summaryrefslogtreecommitdiff
path: root/data/zh_cn/aiccs/2019-10-15/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/aiccs/2019-10-15/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/aiccs/2019-10-15/api-docs.php')
-rw-r--r--data/zh_cn/aiccs/2019-10-15/api-docs.php38826
1 files changed, 13767 insertions, 25059 deletions
diff --git a/data/zh_cn/aiccs/2019-10-15/api-docs.php b/data/zh_cn/aiccs/2019-10-15/api-docs.php
index 10cd3a0..3579549 100644
--- a/data/zh_cn/aiccs/2019-10-15/api-docs.php
+++ b/data/zh_cn/aiccs/2019-10-15/api-docs.php
@@ -1,760 +1,412 @@
<?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' => '通信智能体',
+ 'children' => ['QueryAiVoiceAgentDetailNew', 'PageQueryAgentListNew', 'QueryAiVoiceAgentDetail', 'PageQueryAgentList'],
'type' => 'directory',
- 'children' => [
- 'QueryConversationDetailInfoNew',
- 'ImportOneTaskPhoneNumber',
- 'QueryAiVoiceAgentDetail',
- 'PageQueryAgentList',
- 'QueryConversationDetailInfo',
- 'QueryAiCallDetailPage',
- 'StopAiCallTask',
- 'CancelAiCallDetails',
- 'StartAiCallTask',
- 'UpdateAiCallTask',
- 'QueryAiCallTaskPage',
- 'QueryAiCallTaskDetail',
- 'ImportTaskNumberDatas',
- 'CreateAiCallTask',
- ],
+ 'title' => '通信智能体',
+ 'id' => 452190,
],
[
- 'id' => 200032,
+ 'children' => ['AddInboundNumber', 'TestLargeModel', 'UpdateLargeModel', 'AddLargeModel', 'AddModelApplication', 'UpdateModelApplication', 'LlmSmartCall', 'LlmSmartCallEncrypt', 'HangupOperate', 'ListAvailableTts', 'GetCallDialogContent'],
+ 'type' => 'directory',
'title' => '通信智能引擎',
+ 'id' => 452191,
+ ],
+ [
+ 'children' => ['ImportOneTaskPhoneNumber', 'QueryConversationDetailInfo', 'QueryAiCallDetailPage', 'StopAiCallTask', 'CancelAiCallDetails', 'StartAiCallTask', 'UpdateAiCallTask', 'QueryAiCallTaskPage', 'QueryAiCallTaskDetail', 'ImportTaskNumberDatas', 'CreateAiCallTask'],
'type' => 'directory',
- 'children' => [
- 'LlmSmartCall',
- 'LlmSmartCallEncrypt',
- 'HangupOperate',
- 'ListAvailableTts',
- 'GetCallDialogContent',
- ],
+ 'title' => '大模型通信呼叫任务',
+ 'id' => 452192,
],
[
- 'id' => 164279,
- 'title' => '热线监控数据',
+ 'children' => ['GetAudioNoteUploadUrl', 'SubmitAudioNote'],
'type' => 'directory',
- 'children' => [
- 'GetHotlineServiceStatistics',
- 'GetSkillGroupAndAgentStatusSummary',
- 'GetDepartmentalLatitudeAgentStatus',
- 'GetSkillGroupLatitudeState',
- 'GetAgentBasisStatus',
- 'GetAgentStatistics',
- ],
+ 'title' => '通话智能分析',
+ 'id' => 454807,
],
[
- 'id' => 164286,
- 'title' => '在线监控数据',
+ 'children' => ['GetHotlineServiceStatistics', 'GetSkillGroupAndAgentStatusSummary', 'GetDepartmentalLatitudeAgentStatus', 'GetSkillGroupLatitudeState', 'GetAgentBasisStatus', 'GetAgentStatistics'],
'type' => 'directory',
- 'children' => [
- 'GetOnlineServiceVolume',
- 'GetSeatInformation',
- 'GetSkillGroupServiceCapability',
- 'GetSkillGroupAgentStatusDetails',
- 'GetOnlineSeatInformation',
- 'GetQueueInformation',
- ],
+ 'title' => '热线监控数据',
+ 'id' => 452193,
],
[
- 'id' => 164293,
- 'title' => '热线报表数据',
+ 'children' => ['GetOnlineServiceVolume', 'GetSeatInformation', 'GetSkillGroupServiceCapability', 'GetSkillGroupAgentStatusDetails', 'GetOnlineSeatInformation', 'GetQueueInformation'],
'type' => 'directory',
- 'children' => [
- 'GetSkillGroupStatusTotal',
- 'GetAgentDetailReport',
- ],
+ 'title' => '在线监控数据',
+ 'id' => 452194,
],
[
- 'id' => 164296,
- 'title' => '在线报表数据',
+ 'children' => ['GetSkillGroupStatusTotal', 'GetAgentDetailReport'],
'type' => 'directory',
- 'children' => [
- 'GetSkillGroupServiceStatus',
- 'GetAgentServiceStatus',
- ],
+ 'title' => '热线报表数据',
+ 'id' => 452195,
],
[
- 'id' => 164299,
- 'title' => '坐席管理',
+ 'children' => ['GetSkillGroupServiceStatus', 'GetAgentServiceStatus'],
'type' => 'directory',
- 'children' => [
- 'CreateAgent',
- 'DeleteAgent',
- 'UpdateAgent',
- 'GetAgent',
- 'ListAgentBySkillGroupId',
- 'GetHotlineAgentStatus',
- 'RemoveAgentFromSkillGroup',
- 'GetHotlineAgentDetail',
- ],
+ 'title' => '在线报表数据',
+ 'id' => 452196,
],
[
- 'id' => 164308,
- 'title' => '技能组管理',
+ 'children' => ['CreateAgent', 'DeleteAgent', 'UpdateAgent', 'GetAgent', 'ListAgentBySkillGroupId', 'GetHotlineAgentStatus', 'RemoveAgentFromSkillGroup', 'GetHotlineAgentDetail'],
'type' => 'directory',
- 'children' => [
- 'CreateSkillGroup',
- 'UpdateSkillGroup',
- 'RemoveSkillGroup',
- 'QuerySkillGroups',
- 'ListSkillGroup',
- 'GetDepGroupTreeData',
- ],
+ 'title' => '坐席管理',
+ 'id' => 452197,
],
[
- 'id' => 164315,
- 'title' => '部门管理',
+ 'children' => ['CreateSkillGroup', 'UpdateSkillGroup', 'RemoveSkillGroup', 'QuerySkillGroups', 'ListSkillGroup', 'GetDepGroupTreeData'],
'type' => 'directory',
- 'children' => [
- 'CreateDepartment',
- 'GetAllDepartment',
- 'DeleteDepartment',
- 'UpdateDepartment',
- ],
+ 'title' => '技能组管理',
+ 'id' => 452198,
],
[
- 'id' => 164333,
- 'title' => '通道',
+ 'children' => ['CreateDepartment', 'GetAllDepartment', 'DeleteDepartment', 'UpdateDepartment'],
'type' => 'directory',
- 'children' => [
- 'GenerateWebSocketSign',
- ],
+ 'title' => '部门管理',
+ 'id' => 452199,
],
[
- 'id' => 164335,
- 'title' => '通话详情',
+ 'children' => ['GenerateWebSocketSign'],
'type' => 'directory',
- 'children' => [
- 'HotlineSessionQuery',
- 'GetRecordData',
- 'GetRecordUrl',
- 'DescribeRecordData',
- ],
+ 'title' => '通道',
+ 'id' => 452200,
],
[
- 'id' => 164340,
- 'title' => '数据统计',
+ 'children' => ['HotlineSessionQuery', 'GetRecordData', 'GetRecordUrl', 'DescribeRecordData'],
'type' => 'directory',
- 'children' => [
- 'GetIndexCurrentValue',
- 'GetAgentIndexRealTime',
- 'GetHotlineAgentDetailReport',
- 'GetHotlineGroupDetailReport',
- ],
+ 'title' => '通话详情',
+ 'id' => 452201,
],
[
- 'id' => 164345,
- 'title' => '会话数据',
+ 'children' => ['GetIndexCurrentValue', 'GetAgentIndexRealTime', 'GetHotlineAgentDetailReport', 'GetHotlineGroupDetailReport'],
'type' => 'directory',
- 'children' => [
- 'QueryTouchList',
- 'GetCustomerInfo',
- 'GetHotlineMessageLog',
- 'GetHotlineCallAction',
- ],
+ 'title' => '数据统计',
+ 'id' => 452202,
],
[
- 'id' => 164350,
- 'title' => '机器人外呼',
+ 'children' => ['QueryTouchList', 'GetCustomerInfo', 'GetHotlineMessageLog', 'GetHotlineCallAction'],
'type' => 'directory',
- 'children' => [
- 'RobotCall',
- 'ListRobotCallDialog',
- 'ListAiccsRobot',
- 'ListRobotParams',
- 'GetCallSoundRecord',
- 'ListRobotNode',
- ],
+ 'title' => '会话数据',
+ 'id' => 452203,
],
[
- 'id' => 164357,
- 'title' => '机器人外呼任务',
+ 'children' => ['RobotCall', 'ListRobotCallDialog', 'ListAiccsRobot', 'ListRobotParams', 'GetCallSoundRecord', 'ListRobotNode'],
'type' => 'directory',
- 'children' => [
- 'CreateTask',
- 'AttachTask',
- 'StartTask',
- 'StopTask',
- 'CancelTask',
- 'ListTask',
- 'ListTaskDetail',
- 'ListDialog',
- ],
+ 'title' => '机器人外呼',
+ 'id' => 452204,
],
[
- 'id' => 164366,
- 'title' => '智能语音交互',
+ 'children' => ['CreateTask', 'AttachTask', 'StartTask', 'StopTask', 'CancelTask', 'ListTask', 'ListTaskDetail', 'ListDialog'],
'type' => 'directory',
- 'children' => [
- 'SendCcoSmartCall',
- 'SendCcoSmartCallOperate',
- ],
+ 'title' => '机器人外呼任务',
+ 'id' => 452205,
],
[
- 'id' => 164370,
- 'title' => '智能外呼任务',
+ 'children' => ['SendCcoSmartCall', 'SendCcoSmartCallOperate'],
'type' => 'directory',
- 'children' => [
- 'CreateAiOutboundTask',
- 'CreateAiOutboundTaskBatch',
- 'DeleteAiOutboundTask',
- 'GetAiOutboundTaskBizData',
- 'GetAiOutboundTaskExecDetail',
- 'GetAiOutboundTaskDetail',
- 'UpdateAiOutboundTask',
- 'InsertAiOutboundPhoneNums',
- 'GetAiOutboundTaskProgress',
- 'StopAiOutboundTask',
- 'TerminateAiOutboundTask',
- 'GetAiOutboundTaskList',
- 'StartAiOutboundTask',
- ],
+ 'title' => '智能语音交互',
+ 'id' => 452206,
],
[
- 'id' => 164384,
- 'title' => '号码管理',
+ 'children' => ['CreateAiOutboundTask', 'CreateAiOutboundTaskBatch', 'DeleteAiOutboundTask', 'GetAiOutboundTaskBizData', 'GetAiOutboundTaskExecDetail', 'GetAiOutboundTaskDetail', 'UpdateAiOutboundTask', 'InsertAiOutboundPhoneNums', 'GetAiOutboundTaskProgress', 'StopAiOutboundTask', 'TerminateAiOutboundTask', 'GetAiOutboundTaskList', 'StartAiOutboundTask'],
'type' => 'directory',
- 'children' => [
- 'AddHotlineNumber',
- 'DeleteHotlineNumber',
- 'ResetHotlineNumber',
- 'QueryHotlineNumber',
- 'GetConfigNumList',
- ],
+ 'title' => '智能外呼任务',
+ 'id' => 452207,
],
[
- 'id' => 164813,
- 'title' => '话务管理',
+ 'children' => ['AddHotlineNumber', 'DeleteHotlineNumber', 'ResetHotlineNumber', 'QueryHotlineNumber', 'GetConfigNumList'],
'type' => 'directory',
- 'children' => [
- 'AnswerCall',
- 'FinishHotlineService',
- 'GetNumLocation',
- 'GetRtcToken',
- 'HangupCall',
- 'ListHotlineRecord',
- 'ListOutboundPhoneNumber',
- 'MakeDoubleCall',
- 'SendHotlineHeartBeat',
- 'StartCall',
- 'StartHotlineService',
- 'SuspendHotlineService',
- ],
+ 'title' => '号码管理',
+ 'id' => 452208,
],
[
- 'id' => 165936,
- 'title' => '其他',
+ 'children' => ['AnswerCall', 'FinishHotlineService', 'GetNumLocation', 'GetRtcToken', 'HangupCall', 'ListHotlineRecord', 'ListOutboundPhoneNumber', 'MakeDoubleCall', 'SendHotlineHeartBeat', 'StartCall', 'StartHotlineService', 'SuspendHotlineService'],
'type' => 'directory',
+ 'title' => '话务管理',
+ 'id' => 452209,
+ ],
+ [
'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',
- 'UpdateOuterAccount',
- 'TransferCallToSkillGroup',
- 'AddSkillGroup',
- 'DeleteSkillGroup',
+ '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', 'UpdateOuterAccount', 'TransferCallToSkillGroup', 'AddSkillGroup', 'DeleteSkillGroup', 'QueryConversationDetailInfoNew', 'LlmFullDuplexCallOperate', 'LlmSmartCallFullDuplex',
],
+ 'type' => 'directory',
+ 'title' => '其他',
+ 'id' => 452210,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'QueryConversationDetailInfoNew' => [
- 'summary' => '查询通信智能体呼叫任务明细信息和通话详情信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AddHotlineNumber' => [
+ 'summary' => '调用AddHotlineNumber接口新增热线号码。',
+ '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' => '任务ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)界面查看任务ID或通过[QueryAiCallTaskPage](~~2926799~~)接口获取任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '138************',
- ],
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '实例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'DetailId',
- 'in' => 'query',
+ 'name' => 'HotlineNumber',
+ 'in' => 'formData',
+ 'schema' => ['title' => '号码', 'description' => '热线号码。', 'type' => 'string', 'required' => true, 'example' => '05710000****', 'pattern' => '^\\d+$'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['title' => '号码描述', 'description' => '号码描述。', 'type' => 'string', 'required' => true, 'example' => '热线号码'],
+ ],
+ [
+ 'name' => 'EnableInbound',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否用于入呼', 'description' => '是否用于入呼。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'InboundFlowId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '入呼ivr流程id', 'description' => '入呼IVR流程ID。可通过SaaS工作台热线>渠道接入>IVR流程管理页面获取。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
+ ],
+ [
+ 'name' => 'EnableOutbound',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否用于外呼', 'description' => '是否用于外呼。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'OutboundAllDepart',
+ 'in' => 'formData',
+ 'schema' => ['title' => '外呼是否对所有部门生效', 'description' => '外呼是否对实例下所有部门生效。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'EnableInboundEvaluation',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否开启入呼满意度', 'description' => '是否开启入呼满意度。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'EnableOutboundEvaluation',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否开启外呼满意度', 'description' => '是否开启外呼满意度。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'EvaluationLevel',
+ 'in' => 'formData',
'schema' => [
- 'description' => '任务明细ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面左上角查看任务明细ID或通过[QueryAiCallDetailPage](~~2926853~~)接口获取任务明细ID。',
- 'type' => 'string',
+ 'title' => '满意度等级',
+ 'description' => '满意度等级。取值：'."\n"
+ ."\n"
+ .'- **2**：二级（满意，不满意）'."\n"
+ .'- **3**：三级（满意，一般，不满意）'."\n"
+ .'- **4**：四级（很满意，满意，一般，不满意）'."\n"
+ .'- **5**：五级（很满意，满意，一般，不满意，非常差）',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => '9662*************',
+ 'example' => '2',
+ 'enum' => ['2', '3', '4', '5'],
],
],
[
- 'name' => 'CallId',
- 'in' => 'query',
+ 'name' => 'OutboundRangeList',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '通话唯一 ID。',
- 'type' => 'string',
+ 'title' => '外呼生效范围',
+ 'description' => '外呼生效范围。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '外呼生效范围。',
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupIdList' => [
+ 'title' => '生效技能组列表（部门123下）',
+ 'description' => '生效技能组列表。'."\n"
+ .'> 技能组列表为空则对整个部门生效，否则针对部门下指定技能组列表生效。',
+ 'type' => 'array',
+ 'items' => ['description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'],
+ 'required' => false,
+ ],
+ 'DepartmentId' => ['title' => '生效部门id', 'description' => '生效部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => '1552********^1420********',
],
],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE339D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Code' => ['title' => '错误码', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['title' => '接口调用是否成功', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\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' => '新增热线号码',
+ 'description' => '> 热线号码仅供呼入、呼出使用。',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ ],
+ 'AddInboundNumber' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'OutId',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'LineCode',
+ 'in' => 'query',
+ 'schema' => ['description' => '自定义线路Code。', 'type' => 'string', 'required' => false, 'example' => 'JILIANG_*****_TEST_NET'],
+ ],
+ [
+ 'name' => 'InboundNumbers',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '预留给外部传入的业务流水号，可用唯一 ID 做业务关联。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123******',
+ 'description' => '呼入号码列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '呼入号码', 'type' => 'string', 'required' => false, 'example' => '24243248*****33'],
+ 'required' => true,
],
],
+ [
+ 'name' => 'InboundType',
+ 'in' => 'query',
+ 'schema' => ['description' => '线路类型。`1：云通信资源2：客户自带线路。`', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8'],
+ ],
+ [
+ 'name' => 'ApplicationCode',
+ 'in' => 'query',
+ 'schema' => ['description' => '大模型应用编码。', 'type' => 'string', 'required' => true, 'example' => 'DLWERWLD'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '状态码描述。 ',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '返回结果数据。',
- 'type' => 'object',
- 'properties' => [
- 'CallerPhone' => [
- 'description' => '主叫号码',
- 'type' => 'string',
- 'example' => '0571*******',
- ],
- 'Options' => [
- 'description' => '运行时用到的变量信息，会以Key-Value的形式存储在该字段中。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "date": "666",'."\n"
- .' "phoneNumber": "777",'."\n"
- .' "distance": "555",'."\n"
- .' "mendian": "444",'."\n"
- .' "sex": "男",'."\n"
- .' "name": "111",'."\n"
- .' "age": "222"'."\n"
- .'}',
- ],
- 'CallResult' => [
- 'description' => '外呼结果。取值：'."\n"
- .'- CALL_FORWARDING：呼叫转移。'."\n"
- .'- INCOMING_CALL_BARRED：限制呼入。'."\n"
- .'- CALL_REJECTED：拒接。'."\n"
- .'- ANSWERED：用户接通。'."\n"
- .'- USER_BUSY：被叫忙。'."\n"
- .'- POWERED_OFF：关机。'."\n"
- .'- NO_USER_RESPONSE：不在服务区。'."\n"
- .'- OPERATOR_BLOCK：运营商拦截。'."\n"
- .'- OTHERS：其他状态。'."\n"
- .'- SUSPEND：停机。'."\n"
- .'- CANCEL：主叫取消。'."\n"
- .'- INVALID_NUMBER：空号。'."\n"
- .'- UNAVAILABLE：暂时无法接通。'."\n"
- .'- NETWORK_BUSY：网络忙。'."\n"
- .'- NO_ANSWER：无应答。',
- 'type' => 'string',
- 'example' => 'ANSWERED',
- ],
- 'StatusMsg' => [
- 'description' => '运营商返回的呼叫状态信息。',
- 'type' => 'string',
- 'example' => '呼叫结束（双呼）',
- ],
- 'ConversationTurnCount' => [
- 'description' => '对话轮次。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '23',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => '138************',
- ],
- 'StartCallTime' => [
- 'description' => '开始呼叫时间，时间戳，单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1286987391',
- ],
- 'StatusCode' => [
- 'description' => '呼叫状态码。在语音服务[呼叫状态码](~~112804~~)中查看。',
- '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' => '变量ID',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'Key' => [
- 'description' => '变量Key',
- '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' => '聊天记录信息。结构为JSON数组，聊天记录时按照时间顺序已经排序好了。具体如下：'."\n"
- .'```json'."\n"
- .'['."\n"
- .' {'."\n"
- .' "content":"聊天内容",'."\n"
- .' "role":"角色",//可取值：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"
- .' }]',
- ],
- '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' => '通话唯一ID。',
- 'type' => 'string',
- 'example' => '123*******^213******',
- ],
- 'BatchId' => [
- 'description' => '批次号ID。',
- 'type' => 'string',
- 'example' => '1234******',
- ],
- 'FailedReason' => [
- 'description' => '失败原因',
- 'type' => 'string',
- 'example' => '主动取消',
- ],
- 'Duration' => [
- 'description' => '通话时长，未打通情况下为0，单位：秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '30',
- ],
- 'HangupDirection' => [
- 'description' => '挂断方向。取值：'."\n"
- ."\n"
- .'- **0**：用户。'."\n"
- .'- **1**：机器人。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'DetailId' => [
- 'description' => '任务明细ID。',
- 'type' => 'string',
- 'example' => '1234*******',
- ],
- 'ReleaseTime' => [
- 'description' => '通话结束时间，时间戳，单位毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '7',
- ],
- 'OutId' => [
- 'description' => '外部传入的业务流水号，可用唯一ID做业务关联。',
- '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' => '标签ID。',
- 'type' => 'string',
- 'example' => '12',
- ],
- ],
- ],
- 'example' => '',
+ 'description' => '返回数据。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => '错误描述', 'type' => 'string', 'example' => '号码不合法'],
+ 'InboundNumber' => ['description' => '呼入手机号。', 'type' => 'string', 'example' => '234234238**33'],
+ 'Result' => ['description' => '`true：添加成功 false：添加失败`', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
'example' => '',
],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '添加呼入号码',
+ 'summary' => '添加呼入号码',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- '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"}]',
- 'title' => '通信智能体呼叫任务明细及通话详情',
- 'description' => '- 您可通过此接口查询通信智能体通话详细，也可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面查看通话详情。'."\n"
- ."\n"
- .'- 在调用此接口前，请确保您已创建呼叫任务且已导入被叫数据。'."\n"
- ."\n"
- .'- 若您没有已创建的呼叫任务，可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)界面创建呼叫任务并导入被叫数据，或通过[CreateAiCallTask](~~2926796~~)、[ImportTaskNumberDatas](~~2926815~~)接口创建呼叫任务并导入被叫数据。',
+ '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"}]',
],
- 'ImportOneTaskPhoneNumber' => [
- 'summary' => '导入单个号码数据。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AddLargeModel' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '255142',
+ 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'],
],
'parameters' => [
[
- 'name' => 'TaskId',
+ 'name' => 'ModelName',
'in' => 'query',
- 'schema' => [
- 'description' => '任务ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1231231212****',
- ],
+ 'schema' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'required' => false, 'example' => 'Test Model Name'],
],
[
- 'name' => 'OutId',
+ 'name' => 'ModelUrl',
'in' => 'query',
- 'schema' => [
- 'description' => '外部流水号，建议使用唯一ID。不能超过128个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '94ba739b-xxxx-ef91-335d-4be006c34899',
- ],
+ 'schema' => ['title' => '模型地址', 'description' => '模型地址', 'type' => 'string', 'required' => false, 'example' => 'https://xxxxxxxxxxx'],
],
[
- 'name' => 'PhoneNumber',
+ 'name' => 'AuthCode',
'in' => 'query',
- 'schema' => [
- 'description' => '被叫手机号。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '180******',
- ],
+ 'schema' => ['title' => '授权码', 'description' => '授权码', 'type' => 'string', 'required' => false, 'example' => 'sk-xxxxxxxxxxx*******xx'],
],
[
- 'name' => 'EncryptionType',
+ 'name' => 'Temperature',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '81',
- ],
+ 'schema' => ['title' => '温度', 'description' => '温度', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.1'],
],
[
- 'name' => 'Variables',
+ 'name' => 'TopP',
+ 'in' => 'query',
+ 'schema' => ['title' => 'topP', 'description' => 'topP', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.1'],
+ ],
+ [
+ 'name' => 'TopK',
+ 'in' => 'query',
+ 'schema' => ['title' => 'topK', 'description' => 'topK', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'BaseModel',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '变量列表。Map格式。',
- 'type' => 'object',
+ 'title' => '基础模型',
+ 'description' => '基础模型',
+ 'type' => 'array',
+ 'items' => ['description' => '基础模型名字', 'type' => 'string', 'required' => false, 'example' => 'qwen-max'],
'required' => false,
- 'example' => '{"变量key1":"变量值1","变量key2":"变量值2"}',
+ 'example' => '',
],
],
],
@@ -763,2374 +415,1004 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D',
- ],
- 'Data' => [
- 'description' => '返回结果',
- 'type' => 'object',
- 'properties' => [
- 'DetailId' => [
- 'description' => '任务明细ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '92304322323*****',
- ],
- ],
- 'example' => '',
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'AccessDeniedDetail' => ['description' => '鉴权失败原因', 'type' => 'string', 'example' => 'None'],
+ 'RequestId' => ['title' => '', 'description' => '请求ID。', 'type' => 'string', 'example' => 'B1B8E483-372F-5AA8-A4B2-CA82EC967B0C'],
+ 'Message' => ['title' => '', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => ['title' => '', 'description' => '数据列表。', 'type' => 'boolean', 'example' => 'false'],
+ 'Code' => ['title' => '', 'description' => '状态码。返回OK表示请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['title' => '', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '添加大模型网关',
+ 'summary' => 'AddLargeModel',
+ '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"}]',
- 'title' => '导入单个号码数据',
+ '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"}]',
],
- 'QueryAiVoiceAgentDetail' => [
- 'summary' => '查询通信智能体详情信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AddModelApplication' => [
+ 'summary' => '新增模型应用。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '254052',
+ 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'AgentId',
+ 'name' => 'ApplicationName',
'in' => 'query',
+ 'schema' => ['title' => '模型应用名称', 'description' => '模型应用名称', 'type' => 'string', 'required' => true, 'example' => '测试应用'],
+ ],
+ [
+ 'name' => 'ApplicationCps',
+ 'in' => 'query',
+ 'schema' => ['title' => '应用并发请求数', 'description' => '应用并发请求数', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '25'],
+ ],
+ [
+ 'name' => 'ModelCode',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型编码', 'description' => '模型编码', 'type' => 'string', 'required' => true, 'example' => '1234'],
+ ],
+ [
+ 'name' => 'ModelVersion',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型版本', 'description' => '模型版本', 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'QualificationId',
+ 'in' => 'query',
+ 'schema' => ['title' => '资质ID', 'description' => '资质ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '85'],
+ ],
+ [
+ 'name' => 'QualificationName',
+ 'in' => 'query',
+ 'schema' => ['title' => '资质名称', 'description' => '资质名称', 'type' => 'string', 'required' => false, 'example' => '测试资质'],
+ ],
+ [
+ 'name' => 'SpeechId',
+ 'in' => 'query',
+ 'schema' => ['title' => '话束id', 'description' => '话术ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '88'],
+ ],
+ [
+ 'name' => 'SpeechContent',
+ 'in' => 'query',
+ 'schema' => ['title' => '话术内容', 'description' => '话术内容', 'type' => 'string', 'required' => false, 'example' => '测试话术。'],
+ ],
+ [
+ 'name' => 'UsageDesc',
+ 'in' => 'query',
+ 'schema' => ['title' => '用途', 'description' => '用途', 'type' => 'string', 'required' => false, 'example' => '测试用途'],
+ ],
+ [
+ 'name' => 'DyvmsSceneName',
+ 'in' => 'query',
+ 'schema' => ['title' => '场景名称', 'description' => '场景名称', 'type' => 'string', 'required' => false, 'example' => '测试场景'],
+ ],
+ [
+ 'name' => 'StartWord',
+ 'in' => 'query',
+ 'schema' => ['title' => '开场白', 'description' => '开场白', 'type' => 'string', 'required' => true, 'example' => '你好，这是一句开场白。'],
+ ],
+ [
+ 'name' => 'StartWordType',
+ 'in' => 'query',
+ 'schema' => ['description' => '开场白类型', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0：文本'."\n"
+ .'1：录音'],
+ ],
+ [
+ 'name' => 'RecordingFile',
+ 'in' => 'query',
+ 'schema' => ['description' => '开场白录音音频文件地址，当开场白类型为1时必填', 'type' => 'string', 'required' => false, 'example' => 'https://xxxxxxxx.wav'],
+ ],
+ [
+ 'name' => 'Prompt',
+ 'in' => 'query',
+ 'schema' => ['title' => '提示词', 'description' => '提示词', 'type' => 'string', 'required' => false, 'example' => '测试提示词。'],
+ ],
+ [
+ 'name' => 'Source',
+ 'in' => 'query',
+ 'schema' => ['title' => '来源', 'description' => '来源。固定值：USER。', 'type' => 'string', 'required' => false, 'example' => 'USER'],
+ ],
+ [
+ 'name' => 'TtsConfig',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '智能体ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123123********',
+ 'title' => 'tts配置，包括音色、音量、音速等。',
+ 'description' => 'tts配置，包括音色、音量、音速等。',
+ 'type' => 'object',
+ 'properties' => [
+ 'VoiceCode' => ['title' => '音色code', 'description' => '音色code', 'type' => 'string', 'required' => false, 'example' => 'ddddfd'],
+ 'MixingTemplate' => ['description' => '混音模板id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
+ 'BackgroundEnabled' => ['description' => '是否开启背景音', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'TtsVolume' => ['title' => 'TTS 变量播放的音量。取值范围：0~100，默认值为 0。', 'description' => 'TTS 变量播放的音量。取值范围：0~100，默认值为 0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '55'],
+ 'TtsStyle' => ['title' => '声音风格', 'description' => '声音风格', 'type' => 'string', 'required' => false, 'example' => '龙小夏'],
+ 'ResourceId' => ['description' => '资源id', 'type' => 'string', 'required' => false, 'example' => 'example'],
+ 'CustomerAccountId' => ['description' => '账号id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '45'],
+ 'VoiceType' => ['title' => '声音类型', 'description' => '声音类型。'."\n"
+ ."\n"
+ .'```'."\n"
+ .'SYSTEM：系统音色'."\n"
+ .'COSYCLONE：复刻音色'."\n"
+ .'BL-CUSTOM：定制精品复刻音色'."\n"
+ .'```', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM'],
+ 'MixingEnabled' => ['description' => '是否开启混音', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'TtsSpeed' => ['title' => 'TTS 变量播放时的声音速度。取值范围：-200~200，默认值为 0。', 'description' => 'TTS 变量播放时的声音速度。取值范围：-200~200，默认值为 0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13'],
+ 'BackgroundSound' => ['description' => '背景音id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
+ 'BackgroundVolume' => ['description' => '背景音音量', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0：low'."\n"
+ .'1：medium'."\n"
+ .'2：high'],
+ ],
+ 'required' => true,
+ 'example' => '',
],
],
+ [
+ 'name' => 'MuteDuration',
+ 'in' => 'query',
+ 'schema' => ['title' => '静音时长', 'description' => '静音时长', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '70'],
+ ],
+ [
+ 'name' => 'MuteActive',
+ 'in' => 'query',
+ 'schema' => ['title' => '第一个静音是否唤起模型', 'description' => '第一个静音是否唤起模型', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'MuteHangupNum',
+ 'in' => 'query',
+ 'schema' => ['title' => '连续多少个静音事件主动挂机', 'description' => '连续多少个静音事件主动挂机', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5'],
+ ],
+ [
+ 'name' => 'CallConnectedTriggerModel',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启通话接通事件推送，默认关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- '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' => '可取值唯一ID。',
- 'type' => 'string',
- 'example' => 'd5606d80-7625-dcea-xxxx-17f66fbb564a',
- ],
- ],
- ],
- 'example' => '',
- ],
- 'MainPurposeName' => [
- 'description' => '主意图名称。',
- 'type' => 'string',
- 'example' => '通话效果评级',
- ],
- 'MainPurposeType' => [
- 'description' => '主意图取值类型。目前只有ENUM类型。',
- 'type' => 'string',
- 'example' => 'ENUM',
- ],
- 'MainPurposeDescription' => [
- 'description' => '主意图说明。',
- 'type' => 'string',
- 'example' => '通话效果评级：A、B、C、D，（A最好）',
- ],
- 'Id' => [
- 'description' => '主意图ID。',
- 'type' => 'string',
- 'example' => '1ee6e994-08e0-xxxx-f662-1659cc54d409',
- ],
- ],
- 'example' => '',
- ],
- 'ChildTaskList' => [
- 'description' => '子任务配置列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ChildTaskName' => [
- 'description' => '子任务名称。',
- 'type' => 'string',
- 'example' => '开场与邀约',
- ],
- 'ChildTaskDescription' => [
- 'description' => '子任务描述。',
- 'type' => 'string',
- 'example' => '新用户邀约: \\"喂，家长您好！我是*****的王老师，我们现在有**课程100个试听名额，想帮宝贝安排一下体验，您看什么时候比较方便呢？\\',
- ],
- 'Id' => [
- 'description' => '子任务唯一ID。',
- 'type' => 'string',
- 'example' => '280cd4bf-*******df472c',
- ],
- ],
- ],
- 'example' => '',
- ],
- 'CustomExceptionFileName' => [
- 'description' => '自定义异常文件名称。',
- 'type' => 'string',
- 'example' => '异常测试文件.xlsx',
- ],
- 'StartWordType' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'BusinessType' => [
- 'description' => '业务场景。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'enumValueTitles' => [
- 1 => '个人客户线索转化',
- '企业客户线索转化',
- '会员提醒-续费/复购场景',
- '会员提醒-促销/赠券场景',
- '简单客服-答疑类客服场景',
- '其他',
- ],
- 'example' => '1',
- ],
- 'CustomExceptionUrlPath' => [
- 'description' => '废弃字段，后续会下掉。',
- 'type' => 'string',
- 'example' => '-',
- ],
- 'KnowledgeId' => [
- 'description' => '知识库ID。',
- 'type' => 'string',
- 'example' => '1232131*******',
- ],
- 'KnowledgeDocOriginalNameList' => [
- 'description' => '知识库文档原始文件名列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '文件名。',
- 'type' => 'string',
- 'example' => '**会话引擎测试.xlsx',
- ],
- 'example' => '',
- ],
- 'KnowledgeEnable' => [
- 'description' => '是否关联知识库。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'CustomExceptionEnable' => [
- 'description' => '是否开启自定义异常处理。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Prologue' => [
- 'description' => '开场白。',
- 'type' => 'string',
- 'example' => '你好，这里是******。',
- ],
- 'CustomExceptionFileId' => [
- 'description' => '自定义异常文件ID。',
- 'type' => 'string',
- 'example' => 'OSS文件ID',
- ],
- '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' => '变量唯一ID。',
- 'type' => 'string',
- 'example' => '280cd4bf-*******df472c'."\n",
- ],
- 'PhoneTagSource' => [
- 'type' => 'string',
- 'example' => '示例值',
- ],
- 'PhoneTagDescription' => [
- 'description' => '变量描述。',
- 'type' => 'string',
- 'example' => '用户感兴趣的车系。',
- ],
- 'PhoneTagEnum' => [
- 'description' => '变量枚举值列表。只有变量值类型为ENUM时才有该字段。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Description' => [
- 'description' => '枚举值描述。',
- 'type' => 'string',
- 'example' => '客户完全不接受挽留',
- ],
- 'Value' => [
- 'description' => '枚举值。',
- 'type' => 'string',
- 'example' => '完全不接受',
- ],
- 'Id' => [
- 'description' => '枚举值唯一ID。',
- 'type' => 'string',
- 'example' => 'c3d4ff4e-*********bc26dc044682',
- ],
- ],
- ],
- 'example' => '',
- ],
- 'PhoneTagKey' => [
- 'description' => '变量键名。',
- 'type' => 'string',
- 'example' => 'testParam',
- ],
- ],
- ],
- 'example' => '',
- ],
- 'FlowDesc' => [
- 'description' => '高级任务流程描述。',
- 'type' => 'string',
- 'example' => '这次外呼通过三个核心步骤与家长沟通，........ 3. 用户需求 > 主动介绍',
- ],
- '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' => '标签枚举值，只有标签值类型为ENUM时才有该字段。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Description' => [
- 'description' => '标签枚举值描述。',
- 'type' => 'string',
- 'example' => '高（非常积极，大概率转化）',
- ],
- 'Value' => [
- 'description' => '标签枚举值。',
- 'type' => 'string',
- 'example' => '高',
- ],
- 'Id' => [
- 'description' => '标签枚举值唯一ID。',
- 'type' => 'string',
- 'example' => '8757************2c499fa',
- ],
- ],
- ],
- 'example' => '',
- ],
- 'OutputTagName' => [
- 'description' => '标签名称。',
- 'type' => 'string',
- 'example' => '客户意向度',
- ],
- 'Id' => [
- 'description' => '标签唯一ID。',
- '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' => '知识文档ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '知识文档ID。',
- 'type' => 'string',
- 'example' => '12213******',
- ],
- 'example' => '',
- ],
- ],
- 'example' => '',
- ],
- 'KnowledgeName' => [
- 'description' => '知识库名称。',
- 'type' => 'string',
- 'example' => '测试知识库',
- ],
- 'VoiceStyleName' => [
- 'description' => '语言风格名称。',
- 'type' => 'string',
- 'example' => '亲切',
- ],
- 'AgentId' => [
- 'description' => '智能体ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12311212******',
- ],
- 'AgentName' => [
- 'description' => '智能体名称。',
- 'type' => 'string',
- 'example' => '测试智能体',
- ],
- 'AiVoiceAgentCallConfig' => [
- 'description' => '智能外呼语音配置。',
- 'type' => 'object',
- 'properties' => [
- 'VocabId' => [
- 'description' => '热词ID',
- 'type' => 'string',
- 'example' => 'afb2c43**********83e6df30551c11f7',
- ],
- 'TtsConfig' => [
- 'description' => 'TTS配置。',
- 'type' => 'object',
- 'properties' => [
- 'VoiceCode' => [
- 'type' => 'string',
- 'example' => '示例值',
- ],
- 'MixingTemplate' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'BackgroundEnabled' => [
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TtsVolume' => [
- 'description' => 'TTS 播放的音量。'."\n"
- .'> '."\n"
- .'> - 取值范围：0~100，默认值为0。'."\n"
- .'> - 不设置值时，默认取大模型应用配置的音量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '72',
- ],
- 'TtsStyle' => [
- 'description' => '音色风格。',
- 'type' => 'string',
- 'example' => 'longxiaoxia_v2p1',
- ],
- 'VoiceType' => [
- 'type' => 'string',
- 'example' => '示例值',
- ],
- 'MixingEnabled' => [
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TtsSpeed' => [
- 'description' => 'TTS 播放时的声音速度。'."\n"
- ."\n"
- .'> '."\n"
- .'> - 取值范围：-200~200，默认值为 0；'."\n"
- .'> - 不设置值时，默认取大模型应用配置的声音速度；',
- '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' => '最大通话时长，超时后自动挂断。单位：秒。'."\n"
- .'>'."\n"
- .'>- 最大取值：3600s。'."\n"
- .'>- 最小取值：600s。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '600',
- ],
- 'CallAssistantHangup' => [
- 'description' => '识别到智能接听是否挂断。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'CallAssistantRecognize' => [
- 'description' => '智能接听识别是否开启。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'MuteDuration' => [
- 'description' => '静音时长。'."\n"
- .'>'."\n"
- .'>- 最大取值：15s。'."\n"
- .'>- 最小取值：3s。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'MuteHangupNum' => [
- 'description' => '连续多少个静音事件主动挂机。'."\n"
- .'>'."\n"
- .'>- 最大取值：5。'."\n"
- .'>- 最小取值：1。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- 'example' => '',
- ],
- ],
- 'example' => '',
- ],
- ],
- 'example' => '',
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'RequestId' => ['title' => '', 'description' => '请求ID。', 'type' => 'string', 'example' => '8C93B345-F702-5449-BA7E-7D110D4BF798'],
+ 'Message' => ['title' => '', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => ['title' => '', 'description' => '返回数据，应用Code。', 'type' => 'string', 'example' => '325****2D2'],
+ 'Code' => ['title' => '', 'description' => '状态码。返回OK表示请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['title' => '', 'description' => '调用接口是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建大模型应用',
+ '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"}]',
- 'title' => '查询通信智能体详情信息',
+ '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"}]',
],
- 'PageQueryAgentList' => [
- 'summary' => '分页查询智能体列表。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AddOuterAccount' => [
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
- 'name' => 'AgentId',
+ 'name' => 'OuterAccountId',
'in' => 'query',
- 'schema' => [
- 'description' => '智能体ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1231*******',
- ],
+ 'schema' => ['description' => '外部账号ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1212'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'OuterAccountType',
'in' => 'query',
- 'schema' => [
- 'description' => '页大小，默认10。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '外部账号类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alipay'],
],
[
- 'name' => 'PageNo',
+ 'name' => 'OuterAccountName',
'in' => 'query',
- 'schema' => [
- 'description' => '页编号，从1开始，默认1。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '外部账号名称。', 'type' => 'string', 'required' => false, 'example' => '测试'],
],
[
- 'name' => 'AgentName',
+ 'name' => 'Avatar',
'in' => 'query',
- 'schema' => [
- 'description' => '智能体名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '测试智能体',
- ],
+ 'schema' => ['description' => '头像。', 'type' => 'string', 'required' => false, 'example' => 'http://****'],
],
[
- 'name' => 'Status',
+ 'name' => 'RealName',
'in' => 'query',
- 'schema' => [
- 'description' => '智能体状态。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'enumValueTitles' => [
- 1 => '已上线',
- '已下线',
- '审核中',
- '审核失败',
- '构建中',
- '调试中',
- '可上线',
- '构建失败',
- ],
- 'example' => '7',
- ],
+ 'schema' => ['description' => '账号真实姓名。', 'type' => 'string', 'required' => false, 'example' => '张三'],
+ ],
+ [
+ 'name' => 'OuterDepartmentId',
+ 'in' => 'query',
+ 'schema' => ['description' => '外部部门ID。', 'type' => 'string', 'required' => false, 'example' => '3'],
+ ],
+ [
+ 'name' => 'OuterGroupIds',
+ 'in' => 'query',
+ 'schema' => ['description' => '外部技能组ID列表。多个ID用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => '["222","333","444"]'],
+ ],
+ [
+ 'name' => 'Ext',
+ 'in' => 'query',
+ 'schema' => ['description' => '扩展字段，JSON字符串。', 'type' => 'string', 'required' => false, 'example' => '{"备注":"临时技能组"}'],
+ ],
+ [
+ 'name' => 'OuterDepartmentType',
+ 'in' => 'query',
+ 'schema' => ['description' => '外部部门类型：无效部门类型。', 'type' => 'string', 'required' => false, 'example' => 'type_invalid'],
+ ],
+ [
+ 'name' => 'OuterGroupType',
+ 'in' => 'query',
+ 'schema' => ['description' => '技能组类型。', 'type' => 'string', 'required' => false, 'example' => 'mybank'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => 'Access Denied',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- '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' => '应用Code',
- 'type' => 'string',
- 'example' => 'DFAS*****',
- ],
- 'BusinessTypeName' => [
- 'description' => '业务场景名称',
- 'type' => 'string',
- 'example' => '个人客户线索转化',
- ],
- 'WithConfig' => [
- 'description' => '智能体是否已经配置过。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'AgentName' => [
- 'description' => '智能体名称。',
- 'type' => 'string',
- 'example' => '测试智能体',
- ],
- 'AgentId' => [
- 'description' => '智能体ID。',
- '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' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Data' => ['description' => '创建账号ID。', 'type' => 'string', 'example' => '123456'],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 500 => [
+ ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => '系统错误，请联系管理员！'],
+ ],
],
- '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"}]',
- 'title' => '查询通信智能体列表',
- ],
- 'QueryConversationDetailInfo' => [
- 'summary' => '查询通信智能体呼叫通话详情信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '添加外部关联账户',
+ 'summary' => '调用AddOuterAccount添加外部账号。',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'AddSkillGroup' => [
+ 'methods' => ['get'],
+ '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',
+ 'name' => 'OuterGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '任务ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)界面查看任务ID或通过[QueryAiCallTaskPage](~~2926799~~)接口获取任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '138************',
- ],
+ 'schema' => ['description' => '外部的技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
[
- 'name' => 'DetailId',
+ 'name' => 'OuterGroupName',
'in' => 'query',
- 'schema' => [
- 'description' => '任务明细ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面左上角查看任务明细ID或通过[QueryAiCallDetailPage](~~2926853~~)接口获取任务明细ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '9662*************',
- ],
+ 'schema' => ['description' => '外部的技能组名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '热线技能组'],
],
[
- 'name' => 'BatchId',
+ 'name' => 'OuterGroupType',
'in' => 'query',
- 'schema' => [
- 'description' => '任务批次ID。即为导入被叫数据时返回的批次ID，在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**界面查看任务批次ID或通过[ImportTaskNumberDatas](~~2926815~~)接口导入被叫数据时返回的导入批次ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '139*********216',
- ],
+ 'schema' => ['description' => '外部的技能组类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mybank'],
+ ],
+ [
+ 'name' => 'OuterDepartmentId',
+ 'in' => 'query',
+ 'schema' => ['description' => '外部的部门ID。', 'type' => 'string', 'required' => false, 'example' => '123456'],
+ ],
+ [
+ 'name' => 'OuterDepartmentType',
+ 'in' => 'query',
+ 'schema' => ['description' => '外部的部门类型。', 'type' => 'string', 'required' => false, 'example' => 'type_invalid'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F2051E18-FF3F-5C08-8D24-6F150D2AF757',
- ],
- 'Data' => [
- 'description' => '返回结果数据。',
- 'type' => 'object',
- 'properties' => [
- 'CallerPhone' => [
- 'description' => '主叫号码',
- 'type' => 'string',
- 'example' => '0571*******',
- ],
- 'EncryptionType' => [
- 'type' => 'string',
- 'example' => '示例值',
- ],
- 'CallResult' => [
- 'description' => '外呼结果。取值：'."\n"
- .'- CALL_FORWARDING：呼叫转移。'."\n"
- .'- INCOMING_CALL_BARRED：限制呼入。'."\n"
- .'- CALL_REJECTED：拒接。'."\n"
- .'- ANSWERED：用户接通。'."\n"
- .'- USER_BUSY：被叫忙。'."\n"
- .'- POWERED_OFF：关机。'."\n"
- .'- NO_USER_RESPONSE：不在服务区。'."\n"
- .'- OPERATOR_BLOCK：运营商拦截。'."\n"
- .'- OTHERS：其他状态。'."\n"
- .'- SUSPEND：停机。'."\n"
- .'- CANCEL：主叫取消。'."\n"
- .'- INVALID_NUMBER：空号。'."\n"
- .'- UNAVAILABLE：暂时无法接通。'."\n"
- .'- NETWORK_BUSY：网络忙。'."\n"
- .'- NO_ANSWER：无应答。',
- 'type' => 'string',
- 'example' => 'ANSWERED',
- ],
- 'StatusMsg' => [
- 'description' => '运营商返回的呼叫状态信息。',
- 'type' => 'string',
- 'example' => '呼叫结束（双呼）',
- ],
- 'StartCallTime' => [
- 'description' => '开始呼叫时间，时间戳，单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123123123123123',
- ],
- 'MajorIntent' => [
- 'description' => '主意图',
- 'type' => 'string',
- 'example' => 'D',
- ],
- 'CallId' => [
- 'description' => '通话唯一ID。',
- 'type' => 'string',
- 'example' => '1231231231213^11231231231',
- ],
- 'FailedReason' => [
- 'description' => '失败原因',
- 'type' => 'string',
- 'example' => '主动取消',
- ],
- 'Duration' => [
- 'description' => '通话时长，未打通情况下为0，单位：秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '16',
- ],
- 'HangupDirection' => [
- 'description' => '挂断方向。取值：'."\n"
- ."\n"
- .'- **0**：用户。'."\n"
- .'- **1**：机器人。',
- 'type' => 'string',
- 'example' => '用户',
- ],
- 'StatusCode' => [
- 'description' => '呼叫状态码。在语音服务[呼叫状态码](~~112804~~)中查看。',
- 'type' => 'string',
- 'example' => '200005',
- ],
- 'CalledPhone' => [
- 'description' => '被叫号码',
- 'type' => 'string',
- 'example' => '186******',
- ],
- 'Variables' => [
- 'description' => '通话变量列表。即为您创建的呼叫任务所关联的通信智能体中配置的通话变量。',
- 'type' => 'array',
- 'items' => [
- 'description' => '通话变量信息。',
- 'type' => 'object',
- 'properties' => [
- 'Required' => [
- 'description' => '是否必填。取值：'."\n"
- ."\n"
- .'- true：是。'."\n"
- ."\n"
- .'- false：否。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Value' => [
- 'description' => '变量值。',
- 'type' => 'string',
- 'example' => '张三',
- ],
- 'Id' => [
- 'description' => '变量ID。',
- 'type' => 'string',
- 'example' => '22',
- ],
- 'Key' => [
- 'description' => '变量Key。',
- 'type' => 'string',
- 'example' => 'name',
- ],
- 'Source' => [
- 'type' => 'string',
- 'example' => '示例值',
- ],
- 'Name' => [
- 'description' => '变量名称。',
- 'type' => 'string',
- 'example' => '姓名',
- ],
- ],
- ],
- 'example' => '',
- ],
- 'RecordingFileDownloadUrl' => [
- 'description' => '录音文件下载地址，只有生成录音文件后才有该字段。',
- 'type' => 'string',
- 'example' => 'https://********',
- ],
- 'ReleaseTime' => [
- 'description' => '通话结束时间，时间戳，单位毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '98',
- ],
- 'PickUpTime' => [
- 'description' => '电话接听时间。时间戳格式，单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1754617273000',
- ],
- 'OutId' => [
- 'description' => '外部传入的业务流水号，可用唯一ID做业务关联。',
- 'type' => 'string',
- 'example' => 'bb3bc32d-54b8-49c4-80d3-61583417d22e'."\n",
- ],
- 'ConversationRecord' => [
- 'description' => '聊天记录信息。结构为JSON数组，聊天记录时按照时间顺序已经排序好了。具体如下：'."\n"
- .'```json'."\n"
- .'['."\n"
- .' {'."\n"
- .' "content":"聊天内容",'."\n"
- .' "role":"角色",//可取值：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"
- .']',
- ],
- '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' => '标签ID。',
- 'type' => 'string',
- 'example' => '9ca2*****************************',
- ],
- ],
- ],
- 'example' => '',
- ],
- ],
- 'example' => '',
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Data' => ['description' => '创建技能组ID。', 'type' => 'string', 'example' => '123456'],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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"}]',
- 'title' => '通信智能体呼叫通话详情',
- 'description' => '- 您可通过此接口查询通信智能体通话详细，也可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面查看通话详情。'."\n"
- ."\n"
- .'- 在调用此接口前，请确保您已创建呼叫任务且已导入被叫数据。'."\n"
- ."\n"
- .'- 若您没有已创建的呼叫任务，可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)界面创建呼叫任务并导入被叫数据，或通过[CreateAiCallTask](~~2926796~~)、[ImportTaskNumberDatas](~~2926815~~)接口创建呼叫任务并导入被叫数据。',
- ],
- 'QueryAiCallDetailPage' => [
- 'summary' => '分页查询通信智能体外呼任务明细。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '创建技能组',
+ 'summary' => '调用AddSkillGroup创建外部技能组。',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'AiccsSmartCall' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '269272',
- 'abilityTreeNodes' => [
- 'FEATUREaiccsTY5M4L',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
- 'name' => 'TaskId',
+ 'name' => 'ProdCode',
'in' => 'query',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1187**************',
- ],
+ 'schema' => ['description' => '产品名称。默认取值：**aiccs**。', 'type' => 'string', 'required' => false, 'example' => 'aiccs', 'default' => 'aiccs'],
],
[
- 'name' => 'Status',
+ 'name' => 'CalledShowNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '任务状态。取值：'."\n"
- ."\n"
- .'- 0：待完成。'."\n"
- ."\n"
- .'- 1：已完成。'."\n"
- ."\n"
- .'- 2：失败。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => '0',
- ],
+ 'schema' => ['description' => '被叫显号，必须是已购买的号码。'."\n"
+ ."\n"
+ .'您可以登录[联络中心控制台](https://aiccs.console.aliyun.com/overview?spm=a2c4g.11186623.0.0.7f9bf9658X6jte)，查看已购买的号码。', 'type' => 'string', 'required' => true, 'example' => '0571000****'],
],
[
- 'name' => 'BatchId',
+ 'name' => 'CalledNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '批次号ID。在[外呼任务管理](https://aiccs.console.aliyun.com/agent/task)界面单击详情查看批次号ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1183**************'."\n",
- ],
+ 'schema' => ['description' => '被叫号码。仅支持中国内地号码。', 'type' => 'string', 'required' => true, 'example' => '1862222****'],
],
[
- 'name' => 'CalledNumber',
+ 'name' => 'VoiceCode',
'in' => 'query',
- 'schema' => [
- 'description' => '被叫号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '053714454****',
- ],
+ 'schema' => ['description' => '智能外呼放音文件，支持网络文件和TTS方式。其中，支持使用多个文件和TTS参数混播，之间用英文逗号（,）分隔。TTS参数的替换值在**VoiceCodeParam**中指定。'."\n"
+ ."\n"
+ .'- 放音文件为网络文件时：参数VoiceCode指定为可被公网访问的语音文件URL，建议您使用采样频率为8000Hz或16000Hz且为wav格式的语音文件。'."\n"
+ .'- 放音文件为TTS时：参数VoiceCode指定为变量名称如$name$，需要在VoiceCodeParam中设置变量对应的内容。', 'type' => 'string', 'required' => true, 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$'],
],
[
- 'name' => 'EncryptionType',
+ 'name' => 'OutId',
'in' => 'query',
- 'schema' => [
- 'description' => '加密方式。0: 不加密；1: MD5；2: SHA256；3: SM3；',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '预留给调用方使用的ID，最终会通过在回执消息中将此ID带回给调用方。'."\n"
+ .'字符串类型，长度为1~15个字节。', 'type' => 'string', 'required' => false, 'example' => '222356****'],
],
[
- 'name' => 'CallResult',
+ 'name' => 'PlayTimes',
'in' => 'query',
- 'schema' => [
- 'description' => '外呼结果。取值：'."\n"
- .'- CALL_FORWARDING：呼叫转移。'."\n"
- .'- INCOMING_CALL_BARRED：限制呼入。'."\n"
- .'- CALL_REJECTED：拒接。'."\n"
- .'- ANSWERED：用户接通。'."\n"
- .'- USER_BUSY：被叫忙。'."\n"
- .'- POWERED_OFF：关机。'."\n"
- .'- NO_USER_RESPONSE：不在服务区。'."\n"
- .'- OPERATOR_BLOCK：运营商拦截。'."\n"
- .'- OTHERS：其他状态。'."\n"
- .'- SUSPEND：停机。'."\n"
- .'- CANCEL：主叫取消。'."\n"
- .'- INVALID_NUMBER：空号。'."\n"
- .'- UNAVAILABLE：暂时无法接通。'."\n"
- .'- NETWORK_BUSY：网络忙。'."\n"
- .'- NO_ANSWER：无应答。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'ANSWERED',
- ],
+ 'schema' => ['description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'MajorIntent',
+ 'name' => 'Volume',
'in' => 'query',
- 'schema' => [
- 'description' => '主意图。在[通信智能体管理](https://aiccs.console.aliyun.com/agent/customize)界面单击智能体详情查看主意图。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'A',
- ],
+ 'schema' => ['description' => '播放用户音频的音量，取值范围为**-4~4**，建议设置为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'MinConversationDuration',
+ 'name' => 'Speed',
'in' => 'query',
- 'schema' => [
- 'description' => '通话时长下限。单位：分钟。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'MaxConversationDuration',
+ 'name' => 'AsrModelId',
'in' => 'query',
- 'schema' => [
- 'description' => '通话时长上限。单位：分钟。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'ASR模型ID。请在[ASR模型管理页面](https://aiccs.console.aliyun.com/sentence/model/private?spm=a2c4g.11186623.0.0.7f9b2964fYSGv4)查看ASR模型ID。', 'type' => 'string', 'required' => false, 'example' => 'bf71664d30d2478fb8cb8c39c6b6****'],
],
[
- 'name' => 'StartImportedTime',
+ 'name' => 'AsrBaseId',
'in' => 'query',
- 'schema' => [
- 'description' => '起始导入时间，时间戳，单位：ms。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1748948749000',
- ],
+ 'schema' => ['description' => 'SR基础模型。'."\n"
+ ."\n"
+ .'- **customer_service_8k**：普通话。'."\n"
+ .'- **dialect_customer_service_8k**：重口音。'."\n"
+ ."\n"
+ .'> - 调用接口**SendCcoSmartCall**时，需要指定使用的ASR模型，建议参数**asrModelId**和**AsrBaseId**二者选填一个。'."\n"
+ .'- 如果仅设置**asrModelId**，表示使用指定的ASR模型。'."\n"
+ .'- 如果仅设置**AsrBaseId**，表示使用指定的ASR基础模型。'."\n"
+ .'- 如果二者均未设置，则使用默认的ASR基础模型，即参数**AsrBaseId**默认为**customer_service_8k**，表示使用ASR普通话基础模型。'."\n"
+ .'- 如果二者同时设置，请确认二者是正确对应的。'."\n", 'type' => 'string', 'required' => false, 'example' => 'customer_service_8k'],
],
[
- 'name' => 'EndImportedTime',
+ 'name' => 'AsrAlsAmId',
'in' => 'query',
- 'schema' => [
- 'description' => '结束导入时间，时间戳，单位：ms。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1748948749000',
- ],
+ 'schema' => ['description' => '声学模型ID。', 'type' => 'string', 'required' => false, 'example' => '23387****'],
],
[
- 'name' => 'StartCallingTime',
+ 'name' => 'AsrVocabularyId',
'in' => 'query',
- 'schema' => [
- 'description' => '起始外呼时间，时间戳，单位：ms。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1748948749000',
- ],
+ 'schema' => ['description' => '热词ID。请在[ASR热词管理页面](https://aiccs.console.aliyun.com/sentence/vocab?spm=a2c4g.11186623.0.0.7f9bf965IKBpsi)查看ASR热词ID。', 'type' => 'string', 'required' => false, 'example' => '6689****'],
],
[
- 'name' => 'EndCallingTime',
+ 'name' => 'RecordFlag',
'in' => 'query',
- 'schema' => [
- 'description' => '结束外呼时间，时间戳，单位：ms。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1748948749000',
- ],
+ 'schema' => ['description' => '通话过程中是否录音。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'OutId',
+ 'name' => 'PauseTime',
'in' => 'query',
- 'schema' => [
- 'description' => '预留给调用方使用的ID。最终会通过在回执消息中将此ID带回给调用方。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '94ba739b-c01a-ef91-335d-4be006c34899',
- ],
+ 'schema' => ['description' => '停顿时长。用于设置用户停顿多久，表示一句话结束。单位为毫秒，取值范围为**300~1200**。'."\n"
+ ."\n"
+ .'- 如果指定值不在参数范围中，则默认PauseTime为**800**。'."\n"
+ .'- 首次设置有效，后续设置无效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '800'],
],
[
- 'name' => 'DetailIds',
+ 'name' => 'MuteTime',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '任务明细ID列表，最多不能超过100个。',
- 'type' => 'array',
- 'items' => [
- 'description' => '明细ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '992913231****',
- ],
- 'required' => false,
- 'example' => '示例值示例值',
- ],
+ 'schema' => ['description' => '静音时长。用于设置用户多久不说话通话结束。单位为毫秒，取值范围为**1000~20000**。'."\n"
+ ."\n"
+ .'- 如果指定值不在参数范围中，则默认MuteTime为**10000**。'."\n"
+ .'- 通话过程中可动态设置，以最后一次设置为准。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000'],
],
[
- 'name' => 'PageNo',
+ 'name' => 'ActionCodeBreak',
'in' => 'query',
- 'schema' => [
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '开场放音文件是否可打断。默认为**true**，即开场放音文件可打断。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'DynamicId',
'in' => 'query',
- 'schema' => [
- 'description' => '每页数量。默认值：**10**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => '预留给调用方使用的动态扩展ID，在回调地址中带回，用于客户的开发标识。', 'type' => 'string', 'required' => false, 'example' => '2234****'],
+ ],
+ [
+ 'name' => 'EarlyMediaAsr',
+ 'in' => 'query',
+ 'schema' => ['description' => '早媒体语音识别标识。设为**true**会记录通话未接听的原因。默认为**fasle**，即关闭状态。'."\n"
+ ."\n"
+ .'> 如果需要启用早媒体语音识别标识，请手动设为**true**。', 'type' => 'boolean', 'required' => false, 'example' => 'fasle'],
+ ],
+ [
+ 'name' => 'VoiceCodeParam',
+ 'in' => 'query',
+ 'schema' => ['description' => 'TTS参数传递字符串，格式为JSON。必须与VoiceCode的TTS参数对应。', 'type' => 'string', 'required' => false, 'example' => '“{\\”name\\”:\\”喂，你好\\”}”'],
+ ],
+ [
+ 'name' => 'SessionTimeout',
+ 'in' => 'query',
+ 'schema' => ['description' => '最大通话时长，单位为秒，超时后自动挂断。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120'],
+ ],
+ [
+ 'name' => 'ActionCodeTimeBreak',
+ 'in' => 'query',
+ 'schema' => ['description' => '基于用户持续说话时长打断，在ActionCodeBreak为**true**时生效。单位为毫秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120'],
+ ],
+ [
+ 'name' => 'TtsConf',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否设置TTS声音参数。'."\n"
+ .'- 指定为**true**：需要通过TtsStyle、TtsColume、TtsSpeed三个参数来设置声音风格。'."\n"
+ .'- 定为**false**：不需要设置相关参数，即便设置了也不生效。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'TtsStyle',
+ 'in' => 'query',
+ 'schema' => ['description' => 'TTS变量播放时的声音风格，默认为**xiaoyun**，具体风格请参见声音风格列表。', 'type' => 'string', 'required' => false, 'example' => 'xiaoyun'],
+ ],
+ [
+ 'name' => 'TtsVolume',
+ 'in' => 'query',
+ 'schema' => ['description' => 'TTS变量播放的音量，取值范围为**0~100**，默认为**0**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'TtsSpeed',
+ 'in' => 'query',
+ 'schema' => ['description' => 'TTS变量播放时的声音速度，取值范围为**-200~200**，默认为**0**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
+ ],
+ [
+ 'name' => 'EnableITN',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否在后处理中执行ITN。'."\n"
+ ."\n"
+ .'> 设置为**true**时，中文数字将转为阿拉伯数字输出，默认为**false**。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
+ ],
+ [
+ 'name' => 'BackgroundFileCode',
+ 'in' => 'query',
+ 'schema' => ['description' => '用户和机器人对话时播放的背景语音文件ID。'."\n"
+ ."\n"
+ .'您可以登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，选择**智能交互 > 语音文件管理**，单击**详情**，查看对应的语音ID。', 'type' => 'string', 'required' => false, 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav'],
+ ],
+ [
+ 'name' => 'BackgroundVolume',
+ 'in' => 'query',
+ 'schema' => ['description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '4', 'minimum' => '-4', 'example' => '1'],
+ ],
+ [
+ 'name' => 'BackgroundSpeed',
+ 'in' => 'query',
+ 'schema' => ['description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- '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' => [
- 'description' => '任务明细状态。'."\n"
- .'- 0:初始化'."\n"
- .'- 1:等待外呼中'."\n"
- .'- 2:等待重试中'."\n"
- .'- 3:外呼中'."\n"
- .'- 4:外呼结束'."\n"
- .'- 5:外呼失败'."\n"
- ."\n"
- .'只有4和5属于终态。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
- 'Options' => [
- 'description' => '运行时用到的变量信息，会以Key-Value的形式存储在该字段中。',
- 'type' => 'string',
- 'example' => '{'."\n"
- .' "date": "666",'."\n"
- .' "phoneNumber": "777",'."\n"
- .' "distance": "555",'."\n"
- .' "mendian": "444",'."\n"
- .' "sex": "男",'."\n"
- .' "name": "111",'."\n"
- .' "age": "222"'."\n"
- .'}',
- ],
- 'EncryptionType' => [
- 'description' => '加密方式：0-不加密；1-MD5；2-SHA256；3-SM3',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'CalledNumber' => [
- 'description' => '被叫号码。',
- 'type' => 'string',
- 'example' => '0537101****',
- ],
- 'CallResult' => [
- 'description' => '呼叫结果。',
- 'type' => 'string',
- 'example' => '用户接通',
- ],
- 'ConversationTurnCount' => [
- 'description' => '对话轮次。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => '1187**************',
- ],
- 'BatchId' => [
- 'description' => '批次号ID。',
- 'type' => 'string',
- 'example' => '1183**************',
- ],
- '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' => '任务明细ID。',
- 'type' => 'string',
- 'example' => '9662*************',
- ],
- 'OutId' => [
- 'type' => 'string',
- 'example' => 'outId',
- ],
- 'BranchVersionId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '9',
- ],
- 'ConversationRecord' => [
- 'description' => '聊天记录信息。结构为JSON数组，聊天记录时按照时间顺序已经排序好了。具体如下：'."\n"
- .'```json'."\n"
- .'['."\n"
- .' {'."\n"
- .' "content":"聊天内容",'."\n"
- .' "role":"角色",//可取值：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"
- .']',
- ],
- 'ConversationDuration' => [
- 'description' => '通话时长，单位：秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- ],
- ],
- 'example' => '',
- ],
- ],
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D'],
+ 'Data' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Code' => ['description' => '此次通话的唯一回执ID。', 'type' => 'string', 'example' => '116012854210^10281427****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', 'description' => '权限不足，请联系主账号管理员'],
+ ['errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', 'description' => '参数错误'],
+ ],
],
- '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"}]',
- 'title' => '查询通信智能体外呼任务明细',
- 'description' => '- 在查询通信智能体外呼任务明细之前，请确保您已创建外呼任务。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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":""}]',
+ 'title' => '发起智能语音交互通话',
+ 'summary' => '调用AiccsSmartCall接口发起智能语音交互通话。',
+ 'requestParamsDescription' => '### 声音风格列表'."\n"
."\n"
- .'- 若您没有创建外呼任务，可在[外呼任务管理](https://aiccs.console.aliyun.com/agent/task)界面创建外呼任务或者通过[CreateAiCallTask](~~2926796~~)接口创建外呼任务。',
- ],
- 'StopAiCallTask' => [
- 'summary' => '停止通信智能体呼出任务。',
- 'methods' => [
- 'post',
- 'get',
+ .'- 小云标准女声：xiaoyun'."\n"
+ .'- 小刚标准男声：xiaogang'."\n"
+ .'- 若兮温柔女声：ruoxi'."\n"
+ .'- 小梦标准女声：xiaomeng'."\n"
+ .'- 小威标准男声：xiaowei'."\n"
+ .'- 阿美甜美女声：amei'."\n"
+ .'- 小雪温柔女声：xiaoxue'."\n"
+ .'- 思琪温柔女声：siqi'."\n"
+ .'- 思佳标准女声：sijia'."\n"
+ .'- 思诚标准男声：sicheng'."\n"
+ .'- 思悦温柔女声：siyue'."\n"
+ .'- 小美甜美女声：xiaomei'."\n"
+ .'- 思彤标准童声：sitong'."\n"
+ .'- 宁儿标准女声：ninger'."\n"
+ .'- 小北萝莉女声：xiaobei'."\n"
+ .'- 伊娜浙普女声：yina'."\n",
+ 'changeSet' => [
+ ['createdAt' => '2021-06-23T02:52:00.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ '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' => '任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1187**************',
- ],
+ 'schema' => ['description' => '产品名称。默认取值：**aiccs**。', 'type' => 'string', 'required' => false, 'example' => 'aiccs', 'default' => 'aiccs'],
+ ],
+ [
+ 'name' => 'CallId',
+ 'in' => 'query',
+ 'schema' => ['description' => '通话的唯一回执ID。可以通过[SendCcoSmartCall](~~311247~~)获取。', 'type' => 'string', 'required' => false, 'example' => '116012854210^102814279****'],
+ ],
+ [
+ 'name' => 'Command',
+ 'in' => 'query',
+ 'schema' => ['description' => '在智能外呼通话中，指定被叫号码发起的动作。'."\n"
+ ."\n"
+ .'> 当前仅支持参数**parallelBridge**，表示指定动作为被叫号码与呼叫中心坐席桥接。', 'type' => 'string', 'required' => false, 'example' => 'parallelBridge'],
+ ],
+ [
+ 'name' => 'Param',
+ 'in' => 'query',
+ 'schema' => ['description' => '扩展字段。', 'type' => 'string', 'required' => false, 'example' => 'Param'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '7124F972-BAB8-5D1E-90FC-01CB10713B29',
- ],
- 'Data' => [
- 'description' => '返回数据结果。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'enumValueTitles' => [],
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D'],
+ 'Data' => ['description' => '命令执行的结果。'."\n"
+ .'- **true**：命令执行成功。'."\n"
+ .'- **false**：命令执行失败。', 'type' => 'string', 'example' => 'true'],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
- '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' => '停止通信智能体呼出任务',
- 'description' => '- 在停止通信智能体呼出任务之前，请确保您已创建呼出任务且任务状态为运行中。'."\n"
- ."\n"
- .'- 若您没有已创建的呼出任务，请先在[呼出任务管理](https://aiccs.console.aliyun.com/agent/task)界面创建呼出任务或通过[CreateAiCallTask](~~2926796~~)接口创建呼出任务。',
- ],
- 'CancelAiCallDetails' => [
- 'summary' => '通信智能体呼叫任务取消呼叫，如明细记录已经进入待呼队列或者正在呼叫，则无法取消。',
- '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' => '[{"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' => '发起智能语音指定动作',
+ 'summary' => '调用AiccsSmartCallOperate接口在智能外呼通话中，发起指定动作，仅用于并行转人工，人工坐席可旁听人机对话等场景。',
+ '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' => '任务ID。在[呼叫任务管理](https://aiccs.console.aliyun.com/agent/task)界面查看任务ID或通过[QueryAiCallTaskPage](~~2926799~~)接口获取任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '138************'."\n",
- ],
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
- 'name' => 'DetailIdList',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '任务明细ID列表，如果指定了该参数，则以该参数为准，BatchId和PhoneNumbers无效。',
- 'type' => 'array',
- 'items' => [
- 'description' => '任务明细ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面左上角查看任务明细ID或通过[QueryAiCallDetailPage](~~2926853~~)接口获取任务明细ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12131231*****',
- ],
- 'required' => false,
- ],
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'BatchId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '批次ID。即为导入被叫数据时返回的批次ID，在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**界面查看任务批次ID或通过[ImportTaskNumberDatas](~~2926815~~)接口导入被叫数据时返回的导入批次ID，如果指定了DetailIdList，则该参数无效。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '4253331213*****',
- ],
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '坐席账号名称（坐席登录名）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com'],
],
[
- 'name' => 'PhoneNumbers',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '手机号列表，如果需要使用该参数，则必须指定BatchId，否则认为参数无效。',
- 'type' => 'array',
- 'items' => [
- 'description' => '手机号。即为需要取消呼叫任务的手机号码，为导入被叫数据时传入的手机号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '180*******',
- ],
- 'required' => false,
- 'example' => '',
- ],
+ 'name' => 'CallId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的acid。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786'],
],
[
- 'name' => 'EncryptionType',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '36',
- ],
+ 'name' => 'JobId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的jobId。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787'],
+ ],
+ [
+ 'name' => 'ConnectionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的connId。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '46C98E28-9239-5D95-AC76-648B8FD4889A',
- ],
- 'Data' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'TotalCount' => [
- 'description' => '总量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'FailedDetails' => [
- 'description' => '失败明细情况。是个Map，Key为失败的明细ID或者手机号码，Value为失败原因。',
- 'type' => 'object',
- 'example' => '{'."\n"
- .' "176********": "明细记录当前状态不可取消"'."\n"
- .'}',
- ],
- 'FailedCount' => [
- 'description' => '未成功取消是数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '75',
- ],
- 'SucceedCount' => [
- 'description' => '成功取消的数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '81',
- ],
- 'ResultCode' => [
- 'description' => '取消结果。取值：'."\n"
- .'- ALL_FAILED：全部取消失败。'."\n"
- .'- ALL_SUCCEED：全部取消成功。'."\n"
- .'- PART_FAILED：部分取消失败。',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'PART_FAILED',
- ],
- ],
- 'example' => '',
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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' => '通信智能体呼叫任务取消呼叫',
- 'description' => '- 您可调用此接口取消通信智能体呼叫任务，也可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**管理**>**执行记录**>**待完成**界面手动取消通信智能体呼叫任务。'."\n"
- ."\n"
- .'- 调用此接口之前，请确保您已创建呼叫任务且已导入被叫数据。'."\n"
- ."\n"
- .'- 若您没有已创建的呼叫任务，可在呼叫任务管理界面创建呼叫任务并导入被叫数据，或通过[CreateAiCallTask](~~2926796~~)、[ImportTaskNumberDatas](~~2926815~~)接口创建呼叫任务并导入被叫数据。'."\n"
- ."\n"
- .'- 通信智能体呼叫任务取消呼叫后，可能会对您的业务造成影响，请谨慎操作。',
- ],
- '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' => '[{"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' => '接听来电',
+ 'summary' => '调用AnswerCall接听来电。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'AttachTask' => [
+ 'summary' => '追加任务明细。',
+ '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' => '任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1187**************',
- ],
+ 'schema' => ['description' => '任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面获取任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '12****'],
+ ],
+ [
+ 'name' => 'CallString',
+ 'in' => 'query',
+ 'schema' => ['description' => '呼叫字符（被叫信息和参数列表）。取值：'."\n"
+ ."\n"
+ .'- **LIST**：话术没有输入变量时，则使用LIST类型参数，只需传入呼叫号码。如：`0571****5678,0571****5679`。'."\n"
+ .'- **JSON**：话术有输入变量时，则使用JSON类型参数。需要传入变量名称、呼叫号码、变量值。如：`{"ParamNames":["name","age"],"CalleeList":[{"Callee":"181****0000","Params":["张三","20"]},{"Callee":"181****0001","Params":["李四","21"]}]}`。**ParamNames**代表参数名称列表；**Params**代表参数值列表。'."\n"
+ .'> 话术输入变量在[**话术管理**](https://aiccs.console.aliyun.com/patter/list)>**查看**>**输入输出参数**界面查看', 'type' => 'string', 'required' => false, '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"
+ .'}'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '58A32FFF-86EE-5CF0-B365-97E8C574C7F4',
- ],
- 'Data' => [
- 'description' => '启动结果。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'enumValueTitles' => [],
- 'example' => 'false',
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => ['description' => '追加成功的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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"}]',
- 'title' => '启动通信智能体外呼任务',
- 'description' => '- 在启动通信智能体呼出任务之前，请确保您的呼出任务状态为已停止。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '追加明细',
+ 'description' => '- 您在创建智能联络机器人呼叫任务后，可调用此接口追加任务明细。'."\n"
."\n"
- .'- 若您没有已创建的呼叫任务，请先在[呼叫任务管理](https://aiccs.console.aliyun.com/agent/task)界面创建呼叫任务或通过[CreateAiCallTask](~~2926796~~)接口创建呼叫任务。',
- ],
- 'UpdateAiCallTask' => [
- 'summary' => '更新通信智能体外呼任务配置。',
- 'methods' => [
- 'post',
- 'get',
+ .'- 在调用此接口之前，请确保您已有创建成功的智能联络机器人呼叫任务。'."\n"
+ ."\n"
+ .'- 若您没有已创建成功的智能联络机器人呼叫任务，您可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面单击创建任务或通过[CreateTask](~~2718003~~)接口创建任务。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：500次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ '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' => '全部资源', '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',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务名称，同一个账号下不允许重复。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '测试任务',
- ],
- ],
- [
- 'name' => 'VirtualNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '呼出使用的服务实例。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0537022*****',
- ],
- ],
- [
- 'name' => 'StartType',
+ 'name' => 'ProjectName',
'in' => 'query',
- 'schema' => [
- 'description' => '启动方式。取值：'."\n"
- ."\n"
- .'- IMMEDIATE：立即启动。'."\n"
- ."\n"
- .'- SCHEDULE：定时启动。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'IMMEDIATE',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'MissCallRetry',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否开启重试。取值：'."\n"
- ."\n"
- .'- true：是。'."\n"
- ."\n"
- .'- false（默认）：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'CallRetryReason',
+ 'name' => 'CheckFreqType',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '失败重试原因。',
- 'type' => 'array',
- 'items' => [
- 'description' => '具体重试原因。取值：'."\n"
- ."\n"
- .'- CALL_REJECTED：拒接。'."\n"
- ."\n"
- .'- USER_BUSY：被叫忙。'."\n"
- ."\n"
- .'- SUSPEND：停机。'."\n"
- ."\n"
- .'- INVALID_NUMBER：空号。'."\n"
- ."\n"
- .'- POWERED_OFF：关机。'."\n"
- ."\n"
- .'- NETWORK_BUSY：网络忙。'."\n"
- ."\n"
- .'- NO_ANSWER：无应答。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'CALL_REJECTED',
- ],
- 'required' => false,
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1'],
],
[
- 'name' => 'CallRetryTimes',
+ 'name' => 'TimeRangeStart',
'in' => 'query',
- 'schema' => [
- 'description' => '重试次数，最大不能超过3次。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- 'name' => 'CallRetryInterval',
+ 'name' => 'TimeRangeEnd',
'in' => 'query',
- 'schema' => [
- 'description' => '重试间隔，单位：分钟，最大不能超过120分钟。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '25',
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- 'name' => 'CallTime',
+ 'name' => 'AnalysisIds',
'in' => 'query',
- 'style' => 'json',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '可呼叫时间。',
'type' => 'array',
- 'items' => [
- 'description' => '呼叫时间段，格式如下：'."\n"
- .'```json'."\n"
- .'{"startTime":"09:00:00","endTime":"10:00:00"}'."\n"
- .'```'."\n"
- .'`startTime`代表开始时间，`endTime`代表结束时间，仅处于这个时间段内的时刻才会发起呼出调度，否则将等待下一个可调度是间段到来。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"startTime":"09:00:00","endTime":"10:00:00"}',
- ],
+ 'items' => ['type' => 'integer', 'format' => 'int64'],
'required' => true,
+ 'maxItems' => 3,
],
],
[
- 'name' => 'CallDay',
+ 'name' => 'InstanceList',
'in' => 'query',
- 'style' => 'json',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '可外呼日。',
'type' => 'array',
- 'items' => [
- 'description' => '可外呼日。取值：'."\n"
- ."\n"
- .'- MONDAY：周一。'."\n"
- ."\n"
- .'- TUESDAY：周二。'."\n"
- ."\n"
- .'- WEDNESDAY：周三。'."\n"
- ."\n"
- .'- THURSDAY：周四。'."\n"
- ."\n"
- .'- FRIDAY：周五。'."\n"
- ."\n"
- .'- SATURDAY：周六。'."\n"
- ."\n"
- .'- SUNDAY：周天。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'WEDNESDAY' => '周三',
- 'MONDAY' => '周一',
- 'THURSDAY' => '周四',
- 'SUNDAY' => '周天',
- 'TUESDAY' => '周二',
- 'FRIDAY' => '周五',
- 'SATURDAY' => '周六',
- ],
- 'example' => 'MONDAY',
- ],
+ 'items' => ['type' => 'string'],
'required' => true,
+ 'maxItems' => 3,
],
],
[
- 'name' => 'TaskStartTime',
+ 'name' => 'ChannelTouchType',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '任务预设的启动时间，时间戳，单位毫秒。StarType字段为SCHEDULE时该字段有效且必填，任务将在该字段设置的时间进行自动启动。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'type' => 'array',
+ 'items' => ['type' => 'integer', 'format' => 'int32'],
'required' => false,
- 'example' => '1748923429000',
+ 'maxItems' => 3,
],
],
- [
- 'name' => 'TaskId',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '待更新的任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1187**************',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'Data' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['type' => 'string'],
+ 'Version' => ['type' => 'integer', 'format' => 'int32'],
+ 'ProjectId' => ['type' => 'integer', 'format' => 'int64'],
+ ],
+ ],
+ ],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
+ ],
],
],
+ ],
+ '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\\": true\\n}","type":"json"}]',
+ ],
+ 'CancelAiCallDetails' => [
+ 'summary' => '呼叫任务取消呼叫，如明细记录已经进入待呼队列或者正在呼叫，则无法取消。',
+ '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' => '任务ID。在**呼叫任务管理**界面查看任务ID或通过[QueryAiCallTaskPage](~~2926799~~)接口获取任务ID。', 'type' => 'string', 'required' => true, 'example' => '138************'."\n"],
],
[
- 'name' => 'LineEncoding',
+ 'name' => 'DetailIdList',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'type' => 'string',
+ 'description' => '任务明细ID列表，如果指定了该参数，则以该参数为准，BatchId和PhoneNumbers无效。',
+ 'type' => 'array',
+ 'items' => ['description' => '任务明细ID。在**呼叫任务管理**>**详情**>**执行记录**>**已完成**>**通话详情**界面左上角查看任务明细ID或通过[QueryAiCallDetailPage](~~2926853~~)接口获取任务明细ID。', 'type' => 'string', 'required' => false, 'example' => '12131231*****'],
'required' => false,
- 'example' => '示例值示例值示例值',
],
],
[
- 'name' => 'LinePhoneNum',
+ 'name' => 'BatchId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '示例值示例值',
- ],
+ 'schema' => ['description' => '批次ID。即为导入被叫数据时返回的批次ID，在**呼叫任务管理**>**详情**>**执行记录**界面查看任务批次ID或通过[ImportTaskNumberDatas](~~2926815~~)接口导入被叫数据时返回的导入批次ID，如果指定了DetailIdList，则该参数无效。', 'type' => 'string', 'required' => false, 'example' => '4253331213*****'],
],
[
- 'name' => 'Source',
+ 'name' => 'PhoneNumbers',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '手机号列表，如果需要使用该参数，则必须指定BatchId，否则认为参数无效。',
+ 'type' => 'array',
+ 'items' => ['description' => '手机号。即为需要取消呼叫任务的手机号码，为导入被叫数据时传入的手机号码。', 'type' => 'string', 'required' => false, 'example' => '180*******'],
'required' => false,
- 'example' => '31',
+ 'example' => '',
],
],
],
@@ -3139,403 +1421,242 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '错误信息。仅当返回异常时显示。',
- 'type' => 'string',
- 'example' => '参数不合法',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'FCD94A7F-316D-54D1-9BFC-814006CB1C34',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '46C98E28-9239-5D95-AC76-648B8FD4889A'],
'Data' => [
- 'description' => '更新结果。取值：'."\n"
- ."\n"
- .'- **true**：更新成功。'."\n"
- ."\n"
- .'- **false**：更新失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['description' => '总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'FailedDetails' => ['description' => '失败明细情况。是个Map，Key为失败的明细ID或者手机号码，Value为失败原因。', 'type' => 'object', 'example' => '{'."\n"
+ .' "176********": "明细记录当前状态不可取消"'."\n"
+ .'}'],
+ 'FailedCount' => ['description' => '未成功取消是数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '75'],
+ 'SucceedCount' => ['description' => '成功取消的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '81'],
+ 'ResultCode' => [
+ 'description' => '取消结果。取值：'."\n"
+ .'- ALL_FAILED：全部取消失败。'."\n"
+ .'- ALL_SUCCEED：全部取消成功。'."\n"
+ .'- PART_FAILED：部分取消失败。',
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'PART_FAILED',
+ ],
+ ],
+ 'example' => '',
],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。'."\n", 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- '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' => '更新通信智能体外呼任务配置',
- 'description' => '在更新通信智能体外呼任务配置前，请先确保外呼任务的状态为已停止。',
- ],
- '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' => '取消呼叫任务',
+ 'description' => '- 您可调用此接口取消呼叫任务，也可在**呼叫任务管理**>**管理**>**执行记录**>**待完成**界面手动取消呼叫任务。'."\n"
+ ."\n"
+ .'- 调用此接口之前，请确保您已创建呼叫任务且已导入被叫数据。'."\n"
+ ."\n"
+ .'- 若您没有已创建的呼叫任务，可在呼叫任务管理界面创建呼叫任务并导入被叫数据，或通过[CreateAiCallTask](~~2926796~~)、[ImportTaskNumberDatas](~~2926815~~)接口创建呼叫任务并导入被叫数据。'."\n"
+ ."\n"
+ .'- 呼叫任务取消呼叫后，可能会对您的业务造成影响，请谨慎操作。',
+ '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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CancelTask' => [
+ 'summary' => '取消智能联络机器人呼叫任务。',
+ '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' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面查看或通过[CreateTask](~~223556~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12****'],
],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '分页查询时设置的每页行数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- 'default' => '10',
+ 'title' => 'Schema of Response',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => ['description' => '是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口是否调用成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
+ ],
+ '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' => '[{"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' => '取消任务',
+ 'description' => '- 您可调用此接口取消智能联络机器人呼叫任务，也可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面手动取消任务。'."\n"
+ ."\n"
+ .'- 智能联络机器人呼叫任务被取消后，将无法再次启动，请谨慎操作。'."\n"
+ ."\n"
+ .'- 若您想暂停任务之后再次开启任务，可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面手动暂停任务或通过[StopTask](~~2718006~~)接口暂停任务。'."\n"
+ ."\n\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：500次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [],
+ 'ramActions' => [
[
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务状态。取值：'."\n"
- .'- INIT：初始化（未启动）。'."\n"
- .'- FAILED：启动失败。'."\n"
- .'- RUNNING：运行中。'."\n"
- .'- STOPPED：已停止。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => 'INIT',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aiccs:CancelTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'ChangeChatAgentStatus' => [
+ 'summary' => '调用ChangeChatAgentStatus修改在线客服状态。',
+ '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' => ['title' => 'clientToken', 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
- 'name' => 'TaskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1187**************'."\n",
- ],
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '示例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'ApplicationCode',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '示例值',
- ],
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '账户名称', 'description' => '坐席账号。', 'type' => 'string', 'required' => true, 'example' => 'account1'],
],
[
- 'name' => 'Source',
- 'in' => 'query',
+ 'name' => 'Method',
+ 'in' => 'formData',
'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '68',
+ 'title' => '修改到的状态类型',
+ 'description' => '想要切换到的在线状态。目前支持**requestLogout** （申请离线）。',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'requestLogout',
+ 'enum' => ['requestRest', 'requestLogout', 'restToWork'],
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'result',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '错误信息，正常调用时，不会返回该参数。',
- 'type' => 'string',
- 'example' => '参数不合法',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- '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' => '任务ID。',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => '1187**************',
- ],
- 'CompleteRate' => [
- 'description' => '任务完成率。',
- 'type' => 'string',
- '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' => '1180**************'."\n",
- ],
- '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' => '历史接通率。历史接通率=历史接通数量➗累计呼叫量（TotalCallCount）。',
- 'type' => 'string',
- 'example' => '95.89%',
- ],
- 'DayConnectRate' => [
- 'description' => '当天接通率。当天接通率=当天接通数➗当天呼叫量（DayCallCount）。',
- 'type' => 'string',
- 'example' => '74.14%',
- ],
- ],
- ],
- 'example' => '',
- ],
- ],
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['title' => 'message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DF6A3FB7-A5AA-43BE-A65B'],
+ 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => ['title' => 'data', 'description' => '当前客服状态。取值：'."\n"
+ .'- **0**：下班'."\n"
+ .'- **3**：小休', 'type' => 'string', 'example' => '0'],
+ 'Code' => ['title' => 'code', 'description' => '状态码。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['title' => 'success', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => ''],
+ ],
],
- '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"}]',
- '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' => '修改在线客服状态',
+ 'description' => '> 目前仅支持将在线客服状态修改为下班状态。',
+ 'changeSet' => [],
+ 'ramActions' => [],
],
- 'QueryAiCallTaskDetail' => [
- 'summary' => '查询通信智能体外呼任务基础信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ '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' => '任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1187**************',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true],
+ ],
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true],
],
],
'responses' => [
@@ -3543,388 +1664,165 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '错误信息，正常调用时，不会返回该参数。',
- 'type' => 'string',
- 'example' => '参数无效',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '23822ECB-8CAA-5C52-9C9E-807FD82A5A7F',
- ],
- 'Data' => [
- 'description' => '返回结果数据。',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => '1187**************'."\n",
- ],
- 'ApplicationName' => [
- 'type' => 'string',
- 'example' => '示例值',
- ],
- 'RetryEnable' => [
- 'description' => '是否开启外呼重试。取值：'."\n"
- .'- true：开启。'."\n"
- .'- false：未开启。',
- 'type' => 'boolean',
- 'enumValueTitles' => [],
- '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' => '具体重试原因。取值：'."\n"
- ."\n"
- .'- CALL_REJECTED：拒接。'."\n"
- ."\n"
- .'- USER_BUSY：被叫忙。'."\n"
- ."\n"
- .'- SUSPEND：停机。'."\n"
- ."\n"
- .'- INVALID_NUMBER：空号。'."\n"
- ."\n"
- .'- POWERED_OFF：关机。'."\n"
- ."\n"
- .'- NETWORK_BUSY：网络忙。'."\n"
- ."\n"
- .'- NO_ANSWER：无应答。',
- 'type' => 'string',
- 'enumValueTitles' => [],
- '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' => '启动方式。取值：'."\n"
- ."\n"
- .'- IMMEDIATE：立即启动。'."\n"
- ."\n"
- .'- SCHEDULE：定时启动。',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'IMMEDIATE',
- ],
- 'AgentName' => [
- 'description' => '智能体名称。',
- 'type' => 'string',
- 'example' => '测试智能体',
- ],
- 'AgentId' => [
- 'description' => '已上线的智能体编码。',
- 'type' => 'string',
- 'example' => '1180**************'."\n",
- ],
- 'RetryInterval' => [
- 'description' => '重试间隔。单位：分钟。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'CallDays' => [
- 'description' => '可外呼日列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '可外呼日。取值：'."\n"
- ."\n"
- .'- MONDAY：周一。'."\n"
- ."\n"
- .'- TUESDAY：周二。'."\n"
- ."\n"
- .'- WEDNESDAY：周三。'."\n"
- ."\n"
- .'- THURSDAY：周四。'."\n"
- ."\n"
- .'- FRIDAY：周五。'."\n"
- ."\n"
- .'- SATURDAY：周六。'."\n"
- ."\n"
- .'- SUNDAY：周天。',
- 'type' => 'string',
- 'enumValueTitles' => [],
- 'example' => 'MONDAY',
- ],
- 'example' => '',
- ],
- 'ConcurrentCount' => [
- 'description' => '任务并发。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- ],
- 'example' => '',
- ],
- 'Code' => [
- 'description' => '错误编码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'Data' => ['type' => 'string'],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
],
- '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' => '查询通信智能体外呼任务基础信息',
- ],
- '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\\": true\\n}","type":"json"}]',
+ ],
+ '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' => 'OSS文件路径，非必填。'."\n"
- .'> API调用暂时不支持Excel数据类型。因此上传OSS文件路径的方式暂不可用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123dsdfsdfsdf.xlsx',
- ],
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'js sdk中自动生成的鉴权token', 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
- 'name' => 'TaskId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '119181071278******',
- ],
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'PhoneNumberList',
+ 'name' => 'AccountName',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '如果DataType采用JSON列表，则需要通过该字段上传数据，且单次不能超过1000条。',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据结构如下：'."\n"
- .'```json'."\n"
- .'{'."\n"
- .' "calleeNumber":"被叫号码",'."\n"
- .' "outId":"保留key，该字段可用于携带外部流水唯一ID，回执内容中会将该字段携带回来，可以用这个作为唯一呼叫记录，方便关联回执，限制长度128",'."\n"
- .' "variable1":"value",'."\n"
- .' "variable2":"value",//如果智能体中有用到通话变量，则这里variable1、variable2代表每个变量的key，value就是变量的值。'."\n"
- .' }'."\n"
- .'```'."\n"
- .'> 通话变量在[**通信智能体管理**](https://aiccs.console.aliyun.com/agent/customize)>**详情**>**通话变量配置**界面查看。',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{'."\n"
- .' "calleeNumber": "0534556****",'."\n"
- .' "outId": "CFC2F07E-F763-7C48-1A32-6EFFB6EA344E",'."\n"
- .' "name": "Tom",'."\n"
- .' "age": "18"'."\n"
- .'}',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'],
],
[
- 'name' => 'DataType',
- 'in' => 'query',
+ 'name' => 'DisplayName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '坐席对外显示名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'XX测试'],
+ ],
+ [
+ 'name' => 'SkillGroupId',
+ 'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'description' => '数据类型。取值：'."\n"
- .'- EXCEL'."\n"
- .'- JSON'."\n"
- .'><notice>API调用暂时仅支持JSON数据类型。></notice>',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'JSON',
- 'enum' => [
- 'EXCEL',
- 'JSON',
- ],
+ 'description' => '坐席所属技能组ID。',
+ 'type' => 'array',
+ 'format' => 'int64',
+ 'items' => ['description' => '技能组ID。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234****'],
+ 'required' => false,
+ 'maxItems' => 200,
],
],
[
- 'name' => 'EncryptionType',
- 'in' => 'query',
+ 'name' => 'SkillGroupIdList',
+ 'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'description' => '加密方式：0-不加密；1-MD5；2-SHA256；3-SM3',
- 'type' => 'integer',
+ 'description' => '坐席所属技能组ID列表。',
+ 'type' => 'array',
'format' => 'int64',
+ 'items' => ['description' => '技能组ID列表。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1223****,1456****'],
'required' => false,
- 'example' => '1',
+ 'maxItems' => 200,
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'CFC2F07E-F763-7C48-1A32-6EFFB6EA344E',
- ],
- 'Data' => [
- 'description' => '导入批次ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123497836486******'."\n",
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Data' => ['description' => '坐席ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2578****'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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"}]',
- 'title' => '导入被叫数据',
- 'description' => '- 您可调用此接口导入被叫数据，也可在[呼叫任务管理](https://aiccs.console.aliyun.com/agent/task)界面单击导入被叫数据，下载模板并上传文件的方式导入被叫数据。'."\n"
- ."\n"
- .'- 此接口在导入被叫数据时，暂仅支持JSON数据类型导入。'."\n"
+ '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' => '创建坐席',
+ 'summary' => '创建悉犀客服工作台坐席账号，并返回坐席ID。',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
+ .'- 若您需要填写技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ .'- 您可以调用[DeleteAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-deleteagent)删除坐席，或者调用[UpdateAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-updateagent)更新坐席数据对坐席进行管理。'."\n"
."\n"
- .'- 在调用此接口之前，请确保您已有创建成功的呼叫任务。'."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：100次/秒。'."\n"
."\n"
- .'- 若您没有已创建成功的呼叫任务，可在[呼叫任务管理](https://aiccs.console.aliyun.com/agent/task)界面点击创建呼叫任务或通过[CreateAiCallTask](~~2926796~~)接口创建呼叫任务。',
- ],
- 'CreateAiCallTask' => [
- 'summary' => '创建通信智能体外呼任务。',
- 'methods' => [
- 'post',
- 'get',
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-13T03:55:53.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aiccs:CreateAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateAiCallTask' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3937,9 +1835,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '268866',
- 'abilityTreeNodes' => [
- 'FEATUREaiccsTY5M4L',
- ],
+ 'abilityTreeNodes' => ['FEATUREaiccsTY5M4L'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -3947,32 +1843,17 @@
[
'name' => 'TaskName',
'in' => 'query',
- 'schema' => [
- 'description' => '任务名称，同一个账号下不允许重复。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '测试任务',
- ],
+ 'schema' => ['description' => '任务名称，同一个账号下不允许重复。', 'type' => 'string', 'required' => true, 'example' => '测试任务'],
],
[
'name' => 'AgentId',
'in' => 'query',
- 'schema' => [
- 'description' => '已上线的智能体编码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1180**************'."\n",
- ],
+ 'schema' => ['description' => '已上线的智能体编码。', 'type' => 'string', 'required' => false, 'example' => '1180**************'."\n"],
],
[
'name' => 'VirtualNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '呼出使用的服务实例。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '032712122*****',
- ],
+ 'schema' => ['description' => '呼出使用的服务实例。', 'type' => 'string', 'required' => false, 'example' => '032712122*****'],
],
[
'name' => 'StartType',
@@ -3992,17 +1873,11 @@
[
'name' => 'MissCallRetry',
'in' => 'query',
- 'schema' => [
- 'description' => '是否开启重试。取值：'."\n"
- ."\n"
- .'- true：是。'."\n"
- ."\n"
- .'- false（默认）：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => '是否开启重试。取值：'."\n"
+ ."\n"
+ .'- true：是。'."\n"
+ ."\n"
+ .'- false（默认）：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
[
'name' => 'CallRetryReason',
@@ -4031,24 +1906,12 @@
[
'name' => 'CallRetryTimes',
'in' => 'query',
- 'schema' => [
- 'description' => '重试次数，最大不能超过3次。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['description' => '重试次数，最大不能超过3次。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
],
[
'name' => 'CallRetryInterval',
'in' => 'query',
- 'schema' => [
- 'description' => '重试间隔，单位：分钟，最大不能超过720分钟。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '32',
- ],
+ 'schema' => ['description' => '重试间隔，单位：分钟，最大不能超过720分钟。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '32'],
],
[
'name' => 'CallTime',
@@ -4057,16 +1920,13 @@
'schema' => [
'description' => '可呼叫时间段列表。',
'type' => 'array',
- 'items' => [
- 'description' => '呼叫时间段，格式如下：'."\n"
- .'```json'."\n"
- .'{"startTime":"09:00:00","endTime":"10:00:00"}'."\n"
- .'```'."\n"
- .'`startTime`代表开始时间，`endTime`代表结束时间，仅处于这个时间段内的时刻才会发起呼出调度，否则将等待下一个可调度是间段到来。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"startTime":"09:00:00","endTime":"10:00:00"}'."\n",
- ],
+ 'items' => ['description' => '呼叫时间段，格式如下：'."\n"
+ .'```json'."\n"
+ .'{"startTime":"09:00:00","endTime":"10:00:00"}'."\n"
+ .'```'."\n"
+ .'`startTime`代表开始时间，`endTime`代表结束时间，仅处于这个时间段内的时刻才会发起呼出调度，否则将等待下一个可调度是间段到来。'."\n"
+ ."\n"
+ .'> - 根据运营商政策要求，最终执行时间以平台调度为准，您可通过[真实号管理](https://dyvms.console.aliyun.com/number/list/normal)查看号码限呼时段。', 'type' => 'string', 'required' => false, 'example' => '{"startTime":"09:00:00","endTime":"10:00:00"}'."\n"],
'required' => true,
],
],
@@ -4075,10 +1935,10 @@
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '可外呼日列表。',
+ 'description' => '可呼叫日列表。',
'type' => 'array',
'items' => [
- 'description' => '可外呼日。取值：'."\n"
+ 'description' => '可呼叫日。取值：'."\n"
."\n"
.'- MONDAY：周一。'."\n"
.'- TUESDAY：周二。'."\n"
@@ -4098,80 +1958,45 @@
[
'name' => 'TaskStartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '任务预设的启动时间，时间戳，单位毫秒。StarType字段为SCHEDULE时该字段有效且必填，任务将在该字段设置的时间进行自动启动。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12313123133',
- ],
+ 'schema' => ['description' => '任务预设的启动时间，时间戳，单位毫秒。StarType字段为SCHEDULE时该字段有效且必填，任务将在该字段设置的时间进行自动启动。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12313123133'],
],
[
'name' => 'TaskCps',
'in' => 'query',
- 'schema' => [
- 'description' => '任务并发，最大不超过500。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '75',
- ],
+ 'schema' => ['description' => '任务并发，最大不超过500。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '75'],
],
[
'name' => 'Source',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '92',
- ],
+ 'schema' => ['description' => '创建来源：取值'."\n"
+ ."\n"
+ .'- 0：智能体创建'."\n"
+ ."\n"
+ .'- 1：引擎创建', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
],
[
'name' => 'ApplicationCode',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '示例值示例值',
- ],
- ],
- [
- 'name' => 'ApplicationName',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '示例值示例值',
- ],
+ 'schema' => ['description' => '应用code，创建来源为引擎创建时使用', 'type' => 'string', 'required' => false, 'example' => '025****C98'],
],
[
'name' => 'PhoneType',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '54',
- ],
+ 'schema' => ['description' => '号码类型（创建来源为引擎创建时使用）'."\n"
+ ."\n"
+ .'- 0：阿里云号码'."\n"
+ ."\n"
+ .'- 1：客户自带线路', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
],
[
'name' => 'LineEncoding',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '示例值示例值',
- ],
+ 'schema' => ['description' => '线路编码', 'type' => 'string', 'required' => false, 'example' => 'JILIANG_***_***_NET'],
],
[
'name' => 'LinePhoneNum',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => '示例值示例值',
- ],
+ 'schema' => ['description' => '自带线路号码', 'type' => 'string', 'required' => false, 'example' => '152****3120'],
],
],
'responses' => [
@@ -4179,1995 +2004,968 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '8C93B345-F702-5449-BA7E-7D110D4BF798',
- ],
- 'Data' => [
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1213123123*****',
- ],
- 'Code' => [
- 'description' => '请求状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8C93B345-F702-5449-BA7E-7D110D4BF798'],
+ 'Data' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1213123123*****'],
+ 'Code' => ['description' => '请求状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建呼叫任务',
+ 'summary' => '创建呼叫任务。',
+ 'description' => '在创建呼叫任务之前，请先使用智能体进行拨测以确认效果符合您的要求。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-24T09:12:26.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2025-12-24T08:27:56.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ '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"}]',
- 'title' => '创建通信智能体外呼任务',
- 'description' => '在创建外呼任务之前，请先使用智能体进行拨测以确认效果符合您的要求。',
],
- 'LlmSmartCall' => [
- 'summary' => '基于大模型的智能外呼。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateAiOutboundTask' => [
+ 'summary' => '创建智能外呼任务。支持创建时设置任务类型、任务名、外呼主叫号码、被叫号码重复策略等。',
+ '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',
- 'in' => 'query',
- 'schema' => [
- 'description' => '接收智能外呼的被叫号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '137****0000',
- ],
- ],
- [
- 'name' => 'CallerNumber',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '主叫号码，为必填参数，仅支持中国内地号码。请前往语音服务[真实号管理](https://dyvmsnext.console.aliyun.com/number/list/normal)界面查看号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '132****2054',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'cc_xp_pre-cn-***'],
],
[
- 'name' => 'ApplicationCode',
+ 'name' => 'Type',
'in' => 'query',
'schema' => [
- 'description' => '大模型应用编码。在[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面查看。',
- 'type' => 'string',
+ 'title' => '任务类型（2:预测式外呼3:自动外呼）',
+ 'description' => '任务类型。取值：'."\n"
+ .'- **2**：预测式外呼。'."\n"
+ .'- **3**：自动外呼。',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => true,
- 'example' => 'F32******',
- ],
- ],
- [
- 'name' => 'StartWordParam',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '开场白变量。请前往[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面单击详情查看您创建的大模型开场白变量。',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{'."\n"
- .' "name": "小明",'."\n"
- .' "address": "浙江省杭州市"'."\n"
- .'}',
+ 'example' => '2',
+ 'enum' => ['2', '3'],
],
],
[
- 'name' => 'PromptParam',
+ 'name' => 'Name',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => 'Prompt提示词变量。请前往[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面单击详情查看您创建的Prompt提示词变量。',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{'."\n"
- .' "style": "温柔"'."\n"
- .'}',
- ],
+ 'schema' => ['title' => '任务名（1～15字符）', 'description' => '任务名。1～15字符。', 'type' => 'string', 'required' => true, 'example' => '测试任务', 'maxLength' => 15, 'minLength' => 1],
],
[
- 'name' => 'OutId',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '预留给调用方使用的 ID，最终会通过回执消息将此ID带回给调用方，长度为1~15个字节。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '222356****',
- 'maxLength' => 32,
- ],
+ 'schema' => ['title' => '任务描述（0～100字符）', 'description' => '任务描述。0～100字符。', 'type' => 'string', 'required' => false, 'example' => '房产销售', 'maxLength' => 100],
],
[
- 'name' => 'BizParam',
+ 'name' => 'OutboundNums',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '业务参数，请求客户模型时，会将此参数带入给客户模型。',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{\\"testKey\\":\\"test\\"}',
- ],
- ],
- [
- 'name' => 'Extension',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'X号码的分机号码，不超过5位。'."\n"
+ 'title' => '外呼主叫号码',
+ 'description' => '外呼主叫号码。'."\n"
."\n"
- .'><notice>仅在AXN分机号模式下需要填写，如果不存在分机号，请务必不要填写。></notice>',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- 'maxLength' => 5,
+ .'> 必须是已购买的号码，多个号码用半角逗号（,）隔开。',
+ 'type' => 'array',
+ 'items' => ['description' => '外呼主叫号码。'."\n"
+ .'> 必须是已购买的号码，多个号码用半角逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => '["0571****5678","0571****5678"]'],
+ 'required' => true,
],
],
[
- 'name' => 'SessionTimeout',
+ 'name' => 'NumRepeated',
'in' => 'query',
'schema' => [
- 'description' => '最大通话时长，超时后自动挂断。单位：秒。'."\n"
- .'>'."\n"
- .'>- 最大取值：3600s。'."\n"
- .'>- 最小取值：600s。',
+ 'title' => '被叫号码重复策略（0任务内去重，1不去重）',
+ 'description' => '被叫号码重复策略。取值：'."\n"
+ .'- **0**：任务内去重。'."\n"
+ .'- **1**：不去重。',
'type' => 'integer',
'format' => 'int32',
- 'required' => false,
- 'maximum' => '3600',
- 'minimum' => '300',
- 'example' => '1200',
+ 'required' => true,
+ 'example' => '1',
+ 'enum' => ['0', '1'],
],
],
[
- 'name' => 'TtsVoiceCode',
+ 'name' => 'HandlerId',
'in' => 'query',
- 'schema' => [
- 'description' => 'TTS 播放时的音色编码。'."\n"
- ."\n"
- .'> '."\n"
- .'> - 不设置值时，默认取大模型应用配置的音色编码。'."\n"
- .'> - 支持通过[ListAvailableTts](~~2926668~~)接口查看全部音色编码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'V65******',
- ],
+ 'schema' => ['title' => '技能组id（预测式外呼）或者ivr id（自动外呼）', 'description' => '对应的技能组ID（预测式外呼）或者IVR ID（自动外呼）。请您在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)获取信息。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
],
[
- 'name' => 'TtsSpeed',
+ 'name' => 'ExecutionTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'TTS 播放时的声音速度。'."\n"
- ."\n"
- .'> '."\n"
- .'> - 取值范围：-200~200，默认值为0。'."\n"
- .'> - 不设置值时，默认取大模型应用配置的声音速度。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- ],
+ 'schema' => ['title' => '任务执行时间', 'description' => '任务执行时间。JSON格式。'."\n"
+ ."\n"
+ .'> 结束时间（end）需晚于开始时间（start）。', 'type' => 'string', 'required' => true, '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"}]}'],
],
[
- 'name' => 'TtsVolume',
+ 'name' => 'ConcurrentRate',
'in' => 'query',
- 'schema' => [
- 'description' => 'TTS 播放的音量。'."\n"
- .'> '."\n"
- .'> - 取值范围：0~100，默认值为0。'."\n"
- .'> - 不设置值时，默认取大模型应用配置的音量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '自动外呼的呼叫并发', 'description' => '自动外呼的呼叫并发。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'CustomerLineCode',
+ 'name' => 'RecallRule',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '用户自带线路编码。'."\n"
- .'> '."\n"
- .'> - 若使用客户自带线路，请联系小二开通此功能；'."\n"
- .'> - 线路编码由小二给出，若无，请不要设置值。',
- 'type' => 'string',
+ 'title' => '失败重呼策略（为空则不重呼）',
+ 'description' => '失败重呼策略。'."\n"
+ ."\n"
+ .'> 取值为空则不重呼。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Count' => ['title' => '重呼次数（1～3）', 'description' => '重呼次数。取值范围：**1～3**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3', 'minimum' => '1', 'example' => '1'],
+ 'Interval' => ['title' => '重呼间隔时间（1～60分钟）', 'description' => '重呼间隔时间。取值范围：**1～60**，单位：分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '60', 'minimum' => '1', 'example' => '1'],
+ ],
'required' => false,
- 'example' => 'SELF_xxxxx_A_NET',
],
],
+ [
+ 'name' => 'ForecastCallRate',
+ 'in' => 'query',
+ 'schema' => ['title' => '预测式外呼固定外呼比例（>=1）', 'description' => '预测式外呼固定外呼比例。取值范围：**≥1**。', 'type' => 'number', 'format' => 'float', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '1.5'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D',
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'CallId' => [
- 'description' => '此次通话的唯一回执ID。',
- 'type' => 'string',
- 'example' => '125165515***^11195613****',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => ['title' => '任务id', 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
+ 'Code' => ['description' => '请求状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6A51251-F7C4-596A-9F45-3C3219A5450D\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"CallId\\": \\"125165515***^11195613****\\"\\n}","type":"json"}]',
- 'title' => '大模型智能呼叫',
- 'description' => '- 调用一次接口仅支持添加一个被叫号码。如果有多个被叫号码，可以多次调用。'."\n"
+ '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":""}]',
+ 'title' => '创建智能外呼任务',
+ 'description' => '- 此接口返回参数中的**Data**即是任务ID。'."\n"
+ .'- 创建智能外呼任务后，若有更新需要，您可以调用[UpdateAiOutboundTask](~~2718021~~)接口更新外呼任务。'."\n"
."\n"
- .'- 在基于大模型发起智能呼叫之前，请确保您在[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面已创建大模型应用；在语音服务[真实号管理](https://dyvmsnext.console.aliyun.com/number/list/normal)界面已有申请成功的真实号码。',
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：20次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [],
+ 'ramActions' => [],
],
- 'LlmSmartCallEncrypt' => [
- 'summary' => '基于大模型加密号码智能呼叫。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateAiOutboundTaskBatch' => [
+ 'summary' => '根据实例ID、任务ID创建智能外呼任务的任务批次，使得任务下的数据可以按批次查询。',
+ 'methods' => ['post'],
+ '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',
- 'in' => 'query',
- 'schema' => [
- 'description' => '加密被叫号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '140*********243',
- ],
- ],
- [
- 'name' => 'PromptParam',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '大模型应用prompt参数。',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{"prompt":"推荐一部电影"}',
- ],
- ],
- [
- 'name' => 'StartWordParam',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '大模型应用开场白参数。',
- 'type' => 'object',
- 'required' => false,
- 'example' => '{"name":"小明","address":"浙江省杭州市"}',
- ],
- ],
- [
- 'name' => 'ApplicationCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '大模型应用编码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AD******45',
- ],
- ],
- [
- 'name' => 'CallerNumber',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '主叫号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '132******65',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_***'],
],
[
- 'name' => 'OutId',
+ 'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '客户自定义outId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dsa*******sad',
- ],
+ 'schema' => ['title' => '任务id', 'description' => '任务ID。'."\n"
+ ."\n"
+ .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F92F9749-105E-518F-8B08-CF16EF36A0E2',
- ],
- 'Data' => [
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'CallId' => [
- 'description' => '呼叫ID。',
- 'type' => 'string',
- 'example' => '149******206',
- ],
- ],
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => ['title' => '新建的任务批次版本id', 'description' => '新建的任务批次版本ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '123456'],
+ 'Code' => ['description' => '请求状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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":"<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' => '创建智能外呼任务的任务批次',
+ 'description' => '调用前，建议您确认实例ID、任务ID，请参见[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ ."\n\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：20次/秒。'."\n"
+ .'- API频率：20次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAiOutboundTaskBatch'],
+ ],
],
- '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' => '大模型加密号智能外呼',
+ 'ramActions' => [],
],
- 'HangupOperate' => [
- 'summary' => '通信智能引擎中主动挂断通话。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'CreateDepartment' => [
+ 'summary' => '根据AICCS实例ID、部门名称创建部门信息，创建成功后会返回部门ID。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'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',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'allowEmptyValue' => false,
- 'schema' => [
- 'description' => '通话回执ID。您可通过[LlmSmartCall](~~2862828~~)或[LlmSmartCallEncrypt](~~2881065~~)接口获取通话回执ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '14777672****^13452272****',
- ],
+ 'schema' => ['title' => '实例id', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'ImmediateHangup',
+ 'name' => 'DepartmentName',
'in' => 'query',
- 'schema' => [
- 'description' => '是否立刻挂断。取值：'."\n"
- ."\n"
- .'- true（默认值）：立刻挂断。'."\n"
- ."\n"
- .'- false：前正在播放的内容播放完再挂断。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
+ 'schema' => ['title' => '部门名称', 'description' => '部门名称。', 'type' => 'string', 'required' => true, 'example' => '部门A'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EFD543DD-E087-54A2-AC0B-54E0656511D7',
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK表示请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Mesage' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Result' => [
- 'description' => '返回结果。取值：'."\n"
- ."\n"
- .'- **true**：挂断成功。'."\n"
- ."\n"
- .'- **false**：挂断失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'HttpStatusCode' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => ['description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter.CallId',
- 'errorMessage' => 'The parameter CallId is invalid.',
- ],
+ 500 => [
+ ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => '系统错误，请联系管理员！'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFD543DD-E087-54A2-AC0B-54E0656511D7\\",\\n \\"Code\\": \\"OK\\",\\n \\"Mesage\\": \\"OK\\",\\n \\"Result\\": true\\n}","type":"json"}]',
- 'title' => '通信智能引擎主动挂断通话',
- 'description' => '- 在通信智能引擎主动挂断通话之前，请先确保已有基于大模型发起的通话。'."\n"
+ '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' => '创建部门信息',
+ 'description' => '- 若您需要更新部门信息，可调用[UpdateDepartment](~~2717977~~)接口。'."\n"
+ .'- 调用此接口创建部门信息成功后，返回参数的**Data**即为部门ID，若您后续还需查询部门ID，可调用[GetAllDepartment](~~2717975~~)接口。'."\n"
."\n"
- .'- 若没有基于大模型发起的通话，您可以通过[LlmSmartCall](~~2862828~~)或[LlmSmartCallEncrypt](~~2881065~~)接口发起通话。',
- ],
- 'ListAvailableTts' => [
- 'summary' => '获取大模型外呼支持的TTS音色列表，包括系统预置音色和个性化音色。',
- 'methods' => [
- 'post',
- 'get',
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T12:37:29.000Z', 'description' => 'OpenAPI 下线'],
],
- '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' => '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',
+ 'name' => 'TaskType',
'in' => 'query',
- 'schema' => [
- 'title' => '复刻音色编码',
- 'description' => '个性化音色编码，在[个性化音色](https://aiccs.console.aliyun.com/engine/voiceprint)界面查看音色编码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'V9A******',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息；只有RAM校验失败才会返回此字段。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'RequestId' => [
- 'title' => '',
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- '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' => '音色平台。取值：'."\n"
- ."\n"
- .'- CosyVoice：个性化音色或系统预置音色。'."\n"
- ."\n"
- .'- Volcano：豆包音色。',
- 'type' => 'string',
- 'example' => 'CosyVoice',
- ],
- 'TtsStyle' => [
- 'title' => '音色cosy类型 cosyvoice-v2-XXXX-XXXX',
- 'description' => '音色风格。',
- 'type' => 'string',
- 'example' => 'cosyvoice-v2-*********-*******',
- ],
- 'TtsAuditionFileUrl' => [
- 'title' => '音色试听文件',
- 'description' => '音色试听文件。',
- 'type' => 'string',
- 'example' => 'https://*******/longxiaoxia.mp3',
- ],
- 'TtsVoiceCode' => [
- 'title' => '音色编码',
- 'description' => '音色编码。',
- 'type' => 'string',
- 'example' => 'V9A******'."\n",
- ],
- ],
- 'enumValueTitles' => [],
- ],
- 'example' => '',
- ],
- 'Code' => [
- 'title' => '',
- 'description' => '状态码。返回OK表示调用成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'title' => '',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10', 'minimum' => '0'],
],
- ],
- '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"}]',
- 'title' => '获取大模型呼叫支持的TTS音色列表',
- 'description' => '若您在[个性化音色](https://aiccs.console.aliyun.com/engine/voiceprint)界面没有已创建且上线的音色，则只能查到系统预置的音色。',
- ],
- 'GetCallDialogContent' => [
- 'summary' => '通过CallId查询对话内容，只支持查询近一个月通话已结束的通话对话内容。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '275547',
- 'abilityTreeNodes' => [
- 'FEATUREaiccsA3JJUR',
+ 'name' => 'TaskName',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'CallDate',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'description' => '外呼日期，只可查询最近30天的日期，格式：yyyy-MM-dd。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2025-06-06',
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- 'name' => 'CallId',
+ 'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'description' => '呼叫记录ID，用于标识一条通话记录。'."\n"
- ."\n"
- .'> 在调用大模型外呼接口LlmSmartCall是，会返回此呼叫记录ID，即CallId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123456^123478',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息；只有RAM校验失败才会返回此字段。',
- 'type' => 'string',
- 'example' => 'Access Denied',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'FB0B0481-F13E-16E0-8A7A-1AD2FXXXEF55',
- ],
- 'Message' => [
- 'description' => '返回消息',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'Data' => [
- 'description' => '返回数据结果。',
- 'type' => 'object',
- 'properties' => [
- 'DialogContent' => [
- 'description' => '对话内容',
- 'type' => 'string',
- 'example' => '[{\\"content\\":\\"您好。\\",\\"role\\":\\"assistant\\"},{\\"content\\":\\"不用了。\\",\\"role\\":\\"user\\"},{\\"content\\":\\"呃，不用了，再见，谢谢。\\",\\"role\\":\\"user\\"}]',
- ],
- 'CallId' => [
- 'description' => '呼叫ID',
- 'type' => 'string',
- 'example' => '123456^123478'."\n",
- ],
- 'CallStatus' => [
- 'description' => '呼叫状态 '."\n"
- .'> 呼叫状态返回值描述'."\n"
- .'> - 0：未接通；'."\n"
- .'> - 1：已接通；'."\n"
- .'> - 2：已挂断；',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- ],
- ],
- 'Code' => [
- 'description' => '请求返回Code。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter.CallId',
- 'errorMessage' => 'The parameter CallId is invalid.',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
- ],
- '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' => '通过CallId查询近一个月通话已结束的通话对话内容',
- ],
- 'GetHotlineServiceStatistics' => [
- 'summary' => '获取热线监控下服务统计量。支持实例、时间纬度、坐席、部门、技能组分组查询。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'StartDate',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'EndDate',
+ 'name' => 'RetryTime',
'in' => 'query',
- 'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '3', 'minimum' => '0', 'default' => '0'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'RetryInterval',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '2880', 'minimum' => '0', 'default' => '0'],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'SkillGroup',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0'],
],
[
- 'name' => 'AgentIds',
+ 'name' => 'Ani',
'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '坐席id列表',
- 'description' => '坐席ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '坐席ID。'."\n"
- ."\n"
- .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'DepIds',
+ 'name' => 'GroupName',
'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '部门id列表',
- 'description' => '部门ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- 'name' => 'GroupIds',
+ 'name' => 'Model',
'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '技能组id列表',
- 'description' => '技能组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
- ],
- 'required' => false,
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '10', 'minimum' => '0'],
],
[
- 'name' => 'TimeLatitudeType',
+ 'name' => 'DepartmentId',
'in' => 'query',
- 'schema' => [
- 'title' => '时间纬度类型',
- 'description' => '时间纬度类型分组查询。取值：'."\n"
- .'- **minute**：分钟。'."\n"
- .'- **hour**：小时。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'minute',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0'],
],
[
- 'name' => 'ExistAgentGrouping',
+ 'name' => 'ExtAttrs',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据坐席分组',
- 'description' => '是否根据坐席分组查询。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- 'name' => 'ExistDepartmentGrouping',
+ 'name' => 'CallInfos',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据部门分组',
- 'description' => '是否根据部门分组查询。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- 'name' => 'ExistSkillGroupGrouping',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据技能组分组',
- 'description' => '是否根据技能组分组查询。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- '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' => '信息为List<Map>类型的JSON字符串。',
- '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}',
- ],
- ],
- ],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态编码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '调用接口是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'Data' => ['type' => 'string'],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
],
'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 \\"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' => '获取热线监控下服务统计量',
- 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写坐席、部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
- ."\n"
- .' n_idle_now：当前空闲坐席数'."\n"
- .' n_resttype_now：当前小休坐席数'."\n"
- .' n_resttype1_now：当前普通小休坐席数'."\n"
- .' n_resttype2_now：当前就餐小休坐席数'."\n"
- .' n_resttype3_now：当前会议小休坐席数'."\n"
- .' n_resttype4_now：当前辅导小休坐席数'."\n"
- .' n_resttype5_now：当前培训小休坐席数'."\n"
- .' n_resttype98_now：当前强制小休坐席数'."\n"
- .' n_resttype99_now：当前签入小休坐席数'."\n"
- .' n_ack_now：当前后处理坐席数'."\n"
- .' n_online_now：当前在线坐席数'."\n"
- .' n_busy_now：通话坐席数'."\n"
- .' group_name：技能组名称'."\n"
- .' group_id：技能组ID'."\n"
- .' department_id：部门ID'."\n"
- .' department_name：部门名称'."\n"
- .' date_id：日期'."\n"
- .' tenant_id：租户ID'."\n"
- .' tenant_name：租户名称'."\n"
- .' '."\n"
- .' '."\n"
- .' ',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetSkillGroupAndAgentStatusSummary' => [
- 'summary' => '获取热线监控下技能组坐席汇总状态量。支持实例、时间区间、部门、技能组分组查询。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateQualityProject' => [
+ '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',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'StartDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
+ 'name' => 'CheckFreqType',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1'],
],
[
- 'name' => 'EndDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
+ 'name' => 'ScopeType',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1'],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'name' => 'TimeRangeStart',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- 'name' => 'CurrentPage',
- 'in' => 'query',
+ 'name' => 'TimeRangeEnd',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
+ ],
+ [
+ 'name' => 'ChannelTouchType',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'type' => 'array',
+ 'items' => ['type' => 'integer', 'format' => 'int32'],
'required' => false,
- 'example' => '1',
+ 'maxItems' => 3,
],
],
[
- 'name' => 'DepIds',
- 'in' => 'query',
- 'style' => 'simple',
+ 'name' => 'DepList',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '部门id列表',
- 'description' => '部门ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
+ 'items' => ['type' => 'integer', 'format' => 'int64'],
'required' => false,
+ 'maxItems' => 3,
],
],
[
- 'name' => 'GroupIds',
- 'in' => 'query',
- 'style' => 'simple',
+ 'name' => 'GroupList',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '技能组id列表',
- 'description' => '技能组ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。'."\n"
- ."\n\n"
- .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
- ],
+ 'items' => ['type' => 'integer', 'format' => 'int64'],
'required' => false,
+ 'maxItems' => 3,
],
],
[
- 'name' => 'ExistDepartmentGrouping',
- 'in' => 'query',
+ 'name' => 'ServicerList',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '是否根据部门分组',
- 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
'required' => false,
- 'example' => 'false',
+ 'maxItems' => 3,
],
],
[
- 'name' => 'ExistSkillGroupGrouping',
- 'in' => 'query',
+ 'name' => 'AnalysisIds',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '是否根据技能组分组',
- 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ 'type' => 'array',
+ 'items' => ['type' => 'integer', 'format' => 'int64'],
+ 'required' => true,
+ 'maxItems' => 3,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'message',
- ],
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
'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' => '信息为List<Map>类型的JSON字符串。',
- '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}',
- ],
+ 'InstanceId' => ['type' => 'string'],
+ 'Version' => ['type' => 'integer', 'format' => 'int32'],
+ 'ProjectId' => ['type' => 'integer', 'format' => 'int64'],
],
],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态编码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '接口调用是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
],
- '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' => '获取热线监控下技能组坐席汇总状态量',
- 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- ."\n\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
- ."\n"
- .' n_idle_now：当前空闲坐席数'."\n"
- .' n_resttype_now：当前小休坐席数'."\n"
- .' n_resttype1_now：当前普通小休坐席数'."\n"
- .' n_resttype2_now：当前就餐小休坐席数'."\n"
- .' n_resttype3_now：当前会议小休坐席数'."\n"
- .' n_resttype4_now：当前辅导小休坐席数'."\n"
- .' n_resttype5_now：当前培训小休坐席数'."\n"
- .' n_resttype98_now：当前强制小休坐席数'."\n"
- .' n_resttype99_now：当前签入小休坐席数'."\n"
- .' n_ack_now：当前后处理坐席数'."\n"
- .' n_online_now：当前在线坐席数'."\n"
- .' n_busy_now：通话坐席数'."\n"
- .' tenant_id：租户ID'."\n"
- .' tenant_name：租户名称'."\n"
- .' group_id：技能组ID'."\n"
- .' group_name：技能组名称'."\n"
- .' department_id：部门ID'."\n"
- .' department_name：部门名称'."\n"
- .' date_id：日期',
- ],
- 'GetDepartmentalLatitudeAgentStatus' => [
- 'summary' => '获取热线监控下部门纬度状态量。支持实例、时间区间、部门分组查询。',
- 'methods' => [
- 'get',
+ 'errorCodes' => [
+ 500 => [
+ ['errorMessage' => 'The specified parameter is invalid.', 'errorCode' => 'InvalidParameter', 'description' => '传入参数不正确'],
+ ],
],
- 'schemes' => [
- 'http',
- '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\\": true\\n}","type":"json"}]',
+ ],
+ 'CreateQualityRule' => [
+ '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',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'StartDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'EndDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
+ 'name' => 'RuleTag',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '20',
- ],
+ 'name' => 'MatchType',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'CurrentPage',
- 'in' => 'query',
+ 'name' => 'KeyWords',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
+ 'required' => true,
+ 'maxItems' => 3,
],
],
- [
- 'name' => 'DepIds',
- 'in' => 'query',
- 'style' => 'simple',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '技能组分组id列表',
- 'description' => '部门ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
- 'required' => false,
],
],
+ ],
+ '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\\": true\\n}","type":"json"}]',
+ ],
+ 'CreateSkillGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ExistDepartmentGrouping',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否根据技能组分组id分组显示',
- 'description' => '是否根据部门分组查询。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
+ ],
+ [
+ 'name' => 'SkillGroupName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '技能组名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '在线自动化技能组'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'formData',
+ 'schema' => ['description' => '技能组描述。', 'type' => 'string', 'required' => false, 'example' => '在线自动化技能组'],
+ ],
+ [
+ 'name' => 'DisplayName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '技能组对外显示名。', 'type' => 'string', 'required' => false, 'example' => '在线自动化技能组'],
+ ],
+ [
+ 'name' => 'ChannelType',
+ 'in' => 'formData',
+ 'schema' => ['description' => '技能组类型。取值：'."\n"
+ ."\n"
+ .'- **1**：热线。'."\n"
+ .'- **2**：在线。'."\n"
+ .'- **3**：工单。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '7', 'minimum' => '0', 'example' => '2'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-****-70b6a298d94d'],
+ ],
+ [
+ 'name' => 'DepartmentId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '部门ID', 'description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'result',
- 'description' => 'result',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'message',
- ],
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Data' => [
- 'title' => '数据',
- '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' => '信息为List<Map>类型的JSON字符串。',
- 'type' => 'string',
- '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}',
- ],
- ],
- ],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态码。返回200代表请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '接口调用是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Data' => ['description' => '创建成功的技能组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['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' => ''],
+ ],
],
- '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' => '获取热线监控下部门纬度状态量',
- 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写部门信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '创建技能组',
+ 'summary' => '根据技能组名称和渠道类型创建技能组。',
+ 'description' => '- 此接口可定义技能组的对外显示名、描述等信息，具体请参见[请求参数](#api-detail-35)。'."\n"
+ .'- 此接口返回的**Data**参数即为创建成功的技能组ID。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：1000次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
- ."\n"
- .' n_idle_now：当前空闲坐席数'."\n"
- .' n_resttype_now：当前小休坐席数'."\n"
- .' n_resttype1_now：当前普通小休坐席数'."\n"
- .' n_resttype2_now：当前就餐小休坐席数'."\n"
- .' n_resttype3_now：当前会议小休坐席数'."\n"
- .' n_resttype4_now：当前辅导小休坐席数'."\n"
- .' n_resttype5_now：当前培训小休坐席数'."\n"
- .' n_resttype98_now：当前强制小休坐席数'."\n"
- .' n_resttype99_now：当前签入小休坐席数'."\n"
- .' n_ack_now：当前后处理坐席数'."\n"
- .' n_online_now：当前在线坐席数'."\n"
- .' n_busy_now：通话坐席数'."\n"
- .' tenant_id：租户ID'."\n"
- .' tenant_name：租户名称'."\n"
- .' department_id：部门ID'."\n"
- .' department_name：部门名称'."\n"
- .' date_id：日期'."\n"
- .' n_inqueue_now：排队中会员数'."\n"
- .' n_inservice_now：服务中会员数'."\n"
- .' time_value：时间戳'."\n"
- .' fst_assign_time：该队列最早的时间，排队中的分配时间',
- ],
- 'GetSkillGroupLatitudeState' => [
- 'summary' => '获取热线下监控技能组纬度状态量。支持实例、时间区间、部门、技能组分组查询。',
- 'methods' => [
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2021-05-21T09:25:21.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'CreateTask' => [
+ 'summary' => '创建智能联络机器人呼叫任务。',
+ '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' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['description' => '任务名称。支持中文和英文，0～30个字符。', 'type' => 'string', 'required' => true, 'example' => '测试任务'],
],
[
- 'name' => 'StartDate',
+ 'name' => 'RobotId',
'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
+ 'schema' => ['description' => '指定机器人ID（话术ID）。表示选择哪个机器人话术发起呼叫。'."\n"
+ ."\n"
+ .'您可在控制台的[话术管理](https://aiccs.console.aliyun.com/patter/list)页面，获取话术ID。', 'type' => 'string', 'required' => true, 'example' => '12****'],
],
[
- 'name' => 'EndDate',
+ 'name' => 'Caller',
'in' => 'query',
- 'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
+ 'schema' => ['description' => '外呼主叫号码。'."\n"
+ ."\n"
+ .'> 必须是已购买的号码，多个号码用英文逗号（,）隔开。', 'type' => 'string', 'required' => true, 'example' => '0571****5678,0571****5679'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'CallString',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => '呼叫字符（被叫信息和参数列表）。取值：'."\n"
+ ."\n"
+ .'- **LIST**：`05715678****,05715679****`'."\n"
+ .'- **JSON**：`{"ParamNames":["name","age"],"CalleeList":[{"Callee":"1810000****","Params":["张三","20"]},{"Callee":"1810001****","Params":["李四","21"]}]}`。其中ParamNames代表参数名称列表；Params代表参数值列表。'."\n"
+ ."\n"
+ .'> - 参数名称列表和参数值列表顺序需要对应。 '."\n"
+ .'- 最多1000个被叫号码。'."\n"
+ ."\n\n"
+ ."\n", 'type' => 'string', 'required' => false, 'example' => '{"ParamNames":["name","age"],"CalleeList":[{"Callee":"1810000****","Params":["张三","20"]},{"Callee":"1810001****","Params":["李四","21"]}]}'],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'CallStringType',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '呼叫字符串类型。取值：'."\n"
+ ."\n"
+ .'- **LIST**'."\n"
+ .'- **JSON**', 'type' => 'string', 'required' => true, 'example' => 'JSON'],
],
[
- 'name' => 'DepIds',
+ 'name' => 'RetryFlag',
'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '部门id列表',
- 'description' => '部门ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '是否自动重拨。取值：'."\n"
+ ."\n"
+ .'- **1**：重拨。'."\n"
+ .'- **0**：不重拨。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'GroupIds',
+ 'name' => 'RetryCount',
'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '技能组id列表',
- 'description' => '技能组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '重拨次数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
- 'name' => 'ExistDepartmentGrouping',
+ 'name' => 'RetryInterval',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据部门分组',
- 'description' => '是否根据部门分组。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '重拨间隔。单位：分钟，必须大于1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
- 'name' => 'ExistSkillGroupGrouping',
+ 'name' => 'RetryStatusCode',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据技能组分组',
- 'description' => '是否根据技能组分组。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '需要重拨的通话状态。多个状态使用英文逗号（,）分隔。取值：'."\n"
+ ."\n"
+ .'- **200010**：关机。'."\n"
+ .'- **200011**：停机。'."\n"
+ .'- **200002**：占线。'."\n"
+ .'- **200012**：呼损。'."\n"
+ .'- **200005**：无法接通。'."\n"
+ .'- **200003**：无应答。', 'type' => 'string', 'required' => false, 'example' => '200010,200011'],
+ ],
+ [
+ 'name' => 'StartNow',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否立即启动。'."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => '是', 'default' => 'false'],
+ ],
+ [
+ 'name' => 'WorkTimeList',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作时间列表（精确到分钟）。', 'type' => 'string', 'required' => true, 'example' => '10:00-12:00,13:00-14:00'],
+ ],
+ [
+ 'name' => 'WorkDay',
+ 'in' => 'query',
+ 'schema' => ['description' => '工作日期。取值：'."\n"
+ ."\n"
+ .'- **1**：星期一。'."\n"
+ .'- **2**：星期二。'."\n"
+ .'- **3**：星期三。'."\n"
+ .'- **4**：星期四。'."\n"
+ .'- **5**：星期五。'."\n"
+ .'- **6**：星期六。'."\n"
+ .'- **7**：星期天。'."\n", 'type' => 'string', 'required' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'SeatCount',
+ 'in' => 'query',
+ 'schema' => ['description' => '并发数量（坐席数量）。', 'type' => 'string', 'required' => true, 'example' => '3'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- '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' => '信息为List<Map>类型的JSON字符串。',
- '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":"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}',
- ],
- ],
- ],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态编码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '接口调用是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => ['description' => '机器人呼叫任务的唯一任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12****'],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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\\": \\"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' => '获取热线下监控技能组纬度状态量',
- 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ '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":""}]',
+ 'title' => '创建任务',
+ 'description' => '- 您可以调用此接口创建任务，也可以在**智能联络中心控制台**>**智能外呼机器人（标准版）**>[任务管理](https://aiccs.console.aliyun.com/job/list)>单击**创建任务**进行创建。'."\n"
+ .'- 调用此接口后，返回参数的**Data**为机器人呼叫任务的唯一任务ID。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：500次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
- ."\n"
- .' n_idle_now：当前空闲坐席数'."\n"
- .' n_resttype_now：当前小休坐席数'."\n"
- .' n_resttype1_now：当前普通小休坐席数'."\n"
- .' n_resttype2_now：当前就餐小休坐席数'."\n"
- .' n_resttype3_now：当前会议小休坐席数'."\n"
- .' n_resttype4_now：当前辅导小休坐席数'."\n"
- .' n_resttype5_now：当前培训小休坐席数'."\n"
- .' n_resttype98_now：当前强制小休坐席数'."\n"
- .' n_resttype99_now：当前签入小休坐席数'."\n"
- .' n_ack_now：当前后处理坐席数'."\n"
- .' tenant_id：租户ID'."\n"
- .' tenant_name：租户名称'."\n"
- .' group_id：技能组ID'."\n"
- .' group_name：技能组名称'."\n"
- .' department_id：部门ID'."\n"
- .' department_name：部门名称'."\n"
- .' n_online_now：当前在线坐席数'."\n"
- .' n_inqueue_now：排队中会员数'."\n"
- .' n_inservice_now：服务中会员数'."\n"
- .' time_value：时间戳'."\n"
- .' fst_assign_time：该队列最早的时间，排队中的分配时间'."\n",
- ],
- 'GetAgentBasisStatus' => [
- 'summary' => '获取热线监控下坐席纬度状态量。支持实例、时间区间、坐席、部门分组查询。',
- 'methods' => [
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aiccs:CreateTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateThirdSsoAgent' => [
+ 'summary' => '根据用户账号创建免登到客服工作台的坐席。',
+ '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' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'clientToken', 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
+ ],
+ [
'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => 'param1', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre***'],
],
[
- 'name' => 'StartDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
+ 'name' => 'ClientId',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'param2', 'description' => '颁发给租户实例的clientId。', 'type' => 'string', 'required' => true, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
- 'name' => 'EndDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
+ 'name' => 'AccountId',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'param3', 'description' => '要同步的账号ID。', 'type' => 'string', 'required' => true, 'example' => 'accountId1'],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'param4', 'description' => '要同步的账号名称。', 'type' => 'string', 'required' => true, 'example' => 'accountName1'],
],
[
- 'name' => 'CurrentPage',
- 'in' => 'query',
- 'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'DisplayName',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'param5', 'description' => '坐席显示名称。', 'type' => 'string', 'required' => false, 'example' => '张三'],
],
[
- 'name' => 'AgentIds',
- 'in' => 'query',
- 'style' => 'simple',
+ 'name' => 'SkillGroupIds',
+ 'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'title' => '坐席id列表',
- 'description' => '坐席ID列表。',
+ 'title' => 'param6',
+ 'description' => '技能组ID列表。'."\n"
+ ."\n",
'type' => 'array',
- 'items' => [
- 'description' => '坐席ID。'."\n"
- ."\n"
- .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '["2256****","2257****"]',
- ],
+ 'items' => ['description' => '技能组ID。'."\n"
+ .'> 所传技能组必须属于同一个技能组分组。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
'required' => false,
],
],
[
- 'name' => 'DepIds',
- 'in' => 'query',
- 'style' => 'simple',
+ 'name' => 'RoleIds',
+ 'in' => 'formData',
+ 'style' => 'flat',
'schema' => [
- 'title' => '部门id列表',
- 'description' => '部门ID列表。',
+ 'title' => 'param7',
+ 'description' => '角色ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '["6083****","6084****"]',
- ],
+ 'items' => ['description' => '角色ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
'required' => false,
],
],
@@ -6175,745 +2973,597 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'result',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- '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' => '信息为List<Map>类型的JSON字符串。',
- 'type' => 'string',
- '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"}',
- ],
- ],
- ],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '调用接口是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Message' => ['title' => 'message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'Success'],
+ 'RequestId' => ['title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Data' => ['title' => '新创建的坐席id', 'description' => '创建的坐席ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
+ 'Code' => ['title' => 'code', 'description' => '状态码。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => 'success', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '[{"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' => '创建免登到客服工作台的坐席',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateThirdSsoAgent'],
+ ],
],
- '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' => '获取热线监控下坐席纬度状态量',
- 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写坐席、部门信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
- .' '."\n"
- .' servicer_id：坐席ID'."\n"
- .' servicer_name：坐席名称'."\n"
- .' servicer_real_name：坐席真实姓名'."\n"
- .' department_id：部门ID'."\n"
- .' department_name：部门名称'."\n"
- .' servicer_status：热线坐席状态'."\n"
- .' servicer_status_name：热线坐席名称'."\n"
- .' status_start_time：状态开始时间'."\n"
- .' assign_status：分配状态'."\n"
- .' rest_type：小休类型',
+ 'ramActions' => [],
],
- 'GetAgentStatistics' => [
- 'summary' => '获取热线监控下坐席纬度统计量。支持实例、时间区间、坐席、部门分组查询。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteAgent' => [
+ 'summary' => '根据实例ID及坐席账号名称，删除悉犀客服工作台坐席账号。',
+ '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' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => 'js sdk中自动生成的鉴权token', 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298****'],
],
[
- 'name' => 'StartDate',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'EndDate',
+ 'name' => 'AccountName',
'in' => 'query',
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束日期时间戳。单位：毫秒。 ',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
+ 'description' => 'result',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
+ ],
+ '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' => '[{"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' => '删除坐席',
+ 'description' => '- 删除前，建议您确认需删除的坐席账号名称及实例ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ .'- 若误操作删除坐席，可以调用[CreateAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-createagent)接口，重新创建坐席。'."\n"
+ ."\n"
+ .'> 账号删除后重新添加，坐席ID不变。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-14T01:41:39.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aiccs:DeleteAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'DeleteAiOutboundTask' => [
+ 'summary' => '根据实例ID、任务ID删除智能外呼任务。删除后，获取外呼任务列表时无法获取到该任务。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'CurrentPage',
- 'in' => 'query',
- 'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
[
- 'name' => 'AgentIds',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '坐席id列表',
- 'description' => '坐席ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '坐席ID。'."\n"
- ."\n"
- .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '实例id', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_***'],
],
[
- 'name' => 'DepIds',
+ 'name' => 'TaskId',
'in' => 'query',
- 'style' => 'simple',
+ 'schema' => ['title' => '任务id', 'description' => '任务ID。'."\n"
+ ."\n"
+ .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '部门id列表',
- 'description' => '部门ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Code' => ['description' => '请求状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
- 'required' => false,
],
],
+ ],
+ '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' => '删除智能外呼任务',
+ 'description' => '><notice>删除为敏感操作，请谨慎操作。></notice>'."\n"
+ ."\n"
+ .'- 删除前，建议您确认需删除的任务ID及信息，您可以调用[GetAiOutboundTaskList](~~2718026~~)接口查看外呼任务列表，确认任务名称、描述及对应的任务ID。'."\n"
+ .'- 若需重新创建智能外呼任务，您可以调用[CreateAiOutboundTask](~~312260~~)接口。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：20次/秒。'."\n"
+ .'- API频率：20次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAiOutboundTask'],
+ ],
+ ],
+ 'ramActions' => [],
+ ],
+ 'DeleteDepartment' => [
+ 'summary' => '根据AICCS实例ID、部门ID删除部门信息。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'TimeLatitudeType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '时间纬度类型',
- 'description' => '时间纬度类型。取值：'."\n"
- ."\n"
- .'- **minute**：分钟。'."\n"
- .'- **hour**：小时。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'minute',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
[
- 'name' => 'ExistDepartmentGrouping',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据部门分组',
- 'description' => '是否根据部门分组查询。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '实例id', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'ExistAgentGrouping',
+ 'name' => 'DepartmentId',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据坐席分组',
- 'description' => '是否根据坐席分组查询。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '部门id', 'description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](~~2717975~~)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- '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' => '信息为List<Map>类型的JSON字符串。',
- 'type' => 'string',
- '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}',
- ],
- ],
- ],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '调用接口是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。'."\n",
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'seccessful'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Data' => ['description' => '是否成功。取值：'."\n"
+ .'- **true**：成功'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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',
- ],
+ ['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\\": \\"{\\\\\\"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' => '获取热线监控下坐席纬度统计量',
- 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写坐席、部门信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ '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' => '删除部门信息',
+ 'description' => '- 删除为敏感操作，请您谨慎操作。'."\n"
."\n"
+ .'- 调用此接口前，建议您确认AICCS实例ID及部门ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ .'- 若误删除部门信息，您可以调用[CreateDepartment](~~2717974~~)接口重新创建。'."\n"
+ ."\n\n"
.'### QPS限制'."\n"
.'- 单用户调用频率：100次/秒。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- 'responseParamsDescription' => '返回参数Rows参数说明： '."\n"
- .' '."\n"
- .' t_incall_ring：呼入振铃时长'."\n"
- .' t_incall_speak：呼入时长'."\n"
- .' t_outcall_dial：拨号时长-外部'."\n"
- .' t_outcall_speak：呼出时长'."\n"
- .' t_internal_dial：内部拨号时长'."\n"
- .' t_internal_speak：内部通话时长'."\n"
- .' t_internal_ring：内部振铃时长'."\n"
- .' t_consult_internal_speak：求助时长（内部）'."\n"
- .' t_consulted_internal_ring：求助振铃时长（内部）'."\n"
- .' t_consulted_internal_speak：被求助时长（内部）'."\n"
- .' t_consult_external_speak：求助时长（外部）'."\n"
- .' t_conference_speak：会议时长'."\n"
- .' t_hold：保持时长'."\n"
- .' t_held：被保持时长'."\n"
- .' t_login：登录时长'."\n"
- .' t_resttype_1：普通小休时长'."\n"
- .' t_resttype_2：就餐小休时长'."\n"
- .' t_resttype_3：会议小休时长'."\n"
- .' t_resttype_4：辅导小休时长'."\n"
- .' t_resttype_5：培训小休时长'."\n"
- .' t_resttype_98：系统强制小休时长'."\n"
- .' t_resttype_99：坐席签入小休时长'."\n"
- .' t_idle：空闲时长'."\n"
- .' t_acw：后处理时长（外呼）'."\n"
- .' t_outcall_acw_end：外呼后处理'."\n"
- .' t_incall_acw_end：呼入后处理'."\n"
- .' n_incall_ring：呼入振铃次数'."\n"
- .' n_incall_speak：呼入量'."\n"
- .' n_outcall_dial：拨号量--外部'."\n"
- .' n_outcall_speak：呼出量'."\n"
- .' n_internal_dial：内部拨号次数'."\n"
- .' n_internal_speak：内部通话次数'."\n"
- .' n_internal_ring：内部振铃次数'."\n"
- .' n_consult_internal_dial：求助发起次数（内部）'."\n"
- .' n_consult_internal_speak：求助次数（内部）'."\n"
- .' n_consulted_internal_ring：被求助振铃次数（内部）'."\n"
- .' n_consulted_internal_speak：被求助次数（内部）'."\n"
- .' n_consult_external_dial：发起求助次数（外部）'."\n"
- .' n_consult_external_speak：求助次数（外部）'."\n"
- .' n_send_conference：发起会议次数'."\n"
- .' n_conference_speak：会议次数'."\n"
- .' n_send_step_transfer：单步转接发起次数'."\n"
- .' n_send_finish_transfer：双步转接次数'."\n"
- .' n_send_monitor_error：监听失败次数'."\n"
- .' n_hold：保持次数'."\n"
- .' n_held：被保持次数'."\n"
- .' n_resttype_1：普通小休次数'."\n"
- .' n_resttype_2：就餐小休次数'."\n"
- .' n_resttype_3：会议小休次数'."\n"
- .' n_resttype_4：辅导小休次数'."\n"
- .' n_resttype_5：培训小休次数'."\n"
- .' n_resttype_98：系统强制小休次数'."\n"
- .' n_resttype_99：坐席签入小休次数'."\n"
- .' n_acw：后处理次数'."\n"
- .' n_outcall_acw_end：后处理次数-呼出'."\n"
- .' n_incall_acw_end：后处理次数-呼入',
- ],
- 'GetOnlineServiceVolume' => [
- 'summary' => '获取在线监控下在线服务量。支持实例、时间区间、坐席、部门、技能组分组查询。',
- 'methods' => [
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T12:37:29.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDepartment'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'DeleteHotlineNumber' => [
+ 'summary' => '调用DeleteHotlineNumber接口删除配置的热线号码。',
+ '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' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => '实例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'StartDate',
- 'in' => 'query',
+ 'name' => 'HotlineNumber',
+ 'in' => 'formData',
+ 'schema' => ['title' => '号码', 'description' => '热线号码。', 'type' => 'string', 'required' => true, 'example' => '05710000****', 'pattern' => '^\\d+$'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F'],
+ 'Message' => ['title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Code' => ['title' => '错误码', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['title' => '接口调用是否成功', 'description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\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' => '删除配置的热线号码',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-22T12:36:22.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHotlineNumber'],
+ ],
+ ],
+ 'ramActions' => [],
+ ],
+ 'DeleteOutboundTask' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
[
- 'name' => 'EndDate',
+ 'name' => 'OutboundTaskId',
'in' => 'query',
- 'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'Data' => ['type' => 'string'],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
+ ],
],
],
+ ],
+ '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\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteOuterAccount' => [
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'CurrentPage',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
+ [
+ 'name' => 'OuterAccountId',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '外部账号ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
[
- 'name' => 'AgentIds',
+ 'name' => 'OuterAccountType',
'in' => 'query',
- 'style' => 'simple',
+ 'schema' => ['description' => '外部账号类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aliyun'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '坐席id列表',
- 'description' => '坐席ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '坐席ID。'."\n"
- ."\n"
- .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Data' => ['description' => '是否成功。取值：'."\n"
+ .'- **true**：成功'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
- 'required' => false,
],
],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => '系统错误，请联系管理员！'],
+ ],
+ ],
+ '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' => '删除外部账号',
+ 'summary' => '调用DeleteOuterAccount根据外部账号ID删除外部账号。',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ ],
+ 'DeleteQualityProject' => [
+ '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' => 'InstanceId',
'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '部门id列表',
- 'description' => '部门ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'GroupIds',
+ 'name' => 'ProjectId',
'in' => 'query',
- 'style' => 'simple',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'default' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '技能组id列表',
- 'description' => '技能组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'Data' => ['type' => 'string'],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
- 'required' => false,
],
],
+ ],
+ '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\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteQualityRule' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
[
- 'name' => 'TimeLatitudeType',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '时间纬度类型',
- 'description' => '时间纬度类型。取值：'."\n"
- .'- **minute**：分钟。'."\n"
- .'- **hour**：小时。'."\n"
- .'- **day**：天。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'minute',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'ExistAgentGrouping',
+ 'name' => 'Id',
'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '是否根据坐席分组',
- 'description' => '是否根据坐席分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'Data' => ['type' => 'string'],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
+ ],
],
],
+ ],
+ '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\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteSkillGroup' => [
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ExistDepartmentGrouping',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
+ [
+ 'name' => 'OuterGroupType',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据部门分组',
- 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '外部技能组类型,有以下枚举值： 1：热线 2：在线'."\n"
+ .'4：工单', 'type' => 'string', 'required' => false, 'example' => '2'],
],
[
- 'name' => 'ExistSkillGroupGrouping',
+ 'name' => 'OuterGroupId',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据技能组分组',
- 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '外部技能组id', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '服务数据。',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- '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' => '信息为List<Map>类型的JSON字符串。',
- 'type' => 'string',
- '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}',
- ],
- ],
- ],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '调用接口是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '错误描述', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID，用于跟踪错误原因', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Data' => ['description' => '数据', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '错误编码', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 500 => [
+ ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => '系统错误，请联系管理员！'],
+ ],
],
- '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' => '获取在线监控下在线服务量',
- 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写坐席、部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
- .' '."\n"
- .' online_direct_request_cnt：直连请求量'."\n"
- .' online_transfer_request_cnt：转交请求量（转交代表是别人转交给该小二的）'."\n"
- .' online_direct_giveup_cnt：直连放弃量'."\n"
- .' online_transfer_giveup_cnt：转交放弃量'."\n"
- .' online_direct_ready_cnt：直连接起量'."\n"
- .' online_transfer_ready_cnt：转交接起量'."\n"
- .' online_10s_direct_ready_cnt：直连10s接起量'."\n"
- .' online_10s_transfer_ready_cnt：转交10s接起量'."\n"
- .' online_20s_direct_ready_cnt：直连20s接起量'."\n"
- .' online_20s_transfer_ready_cnt：转交20s接起量'."\n"
- .' online_30s_direct_ready_cnt：直连30s接起量'."\n"
- .' online_30s_transfer_ready_cnt：转交30s接起量'."\n"
- .' online_40s_direct_ready_cnt：直连40s接起量'."\n"
- .' online_40s_transfer_ready_cnt：转交40s接起量'."\n"
- .' online_60s_direct_ready_cnt：直连60s接起量'."\n"
- .' online_60s_transfer_ready_cnt：转交60s接起量'."\n"
- .' online_over_out_cnt：技能组溢出量'."\n"
- .' online_over_in_cnt：技能组溢入量'."\n"
- .' online_sat_cnt：满意数'."\n"
- .' online_normal_cnt：一般数'."\n"
- .' online_unsat_cnt：不满意数'."\n"
- .' service_time_len：总服务时长'."\n"
- .' wait_time_len：总等待时长',
- ],
- 'GetSeatInformation' => [
- 'summary' => '获取在线监控下部门坐席服务能力数据。支持实例、时间区间、部门分组查询。',
- 'methods' => [
- 'get',
+ '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":""}]',
+ 'title' => '删除技能组',
+ 'summary' => '根据技能组id、技能组渠道类型，删除外部技能组。',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'DescribeRecordData' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6925,630 +3575,390 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '15566',
+ 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'startDate',
+ 'name' => 'ProdCode',
'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
+ 'schema' => ['description' => '产品名称。默认取值：**aiccs**。', 'type' => 'string', 'required' => false, 'example' => 'aiccs', 'default' => 'aiccs'],
],
[
- 'name' => 'endDate',
+ 'name' => 'AccountType',
'in' => 'query',
- 'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
+ 'schema' => ['description' => '帐户类型。', 'type' => 'string', 'required' => false, 'example' => 'BUC_TYPE'],
],
[
- 'name' => 'pageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'currentPage',
+ 'name' => 'AccountId',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '帐户ID。', 'type' => 'string', 'required' => false, 'example' => '2235****'],
],
[
- 'name' => 'depIds',
+ 'name' => 'Acid',
'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '部门id列表',
- 'description' => '部门ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => false, 'example' => '1004849****'],
],
[
- 'name' => 'existDepartmentGrouping',
+ 'name' => 'SecLevel',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据部门分组',
- 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '录音脱敏等级。取值范围：**1-4**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- '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',
- ],
- 'Rowr' => [
- 'title' => '信息为list<map>类型的json字符串',
- 'description' => '信息为List<Map>类型的JSON字符串。',
- 'type' => 'string',
- '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}',
- ],
- ],
- ],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '调用接口是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Acid' => ['description' => '会话ID。', 'type' => 'string', 'example' => '1004849****'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'OssLink' => ['description' => '录音文件链接。', 'type' => 'string', 'example' => 'https://****'],
+ 'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => '1212****'],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', 'description' => '权限不足，请联系主账号管理员'],
+ ['errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', '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 \\"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":""}]',
- 'title' => '获取在线监控下部门坐席服务能力数据',
- 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写部门信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
- ."\n"
- .' svc_no_client_cnt：空闲座席数'."\n"
- .' svc_rest_cnt：小休座席数'."\n"
- .' svc_online_cnt：在线中的座席'."\n"
- .' svc_avai_capacity：当前空余服务能力'."\n"
- .' svc_ask_rest_servicer_num：申请小休的座席'."\n"
- .' svc_ask_offline_servicer_num：申请离线的座席'."\n"
- .' svc_offline_cnt：离线座席'."\n"
- .' svc_max_capacity：最大服务能力'."\n"
- .' svc_current_capacity：当前最大服务能力'."\n"
- .' max_speci_ability_num：最大的鲸吞加1能力服务量'."\n"
- .' current_speci_ability_num：当前的鲸吞加1能力服务量'."\n"
- .' special_ability_num：当前可分配的鲸吞加1的服务量'."\n"
- .' servicer_rest_cnt：小休次数',
- ],
- 'GetSkillGroupServiceCapability' => [
- 'summary' => '获取在线监控下技能组纬度服务能力数据。支持实例、时间区间、部门、技能组分组查询。',
- 'methods' => [
- 'get',
+ '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' => '获取通话记录',
+ 'summary' => '调用DescribeRecordData接口获取通话信息。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:DescribeRecordData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', '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' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'StartDate',
+ 'name' => 'ProjectId',
'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0'],
],
[
- 'name' => 'EndDate',
+ 'name' => 'ProjectName',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
+ ],
+ [
+ 'name' => 'CheckFreqType',
'in' => 'query',
- 'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'ProjectVersion',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1'],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'ScopeType',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1'],
+ ],
+ [
+ 'name' => 'TimeRangeStart',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'TimeRangeEnd',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'AnalysisIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ 'type' => 'array',
+ 'items' => ['type' => 'integer', 'format' => 'int64'],
+ 'required' => true,
+ 'maxItems' => 3,
],
],
[
- 'name' => 'DepIds',
+ 'name' => 'DepList',
'in' => 'query',
- 'style' => 'simple',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '部门id列表',
- 'description' => '部门ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
+ 'items' => ['type' => 'integer', 'format' => 'int64'],
'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '0',
+ 'maxItems' => 3,
],
],
[
- 'name' => 'GroupIds',
+ 'name' => 'GroupList',
'in' => 'query',
- 'style' => 'simple',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '技能组id列表',
- 'description' => '技能组ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
+ 'items' => ['type' => 'integer', 'format' => 'int64'],
'required' => false,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '0',
+ 'maxItems' => 3,
],
],
[
- 'name' => 'ExistDepartmentGrouping',
+ 'name' => 'ServicerList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '是否根据部门分组',
- 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
'required' => false,
- 'example' => 'true',
+ 'maxItems' => 3,
],
],
[
- 'name' => 'ExistSkillGroupGrouping',
+ 'name' => 'ChannelTouchType',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '是否根据技能组分组',
- 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'type' => 'array',
+ 'items' => ['type' => 'integer', 'format' => 'int32'],
+ 'required' => true,
+ 'maxItems' => 3,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
'Data' => [
- 'title' => 'data',
- 'description' => '数据列表。',
- 'type' => 'object',
- 'properties' => [
- 'TotalNum' => [
- 'title' => '总记录数',
- 'description' => '总记录数。',
- 'type' => 'integer',
- 'format' => 'int64',
- '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' => '信息为List<Map>类型的JSON字符串。',
- 'type' => 'string',
- '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"
- .'}',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['type' => 'string'],
+ 'Version' => ['type' => 'integer', 'format' => 'int32'],
+ 'ProjectId' => ['type' => 'integer', 'format' => 'int64'],
],
],
],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '调用接口是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
],
- '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":""}]',
- 'title' => '获取在线监控下技能组纬度服务能力数据',
- 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
- ."\n"
- .' tenant_id：租户ID'."\n"
- .' tenant_name：租户名称'."\n"
- .' group_name：技能组名称'."\n"
- .' department_id：部门ID'."\n"
- .' department_name：部门名称'."\n"
- .' svc_no_client_cnt：空闲座席数'."\n"
- .' svc_rest_cnt：小休座席数'."\n"
- .' svc_online_cnt：在线中的座席'."\n"
- .' svc_avai_capacity：当前空余服务能力'."\n"
- .' svc_ask_rest_servicer_num：申请小休的座席'."\n"
- .' svc_ask_offline_servicer_num：申请离线的座席'."\n"
- .' svc_offline_cnt：离线座席'."\n"
- .' svc_max_capacity：最大服务能力'."\n"
- .' svc_current_capacity：当前最大服务能力'."\n"
- .' max_speci_ability_num：最大的鲸吞加1能力服务量'."\n"
- .' current_speci_ability_num：当前的鲸吞加1能力服务量'."\n"
- .' special_ability_num：当前可分配的鲸吞加1的服务量 '."\n"
- .' servicer_rest_cnt：小休次数'."\n"
- .' pk_id：主键',
- ],
- 'GetSkillGroupAgentStatusDetails' => [
- '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\\": true\\n}","type":"json"}]',
+ ],
+ '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' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'StartDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1614824872',
- ],
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'EndDate',
- 'in' => 'query',
+ '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, 'maximum' => '1000', 'minimum' => '1'],
+ ],
+ [
+ 'name' => 'QualityRuleId',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true],
+ ],
+ [
+ 'name' => 'KeyWords',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1614824972',
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
+ 'required' => true,
+ 'maxItems' => 3,
],
],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
+ ],
],
],
+ ],
+ '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\\": true\\n}","type":"json"}]',
+ ],
+ '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' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'DepIds',
+ 'name' => 'AnalysisTypes',
'in' => 'query',
- 'style' => 'simple',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '部门id列表',
- 'description' => '部门ID列表。',
'type' => 'array',
'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
+ 'Name' => ['type' => 'string', 'required' => false],
+ ],
],
- 'required' => false,
+ 'required' => true,
+ 'maxItems' => 100,
],
],
- [
- 'name' => 'GroupIds',
- 'in' => 'query',
- 'style' => 'simple',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '技能组id列表',
- 'description' => '技能组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'Data' => ['type' => 'string'],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
- 'required' => false,
],
],
+ ],
+ '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\\": true\\n}","type":"json"}]',
+ ],
+ 'EncryptPhoneNum' => [
+ 'summary' => '调用EncryptPhoneNum将用户手机号码进行加密。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
[
- 'name' => 'ExistDepartmentGrouping',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据部门分组',
- 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '实例Id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre***'],
],
[
- 'name' => 'ExistSkillGroupGrouping',
+ 'name' => 'PhoneNum',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据技能组分组',
- 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '号码明文', 'description' => '号码明文。', 'type' => 'string', 'required' => true, 'example' => '130****0000'],
],
],
'responses' => [
@@ -7558,588 +3968,376 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'title' => 'data',
- 'description' => '数据列表。',
- 'type' => 'object',
- 'properties' => [
- 'TotalNum' => [
- 'title' => '总记录数',
- 'description' => '总记录数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
- 'PageNum' => [
- 'title' => '当前页数',
- 'description' => '当前页数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页的数量',
- 'description' => '每页的数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2000',
- ],
- 'Rows' => [
- 'title' => '信息为list<map>类型的json字符串',
- 'description' => '信息为List<Map>类型的JSON字符串。',
- 'type' => 'string',
- '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}',
- ],
- ],
- ],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '接口调用是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'Data' => ['title' => '加密后密文', 'description' => '加密后密文。', 'type' => 'string', 'example' => '20nJ****/9Fl/kxx/***7'],
+ 'Code' => ['title' => '错误码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '接口调用是否成功', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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\\\\\\", \\\\\\"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":""}]',
- 'title' => '获取技能组服务状态量',
- 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
- ."\n"
- .' group_name：技能组名称'."\n"
- .' department_id：部门ID'."\n"
- .' department_name：部门名称'."\n"
- .' tenant_id：租户ID'."\n"
- .' tenant_name：租户名称'."\n"
- .' svc_no_client_cnt：空闲座席数'."\n"
- .' svc_rest_cnt：小休座席数'."\n"
- .' svc_online_cnt：在线中的座席'."\n"
- .' svc_avai_capacity：当前空余服务能力'."\n"
- .' svc_ask_rest_servicer_num：申请小休的座席'."\n"
- .' svc_ask_offline_servicer_num：申请离线的座席'."\n"
- .' svc_offline_cnt：离线座席'."\n"
- .' svc_max_capacity：最大服务能力'."\n"
- .' svc_current_capacity：当前最大服务能力'."\n"
- .' max_speci_ability_num：最大的鲸吞加1能力服务量'."\n"
- .' current_speci_ability_num：当前的鲸吞加1能力服务量'."\n"
- .' special_ability_num：当前可分配的鲸吞加1的服务量',
- ],
- 'GetOnlineSeatInformation' => [
- 'summary' => '获取在线监控下在线坐席信息数据。支持实例、时间区间、坐席、部门分组查询。',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": \\"20nJ****/9Fl/kxx/***7\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\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' => '将用户手机号码进行加密',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-25T12:05:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EncryptPhoneNum'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'FetchCall' => [
+ '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' => '客户请求唯一id，用于幂等校验，可以用uuid生成', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
+ ],
+ [
'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'StartDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '坐席账号名称（坐席登录名）', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com'],
],
[
- 'name' => 'EndDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
+ 'name' => 'CallId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的acid', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786'],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'name' => 'JobId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的jobId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787'],
],
[
- 'name' => 'CurrentPage',
- 'in' => 'query',
- 'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'name' => 'ConnectionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的connId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788'],
],
[
- 'name' => 'AgentIds',
- 'in' => 'query',
- 'style' => 'simple',
+ 'name' => 'HoldConnectionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的holdConnId（ 仅在双步转时传入）', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '坐席id列表',
- 'description' => '坐席ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '坐席ID。'."\n"
- ."\n"
- .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
+ 'description' => 'result',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => '错误描述', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID，用于跟踪错误原因', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Code' => ['description' => '错误编码', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true'],
],
- 'required' => false,
],
],
+ ],
+ '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' => '[{"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":""}]',
+ 'title' => '取回通话信息',
+ 'summary' => '取回\\恢复通话。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ ],
+ 'FinishHotlineService' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
[
- 'name' => 'DepIds',
- 'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '部门id列表',
- 'description' => '部门ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
- ],
- 'required' => false,
- ],
+ 'BearerToken' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
+ ],
+ [
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码描述。 ',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- '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' => '信息为List<Map>类型的JSON字符串。',
- 'type' => 'string',
- '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****"}',
- ],
- ],
- ],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '调用接口是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。'."\n",
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 500 => [
+ ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => '没有发现租户实例'],
+ ['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\\\\\\",\\\\\\"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' => '获取在线监控下在线坐席信息数据',
- 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写坐席、部门信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
+ '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":"<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' => '结束热线服务',
+ 'summary' => '根据实例ID、坐席账号名称结束热线服务。',
+ 'description' => '### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
- ."\n"
- .' department_id：部门ID'."\n"
- .' tenant_id：租户ID'."\n"
- .' tenant_name：租户名称'."\n"
- .' current_service_num：当前服务能力'."\n"
- .' max_service_num：最大服务能力'."\n"
- .' max_speci_ability_num：鲸吞加1，当前的最大使用能力'."\n"
- .' current_speci_ability_num：鲸吞加1，当前的已经使用能力'."\n"
- .' speci_ability_status：鲸吞加1。当前的状态，n0：暂停分配状态，n1：可分配状态'."\n"
- .' servicer_status_name：热线坐席名称'."\n"
- .' fst_login_time：当天最早的登录时间'."\n"
- .' lst_login_time：当天最晚的登录时间'."\n"
- .' servicer_rest_cnt：小休次数 ',
- ],
- 'GetQueueInformation' => [
- 'summary' => '获取在线监控下技能组纬度队列信息。支持实例、时间区间、部门、技能组分组查询。',
- 'methods' => [
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'GenerateWebSocketSign' => [
+ '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' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-****-70b6a298d94d'],
],
[
- 'name' => 'StartDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'EndDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'],
],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Data' => ['description' => 'MessageBox消息通道签名码。', 'type' => 'string', 'example' => 'dnthF_oinHg7JMJDmKqex3UxDD7'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。'."\n", 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
+ ],
+ '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' => '[{"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' => '生成MessageBox通道签名',
+ 'summary' => '根据AICCS实例ID和坐席账号名称，生成消息通道访问签名。',
+ 'description' => '- 您可以通过此接口生成消息通道访问签名，返回参数的**Data**即为MessageBox消息通道签名码。 '."\n"
+ ."\n"
+ .'- 调用前建议您确认AICCS实例ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [
+ ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ ],
+ 'GetAgent' => [
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'CurrentPage',
- 'in' => 'query',
- 'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'AK' => [],
],
[
- 'name' => 'DepIds',
- 'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '部门id列表',
- 'description' => '部门ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
- ],
- 'required' => false,
- ],
+ 'BearerToken' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
[
- 'name' => 'GroupIds',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '技能组id列表',
- 'description' => '技能组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => 'js sdk中自动生成的鉴权token', 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
- 'name' => 'ExistDepartmentGrouping',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据部门分组',
- 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'ExistSkillGroupGrouping',
+ 'name' => 'AccountName',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据技能组分组',
- 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Data' => [
- 'title' => 'data',
- 'description' => '数据列表。',
+ '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' => '信息为List<Map>类型的JSON字符串。',
- 'type' => 'string',
- '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}',
+ 'Status' => ['description' => '坐席状态。取值：'."\n"
+ ."\n"
+ .'- **0**：正常'."\n"
+ .'- **1**：冻结'."\n"
+ .'- **2**：删除'."\n"
+ ."\n"
+ .'> 只有正常的状态，才可进行业务活动。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'TenantId' => ['description' => '坐席所属的租户ID，与请求参数中的实例ID相对应。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'GroupList' => [
+ 'description' => '坐席所属技能组信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '技能组信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['description' => '技能组描述', 'type' => 'string', 'example' => '自动化技能组'],
+ 'DisplayName' => ['description' => '技能组对外显示名称。', 'type' => 'string', 'example' => '自动化技能组'],
+ 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
+ 'ChannelType' => ['description' => '技能组渠道类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Name' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '自动化技能组'],
+ ],
+ ],
],
+ 'DisplayName' => ['description' => '坐席对外显示名称。', 'type' => 'string', 'example' => 'XX测试'],
+ 'AgentId' => ['description' => '坐席ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '222222'],
+ 'AccountName' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'example' => 'username@example.com'],
],
],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '请求状态码。返回200代表请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '调用接口是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '系统错误，请联系管理员！'],
+ ],
],
- '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' => '获取在线监控下技能组纬度队列信息',
- 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ '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' => '获取坐席信息',
+ 'summary' => '根据实例ID、坐席账号名称查询悉犀客服工作台坐席信息，如坐席ID等。',
+ 'description' => '- 调用此接口前，请您确认AICCS的实例信息及坐席账号名称，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ .'- 已删除的坐席也支持查询，请您查看返回参数中的**Status**参数值，若取值为2，则表示该坐席已删除。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
- ."\n"
- .' group_name：技能组名称'."\n"
- .' group_id：技能组ID'."\n"
- .' department_id：部门ID'."\n"
- .' department_name：部门名称'."\n"
- .' date_id：日期'."\n"
- .' tenant_id：租户ID'."\n"
- .' tenant_name：租户名称'."\n"
- .' current_session_wait_cnt：排队会员'."\n"
- .' current_session_service_cnt：服务中会员'."\n"
- .' eventide：事件时间'."\n"
- .' fst_assign_time：该队列最早的时间，排队中的分配时间'."\n"
- .' ',
- ],
- 'GetSkillGroupStatusTotal' => [
- 'summary' => '获取热线报表下技能组状态总量。支持实例、时间区间、坐席、部门、技能组分组查询。',
- 'methods' => [
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'GetAgentBasisStatus' => [
+ 'summary' => '获取热线监控下坐席纬度状态量。支持实例、时间区间、坐席、部门分组查询。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8147,73 +4345,33 @@
],
'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' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
],
[
'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'AgentIds',
@@ -8223,15 +4381,9 @@
'title' => '坐席id列表',
'description' => '坐席ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '坐席ID。'."\n"
- ."\n"
- .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
+ 'items' => ['description' => '坐席ID。'."\n"
+ ."\n"
+ .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '["2256****","2257****"]'],
'required' => false,
],
],
@@ -8243,93 +4395,10 @@
'title' => '部门id列表',
'description' => '部门ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'GroupIds',
- 'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '技能组id列表',
- 'description' => '技能组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'TimeLatitudeType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '时间纬度类型',
- 'description' => '时间纬度类型。取值：'."\n"
- ."\n"
- .'- **minute**：分钟。'."\n"
- .'- **hour**：小时。'."\n"
- .'- **day**：天。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'minute',
- ],
- ],
- [
- 'name' => 'ExistAgentGrouping',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否根据坐席分组',
- 'description' => '是否根据坐席分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'ExistDepartmentGrouping',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否根据部门分组',
- 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'ExistSkillGroupGrouping',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否根据技能组分组',
- 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
+ 'items' => ['description' => '部门ID。'."\n"
."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '["6083****","6084****"]'],
'required' => false,
- 'example' => 'false',
],
],
],
@@ -8340,85 +4409,37 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'title' => 'data',
'description' => '数据列表。',
'type' => 'object',
'properties' => [
- 'TotalNum' => [
- 'title' => '总记录数',
- 'description' => '总记录数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
- 'PageNum' => [
- 'title' => '当前页数',
- 'description' => '当前页数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '页大小',
- 'description' => '每页大小。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2000',
- ],
- 'Rows' => [
- 'title' => '信息为list<map>类型的json字符串',
- 'description' => '信息为List<Map>类型的JSON字符串。',
- 'type' => 'string',
- '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}',
- ],
+ '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' => '信息为List<Map>类型的JSON字符串。', 'type' => 'string', '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"}'],
],
],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '接口调用是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。'."\n",
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'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\\": \\"{\\\\\\"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' => '获取热线报表下技能组状态总量',
+ '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' => '获取热线监控下坐席纬度状态量',
'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写坐席、部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ .'- 若您需要填写坐席、部门信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
."\n"
.'### QPS限制'."\n"
.'- 单用户调用频率：100次/秒。'."\n"
@@ -8426,55 +4447,30 @@
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
- ."\n"
- .' date_id：日期 '."\n"
- .' hour_id：小时'."\n"
- .' minute_id：分钟'."\n"
- .' servicer_id：小二ID'."\n"
- .' servicer_name：小二名称'."\n"
- .' servicer_real_name ：小二姓名'."\n"
- .' group_id：技能组ID '."\n"
- .' group_name：技能组名称'."\n"
+ .' '."\n"
+ .' servicer_id：坐席ID'."\n"
+ .' servicer_name：坐席名称'."\n"
+ .' servicer_real_name：坐席真实姓名'."\n"
.' department_id：部门ID'."\n"
.' department_name：部门名称'."\n"
- .' tenant_id ：租户ID'."\n"
- .' tenant_name：租户名称 '."\n"
- .' inline_cnt：进线量'."\n"
- .' request_cnt：请求量（进行量-重新分配量） '."\n"
- .' ready_cnt：接起量 '."\n"
- .' reassign_cnt：重新分配量 '."\n"
- .' ready_cnt_60s：60秒接起量 '."\n"
- .' ringqueue_len ：进入队列到振铃 '."\n"
- .' ringtime_len：振铃到接起 '."\n"
- .' queue_len：进入队列到接起 '."\n"
- .' service_time_len：接起到结束，服务时长'."\n"
- .' give_up_len：进入队列到结束，放弃总时长 '."\n"
- .' call_out_cnt：外呼量 '."\n"
- .' call_out_intervene_cnt：外呼振铃总时长-结束-振铃'."\n"
- .' call_out_sep_sat_cnt：呼出-热线评价满意量 '."\n"
- .' call_out_sep_normal_cnt：呼出-热线评价一般量'."\n"
- .' call_out_sep_unsat_cnt：呼出-热线评价不满意量 '."\n"
- .' call_out_unsep_cnt：呼出-热线参评但未评价量 '."\n"
- .' call_in_unsep_cnt：呼入-热线参评但未评价量 '."\n"
- .' call_in_sep_sat_cnt：呼入-热线评价满意量 '."\n"
- .' call_in_sep_normal_cnt：呼入-热线评价一般量 '."\n"
- .' call_in_sep_unsat_cnt：呼入-热线评价不满意量 '."\n"
- .' call_out_intervene_20s_cnt：呼出-通话>20s的接通量'."\n"
- .' call_out_intervene_30s_cnt：呼出-通话>30s的接通量'."\n"
- .' call_out_intervene_60s_cnt：呼出-通话>60s的接通量'."\n"
- .' call_in_intervene_20s_cnt：呼入-通话>20s的接通量'."\n"
- .' call_in_intervene_30s_cnt：呼入-通话>30s的接通量'."\n"
- .' call_in_intervene_60s_cnt：呼入-通话>60s的接通量'."\n",
- ],
- 'GetAgentDetailReport' => [
- 'summary' => '获取热线报表下热线坐席详情汇总数据。支持实例、时间区间、坐席、部门分组查询。',
- 'methods' => [
- 'get',
+ .' servicer_status：热线坐席状态'."\n"
+ .' servicer_status_name：热线坐席名称'."\n"
+ .' status_start_time：状态开始时间'."\n"
+ .' assign_status：分配状态'."\n"
+ .' rest_type：小休类型',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentBasisStatus'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetAgentById' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8482,73 +4478,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' => 'InstanceId',
- 'in' => 'query',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
+ ],
+ [
+ 'name' => 'AgentId',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
+ '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'],
+ ],
],
],
+ ],
+ '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 \\"ForeignNick\\": \\"\\",\\n \\"ServicerType\\": 0,\\n \\"RealName\\": \\"\\",\\n \\"AgentId\\": 0,\\n \\"ForeignKey\\": \\"\\",\\n \\"ShowName\\": \\"\\",\\n \\"CreateUserName\\": \\"\\"\\n },\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetAgentDetailReport' => [
+ 'summary' => '获取热线报表下热线坐席详情汇总数据。支持实例、时间区间、坐席、部门分组查询。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。'."\n", 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
+ ],
[
'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
],
[
'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'AgentIds',
@@ -8558,15 +4576,9 @@
'title' => '坐席id列表',
'description' => '坐席ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '坐席ID。'."\n"
- ."\n"
- .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
+ 'items' => ['description' => '坐席ID。'."\n"
+ ."\n"
+ .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
'required' => false,
],
],
@@ -8578,60 +4590,36 @@
'title' => '部门id列表',
'description' => '部门ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
'required' => false,
],
],
[
'name' => 'TimeLatitudeType',
'in' => 'query',
- 'schema' => [
- 'title' => '时间纬度类型',
- 'description' => '时间纬度类型。取值：'."\n"
- ."\n"
- .'- **minute**：分钟。'."\n"
- .'- **hour**：小时。'."\n"
- .'- **day**：天。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'day',
- ],
+ 'schema' => ['title' => '时间纬度类型', 'description' => '时间纬度类型。取值：'."\n"
+ ."\n"
+ .'- **minute**：分钟。'."\n"
+ .'- **hour**：小时。'."\n"
+ .'- **day**：天。', 'type' => 'string', 'required' => false, 'example' => 'day'],
],
[
'name' => 'ExistAgentGrouping',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据坐席分组显示',
- 'description' => '是否根据坐席分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '是否根据坐席分组显示', 'description' => '是否根据坐席分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ExistDepartmentGrouping',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据部门分组显示',
- 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '是否根据部门分组显示', 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
@@ -8641,81 +4629,33 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
'title' => 'data',
'description' => '数据列表。',
'type' => 'object',
'properties' => [
- 'TotalNum' => [
- 'title' => '总记录数',
- 'description' => '总记录数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
- 'PageNum' => [
- 'title' => '当前页数',
- 'description' => '当前页数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '页大小',
- 'description' => '每页大小。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2000',
- ],
- 'Rows' => [
- 'title' => '信息为list<map>类型的json字符串',
- 'description' => '信息为List<Map>类型的JSON字符串。',
- 'type' => 'string',
- '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,"}',
- ],
+ 'TotalNum' => ['title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
+ 'PageNum' => ['title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'PageSize' => ['title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000'],
+ 'Rows' => ['title' => '信息为list<map>类型的json字符串', 'description' => '信息为List<Map>类型的JSON字符串。', 'type' => 'string', '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,"}'],
],
],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '调用接口是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'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' => '[{"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' => '获取热线报表下热线坐席详情汇总数据',
'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
@@ -8821,16 +4761,19 @@
.' call_in_intervene_20s_cnt：呼入-通话>20s的接通量'."\n"
.' call_in_intervene_30s_cnt：呼入-通话>30s的接通量'."\n"
.' call_in_intervene_60s_cnt：呼入-通话>60s的接通量',
- ],
- 'GetSkillGroupServiceStatus' => [
- 'summary' => '获取在线报表下技能组服务状态量。',
- 'methods' => [
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentDetailReport'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetAgentIndexRealTime' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -8838,365 +4781,122 @@
],
'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' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'StartDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
- ],
- [
- 'name' => 'EndDate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '20', 'default' => '10'],
],
[
'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'AgentIds',
- 'in' => 'query',
- 'style' => 'simple',
- 'schema' => [
- 'title' => '技能组id列表',
- 'description' => '坐席ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '坐席ID。'."\n"
- ."\n"
- .'可调用[GetAgent](~~2717961~~)接口，查看返回参数的**AgentId**，即坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '当前页。取值大于**0**，默认值：**1**。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'DepIds',
'in' => 'query',
- 'style' => 'simple',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '部门id列表',
'description' => '部门ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](~~2717975~~)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](~~2717975~~)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'],
'required' => false,
+ 'maxItems' => 200,
],
],
[
'name' => 'GroupIds',
'in' => 'query',
- 'style' => 'simple',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '技能组id列表',
'description' => '技能组ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](~~2717970~~)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'TimeLatitudeType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '时间纬度类型',
- 'description' => '时间纬度类型。取值：'."\n"
- .'- **minute**：分钟。'."\n"
- .'- **hour**：小时。'."\n"
- .'- **day**：天。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'minute',
- ],
- ],
- [
- 'name' => 'ExistAgentGrouping',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否根据技能组分组',
- 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
+ 'items' => ['description' => '技能组ID。'."\n"
."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
+ .'可调用[QuerySkillGroups](~~2717970~~)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'],
'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'ExistDepartmentGrouping',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否根据部门分组',
- 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'ExistSkillGroupGrouping',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否根据技能组分组',
- 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'ExistRobotInstanceGrouping',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否根据机器实例分组',
- 'description' => '是否根据机器实例分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'ExistChannelInstanceGrouping',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否根据渠道实例分组',
- 'description' => '是否根据渠道实例分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ 'maxItems' => 200,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
'Data' => [
- 'title' => 'data',
'description' => '数据列表。',
'type' => 'object',
'properties' => [
- 'TotalNum' => [
- 'title' => '总记录数',
- 'description' => '总记录数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'PageSize' => [
- 'title' => '页大小',
- 'description' => '每页大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2000',
- ],
- 'PageNum' => [
- 'title' => '当前页数',
- 'description' => '当前页数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ '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' => '客服ID'],
+ ],
+ ],
],
+ 'Page' => ['description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Rows' => [
- 'title' => '信息为list<map>类型的json字符串',
- 'description' => '信息为List<Map>类型的JSON字符串。',
- 'type' => 'string',
- '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}',
+ 'description' => '返回数据结果。',
+ 'type' => 'array',
+ 'items' => ['description' => '查询结果数据。', 'type' => 'object'],
],
],
],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '调用接口是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。'."\n", 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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 \\"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' => '获取在线报表下技能组服务状态量',
- 'description' => '### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
+ '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' => '获取热线坐席实时数据详情',
+ 'summary' => '根据实例、部门、技能组分组获取坐席详情实时数据（实时数据）。',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
+ .'- 若您需要填写部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：10次/秒。'."\n"
."\n"
- .' date_id：日期'."\n"
- .' hour_id：小时'."\n"
- .' minute_id：分钟-5分钟，如：05，10，00，15'."\n"
- .' servicer_id：小二ID'."\n"
- .' servicer_name：小二名称'."\n"
- .' group_id：技能组ID'."\n"
- .' group_name：技能组名称'."\n"
- .' department_id：部门ID'."\n"
- .' department_name：部门名称'."\n"
- .' tenant_id：租户ID'."\n"
- .' tenant_name：租户名称'."\n"
- .' robot_instance_id：机器人ID'."\n"
- .' robot_instance_name：机器人名称'."\n"
- .' channel_instance_id：渠道实例ID'."\n"
- .' channel_instance_name：渠道实例名称'."\n"
- .' online_direct_request_cnt：用户直接请求的服务量（直连）'."\n"
- .' online_transfer_request_cnt：被转入的用户服务请求量'."\n"
- .' online_direct_ready_cnt：用户直接接起的服务量（直连）'."\n"
- .' online_transfer_ready_cnt：被转入的用户接起服务量'."\n"
- .' online_transfer_in_give_up_cnt：转交后用户放弃量（未接起量）'."\n"
- .' online_transfer_out_cnt：转出的总量（建议通过产品上落标记动作直接取数）'."\n"
- .' online_direct_give_up_cnt：放弃量（直连）直接请求放弃的量'."\n"
- .' online_transfer_give_up_cnt：放弃量（转入）转入后放弃的量'."\n"
- .' online_10s_direct_ready_cnt：10秒接起量（直连）'."\n"
- .' online_10s_transfer_ready_cnt：10秒接起量（转入）'."\n"
- .' online_20s_direct_ready_cnt：20秒接起量（直连）'."\n"
- .' online_20s_transfer_ready_cnt：20秒接起量（转入）'."\n"
- .' online_30s_direct_ready_cnt：30秒接起量（直连）'."\n"
- .' online_30s_transfer_ready_cnt：30秒接起量（转入）'."\n"
- .' online_40s_direct_ready_cnt：40秒接起量（直连）'."\n"
- .' online_40s_transfer_ready_cnt：40秒接起量（转入）'."\n"
- .' online_60s_direct_ready_cnt：60秒接起量（直连）'."\n"
- .' online_60s_transfer_ready_cnt：60秒接起量（转入）'."\n"
- .' online_service_time_len：服务总时长对应技能组中，小二开始服务的时间到小二服务结束时间（如果发生转交，服务结束时间＝转交时间）'."\n"
- .' online_direct_wait_len：等待总时长（直连）直连接起量的进入队列到接起待时长'."\n"
- .' online_transfer_wait_len：等待总时长（转入）转入接起量的进入队列到接起待时长'."\n"
- .' online_direct_give_up_len：放弃总时长（直连）直连接起量的进入队列到放弃时长'."\n"
- .' online_transfer_give_up_len：放弃总时长（转入）转入接起量的进入队列到放弃的时长（如果有放弃的，其时长算在最后一个目标技能组）'."\n"
- .' online_direct_response_len：响应时长（直连）会员发出对话到小二回复的平均间隔时长'."\n"
- .' online_transfer_response_len：响应时长（转入）会员发出对话到小二回复的平均间隔时长'."\n"
- .' online_direct_response_times：响应次数（直连）会员发出对话到小二回复的间隔次数'."\n"
- .' online_transfer_response_times：响应次数（转入）会员发出对话到小二回复的间隔次数'."\n"
- .' online_satis_cnt：满意数-touch的评价'."\n"
- .' online_simple_cnt：一般数-touch的评价'."\n"
- .' online_unsatis_cnt：不满意数-touch的评价',
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
],
'GetAgentServiceStatus' => [
'summary' => '获取在线报表下坐席服务状态量。支持实例、时间区间、坐席、部门分组查询。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -9204,73 +4904,33 @@
],
'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' => [
- 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'title' => '开始日期时间戳（毫秒）',
- 'description' => '开始时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
],
[
'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'title' => '结束日期时间戳（毫秒）',
- 'description' => '结束时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小（默认为10)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页（默认为1）',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'AgentIds',
@@ -9280,15 +4940,9 @@
'title' => '坐席id列表',
'description' => '坐席ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '坐席ID。'."\n"
- ."\n"
- .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
+ 'items' => ['description' => '坐席ID。'."\n"
+ ."\n"
+ .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
'required' => false,
],
],
@@ -9300,60 +4954,36 @@
'title' => '部门id列表',
'description' => '部门ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
- ],
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
'required' => false,
],
],
[
'name' => 'TimeLatitudeType',
'in' => 'query',
- 'schema' => [
- 'title' => '时间纬度类型',
- 'description' => '时间纬度类型。取值：'."\n"
- ."\n"
- .'- **minute**：分钟。'."\n"
- .'- **hour**：小时。'."\n"
- .'- **day**：天。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'minute',
- ],
+ 'schema' => ['title' => '时间纬度类型', 'description' => '时间纬度类型。取值：'."\n"
+ ."\n"
+ .'- **minute**：分钟。'."\n"
+ .'- **hour**：小时。'."\n"
+ .'- **day**：天。', 'type' => 'string', 'required' => false, 'example' => 'minute'],
],
[
'name' => 'ExistDepartmentGrouping',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据部门分组',
- 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'ExistAgentGrouping',
'in' => 'query',
- 'schema' => [
- 'title' => '是否根据坐席分组',
- 'description' => '是否根据坐席分组查询。默认值：**false**。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '是否根据坐席分组', 'description' => '是否根据坐席分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -9363,81 +4993,33 @@
'description' => 'result',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '错误描述',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求ID，用于跟踪错误原因',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
+ 'Message' => ['title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
'Data' => [
'title' => 'data',
'description' => '数据列表。',
'type' => 'object',
'properties' => [
- 'TotalNum' => [
- 'title' => '总记录数',
- 'description' => '总记录数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
- 'PageNum' => [
- 'title' => '当前页数',
- 'description' => '当前页数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '页大小',
- 'description' => '每页大小。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2000',
- ],
- 'Rows' => [
- 'title' => '信息为list<map>类型的json字符串',
- 'description' => '信息为List<Map>类型的JSON字符串。',
- 'type' => 'string',
- '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' => ['title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
+ 'PageNum' => ['title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'PageSize' => ['title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000'],
+ 'Rows' => ['title' => '信息为list<map>类型的json字符串', 'description' => '信息为List<Map>类型的JSON字符串。', 'type' => 'string', '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%"}'],
],
],
- 'Code' => [
- 'title' => '错误编码',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '调用接口是否成功',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '[{"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' => '获取在线报表下坐席服务状态量',
'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
@@ -9490,1785 +5072,1159 @@
.' online_unsatis_cnt：不满意数-touch的评价'."\n"
.' t_login：总登录时长'."\n"
.' t_rest：小休总时长',
- ],
- 'CreateAgent' => [
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentServiceStatus'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetAgentStatistics' => [
+ 'summary' => '获取热线监控下坐席纬度统计量。支持实例、时间区间、坐席、部门分组查询。',
+ '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' => [
- 'title' => 'js sdk中自动生成的鉴权token',
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'name' => 'StartDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
],
[
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束日期时间戳。单位：毫秒。 ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
],
[
- 'name' => 'DisplayName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席对外显示名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'XX测试',
- ],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'SkillGroupId',
- 'in' => 'formData',
- 'style' => 'flat',
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'AgentIds',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '坐席所属技能组ID。',
+ 'title' => '坐席id列表',
+ 'description' => '坐席ID列表。',
'type' => 'array',
- 'format' => 'int64',
- 'items' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1234****',
- ],
+ 'items' => ['description' => '坐席ID。'."\n"
+ ."\n"
+ .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
'required' => false,
- 'maxItems' => 200,
],
],
[
- 'name' => 'SkillGroupIdList',
- 'in' => 'formData',
- 'style' => 'flat',
+ 'name' => 'DepIds',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '坐席所属技能组ID列表。',
+ 'title' => '部门id列表',
+ 'description' => '部门ID列表。',
'type' => 'array',
- 'format' => 'int64',
- 'items' => [
- 'description' => '技能组ID列表。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1223****,1456****',
- ],
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
'required' => false,
- 'maxItems' => 200,
],
],
+ [
+ 'name' => 'TimeLatitudeType',
+ 'in' => 'query',
+ 'schema' => ['title' => '时间纬度类型', 'description' => '时间纬度类型。取值：'."\n"
+ ."\n"
+ .'- **minute**：分钟。'."\n"
+ .'- **hour**：小时。', 'type' => 'string', 'required' => false, 'example' => 'minute'],
+ ],
+ [
+ 'name' => 'ExistDepartmentGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'ExistAgentGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据坐席分组', 'description' => '是否根据坐席分组查询。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2578****',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ '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' => '信息为List<Map>类型的JSON字符串。', 'type' => 'string', '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}'],
+ ],
],
+ 'Code' => ['title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。'."\n", 'type' => 'string', 'example' => 'true'],
],
],
],
],
'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.',
- ],
+ ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => '系统错误，请联系管理员！'],
],
],
- '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' => '创建坐席',
- 'summary' => '创建悉犀客服工作台坐席账号，并返回坐席ID。',
+ '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_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' => '获取热线监控下坐席纬度统计量',
'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- .'- 您可以调用[DeleteAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-deleteagent)删除坐席，或者调用[UpdateAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-updateagent)更新坐席数据对坐席进行管理。'."\n"
+ .'- 若您需要填写坐席、部门信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'DeleteAgent' => [
- 'summary' => '根据实例ID及坐席账号名称，删除悉犀客服工作台坐席账号。',
- 'methods' => [
- 'delete',
+ 'responseParamsDescription' => '返回参数Rows参数说明： '."\n"
+ .' '."\n"
+ .' t_incall_ring：呼入振铃时长'."\n"
+ .' t_incall_speak：呼入时长'."\n"
+ .' t_outcall_dial：拨号时长-外部'."\n"
+ .' t_outcall_speak：呼出时长'."\n"
+ .' t_internal_dial：内部拨号时长'."\n"
+ .' t_internal_speak：内部通话时长'."\n"
+ .' t_internal_ring：内部振铃时长'."\n"
+ .' t_consult_internal_speak：求助时长（内部）'."\n"
+ .' t_consulted_internal_ring：求助振铃时长（内部）'."\n"
+ .' t_consulted_internal_speak：被求助时长（内部）'."\n"
+ .' t_consult_external_speak：求助时长（外部）'."\n"
+ .' t_conference_speak：会议时长'."\n"
+ .' t_hold：保持时长'."\n"
+ .' t_held：被保持时长'."\n"
+ .' t_login：登录时长'."\n"
+ .' t_resttype_1：普通小休时长'."\n"
+ .' t_resttype_2：就餐小休时长'."\n"
+ .' t_resttype_3：会议小休时长'."\n"
+ .' t_resttype_4：辅导小休时长'."\n"
+ .' t_resttype_5：培训小休时长'."\n"
+ .' t_resttype_98：系统强制小休时长'."\n"
+ .' t_resttype_99：坐席签入小休时长'."\n"
+ .' t_idle：空闲时长'."\n"
+ .' t_acw：后处理时长（外呼）'."\n"
+ .' t_outcall_acw_end：外呼后处理'."\n"
+ .' t_incall_acw_end：呼入后处理'."\n"
+ .' n_incall_ring：呼入振铃次数'."\n"
+ .' n_incall_speak：呼入量'."\n"
+ .' n_outcall_dial：拨号量--外部'."\n"
+ .' n_outcall_speak：呼出量'."\n"
+ .' n_internal_dial：内部拨号次数'."\n"
+ .' n_internal_speak：内部通话次数'."\n"
+ .' n_internal_ring：内部振铃次数'."\n"
+ .' n_consult_internal_dial：求助发起次数（内部）'."\n"
+ .' n_consult_internal_speak：求助次数（内部）'."\n"
+ .' n_consulted_internal_ring：被求助振铃次数（内部）'."\n"
+ .' n_consulted_internal_speak：被求助次数（内部）'."\n"
+ .' n_consult_external_dial：发起求助次数（外部）'."\n"
+ .' n_consult_external_speak：求助次数（外部）'."\n"
+ .' n_send_conference：发起会议次数'."\n"
+ .' n_conference_speak：会议次数'."\n"
+ .' n_send_step_transfer：单步转接发起次数'."\n"
+ .' n_send_finish_transfer：双步转接次数'."\n"
+ .' n_send_monitor_error：监听失败次数'."\n"
+ .' n_hold：保持次数'."\n"
+ .' n_held：被保持次数'."\n"
+ .' n_resttype_1：普通小休次数'."\n"
+ .' n_resttype_2：就餐小休次数'."\n"
+ .' n_resttype_3：会议小休次数'."\n"
+ .' n_resttype_4：辅导小休次数'."\n"
+ .' n_resttype_5：培训小休次数'."\n"
+ .' n_resttype_98：系统强制小休次数'."\n"
+ .' n_resttype_99：坐席签入小休次数'."\n"
+ .' n_acw：后处理次数'."\n"
+ .' n_outcall_acw_end：后处理次数-呼出'."\n"
+ .' n_incall_acw_end：后处理次数-呼入',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentStatistics'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetAiOutboundTaskBizData' => [
+ 'summary' => '根据实例ID、会话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' => [
- 'title' => 'js sdk中自动生成的鉴权token',
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298****',
- ],
- ],
- [
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_***'],
],
[
- 'name' => 'AccountName',
+ 'name' => 'ChannelId',
'in' => 'query',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
+ 'schema' => ['title' => '入呼channelId', 'description' => '会话ID。', 'type' => 'string', 'required' => true, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'result',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => [
+ 'title' => '本次呼叫关联的业务信息',
+ 'description' => '本次呼叫关联的业务信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'BizData' => ['title' => '业务自定义信息', 'description' => '业务自定义信息。', 'type' => 'string', 'example' => '{"customer":123}'],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
+ 'PhoneNum' => ['title' => '外呼号码', 'description' => '外呼号码。', 'type' => 'string', 'example' => '158****0000'],
+ 'CaseId' => ['title' => 'id', 'description' => '本次外呼关联的活动ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
+ ],
],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'NoAgentFound',
- 'errorMessage' => 'The specified agent does not exist.',
- ],
- [
- 'errorCode' => 'NoTenantFound',
- 'errorMessage' => 'The specified tenant does not exist.',
- ],
- [
- 'errorCode' => 'SystemError',
- 'errorMessage' => 'A system error occurred. Please contact the administrator.',
- ],
- ],
- ],
- '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' => '删除坐席',
- 'description' => '- 删除前，建议您确认需删除的坐席账号名称及实例ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- .'- 若误操作删除坐席，可以调用[CreateAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-createagent)接口，重新创建坐席。'."\n"
- ."\n"
- .'> 账号删除后重新添加，坐席ID不变。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
+ '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' => '查询本次呼叫关联的业务信息',
+ 'description' => '### QPS限制'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'UpdateAgent' => [
- 'methods' => [
- 'put',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskBizData'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetAiOutboundTaskDetail' => [
+ 'summary' => '根据实例ID、任务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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
- ],
- [
'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。'."\n"
- .'> 不支持更新。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
- ],
- [
- 'name' => 'DisplayName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席对外显示名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'XX测试',
- ],
- ],
- [
- 'name' => 'SkillGroupId',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '坐席所属技能组。',
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2345****',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
+ 'in' => 'query',
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。'."\n", 'type' => 'string', 'required' => true, 'example' => 'agent_***'],
],
[
- 'name' => 'SkillGroupIdList',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '坐席所属技能组列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组列表。多个技能组用半角逗号（,）分隔。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2321****,4567****',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => ['title' => '任务id', 'description' => '任务ID。'."\n"
+ ."\n"
+ .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示调用成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => [
+ 'title' => '任务详情',
+ 'description' => '外呼任务详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['title' => '任务状态（0:未开始,1:进行中,2:系统暂停,3:手动暂停,4:已完成,5:已终止）', 'description' => '任务状态。取值：'."\n"
+ ."\n"
+ .'- **0**：未开始。'."\n"
+ .'- **1**：进行中。'."\n"
+ .'- **2**：系统暂停。'."\n"
+ .'- **3**：手动暂停。'."\n"
+ .'- **4**：已完成。'."\n"
+ .'- **5**：已终止。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'HandlerId' => ['title' => '技能组id（预测式外呼）或者ivr id（自动外呼）', 'description' => '技能组ID（预测式外呼）或IVR ID（自动外呼）。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
+ 'TaskId' => ['title' => '任务id', 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
+ 'Description' => ['title' => '任务描述', 'description' => '任务描述。', 'type' => 'string', 'example' => '房产销售'],
+ 'Name' => ['title' => '任务名', 'description' => '任务名称。', 'type' => 'string', 'example' => 'xxxxx外呼'],
+ 'StatusDesc' => ['title' => '任务状态描述', 'description' => '任务状态描述。', 'type' => 'string', 'example' => '未开始'],
+ 'ExecutionTime' => ['title' => '任务执行时间', 'description' => '任务执行时间。', 'type' => 'string', '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"}]}'],
+ 'Type' => ['title' => '任务类型(2:预测式外呼，3:自动外呼)', 'description' => '任务类型。取值：'."\n"
+ ."\n"
+ .'- **2**：预测式外呼。'."\n"
+ .'- **3**：自动外呼。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'ConcurrentRate' => ['title' => '自动外呼的并发', 'description' => '自动外呼的并发。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'NumRepeated' => ['title' => '被叫号码重复策略（0去重，1不去重）', 'description' => '被叫号码重复策略。'."\n"
+ ."\n"
+ .'- **0**：去重。'."\n"
+ .'- **1**：不去重。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'OutboundNums' => [
+ 'title' => '外呼主叫号码',
+ 'description' => '外呼主叫号码。',
+ 'type' => 'array',
+ 'items' => ['description' => '外呼主叫号码。', 'type' => 'string', 'example' => '150****0000'],
+ ],
+ 'RecallRule' => [
+ 'title' => '失败重呼策略',
+ 'description' => '失败重呼策略。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Count' => ['title' => '重呼次数', 'description' => '重呼次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'Interval' => ['title' => '重呼间隔时间（分钟）', 'description' => '重呼间隔时间。单位：分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ ],
+ ],
+ 'HandlerName' => ['title' => '技能组名称或ivr名称', 'description' => '技能组名称或IVR名称。', 'type' => 'string', 'example' => '热线技能组'],
+ 'ForecastCallRate' => ['title' => '预测式外呼固定外呼比例', 'description' => '预测式外呼固定外呼比例。', 'type' => 'number', 'format' => 'float', 'example' => '1.2'],
+ ],
],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口是否调用成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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',
- ],
- ],
- ],
- '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' => '更新坐席数据',
- 'summary' => '根据实例ID、坐席账号名称修改悉犀客服工作台坐席信息。支持修改坐席对外显示名称、坐席所属技能组。',
- 'description' => '- 调用前，建议您确认AICCS实例ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- .'- 更新后，您可调用[GetAgent](~~2717961~~)接口，确认更新是否符合预期。'."\n"
- ."\n"
- .'> 目前仅支持修改对外显示名称和所属技能组。'."\n"
+ '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' => '获取外呼任务详情',
+ 'description' => '外呼任务详情包含任务ID、任务状态、任务类型、外呼主叫号码、被叫号码重复策略等信息，具体参见[返回参数](#api-detail-40)。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GetAgent' => [
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskDetail'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetAiOutboundTaskExecDetail' => [
+ 'summary' => '根据实例ID、任务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',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => 'js sdk中自动生成的鉴权token',
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。'."\n", 'type' => 'string', 'required' => true, 'example' => 'agent_***'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => '任务id', 'description' => '任务ID。'."\n"
+ ."\n"
+ .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
],
[
- 'name' => 'AccountName',
+ 'name' => 'BatchVersion',
'in' => 'query',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
+ 'schema' => ['title' => '任务批次', 'description' => '任务批次。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PhoneNum',
+ 'in' => 'query',
+ 'schema' => ['title' => '手机号', 'description' => '外呼号码。', 'type' => 'string', 'required' => false, 'example' => '150****000'],
+ ],
+ [
+ 'name' => 'CaseStatus',
+ 'in' => 'query',
+ 'schema' => ['title' => '单条号码任务执行状态（1：待呼叫，2:呼叫中，3:已完成，4:已终止，5:待重呼）', 'description' => '单条号码任务执行状态。取值：'."\n"
+ ."\n"
+ .'- **1**：待呼叫。'."\n"
+ .'- **2**：呼叫中。'."\n"
+ .'- **3**：已完成。'."\n"
+ .'- **4**：已终止。'."\n"
+ .'- **5**：待重呼。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'CreateTimeStart',
+ 'in' => 'query',
+ 'schema' => ['title' => '号码导入起始时间戳（毫秒）', 'description' => '号码导入起始时间。时间戳格式，单位戳：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1632289999000'],
+ ],
+ [
+ 'name' => 'CreateTimeEnd',
+ 'in' => 'query',
+ 'schema' => ['title' => '号码导入结束时间戳（毫秒）', 'description' => '号码导入结束时间。时间戳格式，单位戳：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1632290119000'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页大小（<=50）', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '10'],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '当前页数', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'CaseId',
+ 'in' => 'query',
+ 'schema' => ['title' => '单条外呼id', 'description' => '本次外呼关联的活动ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'result',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
- 'description' => '坐席数据。',
+ 'title' => '任务执行列表',
+ 'description' => '任务执行列表。',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '坐席状态。取值：'."\n"
- ."\n"
- .'- **0**：正常'."\n"
- .'- **1**：冻结'."\n"
- .'- **2**：删除'."\n"
- ."\n"
- .'> 只有正常的状态，才可进行业务活动。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TenantId' => [
- 'description' => '坐席所属的租户ID，与请求参数中的实例ID相对应。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'GroupList' => [
- 'description' => '坐席所属技能组信息。',
+ 'PageSize' => ['title' => '分页大小', 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'CurrentPage' => ['title' => '当前页数', 'description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalResults' => ['title' => '总数', 'description' => '任务总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '199'],
+ 'List' => [
+ 'title' => '外呼号码执行列表',
+ 'description' => '外呼号码执行列表。',
'type' => 'array',
'items' => [
- 'description' => '技能组信息。',
+ 'description' => '外呼号码详情。',
'type' => 'object',
'properties' => [
- 'Description' => [
- 'description' => '技能组描述',
- 'type' => 'string',
- 'example' => '自动化技能组',
- ],
- 'DisplayName' => [
- 'description' => '技能组对外显示名称。',
- 'type' => 'string',
- 'example' => '自动化技能组',
- ],
- 'SkillGroupId' => [
- 'description' => '技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'ChannelType' => [
- 'description' => '技能组渠道类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Name' => [
- 'description' => '技能组名称。',
- 'type' => 'string',
- 'example' => '自动化技能组',
- ],
+ 'Status' => ['title' => '执行状态（1：待呼叫，2:呼叫中，3:已完成，4:已终止，5:待重呼）', 'description' => '执行状态。取值：'."\n"
+ ."\n"
+ .'- **1**：待呼叫。'."\n"
+ .'- **2**：呼叫中。'."\n"
+ .'- **3**：已完成。'."\n"
+ .'- **4**：已终止。'."\n"
+ .'- **5**：待重呼。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'StatusDesc' => ['title' => '执行状态描述', 'description' => '执行状态描述。', 'type' => 'integer', 'format' => 'int32', 'example' => '待呼叫'],
+ 'BizData' => ['title' => '业务自定义信息', 'description' => '业务自定义信息', 'type' => 'string', 'example' => '123'],
+ 'BatchVersion' => ['title' => '任务批次', 'description' => '任务批次。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PhoneNum' => ['title' => '手机号', 'description' => '外呼号码。', 'type' => 'string', 'example' => '150****0000'],
+ 'LastCallResult' => ['title' => '最后一次外呼结果', 'description' => '最后一次外呼结果。', 'type' => 'string', 'example' => '未接通'],
+ 'CreateTime' => ['title' => '号码导入时间戳（毫秒）', 'description' => '号码导入时间。时间戳格式，单位戳：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1632289999000'],
+ 'CaseId' => ['title' => 'id', 'description' => '本次外呼关联的活动ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
+ 'CallCount' => ['title' => '外呼次数', 'description' => '外呼次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
- 'DisplayName' => [
- 'description' => '坐席对外显示名称。',
- 'type' => 'string',
- 'example' => 'XX测试',
- ],
- 'AgentId' => [
- 'description' => '坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '222222',
- ],
- 'AccountName' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。',
- 'type' => 'string',
- 'example' => 'username@example.com',
- ],
+ 'HasNextPage' => ['title' => '是否有下一页', 'description' => '是否有下一页。', 'type' => 'boolean', 'example' => 'true'],
],
],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口是否调用成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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 \\"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' => '获取坐席信息',
- 'summary' => '根据实例ID、坐席账号名称查询悉犀客服工作台坐席信息，如坐席ID等。',
- 'description' => '- 调用此接口前，请您确认AICCS的实例信息及坐席账号名称，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- .'- 已删除的坐席也支持查询，请您查看返回参数中的**Status**参数值，若取值为2，则表示该坐席已删除。'."\n"
+ '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' => '获取任务执行详情',
+ 'description' => '任务执行详情包含任务总数、任务批次、外呼号码及对应的外呼次数、执行状态等信息。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'ListAgentBySkillGroupId' => [
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskExecDetail'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetAiOutboundTaskList' => [
+ 'summary' => '根据实例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',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => ' '."\n"
- .'客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_****'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'Type',
'in' => 'query',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => '任务类型(2:预测式外呼，3:自动外呼)', 'description' => '任务类型。取值：'."\n"
+ ."\n"
+ .'- **2**：预测式外呼。'."\n"
+ .'- **3**：自动外呼。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'],
],
[
- 'name' => 'SkillGroupId',
+ 'name' => 'CreateTimeStart',
'in' => 'query',
- 'schema' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '666666',
- ],
+ 'schema' => ['title' => '任务创建起始时间戳（毫秒）', 'description' => '任务创建起始时间。时间戳格式，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => 'result',
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Data' => [
- 'description' => '坐席信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据信息。',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '坐席状态。只有正常的状态，才可进行业务活动。取值：'."\n"
- .'- **0**：正常'."\n"
- .'- **1**：冻结'."\n"
- .'- **2**：删除',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TenantId' => [
- 'description' => '坐席所属的租户ID。与入参中的实例ID对应。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'DisplayName' => [
- 'description' => '坐席对外显示名称。',
- 'type' => 'string',
- 'example' => '刘测试',
- ],
- 'AgentId' => [
- 'description' => '坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '666666',
- ],
- 'AccountName' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。',
- 'type' => 'string',
- 'example' => 'username@example.com',
- ],
- ],
- ],
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ [
+ 'name' => 'CreateTimeEnd',
+ 'in' => 'query',
+ 'schema' => ['title' => '任务创建截止时间戳（毫秒）', 'description' => '任务创建截止时间。时间戳格式，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
],
- ],
- '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' => ['title' => '任务状态（0:未开始,1:进行中,2:系统暂停,3:手动暂停,4:已完成,5:已终止）', 'description' => '任务状态。取值：'."\n"
+ ."\n"
+ .'- **0**：未开始。'."\n"
+ .'- **1**：进行中。'."\n"
+ .'- **2**：系统暂停。'."\n"
+ .'- **3**：手动暂停。'."\n"
+ .'- **4**：已完成。'."\n"
+ .'- **5**：已终止。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
- ],
- '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' => '获取技能组下坐席信息',
- 'summary' => '根据AICCS实例ID、技能组ID查询悉犀客服工作台坐席列表。',
- 'description' => '- 调用此接口前，请您确认AICCS的实例信息及技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- .'- 若坐席没有设置所属的技能组，可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)查询坐席信息。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GetHotlineAgentStatus' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '分页大小(<=50)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '10'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '查询第几页', 'description' => '查询第几页。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
+ 'name' => 'SearchKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '过滤条件：匹配任务ID或者模糊匹配任务名', 'description' => '过滤条件。'."\n"
+ ."\n"
+ .'> 匹配任务ID或模糊匹配任务名称。', 'type' => 'string', 'required' => false, 'example' => '1763****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'result',
+ 'title' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
- 'description' => '坐席状态。取值：'."\n"
- .'- **离线**'."\n"
- .'- **空闲**'."\n"
- .'- **话后处理**'."\n"
- .'- **通话中**'."\n"
- .'- **小休-休息**'."\n"
- .'- **小休-就餐**'."\n"
- .'- **小休-会议**'."\n"
- .'- **小休-培训**'."\n"
- .'- **小休-辅导**',
- 'type' => 'string',
- 'example' => '通话中',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '任务列表',
+ 'description' => '任务列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageSize' => ['title' => '分页大小', 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'CurrentPage' => ['title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalResults' => ['title' => '数据总量', 'description' => '数据总量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'List' => [
+ 'title' => '任务信息',
+ 'description' => '任务信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '任务信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['title' => '任务状态（0:未开始,1:进行中,2:系统暂停,3:手动暂停,4:已完成,5:已终止）', 'description' => '任务状态。取值：'."\n"
+ ."\n"
+ .'- **0**：未开始。'."\n"
+ .'- **1**：进行中。'."\n"
+ .'- **2**：系统暂停。'."\n"
+ .'- **3**：手动暂停。'."\n"
+ .'- **4**：已完成。'."\n"
+ .'- **5**：已终止。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'FinishRate' => ['title' => '任务完成率', 'description' => '任务完成率。', 'type' => 'number', 'format' => 'float', 'example' => '0.7'],
+ 'StatusDesc' => ['title' => '任务状态描述', 'description' => '任务状态描述。', 'type' => 'string', 'example' => '未开始'],
+ 'HandlerId' => ['title' => '技能组id（预测式）或者ivr id（自动外呼）', 'description' => '技能组ID（预测式）或者IVR ID（自动外呼）。', 'type' => 'integer', 'format' => 'int64', 'example' => '2468****'],
+ 'ConcurrentRate' => ['title' => '自动外呼的并发', 'description' => '外呼并发。'."\n"
+ ."\n"
+ .'> 自动外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalCount' => ['title' => '任务总量', 'description' => '任务总量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'TaskId' => ['title' => '任务id', 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1763****'],
+ 'Description' => ['title' => '任务描述', 'description' => '任务描述。', 'type' => 'string', 'example' => '房产销售'],
+ 'CreateTime' => ['title' => '任务创建时间毫秒时间戳', 'description' => '任务创建截止时间。时间戳格式，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1615083365000'],
+ 'FinishCount' => ['title' => '任务已完成量', 'description' => '任务已完成量。', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
+ 'HandlerName' => ['title' => '技能组名称或ivr名称', 'description' => '技能组名称或IVR名称。', 'type' => 'string', 'example' => '热线技能组'],
+ 'Name' => ['title' => '任务名称', 'description' => '任务名称。', 'type' => 'string', 'example' => 'xxxx外呼任务'],
+ ],
+ ],
+ ],
+ 'HasNextPage' => ['title' => '是否有下一页', 'description' => '是否有下一页。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。'."\n", 'type' => 'boolean', 'example' => 'false'],
+ ],
],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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 \\"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' => '获取热线坐席状态',
- 'summary' => '根据AICCS实例ID、坐席账号名称查询悉犀客服工作台热线坐席状态。',
- 'description' => '- 调用此接口前，请您确认AICCS的实例信息及坐席账号名称，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- .'- 若需获取热线坐席详情，可调用[GetHotlineAgentDetail](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-gethotlineagentdetail)接口。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '获取外呼任务列表',
+ 'description' => '- 任务列表为任务信息列表，任务信息包含任务ID、任务状态、任务名称、任务完成率等信息，具体参见[返回参数](#api-detail-40)。'."\n"
+ .'- 若您需要更新任务信息，可调用[UpdateAiOutboundTask](~~2718021~~)接口。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：200次/秒。'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'RemoveAgentFromSkillGroup' => [
- 'summary' => '通过指定技能组及坐席ID，从技能组移除坐席账号。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskList'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetAiOutboundTaskProgress' => [
+ 'summary' => '根据实例ID、任务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' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-78v1gnp97002',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_***'],
],
[
- 'name' => 'SkillGroupId',
+ 'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'title' => '技能组id',
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1146****',
- ],
+ 'schema' => ['title' => '任务id', 'description' => '任务ID。'."\n"
+ ."\n"
+ .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
],
[
- 'name' => 'AgentIds',
+ 'name' => 'BatchVersion',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '坐席列表',
- 'description' => '坐席ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '坐席ID。'."\n"
- ."\n"
- .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '["6083****","6084****"]',
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '任务批次（为空则查询任务下所有数据）', 'description' => '任务批次。'."\n"
+ ."\n"
+ .'> 为空则查询任务下所有数据。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'ok'],
'Data' => [
- 'title' => '结果信息',
- 'description' => '返回数据。',
+ 'title' => '任务进展',
+ 'description' => '任务进展。',
'type' => 'object',
'properties' => [
- 'SuccessCount' => [
- 'title' => '成功移除的坐席数',
- 'description' => '成功移除的坐席数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
+ 'Type' => ['title' => '任务类型（2:预测式3:自动）', 'description' => '任务类型。取值：'."\n"
+ .'- **2**：预测式。'."\n"
+ .'- **3**：自动。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'TaskId' => ['title' => '任务id', 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
+ 'CalloutProgress' => [
+ 'title' => '外呼维度进展',
+ 'description' => '外呼维度进展。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CallOutCount' => ['title' => '外呼次数', 'description' => '外呼次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'CallOutConnectCount' => ['title' => '外呼接通次数（自动外呼特有）', 'description' => '外呼接通次数。'."\n"
+ .'> 自动外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'CallOutUserPickupCount' => ['title' => '客户接起量（预测式外呼特有）', 'description' => '客户接起量。'."\n"
+ .'> 预测式外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'CallOutUserPickupRate' => ['title' => '客户接起率（预测式外呼特有）', 'description' => '客户接起率。'."\n"
+ .'> 预测式外呼特有参数。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
+ 'CallLossRate' => ['title' => '呼损率（预测式外呼特有）', 'description' => '呼损率。'."\n"
+ .'> 预测式外呼特有参数。', 'type' => 'number', 'format' => 'float', 'example' => '0.01'],
+ 'CallOutConnectRate' => ['title' => '外呼接通次率（自动外呼特有）', 'description' => '外呼接通次率。'."\n"
+ .'> 自动外呼特有参数。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
+ 'CallOutServicerPickupCount' => ['title' => '坐席接通量（预测式外呼特有）', 'description' => '坐席接通量。'."\n"
+ .'> 预测式外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'CallLossCount' => ['title' => '呼损量（预测式外呼特有）', 'description' => '呼损量。'."\n"
+ .'> 预测式外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'CallOutServicerPickupRate' => ['title' => '坐席接通率（预测式外呼特有）', 'description' => '坐席接通率。'."\n"
+ .'> 预测式外呼特有参数。', 'type' => 'number', 'format' => 'float', 'example' => '0.4'],
+ ],
+ ],
+ 'TaskProgress' => [
+ 'title' => '任务维度进展',
+ 'description' => '任务维度进展。',
+ 'type' => 'object',
+ 'properties' => [
+ 'FinishRate' => ['title' => '任务完成率', 'description' => '任务完成率。', 'type' => 'number', 'format' => 'float', 'example' => '0.20'],
+ 'ConnectRate' => ['title' => '任务接通率（自动外呼特有）', 'description' => '任务接通率。'."\n"
+ .'> 自动外呼特有参数。', 'type' => 'number', 'format' => 'float', 'example' => '0.2'],
+ 'WaitingCallCount' => ['title' => '待呼叫任务数', 'description' => '待呼叫任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'FinishCount' => ['title' => '任务完成数', 'description' => '任务完成数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'ConnectCount' => ['title' => '任务接通量（自动外呼特有）', 'description' => '任务接通量。'."\n"
+ ."\n"
+ .'> 自动外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'TotalCount' => ['title' => '总任务数', 'description' => '总任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'WaitingRecallCount' => ['title' => '待重呼任务数', 'description' => '待重呼任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'TerminateCount' => ['title' => '已终止任务数', 'description' => '已终止任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'ServicerPickupCount' => ['title' => '坐席接通数（预测式外呼特有）', 'description' => '坐席接通数。'."\n"
+ ."\n"
+ .'> 预测式外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'UserPickupCount' => ['title' => '客户接起数（预测式外呼特有）', 'description' => '客户接起数。'."\n"
+ ."\n"
+ .'> 预测式外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'CallingCount' => ['title' => '呼叫中任务数', 'description' => '呼叫中任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'ServicerPickupRate' => ['title' => '坐席接通率(预测式外呼特有）', 'description' => '坐席接通率。'."\n"
+ ."\n"
+ .'> 预测式外呼特有参数。', 'type' => 'number', 'format' => 'float', 'example' => '0.2'],
+ 'UserPickupRate' => ['title' => '客户接起率（预测式外呼特有）', 'description' => '客户接起率。'."\n"
+ .'> 预测式外呼特有参数。', 'type' => 'number', 'format' => 'float', 'example' => '0.2'],
+ ],
],
],
],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'ok'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- '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' => '从技能组移除坐席账号',
- 'description' => '- 若您需要填写坐席、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- .'- 您可以调用[ListAgentBySkillGroupId](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-listagentbyskillgroupid)获取技能组下坐席信息，判断移除是否符合预期。'."\n"
- .'- 若误操作移除，您可以调用[UpdateAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-updateagent)更新坐席数据，重新设置坐席的技能组。'."\n"
+ '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' => '获取外呼任务进展',
+ 'description' => '- 调用此接口前，建议您确认实例ID、任务ID信息，具体请参见[请求参数](#api-detail-35)。'."\n"
+ .'- 外呼任务进展包括任务ID、任务类型、任务完成率、坐席接通率、客户接通率等信息，具体参见[返回参数](#api-detail-40)。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：50次/秒。'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GetHotlineAgentDetail' => [
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskProgress'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetAllDepartment' => [
+ 'summary' => '根据AICCS实例ID获取所有部门信息，可获取部门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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d****',
- ],
- ],
- [
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'AccountName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
+ 'schema' => ['title' => '实例id', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'result',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'Message' => ['title' => 'message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F'],
+ 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => [
- 'description' => '坐席服务数据。',
- 'type' => 'object',
- 'properties' => [
- 'Assigned' => [
- 'description' => '是否被分配。取值：'."\n"
- .'**false**：未分配（无通话）。'."\n"
- .'**true**：已分配（有通话）。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'TenantId' => [
- 'description' => '坐席所属的租户ID，与入参中的实例ID相对应。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- 'RestType' => [
- 'description' => '小休类型。取值： '."\n"
- ."\n"
- .'- **1**：小休。'."\n"
- .'- **2**：就餐。'."\n"
- .'- **3**：会议。'."\n"
- .'- **4**：辅导。'."\n"
- .'- **5**：培训。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'AgentStatus' => [
- 'description' => '坐席状态。取值范围：**1~6**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'AgentStatusCode' => [
- 'description' => '坐席状态编码。取值：'."\n"
- ."\n"
- .'- **AgentCheckout**：坐席下班。'."\n"
- .'- **AgentReady**：坐席空闲。'."\n"
- .'- **AgentBreak**：坐席小休。'."\n"
- .'- **AgentAcw**：话后处理。'."\n"
- .'- **AgentBusyForCall**：通话中。',
- 'type' => 'string',
- 'example' => 'AgentCheckout',
- ],
- 'Token' => [
- 'description' => '心跳签名。',
- 'type' => 'string',
- 'example' => 'dnthF_oinHg7JMJDmKqex3Ux****',
- ],
- 'AgentId' => [
- 'description' => '坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2235****',
+ 'title' => 'data',
+ 'description' => '部门信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '部门信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DepartmentName' => ['description' => '部门名称。', 'type' => 'string', 'example' => '部门A'],
+ 'DepartmentId' => ['description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
],
],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => 'code', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => 'success', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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\\": {\\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' => '获取热线坐席详情',
- 'summary' => '根据实例ID、坐席账号名称获取热线坐席当前服务详情。',
- 'description' => '热线坐席详情包含坐姿状态、坐席ID、心跳签名等信息，具体参见[返回参数](#api-detail-40)。'."\n"
+ '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' => '获取所有部门信息',
+ 'description' => '- 您可以调用此接口获取部门ID，用于支持部分查询数据的接口（例如[GetHotlineServiceStatistics](~~2717938~~)）的部门分组查询。'."\n"
+ .'- 创建、删除、更新部门信息后，您可以调用此接口确认部门信息是否符合预期。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'CreateSkillGroup' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T12:37:29.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAllDepartment'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetAudioNoteUploadUrl' => [
+ 'summary' => '获取录音小记上传地址',
+ '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' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'SkillGroupName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '技能组名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '在线自动化技能组',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '技能组描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '在线自动化技能组',
- ],
- ],
- [
- 'name' => 'DisplayName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '技能组对外显示名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '在线自动化技能组',
- ],
- ],
- [
- 'name' => 'ChannelType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '技能组类型。取值：'."\n"
- ."\n"
- .'- **1**：热线。'."\n"
- .'- **2**：在线。'."\n"
- .'- **3**：工单。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '7',
- 'minimum' => '0',
- 'example' => '2',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-****-70b6a298d94d',
- ],
+ 'name' => 'FileName',
+ 'in' => 'query',
+ 'schema' => ['description' => '上传文件的名称。', 'type' => 'string', 'required' => true, 'example' => 'test-audio'],
],
[
- 'name' => 'DepartmentId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '部门ID',
- 'description' => '部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123',
- ],
+ 'name' => 'FileType',
+ 'in' => 'query',
+ 'schema' => ['description' => '文件类型', 'type' => 'string', 'required' => false, 'example' => 'wav'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE339D98-9BD3-4413-B165'],
'Data' => [
- 'description' => '创建成功的技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '返回数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'FilePath' => ['description' => 'OSS文件的保存路径', 'type' => 'string', 'example' => 'audio/file/sample1'],
+ 'Policy' => ['description' => '上传策略', 'type' => 'string', 'example' => 'text'],
+ 'SecurityToken' => ['description' => '授权密钥。', 'type' => 'string', 'example' => 'text'],
+ 'Expire' => ['description' => '授权失效时间', 'type' => 'string', 'example' => '2026-06-13T12:19:13Z'],
+ 'UploadUrl' => ['description' => '上传地址', 'type' => 'string', 'example' => '//alicom-voice-ai-agent-xxxx.oss-cn-xxxx.aliyuncs.com'],
+ 'MaxFileSize' => ['description' => '文件最大值', 'type' => 'integer', 'format' => 'int64', 'example' => '2560000'],
+ 'AccessKeyId' => ['description' => '签名使用的AccessKeyId。', 'type' => 'string', 'example' => 'STS.NYMxfDw3GkXfvEmZHXXXXXX'],
+ 'Signature' => ['description' => '文件上传临时凭证的签名信息，用于上传时验证合法性。', 'type' => 'string', 'example' => 'oss sig text'],
+ 'Host' => ['description' => 'Host 地址。', 'type' => 'string', 'example' => '//alicom-voice-ai-agent-xxxx.oss-cn-xxxx.aliyuncs.com'],
+ 'Method' => ['description' => '上传使用的HTTP方法', 'type' => 'string', 'example' => 'POST'],
+ 'Key' => ['description' => 'OSS文件的key', 'type' => 'string', 'example' => 'audio/file/sample1'],
+ ],
+ 'example' => '',
],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- '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',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取语音小记OSS上传信息',
+ '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' => '创建技能组',
- 'summary' => '根据技能组名称和渠道类型创建技能组。',
- 'description' => '- 此接口可定义技能组的对外显示名、描述等信息，具体请参见[请求参数](#api-detail-35)。'."\n"
- .'- 此接口返回的**Data**参数即为创建成功的技能组ID。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：1000次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ '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' => '通过CallId查询对话内容，只支持查询近一个月通话已结束的通话对话内容。',
+ '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' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'SkillGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。'."\n"
- ."\n"
- .'> 不支持更新。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '123456',
- ],
- ],
- [
- 'name' => 'SkillGroupName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '技能组名称。'."\n"
- .'> 不支持更新。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '自动化测试',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => '技能组描述。'."\n"
- .'> 此参数支持更新。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '自动化测试',
- ],
- ],
- [
- 'name' => 'DisplayName',
+ 'name' => 'CallDate',
'in' => 'query',
- 'schema' => [
- 'description' => '技能组对外显示名称。'."\n"
- .'> 此参数支持更新。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '自动化测试',
- ],
+ 'schema' => ['description' => '外呼日期，只可查询最近30天的日期，格式：yyyy-MM-dd。', 'type' => 'string', 'required' => false, 'example' => '2025-06-06'],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'CallId',
'in' => 'query',
- 'schema' => [
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-****-70b6a298d94d',
- ],
+ 'schema' => ['description' => '呼叫记录ID，用于标识一条通话记录。'."\n"
+ ."\n"
+ .'> 在调用大模型外呼接口LlmSmartCall是，会返回此呼叫记录ID，即CallId。', 'type' => 'string', 'required' => false, 'example' => '123456^123478'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'result',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息；只有RAM校验失败才会返回此字段。', 'type' => 'string', 'example' => 'Access Denied'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FB0B0481-F13E-16E0-8A7A-1AD2FXXXEF55'],
+ 'Message' => ['description' => '返回消息', 'type' => 'string', 'example' => '成功'],
+ 'Data' => [
+ 'description' => '返回数据结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'DialogContent' => ['description' => '对话内容', 'type' => 'string', 'example' => '[{\\"content\\":\\"您好。\\",\\"role\\":\\"assistant\\"},{\\"content\\":\\"不用了。\\",\\"role\\":\\"user\\"},{\\"content\\":\\"呃，不用了，再见，谢谢。\\",\\"role\\":\\"user\\"}]'],
+ 'CallId' => ['description' => '呼叫ID', 'type' => 'string', 'example' => '123456^123478'."\n"],
+ 'CallStatus' => ['description' => '呼叫状态 '."\n"
+ .'> 呼叫状态返回值描述'."\n"
+ .'> - 0：未接通；'."\n"
+ .'> - 1：已接通；'."\n"
+ .'> - 2：已挂断；', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ ],
],
+ 'Code' => ['description' => '请求返回Code。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorMessage' => 'The specified instance is unavailable or does not exist.',
- 'errorCode' => 'InvalidInstanceId',
- ],
+ ['errorCode' => 'InvalidParameter.CallId', 'errorMessage' => 'The parameter CallId is invalid.', 'description' => '参数CallId无效。'."\n"],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- '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' => '修改技能组',
- 'summary' => '根据AICCS实例ID、技能组ID更新悉犀客服工作台技能组信息。支持更新技能组描述、技能组对外显示名称。',
- 'description' => '- 此接口不支持更新技能组ID、技能组名称。'."\n"
- .'- 更新后，您可以调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口查询技能组信息。'."\n"
- .'- 若您需要填写AICCS实例ID、技能组ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：1000次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'RemoveSkillGroup' => [
- 'methods' => [
- 'post',
- 'get',
+ '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' => '通过CallId查询近一个月通话已结束的通话对话内容',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aiccs:GetCallDialogContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetCallSoundRecord' => [
+ 'summary' => '根据呼叫创建时间、呼叫唯一ID获取通话录音文件URL，根据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' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'SkillGroupId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123456',
- ],
+ 'name' => 'CreateTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '呼叫创建时间。格式：YYYY-MM-DD hh:mm:ss。'."\n"
+ ."\n\n"
+ .'可调用[RobotCall](~~2717996~~)接口，查看调用后的**Response Header**中的**date**参数获取。', 'type' => 'string', 'required' => true, 'example' => '2021-10-15 08:56:23'],
],
[
- 'name' => 'ClientToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-****-70b6a298d94d',
- ],
+ 'name' => 'CallId',
+ 'in' => 'query',
+ 'schema' => ['description' => '呼叫唯一ID。'."\n"
+ ."\n\n"
+ .'可调用[RobotCall](~~2717996~~)接口，查看返回参数的**Data**获取。', 'type' => 'string', 'required' => true, 'example' => '125165515022^11195613****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'result',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => ['description' => '通话录音文件URL。', 'type' => 'string', 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/1001067****.wav'],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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',
- ],
- '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' => '删除技能组',
- 'summary' => '根据AICCS实例ID、技能组ID删除悉犀客服工作台技能组。',
- 'description' => '- 删除为敏感操作，请您谨慎操作。'."\n"
- .'- 删除前，建议您确认AICCS实例ID、需删除的技能组ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- .'- 删除后，可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口查询技能组确认。'."\n"
- .'- 若误操作删除，可调用[CreateSkillGroup](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-createskillgroup)接口重新创建技能组。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '获取通话录音文件',
+ 'description' => '### 前提条件'."\n"
+ .'调用本接口前，请您确保调用[RobotCall](~~223270~~)接口过程中，已开启通话过程录音，且成功获取录音回执，即录音文件已生成，否则会返回无效的URL链接。'."\n"
+ ."\n"
+ .'### 使用说明'."\n"
+ .'本接口为录音回执的补充接口。当录音回执消息中的URL链接超过有效期后，可以通过本接口获取新的录音地址，默认录音回执URL有效期为三天。'."\n"
+ ."\n"
+ .'> 建议您通过录音回执URL直接下载录音内容，进行本地保存，不依赖回执的URL，以解决有效期问题。'."\n"
."\n"
.'### QPS限制'."\n"
.'- 单用户调用频率：不限流。'."\n"
- .'- API频率：1000次/秒。'."\n"
+ .'- API频率：500次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'QuerySkillGroups' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2021-10-21T13:04:17.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:GetCallSoundRecord',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetConfigNumList' => [
+ 'summary' => '调用GetConfigNumList接口获取热线设置号码列表。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11276,372 +6232,142 @@
],
'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' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'PageNo',
- 'in' => 'query',
- 'schema' => [
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '20',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-****-70b6a298d94d',
- ],
- ],
- [
- 'name' => 'ChannelType',
+ 'name' => 'DepartmentId',
'in' => 'query',
- 'schema' => [
- 'title' => '技能组类型（1：热线，2：在线，4：工单）',
- 'description' => '技能组渠道类型。取值：'."\n"
- ."\n"
- .'- **0**：返回所有技能组。'."\n"
- .'- **1**：热线技能组。'."\n"
- .'- **2**：在线技能组。'."\n"
- .'- **3**：在线+热线技能组。'."\n"
- .'- **4**：工单技能组。'."\n"
- .'- **5**：热线+工单节能组。'."\n"
- .'- **6**：在线+工单技能组。'."\n"
- .'- **7**：在线+热线+工单技能组。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- 'enum' => [
- '1',
- '2',
- '4',
- ],
- ],
+ 'schema' => ['title' => '部门ID', 'description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345'],
],
[
- 'name' => 'DepartmentId',
+ 'name' => 'AccountName',
'in' => 'query',
- 'schema' => [
- 'title' => '部门ID',
- 'description' => '部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1023****',
- ],
+ 'schema' => ['title' => '账号名称', 'description' => '坐席账号名称。实例内唯一（登录名）。', 'type' => 'string', 'required' => false, 'example' => '123@123.com'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'OnePageSize' => [
- 'description' => '每页的数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'TotalPage' => [
- 'description' => '总页数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'CurrentPage' => [
- 'description' => '当前页。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalResults' => [
- 'description' => '总共记录数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '76',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE339D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
'Data' => [
- 'description' => '数据。',
+ 'title' => '号码列表',
+ 'description' => '号码列表。',
'type' => 'array',
- 'items' => [
- 'description' => '数据信息。',
- 'type' => 'object',
- 'properties' => [
- 'Description' => [
- 'description' => '技能组描述。',
- 'type' => 'string',
- 'example' => '自动化技能组',
- ],
- 'SkillGroupName' => [
- 'description' => '技能组名称。',
- 'type' => 'string',
- 'example' => '自动化技能组',
- ],
- 'DisplayName' => [
- 'description' => '技能组对外显示名称。',
- 'type' => 'string',
- 'example' => '自动化技能组',
- ],
- 'SkillGroupId' => [
- 'description' => '技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'ChannelType' => [
- 'description' => '技能组渠道类型。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- ],
- ],
+ 'items' => ['description' => '号码列表。', 'type' => 'string', 'example' => '0:"057****890" 1:"057****506" 2:"057****507" 3:"057****417" 4:"057****090" 5:"057****888"'],
],
+ 'Code' => ['title' => '错误码', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['title' => '接口调用是否成功', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '查询技能组',
- 'summary' => '根据实例ID查询悉犀客服工作台技能组列表。',
- 'description' => '此接口可查询技能组的对外显示名称、描述、渠道类型、ID等信息，具体参见[返回参数](#api-detail-40)。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：1000次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'ListSkillGroup' => [
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","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}","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' => '获取热线设置号码列表',
+ 'changeSet' => [
+ ['createdAt' => '2021-05-21T09:25:21.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConfigNumList'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetCustomerInfo' => [
+ 'summary' => '调用GetCustomerInfo接口根据工作台会员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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-****-70b6a298d94d',
- ],
- ],
- [
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'ChannelType',
+ 'name' => 'MemberId',
'in' => 'query',
- 'schema' => [
- 'description' => '技能组渠道类型。取值：'."\n"
- .'- **0**：返回所有技能组。'."\n"
- .'- **1**：热线技能组。'."\n"
- .'- **2**：在线技能组。'."\n"
- .'- **3**：在线+热线技能组。'."\n"
- .'- **4**：工单技能组。'."\n"
- .'- **5**：热线+工单节能组。'."\n"
- .'- **6**：在线+工单技能组。'."\n"
- .'- **7**：在线+热线+工单技能组。'."\n"
- ."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '7',
- 'minimum' => '0',
- 'example' => '2',
- ],
+ 'schema' => ['title' => '会员ID', 'description' => '会员ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '1', 'example' => '82345678****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DF6A3FB7-A5AA-43BE-A65B'],
+ 'Message' => ['title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '技能组信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据信息。',
- 'type' => 'object',
- 'properties' => [
- 'Description' => [
- 'description' => '技能组描述。',
- 'type' => 'string',
- 'example' => '自动化技能组',
- ],
- 'DisplayName' => [
- 'description' => '技能组对外显示名称。',
- 'type' => 'string',
- 'example' => '自动化技能组',
- ],
- 'SkillGroupId' => [
- 'description' => '技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'ChannelType' => [
- 'description' => '技能组渠道类型。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Name' => [
- 'description' => '技能组名称。',
- 'type' => 'string',
- 'example' => '自动化技能组',
- ],
- ],
+ 'title' => '会员信息',
+ 'description' => '会员信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OuterId' => ['title' => '外部ID', 'description' => '外部ID。', 'type' => 'string', 'example' => '6666666'],
+ 'Nick' => ['title' => '昵称', 'description' => '昵称。', 'type' => 'string', 'example' => '测试会员'],
+ 'UserId' => ['title' => '会员ID', 'description' => '会员ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '823456789023'],
+ 'CustomizeFields' => ['title' => '自定义字段', 'description' => '自定义字段。', 'type' => 'object'],
+ 'Photo' => ['title' => '头像', 'description' => '头像。', 'type' => 'string', 'example' => 'https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLSW7XPFlJDwVunXP8pr84TvltwtLlNqTlOVSFeM3bCgn57mAB4JuZZmvMW0qicqW0PyzyUdZpxiaFQ'],
+ 'RealName' => ['title' => '真实姓名', 'description' => '真实姓名。', 'type' => 'string', 'example' => '刘测试'],
],
],
- 'Code' => [
- 'description' => '状态码。返回Success表示调用成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '错误码', 'description' => '状态码。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '是否请求成功', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '[{"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' => '获取会员信息',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => '错误码发生变更'],
],
- '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' => '查询技能组',
- 'summary' => '根据实例ID、技能组渠道类型查询悉犀客服工作台技能组。',
- 'description' => '### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomerInfo'],
+ ],
+ ],
+ 'ramActions' => [],
],
'GetDepGroupTreeData' => [
'summary' => '根据AICCS实例ID、坐席ID查询技能组分组和技能组列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11649,39 +6375,20 @@
],
'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' => [
- 'title' => '租户实例ID',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => '租户实例ID', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
'name' => 'AgentId',
'in' => 'query',
- 'schema' => [
- 'title' => '坐席ID',
- 'description' => '坐席ID。'."\n"
- ."\n"
- .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123456',
- ],
+ 'schema' => ['title' => '坐席ID', 'description' => '坐席ID。'."\n"
+ ."\n"
+ .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
],
],
'responses' => [
@@ -11691,18 +6398,8 @@
'description' => 'result',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => 'Message',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => 'Message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
'title' => 'Data',
'description' => '部门信息。',
@@ -11711,12 +6408,7 @@
'description' => '部门信息。',
'type' => 'object',
'properties' => [
- 'DepGroupId' => [
- 'title' => 'depGroupId',
- 'description' => '部门ID。',
- 'type' => 'string',
- 'example' => '10****',
- ],
+ 'DepGroupId' => ['title' => 'depGroupId', 'description' => '部门ID。', 'type' => 'string', 'example' => '10****'],
'GroupDTOS' => [
'title' => 'groupDTOS',
'description' => '技能组数据。',
@@ -11725,60 +6417,29 @@
'description' => '技能组信息。',
'type' => 'object',
'properties' => [
- 'SkillGroupId' => [
- 'title' => 'skillGroupId',
- 'description' => '技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '55****',
- ],
- 'Name' => [
- 'title' => 'name',
- 'description' => '技能组名称。',
- 'type' => 'string',
- 'example' => '自动化技能组',
- ],
+ 'SkillGroupId' => ['title' => 'skillGroupId', 'description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '55****'],
+ 'Name' => ['title' => 'name', 'description' => '技能组名称。', 'type' => 'string', 'example' => '自动化技能组'],
],
],
],
- 'DepGroupName' => [
- 'title' => 'depGroupName',
- 'description' => '部门名称。',
- 'type' => 'string',
- 'example' => '部门A',
- ],
+ 'DepGroupName' => ['title' => 'depGroupName', 'description' => '部门名称。', 'type' => 'string', 'example' => '部门A'],
],
],
],
- 'Code' => [
- 'title' => 'Code',
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'title' => 'Success',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => 'Code', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['title' => 'Success', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'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' => '[{"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' => '查询技能组分组和技能组列表',
'description' => '- 此接口查询的技能组以部门ID分组，部门ID可在[创建技能组](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-createskillgroup)时填写。'."\n"
@@ -11790,16 +6451,20 @@
.'- API频率：1000次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'CreateDepartment' => [
- 'summary' => '根据AICCS实例ID、部门名称创建部门信息，创建成功后会返回部门ID。',
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2021-05-13T16:12:41.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDepGroupTreeData'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetDepartmentalLatitudeAgentStatus' => [
+ 'summary' => '获取热线监控下部门纬度状态量。支持实例、时间区间、部门分组查询。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -11807,241 +6472,234 @@
],
'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' => [
- 'title' => '实例id',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'DepartmentName',
+ 'name' => 'StartDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'DepIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'title' => '部门名称',
- 'description' => '部门名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '部门A',
+ 'title' => '技能组分组id列表',
+ 'description' => '部门ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
+ 'required' => false,
],
],
+ [
+ 'name' => 'ExistDepartmentGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据技能组分组id分组显示', 'description' => '是否根据部门分组查询。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回数据。',
+ 'title' => 'result',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Message' => ['title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'message'],
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
'Data' => [
- 'description' => '部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '数据',
+ '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' => '信息为List<Map>类型的JSON字符串。', 'type' => 'string', '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}'],
+ ],
],
+ 'Code' => ['title' => '错误编码', 'description' => '状态码。返回200代表请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '接口调用是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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' => '创建部门信息',
- 'description' => '- 若您需要更新部门信息，可调用[UpdateDepartment](~~2717977~~)接口。'."\n"
- .'- 调用此接口创建部门信息成功后，返回参数的**Data**即为部门ID，若您后续还需查询部门ID，可调用[GetAllDepartment](~~2717975~~)接口。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '获取热线监控下部门纬度状态量',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
+ .'- 若您需要填写部门信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
."\n"
.'### QPS限制'."\n"
.'- 单用户调用频率：100次/秒。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GetAllDepartment' => [
- 'summary' => '根据AICCS实例ID获取所有部门信息，可获取部门ID、部门名称。',
- 'methods' => [
- 'get',
+ 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
+ ."\n"
+ .' n_idle_now：当前空闲坐席数'."\n"
+ .' n_resttype_now：当前小休坐席数'."\n"
+ .' n_resttype1_now：当前普通小休坐席数'."\n"
+ .' n_resttype2_now：当前就餐小休坐席数'."\n"
+ .' n_resttype3_now：当前会议小休坐席数'."\n"
+ .' n_resttype4_now：当前辅导小休坐席数'."\n"
+ .' n_resttype5_now：当前培训小休坐席数'."\n"
+ .' n_resttype98_now：当前强制小休坐席数'."\n"
+ .' n_resttype99_now：当前签入小休坐席数'."\n"
+ .' n_ack_now：当前后处理坐席数'."\n"
+ .' n_online_now：当前在线坐席数'."\n"
+ .' n_busy_now：通话坐席数'."\n"
+ .' tenant_id：租户ID'."\n"
+ .' tenant_name：租户名称'."\n"
+ .' department_id：部门ID'."\n"
+ .' department_name：部门名称'."\n"
+ .' date_id：日期'."\n"
+ .' n_inqueue_now：排队中会员数'."\n"
+ .' n_inservice_now：服务中会员数'."\n"
+ .' time_value：时间戳'."\n"
+ .' fst_assign_time：该队列最早的时间，排队中的分配时间',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDepartmentalLatitudeAgentStatus'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ '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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d****'],
+ ],
+ [
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '实例id',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
+ ],
+ [
+ 'name' => 'AccountName',
+ 'in' => 'query',
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'result',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => 'message',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F',
- ],
- 'HttpStatusCode' => [
- 'title' => 'httpStatusCode',
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Data' => [
- 'title' => 'data',
- 'description' => '部门信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '部门信息。',
- 'type' => 'object',
- 'properties' => [
- 'DepartmentName' => [
- 'description' => '部门名称。',
- 'type' => 'string',
- 'example' => '部门A',
- ],
- 'DepartmentId' => [
- 'description' => '部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- ],
+ 'description' => '坐席服务数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Assigned' => ['description' => '是否被分配。取值：'."\n"
+ .'**false**：未分配（无通话）。'."\n"
+ .'**true**：已分配（有通话）。', 'type' => 'boolean', 'example' => 'false'],
+ 'TenantId' => ['description' => '坐席所属的租户ID，与入参中的实例ID相对应。', 'type' => 'integer', 'format' => 'int64', 'example' => 'ccc_xp_pre-cn-***'],
+ 'RestType' => ['description' => '小休类型。取值： '."\n"
+ ."\n"
+ .'- **1**：小休。'."\n"
+ .'- **2**：就餐。'."\n"
+ .'- **3**：会议。'."\n"
+ .'- **4**：辅导。'."\n"
+ .'- **5**：培训。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'AgentStatus' => ['description' => '坐席状态。取值范围：**1~6**。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'AgentStatusCode' => ['description' => '坐席状态编码。取值：'."\n"
+ ."\n"
+ .'- **AgentCheckout**：坐席下班。'."\n"
+ .'- **AgentReady**：坐席空闲。'."\n"
+ .'- **AgentBreak**：坐席小休。'."\n"
+ .'- **AgentAcw**：话后处理。'."\n"
+ .'- **AgentBusyForCall**：通话中。', 'type' => 'string', 'example' => 'AgentCheckout'],
+ 'Token' => ['description' => '心跳签名。', 'type' => 'string', 'example' => 'dnthF_oinHg7JMJDmKqex3Ux****'],
+ 'AgentId' => ['description' => '坐席ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2235****'],
],
],
- 'Code' => [
- 'title' => 'code',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => 'success',
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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',
- ],
- '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' => '获取所有部门信息',
- 'description' => '- 您可以调用此接口获取部门ID，用于支持部分查询数据的接口（例如[GetHotlineServiceStatistics](~~2717938~~)）的部门分组查询。'."\n"
- .'- 创建、删除、更新部门信息后，您可以调用此接口确认部门信息是否符合预期。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '获取热线坐席详情',
+ 'summary' => '根据实例ID、坐席账号名称获取热线坐席当前服务详情。',
+ 'description' => '热线坐席详情包含坐姿状态、坐席ID、心跳签名等信息，具体参见[返回参数](#api-detail-40)。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'DeleteDepartment' => [
- 'summary' => '根据AICCS实例ID、部门ID删除部门信息。',
- 'methods' => [
- 'get',
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'GetHotlineAgentDetailReport' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -12049,263 +6707,223 @@
],
'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' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '20', 'default' => '10'],
+ ],
+ [
+ 'name' => 'StartDate',
+ 'in' => 'query',
+ 'schema' => ['description' => '开始日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1614824872'],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['description' => '结束日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1614824972'],
+ ],
+ [
'name' => 'InstanceId',
'in' => 'query',
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
+ ],
+ [
+ 'name' => 'DepIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '实例id',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
+ 'description' => '部门ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](~~2717975~~)接口，查看返回参数的**DepartmentId**，即部门ID。'."\n"
+ ."\n"
+ .'> 当该参数不为空时：'."\n"
+ .'> - 若GroupIds不为空，则优先以GroupIds参数对应技能组列表查询。'."\n"
+ .'> - 若GroupIds为空，则优先以该参数对应部门列表查询。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5623***'],
+ 'required' => false,
+ 'maxItems' => 200,
],
],
[
- 'name' => 'DepartmentId',
+ 'name' => 'GroupIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '部门id',
- 'description' => '部门ID。'."\n"
+ 'description' => '技能组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '技能组ID。'."\n"
."\n"
- .'可调用[GetAllDepartment](~~2717975~~)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '12****',
+ .'可调用[QuerySkillGroups](~~2717970~~)接口，查看返回参数的**SkillGroupId**，即技能组ID。'."\n"
+ ."\n"
+ .'> 当该参数不为空时，优先以参数对应技能组列表查询。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232****'],
+ 'required' => false,
+ 'maxItems' => 200,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'seccessful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Data' => [
- 'description' => '是否成功。取值：'."\n"
- .'- **true**：成功'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '查询结果数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageSize' => ['description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['description' => '总共记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
+ 'Columns' => [
+ 'description' => '返回列描述。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '指标数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Title' => ['description' => '指标说明。', 'type' => 'string', 'example' => '客服姓名'],
+ 'Key' => ['description' => '指标。', 'type' => 'string', 'example' => 'realName'],
+ ],
+ ],
+ ],
+ 'Page' => ['description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Rows' => [
+ 'description' => '返回数据结果。',
+ 'type' => 'array',
+ 'items' => ['description' => '返回数据。', 'type' => 'object', '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%"}]'],
+ ],
+ ],
],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorMessage' => 'The specified department does not exist.',
- 'errorCode' => 'Department.NotFound',
- ],
- ],
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\\": \\"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' => '删除部门信息',
- 'description' => '- 删除为敏感操作，请您谨慎操作。'."\n"
- ."\n"
- .'- 调用此接口前，建议您确认AICCS实例ID及部门ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- .'- 若误删除部门信息，您可以调用[CreateDepartment](~~2717974~~)接口重新创建。'."\n"
+ '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' => '获取热线坐席维度（T+1）数据详情',
+ 'summary' => '获取热线坐席维度（T+1）数据详情。支持实例、时间区间、部门、技能组分组查询。',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](~~276009~~)，并[创建实例](~~276011~~)。'."\n"
+ .'- 若您需要填写部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ ."\n\n"
+ .'> 查询逻辑优先级：'."\n"
+ .'> - 若GroupIds不为空，则查询对应技能组列表下数据指标。'."\n"
+ .'> - 否则，若DepIds不为空，则查询对应技能组分组下数据指标。'."\n"
+ .'> - 否则，查询AICCS实例下数据指标。'."\n"
."\n\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：10次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'UpdateDepartment' => [
- 'summary' => '根据AICCS实例ID、部门ID更新部门名称。',
- 'methods' => [
- 'get',
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ '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' => [
- 'title' => '实例id',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'DepartmentName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '部门名称',
- 'description' => '部门名称。'."\n"
- ."\n"
- .'> 支持更新该参数。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '部门A',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'DepartmentId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '部门id',
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](~~2717975~~)接口，查看返回参数的**DepartmentId**，即部门ID。'."\n"
- ."\n"
- .'> 不支持更新。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '12****',
- ],
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回数据。',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Data' => [
- 'description' => '是否成功。取值：'."\n"
- .'- **true**：成功'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Data' => ['description' => '坐席状态。取值：'."\n"
+ .'- **离线**'."\n"
+ .'- **空闲**'."\n"
+ .'- **话后处理**'."\n"
+ .'- **通话中**'."\n"
+ .'- **小休-休息**'."\n"
+ .'- **小休-就餐**'."\n"
+ .'- **小休-会议**'."\n"
+ .'- **小休-培训**'."\n"
+ .'- **小休-辅导**', 'type' => 'string', 'example' => '通话中'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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\\": \\"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' => '更新部门信息',
- 'description' => '- 此接口仅支持更新部门名称，不支持更新部门ID。'."\n"
- .'- 调用此接口前，建议您确认AICCS实例ID及部门ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- .'- 更新完成后，您可以调用[GetAllDepartment](~~2717975~~)接口，确认部门信息是否符合预期。'."\n"
+ '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' => '获取热线坐席状态',
+ 'summary' => '根据AICCS实例ID、坐席账号名称查询悉犀客服工作台热线坐席状态。',
+ 'description' => '- 调用此接口前，请您确认AICCS的实例信息及坐席账号名称，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ .'- 若需获取热线坐席详情，可调用[GetHotlineAgentDetail](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-gethotlineagentdetail)接口。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：200次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GenerateWebSocketSign' => [
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:00.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'GetHotlineCallAction' => [
+ 'summary' => '调用GetHotlineCallAction接口查询话务动作结果数据。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -12314,515 +6932,182 @@
'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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-****-70b6a298d94d',
- ],
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d9****'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
'name' => 'AccountName',
'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'username@example.com'],
+ ],
+ [
+ 'name' => 'Act',
+ 'in' => 'formData',
+ 'schema' => ['description' => '操作类型。取值：'."\n"
+ .'- **1**：热线。'."\n"
+ .'- **2**：在线。'."\n"
+ .'- **3**：工单。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1', 'default' => '0'],
+ ],
+ [
+ 'name' => 'FromSource',
+ 'in' => 'formData',
+ 'schema' => ['description' => '来源类型。取值：'."\n"
+ ."\n"
+ .'- **hotlinebs_out**：热线。'."\n"
+ .'- **ticket_out**：工单。'."\n"
+ .'- **other_system_out**：其他系统。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hotlinebs_out'],
+ ],
+ [
+ 'name' => 'Biz',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务自定义参数', 'description' => '业务自定义参数，格式为JSON。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"name":123}'],
+ ],
+ [
+ 'name' => 'Acc',
+ 'in' => 'formData',
+ 'schema' => ['title' => '热线自定义参数', 'description' => '热线自定义参数，格式为JSON。', 'type' => 'string', 'required' => false, 'example' => '{"time":1}'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
+ 'description' => ' '."\n"
+ .'result',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE339D98-9BD3-4413-B165'],
'Data' => [
- 'description' => 'MessageBox消息通道签名码。',
- 'type' => 'string',
- 'example' => 'dnthF_oinHg7JMJDmKqex3UxDD7',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '任务编号。', 'type' => 'integer', 'format' => 'int64', 'example' => '12345****'],
+ 'SubTouchId' => ['description' => '次接触ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3423****'],
+ 'MemberList' => ['description' => '会员列表。', 'type' => 'string', 'example' => '8900****'],
+ 'DepId' => ['description' => '部门编号。', 'type' => 'integer', 'format' => 'int64', 'example' => '1223****'],
+ 'CaseId' => ['description' => '工单编号。', 'type' => 'integer', 'format' => 'int64', 'example' => '1138902****'],
+ 'ChannelId' => ['description' => '渠道编号。', 'type' => 'string', 'example' => '2377****'],
+ 'TouchId' => ['description' => '接触ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2235****'],
+ 'BuId' => ['description' => '租户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2367****'],
+ 'CalloutId' => ['description' => '呼叫编号', 'type' => 'integer', 'format' => 'int64', 'example' => '1122****'],
+ 'MemberId' => ['description' => '会员ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '7856876****'],
+ 'ActionId' => ['description' => '客户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '8999****'],
+ 'ServicerName' => ['description' => '客服名称。', 'type' => 'string', 'example' => 'XX测试'],
+ 'CalloutName' => ['description' => '呼叫名称。', 'type' => 'string', 'example' => '王XX'],
+ 'IsTransfer' => ['description' => '是否转移。', 'type' => 'string', 'example' => 'true'],
+ 'MemberName' => ['description' => '会员名称。', 'type' => 'string', 'example' => '匿名会员'],
+ 'ServicerId' => ['description' => '坐席ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1332****'],
+ 'ChannelType' => ['description' => '渠道类型。取值：'."\n"
+ ."\n"
+ .'- **1**：热线。'."\n"
+ .'- **2**：在线。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ ],
],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '生成MessageBox通道签名',
- 'summary' => '根据AICCS实例ID和坐席账号名称，生成消息通道访问签名。',
- 'description' => '- 您可以通过此接口生成消息通道访问签名，返回参数的**Data**即为MessageBox消息通道签名码。 '."\n"
- ."\n"
- .'- 调用前建议您确认AICCS实例ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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":""}]',
+ 'title' => '查询话务动作结果数据',
+ 'description' => '### QPS限制'."\n"
+ .'- 单用户调用频率：50次/秒。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'HotlineSessionQuery' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2022-03-07T06:25:25.000Z', 'description' => '请求参数发生变更'],
],
- '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' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'Acid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '会话ID。入呼后，websocket中的acid。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => '7719786****',
- ],
- ],
- [
- 'name' => 'CallType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '电话类型。取值：'."\n"
- .'- **1**：外呼。'."\n"
- .'- **2**：入呼。'."\n"
- .'- **3**：转交。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'CalledNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '发起方号码。例如用户手机号码、客服坐席号码、机器号码等。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '135615****',
- ],
- ],
- [
- 'name' => 'CallingNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '接听方号码。例如用户手机号码、客服坐席号码、机器号码等。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '057177****',
- ],
- ],
- [
- 'name' => 'GroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456',
- ],
- ],
- [
- 'name' => 'GroupName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '技能组名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '自动化技能组',
- ],
- ],
- [
- 'name' => 'MemberId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '会员ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7856****',
- ],
- ],
- [
- 'name' => 'MemberName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '会员名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '匿名会员',
- ],
- ],
- [
- 'name' => 'QueryEndTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '结束时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1614829721',
- ],
- ],
- [
- 'name' => 'QueryStartTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '开始时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1614828721',
- ],
- ],
- [
- 'name' => 'RequestId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- ],
- [
- 'name' => 'ServicerName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '坐席名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '刘测试',
- ],
- ],
- [
- 'name' => 'ServicerId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '坐席ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '555555',
- ],
- ],
- [
- 'name' => 'Params',
+ 'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'description' => '扩展参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '50',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '20', 'default' => '10'],
],
[
- 'name' => 'PageNo',
+ 'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '开始日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1614824872', 'default' => ''],
],
[
- 'name' => 'CallResult',
+ 'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'description' => '呼叫结果。取值：'."\n"
- ."\n"
- .'- **normal**：正常挂机。'."\n"
- .'- **touchRouteError**：队列挂机。'."\n"
- .'- **touchInQueue**：队列挂机。'."\n"
- .'- **touchInLoss**：队列挂机。'."\n"
- .'- **userHangup**：用户挂机，IVR挂机。'."\n"
- .'- **sysHangup**：系统挂机，IVR挂机。'."\n"
- .'- **transferAgent**：用户挂机，IVR挂机。'."\n"
- .'- **dailing**：客服挂机，振铃挂机。'."\n"
- .'- **TouchRingCallLoss**：队列挂机，振铃挂机。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'normal',
- 'enum' => [
- 'normal',
- 'queueClose',
- 'dailingClose',
- 'ivrClose',
- ],
- ],
+ 'schema' => ['description' => '结束日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1614824972'],
],
[
- 'name' => 'Id',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '通话详情全局唯一ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'acc1c58dab4a4****0e3813c66',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'AcidList',
+ 'name' => 'DepIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '会话ID列表。',
+ 'description' => '部门ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '入呼后，websocket中的acid。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7719786',
- ],
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](~~2717975~~)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '56****'],
'required' => false,
'maxItems' => 200,
],
],
[
- 'name' => 'CallTypeList',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '呼叫类型列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '呼叫类型。取值：'."\n"
- .'- **1**：外呼。'."\n"
- .'- **2**：入呼。'."\n"
- .'- **3**：转交。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'required' => false,
- 'maxItems' => 5,
- ],
- ],
- [
- 'name' => 'GroupIdList',
+ 'name' => 'GroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '技能组ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
- ],
- [
- 'name' => 'CallingNumberList',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '主叫号码列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '主叫号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0571773****',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
- ],
- [
- 'name' => 'CalledNumberList',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '被叫号码列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '被叫号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '135615****',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
- ],
- [
- 'name' => 'MemberIdList',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '会员列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '会员ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7856876',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
- ],
- [
- 'name' => 'ServicerIdList',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '坐席列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '坐席ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '555555',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
- ],
- [
- 'name' => 'CallResultList',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '呼叫结果列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '呼叫结果。取值： '."\n"
- ."\n"
- .'- **normal**：正常通话结束 。'."\n"
- .'- **queueClose**： 队列挂机 。'."\n"
- .'- **dailingClose**：振铃挂机 。'."\n"
- .'- **ivrClose**：IVR挂机。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'normal',
- ],
+ 'items' => ['description' => '技能组ID。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](~~2717970~~)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'],
'required' => false,
'maxItems' => 200,
],
@@ -12831,467 +7116,170 @@
'responses' => [
200 => [
'schema' => [
- 'description' => 'result',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE339D98-9BD3-4413-B165',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
'Data' => [
- 'description' => '通话数据。',
+ 'description' => '查询结果数据。',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'description' => '总共记录数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '26',
- ],
- 'PageSize' => [
- 'description' => '每页的数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNumber' => [
- 'description' => '当前页。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CallDetailRecord' => [
- 'description' => '通话记录。',
+ 'PageSize' => ['description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['description' => '总共记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '9'],
+ 'Columns' => [
+ 'description' => '返回列描述。',
'type' => 'array',
'items' => [
- 'description' => '通话记录信息。',
+ 'description' => '返回列描述。',
'type' => 'object',
'properties' => [
- 'GroupName' => [
- 'description' => '技能组名称。'."\n"
- .'> 当CallType取值为**1**时，外呼场景无技能组信息。',
- 'type' => 'string',
- 'example' => '自动化技能组',
- ],
- 'CallResult' => [
- 'description' => '呼叫结果。取值：'."\n"
- ."\n"
- .'- **normal**：正常挂机。'."\n"
- .'- **touchRouteError**：队列挂机。'."\n"
- .'- **touchInQueue**：队列挂机。'."\n"
- .'- **touchInLoss**：队列挂机。'."\n"
- .'- **userHangup**：用户挂机，IVR挂机。'."\n"
- .'- **sysHangup**：系统挂机，IVR挂机。'."\n"
- .'- **transferAgent**：用户挂机，IVR挂机。'."\n"
- .'- **dailing**：客服挂机，振铃挂机。'."\n"
- .'- **TouchRingCallLoss**：队列挂机，振铃挂机。',
- 'type' => 'string',
- 'example' => 'normal',
- ],
- 'CalledNumber' => [
- 'description' => '被叫号码。',
- 'type' => 'string',
- 'example' => '135615*****',
- ],
- 'Acid' => [
- 'description' => '会话ID。入呼后，websocket中的acid。',
- 'type' => 'string',
- 'example' => '7719786',
- ],
- 'CallType' => [
- 'description' => '呼叫类型。取值：'."\n"
- .'- **1**：外呼'."\n"
- .'- **2**：入呼'."\n"
- .'- **3**：转交',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'QueueUpContinueTime' => [
- 'description' => '排队时长。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'PassiveTransferId' => [
- 'description' => '坐席ID。转交电话号码。'."\n"
- .'> 非转交场景数据为Null。',
- 'type' => 'string',
- 'example' => '12',
- ],
- 'CallingNumber' => [
- 'description' => '发起方号码。例如用户手机号码、客服坐席号码、机器号码等。',
- 'type' => 'string',
- 'example' => '0571773',
- ],
- 'MemberId' => [
- 'description' => '会员ID。',
- 'type' => 'string',
- 'example' => '7856876',
- ],
- 'ServicerName' => [
- 'description' => '坐席名称。'."\n"
- .'> 呼入场景未分配到到坐席之前无坐席信息。',
- 'type' => 'string',
- 'example' => '刘测试',
- ],
- 'OutQueueTime' => [
- 'description' => '热线分配出队时间。'."\n"
- ."\n"
- .'> 外呼场景无出队时间。',
- 'type' => 'string',
- 'example' => '2020-10-02 22:32:59',
- ],
- 'RingEndTime' => [
- 'description' => '振铃结束时间。'."\n"
- ."\n"
- .'> 外呼场景无振铃结束时间。',
- 'type' => 'string',
- 'example' => '2020-10-02 22:33:09',
- ],
- 'PickUpTime' => [
- 'description' => '接起时间。',
- 'type' => 'string',
- 'example' => '2020-10-02 22:33:09',
- ],
- 'EvaluationLevel' => [
- 'description' => '满意度，评价星级。取值：'."\n"
- ."\n"
- .'- **2**：二级满意度'."\n"
- .'- **3**：三级满意度'."\n"
- .'- **4**：四级满意度'."\n"
- .'- **5**：五级满意度'."\n"
- ."\n"
- .'> 外呼场景和未接通场景无数据。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'RingContinueTime' => [
- 'description' => '振铃时长。单位：秒。'."\n"
- ."\n"
- .'> 外呼场景无振铃时间。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PassiveTransferIdType' => [
- 'description' => '会话被转交方。取值：'."\n"
- .'- **1**：坐席ID。'."\n"
- .'- **2**：转交电话号码。'."\n"
- ."\n"
- .'> 非转交场景数据为Null',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'EvaluationScore' => [
- 'description' => '满意度-评价得分。取值：'."\n"
- .'- **1**：非常不满意'."\n"
- .'- **2**：不满意'."\n"
- .'- **3**：一般'."\n"
- .'- **4**：满意'."\n"
- .'- **5**：非常满意'."\n"
- ."\n"
- .'> 外呼场景和未接通场景无数据。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'CreateTime' => [
- 'description' => '通话创建时间。'."\n"
- ."\n"
- .'> - 外呼场景为外呼发起时间。'."\n"
- .'- 入呼场景为通话进入ACC系统时间。',
- 'type' => 'string',
- 'example' => '2020-10-02 22:32:55',
- ],
- 'HangUpTime' => [
- 'description' => '挂断时间。',
- 'type' => 'string',
- 'example' => '2020-10-02 22:33:46',
- ],
- 'GroupId' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'> 当CallType取值为**1**时，外呼场景无技能组信息。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'InQueueTime' => [
- 'description' => '热线分配-入队时间。'."\n"
- .'> 外呼场景无入队时间。',
- 'type' => 'string',
- 'example' => '2020-10-02 22:32:55',
- ],
- 'RingStartTime' => [
- 'description' => '振铃开始时间。'."\n"
- ."\n"
- .'> 外呼场景无振铃开始时间。',
- 'type' => 'string',
- 'example' => '2020-10-02 22:32:59',
- ],
- 'CallContinueTime' => [
- 'description' => '通话时长。单位：秒。'."\n"
- ."\n"
- .'> 未接通场景无通话时长。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '37',
- ],
- 'ActiveTransferId' => [
- 'description' => '坐席ID。'."\n"
- .'> 非转交场景数据为Null。',
- 'type' => 'string',
- 'example' => '12',
- ],
- 'HangUpRole' => [
- 'description' => '挂机方。取值：'."\n"
- ."\n"
- .'- **1**：系统挂机'."\n"
- .'- **2**：客户挂机'."\n"
- .'- **3**：客服挂机'."\n"
- .'- **null**：未知',
- 'type' => 'string',
- 'example' => '2',
- ],
- 'MemberName' => [
- 'description' => '会员名称。',
- 'type' => 'string',
- 'example' => '匿名会员',
- ],
- 'Id' => [
- 'description' => '通话详情全局唯一ID。',
- 'type' => 'string',
- 'example' => 'acc1c58dab4a4dd280e3813c66',
- ],
- 'ServicerId' => [
- 'description' => '坐席ID。'."\n"
- .'> 呼入场景未分配到到坐席之前无坐席信息。',
- 'type' => 'string',
- 'example' => '555555',
- ],
- 'TrunkCall' => [
- 'description' => '长途电话。',
- 'type' => 'string',
- 'example' => '1861111****',
- ],
+ '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%"}'],
+ ],
],
],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '状态吗。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'string', 'example' => 'Public'],
],
],
],
],
- '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' => '批量查询通话详情',
- 'summary' => '根据实例ID查询通话详情。',
- 'description' => '通话详情包含总共记录数、呼叫结果、坐席名称、通话时间等信息。'."\n"
+ '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' => '获取热线技能组维度T+1数据详情',
+ 'summary' => '获取热线技能组维度（T+1）数据详情。支持实例、时间区间、部门、技能组分组获取。',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](~~276009~~)，并[创建实例](~~276011~~)。'."\n"
+ .'- 若您需要填写坐席、部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
."\n"
.'### QPS限制'."\n"
.'- 单用户调用频率：不限流。'."\n"
- .'- API频率：80次/秒。'."\n"
+ .'- API频率：10次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GetRecordData' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'GetHotlineMessageLog' => [
+ 'summary' => '调用GetHotlineMessageLog接口获取热线消息记录。',
+ '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' => '实例ID。'."\n"
- ."\n"
- .'请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**实例管理**中查看实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => '实例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
'name' => 'Acid',
'in' => 'query',
- 'schema' => [
- 'description' => '会话ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1001067****',
- ],
+ 'schema' => ['title' => '会话id', 'description' => '会话ID。', 'type' => 'string', 'required' => true, 'example' => '100****2077'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Rusult',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
'Data' => [
- 'description' => '数据列表。',
- 'type' => 'object',
- 'properties' => [
- 'Acid' => [
- 'description' => '会话ID。',
- 'type' => 'string',
- 'example' => '1001067****',
- ],
- 'OssLink' => [
- 'description' => '录音文件地址。',
- 'type' => 'string',
- 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***',
+ 'description' => '语音信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '语音信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Acid' => ['title' => '会话ID', 'description' => '会话ID。', 'type' => 'string', 'example' => '100****2077'],
+ 'EndTime' => ['title' => '结束时间', 'description' => '结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1623738027480'],
+ 'Content' => ['title' => '会话内容', 'description' => '会话内容。', 'type' => 'string', 'example' => '您好。'],
+ 'SenderType' => ['title' => '发送方类型（1：会员，2：坐席）', 'description' => '发送方类型。取值：'."\n"
+ .'- **1**：会员'."\n"
+ .'- **2**：坐席', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'StartTime' => ['title' => '开始时间', 'description' => '开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1623738026460'],
+ 'Mid' => ['title' => '记录id', 'description' => '记录ID。', 'type' => 'string', 'example' => '11deca999****'],
],
],
],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '错误码', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['title' => '调用是否成功', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '获取录音文件',
- 'summary' => '调用GetRecordData接口获取录音文件。',
- ],
- 'GetRecordUrl' => [
- 'summary' => '调用GetRecordUrl接口获取语音双呼录音链接。',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","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}","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' => '获取热线消息记录',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-25T12:05:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineMessageLog'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetHotlineRuntimeInfo' => [
+ 'summary' => '调用GetHotlineRuntimeInfo接口查询热线运行信息。',
+ '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' => 'AICCS实例ID。可在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)>实例管理中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-****',
- ],
- ],
- [
- 'name' => 'Acid',
- 'in' => 'query',
- 'schema' => [
- 'description' => '会话ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1001067****',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => '实例ID。'."\n"
+ ."\n"
+ .'请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**实例管理**中查看实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'RecordType',
+ 'name' => 'AccountName',
'in' => 'query',
- 'schema' => [
- 'description' => '呼叫类型。取值：'."\n"
- ."\n"
- .'- **DUP_CALL**：双呼。'."\n"
- .'- **IVR_CALL**：IVR外呼。'."\n"
- .'- **SMART_CALL**：智能外呼。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DUP_CALL',
- 'enum' => [
- 'DUP_CALL',
- 'IVR_CALL',
- 'SMART_CALL',
- ],
- ],
+ 'schema' => ['title' => '账号名', 'description' => '坐席账号名称。实例内唯一（登录名）。', 'type' => 'string', 'required' => true, 'example' => '123@****.com'],
],
],
'responses' => [
@@ -13301,59 +7289,37 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Data' => [
- 'description' => '数据列表。',
- 'type' => 'object',
- 'properties' => [
- 'Acid' => [
- 'title' => '会话id',
- 'description' => '会话ID。',
- 'type' => 'string',
- 'example' => '1001067****',
- ],
- 'OssLink' => [
- 'title' => '录音链接',
- 'description' => '录音链接。',
- 'type' => 'string',
- 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***',
- ],
- ],
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => ['title' => '数据结果', 'description' => '热线运行信息。', 'type' => 'object', '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":"坐席签出状态"}'],
+ 'Code' => ['title' => '错误码', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '接口调用是否成功', 'description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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' => '获取语音双呼录音链接',
- ],
- 'DescribeRecordData' => [
- 'methods' => [
- 'post',
- 'get',
+ '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' => '查询热线运行信息',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-08T02:35:54.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineRuntimeInfo'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetHotlineServiceStatistics' => [
+ 'summary' => '获取热线监控下服务统计量。支持实例、时间纬度、坐席、部门、技能组分组查询。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -13361,139 +7327,257 @@
],
'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' => '产品名称。默认取值：**aiccs**。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aiccs',
- 'default' => 'aiccs',
- ],
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'AccountType',
+ 'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'description' => '帐户类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'BUC_TYPE',
- ],
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
],
[
- 'name' => 'AccountId',
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
+ ],
+ [
+ 'name' => 'PageSize',
'in' => 'query',
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'AgentIds',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '帐户ID。',
- 'type' => 'string',
+ 'title' => '坐席id列表',
+ 'description' => '坐席ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '坐席ID。'."\n"
+ ."\n"
+ .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
'required' => false,
- 'example' => '2235****',
],
],
[
- 'name' => 'Acid',
+ 'name' => 'DepIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '会话ID。',
- 'type' => 'string',
+ 'title' => '部门id列表',
+ 'description' => '部门ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
'required' => false,
- 'example' => '1004849****',
],
],
[
- 'name' => 'SecLevel',
+ 'name' => 'GroupIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '录音脱敏等级。取值范围：**1-4**。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '技能组id列表',
+ 'description' => '技能组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '技能组ID。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
'required' => false,
- 'example' => '2',
],
],
+ [
+ 'name' => 'TimeLatitudeType',
+ 'in' => 'query',
+ 'schema' => ['title' => '时间纬度类型', 'description' => '时间纬度类型分组查询。取值：'."\n"
+ .'- **minute**：分钟。'."\n"
+ .'- **hour**：小时。', 'type' => 'string', 'required' => false, 'example' => 'minute'],
+ ],
+ [
+ 'name' => 'ExistAgentGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据坐席分组', 'description' => '是否根据坐席分组查询。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'ExistDepartmentGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'ExistSkillGroupGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Acid' => [
- 'description' => '会话ID。',
- 'type' => 'string',
- 'example' => '1004849****',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'OssLink' => [
- 'description' => '录音文件链接。',
- 'type' => 'string',
- 'example' => 'https://****',
- ],
- 'AgentId' => [
- 'description' => '坐席ID。',
- 'type' => 'string',
- 'example' => '1212****',
- ],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', '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' => '信息为List<Map>类型的JSON字符串。', '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}'],
+ ],
],
+ 'Code' => ['title' => '错误编码', 'description' => '状态编码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'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' => '[{"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' => '获取热线监控下服务统计量',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
+ .'- 若您需要填写坐席、部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
+ ."\n"
+ .' n_idle_now：当前空闲坐席数'."\n"
+ .' n_resttype_now：当前小休坐席数'."\n"
+ .' n_resttype1_now：当前普通小休坐席数'."\n"
+ .' n_resttype2_now：当前就餐小休坐席数'."\n"
+ .' n_resttype3_now：当前会议小休坐席数'."\n"
+ .' n_resttype4_now：当前辅导小休坐席数'."\n"
+ .' n_resttype5_now：当前培训小休坐席数'."\n"
+ .' n_resttype98_now：当前强制小休坐席数'."\n"
+ .' n_resttype99_now：当前签入小休坐席数'."\n"
+ .' n_ack_now：当前后处理坐席数'."\n"
+ .' n_online_now：当前在线坐席数'."\n"
+ .' n_busy_now：通话坐席数'."\n"
+ .' group_name：技能组名称'."\n"
+ .' group_id：技能组ID'."\n"
+ .' department_id：部门ID'."\n"
+ .' department_name：部门名称'."\n"
+ .' date_id：日期'."\n"
+ .' tenant_id：租户ID'."\n"
+ .' tenant_name：租户名称'."\n"
+ .' '."\n"
+ .' '."\n"
+ .' ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineServiceStatistics'],
+ ],
],
- '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' => '获取通话记录',
- 'summary' => '调用DescribeRecordData接口获取通话信息。',
+ 'ramActions' => [],
],
- 'GetIndexCurrentValue' => [
- 'methods' => [
- 'post',
- 'get',
+ 'GetHotlineWaitingNumber' => [
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => ' '."\n"
+ .'客户请求唯一id，用于幂等校验，可以用uuid生成', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['description' => ' '."\n"
+ .'AICCS实例ID，在智能联络中心控制台上可以看到', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
+ ],
+ [
+ 'name' => 'AccountName',
+ 'in' => 'query',
+ 'schema' => ['description' => ' '."\n"
+ .'坐席账号名称（坐席登录名）', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => ' '."\n"
+ .'result',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => '错误描述', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID，用于跟踪错误原因', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Data' => ['description' => '热线会员排队数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ 'Code' => ['description' => '错误编码', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => ' '."\n"
+ .'接口调用是否成功', 'type' => 'string', 'example' => 'true'],
+ ],
+ ],
+ ],
],
+ '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' => '[{"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":""}]',
+ 'title' => '查看当前坐席所在技能组热线排队数量',
+ 'summary' => '获取热线会员排队数。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ ],
+ 'GetIndexCurrentValue' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -13501,56 +7585,35 @@
],
'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',
'in' => 'query',
- 'schema' => [
- 'description' => '部门ID列表。多个ID以半角逗号（,）分隔。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](~~2717975~~)接口，查看返回参数的**DepartmentId**，即部门ID。'."\n"
- ."\n"
- .'> 当该参数不为空时：'."\n"
- .'> - 若GroupIds不为空，则优先以GroupIds参数对应技能组列表查询。'."\n"
- .'> - 若GroupIds为空，则优先以该参数对应部门列表查询。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2332****,2334****',
- ],
+ 'schema' => ['description' => '部门ID列表。多个ID以半角逗号（,）分隔。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](~~2717975~~)接口，查看返回参数的**DepartmentId**，即部门ID。'."\n"
+ ."\n"
+ .'> 当该参数不为空时：'."\n"
+ .'> - 若GroupIds不为空，则优先以GroupIds参数对应技能组列表查询。'."\n"
+ .'> - 若GroupIds为空，则优先以该参数对应部门列表查询。', 'type' => 'string', 'required' => false, 'example' => '2332****,2334****'],
],
[
'name' => 'GroupIds',
'in' => 'query',
- 'schema' => [
- 'description' => '技能组ID列表。多个ID以半角逗号（,）分隔。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](~~2717970~~)接口，查看返回参数的**SkillGroupId**，即技能组ID。'."\n"
- ."\n"
- .'> 当该参数不为空时，优先以参数对应技能组列表查询。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2323****,2324****',
- ],
+ 'schema' => ['description' => '技能组ID列表。多个ID以半角逗号（,）分隔。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](~~2717970~~)接口，查看返回参数的**SkillGroupId**，即技能组ID。'."\n"
+ ."\n"
+ .'> 当该参数不为空时，优先以参数对应技能组列表查询。', 'type' => 'string', 'required' => false, 'example' => '2323****,2324****'],
],
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。'."\n"
- ."\n"
- .'> AICCS实例ID必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。'."\n"
+ ."\n"
+ .'> AICCS实例ID必填。', 'type' => 'string', 'required' => false, 'example' => 'ccc_xp_pre-cn-***'],
],
],
'responses' => [
@@ -13559,52 +7622,27 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
'Data' => [
'description' => '数据列表。',
'type' => 'array',
- 'items' => [
- 'description' => '存放键值对数据列表。',
- 'type' => 'object',
- 'example' => '[{"indexName":"hotlineRateRateSati","canAcc":"true","indexValue":"100%","indexNameShow":"hotlineRateRateSati","desc":"热线即时满意度（当天收到的满意评价数 / 参评数）"}]',
- ],
- ],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'items' => ['description' => '存放键值对数据列表。', 'type' => 'object', 'example' => '[{"indexName":"hotlineRateRateSati","canAcc":"true","indexValue":"100%","indexNameShow":"hotlineRateRateSati","desc":"热线即时满意度（当天收到的满意评价数 / 参评数）"}]'],
],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '[{"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' => '获取当前数据统计指标',
'summary' => '获取当前数据统计指标（实时数据），支持实例ID、部门、技能组分组查询。',
@@ -13666,16 +7704,17 @@
.'| OUTCALL ACW | 呼出平均后处理时长 | '."\n"
.'| hotline_rate_value_data | 呼即时问卷满意度 | '."\n"
.'| hotline_rate_accumulate_data | 参评量 | ',
- ],
- 'GetAgentIndexRealTime' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'GetInstanceList' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -13683,212 +7722,71 @@
],
'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' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'default' => '1', 'description' => ''],
],
[
'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '200',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '10',
- ],
- ],
- [
- 'name' => 'CurrentPage',
- 'in' => 'query',
- 'schema' => [
- 'description' => '当前页。取值大于**0**，默认值：**1**。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
- ],
- [
- 'name' => 'DepIds',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '部门ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](~~2717975~~)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '20', 'description' => ''],
],
[
- 'name' => 'GroupIds',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '技能组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](~~2717970~~)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
+ 'name' => 'Name',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- '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' => '客服ID',
- ],
- ],
- ],
- ],
- 'Page' => [
- 'description' => '当前页数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Rows' => [
- 'description' => '返回数据结果。',
- 'type' => 'array',
- 'items' => [
- 'description' => '查询结果数据。',
- 'type' => 'object',
- ],
+ 'TotalCount' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ 'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ 'CommodityInstances' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'InstanceId' => ['type' => 'string', 'description' => ''],
+ 'Name' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
+ 'description' => '',
],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'boolean', 'description' => ''],
],
+ 'description' => '',
],
],
],
'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"}]',
- 'title' => '获取热线坐席实时数据详情',
- 'summary' => '根据实例、部门、技能组分组获取坐席详情实时数据（实时数据）。',
- 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
- .'- 若您需要填写部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：10次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ '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\\": true\\n}","type":"json"}]',
],
- 'GetHotlineAgentDetailReport' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetMcuLvsIp' => [
+ 'summary' => '调用GetMcuLvsIp查询热线服务器IP。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -13896,256 +7794,114 @@
],
'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' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre***'],
],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '10',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => 'error message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'Data' => ['title' => 'result data', 'description' => 'IP信息。格式为List类型的JSON字符串。', 'type' => 'string', 'example' => '{ "xmculvs":[ 0:{ "port":00 "ip":"0.0.0.0" "name":"lvs1" } ]}'],
+ 'Code' => ['title' => 'error code', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => 'success', 'description' => '调用接口是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
+ ],
+ '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' => '查询热线服务器IP',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMcuLvsIp'],
+ ],
+ ],
+ 'ramActions' => [],
+ ],
+ 'GetNumLocation' => [
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'StartDate',
- 'in' => 'query',
- 'schema' => [
- 'description' => '开始日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'minimum' => '1',
- 'example' => '1614824872',
- ],
+ 'AK' => [],
],
[
- 'name' => 'EndDate',
- 'in' => 'query',
- 'schema' => [
- 'description' => '结束日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'minimum' => '1',
- 'example' => '1614824972',
- ],
+ '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' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
- 'name' => 'DepIds',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '部门ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](~~2717975~~)接口，查看返回参数的**DepartmentId**，即部门ID。'."\n"
- ."\n"
- .'> 当该参数不为空时：'."\n"
- .'> - 若GroupIds不为空，则优先以GroupIds参数对应技能组列表查询。'."\n"
- .'> - 若GroupIds为空，则优先以该参数对应部门列表查询。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '5623***',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'GroupIds',
+ 'name' => 'PhoneNum',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '技能组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](~~2717970~~)接口，查看返回参数的**SkillGroupId**，即技能组ID。'."\n"
- ."\n"
- .'> 当该参数不为空时，优先以参数对应技能组列表查询。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1232****',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
+ 'schema' => ['description' => '需要查询的电话号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1360987****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Data' => [
- 'description' => '查询结果数据。',
- 'type' => 'object',
- 'properties' => [
- 'PageSize' => [
- 'description' => '每页的数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'description' => '总共记录数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '7',
- ],
- 'Columns' => [
- 'description' => '返回列描述。',
- 'type' => 'array',
- 'items' => [
- 'description' => '指标数据。',
- 'type' => 'object',
- 'properties' => [
- 'Title' => [
- 'description' => '指标说明。',
- 'type' => 'string',
- 'example' => '客服姓名',
- ],
- 'Key' => [
- 'description' => '指标。',
- 'type' => 'string',
- 'example' => 'realName',
- ],
- ],
- ],
- ],
- 'Page' => [
- 'description' => '当前页。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Rows' => [
- 'description' => '返回数据结果。',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- '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%"}]',
- ],
- ],
- ],
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Data' => ['description' => '号码归属地。', 'type' => 'string', 'example' => '杭州'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '获取热线坐席维度（T+1）数据详情',
- 'summary' => '获取热线坐席维度（T+1）数据详情。支持实例、时间区间、部门、技能组分组查询。',
- 'description' => '- 调用此接口前，请确保您已[开通服务](~~276009~~)，并[创建实例](~~276011~~)。'."\n"
- .'- 若您需要填写部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- ."\n\n"
- .'> 查询逻辑优先级：'."\n"
- .'> - 若GroupIds不为空，则查询对应技能组列表下数据指标。'."\n"
- .'> - 否则，若DepIds不为空，则查询对应技能组分组下数据指标。'."\n"
- .'> - 否则，查询AICCS实例下数据指标。'."\n"
- ."\n\n"
- .'### QPS限制'."\n"
+ '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' => '获取号码归属地',
+ 'summary' => '根据实例ID、电话号码获取该号码的归属地信息。',
+ 'description' => '### QPS限制'."\n"
.'- 单用户调用频率：不限流。'."\n"
- .'- API频率：10次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GetHotlineGroupDetailReport' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'GetOnlineSeatInformation' => [
+ 'summary' => '获取在线监控下在线坐席信息数据。支持实例、时间区间、坐席、部门分组查询。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -14153,951 +7909,422 @@
],
'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' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '10',
- ],
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
],
[
- 'name' => 'StartDate',
+ 'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'description' => '开始日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'minimum' => '1',
- 'example' => '1614824872',
- 'default' => '',
- ],
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
],
[
- 'name' => 'EndDate',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '结束日期时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'minimum' => '1',
- 'example' => '1614824972',
- ],
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'DepIds',
+ 'name' => 'AgentIds',
'in' => 'query',
- 'style' => 'repeatList',
+ 'style' => 'simple',
'schema' => [
- 'description' => '部门ID列表。',
+ 'title' => '坐席id列表',
+ 'description' => '坐席ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '部门ID。'."\n"
- ."\n"
- .'可调用[GetAllDepartment](~~2717975~~)接口，查看返回参数的**DepartmentId**，即部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '56****',
- ],
+ 'items' => ['description' => '坐席ID。'."\n"
+ ."\n"
+ .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
'required' => false,
- 'maxItems' => 200,
],
],
[
- 'name' => 'GroupIds',
+ 'name' => 'DepIds',
'in' => 'query',
- 'style' => 'repeatList',
+ 'style' => 'simple',
'schema' => [
- 'description' => '技能组ID列表。',
+ 'title' => '部门id列表',
+ 'description' => '部门ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。'."\n"
- ."\n"
- .'可调用[QuerySkillGroups](~~2717970~~)接口，查看返回参数的**SkillGroupId**，即技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
'required' => false,
- 'maxItems' => 200,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误描述', 'description' => '状态码描述。 ', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '查询结果数据。',
+ 'title' => 'data',
+ 'description' => '数据列表。',
'type' => 'object',
'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' => ['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' => '信息为List<Map>类型的JSON字符串。', 'type' => 'string', '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****"}'],
],
],
- 'Code' => [
- 'description' => '状态吗。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'string',
- 'example' => 'Public',
- ],
+ 'Code' => ['title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。'."\n", 'type' => 'string', 'example' => 'true'],
],
],
],
],
- '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"}]',
- 'title' => '获取热线技能组维度T+1数据详情',
- 'summary' => '获取热线技能组维度（T+1）数据详情。支持实例、时间区间、部门、技能组分组获取。',
- 'description' => '- 调用此接口前，请确保您已[开通服务](~~276009~~)，并[创建实例](~~276011~~)。'."\n"
- .'- 若您需要填写坐席、部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ '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' => '获取在线监控下在线坐席信息数据',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
+ .'- 若您需要填写坐席、部门信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：10次/秒。'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'QueryTouchList' => [
- 'methods' => [
- 'post',
- 'get',
+ 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
+ ."\n"
+ .' department_id：部门ID'."\n"
+ .' tenant_id：租户ID'."\n"
+ .' tenant_name：租户名称'."\n"
+ .' current_service_num：当前服务能力'."\n"
+ .' max_service_num：最大服务能力'."\n"
+ .' max_speci_ability_num：鲸吞加1，当前的最大使用能力'."\n"
+ .' current_speci_ability_num：鲸吞加1，当前的已经使用能力'."\n"
+ .' speci_ability_status：鲸吞加1。当前的状态，n0：暂停分配状态，n1：可分配状态'."\n"
+ .' servicer_status_name：热线坐席名称'."\n"
+ .' fst_login_time：当天最早的登录时间'."\n"
+ .' lst_login_time：当天最晚的登录时间'."\n"
+ .' servicer_rest_cnt：小休次数 ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOnlineSeatInformation'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetOnlineServiceVolume' => [
+ 'summary' => '获取在线监控下在线服务量。支持实例、时间区间、坐席、部门、技能组分组查询。',
+ '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' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'in' => 'query',
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'TouchId',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '要精确查询的接触ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '接触ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10****',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
+ 'name' => 'StartDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
],
[
- 'name' => 'ChannelId',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '要精确查询的会话ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '会话ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '846a7a4aa2524186b899a6ba02****',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
],
[
- 'name' => 'ChannelType',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '渠道类型。',
- 'type' => 'array',
- 'items' => [
- 'description' => '渠道类型。取值：'."\n"
- .'- **1**：热线。'."\n"
- .'- **2**：在线。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'required' => false,
- 'maxItems' => 10,
- 'enum' => [
- '1',
- '2',
- ],
- ],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'TouchType',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '接触类型。',
- 'type' => 'array',
- 'items' => [
- 'description' => '接触类型。取值：'."\n"
- .'- **1**：主动接触（外呼）。'."\n"
- .'- **2**：被动接触（咨询）。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- 'required' => false,
- 'maxItems' => 10,
- 'enum' => [
- '1',
- '2',
- ],
- ],
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'MemberId',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ 'name' => 'AgentIds',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '要查询的会员ID列表。',
+ 'title' => '坐席id列表',
+ 'description' => '坐席ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '会员ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1000',
- ],
+ 'items' => ['description' => '坐席ID。'."\n"
+ ."\n"
+ .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
'required' => false,
- 'maxItems' => 200,
],
],
[
- 'name' => 'MemberName',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ 'name' => 'DepIds',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '要查询的会员名称列表。',
+ 'title' => '部门id列表',
+ 'description' => '部门ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '会员名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'zhangsan',
- ],
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
'required' => false,
- 'maxItems' => 200,
],
],
[
- 'name' => 'ServicerId',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ 'name' => 'GroupIds',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '要查询的客服ID列表。',
+ 'title' => '技能组id列表',
+ 'description' => '技能组ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '客服ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '70020',
- ],
+ 'items' => ['description' => '技能组ID。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
'required' => false,
- 'maxItems' => 200,
],
],
[
- 'name' => 'ServicerName',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '要查询的客服名称列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '客服名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'lisi',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
+ 'name' => 'TimeLatitudeType',
+ 'in' => 'query',
+ 'schema' => ['title' => '时间纬度类型', 'description' => '时间纬度类型。取值：'."\n"
+ .'- **minute**：分钟。'."\n"
+ .'- **hour**：小时。'."\n"
+ .'- **day**：天。', 'type' => 'string', 'required' => false, 'example' => 'minute'],
],
[
- 'name' => 'QueueId',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '进线技能组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '进线技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10000',
- ],
- 'required' => false,
- 'maxItems' => 200,
- ],
+ 'name' => 'ExistAgentGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据坐席分组', 'description' => '是否根据坐席分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'EvaluationStatus',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '评价状态。',
- 'type' => 'array',
- 'items' => [
- 'description' => '评价状态。取值：'."\n"
- .'- **-1**：未发起评价。'."\n"
- .'- **0**：未评价。'."\n"
- .'- **1**：已评价。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'required' => false,
- 'maxItems' => 10,
- 'enum' => [
- '-1',
- '0',
- '1',
- ],
- ],
+ 'name' => 'ExistDepartmentGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'EvaluationLevel',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '满意度等级。',
- 'type' => 'array',
- 'items' => [
- 'description' => '满意度等级。取值：'."\n"
- .'- **2**：二级满意度。'."\n"
- .'- **3**：三级满意度。'."\n"
- .'- **4**：四级满意度。'."\n"
- .'- **5**：五级满意度。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5',
- ],
- 'required' => false,
- 'maxItems' => 10,
- 'enum' => [
- '2',
- '3',
- '4',
- '5',
- ],
- ],
+ 'name' => 'ExistSkillGroupGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
- [
- 'name' => 'EvaluationScore',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '满意度评分。',
- 'type' => 'array',
- 'items' => [
- 'description' => '满意度评分。取值：'."\n"
- .'- **1**：很不满。'."\n"
- .'- **2**：不满。'."\n"
- .'- **3**：一般。'."\n"
- .'- **4**：满意。'."\n"
- .'- **5**：很满意。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5',
- ],
- 'required' => false,
- 'maxItems' => 10,
- 'enum' => [
- '1',
- '2',
- '3',
- '4',
- '5',
+ 'description' => '服务数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ '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' => '信息为List<Map>类型的JSON字符串。', 'type' => 'string', '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}'],
+ ],
+ ],
+ 'Code' => ['title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
- [
- 'name' => 'FirstTimeStart',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '会话开始的时间范围左区间。时间戳格式（单位：毫秒）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1614596400000',
- ],
+ ],
+ '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' => '获取在线监控下在线服务量',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
+ .'- 若您需要填写坐席、部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
+ .' '."\n"
+ .' online_direct_request_cnt：直连请求量'."\n"
+ .' online_transfer_request_cnt：转交请求量（转交代表是别人转交给该小二的）'."\n"
+ .' online_direct_giveup_cnt：直连放弃量'."\n"
+ .' online_transfer_giveup_cnt：转交放弃量'."\n"
+ .' online_direct_ready_cnt：直连接起量'."\n"
+ .' online_transfer_ready_cnt：转交接起量'."\n"
+ .' online_10s_direct_ready_cnt：直连10s接起量'."\n"
+ .' online_10s_transfer_ready_cnt：转交10s接起量'."\n"
+ .' online_20s_direct_ready_cnt：直连20s接起量'."\n"
+ .' online_20s_transfer_ready_cnt：转交20s接起量'."\n"
+ .' online_30s_direct_ready_cnt：直连30s接起量'."\n"
+ .' online_30s_transfer_ready_cnt：转交30s接起量'."\n"
+ .' online_40s_direct_ready_cnt：直连40s接起量'."\n"
+ .' online_40s_transfer_ready_cnt：转交40s接起量'."\n"
+ .' online_60s_direct_ready_cnt：直连60s接起量'."\n"
+ .' online_60s_transfer_ready_cnt：转交60s接起量'."\n"
+ .' online_over_out_cnt：技能组溢出量'."\n"
+ .' online_over_in_cnt：技能组溢入量'."\n"
+ .' online_sat_cnt：满意数'."\n"
+ .' online_normal_cnt：一般数'."\n"
+ .' online_unsat_cnt：不满意数'."\n"
+ .' service_time_len：总服务时长'."\n"
+ .' wait_time_len：总等待时长',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOnlineServiceVolume'],
],
+ ],
+ 'ramActions' => [],
+ ],
+ 'GetOutbounNumList' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'FirstTimeEnd',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '会话开始的时间范围右区间。时间戳格式（单位：毫秒）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1614599400000',
- ],
+ 'AK' => [],
],
[
- 'name' => 'CloseTimeStart',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '会话结束的时间范围左区间。时间戳格式（单位：毫秒）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1614600400000',
- ],
+ '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' => '会话结束的时间范围右区间。时间戳格式（单位：毫秒）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1614600500000',
- ],
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d****'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'InstanceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '500',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '50',
- ],
+ 'schema' => ['description' => "\n"
+ .'实例ID。'."\n"
+ ."\n"
+ .'请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**实例管理**中查看实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-****'],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'AccountName',
'in' => 'formData',
- 'schema' => [
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '坐席账号名称（坐席登录名）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@****.com'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'ResultData' => [
- 'description' => '数据结果。',
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Data' => [
+ 'description' => '号码列表信息。',
'type' => 'object',
'properties' => [
- 'Empty' => [
- 'description' => '是否为空。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'OnePageSize' => [
- 'description' => '页大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'TotalPage' => [
- 'description' => '总页数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'CurrentPage' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PreviousPage' => [
- 'description' => '上一页页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'TotalResults' => [
- 'description' => '查询总量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'Data' => [
- 'description' => '数据。',
+ 'Num' => [
+ 'description' => '主叫号码信息。',
'type' => 'array',
'items' => [
- 'description' => '返回数据。',
+ 'description' => '主叫号码信息。',
'type' => 'object',
'properties' => [
- 'ParentTouchId' => [
- 'description' => '父接触ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'DepId' => [
- 'description' => '部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'GmtModified' => [
- 'description' => '更新时间。时间戳格式（单位：毫秒）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1611207979000',
- ],
- 'UserTouchId' => [
- 'description' => '用户接触ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1386****',
- ],
- 'CommonQueueName' => [
- 'description' => '技能组名称。',
- 'type' => 'string',
- 'example' => '测试1',
- ],
- 'ChannelId' => [
- 'description' => '会话ID。',
- 'type' => 'string',
- 'example' => '4f8807a9de024507a3090b5b66a8****',
- ],
- 'TouchId' => [
- 'description' => '接触ID。',
- 'type' => 'string',
- 'example' => '1386****',
- ],
- 'MemberId' => [
- 'description' => '会员ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '6400665****',
- ],
- 'ServicerName' => [
- 'description' => '客服名称。',
- 'type' => 'string',
- 'example' => '1390000****',
- ],
- 'Feedback' => [
- 'description' => '反馈。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'TouchType' => [
- 'description' => '接触类型。取值：'."\n"
- .'- **1**：主动接触。'."\n"
- .'- **2**：被动接触。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Status' => [
- 'description' => '接触状态。取值：'."\n"
- .'- **1**：已进线。'."\n"
- .'- **2**：小二已接入。'."\n"
- .'- **3**：通话中。'."\n"
- .'- **4**：已结束。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'SwitchUser' => [
- 'description' => '转交列表。',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'FirstTime' => [
- 'description' => '会话接起时间。时间戳格式（单位：毫秒）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1611209971000',
- ],
- 'FromId' => [
- 'description' => '会话发起者。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '6400665****',
- ],
- 'QueueId' => [
- 'description' => '技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '111',
- ],
- 'ExtAttrsString' => [
- 'description' => '大字段。',
- 'type' => 'object',
- ],
- 'TouchTime' => [
- 'description' => '会话时长（单位：秒）。',
- 'type' => 'string',
- 'example' => '111',
- ],
- 'ToId' => [
- 'description' => '会话接受者。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '67****',
- ],
- 'BuId' => [
- 'description' => '租户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '905',
- ],
- 'GmtCreate' => [
- 'description' => '创建时间。时间戳格式（单位：毫秒）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1611209971000',
- ],
- 'CloseTime' => [
- 'description' => '会话结束时间。时间戳格式（单位：毫秒）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1611207976000',
- ],
- 'ExtAttrs' => [
- 'description' => '扩展字段。',
- 'type' => 'object',
- 'properties' => [
- 'EvaluationScore' => [
- 'description' => '满意度评分。取值：'."\n"
- .'- **1**：很不满。'."\n"
- .'- **2**：不满。'."\n"
- .'- **3**：一般。'."\n"
- .'- **4**：满意。'."\n"
- .'- **5**：很满意。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'OnlineJoinRespInterval' => [
- 'description' => '首次响应时长（单位：秒）。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Dnis' => [
- 'description' => '外呼为被叫号码，入呼为被叫号码。',
- 'type' => 'string',
- 'example' => '05712688****',
- ],
- 'OnlineSessionSource' => [
- 'description' => '线上会话源。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'EvaluationStatus' => [
- 'description' => '评价状态。取值：'."\n"
- .'- **-1**：未发起评价。'."\n"
- .'- **0**：未评价。'."\n"
- .'- **1**：已评价。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'EvaluationLevel' => [
- 'description' => '满意度等级。取值：'."\n"
- .'- **2**：二级满意度。'."\n"
- .'- **3**：三级满意度。'."\n"
- .'- **4**：四级满意度。'."\n"
- .'- **5**：五级满意度。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'OutCallRouteNumber' => [
- 'description' => '外呼为主叫号码。',
- 'type' => 'string',
- 'example' => '05712688****',
- ],
- 'Ani' => [
- 'description' => '入呼为主叫号码。',
- 'type' => 'string',
- 'example' => '187****0000',
- ],
- 'EvaluationSolution' => [
- 'description' => '评估解决方案。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
- ],
- 'TouchEndReason' => [
- 'description' => '结束原因。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'MemberName' => [
- 'description' => '会员名称。',
- 'type' => 'string',
- 'example' => '访客',
- ],
- 'ServicerId' => [
- 'description' => '客服ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '67****',
- ],
- 'ChannelType' => [
- 'description' => '接触渠道。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TouchContent' => [
- 'description' => '会话结束原因。取值：'."\n"
- .'- **0**：未知。'."\n"
- .'- **1**：接触未成功。'."\n"
- .'- **2**：客户终止。'."\n"
- .'- **3**：坐席终止。'."\n"
- .'- **4**：通话异常中断。'."\n"
- .'- **5**：转交终止。'."\n"
- .'- **6**：系统终止。',
- 'type' => 'string',
- 'example' => '1',
- ],
+ 'Type' => ['description' => '主叫号码类型。取值：'."\n"
+ ."\n"
+ .'- **1**：号码。'."\n"
+ .'- **2**：号码组。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Description' => ['description' => '主叫号码描述（归属地信息）。', 'type' => 'string', 'example' => '浙江省杭州市'],
+ 'Value' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '07512234****'],
],
],
],
- 'NextPage' => [
- 'description' => '下一页页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
+ 'NumGroup' => [
+ 'description' => '号码组信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '号码组信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => '号码组类型。取值：'."\n"
+ ."\n"
+ .'- **1**：号码。'."\n"
+ .'- **2**：号码组。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'Description' => ['description' => '号码组描述（号码组名称）。', 'type' => 'string', 'example' => 'Jella'],
+ 'Value' => ['description' => '号码组ID。', 'type' => 'string', 'example' => '7688****'],
+ ],
+ ],
],
],
],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '865658FD-80DE-5D49-ABEB-F3CC9863F4F1',
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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',
- ],
- '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":""}]',
- 'title' => '查询接触数据',
- 'summary' => '根据实例、接触ID列表、会话ID列表等查询接触数据。',
- 'description' => '此接口可查询接触状态、会话接受者、客服名称、接触渠道、满意度评分、评价状态等接触数据，详情可查看[返回参数](#api-detail-40)。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：50次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GetCustomerInfo' => [
- 'summary' => '调用GetCustomerInfo接口根据工作台会员ID获取会员详情。',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '获取外呼号码列表',
+ 'summary' => '获取外部热线号码列表。',
+ 'changeSet' => [
+ ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'GetQualityProjectDetail' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -15105,734 +8332,448 @@
],
'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' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => '租户实例ID', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre***'],
],
[
- 'name' => 'MemberId',
+ 'name' => 'ProjectId',
'in' => 'query',
- 'schema' => [
- 'title' => '会员ID',
- 'description' => '会员ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'maximum' => '9223372036854775807',
- 'exclusiveMaximum' => true,
- 'minimum' => '1',
- 'example' => '82345678****',
- ],
+ 'schema' => ['title' => '质检任务ID', 'description' => '质检任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '15977801'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'DF6A3FB7-A5AA-43BE-A65B',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Message' => ['title' => 'Message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['title' => 'RequestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
'Data' => [
- 'title' => '会员信息',
- 'description' => '会员信息。',
+ 'title' => 'Data',
+ 'description' => '质检任务信息。',
'type' => 'object',
'properties' => [
- 'OuterId' => [
- 'title' => '外部ID',
- 'description' => '外部ID。',
- 'type' => 'string',
- 'example' => '6666666',
- ],
- 'Nick' => [
- 'title' => '昵称',
- 'description' => '昵称。',
- 'type' => 'string',
- 'example' => '测试会员',
- ],
- 'UserId' => [
- 'title' => '会员ID',
- 'description' => '会员ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '823456789023',
+ 'Status' => ['title' => '质检任务状态', 'description' => '质检任务状态。取值：'."\n"
+ ."\n"
+ .'- **0**：启动'."\n"
+ .'- **1**：关闭', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ServicerList' => [
+ 'title' => '坐席列表',
+ 'description' => '质检抽样范围。',
+ 'type' => 'array',
+ 'items' => ['description' => '质检抽样范围：客服登录名。', 'type' => 'integer', 'format' => 'int64', 'example' => '0:55555'],
],
- 'CustomizeFields' => [
- 'title' => '自定义字段',
- 'description' => '自定义字段。',
- 'type' => 'object',
+ 'ModifyTime' => ['title' => '修改时间', 'description' => '修改时间。', 'type' => 'string', 'example' => '2021-04-07 18:07:19'],
+ 'QualityType' => ['title' => '质检类型', 'description' => '质检类型 。固定取值为**1**（咨询类）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'DepList' => [
+ 'title' => '技能组分组',
+ 'description' => '质检抽样范围。',
+ 'type' => 'array',
+ 'items' => ['description' => '部门列表：部门列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '0:10'],
],
- 'Photo' => [
- 'title' => '头像',
- 'description' => '头像。',
- 'type' => 'string',
- 'example' => 'https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLSW7XPFlJDwVunXP8pr84TvltwtLlNqTlOVSFeM3bCgn57mAB4JuZZmvMW0qicqW0PyzyUdZpxiaFQ',
+ 'GroupList' => [
+ 'title' => '技能组列表',
+ 'description' => '质检抽样范围。',
+ 'type' => 'array',
+ 'items' => ['description' => '质检抽样范围：技能组列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '0:123456'],
],
- 'RealName' => [
- 'title' => '真实姓名',
- 'description' => '真实姓名。',
- 'type' => 'string',
- 'example' => '刘测试',
+ 'ProjectName' => ['title' => '质检任务名称', 'description' => '质检任务名称', 'type' => 'string', 'example' => '自动化质检任务'],
+ 'Version' => ['title' => 'Version', 'description' => '质检任务版本号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-04-07 18:07:18'],
+ 'Id' => ['title' => '质检任务ID', 'description' => '质检任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '15977801'],
+ 'QualityRuleIds' => [
+ 'title' => '质检规则ID',
+ 'description' => '质检项规则ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '质检规则数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '5369'],
],
+ 'CheckFreqType' => ['title' => '质检周期', 'description' => '检查频次类型。取值：'."\n"
+ ."\n"
+ .'- **1**：周期质检'."\n"
+ .'- **4**：临时质检', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '是否请求成功',
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => 'Code', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => 'Success', 'description' => '接口调用是否成功。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'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\\": \\"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' => '获取会员信息',
- ],
- 'GetHotlineMessageLog' => [
- 'summary' => '调用GetHotlineMessageLog接口获取热线消息记录。',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '获取质检任务详情',
+ 'summary' => '调用GetQualityProjectDetail获取质检任务详情。',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:00.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2021-05-13T16:12:41.000Z', 'description' => 'OpenAPI 下线'],
],
- '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' => [
- 'title' => '实例id',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre***'],
],
[
- 'name' => 'Acid',
+ 'name' => 'ProjectId',
'in' => 'query',
- 'schema' => [
- 'title' => '会话id',
- 'description' => '会话ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '100****2077',
- ],
+ 'schema' => ['title' => '质检项ID', 'description' => '质检任务ID（支持模糊搜索）。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '15', 'default' => '1'],
+ ],
+ [
+ 'name' => 'ProjectName',
+ 'in' => 'query',
+ 'schema' => ['title' => '质检项名称', 'description' => '质检任务名（支持模糊搜索）。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '质检'],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['title' => '质检项状态', 'description' => '质检任务状态。取值：'."\n"
+ ."\n"
+ .'- **0**：启动'."\n"
+ .'- **1**：关闭'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '0'],
+ ],
+ [
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['title' => 'PageNo', 'description' => '当前页。默认为：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => 'PageSize', 'description' => '每页大小。默认为：**10**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10'],
+ ],
+ [
+ 'name' => 'checkFreqType',
+ 'in' => 'query',
+ 'schema' => ['title' => '质检频率', 'description' => '检查频次类型。取值：'."\n"
+ ."\n"
+ .'- **1**：周期质检'."\n"
+ .'- **4**：临时质检', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Rusult',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
+ 'Message' => ['title' => 'Message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['title' => 'RequestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
'Data' => [
- 'description' => '语音信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '语音信息。',
- 'type' => 'object',
- 'properties' => [
- 'Acid' => [
- 'title' => '会话ID',
- 'description' => '会话ID。',
- 'type' => 'string',
- 'example' => '100****2077',
- ],
- 'EndTime' => [
- 'title' => '结束时间',
- 'description' => '结束时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1623738027480',
- ],
- 'Content' => [
- 'title' => '会话内容',
- 'description' => '会话内容。',
- 'type' => 'string',
- 'example' => '您好。',
- ],
- 'SenderType' => [
- 'title' => '发送方类型（1：会员，2：坐席）',
- 'description' => '发送方类型。取值：'."\n"
- .'- **1**：会员'."\n"
- .'- **2**：坐席',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'StartTime' => [
- 'title' => '开始时间',
- 'description' => '开始时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1623738026460',
- ],
- 'Mid' => [
- 'title' => '记录id',
- 'description' => '记录ID。',
- 'type' => 'string',
- 'example' => '11deca999****',
+ 'title' => 'Data',
+ 'description' => '质检任务信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageSize' => ['title' => 'PageSize', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'QualityProjectList' => [
+ 'title' => '质检项列表',
+ 'description' => '质检任务列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '质检任务数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['title' => '质检任务状态', 'description' => '质检任务状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ServicerList' => [
+ 'title' => '坐席列表',
+ 'description' => '质检抽样范围。',
+ 'type' => 'array',
+ 'items' => ['description' => '质检抽样范围：客服登录名。', 'type' => 'integer', 'format' => 'int64', 'example' => '0:555555'],
+ ],
+ 'ModifyTime' => ['title' => '修改时间', 'description' => '修改时间。', 'type' => 'string', 'example' => '2021-04-07 18:07:19'],
+ 'QualityType' => ['title' => '质检任务类型', 'description' => '质检类型 。固定取值为**1**（咨询类）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'DepList' => [
+ 'title' => '技能组分组列表',
+ 'description' => '质检抽样范围。',
+ 'type' => 'array',
+ 'items' => ['description' => '质检抽样范围：部门列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '0:10'],
+ ],
+ 'GroupList' => [
+ 'title' => '技能组列表',
+ 'description' => '质检抽样范围。',
+ 'type' => 'array',
+ 'items' => ['description' => '质检抽样范围：技能组列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '0:123456'],
+ ],
+ 'ProjectName' => ['title' => '质检任务名称', 'description' => '质检任务名称。', 'type' => 'string', 'example' => '自动化质检任务'],
+ 'Version' => ['title' => '版本', 'description' => '质检任务版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'CreateTime' => ['title' => 'CreateTime', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-04-07 18:07:18'],
+ 'Id' => ['title' => '质检任务Id', 'description' => '质检任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '15977801'],
+ 'QualityRuleIds' => [
+ 'title' => '质检规则列表',
+ 'description' => '质检项规则ID。',
+ 'type' => 'array',
+ 'items' => ['description' => '质检规则数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '5369'],
+ ],
+ 'CheckFreqType' => ['title' => '质检任务频率', 'description' => '质检任务频率。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
],
],
+ 'Total' => ['title' => 'Total', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '35'],
+ 'PageNo' => ['title' => 'PageNo', 'description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'title' => '调用是否成功',
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => 'Code', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => 'Success', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '获取热线消息记录',
- ],
- 'GetHotlineCallAction' => [
- 'summary' => '调用GetHotlineCallAction接口查询话务动作结果数据。',
- 'methods' => [
- 'post',
- 'get',
+ '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' => '获取质检任务列表',
+ 'summary' => '调用GetQualityProjectList获取质检任务列表。',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:00.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2021-04-08T12:35:57.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2021-04-08T12:35:57.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- '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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d9****',
- ],
- ],
- [
'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
- ],
- [
- 'name' => 'Act',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '操作类型。取值：'."\n"
- .'- **1**：热线。'."\n"
- .'- **2**：在线。'."\n"
- .'- **3**：工单。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '2147483647',
- 'minimum' => '0',
- 'example' => '1',
- 'default' => '0',
- ],
- ],
- [
- 'name' => 'FromSource',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '来源类型。取值：'."\n"
- ."\n"
- .'- **hotlinebs_out**：热线。'."\n"
- .'- **ticket_out**：工单。'."\n"
- .'- **other_system_out**：其他系统。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'hotlinebs_out',
- ],
- ],
- [
- 'name' => 'Biz',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '业务自定义参数',
- 'description' => '业务自定义参数，格式为JSON。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '{"name":123}',
- ],
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'Acc',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '热线自定义参数',
- 'description' => '热线自定义参数，格式为JSON。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"time":1}',
- ],
+ 'name' => 'ProjectId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => ' '."\n"
- .'result',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE339D98-9BD3-4413-B165',
- ],
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
'Data' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '任务编号。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12345****',
- ],
- 'SubTouchId' => [
- 'description' => '次接触ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3423****',
- ],
- 'MemberList' => [
- 'description' => '会员列表。',
- 'type' => 'string',
- 'example' => '8900****',
- ],
- 'DepId' => [
- 'description' => '部门编号。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1223****',
- ],
- 'CaseId' => [
- 'description' => '工单编号。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1138902****',
- ],
- 'ChannelId' => [
- 'description' => '渠道编号。',
- 'type' => 'string',
- 'example' => '2377****',
- ],
- 'TouchId' => [
- 'description' => '接触ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2235****',
- ],
- 'BuId' => [
- 'description' => '租户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2367****',
- ],
- 'CalloutId' => [
- 'description' => '呼叫编号',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1122****',
- ],
- 'MemberId' => [
- 'description' => '会员ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '7856876****',
- ],
- 'ActionId' => [
- 'description' => '客户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '8999****',
- ],
- 'ServicerName' => [
- 'description' => '客服名称。',
- 'type' => 'string',
- 'example' => 'XX测试',
- ],
- 'CalloutName' => [
- 'description' => '呼叫名称。',
- 'type' => 'string',
- 'example' => '王XX',
- ],
- 'IsTransfer' => [
- 'description' => '是否转移。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'MemberName' => [
- 'description' => '会员名称。',
- 'type' => 'string',
- 'example' => '匿名会员',
- ],
- 'ServicerId' => [
- 'description' => '坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1332****',
- ],
- 'ChannelType' => [
- 'description' => '渠道类型。取值：'."\n"
- ."\n"
- .'- **1**：热线。'."\n"
- .'- **2**：在线。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ActionTime' => ['type' => 'string'],
+ 'ActionType' => ['type' => 'string'],
+ 'ProjectCreateTime' => ['type' => 'string'],
+ 'ProjectId' => ['type' => 'integer', 'format' => 'int64'],
+ 'ActionData' => ['type' => 'string'],
],
],
],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
],
'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":""}]',
- 'title' => '查询话务动作结果数据',
- 'description' => '### QPS限制'."\n"
- .'- 单用户调用频率：50次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ '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\\": true\\n}","type":"json"}]',
],
- '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' => '呼出主叫号码。在语音服务[真实号管理](https://dyvmsnext.console.aliyun.com/number/list/normal)界面查看。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '132****0849',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => ''],
],
[
- 'name' => 'CalledNumber',
+ 'name' => 'PageNo',
'in' => 'query',
- 'schema' => [
- 'description' => '被叫号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '131****2204',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'default' => '', 'description' => ''],
],
[
- 'name' => 'RobotId',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '机器人ID，即话术ID。在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面查看审核通过的话术ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '1000035******',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'description' => ''],
],
[
- 'name' => 'OutId',
+ 'name' => 'TouchStartTime',
'in' => 'query',
- 'schema' => [
- 'description' => '预留给调用方使用的 ID，最终会通过回执消息将此 ID 带回给调用方，长度为 1~15 个字节。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '222356****',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => ''],
],
[
- 'name' => 'RecordFlag',
+ 'name' => 'TouchEndTime',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => ''],
+ ],
+ [
+ 'name' => 'ChannelType',
'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'HitStatus',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'description' => ''],
+ ],
+ [
+ 'name' => 'GroupIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '通话过程是否录音。取值：'."\n"
- ."\n"
- .'- **false**（默认值）：不录音。'."\n"
- .'- **true**：录音。'."\n",
- 'type' => 'boolean',
+ 'type' => 'array',
+ 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'required' => false,
- 'example' => 'true',
+ 'maxItems' => 1,
+ 'description' => '',
],
],
[
- 'name' => 'EarlyMediaAsr',
+ 'name' => 'QualityRuleIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '是否启用号码状态识别标识。取值：'."\n"
- ."\n"
- .'- **false**（默认值）：不启用。'."\n"
- .'- **true**：启用。'."\n"
- .'>启用后会记录通话未接听的原因。',
- 'type' => 'boolean',
+ 'type' => 'array',
+ 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'required' => false,
- 'example' => 'false',
+ 'maxItems' => 1,
+ 'description' => '',
],
],
[
- 'name' => 'Params',
+ 'name' => 'ProjectIds',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '机器人的参数列表。JSON格式。总长度不要超过512个字节。在[话术管理](https://aiccs.console.aliyun.com/patter/list)>**详情**>**输出输入参数**中查看或通过[ListRobotParams](~~2717999~~)接口查看。',
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'required' => false,
- 'example' => '{'."\n"
- .' "name": "张三",'."\n"
- .' "age": "25"'."\n"
- .'}',
+ 'maxItems' => 1,
+ 'description' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D',
- ],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => ''],
'Data' => [
- 'description' => '此次通话的唯一回执ID，即呼叫唯一ID。',
- 'type' => 'string',
- 'example' => '1160128*****^10281427*****',
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalNum' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ 'QualityResultResponseList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupName' => ['type' => 'string', 'description' => ''],
+ 'ProjectName' => ['type' => 'string', 'description' => ''],
+ 'TouchStartTime' => ['type' => 'string', 'description' => ''],
+ 'HitStatus' => ['type' => 'boolean', 'description' => ''],
+ 'RuleId' => ['type' => 'string', 'description' => ''],
+ 'ProjectId' => ['type' => 'string', 'description' => ''],
+ 'TouchId' => ['type' => 'string', 'description' => ''],
+ 'ChannelTypeName' => ['type' => 'string', 'description' => ''],
+ 'GroupId' => ['type' => 'string', 'description' => ''],
+ 'InstanceName' => ['type' => 'string', 'description' => ''],
+ 'ServicerName' => ['type' => 'string', 'description' => ''],
+ 'HitDetail' => ['type' => 'string', 'description' => ''],
+ 'MemberName' => ['type' => 'string', 'description' => ''],
+ 'ServicerId' => ['type' => 'string', 'description' => ''],
+ 'ChannelType' => ['type' => 'string', 'description' => ''],
+ 'RuleName' => ['type' => 'string', 'description' => ''],
+ ],
+ 'description' => '',
+ ],
+ 'description' => '',
+ ],
+ 'PageNo' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ ],
+ 'description' => '',
],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'ChannelTypeName' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'boolean', 'description' => ''],
],
+ 'description' => '',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.',
- 'errorCode' => 'Permission.NotAuthorized',
- ],
- [
- 'errorMessage' => 'Parameter error.',
- 'errorCode' => 'Parameter.Error',
- ],
+ 500 => [
+ ['errorMessage' => 'The specified parameter is invalid.', 'errorCode' => 'InvalidParameter', 'description' => '传入参数不正确'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- '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' => '智能联络机器人呼出',
- 'summary' => '发起智能联络机器人呼出。',
- 'description' => '- 在发起智能联络机器人呼出之前，请先确保您在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面已有审核通过的话术；在语音服务[真实号管理](https://dyvmsnext.console.aliyun.com/number/list/normal)界面已有申请成功的真实号码。'."\n"
- ."\n"
- .'- 呼叫的创建时间可从此接口调用后的**Response Header**中的**date**参数获取。'."\n"
- .'> 例如，**date**参数为："date": "Mon, 24 Jun 2024 03:40:31 GMT"，则呼叫的创建时间为："2024-06-24 03:40:31"。'."\n"
- ."\n\n"
- ."\n\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：1000次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ '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\\": true,\\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\\": true\\n}","type":"json"}]',
],
- 'ListRobotCallDialog' => [
- 'summary' => '查询智能联络机器人通话记录。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetQualityRuleDetail' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -15840,141 +8781,62 @@
],
'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' => 'CallId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '呼叫唯一ID。可调用[RobotCall](~~2717996~~)接口，查看返回参数的**Data**获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12516551****^11195613****',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'CreateTime',
+ 'name' => 'QualityRuleId',
'in' => 'query',
- 'schema' => [
- 'description' => '创建时间。格式：YYYY-MM-DD hh:mm:ss，需要精确到时间。可调用[RobotCall](~~2717996~~)接口，查看调用后的**Response Header**中的**date**参数获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2021-05-20 00:00:00',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
'Data' => [
- 'description' => '对话记录。',
- 'type' => 'array',
- 'items' => [
- 'description' => '对话记录列表。',
- 'type' => 'object',
- 'properties' => [
- 'Role' => [
- 'description' => '对话内容角色。',
- 'type' => 'string',
- 'example' => 'robot',
- ],
- 'Content' => [
- 'description' => '话术内容。',
- 'type' => 'string',
- 'example' => '我是某某的客服，看您之前在我们家找过工作，做个回访，现在工作怎么样？',
- ],
- 'NodeType' => [
- 'description' => '节点类型。',
- 'type' => 'string',
- 'example' => '开场白',
- ],
- 'Time' => [
- 'description' => '开始时间。时间戳格式，单位：毫秒。',
- 'type' => 'string',
- 'example' => '1621483557000',
- ],
- 'Tag' => [
- 'description' => '意图标签。',
- 'type' => 'string',
- 'example' => '拒绝',
- ],
+ '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' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
],
'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 \\"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' => '查询通话记录',
- 'description' => '- 在调用此接口之前，请确保您已使用智能联络机器人发起过呼出任务。'."\n"
- ."\n"
- .'- 若您还没有使用智能联络机器人发起呼出任务，可以调用[RobotCall](~~2717996~~)接口发起呼出任务。'."\n"
- ."\n\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：500次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ '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\\": true\\n}","type":"json"}]',
],
- 'ListAiccsRobot' => [
- 'summary' => '获取机器人话术列表。包含机器人类型、机器人名称、机器人ID、所属业务、行业信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetQualityRuleList' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -15982,132 +8844,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' => 'RobotName',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '机器人名称。在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面查看机器人名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '测试机器人',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
+ ],
+ [
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
'Data' => [
- 'description' => '机器人话术。',
- 'type' => 'array',
- 'items' => [
- 'description' => '话术列表。',
- 'type' => 'object',
- 'properties' => [
- 'RobotType' => [
- 'description' => '机器人类型。',
- 'type' => 'string',
- 'example' => 'CUSTOM',
- ],
- 'AtSence' => [
- 'description' => '所属业务。',
- 'type' => 'string',
- 'example' => '新房销售',
- ],
- 'AtProfession' => [
- 'description' => '所属行业。',
- 'type' => 'string',
- 'example' => '房地产',
- ],
- 'RobotName' => [
- 'description' => '机器人名称。',
- 'type' => 'string',
- 'example' => '测试机器人',
- ],
- 'Id' => [
- 'description' => '机器人ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12****',
+ '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' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
],
'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\\": \\"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' => '获取话术列表',
- 'description' => '- 在调用此接口之前，请确保您已有审核通过的话术。'."\n"
- ."\n"
- .'- 若您没有已审核通过的话术，请先在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面添加话术并提交审核。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：500次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ '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\\": true\\n}","type":"json"}]',
],
- 'ListRobotParams' => [
- 'summary' => '根据机器人ID，即话术ID，查询机器人参数列表。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetQualityRuleTagList' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -16115,129 +8923,54 @@
],
'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' => '机器人ID，即话术ID。在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面查看或通过[ListAiccsRobot](~~2717998~~)接口获取。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '12****',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'FF67D4D5-4E90-1DF5-BB8F-060BBFAD72DB',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
'Data' => [
- 'description' => '参数信息。',
'type' => 'array',
'items' => [
- 'description' => '参数列表。',
'type' => 'object',
'properties' => [
- 'IsEmpty' => [
- 'description' => '是否必填。取值：'."\n"
- ."\n"
- .'- 0：非必填。'."\n"
- ."\n"
- .'- 1：必填。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ParamCode' => [
- 'description' => '参数ID。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'ParamName' => [
- 'description' => '参数名称。',
- 'type' => 'string',
- 'example' => '名称',
- ],
+ 'RuleTagName' => ['type' => 'string'],
+ 'RuleTagId' => ['type' => 'integer', 'format' => 'int64'],
],
],
],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
],
'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' => '查询机器人参数列表',
- 'description' => '- 在调用此接口之前，请确保您已有新增的机器人输入参数。'."\n"
- ."\n"
- .'- 若您的机器人没有新增输入参数，请在[**话术管理**](https://aiccs.console.aliyun.com/patter/list)>**配置**>**输入输出参数**界面单击新增输入参数。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：500次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": [\\n {\\n \\"RuleTagName\\": \\"\\",\\n \\"RuleTagId\\": 0\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetCallSoundRecord' => [
- 'summary' => '根据呼叫创建时间、呼叫唯一ID获取通话录音文件URL，根据URL获取通话录音文件。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetQueueInformation' => [
+ 'summary' => '获取在线监控下技能组纬度队列信息。支持实例、时间区间、部门、技能组分组查询。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -16245,38 +8978,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' => 'CreateTime',
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
+ ],
+ [
+ 'name' => 'StartDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'CurrentPage',
'in' => 'query',
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'DepIds',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '呼叫创建时间。格式：YYYY-MM-DD hh:mm:ss。'."\n"
- ."\n\n"
- .'可调用[RobotCall](~~2717996~~)接口，查看调用后的**Response Header**中的**date**参数获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2021-10-15 08:56:23',
+ 'title' => '部门id列表',
+ 'description' => '部门ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
+ 'required' => false,
],
],
[
- 'name' => 'CallId',
+ 'name' => 'GroupIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '呼叫唯一ID。'."\n"
- ."\n\n"
- .'可调用[RobotCall](~~2717996~~)接口，查看返回参数的**Data**获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '125165515022^11195613****',
+ 'title' => '技能组id列表',
+ 'description' => '技能组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '技能组ID。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
+ 'required' => false,
],
],
+ [
+ 'name' => 'ExistDepartmentGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'ExistSkillGroupGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
],
'responses' => [
200 => [
@@ -16285,400 +9058,163 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误描述', 'description' => '状态码的描述。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '通话录音文件URL。',
- 'type' => 'string',
- 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/1001067****.wav',
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ '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' => '信息为List<Map>类型的JSON字符串。', 'type' => 'string', '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}'],
+ ],
],
+ 'Code' => ['title' => '错误编码', 'description' => '请求状态码。返回200代表请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- '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\\": \\"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' => '获取通话录音文件',
- 'description' => '### 前提条件'."\n"
- .'调用本接口前，请您确保调用[RobotCall](~~223270~~)接口过程中，已开启通话过程录音，且成功获取录音回执，即录音文件已生成，否则会返回无效的URL链接。'."\n"
- ."\n"
- .'### 使用说明'."\n"
- .'本接口为录音回执的补充接口。当录音回执消息中的URL链接超过有效期后，可以通过本接口获取新的录音地址，默认录音回执URL有效期为三天。'."\n"
- ."\n"
- .'> 建议您通过录音回执URL直接下载录音内容，进行本地保存，不依赖回执的URL，以解决有效期问题。'."\n"
+ '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' => '获取在线监控下技能组纬度队列信息',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
+ .'- 若您需要填写部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：500次/秒。'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'ListRobotNode' => [
- 'summary' => '根据机器人ID，即话术ID，获取机器人节点信息列表。',
- 'methods' => [
- 'post',
- 'get',
+ 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
+ ."\n"
+ .' group_name：技能组名称'."\n"
+ .' group_id：技能组ID'."\n"
+ .' department_id：部门ID'."\n"
+ .' department_name：部门名称'."\n"
+ .' date_id：日期'."\n"
+ .' tenant_id：租户ID'."\n"
+ .' tenant_name：租户名称'."\n"
+ .' current_session_wait_cnt：排队会员'."\n"
+ .' current_session_service_cnt：服务中会员'."\n"
+ .' eventide：事件时间'."\n"
+ .' fst_assign_time：该队列最早的时间，排队中的分配时间'."\n"
+ .' ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueueInformation'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetRecordData' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'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' => '机器人ID，即话术ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>智能外呼机器人</b>><b>话术管理</b>中获取。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '100002674****',
- ],
+ 'schema' => ['description' => '实例ID。'."\n"
+ ."\n"
+ .'请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**实例管理**中查看实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
+ ],
+ [
+ 'name' => 'Acid',
+ 'in' => 'query',
+ 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1001067****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'Ok',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Data' => [
- 'description' => '机器人节点列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '机器人节点列表。',
- 'type' => 'object',
- 'properties' => [
- 'ProcessName' => [
- 'description' => '流程名称。',
- 'type' => 'string',
- 'example' => '开场白',
- ],
- 'ModelName' => [
- 'description' => '模型名称。',
- 'type' => 'string',
- 'example' => '模型一',
- ],
- 'IsOutput' => [
- 'description' => '是否输出。取值：'."\n"
- ."\n"
- .'- **1**：是。'."\n"
- .'- **0**：否。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'NodeName' => [
- 'description' => '节点名称。',
- 'type' => 'string',
- 'example' => '理财',
- ],
- 'NodeIdentifier' => [
- 'description' => '输出ID。',
- 'type' => 'string',
- 'example' => '12****',
- ],
- ],
+ 'description' => '数据列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Acid' => ['description' => '会话ID。', 'type' => 'string', 'example' => '1001067****'],
+ 'OssLink' => ['description' => '录音文件地址。', 'type' => 'string', 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***'],
],
],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'Ok',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '调用接口是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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\\": [\\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' => '获取机器人节点信息列表',
- 'description' => '- 机器人节点信息包括流程名称、模型名称、节点名称、是否输出、输出ID。'."\n"
- .'- 调用前，建议您确认机器人ID，即话术ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：500次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'CreateTask' => [
- 'summary' => '创建智能联络机器人呼叫任务。',
- 'methods' => [
- 'post',
- 'get',
+ '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' => '获取录音文件',
+ 'summary' => '调用GetRecordData接口获取录音文件。',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:00.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'GetRecordUrl' => [
+ 'summary' => '调用GetRecordUrl接口获取语音双呼录音链接。',
+ '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' => '任务名称。支持中文和英文，0～30个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '测试任务',
- ],
- ],
- [
- 'name' => 'RobotId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '指定机器人ID（话术ID）。表示选择哪个机器人话术发起呼叫。'."\n"
- ."\n"
- .'您可在控制台的[话术管理](https://aiccs.console.aliyun.com/patter/list)页面，获取话术ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12****',
- ],
- ],
- [
- 'name' => 'Caller',
- 'in' => 'query',
- 'schema' => [
- 'description' => '外呼主叫号码。'."\n"
- ."\n"
- .'> 必须是已购买的号码，多个号码用英文逗号（,）隔开。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0571****5678,0571****5679',
- ],
- ],
- [
- 'name' => 'CallString',
- 'in' => 'query',
- 'schema' => [
- 'description' => '呼叫字符（被叫信息和参数列表）。取值：'."\n"
- ."\n"
- .'- **LIST**：`05715678****,05715679****`'."\n"
- .'- **JSON**：`{"ParamNames":["name","age"],"CalleeList":[{"Callee":"1810000****","Params":["张三","20"]},{"Callee":"1810001****","Params":["李四","21"]}]}`。其中ParamNames代表参数名称列表；Params代表参数值列表。'."\n"
- ."\n"
- .'> - 参数名称列表和参数值列表顺序需要对应。 '."\n"
- .'- 最多1000个被叫号码。'."\n"
- ."\n\n"
- ."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"ParamNames":["name","age"],"CalleeList":[{"Callee":"1810000****","Params":["张三","20"]},{"Callee":"1810001****","Params":["李四","21"]}]}',
- ],
- ],
- [
- 'name' => 'CallStringType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '呼叫字符串类型。取值：'."\n"
- ."\n"
- .'- **LIST**'."\n"
- .'- **JSON**',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'JSON',
- ],
- ],
- [
- 'name' => 'RetryFlag',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否自动重拨。取值：'."\n"
- ."\n"
- .'- **1**：重拨。'."\n"
- .'- **0**：不重拨。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'RetryCount',
- 'in' => 'query',
- 'schema' => [
- 'description' => '重拨次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- ],
- [
- 'name' => 'RetryInterval',
- 'in' => 'query',
- 'schema' => [
- 'description' => '重拨间隔。单位：分钟，必须大于1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- ],
- [
- 'name' => 'RetryStatusCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '需要重拨的通话状态。多个状态使用英文逗号（,）分隔。取值：'."\n"
- ."\n"
- .'- **200010**：关机。'."\n"
- .'- **200011**：停机。'."\n"
- .'- **200002**：占线。'."\n"
- .'- **200012**：呼损。'."\n"
- .'- **200005**：无法接通。'."\n"
- .'- **200003**：无应答。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '200010,200011',
- ],
- ],
- [
- 'name' => 'StartNow',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '是否立即启动。'."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '是',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。可在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)>实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-****'],
],
[
- 'name' => 'WorkTimeList',
+ 'name' => 'Acid',
'in' => 'query',
- 'schema' => [
- 'description' => '工作时间列表（精确到分钟）。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '10:00-12:00,13:00-14:00',
- ],
+ 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => true, 'example' => '1001067****'],
],
[
- 'name' => 'WorkDay',
+ 'name' => 'RecordType',
'in' => 'query',
'schema' => [
- 'description' => '工作日期。取值：'."\n"
+ 'description' => '呼叫类型。取值：'."\n"
."\n"
- .'- **1**：星期一。'."\n"
- .'- **2**：星期二。'."\n"
- .'- **3**：星期三。'."\n"
- .'- **4**：星期四。'."\n"
- .'- **5**：星期五。'."\n"
- .'- **6**：星期六。'."\n"
- .'- **7**：星期天。'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'SeatCount',
- 'in' => 'query',
- 'schema' => [
- 'description' => '并发数量（坐席数量）。',
+ .'- **DUP_CALL**：双呼。'."\n"
+ .'- **IVR_CALL**：IVR外呼。'."\n"
+ .'- **SMART_CALL**：智能外呼。',
'type' => 'string',
'required' => true,
- 'example' => '3',
+ 'example' => 'DUP_CALL',
+ 'enum' => ['DUP_CALL', 'IVR_CALL', 'SMART_CALL'],
],
],
],
@@ -16686,140 +9222,58 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回数据。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
- 'description' => '机器人呼叫任务的唯一任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12****',
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '数据列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Acid' => ['title' => '会话id', 'description' => '会话ID。', 'type' => 'string', 'example' => '1001067****'],
+ 'OssLink' => ['title' => '录音链接', 'description' => '录音链接。', 'type' => 'string', 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***'],
+ ],
],
+ 'Success' => ['description' => '调用接口是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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\\": {\\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}","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' => '获取语音双呼录音链接',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRecordUrl'],
],
],
- '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":""}]',
- 'title' => '创建任务',
- 'description' => '- 您可以调用此接口创建任务，也可以在**智能联络中心控制台**>**智能外呼机器人（标准版）**>[任务管理](https://aiccs.console.aliyun.com/job/list)>单击**创建任务**进行创建。'."\n"
- .'- 调用此接口后，返回参数的**Data**为机器人呼叫任务的唯一任务ID。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：500次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'ramActions' => [],
],
- 'AttachTask' => [
- 'summary' => '追加任务明细。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'GetRtcToken' => [
+ 'summary' => '调用GetRtcToken获取移动坐席Token。',
+ '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' => '任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面获取任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '12****',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_***'],
],
[
- 'name' => 'CallString',
+ 'name' => 'AccountName',
'in' => 'query',
- 'schema' => [
- 'description' => '呼叫字符（被叫信息和参数列表）。取值：'."\n"
- ."\n"
- .'- **LIST**：话术没有输入变量时，则使用LIST类型参数，只需传入呼叫号码。如：`0571****5678,0571****5679`。'."\n"
- .'- **JSON**：话术有输入变量时，则使用JSON类型参数。需要传入变量名称、呼叫号码、变量值。如：`{"ParamNames":["name","age"],"CalleeList":[{"Callee":"181****0000","Params":["张三","20"]},{"Callee":"181****0001","Params":["李四","21"]}]}`。**ParamNames**代表参数名称列表；**Params**代表参数值列表。'."\n"
- .'> 话术输入变量在[**话术管理**](https://aiccs.console.aliyun.com/patter/list)>**查看**>**输入输出参数**界面查看',
- 'type' => 'string',
- 'required' => false,
- '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"
- .'}',
- ],
+ 'schema' => ['title' => '账号名称', 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => true, 'example' => 'username@example.com'],
],
],
'responses' => [
@@ -16829,412 +9283,333 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
- 'description' => '追加成功的数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => 'data',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RtcId' => ['title' => 'rtcId', 'description' => '通过互联网域接入的终端身份标识。', 'type' => 'string', 'example' => '200000000*******'],
+ 'Token' => [
+ 'title' => 'token信息',
+ 'description' => 'Token信息。',
+ 'type' => 'string',
+ '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}',
+ ],
+ 'AccountName' => ['title' => '账号名', 'description' => '账号名称。', 'type' => 'string', 'example' => '139000000'],
+ ],
+ '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"}',
],
+ 'Code' => ['title' => '错误码', 'description' => '状态码。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '是否成功', 'description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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\\": 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' => '追加明细',
- 'description' => '- 您在创建智能联络机器人呼叫任务后，可调用此接口追加任务明细。'."\n"
- ."\n"
- .'- 在调用此接口之前，请确保您已有创建成功的智能联络机器人呼叫任务。'."\n"
- ."\n"
- .'- 若您没有已创建成功的智能联络机器人呼叫任务，您可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面单击创建任务或通过[CreateTask](~~2718003~~)接口创建任务。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：500次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'StartTask' => [
- 'summary' => '启动已创建成功的智能联络机器人呼叫任务。',
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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":""}]',
+ 'title' => '获取移动坐席Token',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:00.000Z', 'description' => '错误码发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRtcToken'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetSeatInformation' => [
+ 'summary' => '获取在线监控下部门坐席服务能力数据。支持实例、时间区间、部门分组查询。',
+ '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' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)页面查看或通过[CreateTask](~~223556~~)接口获取。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '12****',
- ],
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'StartNow',
+ 'name' => 'startDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
+ ],
+ [
+ 'name' => 'endDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'currentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'depIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '是否立即启动。取值：'."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。代表不启动任务。',
- 'type' => 'boolean',
+ 'title' => '部门id列表',
+ 'description' => '部门ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
'required' => false,
- 'example' => 'true',
],
],
+ [
+ 'name' => 'existDepartmentGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回数据。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ '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'],
+ 'Rowr' => ['title' => '信息为list<map>类型的json字符串', 'description' => '信息为List<Map>类型的JSON字符串。', 'type' => 'string', '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}'],
+ ],
],
+ 'Code' => ['title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- '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' => '启动任务',
- 'description' => '- 您可调用此接口启动已创建成功的智能联络机器人呼叫任务，也可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面手动启动任务。'."\n"
- ."\n"
- .'- 在调用此接口之前，请确保您已有创建成功的智能联络机器人呼叫任务。'."\n"
- ."\n"
- .'- 若您没有已创建成功的智能联络机器人呼出任务，可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面单击创建任务或通过[CreateTask](~~2718003~~)接口创建任务。'."\n"
- ."\n\n"
+ '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":""}]',
+ 'title' => '获取在线监控下部门坐席服务能力数据',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
+ .'- 若您需要填写部门信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：500次/秒。'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'StopTask' => [
- 'summary' => '暂停已成功启动的智能联络机器人呼叫任务。',
- 'methods' => [
- 'post',
- 'get',
+ 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
+ ."\n"
+ .' svc_no_client_cnt：空闲座席数'."\n"
+ .' svc_rest_cnt：小休座席数'."\n"
+ .' svc_online_cnt：在线中的座席'."\n"
+ .' svc_avai_capacity：当前空余服务能力'."\n"
+ .' svc_ask_rest_servicer_num：申请小休的座席'."\n"
+ .' svc_ask_offline_servicer_num：申请离线的座席'."\n"
+ .' svc_offline_cnt：离线座席'."\n"
+ .' svc_max_capacity：最大服务能力'."\n"
+ .' svc_current_capacity：当前最大服务能力'."\n"
+ .' max_speci_ability_num：最大的鲸吞加1能力服务量'."\n"
+ .' current_speci_ability_num：当前的鲸吞加1能力服务量'."\n"
+ .' special_ability_num：当前可分配的鲸吞加1的服务量'."\n"
+ .' servicer_rest_cnt：小休次数',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSeatInformation'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetSkillGroupAgentStatusDetails' => [
+ 'summary' => '获取技能组服务状态量。支持实例、时间区间、部门、技能组分组查询。',
+ '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' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)页面查看或通过[CreateTask](~~223556~~)接口获取。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '12****',
- ],
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'StartDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614824872'],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614824972'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'DepIds',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Data' => [
- 'description' => '是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ 'title' => '部门id列表',
+ 'description' => '部门ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
+ 'required' => false,
],
],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.',
- 'errorCode' => 'PermissionInsufficient',
- ],
- [
- 'errorMessage' => 'The parameter is invalid.',
- 'errorCode' => 'ParameterError',
+ [
+ 'name' => 'GroupIds',
+ 'in' => 'query',
+ 'style' => 'simple',
+ 'schema' => [
+ 'title' => '技能组id列表',
+ 'description' => '技能组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '技能组ID。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
+ 'required' => false,
],
],
- ],
- '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' => '暂停任务',
- 'description' => '- 你可通过此接口暂停已成功启动的智能联络机器人呼叫任务，也可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面手动暂停任务。'."\n"
- ."\n"
- .'- 在调用此接口之前，请确保您已有成功启动的智能联络机器人呼叫任务。'."\n"
- ."\n"
- .'- 若您没有已成功启动的智能联络机器人呼叫任务，请在[任务管理](https://aiccs.console.aliyun.com/job/list)界面点击启动或通过[StartTask](~~2718005~~)接口启动任务。'."\n"
- ."\n\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：500次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'CancelTask' => [
- 'summary' => '取消智能联络机器人呼叫任务。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'ExistDepartmentGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'TaskId',
+ 'name' => 'ExistSkillGroupGrouping',
'in' => 'query',
- 'schema' => [
- 'description' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面查看或通过[CreateTask](~~223556~~)接口获取。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '12****',
- ],
+ 'schema' => ['title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回数据。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口是否调用成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => 'data',
+ 'description' => '数据列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalNum' => ['title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
+ 'PageNum' => ['title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'PageSize' => ['title' => '每页的数量', 'description' => '每页的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000'],
+ 'Rows' => ['title' => '信息为list<map>类型的json字符串', 'description' => '信息为List<Map>类型的JSON字符串。', 'type' => 'string', '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}'],
+ ],
],
+ 'Code' => ['title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '接口调用是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- '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":"<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' => '取消任务',
- 'description' => '- 您可调用此接口取消智能联络机器人呼叫任务，也可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面手动取消任务。'."\n"
- ."\n"
- .'- 智能联络机器人呼叫任务被取消后，将无法再次启动，请谨慎操作。'."\n"
+ '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":""}]',
+ 'title' => '获取技能组服务状态量',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
+ .'- 若您需要填写部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
."\n"
- .'- 若您想暂停任务之后再次开启任务，可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面手动暂停任务或通过[StopTask](~~2718006~~)接口暂停任务。'."\n"
- ."\n\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：500次/秒。'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'ListTask' => [
- 'summary' => '分页查询智能联络机器人呼叫任务列表。包含任务总数、任务信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
+ ."\n"
+ .' group_name：技能组名称'."\n"
+ .' department_id：部门ID'."\n"
+ .' department_name：部门名称'."\n"
+ .' tenant_id：租户ID'."\n"
+ .' tenant_name：租户名称'."\n"
+ .' svc_no_client_cnt：空闲座席数'."\n"
+ .' svc_rest_cnt：小休座席数'."\n"
+ .' svc_online_cnt：在线中的座席'."\n"
+ .' svc_avai_capacity：当前空余服务能力'."\n"
+ .' svc_ask_rest_servicer_num：申请小休的座席'."\n"
+ .' svc_ask_offline_servicer_num：申请离线的座席'."\n"
+ .' svc_offline_cnt：离线座席'."\n"
+ .' svc_max_capacity：最大服务能力'."\n"
+ .' svc_current_capacity：当前最大服务能力'."\n"
+ .' max_speci_ability_num：最大的鲸吞加1能力服务量'."\n"
+ .' current_speci_ability_num：当前的鲸吞加1能力服务量'."\n"
+ .' special_ability_num：当前可分配的鲸吞加1的服务量',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupAgentStatusDetails'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetSkillGroupAndAgentStatusSummary' => [
+ 'summary' => '获取热线监控下技能组坐席汇总状态量。支持实例、时间区间、部门、技能组分组查询。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -17242,88 +9617,76 @@
],
'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' => '任务名称。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面查看已创建的任务名称。',
- 'type' => 'string',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '任务测试',
- ],
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'PageNo',
+ 'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '每页数量。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'Status',
+ 'name' => 'CurrentPage',
'in' => 'query',
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'DepIds',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '任务状态。取值：'."\n"
+ 'title' => '部门id列表',
+ 'description' => '部门ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '部门ID。'."\n"
."\n"
- .'- **INIT**：未开始。'."\n"
- .'- **RELEASE**：解析中。'."\n"
- .'- **RUNNING**：执行中。'."\n"
- .'- **STOP**：手动暂停。'."\n"
- .'- **SYSTEM_STOP**：系统暂停。'."\n"
- .'- **READY**：待执行。'."\n"
- .'- **CANCEL**：手动终止。'."\n"
- .'- **SYSTEM_CANCEL**：系统终止。'."\n"
- .'- **DONE**：已完成。',
- 'type' => 'string',
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
'required' => false,
- 'example' => 'STOP',
],
],
[
- 'name' => 'TaskId',
+ 'name' => 'GroupIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面查看或通过[CreateTask](~~223556~~)接口获取。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '技能组id列表',
+ 'description' => '技能组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '技能组ID。'."\n"
+ ."\n\n"
+ .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
'required' => false,
- 'example' => '12****',
],
],
[
- 'name' => 'RobotName',
+ 'name' => 'ExistDepartmentGrouping',
'in' => 'query',
- 'schema' => [
- 'description' => '机器人名称。即为话术名称，在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面查看已经通过审核的话术名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '机器人',
- ],
+ 'schema' => ['title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'ExistSkillGroupGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
@@ -17333,155 +9696,73 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'message'],
'Data' => [
- 'description' => '任务数据列表。',
+ 'title' => 'data',
+ 'description' => '数据列表。',
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => '每页个数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'Total' => [
- 'description' => '任务总数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'PageNo' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Record' => [
- 'description' => '任务信息列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '任务信息。',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '任务状态。',
- 'type' => 'string',
- 'example' => 'RELEASE',
- ],
- 'GmtCreate' => [
- 'description' => '任务创建时间。时间戳格式，单位：毫秒。',
- 'type' => 'string',
- 'example' => '1618477232000',
- ],
- 'TotalCount' => [
- 'description' => '处理通话总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'FireTime' => [
- 'description' => '任务启动时间。时间戳格式，单位：毫秒。',
- 'type' => 'string',
- 'example' => '1618477232000',
- ],
- 'TaskName' => [
- 'description' => '任务名称。',
- 'type' => 'string',
- 'example' => '测试任务',
- ],
- 'RobotId' => [
- 'description' => '指定机器人ID。即为话术ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12****',
- ],
- 'RobotName' => [
- 'description' => '机器人名称。',
- 'type' => 'string',
- 'example' => '机器人',
- ],
- 'Id' => [
- 'description' => '机器人呼叫任务的唯一任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12****',
- ],
- 'CompleteCount' => [
- 'description' => '完成通话个数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- ],
+ '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' => '信息为List<Map>类型的JSON字符串。', '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}'],
],
],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '错误编码', 'description' => '状态编码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '接口调用是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- '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' => '获取任务列表',
- 'description' => '- 您可以通过此接口获取智能联络机器人呼叫任务列表，也可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面获取任务列表。'."\n"
- ."\n"
- .'- 若您没有已创建的智能联络机器人呼叫任务，可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面单击创建任务或通过[CreateTask](~~2718003~~)接口创建任务。'."\n"
- ."\n"
- .'- 此接口的非必填参数为智能联络机器人呼叫任务列表的筛选条件，若不填写，则查询全部任务列表。'."\n"
- ."\n"
+ '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' => '获取热线监控下技能组坐席汇总状态量',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
+ .'- 若您需要填写部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ ."\n\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：500次/秒。'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'ListTaskDetail' => [
- 'summary' => '获取智能联络机器人呼叫任务明细信息。',
- 'methods' => [
- 'post',
- 'get',
+ 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
+ ."\n"
+ .' n_idle_now：当前空闲坐席数'."\n"
+ .' n_resttype_now：当前小休坐席数'."\n"
+ .' n_resttype1_now：当前普通小休坐席数'."\n"
+ .' n_resttype2_now：当前就餐小休坐席数'."\n"
+ .' n_resttype3_now：当前会议小休坐席数'."\n"
+ .' n_resttype4_now：当前辅导小休坐席数'."\n"
+ .' n_resttype5_now：当前培训小休坐席数'."\n"
+ .' n_resttype98_now：当前强制小休坐席数'."\n"
+ .' n_resttype99_now：当前签入小休坐席数'."\n"
+ .' n_ack_now：当前后处理坐席数'."\n"
+ .' n_online_now：当前在线坐席数'."\n"
+ .' n_busy_now：通话坐席数'."\n"
+ .' tenant_id：租户ID'."\n"
+ .' tenant_name：租户名称'."\n"
+ .' group_id：技能组ID'."\n"
+ .' group_name：技能组名称'."\n"
+ .' department_id：部门ID'."\n"
+ .' department_name：部门名称'."\n"
+ .' date_id：日期',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupAndAgentStatusSummary'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetSkillGroupLatitudeState' => [
+ 'summary' => '获取热线下监控技能组纬度状态量。支持实例、时间区间、部门、技能组分组查询。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -17489,280 +9770,155 @@
],
'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' => '呼叫状态码。在语音服务[呼叫状态码](~~112804~~)中查看。',
- 'type' => 'string',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '200100',
- ],
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'Status',
+ 'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'description' => '明细状态。取值：'."\n"
- ."\n"
- .'- **SUCCESS**：外呼成功。'."\n"
- .'- **FAIL**：外呼失败。'."\n"
- .'- **INIT**：未外呼。',
- 'type' => 'string',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => 'SUCCESS',
- ],
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
],
[
- 'name' => 'PageNo',
+ 'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
],
[
'name' => 'PageSize',
'in' => 'query',
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'DepIds',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '部门id列表',
+ 'description' => '部门ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
'required' => false,
- 'example' => '20',
],
],
[
- 'name' => 'Called',
+ 'name' => 'GroupIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '被叫号码。在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**界面查看被叫号码。',
- 'type' => 'string',
+ 'title' => '技能组id列表',
+ 'description' => '技能组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '技能组ID。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
'required' => false,
- 'example' => '186****0000',
],
],
[
- 'name' => 'TaskId',
+ 'name' => 'ExistDepartmentGrouping',
'in' => 'query',
- 'schema' => [
- 'description' => '任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)页面查看任务ID或通过[ListTask](~~2718008~~)接口获取任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '12****',
- ],
+ 'schema' => ['title' => '是否根据部门分组', 'description' => '是否根据部门分组。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'Id',
+ 'name' => 'ExistSkillGroupGrouping',
'in' => 'query',
- 'schema' => [
- 'description' => '明细ID。在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**界面查看明细ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12****',
- ],
+ 'schema' => ['title' => '是否根据技能组分组', 'description' => '是否根据技能组分组。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回数据。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '任务详细信息。',
+ 'title' => 'data',
+ 'description' => '数据列表。',
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Total' => [
- 'description' => '任务总数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'PageNo' => [
- 'description' => '每页个数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'Record' => [
- 'description' => '任务信息列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '任务信息。',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'description' => '明细状态。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'Called' => [
- 'description' => '被叫号码。',
- 'type' => 'string',
- 'example' => '186****0000',
- ],
- 'EndTime' => [
- 'description' => '结束时间。',
- 'type' => 'string',
- 'example' => '2021-05-20 00:03:00',
- ],
- 'StartTime' => [
- 'description' => '开始时间。',
- 'type' => 'string',
- 'example' => '2021-05-20 00:00:00',
- ],
- 'Duration' => [
- 'description' => '通话时长。单位：秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'StatusCode' => [
- 'description' => '呼叫状态码。',
- 'type' => 'string',
- 'example' => '200100',
- ],
- 'StatusCodeDesc' => [
- 'description' => '呼叫状态码描述。',
- 'type' => 'string',
- 'example' => '呼叫成功',
- ],
- 'Direction' => [
- 'description' => '挂断方向。取值：'."\n"
- ."\n"
- .'- **用户**。'."\n"
- .'- **机器**。',
- 'type' => 'string',
- 'example' => '用户',
- ],
- 'RetryCurTimes' => [
- 'description' => '当前重试次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Caller' => [
- 'description' => '主叫号码。',
- 'type' => 'string',
- 'example' => '136****0000',
- ],
- 'Id' => [
- 'description' => '明细ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12****',
- ],
- 'RetryTimes' => [
- 'description' => '重试次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Tags' => [
- 'description' => '意图标签。',
- 'type' => 'string',
- 'example' => '肯定',
- ],
- ],
- ],
- ],
+ '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' => '信息为List<Map>类型的JSON字符串。', '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":"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}'],
],
],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '错误编码', 'description' => '状态编码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '接口调用是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- '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' => '获取任务明细信息',
- 'description' => '- 您可调用此接口获取智能联络机器人呼叫任务明细信息，也可在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**界面查看智能联络机器人呼叫任务明细信息。'."\n"
- ."\n"
- .'- 在调用此接口前，请确保您创建成功的智能联络机器人已成功启动任务。'."\n"
- ."\n"
- .'- 若您没有已创建成功的智能联络机器人呼叫任务，可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面创建并启动任务或通过[CreateTask](~~2718003~~)、[StartTask](~~2718005~~)接口创建并启动任务。'."\n"
- ."\n"
- .'- 此接口中的非必填参数为智能联络机器人呼叫任务明细信息的筛选条件，若不填写，则查询全部任务明细信息。'."\n"
+ '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\\\\\\",\\\\\\"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' => '获取热线下监控技能组纬度状态量',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
+ .'- 若您需要填写部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：500次/秒。'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'ListDialog' => [
- 'summary' => '查询智能联络机器人对话记录。',
- 'methods' => [
- 'post',
- 'get',
+ 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
+ ."\n"
+ .' n_idle_now：当前空闲坐席数'."\n"
+ .' n_resttype_now：当前小休坐席数'."\n"
+ .' n_resttype1_now：当前普通小休坐席数'."\n"
+ .' n_resttype2_now：当前就餐小休坐席数'."\n"
+ .' n_resttype3_now：当前会议小休坐席数'."\n"
+ .' n_resttype4_now：当前辅导小休坐席数'."\n"
+ .' n_resttype5_now：当前培训小休坐席数'."\n"
+ .' n_resttype98_now：当前强制小休坐席数'."\n"
+ .' n_resttype99_now：当前签入小休坐席数'."\n"
+ .' n_ack_now：当前后处理坐席数'."\n"
+ .' tenant_id：租户ID'."\n"
+ .' tenant_name：租户名称'."\n"
+ .' group_id：技能组ID'."\n"
+ .' group_name：技能组名称'."\n"
+ .' department_id：部门ID'."\n"
+ .' department_name：部门名称'."\n"
+ .' n_online_now：当前在线坐席数'."\n"
+ .' n_inqueue_now：排队中会员数'."\n"
+ .' n_inservice_now：服务中会员数'."\n"
+ .' time_value：时间戳'."\n"
+ .' fst_assign_time：该队列最早的时间，排队中的分配时间'."\n",
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupLatitudeState'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetSkillGroupServiceCapability' => [
+ 'summary' => '获取在线监控下技能组纬度服务能力数据。支持实例、时间区间、部门、技能组分组查询。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -17770,1002 +9926,768 @@
],
'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' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。'."\n", 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
+ ],
+ [
+ 'name' => 'StartDate',
'in' => 'query',
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
+ ],
+ [
+ 'name' => 'EndDate',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'DepIds',
+ 'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面查看或通过[CreateTask](~~223556~~)接口获取。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '12****',
+ 'title' => '部门id列表',
+ 'description' => '部门ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
+ 'required' => false,
],
],
[
- 'name' => 'Called',
+ 'name' => 'GroupIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '被叫号码。在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**界面查看被叫号码或通过[ListTaskDetail](~~2718009~~)接口获取被叫号码，接口返回的参数**Called**即为被叫号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '130****0000',
+ 'title' => '技能组id列表',
+ 'description' => '技能组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '技能组ID。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
+ 'required' => false,
],
],
+ [
+ 'name' => 'ExistDepartmentGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'ExistSkillGroupGrouping',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回数据。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '通话交互内容。',
- 'type' => 'array',
- 'items' => [
- 'description' => '通话交互内容列表。',
- 'type' => 'object',
- 'properties' => [
- 'Role' => [
- 'description' => '说话的角色。取值：'."\n"
- ."\n"
- .'- robot：机器人。'."\n"
- ."\n"
- .'- user：用户。',
- 'type' => 'string',
- 'example' => 'robot',
- ],
- 'Content' => [
- 'description' => '话术内容。',
- 'type' => 'string',
- 'example' => '您好',
- ],
- 'NodeType' => [
- 'description' => '节点类型。',
- 'type' => 'string',
- 'example' => 'normal',
- ],
- 'Time' => [
- 'description' => '开始时间。时间戳格式，单位：毫秒。',
- 'type' => 'string',
- 'example' => '1619763900718',
- ],
- 'Tag' => [
- 'description' => '意图标签。',
- 'type' => 'string',
- 'example' => '肯定',
- ],
- ],
+ 'title' => 'data',
+ 'description' => '数据列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalNum' => ['title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', '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' => '信息为List<Map>类型的JSON字符串。', 'type' => 'string', '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"
+ .'}'],
],
],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
- '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' => '查询对话记录',
- 'description' => '- 您可调用此接口查询智能联络机器人对话记录，也可在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**>**查看对话记录**界面查看智能联络机器人对话记录。'."\n"
- ."\n"
- .'- 在调用此接口前，请确保您创建的智能联络机器人呼叫任务已有成功拨通的号码。'."\n"
- ."\n"
- .'- 若您没有已创建的智能联络机器人呼叫任务，可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面创建并启动任务或通过[CreateTask](~~2718003~~)、[StartTask](~~2718005~~)接口创建并启动任务。'."\n"
- ."\n\n"
+ '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":""}]',
+ 'title' => '获取在线监控下技能组纬度服务能力数据',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
+ .'- 若您需要填写部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：500次/秒。'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'SendCcoSmartCall' => [
- 'methods' => [
- 'post',
- 'get',
+ 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
+ ."\n"
+ .' tenant_id：租户ID'."\n"
+ .' tenant_name：租户名称'."\n"
+ .' group_name：技能组名称'."\n"
+ .' department_id：部门ID'."\n"
+ .' department_name：部门名称'."\n"
+ .' svc_no_client_cnt：空闲座席数'."\n"
+ .' svc_rest_cnt：小休座席数'."\n"
+ .' svc_online_cnt：在线中的座席'."\n"
+ .' svc_avai_capacity：当前空余服务能力'."\n"
+ .' svc_ask_rest_servicer_num：申请小休的座席'."\n"
+ .' svc_ask_offline_servicer_num：申请离线的座席'."\n"
+ .' svc_offline_cnt：离线座席'."\n"
+ .' svc_max_capacity：最大服务能力'."\n"
+ .' svc_current_capacity：当前最大服务能力'."\n"
+ .' max_speci_ability_num：最大的鲸吞加1能力服务量'."\n"
+ .' current_speci_ability_num：当前的鲸吞加1能力服务量'."\n"
+ .' special_ability_num：当前可分配的鲸吞加1的服务量 '."\n"
+ .' servicer_rest_cnt：小休次数'."\n"
+ .' pk_id：主键',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupServiceCapability'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'GetSkillGroupServiceStatus' => [
+ 'summary' => '获取在线报表下技能组服务状态量。',
+ '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' => '产品名称。默认取值：**aiccs**。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aiccs',
- 'default' => 'aiccs',
- ],
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'CalledShowNumber',
+ 'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'description' => '被叫显号，必须是已购买的号码。'."\n"
- ."\n"
- .'您可以登录[联络中心控制台](https://aiccs.console.aliyun.com/overview?spm=a2c4g.11186623.0.0.7f9bf9658X6jte)，查看已购买的号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0571****0000',
- ],
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
],
[
- 'name' => 'CalledNumber',
+ 'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'description' => '被叫号码。仅支持中国内地号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '137****0000',
- ],
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
],
[
- 'name' => 'VoiceCode',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '智能外呼放音文件，支持网络文件和TTS方式。其中，支持使用多个文件和TTS参数混播，之间用英文逗号（,）分隔。TTS参数的替换值在**VoiceCodeParam**中指定。'."\n"
- ."\n"
- .'- 放音文件为网络文件时：参数VoiceCode指定为可被公网访问的语音文件URL，建议您使用采样频率为8000Hz或16000Hz且为wav格式的语音文件。'."\n"
- .'- 放音文件为TTS时：参数VoiceCode指定为变量名称如$name$，需要在VoiceCodeParam中设置变量对应的内容。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$',
- ],
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'OutId',
+ 'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'description' => '预留给调用方使用的ID，最终会通过在回执消息中将此ID带回给调用方。'."\n"
- .'字符串类型，长度为1~15个字节。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '222356****',
- ],
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'PlayTimes',
+ 'name' => 'AgentIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '参数暂不支持使用。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '技能组id列表',
+ 'description' => '坐席ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '坐席ID。'."\n"
+ ."\n"
+ .'可调用[GetAgent](~~2717961~~)接口，查看返回参数的**AgentId**，即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
'required' => false,
- 'example' => '1',
],
],
[
- 'name' => 'Volume',
+ 'name' => 'DepIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '播放用户音频的音量，取值范围为：-4~4，建议设置为1。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '部门id列表',
+ 'description' => '部门ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](~~2717975~~)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
'required' => false,
- 'example' => '1',
],
],
[
- 'name' => 'Speed',
+ 'name' => 'GroupIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => '参数暂不支持使用。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '技能组id列表',
+ 'description' => '技能组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '技能组ID。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](~~2717970~~)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
'required' => false,
- 'example' => '1',
],
],
[
- 'name' => 'AsrModelId',
+ 'name' => 'TimeLatitudeType',
'in' => 'query',
- 'schema' => [
- 'description' => 'ASR模型ID。请在[ASR模型管理页面](https://aiccs.console.aliyun.com/sentence/model/private?spm=a2c4g.11186623.0.0.7f9b2964fYSGv4)查看ASR模型ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bf71664d30d2478fb8cb8c39c6b6****',
- ],
+ 'schema' => ['title' => '时间纬度类型', 'description' => '时间纬度类型。取值：'."\n"
+ .'- **minute**：分钟。'."\n"
+ .'- **hour**：小时。'."\n"
+ .'- **day**：天。', 'type' => 'string', 'required' => false, 'example' => 'minute'],
],
[
- 'name' => 'AsrBaseId',
+ 'name' => 'ExistAgentGrouping',
'in' => 'query',
- 'schema' => [
- 'description' => 'SR基础模型。'."\n"
- ."\n"
- .'- **customer_service_8k**：普通话。'."\n"
- .'- **dialect_customer_service_8k**：重口音。'."\n"
- .'- 如果仅设置**asrModelId**，表示使用指定的ASR模型。'."\n"
- .'- 如果仅设置**AsrBaseId**，表示使用指定的ASR基础模型。'."\n"
- .'- 如果二者均未设置，则使用默认的ASR基础模型，即参数**AsrBaseId**默认为**customer_service_8k**，表示使用ASR普通话基础模型。'."\n"
- .'- 如果二者同时设置，请确认二者是正确对应的。 '."\n"
- ."\n"
- .'> 调用接口**SendCcoSmartCall**时，需要指定使用的ASR模型，建议参数**asrModelId**和**AsrBaseId**二者选填一个。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'customer_service_8k',
- ],
+ 'schema' => ['title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'AsrAlsAmId',
+ 'name' => 'ExistDepartmentGrouping',
'in' => 'query',
- 'schema' => [
- 'description' => '声学模型ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456',
- ],
+ 'schema' => ['title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'AsrVocabularyId',
+ 'name' => 'ExistSkillGroupGrouping',
'in' => 'query',
- 'schema' => [
- 'description' => '热词ID。请在[ASR热词管理页面](https://aiccs.console.aliyun.com/sentence/vocab?spm=a2c4g.11186623.0.0.7f9bf965IKBpsi)查看ASR热词ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456',
- ],
+ 'schema' => ['title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'RecordFlag',
+ 'name' => 'ExistRobotInstanceGrouping',
'in' => 'query',
- 'schema' => [
- 'description' => '通话过程中是否录音。'."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '是否根据机器实例分组', 'description' => '是否根据机器实例分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'PauseTime',
+ 'name' => 'ExistChannelInstanceGrouping',
'in' => 'query',
- 'schema' => [
- 'description' => '停顿时长。用于设置用户停顿多久表示一句话结束。单位为毫秒。取值范围为**300~1200**，如果指定值不在参数范围中，则默认PauseTime为**800**。'."\n"
- ."\n"
- .'> 首次设置有效，后续设置无效。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '800',
- ],
+ 'schema' => ['title' => '是否根据渠道实例分组', 'description' => '是否根据渠道实例分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
- [
- 'name' => 'MuteTime',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '静音时长，用于设置用户多久不说话通话结束。单位为：毫秒，取值范围为**1000~20000**。'."\n"
- ."\n"
- .'- 如果指定值不在参数范围中，则默认MuteTime为**10000**。'."\n"
- .'- 通话过程中可动态设置，以最后一次设置为准。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10000',
+ 'title' => 'Schema of Response',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => [
+ 'title' => 'data',
+ 'description' => '数据列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalNum' => ['title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'PageSize' => ['title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
+ 'PageNum' => ['title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Rows' => ['title' => '信息为list<map>类型的json字符串', 'description' => '信息为List<Map>类型的JSON字符串。', 'type' => 'string', '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}'],
+ ],
+ ],
+ 'Code' => ['title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'string', 'example' => 'true'],
+ ],
],
],
- [
- 'name' => 'ActionCodeBreak',
- 'in' => 'query',
- 'schema' => [
- 'description' => '开场放音文件是否可打断。默认为**true**，即开场放音文件可打断。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['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 \\"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' => '获取在线报表下技能组服务状态量',
+ 'description' => '### QPS限制'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
+ ."\n"
+ .' date_id：日期'."\n"
+ .' hour_id：小时'."\n"
+ .' minute_id：分钟-5分钟，如：05，10，00，15'."\n"
+ .' servicer_id：小二ID'."\n"
+ .' servicer_name：小二名称'."\n"
+ .' group_id：技能组ID'."\n"
+ .' group_name：技能组名称'."\n"
+ .' department_id：部门ID'."\n"
+ .' department_name：部门名称'."\n"
+ .' tenant_id：租户ID'."\n"
+ .' tenant_name：租户名称'."\n"
+ .' robot_instance_id：机器人ID'."\n"
+ .' robot_instance_name：机器人名称'."\n"
+ .' channel_instance_id：渠道实例ID'."\n"
+ .' channel_instance_name：渠道实例名称'."\n"
+ .' online_direct_request_cnt：用户直接请求的服务量（直连）'."\n"
+ .' online_transfer_request_cnt：被转入的用户服务请求量'."\n"
+ .' online_direct_ready_cnt：用户直接接起的服务量（直连）'."\n"
+ .' online_transfer_ready_cnt：被转入的用户接起服务量'."\n"
+ .' online_transfer_in_give_up_cnt：转交后用户放弃量（未接起量）'."\n"
+ .' online_transfer_out_cnt：转出的总量（建议通过产品上落标记动作直接取数）'."\n"
+ .' online_direct_give_up_cnt：放弃量（直连）直接请求放弃的量'."\n"
+ .' online_transfer_give_up_cnt：放弃量（转入）转入后放弃的量'."\n"
+ .' online_10s_direct_ready_cnt：10秒接起量（直连）'."\n"
+ .' online_10s_transfer_ready_cnt：10秒接起量（转入）'."\n"
+ .' online_20s_direct_ready_cnt：20秒接起量（直连）'."\n"
+ .' online_20s_transfer_ready_cnt：20秒接起量（转入）'."\n"
+ .' online_30s_direct_ready_cnt：30秒接起量（直连）'."\n"
+ .' online_30s_transfer_ready_cnt：30秒接起量（转入）'."\n"
+ .' online_40s_direct_ready_cnt：40秒接起量（直连）'."\n"
+ .' online_40s_transfer_ready_cnt：40秒接起量（转入）'."\n"
+ .' online_60s_direct_ready_cnt：60秒接起量（直连）'."\n"
+ .' online_60s_transfer_ready_cnt：60秒接起量（转入）'."\n"
+ .' online_service_time_len：服务总时长对应技能组中，小二开始服务的时间到小二服务结束时间（如果发生转交，服务结束时间＝转交时间）'."\n"
+ .' online_direct_wait_len：等待总时长（直连）直连接起量的进入队列到接起待时长'."\n"
+ .' online_transfer_wait_len：等待总时长（转入）转入接起量的进入队列到接起待时长'."\n"
+ .' online_direct_give_up_len：放弃总时长（直连）直连接起量的进入队列到放弃时长'."\n"
+ .' online_transfer_give_up_len：放弃总时长（转入）转入接起量的进入队列到放弃的时长（如果有放弃的，其时长算在最后一个目标技能组）'."\n"
+ .' online_direct_response_len：响应时长（直连）会员发出对话到小二回复的平均间隔时长'."\n"
+ .' online_transfer_response_len：响应时长（转入）会员发出对话到小二回复的平均间隔时长'."\n"
+ .' online_direct_response_times：响应次数（直连）会员发出对话到小二回复的间隔次数'."\n"
+ .' online_transfer_response_times：响应次数（转入）会员发出对话到小二回复的间隔次数'."\n"
+ .' online_satis_cnt：满意数-touch的评价'."\n"
+ .' online_simple_cnt：一般数-touch的评价'."\n"
+ .' online_unsatis_cnt：不满意数-touch的评价',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupServiceStatus'],
],
+ ],
+ 'ramActions' => [],
+ ],
+ 'GetSkillGroupStatusTotal' => [
+ 'summary' => '获取热线报表下技能组状态总量。支持实例、时间区间、坐席、部门、技能组分组查询。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'DynamicId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '预留给调用方使用的动态扩展ID，在回调地址中带回，用于客户的开发标识。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
[
- 'name' => 'EarlyMediaAsr',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '早媒体语音识别标识。设为true会记录通话未接听的原因。默认为**false**，即关闭状态。'."\n"
- ."\n"
- .'> 如果需要启用早媒体语音识别标识，请手动设为**true**。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'VoiceCodeParam',
+ 'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'description' => 'TTS参数传递字符串，格式为JSON。必须与VoiceCode的TTS参数对应。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"name":"喂，你好"}',
- ],
+ 'schema' => ['title' => '开始日期时间戳（毫秒）', 'description' => '开始日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'],
],
[
- 'name' => 'SessionTimeout',
+ 'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'description' => '最大通话时长，单位为秒，超时后自动挂断。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '120',
- ],
+ 'schema' => ['title' => '结束日期时间戳（毫秒）', 'description' => '结束日期时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'],
],
[
- 'name' => 'ActionCodeTimeBreak',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '基于用户持续说话时长打断，在ActionCodeBreak为**true**时生效。单位为毫秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '120',
- ],
+ 'schema' => ['title' => '每页大小（默认为10)', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'TtsConf',
+ 'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'description' => '是否设置TTS声音参数。'."\n"
- .'- 指定为**true**：需要通过TtsStyle、TtsVolume、TtsSpeed三个参数来设置声音风格。'."\n"
- .'- 定为**false**：不需要设置相关参数，即便设置了也不生效。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '当前页（默认为1）', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'TtsStyle',
+ 'name' => 'AgentIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => 'TTS变量播放时的声音风格，默认为**xiaoyun**，具体风格请参见声音风格列表。',
- 'type' => 'string',
+ 'title' => '坐席id列表',
+ 'description' => '坐席ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '坐席ID。'."\n"
+ ."\n"
+ .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
'required' => false,
- 'example' => 'xiaoyun',
],
],
[
- 'name' => 'TtsVolume',
+ 'name' => 'DepIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => 'TTS变量播放的音量，取值范围为**0~100**，默认为**0**。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '部门id列表',
+ 'description' => '部门ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口，查看返回参数的**DepartmentId**，即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'],
'required' => false,
- 'example' => '10',
],
],
[
- 'name' => 'TtsSpeed',
+ 'name' => 'GroupIds',
'in' => 'query',
+ 'style' => 'simple',
'schema' => [
- 'description' => 'TTS变量播放时的声音速度，取值范围为：-200~200，默认为0。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '技能组id列表',
+ 'description' => '技能组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '技能组ID。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
'required' => false,
- 'example' => '100',
],
],
[
- 'name' => 'BackgroundFileCode',
+ 'name' => 'TimeLatitudeType',
'in' => 'query',
- 'schema' => [
- 'description' => '用户和机器人对话时播放的背景语音文件ID。您可以登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，选择**智能交互 > 语音文件管理**，单击**详情**，查看对应的语音ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav',
- ],
+ 'schema' => ['title' => '时间纬度类型', 'description' => '时间纬度类型。取值：'."\n"
+ ."\n"
+ .'- **minute**：分钟。'."\n"
+ .'- **hour**：小时。'."\n"
+ .'- **day**：天。', 'type' => 'string', 'required' => false, 'example' => 'minute'],
],
[
- 'name' => 'BackgroundVolume',
+ 'name' => 'ExistAgentGrouping',
'in' => 'query',
- 'schema' => [
- 'description' => '参数暂不支持使用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '4',
- 'minimum' => '-4',
- 'example' => '1',
- ],
+ 'schema' => ['title' => '是否根据坐席分组', 'description' => '是否根据坐席分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'BackgroundSpeed',
+ 'name' => 'ExistDepartmentGrouping',
'in' => 'query',
- 'schema' => [
- 'description' => '参数暂不支持使用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'EnableITN',
+ 'name' => 'ExistSkillGroupGrouping',
'in' => 'query',
- 'schema' => [
- 'description' => '是否在后处理中执行ITN。'."\n"
- ."\n"
- .'> 设置为**true**时，中文数字将转为阿拉伯数字输出，默认为**false**。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
+ 'schema' => ['title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值：**false**。取值：'."\n"
+ ."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D',
- ],
+ 'RequestId' => ['title' => '请求ID，用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '此次通话的唯一回执ID。',
- 'type' => 'string',
- 'example' => '16012854210^10281427****',
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
+ 'title' => 'data',
+ 'description' => '数据列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalNum' => ['title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
+ 'PageNum' => ['title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'PageSize' => ['title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000'],
+ 'Rows' => ['title' => '信息为list<map>类型的json字符串', 'description' => '信息为List<Map>类型的JSON字符串。', 'type' => 'string', '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}'],
+ ],
],
+ 'Code' => ['title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '接口调用是否成功', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。'."\n", 'type' => 'string', 'example' => 'true'],
],
],
],
],
'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',
- ],
- '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":""}]',
- 'title' => '发起智能外呼',
- 'summary' => '根据被叫显号、被叫号码、智能外呼放音文件发起智能语音交互通话。',
- 'description' => '- 以下字符不可以在智能语音交互SendCcoSmartCall回调中出现：`@ = : "" $ { } ^ * ￥`。'."\n"
- .'- 调用此接口后，返回参数的**Data**为此次通话的唯一回执ID，可以用于调用[SendCcoSmartCallOperate](~~2718013~~)接口。'."\n"
+ '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' => '获取热线报表下技能组状态总量',
+ 'description' => '- 调用此接口前，请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH)，并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n"
+ .'- 若您需要填写坐席、部门、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- 'requestParamsDescription' => '### 声音风格列表'."\n"
+ 'responseParamsDescription' => '返回参数Rows参数说明：'."\n"
."\n"
- .'- 小云标准女声：xiaoyun'."\n"
- .'- 小刚标准男声：xiaogang'."\n"
- .'- 若兮温柔女声：ruoxi'."\n"
- .'- 小梦标准女声：xiaomeng'."\n"
- .'- 小威标准男声：xiaowei'."\n"
- .'- 阿美甜美女声：amei'."\n"
- .'- 小雪温柔女声：xiaoxue'."\n"
- .'- 思琪温柔女声：siqi'."\n"
- .'- 思佳标准女声：sijia'."\n"
- .'- 思诚标准男声：sicheng'."\n"
- .'- 思悦温柔女声：siyue'."\n"
- .'- 小美甜美女声：xiaomei'."\n"
- .'- 思彤标准童声：sitong'."\n"
- .'- 宁儿标准女声：ninger'."\n"
- .'- 小北萝莉女声：xiaobei'."\n"
- .'- 伊娜浙普女声：yina'."\n",
- ],
- 'SendCcoSmartCallOperate' => [
- 'methods' => [
- 'post',
- 'get',
+ .' date_id：日期 '."\n"
+ .' hour_id：小时'."\n"
+ .' minute_id：分钟'."\n"
+ .' servicer_id：小二ID'."\n"
+ .' servicer_name：小二名称'."\n"
+ .' servicer_real_name ：小二姓名'."\n"
+ .' group_id：技能组ID '."\n"
+ .' group_name：技能组名称'."\n"
+ .' department_id：部门ID'."\n"
+ .' department_name：部门名称'."\n"
+ .' tenant_id ：租户ID'."\n"
+ .' tenant_name：租户名称 '."\n"
+ .' inline_cnt：进线量'."\n"
+ .' request_cnt：请求量（进行量-重新分配量） '."\n"
+ .' ready_cnt：接起量 '."\n"
+ .' reassign_cnt：重新分配量 '."\n"
+ .' ready_cnt_60s：60秒接起量 '."\n"
+ .' ringqueue_len ：进入队列到振铃 '."\n"
+ .' ringtime_len：振铃到接起 '."\n"
+ .' queue_len：进入队列到接起 '."\n"
+ .' service_time_len：接起到结束，服务时长'."\n"
+ .' give_up_len：进入队列到结束，放弃总时长 '."\n"
+ .' call_out_cnt：外呼量 '."\n"
+ .' call_out_intervene_cnt：外呼振铃总时长-结束-振铃'."\n"
+ .' call_out_sep_sat_cnt：呼出-热线评价满意量 '."\n"
+ .' call_out_sep_normal_cnt：呼出-热线评价一般量'."\n"
+ .' call_out_sep_unsat_cnt：呼出-热线评价不满意量 '."\n"
+ .' call_out_unsep_cnt：呼出-热线参评但未评价量 '."\n"
+ .' call_in_unsep_cnt：呼入-热线参评但未评价量 '."\n"
+ .' call_in_sep_sat_cnt：呼入-热线评价满意量 '."\n"
+ .' call_in_sep_normal_cnt：呼入-热线评价一般量 '."\n"
+ .' call_in_sep_unsat_cnt：呼入-热线评价不满意量 '."\n"
+ .' call_out_intervene_20s_cnt：呼出-通话>20s的接通量'."\n"
+ .' call_out_intervene_30s_cnt：呼出-通话>30s的接通量'."\n"
+ .' call_out_intervene_60s_cnt：呼出-通话>60s的接通量'."\n"
+ .' call_in_intervene_20s_cnt：呼入-通话>20s的接通量'."\n"
+ .' call_in_intervene_30s_cnt：呼入-通话>30s的接通量'."\n"
+ .' call_in_intervene_60s_cnt：呼入-通话>60s的接通量'."\n",
+ 'changeSet' => [
+ ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupStatusTotal'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'HangUpDoubleCall' => [
+ 'summary' => '取消双呼。',
+ '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',
- 'in' => 'query',
- 'schema' => [
- 'description' => '产品名称。默认取值：**aiccs**。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aiccs',
- 'default' => 'aiccs',
- ],
- ],
- [
- 'name' => 'CallId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '通话的唯一回执ID。可以通过[SendCcoSmartCall](~~311247~~)返回。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '116012854210^102814279****',
- ],
- ],
- [
- 'name' => 'Command',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '在智能外呼通话中，指定被叫号码发起的动作。'."\n"
- ."\n"
- .'> 当前仅支持参数**parallelBridge**，表示指定动作为被叫号码与呼叫中心坐席桥接。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'parallelBridge',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => false, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'Param',
+ 'name' => 'Acid',
'in' => 'query',
- 'schema' => [
- 'description' => '扩展字段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Param',
- ],
+ 'schema' => ['title' => '会话ID', 'description' => '会话ID。', 'type' => 'string', 'required' => false, 'example' => '68255155****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D',
- ],
- 'Data' => [
- 'description' => '命令执行的结果。'."\n"
- .'- **true**：命令执行成功。'."\n"
- .'- **false**：命令执行失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'Code' => ['title' => '错误码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '是否调用成功', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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',
- ],
- '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' => '发起智能外呼',
- 'summary' => '在智能外呼通话中，发起指定动作，仅用于并行转人工，人工坐席可旁听人机对话等场景。',
- 'description' => '- 此接口仅可在智能外呼通话过程中调用成功，调用时请注意：请求参数的**CallId**需要填写正在通话的通话唯一回执ID。'."\n"
- .'- **CallId**为调用[SendCcoSmartCall](~~2718012~~)接口时，返回参数的**Data**参数。',
- ],
- 'CreateAiOutboundTask' => [
- 'summary' => '创建智能外呼任务。支持创建时设置任务类型、任务名、外呼主叫号码、被叫号码重复策略等。',
- 'methods' => [
- 'post',
+ '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' => '取消双呼',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:00.000Z', 'description' => '错误码发生变更'],
],
- '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' => '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' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'Type',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务类型（2:预测式外呼3:自动外呼）',
- 'description' => '任务类型。取值：'."\n"
- .'- **2**：预测式外呼。'."\n"
- .'- **3**：自动外呼。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '2',
- 'enum' => [
- '2',
- '3',
- ],
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务名（1～15字符）',
- 'description' => '任务名。1～15字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '测试任务',
- 'maxLength' => 15,
- 'minLength' => 1,
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务描述（0～100字符）',
- 'description' => '任务描述。0～100字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '房产销售',
- 'maxLength' => 100,
- ],
- ],
- [
- 'name' => 'OutboundNums',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '外呼主叫号码',
- 'description' => '外呼主叫号码。'."\n"
- ."\n"
- .'> 必须是已购买的号码，多个号码用半角逗号（,）隔开。',
- 'type' => 'array',
- 'items' => [
- 'description' => '外呼主叫号码。'."\n"
- .'> 必须是已购买的号码，多个号码用半角逗号（,）隔开。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '["0571****5678","0571****5678"]',
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'NumRepeated',
- 'in' => 'query',
- 'schema' => [
- 'title' => '被叫号码重复策略（0任务内去重，1不去重）',
- 'description' => '被叫号码重复策略。取值：'."\n"
- .'- **0**：任务内去重。'."\n"
- .'- **1**：不去重。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- 'enum' => [
- '0',
- '1',
- ],
- ],
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
- 'name' => 'HandlerId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '技能组id（预测式外呼）或者ivr id（自动外呼）',
- 'description' => '对应的技能组ID（预测式外呼）或者IVR ID（自动外呼）。请您在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)获取信息。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123456',
- ],
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'ExecutionTime',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务执行时间',
- 'description' => '任务执行时间。JSON格式。'."\n"
- ."\n"
- .'> 结束时间（end）需晚于开始时间（start）。',
- 'type' => 'string',
- 'required' => true,
- '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"}]}',
- ],
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '坐席账号名称（坐席登录名）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com'],
],
[
- 'name' => 'ConcurrentRate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '自动外呼的呼叫并发',
- 'description' => '自动外呼的呼叫并发。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'name' => 'CallId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '热线会话ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786'],
],
[
- 'name' => 'RecallRule',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '失败重呼策略（为空则不重呼）',
- 'description' => '失败重呼策略。'."\n"
- ."\n"
- .'> 取值为空则不重呼。',
- 'type' => 'object',
- 'properties' => [
- 'Count' => [
- 'title' => '重呼次数（1～3）',
- 'description' => '重呼次数。取值范围：**1～3**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '3',
- 'minimum' => '1',
- 'example' => '1',
- ],
- 'Interval' => [
- 'title' => '重呼间隔时间（1～60分钟）',
- 'description' => '重呼间隔时间。取值范围：**1～60**，单位：分钟。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '60',
- 'minimum' => '1',
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
+ 'name' => 'JobId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的jobId。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787'],
],
[
- 'name' => 'ForecastCallRate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '预测式外呼固定外呼比例（>=1）',
- 'description' => '预测式外呼固定外呼比例。取值范围：**≥1**。',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '1.5',
- ],
+ 'name' => 'ConnectionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的connId。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回数据。',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Data' => [
- 'title' => '任务id',
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'Code' => [
- 'description' => '请求状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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":""}]',
- 'title' => '创建智能外呼任务',
- 'description' => '- 此接口返回参数中的**Data**即是任务ID。'."\n"
- .'- 创建智能外呼任务后，若有更新需要，您可以调用[UpdateAiOutboundTask](~~2718021~~)接口更新外呼任务。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：20次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'CreateAiOutboundTaskBatch' => [
- 'summary' => '根据实例ID、任务ID创建智能外呼任务的任务批次，使得任务下的数据可以按批次查询。',
- 'methods' => [
- 'post',
+ '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' => '[{"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' => '挂断电话',
+ 'summary' => '调用HangupCall执行坐席挂机操作。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'HangupOperate' => [
+ 'summary' => '通信智能引擎中主动挂断通话。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '259150',
+ 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'CallId',
'in' => 'query',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_***',
- ],
+ 'allowEmptyValue' => false,
+ 'schema' => ['description' => '通话回执ID。您可通过[LlmSmartCall](~~2862828~~)或[LlmSmartCallEncrypt](~~2881065~~)接口获取通话回执ID。', 'type' => 'string', 'required' => true, 'example' => '14777672****^13452272****'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'ImmediateHangup',
'in' => 'query',
- 'schema' => [
- 'title' => '任务id',
- 'description' => '任务ID。'."\n"
- ."\n"
- .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123456',
- ],
+ 'schema' => ['description' => '是否立刻挂断。取值：'."\n"
+ ."\n"
+ .'- true（默认值）：立刻挂断。'."\n"
+ ."\n"
+ .'- false：前正在播放的内容播放完再挂断。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
],
],
'responses' => [
@@ -18775,1074 +10697,781 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Data' => [
- 'title' => '新建的任务批次版本id',
- 'description' => '新建的任务批次版本ID。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '123456',
- ],
- 'Code' => [
- 'description' => '请求状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EFD543DD-E087-54A2-AC0B-54E0656511D7'],
+ 'Code' => ['description' => '请求状态码。返回OK表示请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Mesage' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Result' => ['description' => '返回结果。取值：'."\n"
+ ."\n"
+ .'- **true**：挂断成功。'."\n"
+ ."\n"
+ .'- **false**：挂断失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter.CallId', 'errorMessage' => 'The parameter CallId is invalid.', 'description' => '参数CallId无效。'."\n"],
+ ],
],
- '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' => '创建智能外呼任务的任务批次',
- 'description' => '调用前，建议您确认实例ID、任务ID，请参见[请求参数](#api-detail-35)描述中的指引获取。'."\n"
- ."\n\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：20次/秒。'."\n"
- .'- API频率：20次/秒。'."\n"
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFD543DD-E087-54A2-AC0B-54E0656511D7\\",\\n \\"Code\\": \\"OK\\",\\n \\"Mesage\\": \\"OK\\",\\n \\"Result\\": true\\n}","type":"json"}]',
+ 'title' => '通信智能引擎主动挂断通话',
+ 'description' => '- 在通信智能引擎主动挂断通话之前，请先确保已有基于大模型发起的通话。'."\n"
."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'DeleteAiOutboundTask' => [
- 'summary' => '根据实例ID、任务ID删除智能外呼任务。删除后，获取外呼任务列表时无法获取到该任务。',
- 'methods' => [
- 'get',
- 'post',
+ .'- 若没有基于大模型发起的通话，您可以通过[LlmSmartCall](~~2862828~~)或[LlmSmartCallEncrypt](~~2881065~~)接口发起通话。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aiccs:HangupOperate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'HangupThirdCall' => [
+ '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' => '客户请求唯一id，用于幂等校验，可以用uuid生成', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
+ ],
+ [
'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实例id',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_***',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'TaskId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务id',
- 'description' => '任务ID。'."\n"
- ."\n"
- .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123456',
- ],
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '坐席账号名称（坐席登录名）', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com'],
+ ],
+ [
+ 'name' => 'CallId',
+ 'in' => 'formData',
+ 'schema' => ['description' => ' '."\n"
+ .'入呼后，websocket中的acid', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786'],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的jobId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787'],
+ ],
+ [
+ 'name' => 'ConnectionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => "\n"
+ .'入呼后，websocket中的connId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Code' => [
- 'description' => '请求状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '错误描述', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => ' '."\n"
+ .'请求ID，用于跟踪错误原因', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Code' => ['description' => '错误编码', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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' => '删除智能外呼任务',
- 'description' => '><notice>删除为敏感操作，请谨慎操作。></notice>'."\n"
- ."\n"
- .'- 删除前，建议您确认需删除的任务ID及信息，您可以调用[GetAiOutboundTaskList](~~2718026~~)接口查看外呼任务列表，确认任务名称、描述及对应的任务ID。'."\n"
- .'- 若需重新创建智能外呼任务，您可以调用[CreateAiOutboundTask](~~312260~~)接口。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：20次/秒。'."\n"
- .'- API频率：20次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GetAiOutboundTaskBizData' => [
- 'summary' => '根据实例ID、会话ID查询本次呼叫关联的业务信息。',
- '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' => '[{"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":""}]',
+ 'title' => '挂断三方通话',
+ 'summary' => '挂断第三方通话。',
+ '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' => '客户请求唯一id，用于幂等校验，可以用uuid生成', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
+ ],
+ [
'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_***',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'ChannelId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '入呼channelId',
- 'description' => '会话ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123456',
- ],
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '坐席账号名称（坐席登录名）', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com'],
+ ],
+ [
+ 'name' => 'CallId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的acid', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786'],
+ ],
+ [
+ 'name' => 'JobId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的jobId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787'],
+ ],
+ [
+ 'name' => 'ConnectionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的connId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Data' => [
- 'title' => '本次呼叫关联的业务信息',
- 'description' => '本次呼叫关联的业务信息。',
- 'type' => 'object',
- 'properties' => [
- 'BizData' => [
- 'title' => '业务自定义信息',
- 'description' => '业务自定义信息。',
- 'type' => 'string',
- 'example' => '{"customer":123}',
- ],
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'PhoneNum' => [
- 'title' => '外呼号码',
- 'description' => '外呼号码。',
- 'type' => 'string',
- 'example' => '158****0000',
- ],
- 'CaseId' => [
- 'title' => 'id',
- 'description' => '本次外呼关联的活动ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123',
- ],
- ],
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '错误描述', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID，用于跟踪错误原因', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Code' => ['description' => '错误编码', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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' => '查询本次呼叫关联的业务信息',
- 'description' => '### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GetAiOutboundTaskExecDetail' => [
- 'summary' => '根据实例ID、任务ID获取任务执行详情。',
- 'methods' => [
- 'get',
+ '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' => '[{"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":""}]',
+ 'title' => '通话保持',
+ 'summary' => '保持通话。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'HotlineSessionQuery' => [
+ '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' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_***',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'Acid',
+ 'in' => 'query',
+ 'schema' => ['description' => '会话ID。入呼后，websocket中的acid。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '7719786****'],
+ ],
+ [
+ 'name' => 'CallType',
+ 'in' => 'query',
+ 'schema' => ['description' => '电话类型。取值：'."\n"
+ .'- **1**：外呼。'."\n"
+ .'- **2**：入呼。'."\n"
+ .'- **3**：转交。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'CalledNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '发起方号码。例如用户手机号码、客服坐席号码、机器号码等。', 'type' => 'string', 'required' => false, 'example' => '135615****'],
+ ],
+ [
+ 'name' => 'CallingNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '接听方号码。例如用户手机号码、客服坐席号码、机器号码等。', 'type' => 'string', 'required' => false, 'example' => '057177****'],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
+ ],
+ [
+ 'name' => 'GroupName',
+ 'in' => 'query',
+ 'schema' => ['description' => '技能组名称。', 'type' => 'string', 'required' => false, 'example' => '自动化技能组'],
+ ],
+ [
+ 'name' => 'MemberId',
+ 'in' => 'query',
+ 'schema' => ['description' => '会员ID。', 'type' => 'string', 'required' => false, 'example' => '7856****'],
+ ],
+ [
+ 'name' => 'MemberName',
+ 'in' => 'query',
+ 'schema' => ['description' => '会员名称。', 'type' => 'string', 'required' => false, 'example' => '匿名会员'],
+ ],
+ [
+ 'name' => 'QueryEndTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '结束时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614829721'],
+ ],
+ [
+ 'name' => 'QueryStartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '开始时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614828721'],
+ ],
+ [
+ 'name' => 'RequestId',
+ 'in' => 'query',
+ 'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => 'EE338D98-9BD3-4413-B165'],
+ ],
+ [
+ 'name' => 'ServicerName',
+ 'in' => 'query',
+ 'schema' => ['description' => '坐席名称。', 'type' => 'string', 'required' => false, 'example' => '刘测试'],
+ ],
+ [
+ 'name' => 'ServicerId',
+ 'in' => 'query',
+ 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'example' => '555555'],
+ ],
+ [
+ 'name' => 'Params',
+ 'in' => 'query',
+ 'schema' => ['description' => '扩展参数。', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'CallResult',
'in' => 'query',
'schema' => [
- 'title' => '任务id',
- 'description' => '任务ID。'."\n"
+ 'description' => '呼叫结果。取值：'."\n"
."\n"
- .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123456',
+ .'- **normal**：正常挂机。'."\n"
+ .'- **touchRouteError**：队列挂机。'."\n"
+ .'- **touchInQueue**：队列挂机。'."\n"
+ .'- **touchInLoss**：队列挂机。'."\n"
+ .'- **userHangup**：用户挂机，IVR挂机。'."\n"
+ .'- **sysHangup**：系统挂机，IVR挂机。'."\n"
+ .'- **transferAgent**：用户挂机，IVR挂机。'."\n"
+ .'- **dailing**：客服挂机，振铃挂机。'."\n"
+ .'- **TouchRingCallLoss**：队列挂机，振铃挂机。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'normal',
+ 'enum' => ['normal', 'queueClose', 'dailingClose', 'ivrClose'],
],
],
[
- 'name' => 'BatchVersion',
+ 'name' => 'Id',
'in' => 'query',
+ 'schema' => ['description' => '通话详情全局唯一ID。', 'type' => 'string', 'required' => false, 'example' => 'acc1c58dab4a4****0e3813c66'],
+ ],
+ [
+ 'name' => 'AcidList',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '任务批次',
- 'description' => '任务批次。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '会话ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '入呼后，websocket中的acid。', 'type' => 'string', 'required' => false, 'example' => '7719786'],
'required' => false,
- 'example' => '1',
+ 'maxItems' => 200,
],
],
[
- 'name' => 'PhoneNum',
+ 'name' => 'CallTypeList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '手机号',
- 'description' => '外呼号码。',
- 'type' => 'string',
+ 'description' => '呼叫类型列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '呼叫类型。取值：'."\n"
+ .'- **1**：外呼。'."\n"
+ .'- **2**：入呼。'."\n"
+ .'- **3**：转交。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
'required' => false,
- 'example' => '150****000',
+ 'maxItems' => 5,
],
],
[
- 'name' => 'CaseStatus',
+ 'name' => 'GroupIdList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '单条号码任务执行状态（1：待呼叫，2:呼叫中，3:已完成，4:已终止，5:待重呼）',
- 'description' => '单条号码任务执行状态。取值：'."\n"
- ."\n"
- .'- **1**：待呼叫。'."\n"
- .'- **2**：呼叫中。'."\n"
- .'- **3**：已完成。'."\n"
- .'- **4**：已终止。'."\n"
- .'- **5**：待重呼。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '技能组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
'required' => false,
- 'example' => '1',
+ 'maxItems' => 200,
],
],
[
- 'name' => 'CreateTimeStart',
+ 'name' => 'CallingNumberList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '号码导入起始时间戳（毫秒）',
- 'description' => '号码导入起始时间。时间戳格式，单位戳：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '主叫号码列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '主叫号码。', 'type' => 'string', 'required' => false, 'example' => '0571773****'],
'required' => false,
- 'example' => '1632289999000',
+ 'maxItems' => 200,
],
],
[
- 'name' => 'CreateTimeEnd',
+ 'name' => 'CalledNumberList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '号码导入结束时间戳（毫秒）',
- 'description' => '号码导入结束时间。时间戳格式，单位戳：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '被叫号码列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '被叫号码。', 'type' => 'string', 'required' => false, 'example' => '135615****'],
'required' => false,
- 'example' => '1632290119000',
+ 'maxItems' => 200,
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'MemberIdList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '分页大小（<=50）',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '50',
- 'minimum' => '1',
- 'example' => '10',
+ 'description' => '会员列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '会员ID。', 'type' => 'string', 'required' => false, 'example' => '7856876'],
+ 'required' => false,
+ 'maxItems' => 200,
],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'ServicerIdList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '当前页数',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
+ 'description' => '坐席列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'example' => '555555'],
+ 'required' => false,
+ 'maxItems' => 200,
],
],
[
- 'name' => 'CaseId',
+ 'name' => 'CallResultList',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'title' => '单条外呼id',
- 'description' => '本次外呼关联的活动ID。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '呼叫结果列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '呼叫结果。取值： '."\n"
+ ."\n"
+ .'- **normal**：正常通话结束 。'."\n"
+ .'- **queueClose**： 队列挂机 。'."\n"
+ .'- **dailingClose**：振铃挂机 。'."\n"
+ .'- **ivrClose**：IVR挂机。', 'type' => 'string', 'required' => false, 'example' => 'normal'],
'required' => false,
- 'example' => '123456',
+ 'maxItems' => 200,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE339D98-9BD3-4413-B165'],
'Data' => [
- 'title' => '任务执行列表',
- 'description' => '任务执行列表。',
+ 'description' => '通话数据。',
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'title' => '分页大小',
- 'description' => '分页大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'CurrentPage' => [
- 'title' => '当前页数',
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalResults' => [
- 'title' => '总数',
- 'description' => '任务总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '199',
- ],
- 'List' => [
- 'title' => '外呼号码执行列表',
- 'description' => '外呼号码执行列表。',
+ 'TotalCount' => ['description' => '总共记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '26'],
+ 'PageSize' => ['description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNumber' => ['description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'CallDetailRecord' => [
+ 'description' => '通话记录。',
'type' => 'array',
'items' => [
- 'description' => '外呼号码详情。',
+ 'description' => '通话记录信息。',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'title' => '执行状态（1：待呼叫，2:呼叫中，3:已完成，4:已终止，5:待重呼）',
- 'description' => '执行状态。取值：'."\n"
- ."\n"
- .'- **1**：待呼叫。'."\n"
- .'- **2**：呼叫中。'."\n"
- .'- **3**：已完成。'."\n"
- .'- **4**：已终止。'."\n"
- .'- **5**：待重呼。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'StatusDesc' => [
- 'title' => '执行状态描述',
- 'description' => '执行状态描述。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '待呼叫',
- ],
- 'BizData' => [
- 'title' => '业务自定义信息',
- 'description' => '业务自定义信息',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'BatchVersion' => [
- 'title' => '任务批次',
- 'description' => '任务批次。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PhoneNum' => [
- 'title' => '手机号',
- 'description' => '外呼号码。',
- 'type' => 'string',
- 'example' => '150****0000',
- ],
- 'LastCallResult' => [
- 'title' => '最后一次外呼结果',
- 'description' => '最后一次外呼结果。',
- 'type' => 'string',
- 'example' => '未接通',
- ],
- 'CreateTime' => [
- 'title' => '号码导入时间戳（毫秒）',
- 'description' => '号码导入时间。时间戳格式，单位戳：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1632289999000',
- ],
- 'CaseId' => [
- 'title' => 'id',
- 'description' => '本次外呼关联的活动ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'CallCount' => [
- 'title' => '外呼次数',
- 'description' => '外呼次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'GroupName' => ['description' => '技能组名称。'."\n"
+ .'> 当CallType取值为**1**时，外呼场景无技能组信息。', 'type' => 'string', 'example' => '自动化技能组'],
+ 'CallResult' => ['description' => '呼叫结果。取值：'."\n"
+ ."\n"
+ .'- **normal**：正常挂机。'."\n"
+ .'- **touchRouteError**：队列挂机。'."\n"
+ .'- **touchInQueue**：队列挂机。'."\n"
+ .'- **touchInLoss**：队列挂机。'."\n"
+ .'- **userHangup**：用户挂机，IVR挂机。'."\n"
+ .'- **sysHangup**：系统挂机，IVR挂机。'."\n"
+ .'- **transferAgent**：用户挂机，IVR挂机。'."\n"
+ .'- **dailing**：客服挂机，振铃挂机。'."\n"
+ .'- **TouchRingCallLoss**：队列挂机，振铃挂机。', 'type' => 'string', 'example' => 'normal'],
+ 'CalledNumber' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '135615*****'],
+ 'Acid' => ['description' => '会话ID。入呼后，websocket中的acid。', 'type' => 'string', 'example' => '7719786'],
+ 'CallType' => ['description' => '呼叫类型。取值：'."\n"
+ .'- **1**：外呼'."\n"
+ .'- **2**：入呼'."\n"
+ .'- **3**：转交', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'QueueUpContinueTime' => ['description' => '排队时长。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'PassiveTransferId' => ['description' => '坐席ID。转交电话号码。'."\n"
+ .'> 非转交场景数据为Null。', 'type' => 'string', 'example' => '12'],
+ 'CallingNumber' => ['description' => '发起方号码。例如用户手机号码、客服坐席号码、机器号码等。', 'type' => 'string', 'example' => '0571773'],
+ 'MemberId' => ['description' => '会员ID。', 'type' => 'string', 'example' => '7856876'],
+ 'ServicerName' => ['description' => '坐席名称。'."\n"
+ .'> 呼入场景未分配到到坐席之前无坐席信息。', 'type' => 'string', 'example' => '刘测试'],
+ 'OutQueueTime' => ['description' => '热线分配出队时间。'."\n"
+ ."\n"
+ .'> 外呼场景无出队时间。', 'type' => 'string', 'example' => '2020-10-02 22:32:59'],
+ 'RingEndTime' => ['description' => '振铃结束时间。'."\n"
+ ."\n"
+ .'> 外呼场景无振铃结束时间。', 'type' => 'string', 'example' => '2020-10-02 22:33:09'],
+ 'PickUpTime' => ['description' => '接起时间。', 'type' => 'string', 'example' => '2020-10-02 22:33:09'],
+ 'EvaluationLevel' => ['description' => '满意度，评价星级。取值：'."\n"
+ ."\n"
+ .'- **2**：二级满意度'."\n"
+ .'- **3**：三级满意度'."\n"
+ .'- **4**：四级满意度'."\n"
+ .'- **5**：五级满意度'."\n"
+ ."\n"
+ .'> 外呼场景和未接通场景无数据。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'RingContinueTime' => ['description' => '振铃时长。单位：秒。'."\n"
+ ."\n"
+ .'> 外呼场景无振铃时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PassiveTransferIdType' => ['description' => '会话被转交方。取值：'."\n"
+ .'- **1**：坐席ID。'."\n"
+ .'- **2**：转交电话号码。'."\n"
+ ."\n"
+ .'> 非转交场景数据为Null', 'type' => 'string', 'example' => '1'],
+ 'EvaluationScore' => ['description' => '满意度-评价得分。取值：'."\n"
+ .'- **1**：非常不满意'."\n"
+ .'- **2**：不满意'."\n"
+ .'- **3**：一般'."\n"
+ .'- **4**：满意'."\n"
+ .'- **5**：非常满意'."\n"
+ ."\n"
+ .'> 外呼场景和未接通场景无数据。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'CreateTime' => ['description' => '通话创建时间。'."\n"
+ ."\n"
+ .'> - 外呼场景为外呼发起时间。'."\n"
+ .'- 入呼场景为通话进入ACC系统时间。', 'type' => 'string', 'example' => '2020-10-02 22:32:55'],
+ 'HangUpTime' => ['description' => '挂断时间。', 'type' => 'string', 'example' => '2020-10-02 22:33:46'],
+ 'GroupId' => ['description' => '技能组ID。'."\n"
+ ."\n"
+ .'> 当CallType取值为**1**时，外呼场景无技能组信息。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
+ 'InQueueTime' => ['description' => '热线分配-入队时间。'."\n"
+ .'> 外呼场景无入队时间。', 'type' => 'string', 'example' => '2020-10-02 22:32:55'],
+ 'RingStartTime' => ['description' => '振铃开始时间。'."\n"
+ ."\n"
+ .'> 外呼场景无振铃开始时间。', 'type' => 'string', 'example' => '2020-10-02 22:32:59'],
+ 'CallContinueTime' => ['description' => '通话时长。单位：秒。'."\n"
+ ."\n"
+ .'> 未接通场景无通话时长。', 'type' => 'integer', 'format' => 'int32', 'example' => '37'],
+ 'ActiveTransferId' => ['description' => '坐席ID。'."\n"
+ .'> 非转交场景数据为Null。', 'type' => 'string', 'example' => '12'],
+ 'HangUpRole' => ['description' => '挂机方。取值：'."\n"
+ ."\n"
+ .'- **1**：系统挂机'."\n"
+ .'- **2**：客户挂机'."\n"
+ .'- **3**：客服挂机'."\n"
+ .'- **null**：未知', 'type' => 'string', 'example' => '2'],
+ 'MemberName' => ['description' => '会员名称。', 'type' => 'string', 'example' => '匿名会员'],
+ 'Id' => ['description' => '通话详情全局唯一ID。', 'type' => 'string', 'example' => 'acc1c58dab4a4dd280e3813c66'],
+ 'ServicerId' => ['description' => '坐席ID。'."\n"
+ .'> 呼入场景未分配到到坐席之前无坐席信息。', 'type' => 'string', 'example' => '555555'],
+ 'TrunkCall' => ['description' => '长途电话。', 'type' => 'string', 'example' => '1861111****'],
],
],
],
- 'HasNextPage' => [
- 'title' => '是否有下一页',
- 'description' => '是否有下一页。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口是否调用成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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' => '获取任务执行详情',
- 'description' => '任务执行详情包含任务总数、任务批次、外呼号码及对应的外呼次数、执行状态等信息。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '批量查询通话详情',
+ 'summary' => '根据实例ID查询通话详情。',
+ 'description' => '通话详情包含总共记录数、呼叫结果、坐席名称、通话时间等信息。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：80次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GetAiOutboundTaskDetail' => [
- 'summary' => '根据实例ID、任务ID获取外呼任务详情。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'ImportOneTaskPhoneNumber' => [
+ 'summary' => '导入单个号码数据。',
+ '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' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_***',
- ],
+ 'schema' => ['description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1231231212****'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'OutId',
'in' => 'query',
- 'schema' => [
- 'title' => '任务id',
- 'description' => '任务ID。'."\n"
- ."\n"
- .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123456',
- ],
+ 'schema' => ['description' => '外部流水号，建议使用唯一ID。不能超过128个字符。', 'type' => 'string', 'required' => false, 'example' => '94ba739b-xxxx-ef91-335d-4be006c34899'],
+ ],
+ [
+ 'name' => 'PhoneNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '被叫手机号。', 'type' => 'string', 'required' => true, 'example' => '180******'],
+ ],
+ [
+ 'name' => 'Variables',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => ['description' => '变量列表。Map格式。'."\n"
+ .'> 引擎呼叫任务变量格式'."\n"
+ .'> - {"startWordParam.变量key1":"变量值1","promptParam.变量key2":"变量值2","bizParam.变量key3":"变量值3"}', 'type' => 'object', 'required' => false, 'example' => '{"变量key1":"变量值1","变量key2":"变量值2"}'."\n"
+ .'引擎呼叫任务示例值请看左侧描述'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D'],
'Data' => [
- 'title' => '任务详情',
- 'description' => '外呼任务详情。',
+ 'description' => '返回结果',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'title' => '任务状态（0:未开始,1:进行中,2:系统暂停,3:手动暂停,4:已完成,5:已终止）',
- 'description' => '任务状态。取值：'."\n"
- ."\n"
- .'- **0**：未开始。'."\n"
- .'- **1**：进行中。'."\n"
- .'- **2**：系统暂停。'."\n"
- .'- **3**：手动暂停。'."\n"
- .'- **4**：已完成。'."\n"
- .'- **5**：已终止。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'HandlerId' => [
- 'title' => '技能组id（预测式外呼）或者ivr id（自动外呼）',
- 'description' => '技能组ID（预测式外呼）或IVR ID（自动外呼）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'TaskId' => [
- 'title' => '任务id',
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123',
- ],
- 'Description' => [
- 'title' => '任务描述',
- 'description' => '任务描述。',
- 'type' => 'string',
- 'example' => '房产销售',
- ],
- 'Name' => [
- 'title' => '任务名',
- 'description' => '任务名称。',
- 'type' => 'string',
- 'example' => 'xxxxx外呼',
- ],
- 'StatusDesc' => [
- 'title' => '任务状态描述',
- 'description' => '任务状态描述。',
- 'type' => 'string',
- 'example' => '未开始',
- ],
- 'ExecutionTime' => [
- 'title' => '任务执行时间',
- 'description' => '任务执行时间。',
- 'type' => 'string',
- '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"}]}',
- ],
- 'Type' => [
- 'title' => '任务类型(2:预测式外呼，3:自动外呼)',
- 'description' => '任务类型。取值：'."\n"
- ."\n"
- .'- **2**：预测式外呼。'."\n"
- .'- **3**：自动外呼。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'ConcurrentRate' => [
- 'title' => '自动外呼的并发',
- 'description' => '自动外呼的并发。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'NumRepeated' => [
- 'title' => '被叫号码重复策略（0去重，1不去重）',
- 'description' => '被叫号码重复策略。'."\n"
- ."\n"
- .'- **0**：去重。'."\n"
- .'- **1**：不去重。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'OutboundNums' => [
- 'title' => '外呼主叫号码',
- 'description' => '外呼主叫号码。',
- 'type' => 'array',
- 'items' => [
- 'description' => '外呼主叫号码。',
- 'type' => 'string',
- 'example' => '150****0000',
- ],
- ],
- 'RecallRule' => [
- 'title' => '失败重呼策略',
- 'description' => '失败重呼策略。',
- 'type' => 'object',
- 'properties' => [
- 'Count' => [
- 'title' => '重呼次数',
- 'description' => '重呼次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Interval' => [
- 'title' => '重呼间隔时间（分钟）',
- 'description' => '重呼间隔时间。单位：分钟。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- ],
- ],
- 'HandlerName' => [
- 'title' => '技能组名称或ivr名称',
- 'description' => '技能组名称或IVR名称。',
- 'type' => 'string',
- 'example' => '热线技能组',
- ],
- 'ForecastCallRate' => [
- 'title' => '预测式外呼固定外呼比例',
- 'description' => '预测式外呼固定外呼比例。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '1.2',
- ],
+ 'DetailId' => ['description' => '任务明细ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '92304322323*****'],
],
+ 'example' => '',
],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口是否调用成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- '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' => '获取外呼任务详情',
- 'description' => '外呼任务详情包含任务ID、任务状态、任务类型、外呼主叫号码、被叫号码重复策略等信息，具体参见[返回参数](#api-detail-40)。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'UpdateAiOutboundTask' => [
- 'summary' => '根据实例ID、任务ID更新外呼任务。',
- 'methods' => [
- 'post',
+ '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' => '导入单个号码数据',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aiccs:',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ImportTaskNumberDatas' => [
+ 'summary' => '呼叫任务导入被叫数据。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '268865',
+ 'abilityTreeNodes' => ['FEATUREaiccsTY5M4L'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'OssFileName',
'in' => 'query',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_***',
- ],
+ 'schema' => ['description' => 'OSS文件路径，非必填。'."\n"
+ .'> API调用暂时不支持Excel数据类型。因此上传OSS文件路径的方式暂不可用。', 'type' => 'string', 'required' => false, 'example' => '123dsdfsdfsdf.xlsx'],
],
[
'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'title' => '任务id',
- 'description' => '任务ID。'."\n"
- ."\n"
- .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123',
- ],
- ],
- [
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务名（1～15字符）',
- 'description' => '任务名称。1～15字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx外呼',
- 'maxLength' => 15,
- 'minLength' => 1,
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务描述（0～100字符）',
- 'description' => '任务描述。0～100字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '房产销售',
- 'maxLength' => 100,
- ],
+ 'schema' => ['description' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => '119181071278******'],
],
[
- 'name' => 'OutboundNums',
- 'in' => 'query',
+ 'name' => 'PhoneNumberList',
+ 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '外呼主叫号码',
- 'description' => '外呼主叫号码。',
+ 'description' => '如果DataType采用JSON列表，则需要通过该字段上传数据，且单次不能超过1000条。',
'type' => 'array',
- 'items' => [
- 'description' => '外呼主叫号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '150****0000',
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'NumRepeated',
- 'in' => 'query',
- 'schema' => [
- 'title' => '被叫号码重复策略（0:任务内去重，1:任务内不去重）',
- 'description' => '被叫号码重复策略。'."\n"
- .'- **0**：任务内去重。'."\n"
- .'- **1**：任务内不去重。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- 'enum' => [
- '0',
- '1',
- ],
- ],
- ],
- [
- 'name' => 'HandlerId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '技能组id（预测式外呼）或者ivr id（自动外呼）',
- 'description' => '技能组ID（预测式外呼）或者IVR ID（自动外呼）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123',
+ 'items' => ['description' => '数据结构如下：'."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "calleeNumber":"被叫号码",'."\n"
+ .' "outId":"保留key，该字段可用于携带外部流水唯一ID，回执内容中会将该字段携带回来，可以用这个作为唯一呼叫记录，方便关联回执，限制长度128",'."\n"
+ .' "variable1":"value",'."\n"
+ .' "variable2":"value",//如果智能体中有用到通话变量，则这里variable1、variable2代表每个变量的key，value就是变量的值。'."\n"
+ .' }'."\n"
+ .'```'."\n"
+ .'> 通话变量在[**通信智能体管理**](https://aiccs.console.aliyun.com/agent/customize)>**详情**>**通话变量配置**界面查看。'."\n"
+ .'> 引擎呼叫任务通话变量配置示例：'."\n"
+ .'{'."\n"
+ .' "calleeNumber": "被叫号码",'."\n"
+ .' "outId": "",'."\n"
+ .' "startWordParam.变量key1": "xxx",'."\n"
+ .' "promptParam.变量key2": "xx",'."\n"
+ .' "bizParam.变量 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"
+ .'引擎通话任务通话变量配置示例请看描述中说明'],
+ 'required' => false,
],
],
[
- 'name' => 'ExecutionTime',
+ 'name' => 'DataType',
'in' => 'query',
'schema' => [
- 'title' => '任务执行时间',
- 'description' => '任务执行时间。'."\n"
- ."\n"
- .'> 结束时间（end）需晚于开始时间（start）。',
+ 'description' => '数据类型。取值：'."\n"
+ .'- EXCEL'."\n"
+ .'- JSON'."\n"
+ .'><notice>API调用暂时仅支持JSON数据类型。></notice>',
'type' => 'string',
'required' => true,
- '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"}]}',
- ],
- ],
- [
- 'name' => 'ConcurrentRate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '自动外呼的并发',
- 'description' => '自动外呼的并发。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'RecallRule',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '失败重呼策略',
- 'description' => '失败重呼策略。'."\n"
- ."\n"
- .'> 为空则外呼失败时不重呼。',
- 'type' => 'object',
- 'properties' => [
- 'Count' => [
- 'title' => '失败重呼次数（1～3次）',
- 'description' => '失败重呼次数。取值范围：**1～3**次。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '3',
- 'minimum' => '1',
- 'example' => '2',
- ],
- 'Interval' => [
- 'title' => '失败重呼间隔时间（1～60分钟）',
- 'description' => '失败重呼间隔时间。取值范围：**1～60**，单位：分钟。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '60',
- 'minimum' => '1',
- 'example' => '5',
- ],
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'ForecastCallRate',
- 'in' => 'query',
- 'schema' => [
- 'title' => '预测式外呼固定外呼比例（>=1）',
- 'description' => '预测式外呼固定外呼比例。取值范围：**≥1**。',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '1.2',
+ 'enumValueTitles' => [],
+ 'example' => 'JSON',
+ 'enum' => ['EXCEL', 'JSON'],
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- 'Success' => [
- 'description' => '调用接口是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CFC2F07E-F763-7C48-1A32-6EFFB6EA344E'],
+ 'Data' => ['description' => '导入批次ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123497836486******'."\n"],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- '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' => '更新外呼任务',
- 'description' => '此接口支持更新任务名称、任务描述、外呼主叫号码、技能组ID等信息，具体参见[请求参数](#api-detail-35)。'."\n"
+ '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' => '导入被叫数据',
+ 'description' => '- 您可调用此接口导入被叫数据，也可在**呼叫任务管理**界面单击导入被叫数据，下载模板并上传文件的方式导入被叫数据。'."\n"
."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：20次/秒。'."\n"
+ .'- 此接口在导入被叫数据时，暂仅支持JSON数据类型导入。'."\n"
."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ .'- 在调用此接口之前，请确保您已有创建成功的呼叫任务。'."\n"
+ ."\n"
+ .'- 若您没有已创建成功的呼叫任务，可在**呼叫任务管理**界面点击创建呼叫任务或通过[CreateAiCallTask](~~2926796~~)接口创建呼叫任务。',
+ 'changeSet' => [
+ ['createdAt' => '2026-02-02T07:39:07.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2026-02-02T07:38:45.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2026-02-02T07:38:42.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportTaskNumberDatas'],
+ ],
+ ],
+ 'ramActions' => [],
],
'InsertAiOutboundPhoneNums' => [
'summary' => '根据实例ID、任务ID导入外呼被叫号码。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -19850,53 +11479,27 @@
],
'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' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_***',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。'."\n", 'type' => 'string', 'required' => true, 'example' => 'agent_***'],
],
[
'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'title' => '任务id',
- 'description' => '任务ID。'."\n"
- ."\n"
- .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123',
- ],
+ 'schema' => ['title' => '任务id', 'description' => '任务ID。'."\n"
+ ."\n"
+ .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'],
],
[
'name' => 'BatchVersion',
'in' => 'query',
- 'schema' => [
- 'title' => '任务批次号（不填则导入到默认批次）',
- 'description' => '任务批次号。'."\n"
- ."\n"
- .'> 不填则导入到默认批次。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['title' => '任务批次号（不填则导入到默认批次）', 'description' => '任务批次号。'."\n"
+ ."\n"
+ .'> 不填则导入到默认批次。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'Details',
@@ -19911,20 +11514,8 @@
'description' => '号码详情。',
'type' => 'object',
'properties' => [
- 'BizData' => [
- 'title' => '自定义信息',
- 'description' => '业务自定义信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- 'PhoneNum' => [
- 'title' => '手机号',
- 'description' => '外呼被叫号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '150****0000',
- ],
+ 'BizData' => ['title' => '自定义信息', 'description' => '业务自定义信息。', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ 'PhoneNum' => ['title' => '手机号', 'description' => '外呼被叫号码。', 'type' => 'string', 'required' => false, 'example' => '150****0000'],
],
'required' => false,
],
@@ -19939,36 +11530,15 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'title' => '导入结果',
'description' => '导入结果。',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'title' => '导入总数',
- 'description' => '导入总数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'SuccessCount' => [
- 'title' => '导入成功数量',
- 'description' => '导入成功数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '7',
- ],
+ 'TotalCount' => ['title' => '导入总数', 'description' => '导入总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'SuccessCount' => ['title' => '导入成功数量', 'description' => '导入成功数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
'FailInfo' => [
'title' => '失败号码详情',
'description' => '失败号码详情。',
@@ -19977,48 +11547,23 @@
'description' => '失败号码详情。',
'type' => 'object',
'properties' => [
- 'Msg' => [
- 'title' => '失败原因描述',
- 'description' => '失败原因描述。',
- 'type' => 'string',
- 'example' => '号码格式异常',
- ],
- 'BizData' => [
- 'title' => '自定义信息',
- 'description' => '业务自定义信息。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'PhoneNum' => [
- 'title' => '外呼被叫号码',
- 'description' => '外呼被叫号码。',
- 'type' => 'string',
- 'example' => '150****0000',
- ],
+ 'Msg' => ['title' => '失败原因描述', 'description' => '失败原因描述。', 'type' => 'string', 'example' => '号码格式异常'],
+ 'BizData' => ['title' => '自定义信息', 'description' => '业务自定义信息。', 'type' => 'string', 'example' => 'xxxx'],
+ 'PhoneNum' => ['title' => '外呼被叫号码', 'description' => '外呼被叫号码。', 'type' => 'string', 'example' => '150****0000'],
],
],
],
],
],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口是否调用成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口是否调用成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'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' => '导入外呼被叫号码',
'description' => '- 导入外呼被叫号码后，外呼任务才可以正常外呼。'."\n"
@@ -20029,898 +11574,261 @@
.'- API频率：50次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GetAiOutboundTaskProgress' => [
- 'summary' => '根据实例ID、任务ID获取外呼任务进展。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InsertAiOutboundPhoneNums'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'InsertTaskDetail' => [
+ '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' => 'OutboundTaskId',
'in' => 'query',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_***',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'CallInfos',
'in' => 'query',
- 'schema' => [
- 'title' => '任务id',
- 'description' => '任务ID。'."\n"
- ."\n"
- .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123456',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- 'name' => 'BatchVersion',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '任务批次（为空则查询任务下所有数据）',
- 'description' => '任务批次。'."\n"
- ."\n"
- .'> 为空则查询任务下所有数据。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- 'Data' => [
- 'title' => '任务进展',
- 'description' => '任务进展。',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => '任务类型（2:预测式3:自动）',
- 'description' => '任务类型。取值：'."\n"
- .'- **2**：预测式。'."\n"
- .'- **3**：自动。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'TaskId' => [
- 'title' => '任务id',
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'CalloutProgress' => [
- 'title' => '外呼维度进展',
- 'description' => '外呼维度进展。',
- 'type' => 'object',
- 'properties' => [
- 'CallOutCount' => [
- 'title' => '外呼次数',
- 'description' => '外呼次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'CallOutConnectCount' => [
- 'title' => '外呼接通次数（自动外呼特有）',
- 'description' => '外呼接通次数。'."\n"
- .'> 自动外呼特有参数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'CallOutUserPickupCount' => [
- 'title' => '客户接起量（预测式外呼特有）',
- 'description' => '客户接起量。'."\n"
- .'> 预测式外呼特有参数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'CallOutUserPickupRate' => [
- 'title' => '客户接起率（预测式外呼特有）',
- 'description' => '客户接起率。'."\n"
- .'> 预测式外呼特有参数。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.5',
- ],
- 'CallLossRate' => [
- 'title' => '呼损率（预测式外呼特有）',
- 'description' => '呼损率。'."\n"
- .'> 预测式外呼特有参数。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.01',
- ],
- 'CallOutConnectRate' => [
- 'title' => '外呼接通次率（自动外呼特有）',
- 'description' => '外呼接通次率。'."\n"
- .'> 自动外呼特有参数。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.5',
- ],
- 'CallOutServicerPickupCount' => [
- 'title' => '坐席接通量（预测式外呼特有）',
- 'description' => '坐席接通量。'."\n"
- .'> 预测式外呼特有参数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'CallLossCount' => [
- 'title' => '呼损量（预测式外呼特有）',
- 'description' => '呼损量。'."\n"
- .'> 预测式外呼特有参数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CallOutServicerPickupRate' => [
- 'title' => '坐席接通率（预测式外呼特有）',
- 'description' => '坐席接通率。'."\n"
- .'> 预测式外呼特有参数。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.4',
- ],
- ],
- ],
- 'TaskProgress' => [
- 'title' => '任务维度进展',
- 'description' => '任务维度进展。',
- 'type' => 'object',
- 'properties' => [
- 'FinishRate' => [
- 'title' => '任务完成率',
- 'description' => '任务完成率。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.20',
- ],
- 'ConnectRate' => [
- 'title' => '任务接通率（自动外呼特有）',
- 'description' => '任务接通率。'."\n"
- .'> 自动外呼特有参数。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.2',
- ],
- 'WaitingCallCount' => [
- 'title' => '待呼叫任务数',
- 'description' => '待呼叫任务数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'FinishCount' => [
- 'title' => '任务完成数',
- 'description' => '任务完成数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'ConnectCount' => [
- 'title' => '任务接通量（自动外呼特有）',
- 'description' => '任务接通量。'."\n"
- ."\n"
- .'> 自动外呼特有参数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'TotalCount' => [
- 'title' => '总任务数',
- 'description' => '总任务数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'WaitingRecallCount' => [
- 'title' => '待重呼任务数',
- 'description' => '待重呼任务数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'TerminateCount' => [
- 'title' => '已终止任务数',
- 'description' => '已终止任务数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'ServicerPickupCount' => [
- 'title' => '坐席接通数（预测式外呼特有）',
- 'description' => '坐席接通数。'."\n"
- ."\n"
- .'> 预测式外呼特有参数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'UserPickupCount' => [
- 'title' => '客户接起数（预测式外呼特有）',
- 'description' => '客户接起数。'."\n"
- ."\n"
- .'> 预测式外呼特有参数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'CallingCount' => [
- 'title' => '呼叫中任务数',
- 'description' => '呼叫中任务数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'ServicerPickupRate' => [
- 'title' => '坐席接通率(预测式外呼特有）',
- 'description' => '坐席接通率。'."\n"
- ."\n"
- .'> 预测式外呼特有参数。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.2',
- ],
- 'UserPickupRate' => [
- 'title' => '客户接起率（预测式外呼特有）',
- 'description' => '客户接起率。'."\n"
- .'> 预测式外呼特有参数。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.2',
- ],
- ],
- ],
- ],
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'ok',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'Data' => ['type' => 'string'],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
],
- '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' => '获取外呼任务进展',
- 'description' => '- 调用此接口前，建议您确认实例ID、任务ID信息，具体请参见[请求参数](#api-detail-35)。'."\n"
- .'- 外呼任务进展包括任务ID、任务类型、任务完成率、坐席接通率、客户接通率等信息，具体参见[返回参数](#api-detail-40)。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'StopAiOutboundTask' => [
- 'summary' => '根据实例ID、任务ID暂停外呼任务。',
- 'methods' => [
- 'get',
- '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\\": true\\n}","type":"json"}]',
+ ],
+ 'JoinThirdCall' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
+ [
+ 'BearerToken' => [],
+ ],
],
'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' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '客户请求唯一id，用于幂等校验，可以用uuid生成', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
+ ],
+ [
'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_***',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'AICCS实例ID，在智能联络中心控制台上可以看到', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'TaskId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务id',
- 'description' => '任务ID。'."\n"
- ."\n"
- .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123456',
- ],
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '坐席账号名称（坐席登录名）', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ [
+ 'name' => 'CallId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的acid', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786'],
],
- ],
- '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' => '暂停外呼任务',
- 'description' => '暂停外呼任务后，若需要重新启动外呼任务，可调用[StartAiOutboundTask](~~2718027~~)接口。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：20次/秒。'."\n"
- .'- API频率：20次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'TerminateAiOutboundTask' => [
- 'summary' => '根据实例ID、任务ID终止外呼任务。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'JobId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的jobId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787'],
],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实例id',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_****',
- ],
+ 'name' => 'ConnectionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的connId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788'],
],
[
- 'name' => 'TaskId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务id',
- 'description' => '任务ID。'."\n"
- ."\n"
- .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1763****',
- ],
+ 'name' => 'HoldConnectionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '入呼后，websocket中的holdConnId（ 仅在双步转时传入）', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回数据。',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '错误描述', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID，用于跟踪错误原因', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Code' => ['description' => '错误编码', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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' => '终止外呼任务',
- 'description' => '- 此接口支持终止外呼任务，终止后，任务无法重新启动。'."\n"
- .'- 若需要暂时停止外呼任务，可调用[StopAiOutboundTask](~~2718024~~)接口。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：20次/秒。'."\n"
- .'- API频率：20次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GetAiOutboundTaskList' => [
- 'summary' => '根据实例ID、任务类型获取外呼任务列表。',
- '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' => '[{"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":""}]',
+ 'title' => '加入三方通话',
+ 'summary' => '将第三方加入到通话中。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'ListAgentBySkillGroupId' => [
+ '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' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_****',
- ],
- ],
- [
- 'name' => 'Type',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务类型(2:预测式外呼，3:自动外呼)',
- 'description' => '任务类型。取值：'."\n"
- ."\n"
- .'- **2**：预测式外呼。'."\n"
- .'- **3**：自动外呼。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '2',
- ],
- ],
- [
- 'name' => 'CreateTimeStart',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务创建起始时间戳（毫秒）',
- 'description' => '任务创建起始时间。时间戳格式，单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1615083365000',
- ],
- ],
- [
- 'name' => 'CreateTimeEnd',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务创建截止时间戳（毫秒）',
- 'description' => '任务创建截止时间。时间戳格式，单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1617761765000',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务状态（0:未开始,1:进行中,2:系统暂停,3:手动暂停,4:已完成,5:已终止）',
- 'description' => '任务状态。取值：'."\n"
- ."\n"
- .'- **0**：未开始。'."\n"
- .'- **1**：进行中。'."\n"
- .'- **2**：系统暂停。'."\n"
- .'- **3**：手动暂停。'."\n"
- .'- **4**：已完成。'."\n"
- .'- **5**：已终止。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'title' => '分页大小(<=50)',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '50',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => ' '."\n"
+ .'客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '查询第几页',
- 'description' => '查询第几页。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'SearchKey',
+ 'name' => 'SkillGroupId',
'in' => 'query',
- 'schema' => [
- 'title' => '过滤条件：匹配任务ID或者模糊匹配任务名',
- 'description' => '过滤条件。'."\n"
- ."\n"
- .'> 匹配任务ID或模糊匹配任务名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1763****',
- ],
+ 'schema' => ['description' => '技能组ID。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '666666'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回数据。',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求id',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
'Data' => [
- 'title' => '任务列表',
- 'description' => '任务列表。',
- 'type' => 'object',
- 'properties' => [
- 'PageSize' => [
- 'title' => '分页大小',
- 'description' => '分页大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'CurrentPage' => [
- 'title' => '当前页数',
- 'description' => '当前页数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalResults' => [
- 'title' => '数据总量',
- 'description' => '数据总量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'List' => [
- 'title' => '任务信息',
- 'description' => '任务信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '任务信息。',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'title' => '任务状态（0:未开始,1:进行中,2:系统暂停,3:手动暂停,4:已完成,5:已终止）',
- 'description' => '任务状态。取值：'."\n"
- ."\n"
- .'- **0**：未开始。'."\n"
- .'- **1**：进行中。'."\n"
- .'- **2**：系统暂停。'."\n"
- .'- **3**：手动暂停。'."\n"
- .'- **4**：已完成。'."\n"
- .'- **5**：已终止。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'FinishRate' => [
- 'title' => '任务完成率',
- 'description' => '任务完成率。',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.7',
- ],
- 'StatusDesc' => [
- 'title' => '任务状态描述',
- 'description' => '任务状态描述。',
- 'type' => 'string',
- 'example' => '未开始',
- ],
- 'HandlerId' => [
- 'title' => '技能组id（预测式）或者ivr id（自动外呼）',
- 'description' => '技能组ID（预测式）或者IVR ID（自动外呼）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2468****',
- ],
- 'ConcurrentRate' => [
- 'title' => '自动外呼的并发',
- 'description' => '外呼并发。'."\n"
- ."\n"
- .'> 自动外呼特有参数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'title' => '任务总量',
- 'description' => '任务总量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'TaskId' => [
- 'title' => '任务id',
- 'description' => '任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1763****',
- ],
- 'Description' => [
- 'title' => '任务描述',
- 'description' => '任务描述。',
- 'type' => 'string',
- 'example' => '房产销售',
- ],
- 'CreateTime' => [
- 'title' => '任务创建时间毫秒时间戳',
- 'description' => '任务创建截止时间。时间戳格式，单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1615083365000',
- ],
- 'FinishCount' => [
- 'title' => '任务已完成量',
- 'description' => '任务已完成量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '70',
- ],
- 'HandlerName' => [
- 'title' => '技能组名称或ivr名称',
- 'description' => '技能组名称或IVR名称。',
- 'type' => 'string',
- 'example' => '热线技能组',
- ],
- 'Name' => [
- 'title' => '任务名称',
- 'description' => '任务名称。',
- 'type' => 'string',
- 'example' => 'xxxx外呼任务',
- ],
- ],
- ],
- ],
- 'HasNextPage' => [
- 'title' => '是否有下一页',
- 'description' => '是否有下一页。取值：'."\n"
- ."\n"
- .'- **true**：是。'."\n"
- .'- **false**：否。'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
+ 'description' => '坐席信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => '坐席状态。只有正常的状态，才可进行业务活动。取值：'."\n"
+ .'- **0**：正常'."\n"
+ .'- **1**：冻结'."\n"
+ .'- **2**：删除', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'TenantId' => ['description' => '坐席所属的租户ID。与入参中的实例ID对应。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'DisplayName' => ['description' => '坐席对外显示名称。', 'type' => 'string', 'example' => '刘测试'],
+ 'AgentId' => ['description' => '坐席ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '666666'],
+ 'AccountName' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'example' => 'username@example.com'],
],
],
],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。'."\n", 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 500 => [
+ ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => '没有发现租户实例'],
+ ['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\\": {\\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' => '获取外呼任务列表',
- 'description' => '- 任务列表为任务信息列表，任务信息包含任务ID、任务状态、任务名称、任务完成率等信息，具体参见[返回参数](#api-detail-40)。'."\n"
- .'- 若您需要更新任务信息，可调用[UpdateAiOutboundTask](~~2718021~~)接口。'."\n"
+ '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' => '获取技能组下坐席信息',
+ 'summary' => '根据AICCS实例ID、技能组ID查询悉犀客服工作台坐席列表。',
+ 'description' => '- 调用此接口前，请您确认AICCS的实例信息及技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ .'- 若坐席没有设置所属的技能组，可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)查询坐席信息。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'StartAiOutboundTask' => [
- 'summary' => '根据实例ID、任务ID启动外呼任务。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'ListAiccsRobot' => [
+ 'summary' => '获取机器人话术列表。包含机器人类型、机器人名称、机器人ID、所属业务、行业信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ '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',
+ 'name' => 'RobotName',
'in' => 'query',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_****',
- ],
- ],
- [
- 'name' => 'TaskId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务id',
- 'description' => '任务ID。'."\n"
- ."\n"
- .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1763****',
- ],
+ 'schema' => ['description' => '机器人名称。在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面查看机器人名称。', 'type' => 'string', 'required' => false, 'example' => '测试机器人'],
],
],
'responses' => [
@@ -20930,628 +11838,177 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => [
+ 'description' => '机器人话术。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '话术列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RobotType' => ['description' => '机器人类型。', 'type' => 'string', 'example' => 'CUSTOM'],
+ 'AtSence' => ['description' => '所属业务。', 'type' => 'string', 'example' => '新房销售'],
+ 'AtProfession' => ['description' => '所属行业。', 'type' => 'string', 'example' => '房地产'],
+ 'RobotName' => ['description' => '机器人名称。', 'type' => 'string', 'example' => '测试机器人'],
+ 'Id' => ['description' => '机器人ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12****'],
+ ],
+ ],
],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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\\": \\"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' => '启动外呼任务',
- 'description' => '- 调用此接口，可启动暂停状态的外呼任务。'."\n"
- .'- 终止状态的外呼任务无法再次被启动。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '获取话术列表',
+ 'description' => '- 在调用此接口之前，请确保您已有审核通过的话术。'."\n"
+ ."\n"
+ .'- 若您没有已审核通过的话术，请先在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面添加话术并提交审核。'."\n"
."\n"
.'### QPS限制'."\n"
- .'- 单用户调用频率：20次/秒。'."\n"
- .'- API频率：20次/秒。'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：500次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'AddHotlineNumber' => [
- 'summary' => '调用AddHotlineNumber接口新增热线号码。',
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '实例id',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'HotlineNumber',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '号码',
- 'description' => '热线号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '05710000****',
- 'pattern' => '^\\d+$',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '号码描述',
- 'description' => '号码描述。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '热线号码',
- ],
- ],
- [
- 'name' => 'EnableInbound',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否用于入呼',
- 'description' => '是否用于入呼。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'InboundFlowId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '入呼ivr流程id',
- 'description' => '入呼IVR流程ID。可通过SaaS工作台热线>渠道接入>IVR流程管理页面获取。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456',
- ],
- ],
- [
- 'name' => 'EnableOutbound',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否用于外呼',
- 'description' => '是否用于外呼。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'OutboundAllDepart',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '外呼是否对所有部门生效',
- 'description' => '外呼是否对实例下所有部门生效。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'EnableInboundEvaluation',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否开启入呼满意度',
- 'description' => '是否开启入呼满意度。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'EnableOutboundEvaluation',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否开启外呼满意度',
- 'description' => '是否开启外呼满意度。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'EvaluationLevel',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '满意度等级',
- 'description' => '满意度等级。取值：'."\n"
- ."\n"
- .'- **2**：二级（满意，不满意）'."\n"
- .'- **3**：三级（满意，一般，不满意）'."\n"
- .'- **4**：四级（很满意，满意，一般，不满意）'."\n"
- .'- **5**：五级（很满意，满意，一般，不满意，非常差）',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- 'enum' => [
- '2',
- '3',
- '4',
- '5',
- ],
- ],
- ],
- [
- 'name' => 'OutboundRangeList',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '外呼生效范围',
- 'description' => '外呼生效范围。',
- 'type' => 'array',
- 'items' => [
- 'description' => '外呼生效范围。',
- 'type' => 'object',
- 'properties' => [
- 'GroupIdList' => [
- 'title' => '生效技能组列表（部门123下）',
- 'description' => '生效技能组列表。'."\n"
- .'> 技能组列表为空则对整个部门生效，否则针对部门下指定技能组列表生效。',
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1234',
- ],
- 'required' => false,
- ],
- 'DepartmentId' => [
- 'title' => '生效部门id',
- 'description' => '生效部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE339D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'title' => '接口调用是否成功',
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListAiccsRobot',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- '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' => '新增热线号码',
- 'description' => '> 热线号码仅供呼入、呼出使用。',
],
- 'DeleteHotlineNumber' => [
- 'summary' => '调用DeleteHotlineNumber接口删除配置的热线号码。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListAvailableTts' => [
+ 'summary' => '获取大模型外呼支持的TTS音色列表，包括系统预置音色和个性化音色。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '273987',
+ 'abilityTreeNodes' => ['FEATUREaiccsTY5M4L'],
'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '实例id',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'name' => 'TtsVoiceCode',
+ 'in' => 'query',
+ 'schema' => ['title' => '复刻音色编码', 'description' => '个性化音色编码，在[个性化音色](https://aiccs.console.aliyun.com/engine/voiceprint)界面查看音色编码。', 'type' => 'string', 'required' => false, 'example' => 'V9A******'],
],
[
- 'name' => 'HotlineNumber',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '号码',
- 'description' => '热线号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '05710000****',
- 'pattern' => '^\\d+$',
- ],
+ 'name' => 'VoiceType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'TTS音色类型枚举值。'."\n"
+ ."\n"
+ .'`SYSTEM`-系统音色。'."\n"
+ ."\n"
+ .'`COSYCLONE`-复刻音色。'."\n"
+ ."\n"
+ .'`BL-CUSTOM`-定制精品复刻音色。', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'title' => '接口调用是否成功',
- 'description' => '接口调用是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- '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' => '删除配置的热线号码',
- ],
- 'ResetHotlineNumber' => [
- 'summary' => '调用ResetHotlineNumber接口重置热线号码的呼入（IVR流程）、呼出（生效范围）配置信息。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '实例id',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'HotlineNumber',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '号码',
- 'description' => '热线号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0571********',
- 'pattern' => '^\\d+$',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '号码描述',
- 'description' => '号码描述。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '热线号码',
- ],
- ],
- [
- 'name' => 'EnableInbound',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否用于入呼',
- 'description' => '是否用于入呼。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'InboundFlowId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '入呼ivr流程id',
- 'description' => '入呼IVR流程ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456',
- ],
- ],
- [
- 'name' => 'EnableOutbound',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否用于外呼',
- 'description' => '是否用于外呼。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'OutboundAllDepart',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '外呼是否对所有部门生效',
- 'description' => '外呼是否对所有部门生效。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'EnableInboundEvaluation',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否开启入呼满意度',
- 'description' => '是否开启入呼满意度。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'EnableOutboundEvaluation',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否开启外呼满意度',
- 'description' => '是否开启外呼满意度。',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'EvaluationLevel',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '满意度等级',
- 'description' => '满意度等级。取值：'."\n"
- ."\n"
- .'- **2**：二级（满意，不满意）'."\n"
- .'- **3**：三级（满意，一般，不满意）'."\n"
- .'- **4**：四级（很满意，满意，一般，不满意）'."\n"
- .'- **5**：五级（很满意，满意，一般，不满意，非常差）',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- 'enum' => [
- '2',
- '3',
- '4',
- '5',
- ],
- ],
- ],
- [
- 'name' => 'OutboundRangeList',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '外呼生效范围',
- 'description' => '外呼生效范围。',
- 'type' => 'array',
- 'items' => [
- 'description' => '外呼生效范围。',
- 'type' => 'object',
- 'properties' => [
- 'GroupIdList' => [
- 'title' => '生效技能组列表（部门123下）',
- 'description' => '生效技能组列表。'."\n"
- ."\n"
- .'> 技能组列表为空则对整个部门生效，否则针对部门下指定技能组列表生效。'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456',
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息；只有RAM校验失败才会返回此字段。', 'type' => 'string', 'example' => 'None'],
+ 'RequestId' => ['title' => '', 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', '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' => '音色平台。取值：'."\n"
+ ."\n"
+ .'- CosyVoice：个性化音色或系统预置音色。'."\n"
+ ."\n"
+ .'- Volcano：豆包音色。', 'type' => 'string', 'example' => 'CosyVoice'],
+ 'TtsStyle' => ['title' => '音色cosy类型 cosyvoice-v2-XXXX-XXXX', 'description' => '音色风格。', 'type' => 'string', 'example' => 'cosyvoice-v2-*********-*******'],
+ 'TtsAuditionFileUrl' => ['title' => '音色试听文件', 'description' => '音色试听文件。', 'type' => 'string', 'example' => 'https://*******/longxiaoxia.mp3'],
+ 'TtsVoiceCode' => ['title' => '音色编码', 'description' => '音色编码。', 'type' => 'string', 'example' => 'V9A******'."\n"],
+ 'VoiceType' => ['description' => 'TTS音色类型枚举值。'."\n"
+ ."\n"
+ .'`SYSTEM`-系统音色。'."\n"
+ ."\n"
+ .'`COSYCLONE`-复刻音色。'."\n"
+ ."\n"
+ .'`BL-CUSTOM`-定制精品复刻音色。', 'type' => 'string', 'example' => 'COSYCLONE'],
],
- 'required' => false,
- ],
- 'DepartmentId' => [
- 'title' => '生效部门id',
- 'description' => '生效部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '123456',
+ 'enumValueTitles' => [],
],
+ 'example' => '',
],
- 'required' => false,
+ 'Code' => ['title' => '', 'description' => '状态码。返回OK表示调用成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['title' => '', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
- 'required' => false,
+ 'description' => '',
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'title' => '接口调用是否成功',
- 'description' => '接口调用是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ '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' => '获取大模型呼叫支持的TTS音色列表',
+ 'description' => '若您在[个性化音色](https://aiccs.console.aliyun.com/engine/voiceprint)界面没有已创建且上线的音色，则只能查到系统预置的音色。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListAvailableTts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- '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' => '重置热线号码',
],
- 'QueryHotlineNumber' => [
- 'summary' => '根据实例ID查询热线号码配置列表，支持通过热线号码模糊查询。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListChatRecordDetail' => [
+ 'summary' => '调用ListChatRecordDetail根据时间段查询在线会话详情。',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -21559,307 +12016,123 @@
],
'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' => [
- 'title' => '实例id',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => 'clientToken', 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页码',
- 'description' => '当前页。取值大于**0**，默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['title' => '实例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre***'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'CloseTimeEnd',
'in' => 'query',
- 'schema' => [
- 'title' => '每页大小',
- 'description' => '每页大小。取值大于**0**，默认值：**20**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'maximum' => '20',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['title' => '在线挂断的时间范围', 'description' => '会话结束的时间范围右区间。时间戳格式，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614582000000'],
],
[
- 'name' => 'HotlineNumber',
+ 'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'title' => '号码（支持模糊查询）',
- 'description' => '热线号码。支持模糊查询。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0571****2211',
- ],
+ 'schema' => ['title' => '当前页', 'description' => '当前页。默认为：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
- 'name' => 'DepartmentId',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '部门id（技能组分组）',
- 'description' => '部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2256****',
- ],
+ 'schema' => ['title' => '每页数据量', 'description' => '每页大小。默认为：**500**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'default' => '500'],
],
[
- 'name' => 'GroupIds',
+ 'name' => 'CloseTimeStart',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '技能组列表',
- 'description' => '技能组列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。结合技能组分组ID使用。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '["6083****","6084****"]',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '在线挂断的时间范围', 'description' => '会话结束的时间范围左区间。时间戳格式，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614578400000'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回数据。',
+ 'title' => 'result',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE339D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Data' => [
- 'title' => '返回结果数据',
- 'description' => '热线号码配置信息。',
+ 'ResultData' => [
+ 'title' => 'data',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'title' => '数据总量',
- 'description' => '数据总量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123',
- ],
- 'PageSize' => [
- 'title' => '每页大小',
- 'description' => '每页大小。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'CurrentPage' => [
- 'title' => '当前页面',
- 'description' => '当前页面。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'HotlineNumList' => [
- 'title' => '号码列表',
- 'description' => '号码列表。',
+ 'OnePageSize' => ['description' => '每页大小', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'TotalPage' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'CurrentPage' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TotalResults' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'Data' => [
+ 'description' => '查询数据结果。',
'type' => 'array',
'items' => [
- 'description' => '号码列表。',
+ 'description' => '会话列表数据对象。',
'type' => 'object',
'properties' => [
- 'FlowId' => [
- 'title' => '入呼流程id',
- 'description' => '入呼流程ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'Description' => [
- 'title' => '号码描述',
- 'description' => '号码描述。',
- 'type' => 'string',
- 'example' => '测试',
- ],
- 'OutboundEnabled' => [
- 'title' => '是否用于外呼',
- 'description' => '是否用于外呼。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'CalloutAllDepartment' => [
- 'title' => '外呼针对所有部门生效',
- 'description' => '外呼针对所有部门生效。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'FlowName' => [
- 'title' => '入呼流程名称',
- 'description' => '入呼流程名称。',
- 'type' => 'string',
- 'example' => '测试流程',
- ],
- 'CalloutRangeList' => [
- 'title' => '外呼生效列表',
- 'description' => '外呼生效列表。',
+ 'ServicerName' => ['description' => '客服账号', 'type' => 'string', 'example' => '123@123.com'],
+ 'EndTime' => ['title' => '在线结束时间', 'description' => '在线结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614578410000'],
+ 'StartTime' => ['title' => '在线开始时间', 'description' => '在线开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614578400000'],
+ 'MessageList' => [
+ 'title' => '在线会话详细信息',
+ 'description' => '在线会话详细信息列表。',
'type' => 'array',
'items' => [
- 'description' => '外呼生效列表。',
+ 'description' => '一个会话详情。',
'type' => 'object',
'properties' => [
- 'GroupDOList' => [
- 'title' => '技能组列表',
- 'description' => '技能组列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组列表。',
- 'type' => 'object',
- 'properties' => [
- 'GroupName' => [
- 'title' => '技能组名称',
- 'description' => '技能组名称。',
- 'type' => 'string',
- 'example' => '技能组A',
- ],
- 'GroupId' => [
- 'title' => '技能组id',
- 'description' => '技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '6083****',
- ],
- ],
- ],
- ],
- 'DepartmentName' => [
- 'title' => '部门名称',
- 'description' => '部门名称。',
- 'type' => 'string',
- 'example' => '部门A',
- ],
- 'DepartmentId' => [
- 'title' => '部门id',
- 'description' => '部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2256****',
- ],
+ 'SenderName' => ['description' => '发送信息的账号。', 'type' => 'string', 'example' => 'account1'],
+ 'Content' => ['description' => '发送的对话内容', 'type' => 'string', 'example' => '你好'],
+ 'CreateTime' => ['description' => '信息发送时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614578400000'],
+ 'SenderType' => ['description' => '发送信息类型。取值：'."\n"
+ .'- **1**：会员'."\n"
+ .'- **2**：客服', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ 'MsgType' => ['description' => '信息类型。', 'type' => 'string', 'example' => 'MSG'],
],
],
],
- 'HotlineNumber' => [
- 'title' => '号码',
- 'description' => '热线号码。',
- 'type' => 'string',
- 'example' => '0571****2211',
- ],
- 'EvaluationStatus' => [
- 'title' => '满意度状态',
- 'description' => '满意度状态。取值：'."\n"
- .'- **0**：入呼外呼均不开启。'."\n"
- .'- **1**：入呼开启。'."\n"
- .'- **2**：外呼开启。'."\n"
- .'- **3**：入呼外呼均开启。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Sp' => [
- 'title' => '运营商',
- 'description' => '运营商。',
- 'type' => 'string',
- 'example' => '电信',
- ],
- 'Location' => [
- 'title' => '归属地',
- 'description' => '号码归属地。',
- 'type' => 'string',
- 'example' => '浙江杭州',
- ],
- 'InBoundEnabled' => [
- 'title' => '是否用于入呼',
- 'description' => '是否用于入呼。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
],
],
],
],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'title' => '是否成功',
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['title' => 'message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Code' => ['title' => 'code', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => 'success', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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' => '查询热线号码配置列表',
- 'description' => '热线号码配置包含热线号码、号码归属地、运营商、是否用于入呼等信息，具体参见[返回参数](#api-detail-40)。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：100次/秒。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GetConfigNumList' => [
- 'summary' => '调用GetConfigNumList接口获取热线设置号码列表。',
- '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' => '[{"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' => '根据时间段查询在线会话详情',
+ 'description' => '此接口查询在某个时间段范围内完成的在线会话信息，包含会话内容。查询规则如下：'."\n"
+ .'- 查询时间段跨度最大为1天。'."\n"
+ .'- 如果只传了查询结束时间，则查询起始时间为结束时间前1小时。'."\n"
+ .'- 如果只传了查询起始时间，则结束时间为起始时间后1小时。'."\n"
+ .'- 如果都没传，则认为结束时间为当前时间，起始时间为结束时间前1小时。'."\n"
+ .'- 如果都传了但是时间跨度大于1天，返回异常信息。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListChatRecordDetail'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'ListDialog' => [
+ 'summary' => '查询智能联络机器人对话记录。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -21867,130 +12140,97 @@
],
'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' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'DepartmentId',
+ 'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'title' => '部门ID',
- 'description' => '部门ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12345',
- ],
+ 'schema' => ['description' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面查看或通过[CreateTask](~~223556~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '12****'],
],
[
- 'name' => 'AccountName',
+ 'name' => 'Called',
'in' => 'query',
- 'schema' => [
- 'title' => '账号名称',
- 'description' => '坐席账号名称。实例内唯一（登录名）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123@123.com',
- ],
+ 'schema' => ['description' => '被叫号码。在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**界面查看被叫号码或通过[ListTaskDetail](~~2718009~~)接口获取被叫号码，接口返回的参数**Called**即为被叫号码。', 'type' => 'string', 'required' => true, 'example' => '130****0000'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE339D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
- 'title' => '号码列表',
- 'description' => '号码列表。',
+ 'description' => '通话交互内容。',
'type' => 'array',
'items' => [
- 'description' => '号码列表。',
- 'type' => 'string',
- 'example' => '0:"057****890" 1:"057****506" 2:"057****507" 3:"057****417" 4:"057****090" 5:"057****888"',
+ 'description' => '通话交互内容列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Role' => ['description' => '说话的角色。取值：'."\n"
+ ."\n"
+ .'- robot：机器人。'."\n"
+ ."\n"
+ .'- user：用户。', 'type' => 'string', 'example' => 'robot'],
+ 'Content' => ['description' => '话术内容。', 'type' => 'string', 'example' => '您好'],
+ 'NodeType' => ['description' => '节点类型。', 'type' => 'string', 'example' => 'normal'],
+ 'Time' => ['description' => '开始时间。时间戳格式，单位：毫秒。', 'type' => 'string', 'example' => '1619763900718'],
+ 'Tag' => ['description' => '意图标签。', 'type' => 'string', 'example' => '肯定'],
+ ],
],
],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'title' => '接口调用是否成功',
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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',
- ],
+ ['errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', 'description' => '权限不足，请联系主账号管理员'],
+ ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => '参数错误'],
],
- 500 => [
- [
- 'errorMessage' => 'A system error occurred. Please contact the administrator.',
- 'errorCode' => 'SystemError',
+ ],
+ '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' => '查询对话记录',
+ 'description' => '- 您可调用此接口查询智能联络机器人对话记录，也可在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**>**查看对话记录**界面查看智能联络机器人对话记录。'."\n"
+ ."\n"
+ .'- 在调用此接口前，请确保您创建的智能联络机器人呼叫任务已有成功拨通的号码。'."\n"
+ ."\n"
+ .'- 若您没有已创建的智能联络机器人呼叫任务，可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面创建并启动任务或通过[CreateTask](~~2718003~~)、[StartTask](~~2718005~~)接口创建并启动任务。'."\n"
+ ."\n\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：500次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListDialog',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', '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' => '获取热线设置号码列表',
],
- 'AnswerCall' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListHotlineRecord' => [
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -21999,80 +12239,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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称（坐席登录名）。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123@123.com',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
'name' => 'CallId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '入呼后，websocket中的acid。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719786',
- ],
- ],
- [
- 'name' => 'JobId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '入呼后，websocket中的jobId。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719787',
- ],
- ],
- [
- 'name' => 'ConnectionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '入呼后，websocket中的connId。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719788',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '会话ID。入呼后，websocket中的acid。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '100365558'],
],
],
'responses' => [
@@ -22081,179 +12265,156 @@
'description' => 'result',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Data' => [
+ 'description' => '热线会话信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '热线会话录音信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ConnectionId' => ['description' => '连接ID。', 'type' => 'string', 'example' => '100365548'],
+ 'EndTime' => ['description' => '录音结束时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16128694810'],
+ 'CallId' => ['description' => '会话ID。入呼后，websocket中的acid。', 'type' => 'string', 'example' => '100365558'],
+ 'StartTime' => ['description' => '录音开始时间戳。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16128694110'],
+ 'Url' => ['description' => '录音文件URL。', 'type' => 'string', 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com'],
+ ],
+ ],
],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '[{"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' => '获取热线录音列表',
+ 'summary' => '调用ListHotlineRecord根据热线会话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' => '接听来电',
- 'summary' => '调用AnswerCall接听来电。',
+ 'ramActions' => [],
],
- 'FinishHotlineService' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListHotlineRecordDetail' => [
+ 'summary' => '根据时间段查询热线详情列表。',
+ '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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'in' => 'query',
+ 'schema' => ['title' => 'clientToken', 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'in' => 'query',
+ 'schema' => ['title' => '实例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre***'],
],
[
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
+ 'name' => 'CloseTimeEnd',
+ 'in' => 'query',
+ 'schema' => ['title' => '热线挂断的时间范围', 'description' => '热线挂断的开始时间。时间戳格式，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614582000000'],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['title' => '当前页', 'description' => '当前页。默认为：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页数据量', 'description' => '每页大小。默认为：**100**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'default' => '100'],
+ ],
+ [
+ 'name' => 'CloseTimeStart',
+ 'in' => 'query',
+ 'schema' => ['title' => '热线挂断的时间范围', 'description' => '热线挂断的结束时间。时间戳格式，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614578400000'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'result',
+ 'title' => 'result',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'ResultData' => [
+ 'title' => 'data',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OnePageSize' => ['description' => '每页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'TotalPage' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'CurrentPage' => ['description' => '当前页。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TotalResults' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '945'],
+ 'Data' => [
+ 'description' => '查询数据结果。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '会话列表数据对象。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ServicerName' => ['description' => '客服账号。', 'type' => 'string', 'example' => '123@123.com'],
+ 'EndTime' => ['title' => '热线结束时间', 'description' => '热线结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614578410000'],
+ 'StartTime' => ['title' => '热线开始时间', 'description' => '热线开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614578400000'],
+ 'OssUrl' => ['title' => '热线通话录音地址', 'description' => '热线通话录音地址。', 'type' => 'string', 'example' => 'http://xxx.xxxxx/xx.wav'],
+ ],
+ ],
+ ],
+ ],
],
+ 'Message' => ['title' => 'message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Code' => ['title' => 'code', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => 'success', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '[{"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' => '查询热线详情列表',
+ 'description' => '此接口查询在某个时间段范围内查询热线详细信息，包含热线通话信息。查询规则如下：'."\n"
+ .'- 查询时间段跨度最大为1天。'."\n"
+ .'- 如果只传了查询结束时间，则查询起始时间为结束时间前1小时。'."\n"
+ .'- 如果只传了查询起始时间，则结束时间为起始时间后1小时。'."\n"
+ .'- 如果都没传，则认为结束时间为当前时间，起始时间为结束时间前1小时。'."\n"
+ .'- 如果都传了但是时间跨度大于1天，返回异常。'."\n"
+ ."\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' => '结束热线服务',
- 'summary' => '根据实例ID、坐席账号名称结束热线服务。',
- 'description' => '### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'ramActions' => [],
],
- 'GetNumLocation' => [
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListOutboundPhoneNumber' => [
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -22264,114 +12425,75 @@
],
'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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d****'],
],
[
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'PhoneNum',
+ 'name' => 'AccountName',
'in' => 'query',
- 'schema' => [
- 'description' => '需要查询的电话号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1360987****',
- ],
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'username@example.com'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'result',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Data' => [
- 'description' => '号码归属地。',
- 'type' => 'string',
- 'example' => '杭州',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '主叫外呼电话号码。',
+ 'type' => 'array',
+ 'items' => ['description' => '主叫外呼电话号码。', 'type' => 'string', 'example' => '{906****}'],
],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。'."\n", 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"杭州\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取号码归属地',
- 'summary' => '根据实例ID、电话号码获取该号码的归属地信息。',
+ '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' => '获取外呼号码信息',
+ 'summary' => '根据实例ID、坐席账号名称获取指定坐席下的主叫外呼电话号码。',
'description' => '### QPS限制'."\n"
.'- 单用户调用频率：不限流。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'GetRtcToken' => [
- 'summary' => '调用GetRtcToken获取移动坐席Token。',
- 'methods' => [
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'ListRobotCallDialog' => [
+ 'summary' => '查询智能联络机器人通话记录。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -22379,36 +12501,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' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_***',
- ],
+ 'schema' => ['description' => '呼叫唯一ID。可调用[RobotCall](~~2717996~~)接口，查看返回参数的**Data**获取。', 'type' => 'string', 'required' => true, 'example' => '12516551****^11195613****'],
],
[
- 'name' => 'AccountName',
+ 'name' => 'CreateTime',
'in' => 'query',
- 'schema' => [
- 'title' => '账号名称',
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'username@example.com',
- ],
+ 'schema' => ['description' => '创建时间。格式：YYYY-MM-DD hh:mm:ss，需要精确到时间。可调用[RobotCall](~~2717996~~)接口，查看调用后的**Response Header**中的**date**参数获取。', 'type' => 'string', 'required' => true, 'example' => '2021-05-20 00:00:00'],
],
],
'responses' => [
@@ -22418,660 +12521,327 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'Successful',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
- 'title' => 'data',
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'RtcId' => [
- 'title' => 'rtcId',
- 'description' => '通过互联网域接入的终端身份标识。',
- 'type' => 'string',
- 'example' => '200000000*******',
- ],
- 'Token' => [
- 'title' => 'token信息',
- 'description' => 'Token信息。',
- 'type' => 'string',
- '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}',
- ],
- 'AccountName' => [
- 'title' => '账号名',
- 'description' => '账号名称。',
- 'type' => 'string',
- 'example' => '139000000',
+ 'description' => '对话记录。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '对话记录列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Role' => ['description' => '对话内容角色。', 'type' => 'string', 'example' => 'robot'],
+ 'Content' => ['description' => '话术内容。', 'type' => 'string', 'example' => '我是某某的客服，看您之前在我们家找过工作，做个回访，现在工作怎么样？'],
+ 'NodeType' => ['description' => '节点类型。', 'type' => 'string', 'example' => '开场白'],
+ 'Time' => ['description' => '开始时间。时间戳格式，单位：毫秒。', 'type' => 'string', 'example' => '1621483557000'],
+ 'Tag' => ['description' => '意图标签。', 'type' => 'string', 'example' => '拒绝'],
],
],
- '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"}',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '是否成功',
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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\\": \\"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":""}]',
- 'title' => '获取移动坐席Token',
- ],
- 'HangupCall' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- [
- 'BearerToken' => [],
- ],
+ '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' => '查询通话记录',
+ 'description' => '- 在调用此接口之前，请确保您已使用智能联络机器人发起过呼出任务。'."\n"
+ ."\n"
+ .'- 若您还没有使用智能联络机器人发起呼出任务，可以调用[RobotCall](~~2717996~~)接口发起呼出任务。'."\n"
+ ."\n\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：500次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [
+ ['createdAt' => '2021-05-20T06:39:10.000Z', 'description' => 'OpenAPI 下线'],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'parameters' => [
- [
- 'name' => 'ClientToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称（坐席登录名）。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123@123.com',
- ],
- ],
- [
- 'name' => 'CallId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '热线会话ID。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719786',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'JobId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '入呼后，websocket中的jobId。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719787',
- ],
- ],
- [
- 'name' => 'ConnectionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '入呼后，websocket中的connId。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719788',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => 'result',
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListRobotCallDialog',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- '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',
- ],
- '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' => '挂断电话',
- 'summary' => '调用HangupCall执行坐席挂机操作。',
],
- 'ListHotlineRecord' => [
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListRobotNode' => [
+ 'summary' => '根据机器人ID，即话术ID，获取机器人节点信息列表。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
- [
- 'BearerToken' => [],
- ],
],
'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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'CallId',
+ 'name' => 'RobotId',
'in' => 'query',
- 'schema' => [
- 'description' => '会话ID。入呼后，websocket中的acid。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '100365558',
- ],
+ 'schema' => ['description' => '机器人ID，即话术ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>智能外呼机器人</b>><b>话术管理</b>中获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '100002674****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'result',
+ 'title' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'Ok'],
'Data' => [
- 'description' => '热线会话信息。',
+ 'description' => '机器人节点列表。',
'type' => 'array',
'items' => [
- 'description' => '热线会话录音信息。',
+ 'description' => '机器人节点列表。',
'type' => 'object',
'properties' => [
- 'ConnectionId' => [
- 'description' => '连接ID。',
- 'type' => 'string',
- 'example' => '100365548',
- ],
- 'EndTime' => [
- 'description' => '录音结束时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '16128694810',
- ],
- 'CallId' => [
- 'description' => '会话ID。入呼后，websocket中的acid。',
- 'type' => 'string',
- 'example' => '100365558',
- ],
- 'StartTime' => [
- 'description' => '录音开始时间戳。单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '16128694110',
- ],
- 'Url' => [
- 'description' => '录音文件URL。',
- 'type' => 'string',
- 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com',
- ],
+ 'ProcessName' => ['description' => '流程名称。', 'type' => 'string', 'example' => '开场白'],
+ 'ModelName' => ['description' => '模型名称。', 'type' => 'string', 'example' => '模型一'],
+ 'IsOutput' => ['description' => '是否输出。取值：'."\n"
+ ."\n"
+ .'- **1**：是。'."\n"
+ .'- **0**：否。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'NodeName' => ['description' => '节点名称。', 'type' => 'string', 'example' => '理财'],
+ 'NodeIdentifier' => ['description' => '输出ID。', 'type' => 'string', 'example' => '12****'],
],
],
],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'Ok'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '获取机器人节点信息列表',
+ 'description' => '- 机器人节点信息包括流程名称、模型名称、节点名称、是否输出、输出ID。'."\n"
+ .'- 调用前，建议您确认机器人ID，即话术ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：500次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [
+ ['createdAt' => '2021-10-21T13:04:17.000Z', 'description' => 'OpenAPI 下线'],
],
- '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' => '获取热线录音列表',
- 'summary' => '调用ListHotlineRecord根据热线会话ID查询热线录音列表。',
- ],
- 'ListOutboundPhoneNumber' => [
- 'methods' => [
- 'get',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListRobotNode',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListRobotParams' => [
+ 'summary' => '根据机器人ID，即话术ID，查询机器人参数列表。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
- [
- 'BearerToken' => [],
- ],
],
'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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d****',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'AccountName',
+ 'name' => 'RobotId',
'in' => 'query',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
+ 'schema' => ['description' => '机器人ID，即话术ID。在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面查看或通过[ListAiccsRobot](~~2717998~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FF67D4D5-4E90-1DF5-BB8F-060BBFAD72DB'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '主叫外呼电话号码。',
+ 'description' => '参数信息。',
'type' => 'array',
'items' => [
- 'description' => '主叫外呼电话号码。',
- 'type' => 'string',
- 'example' => '{906****}',
+ 'description' => '参数列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'IsEmpty' => ['description' => '是否必填。取值：'."\n"
+ ."\n"
+ .'- 0：非必填。'."\n"
+ ."\n"
+ .'- 1：必填。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'ParamCode' => ['description' => '参数ID。', 'type' => 'string', 'example' => '1'],
+ 'ParamName' => ['description' => '参数名称。', 'type' => 'string', 'example' => '名称'],
+ ],
],
],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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',
- ],
+ 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\\": \\"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' => '获取外呼号码信息',
- 'summary' => '根据实例ID、坐席账号名称获取指定坐席下的主叫外呼电话号码。',
- 'description' => '### QPS限制'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '查询机器人参数列表',
+ 'description' => '- 在调用此接口之前，请确保您已有新增的机器人输入参数。'."\n"
+ ."\n"
+ .'- 若您的机器人没有新增输入参数，请在[**话术管理**](https://aiccs.console.aliyun.com/patter/list)>**配置**>**输入输出参数**界面单击新增输入参数。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
.'- 单用户调用频率：不限流。'."\n"
- .'- API频率：100次/秒。'."\n"
+ .'- API频率：500次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'MakeDoubleCall' => [
- 'summary' => '调用MakeDoubleCall通过服务端SDK发起呼叫。',
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListRobotParams',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListRoles' => [
+ 'summary' => '调用ListRoles获取一个租户下的所有角色列表。',
+ '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' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'agent_***',
- ],
- ],
- [
- 'name' => 'AccountName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '账号名称',
- 'description' => '账号名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
- ],
- [
- 'name' => 'ServicerPhone',
- 'in' => 'query',
- 'schema' => [
- 'title' => '坐席手机号（需要通过坐席手机呼叫才需要填写）',
- 'description' => '坐席手机号。'."\n"
- .'> 需要通过坐席手机呼叫才需要填写',
- 'type' => 'string',
- 'required' => false,
- 'example' => '150****1234',
- ],
- ],
- [
- 'name' => 'MemberPhone',
- 'in' => 'query',
- 'schema' => [
- 'title' => '用户手机号',
- 'description' => '用户手机号。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1502123****',
- ],
- ],
- [
- 'name' => 'OutboundCallNumber',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'title' => '外呼主叫号码',
- 'description' => '外呼主叫号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0571000****',
- ],
+ 'schema' => ['title' => 'clientToken', 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
- 'name' => 'BizData',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '业务携带数据（JsonString）',
- 'description' => '业务携带数据。JSON格式。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"bizId": 123456}',
- ],
+ 'schema' => ['title' => '租户实例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => 'result',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'Successful',
- ],
+ 'Message' => ['title' => 'message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => '状态码。返回200表示请求成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => [
- 'title' => '返回数据',
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Acid' => [
- 'title' => '会话id',
- 'description' => '会话ID。',
- 'type' => 'string',
- 'example' => '68255155365620598',
+ 'title' => 'data',
+ 'description' => '角色信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoleGroupId' => ['title' => '所属角色组id', 'description' => '所属角色组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'BuId' => ['title' => '租户id', 'description' => '租户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Description' => ['title' => '角色描述', 'description' => '角色描述。', 'type' => 'string', 'example' => 'Admin'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。', 'type' => 'string', 'example' => '2020-01-03T20:25:33Z'],
+ 'Title' => ['title' => '角色名称', 'description' => '角色名称。', 'type' => 'string', 'example' => '企业管理员'],
+ 'RoleGroupName' => ['title' => '所属角色组名称', 'description' => '所属角色组名称。', 'type' => 'string', 'example' => '角色组名称'],
+ 'RoleId' => ['title' => '角色id', 'description' => '角色ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Code' => ['title' => '角色code', 'description' => '角色Code。', 'type' => 'string', 'example' => 'admin'],
],
],
],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '调用是否成功',
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Success' => ['title' => 'success', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '[{"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' => '获取角色列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoles'],
+ ],
],
- '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' => '通过服务端SDK发起呼叫',
+ 'ramActions' => [],
],
- 'SendHotlineHeartBeat' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListSkillGroup' => [
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -23080,61 +12850,34 @@
'BearerToken' => [],
],
],
- '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' => 'ClientToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-****-70b6a298d94d'],
],
[
'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
- ],
- [
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
+ 'in' => 'query',
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'Token',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '心跳签名。'."\n"
- ."\n"
- .'可调用[StartHotlineService](~~2718045~~)接口获取Token。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0079e7a845e373****',
- ],
+ 'name' => 'ChannelType',
+ 'in' => 'query',
+ 'schema' => ['description' => '技能组渠道类型。取值：'."\n"
+ .'- **0**：返回所有技能组。'."\n"
+ .'- **1**：热线技能组。'."\n"
+ .'- **2**：在线技能组。'."\n"
+ .'- **3**：在线+热线技能组。'."\n"
+ .'- **4**：工单技能组。'."\n"
+ .'- **5**：热线+工单节能组。'."\n"
+ .'- **6**：在线+工单技能组。'."\n"
+ .'- **7**：在线+热线+工单技能组。'."\n"
+ ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '7', 'minimum' => '0', 'example' => '2'],
],
],
'responses' => [
@@ -23143,474 +12886,405 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Data' => [
+ 'description' => '技能组信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['description' => '技能组描述。', 'type' => 'string', 'example' => '自动化技能组'],
+ 'DisplayName' => ['description' => '技能组对外显示名称。', 'type' => 'string', 'example' => '自动化技能组'],
+ 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
+ 'ChannelType' => ['description' => '技能组渠道类型。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'Name' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '自动化技能组'],
+ ],
+ ],
],
+ 'Code' => ['description' => '状态码。返回Success表示调用成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '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' => '[{"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' => '发送热线心跳',
- 'summary' => '根据实例ID、坐席账号名称、心跳签名发送热线心跳请求。',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '查询技能组',
+ 'summary' => '根据实例ID、技能组渠道类型查询悉犀客服工作台技能组。',
'description' => '### QPS限制'."\n"
.'- 单用户调用频率：不限流。'."\n"
.'- API频率：100次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'StartCall' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'ListTask' => [
+ 'summary' => '分页查询智能联络机器人呼叫任务列表。包含任务总数、任务信息。',
+ '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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'name' => 'TaskName',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务名称。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面查看已创建的任务名称。', 'type' => 'string', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '任务测试'],
],
[
- 'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页数量。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'Caller',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '热线外呼主叫号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '906****',
- ],
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务状态。取值：'."\n"
+ ."\n"
+ .'- **INIT**：未开始。'."\n"
+ .'- **RELEASE**：解析中。'."\n"
+ .'- **RUNNING**：执行中。'."\n"
+ .'- **STOP**：手动暂停。'."\n"
+ .'- **SYSTEM_STOP**：系统暂停。'."\n"
+ .'- **READY**：待执行。'."\n"
+ .'- **CANCEL**：手动终止。'."\n"
+ .'- **SYSTEM_CANCEL**：系统终止。'."\n"
+ .'- **DONE**：已完成。', 'type' => 'string', 'required' => false, 'example' => 'STOP'],
],
[
- 'name' => 'Callee',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '热线外呼被叫号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1360987****',
- ],
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => ['description' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面查看或通过[CreateTask](~~223556~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'],
+ ],
+ [
+ 'name' => 'RobotName',
+ 'in' => 'query',
+ 'schema' => ['description' => '机器人名称。即为话术名称，在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面查看已经通过审核的话术名称。', 'type' => 'string', 'required' => false, 'example' => '机器人'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => [
+ 'description' => '任务数据列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageSize' => ['description' => '每页个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
+ 'Total' => ['description' => '任务总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'PageNo' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Record' => [
+ 'description' => '任务信息列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '任务信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => '任务状态。', 'type' => 'string', 'example' => 'RELEASE'],
+ 'GmtCreate' => ['description' => '任务创建时间。时间戳格式，单位：毫秒。', 'type' => 'string', 'example' => '1618477232000'],
+ 'TotalCount' => ['description' => '处理通话总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'FireTime' => ['description' => '任务启动时间。时间戳格式，单位：毫秒。', 'type' => 'string', 'example' => '1618477232000'],
+ 'TaskName' => ['description' => '任务名称。', 'type' => 'string', 'example' => '测试任务'],
+ 'RobotId' => ['description' => '指定机器人ID。即为话术ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12****'],
+ 'RobotName' => ['description' => '机器人名称。', 'type' => 'string', 'example' => '机器人'],
+ 'Id' => ['description' => '机器人呼叫任务的唯一任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12****'],
+ 'CompleteCount' => ['description' => '完成通话个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ ],
+ ],
+ ],
],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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":"<StartCallResponse>\\n<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>\\n</StartCallResponse>","errorExample":""}]',
- 'title' => '坐席发起外呼',
- 'summary' => '根据实例ID、坐席账号名称、热线外呼主叫号码、被叫号码发起外呼。',
- 'description' => '### QPS限制'."\n"
+ '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' => '获取任务列表',
+ 'description' => '- 您可以通过此接口获取智能联络机器人呼叫任务列表，也可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面获取任务列表。'."\n"
+ ."\n"
+ .'- 若您没有已创建的智能联络机器人呼叫任务，可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面单击创建任务或通过[CreateTask](~~2718003~~)接口创建任务。'."\n"
+ ."\n"
+ .'- 此接口的非必填参数为智能联络机器人呼叫任务列表的筛选条件，若不填写，则查询全部任务列表。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
.'- 单用户调用频率：不限流。'."\n"
- .'- API频率：100次/秒。'."\n"
+ .'- API频率：500次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'StartHotlineService' => [
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListTaskDetail' => [
+ 'summary' => '获取智能联络机器人呼叫任务明细信息。',
+ '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' => [
- 'title' => 'js sdk中自动生成的鉴权token',
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'name' => 'StatusCode',
+ 'in' => 'query',
+ 'schema' => ['description' => '呼叫状态码。在语音服务[呼叫状态码](~~112804~~)中查看。', 'type' => 'string', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '200100'],
],
[
- 'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => ['description' => '明细状态。取值：'."\n"
+ ."\n"
+ .'- **SUCCESS**：外呼成功。'."\n"
+ .'- **FAIL**：外呼失败。'."\n"
+ .'- **INIT**：未外呼。', 'type' => 'string', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => 'SUCCESS'],
],
[
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'Called',
+ 'in' => 'query',
+ 'schema' => ['description' => '被叫号码。在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**界面查看被叫号码。', 'type' => 'string', 'required' => false, 'example' => '186****0000'],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)页面查看任务ID或通过[ListTask](~~2718008~~)接口获取任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '12****'],
+ ],
+ [
+ 'name' => 'Id',
+ 'in' => 'query',
+ 'schema' => ['description' => '明细ID。在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**界面查看明细ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
- 'description' => '请求调用成功后返回，发起心跳所需的Token。',
- 'type' => 'string',
- 'example' => '0079e7a845e373****',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '任务详细信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageSize' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Total' => ['description' => '任务总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'PageNo' => ['description' => '每页个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
+ 'Record' => [
+ 'description' => '任务信息列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '任务信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['description' => '明细状态。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'Called' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '186****0000'],
+ 'EndTime' => ['description' => '结束时间。', 'type' => 'string', 'example' => '2021-05-20 00:03:00'],
+ 'StartTime' => ['description' => '开始时间。', 'type' => 'string', 'example' => '2021-05-20 00:00:00'],
+ 'Duration' => ['description' => '通话时长。单位：秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'StatusCode' => ['description' => '呼叫状态码。', 'type' => 'string', 'example' => '200100'],
+ 'StatusCodeDesc' => ['description' => '呼叫状态码描述。', 'type' => 'string', 'example' => '呼叫成功'],
+ 'Direction' => ['description' => '挂断方向。取值：'."\n"
+ ."\n"
+ .'- **用户**。'."\n"
+ .'- **机器**。', 'type' => 'string', 'example' => '用户'],
+ 'RetryCurTimes' => ['description' => '当前重试次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Caller' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '136****0000'],
+ 'Id' => ['description' => '明细ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12****'],
+ 'RetryTimes' => ['description' => '重试次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Tags' => ['description' => '意图标签。', 'type' => 'string', 'example' => '肯定'],
+ ],
+ ],
+ ],
+ ],
],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
- 500 => [
- [
- 'errorMessage' => 'The specified agent does not exist.',
- 'errorCode' => 'NoAgentFound',
- ],
- [
- '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\\": \\"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' => '开始热线服务',
- 'summary' => '根据实例ID、坐席账号名称进行热线坐席签入，开始热线服务。',
- 'description' => '- 此接口返回的**Data**参数为发起心跳所需的Token。'."\n"
- .'- 若坐席小休，需暂停热线服务，可调用[SuspendHotlineService](~~2718046~~)接口。'."\n"
+ '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' => '获取任务明细信息',
+ 'description' => '- 您可调用此接口获取智能联络机器人呼叫任务明细信息，也可在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**界面查看智能联络机器人呼叫任务明细信息。'."\n"
+ ."\n"
+ .'- 在调用此接口前，请确保您创建成功的智能联络机器人已成功启动任务。'."\n"
+ ."\n"
+ .'- 若您没有已创建成功的智能联络机器人呼叫任务，可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面创建并启动任务或通过[CreateTask](~~2718003~~)、[StartTask](~~2718005~~)接口创建并启动任务。'."\n"
+ ."\n"
+ .'- 此接口中的非必填参数为智能联络机器人呼叫任务明细信息的筛选条件，若不填写，则查询全部任务明细信息。'."\n"
."\n"
.'### QPS限制'."\n"
.'- 单用户调用频率：不限流。'."\n"
- .'- API频率：100次/秒。'."\n"
+ .'- API频率：500次/秒。'."\n"
."\n"
.'> 如果多个用户的总调用超过API频率也会触发流控。',
- ],
- 'SuspendHotlineService' => [
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListTaskDetail',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'LlmFullDuplexCallOperate' => [
+ 'summary' => '全双工大模型操作',
+ '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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'name' => 'CallId',
+ 'in' => 'query',
+ 'schema' => ['title' => '通话的唯一回执 ID。可通过 llmSmartCallFullDuplex 接口获取。', 'description' => '通话的唯一回执 ID。可通过 llmSmartCallFullDuplex 接口获取。', 'type' => 'string', 'required' => true, 'example' => '示例值'],
],
[
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
+ 'name' => 'Command',
+ 'in' => 'query',
+ 'schema' => ['title' => '动作指令：play / flush / hangup / sendDtmf ', 'description' => '动作指令：play / flush / hangup / sendDtmf ', 'type' => 'string', 'required' => true, 'example' => '示例值'],
],
[
- 'name' => 'Type',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '小休原因。取值：'."\n"
- .'- **1**：小休（默认值）。'."\n"
- .'- **2**：就餐。'."\n"
- .'- **3**：会议。'."\n"
- .'- **4**：辅导 。'."\n"
- .'- **5**：培训。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '5',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'name' => 'Param',
+ 'in' => 'query',
+ 'schema' => ['title' => '扩展参数，JSON 字符串。各 command 参数说明：', 'description' => '扩展参数，JSON 字符串。各 command 参数说明：', 'type' => 'string', 'required' => false, 'example' => '示例值示例值'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', 'type' => 'string', 'example' => 'None'],
+ 'RequestId' => ['title' => '', 'description' => '请求ID。', 'type' => 'string', 'example' => '示例值示例值示例值'],
+ 'Message' => ['title' => '', 'description' => '状态码描述。', 'type' => 'string', 'example' => '示例值示例值示例值'],
+ 'Data' => ['title' => '', 'description' => '命令执行的结果。'."\n"
+ .'- **true**：命令执行成功。'."\n"
+ .'- **false**：命令执行失败。', 'type' => 'boolean', 'example' => 'false'],
+ 'Code' => ['title' => '', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => '示例值示例值'],
+ 'Success' => ['title' => '', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- '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' => '全双工呼叫控制接口',
+ 'description' => '- 此接口仅可在智能外呼通话过程中调用成功，调用时请注意：请求参数的**CallId**需要填写正在通话的通话唯一回执ID。'."\n"
+ .'- **CallId**为调用[LlmSmartCallFullDuplex](~~2718012~~)接口时，返回参数的**CallId**参数。',
+ '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":"<StartHotlineServiceResponse>\\n<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>\\n</StartHotlineServiceResponse>","errorExample":""}]',
- 'title' => '暂停热线服务',
- 'summary' => '在热线坐席小休时，暂停热线服务。',
- 'description' => '若休息结束，需要开始热线服务，可调用[StartHotlineService](~~2718045~~)接口。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'- 单用户调用频率：不限流。'."\n"
- .'- API频率：100次/秒。'."\n"
- ."\n"
- .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"Data\\": false,\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": false\\n}","type":"json"}]',
],
- 'AddOuterAccount' => [
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'LlmSmartCall' => [
+ 'summary' => '基于大模型的智能外呼。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -23619,1056 +13293,724 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'none',
'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '256802',
+ 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'OuterAccountId',
+ 'name' => 'CalledNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '外部账号ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1212',
- ],
+ 'schema' => ['description' => '接收智能外呼的被叫号码。', 'type' => 'string', 'required' => true, 'example' => '137****0000'],
],
[
- 'name' => 'OuterAccountType',
+ 'name' => 'CallerNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '外部账号类型。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'alipay',
- ],
+ 'schema' => ['description' => '主叫号码，为必填参数，仅支持中国内地号码。请前往语音服务[真实号管理](https://dyvmsnext.console.aliyun.com/number/list/normal)界面查看号码。'."\n"
+ ."\n"
+ .'> '."\n"
+ .'> - 若您使用的是自带线路，则需要传自带线路号码。', 'type' => 'string', 'required' => false, 'example' => '132****2054'],
],
[
- 'name' => 'OuterAccountName',
+ 'name' => 'ApplicationCode',
'in' => 'query',
- 'schema' => [
- 'description' => '外部账号名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '测试',
- ],
+ 'schema' => ['description' => '大模型应用编码。在[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面查看。', 'type' => 'string', 'required' => true, 'example' => 'F32******'],
],
[
- 'name' => 'Avatar',
+ 'name' => 'StartWordParam',
'in' => 'query',
- 'schema' => [
- 'description' => '头像。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://****',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => '开场白变量。请前往[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面单击详情查看您创建的大模型开场白变量。', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "name": "小明",'."\n"
+ .' "address": "浙江省杭州市"'."\n"
+ .'}'],
],
[
- 'name' => 'RealName',
+ 'name' => 'PromptParam',
'in' => 'query',
- 'schema' => [
- 'description' => '账号真实姓名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '张三',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => 'Prompt提示词变量。请前往[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面单击详情查看您创建的Prompt提示词变量。', 'type' => 'object', 'required' => false, 'example' => '{'."\n"
+ .' "style": "温柔"'."\n"
+ .'}'],
],
[
- 'name' => 'OuterDepartmentId',
+ 'name' => 'OutId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部部门ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3',
- ],
+ 'schema' => ['description' => '预留给调用方使用的 ID，最终会通过回执消息将此 ID 带回给调用方，同时大模型网关请求客户模型时会将此参数带给客户模型，长度为 1~15 个字节。', 'type' => 'string', 'required' => false, 'example' => '222356****', 'maxLength' => 32],
],
[
- 'name' => 'OuterGroupIds',
+ 'name' => 'BizParam',
'in' => 'query',
- 'schema' => [
- 'description' => '外部技能组ID列表。多个ID用英文逗号（,）分隔。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["222","333","444"]',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => '自定义业务参数，客户调用此接口时可以将自定义参数传递给大模型网关，大模型网关请求客户模型时会将此参数带给客户模型。'."\n"
+ ."\n"
+ .'- [百炼工作流应用地址：参数传递](https://help.aliyun.com/zh/model-studio/invoke-workflow-application/#6e644d5a7b3ia)。如：`biz_params = {"city": "杭州"}`'."\n"
+ ."\n"
+ .'- [百炼智能体应用地址：传递自定义参数](https://help.aliyun.com/zh/model-studio/call-single-agent-application/#b774db7cdc0aa)。如：'."\n"
+ .'`'."\n"
+ .'biz_params = {'."\n"
+ .' "user_prompt_params": "{\\"city\\":\\"北京\\"}"'."\n"
+ .'}'."\n"
+ .'`', 'type' => 'object', 'required' => false, 'example' => 'biz_params = {'."\n"
+ .' "user_prompt_params": "{\\"city\\":\\"北京\\"}"'."\n"
+ .'}'],
],
[
- 'name' => 'Ext',
+ 'name' => 'Extension',
'in' => 'query',
- 'schema' => [
- 'description' => '扩展字段，JSON字符串。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"备注":"临时技能组"}',
- ],
+ 'schema' => ['description' => 'X号码的分机号码，不超过5位。'."\n"
+ ."\n"
+ .'><notice>仅在AXN分机号模式下需要填写，如果不存在分机号，请务必不要填写。></notice>', 'type' => 'string', 'required' => false, 'example' => '123', 'maxLength' => 5],
],
[
- 'name' => 'OuterDepartmentType',
+ 'name' => 'SessionTimeout',
'in' => 'query',
- 'schema' => [
- 'description' => '外部部门类型：无效部门类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'type_invalid',
- ],
+ 'schema' => ['description' => '最大通话时长，超时后自动挂断。单位：秒。'."\n"
+ .'>'."\n"
+ .'>- 最大取值：3600s。'."\n"
+ .'>- 最小取值：600s。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '300', 'example' => '1200'],
],
[
- 'name' => 'OuterGroupType',
+ 'name' => 'TtsVoiceCode',
'in' => 'query',
- 'schema' => [
- 'description' => '技能组类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'mybank',
- ],
+ 'schema' => ['description' => 'TTS 播放时的音色编码。'."\n"
+ ."\n"
+ .'> '."\n"
+ .'> - 不设置值时，默认取大模型应用配置的音色编码。'."\n"
+ .'> - 支持通过[ListAvailableTts](~~2926668~~)接口查看全部音色编码。', 'type' => 'string', 'required' => false, 'example' => 'V65******'],
+ ],
+ [
+ 'name' => 'TtsSpeed',
+ 'in' => 'query',
+ 'schema' => ['description' => 'TTS 播放时的声音速度。'."\n"
+ ."\n"
+ .'> '."\n"
+ .'> - 取值范围：-200~200，默认值为0。'."\n"
+ .'> - 不设置值时，默认取大模型应用配置的声音速度。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
+ ],
+ [
+ 'name' => 'TtsVolume',
+ 'in' => 'query',
+ 'schema' => ['description' => 'TTS 播放的音量。'."\n"
+ .'> '."\n"
+ .'> - 取值范围：0~100，默认值为0。'."\n"
+ .'> - 不设置值时，默认取大模型应用配置的音量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'CustomerLineCode',
+ 'in' => 'query',
+ 'schema' => ['description' => '用户自带线路编码。'."\n"
+ .'> '."\n"
+ .'> - 如果需要使用自带线路，请联系运营开通此功能；自带线路审核通过后会返回线路编码，若无，请不要设置值。', 'type' => 'string', 'required' => false, 'example' => 'SELF_xxxxx_A_NET'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Data' => [
- 'description' => '创建账号ID。',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D'],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'CallId' => ['description' => '此次通话的唯一回执ID。', 'type' => 'string', 'example' => '125165515***^11195613****'],
],
],
],
],
'errorCodes' => [
- 500 => [
- [
- 'errorMessage' => 'A system error occurred. Please contact the administrator.',
- 'errorCode' => 'SystemError',
- ],
+ 400 => [
+ ['errorCode' => 'ModelStatus.Invalid', 'errorMessage' => 'Model state invalid.', 'description' => '模型状态无效。'],
+ ['errorCode' => 'MissingParameter.CallerNumber', 'errorMessage' => 'Parameter "CallerNumber" which is mandatory for the request is not provided.', 'description' => '没有提供请求必须的参数“CallerNumber”。'],
+ ['errorCode' => 'InvalidParameter.ApplicationCode', 'errorMessage' => 'The specified parameter "ApplicationCode" is invalid.', 'description' => '参数ApplicationCode无效。'],
+ ['errorCode' => 'ModelNotExist', 'errorMessage' => 'The model does not exist.', 'description' => '模型不存在。'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6A51251-F7C4-596A-9F45-3C3219A5450D\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"CallId\\": \\"125165515***^11195613****\\"\\n}","type":"json"}]',
+ 'title' => '大模型智能呼叫',
+ 'description' => '- 调用一次接口仅支持添加一个被叫号码。如果有多个被叫号码，可以多次调用。'."\n"
+ ."\n"
+ .'- 在基于大模型发起智能呼叫之前，请确保您在[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面已创建大模型应用；在语音服务[真实号管理](https://dyvmsnext.console.aliyun.com/number/list/normal)界面已有申请成功的真实号码。',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-10T15:15:11.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-05-30T06:27:57.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-05-13T02:43:55.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-18T03:54:47.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-14T05:49:07.000Z', 'description' => '请求参数发生变更'],
],
- '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' => '添加外部关联账户',
- 'summary' => '调用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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'LlmSmartCallEncrypt' => [
+ 'summary' => '基于大模型加密号码智能呼叫。',
+ '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',
- 'in' => 'query',
- 'schema' => [
- 'description' => '产品名称。默认取值：**aiccs**。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aiccs',
- 'default' => 'aiccs',
- ],
- ],
- [
- 'name' => 'CalledShowNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '被叫显号，必须是已购买的号码。'."\n"
- ."\n"
- .'您可以登录[联络中心控制台](https://aiccs.console.aliyun.com/overview?spm=a2c4g.11186623.0.0.7f9bf9658X6jte)，查看已购买的号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0571000****',
- ],
- ],
- [
- 'name' => 'CalledNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '被叫号码。仅支持中国内地号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1862222****',
- ],
- ],
- [
- 'name' => 'VoiceCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '智能外呼放音文件，支持网络文件和TTS方式。其中，支持使用多个文件和TTS参数混播，之间用英文逗号（,）分隔。TTS参数的替换值在**VoiceCodeParam**中指定。'."\n"
- ."\n"
- .'- 放音文件为网络文件时：参数VoiceCode指定为可被公网访问的语音文件URL，建议您使用采样频率为8000Hz或16000Hz且为wav格式的语音文件。'."\n"
- .'- 放音文件为TTS时：参数VoiceCode指定为变量名称如$name$，需要在VoiceCodeParam中设置变量对应的内容。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$',
- ],
- ],
- [
- 'name' => 'OutId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '预留给调用方使用的ID，最终会通过在回执消息中将此ID带回给调用方。'."\n"
- .'字符串类型，长度为1~15个字节。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '222356****',
- ],
- ],
- [
- 'name' => 'PlayTimes',
+ 'name' => 'EncryptCalledNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '参数暂不支持使用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '加密被叫号码。', 'type' => 'string', 'required' => true, 'example' => '140*********243'],
],
[
- 'name' => 'Volume',
+ 'name' => 'PromptParam',
'in' => 'query',
- 'schema' => [
- 'description' => '播放用户音频的音量，取值范围为**-4~4**，建议设置为**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => '大模型应用prompt参数。', 'type' => 'object', 'required' => false, 'example' => '{"prompt":"推荐一部电影"}'],
],
[
- 'name' => 'Speed',
+ 'name' => 'StartWordParam',
'in' => 'query',
- 'schema' => [
- 'description' => '参数暂不支持使用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => '大模型应用开场白参数。', 'type' => 'object', 'required' => false, 'example' => '{"name":"小明","address":"浙江省杭州市"}'],
],
[
- 'name' => 'AsrModelId',
+ 'name' => 'ApplicationCode',
'in' => 'query',
- 'schema' => [
- 'description' => 'ASR模型ID。请在[ASR模型管理页面](https://aiccs.console.aliyun.com/sentence/model/private?spm=a2c4g.11186623.0.0.7f9b2964fYSGv4)查看ASR模型ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bf71664d30d2478fb8cb8c39c6b6****',
- ],
+ 'schema' => ['description' => '大模型应用编码。', 'type' => 'string', 'required' => true, 'example' => 'AD******45'],
],
[
- 'name' => 'AsrBaseId',
+ 'name' => 'CallerNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'SR基础模型。'."\n"
- ."\n"
- .'- **customer_service_8k**：普通话。'."\n"
- .'- **dialect_customer_service_8k**：重口音。'."\n"
- ."\n"
- .'> - 调用接口**SendCcoSmartCall**时，需要指定使用的ASR模型，建议参数**asrModelId**和**AsrBaseId**二者选填一个。'."\n"
- .'- 如果仅设置**asrModelId**，表示使用指定的ASR模型。'."\n"
- .'- 如果仅设置**AsrBaseId**，表示使用指定的ASR基础模型。'."\n"
- .'- 如果二者均未设置，则使用默认的ASR基础模型，即参数**AsrBaseId**默认为**customer_service_8k**，表示使用ASR普通话基础模型。'."\n"
- .'- 如果二者同时设置，请确认二者是正确对应的。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'customer_service_8k',
- ],
+ 'schema' => ['description' => '主叫号码。', 'type' => 'string', 'required' => true, 'example' => '132******65'],
],
[
- 'name' => 'AsrAlsAmId',
+ 'name' => 'OutId',
'in' => 'query',
- 'schema' => [
- 'description' => '声学模型ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '23387****',
- ],
+ 'schema' => ['description' => '客户自定义outId。', 'type' => 'string', 'required' => false, 'example' => 'dsa*******sad'],
],
- [
- 'name' => 'AsrVocabularyId',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '热词ID。请在[ASR热词管理页面](https://aiccs.console.aliyun.com/sentence/vocab?spm=a2c4g.11186623.0.0.7f9bf965IKBpsi)查看ASR热词ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6689****',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F92F9749-105E-518F-8B08-CF16EF36A0E2'],
+ 'Data' => [
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CallId' => ['description' => '呼叫ID。', 'type' => 'string', 'example' => '149******206'],
+ ],
+ ],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'ok'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
],
],
+ ],
+ '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' => '大模型加密号智能外呼',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'RecordFlag',
- 'in' => 'query',
- 'schema' => [
- 'description' => '通话过程中是否录音。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aiccs:LlmSmartCallEncrypt',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'LlmSmartCallFullDuplex' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'PauseTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '停顿时长。用于设置用户停顿多久，表示一句话结束。单位为毫秒，取值范围为**300~1200**。'."\n"
- ."\n"
- .'- 如果指定值不在参数范围中，则默认PauseTime为**800**。'."\n"
- .'- 首次设置有效，后续设置无效。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '800',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '256802',
+ 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
[
- 'name' => 'MuteTime',
+ 'name' => 'CalledNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '静音时长。用于设置用户多久不说话通话结束。单位为毫秒，取值范围为**1000~20000**。'."\n"
- ."\n"
- .'- 如果指定值不在参数范围中，则默认MuteTime为**10000**。'."\n"
- .'- 通话过程中可动态设置，以最后一次设置为准。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10000',
- ],
+ 'schema' => ['description' => '**CalledNumber** '."\n"
+ .'接收智能外呼的被叫号码。', 'type' => 'string', 'required' => true, 'example' => '1234567890'],
],
[
- 'name' => 'ActionCodeBreak',
+ 'name' => 'CallerNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '开场放音文件是否可打断。默认为**true**，即开场放音文件可打断。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '**CallerNumber** '."\n"
+ .'主叫号码', 'type' => 'string', 'required' => true, 'example' => '0987654321'],
],
[
- 'name' => 'DynamicId',
+ 'name' => 'ApplicationCode',
'in' => 'query',
- 'schema' => [
- 'description' => '预留给调用方使用的动态扩展ID，在回调地址中带回，用于客户的开发标识。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2234****',
- ],
+ 'schema' => ['description' => '**ApplicationCode** '."\n"
+ .'应用code', 'type' => 'string', 'required' => true, 'example' => 'app123'],
],
[
- 'name' => 'EarlyMediaAsr',
+ 'name' => 'StartWordParam',
'in' => 'query',
- 'schema' => [
- 'description' => '早媒体语音识别标识。设为**true**会记录通话未接听的原因。默认为**fasle**，即关闭状态。'."\n"
- ."\n"
- .'> 如果需要启用早媒体语音识别标识，请手动设为**true**。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'fasle',
- ],
+ 'style' => 'json',
+ 'schema' => ['description' => '**StartWordParam** '."\n"
+ .'开场白变量,格式：json 格式，开场白变量名+参数`{"custom":"XXX"}`', 'type' => 'object', 'required' => false, 'example' => '{\\"tailnumber\\":\\"7898\\",\\"platformOrder\\":\\"\\",\\"signatory\\":\\"客户\\"}'],
],
[
- 'name' => 'VoiceCodeParam',
+ 'name' => 'OutId',
'in' => 'query',
- 'schema' => [
- 'description' => 'TTS参数传递字符串，格式为JSON。必须与VoiceCode的TTS参数对应。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '“{\\”name\\”:\\”喂，你好\\”}”',
- ],
+ 'schema' => ['description' => '**OutId** '."\n"
+ .'外部ID,长度为 1~15 个字节。', 'type' => 'string', 'required' => false, 'example' => 'out123', 'maxLength' => 32],
],
[
'name' => 'SessionTimeout',
'in' => 'query',
- 'schema' => [
- 'description' => '最大通话时长，单位为秒，超时后自动挂断。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '120',
- ],
- ],
- [
- 'name' => 'ActionCodeTimeBreak',
- 'in' => 'query',
- 'schema' => [
- 'description' => '基于用户持续说话时长打断，在ActionCodeBreak为**true**时生效。单位为毫秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '120',
- ],
- ],
- [
- 'name' => 'TtsConf',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否设置TTS声音参数。'."\n"
- .'- 指定为**true**：需要通过TtsStyle、TtsColume、TtsSpeed三个参数来设置声音风格。'."\n"
- .'- 定为**false**：不需要设置相关参数，即便设置了也不生效。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'TtsStyle',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'TTS变量播放时的声音风格，默认为**xiaoyun**，具体风格请参见声音风格列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xiaoyun',
- ],
+ 'schema' => ['description' => '**SessionTimeout** '."\n"
+ .'最大通话时长，超时后自动挂断。单位：秒。通话时长最长 3600 秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '300', 'example' => '120'],
],
[
- 'name' => 'TtsVolume',
+ 'name' => 'TtsVoiceCode',
'in' => 'query',
- 'schema' => [
- 'description' => 'TTS变量播放的音量，取值范围为**0~100**，默认为**0**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '个性化音色界面的音色code不传使用应用上配置的参数。'."\n", 'type' => 'string', 'required' => false, 'example' => 'V745A7CED'],
],
[
'name' => 'TtsSpeed',
'in' => 'query',
- 'schema' => [
- 'description' => 'TTS变量播放时的声音速度，取值范围为**-200~200**，默认为**0**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
- ],
- [
- 'name' => 'EnableITN',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否在后处理中执行ITN。'."\n"
- ."\n"
- .'> 设置为**true**时，中文数字将转为阿拉伯数字输出，默认为**false**。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'false',
- ],
- ],
- [
- 'name' => 'BackgroundFileCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '用户和机器人对话时播放的背景语音文件ID。'."\n"
- ."\n"
- .'您可以登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，选择**智能交互 > 语音文件管理**，单击**详情**，查看对应的语音ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav',
- ],
+ 'schema' => ['description' => '音色速度取值0~100，不传使用应用上配置的参数。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70'],
],
[
- 'name' => 'BackgroundVolume',
+ 'name' => 'TtsVolume',
'in' => 'query',
- 'schema' => [
- 'description' => '参数暂不支持使用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '4',
- 'minimum' => '-4',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'BackgroundSpeed',
- 'in' => 'query',
- 'schema' => [
- 'description' => '参数暂不支持使用。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '音量取值范围：-200~200，不传使用应用上配置的参数。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D',
- ],
- 'Data' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Code' => [
- 'description' => '此次通话的唯一回执ID。',
- 'type' => 'string',
- 'example' => '116012854210^10281427****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Code' => ['description' => '错误码'."\n", 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '错误信息'."\n", 'type' => 'string', 'example' => 'OK'],
+ 'CallId' => ['description' => '呼叫记录ID，用于标识一条通话记录。'."\n"
+ ."\n"
+ .'> 在调用大模型外呼接口LlmSmartCall是，会返回此呼叫记录ID，即CallId。', 'type' => 'string', 'example' => '153955119976^140696759976'],
],
],
],
],
'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\\": \\"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":""}]',
- 'title' => '发起智能语音交互通话',
- 'summary' => '调用AiccsSmartCall接口发起智能语音交互通话。',
- 'requestParamsDescription' => '### 声音风格列表'."\n"
- ."\n"
- .'- 小云标准女声：xiaoyun'."\n"
- .'- 小刚标准男声：xiaogang'."\n"
- .'- 若兮温柔女声：ruoxi'."\n"
- .'- 小梦标准女声：xiaomeng'."\n"
- .'- 小威标准男声：xiaowei'."\n"
- .'- 阿美甜美女声：amei'."\n"
- .'- 小雪温柔女声：xiaoxue'."\n"
- .'- 思琪温柔女声：siqi'."\n"
- .'- 思佳标准女声：sijia'."\n"
- .'- 思诚标准男声：sicheng'."\n"
- .'- 思悦温柔女声：siyue'."\n"
- .'- 小美甜美女声：xiaomei'."\n"
- .'- 思彤标准童声：sitong'."\n"
- .'- 宁儿标准女声：ninger'."\n"
- .'- 小北萝莉女声：xiaobei'."\n"
- .'- 伊娜浙普女声：yina'."\n",
+ ['errorCode' => 'ModelStatus.Invalid', 'errorMessage' => 'Model state invalid.', 'description' => '模型状态无效。'],
+ ['errorCode' => 'MissingParameter.CallerNumber', 'errorMessage' => 'Parameter "CallerNumber" which is mandatory for the request is not provided.', 'description' => '没有提供请求必须的参数“CallerNumber”。'],
+ ['errorCode' => 'InvalidParameter.ApplicationCode', 'errorMessage' => 'The specified parameter "ApplicationCode" is invalid.', 'description' => '参数ApplicationCode无效。'],
+ ['errorCode' => 'ModelNotExist', 'errorMessage' => 'The model does not exist.', 'description' => '模型不存在。'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '全双工智能联络中心呼叫',
+ 'summary' => '发起全双工智能联络中心通话，支持个性化配置。',
+ 'description' => '## 请求说明'."\n"
+ .'- 在使用本接口前，请确保已经完成ASR回调地址的配置。'."\n"
+ .'- 该接口仅限于特定UID白名单用户使用。'."\n"
+ .'- 单个用户的请求频率限制为100qps。'."\n"
+ .'- `CalledNumber` 和 `CallerNumber` 是必填项，分别代表被叫号码和主叫显示号码。'."\n"
+ .'- 可选参数如 `StartWordParam`, `TtsVoiceCode`, `TtsSpeed`, `TtsVolume` 等允许自定义通话体验，若未提供则采用应用默认设置。'."\n"
+ .'- `SessionTimeout` 参数用于设定最大通话时长（秒），超过此时间将自动结束通话，默认值及范围请参考具体文档。'."\n"
+ .'- `OutId` 字段可用于追踪外部系统中的唯一标识符，长度限制在1到32字节之间。'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"CallId\\": \\"153955119976^140696759976\\"\\n}","type":"json"}]',
],
- 'AiccsSmartCallOperate' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'MakeCall' => [
+ 'methods' => ['post', 'get'],
+ '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' => 'OuterAccountId',
'in' => 'query',
- 'schema' => [
- 'description' => '产品名称。默认取值：**aiccs**。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aiccs',
- 'default' => 'aiccs',
- ],
+ 'schema' => ['description' => '外部账户ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
[
- 'name' => 'CallId',
+ 'name' => 'OuterAccountType',
'in' => 'query',
- 'schema' => [
- 'description' => '通话的唯一回执ID。可以通过[SendCcoSmartCall](~~311247~~)获取。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '116012854210^102814279****',
- ],
+ 'schema' => ['description' => '外部账户类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ALIPAY'],
],
[
- 'name' => 'Command',
+ 'name' => 'CommandCode',
'in' => 'query',
- 'schema' => [
- 'description' => '在智能外呼通话中，指定被叫号码发起的动作。'."\n"
- ."\n"
- .'> 当前仅支持参数**parallelBridge**，表示指定动作为被叫号码与呼叫中心坐席桥接。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'parallelBridge',
- ],
+ 'schema' => ['description' => '操作码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'outBound_Call'],
],
[
- 'name' => 'Param',
+ 'name' => 'CallingNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '扩展字段。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Param',
- ],
+ 'schema' => ['description' => '主叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0571456****'],
+ ],
+ [
+ 'name' => 'CalledNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '130****0000'],
+ ],
+ [
+ 'name' => 'ExtInfo',
+ 'in' => 'query',
+ 'schema' => ['description' => '透传业务信息。', 'type' => 'string', 'required' => false, 'example' => '{"bizId": 23323}'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D',
- ],
- 'Data' => [
- 'description' => '命令执行的结果。'."\n"
- .'- **true**：命令执行成功。'."\n"
- .'- **false**：命令执行失败。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Data' => ['description' => '是否成功。取值：'."\n"
+ .'- **true**（成功）'."\n"
+ .'- **false**（失败）', 'type' => 'string', 'example' => 'true'],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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',
- ],
- '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' => '发起智能语音指定动作',
- 'summary' => '调用AiccsSmartCallOperate接口在智能外呼通话中，发起指定动作，仅用于并行转人工，人工坐席可旁听人机对话等场景。',
- ],
- 'BatchCreateQualityProjects' => [
- 'methods' => [
- 'post',
- 'get',
+ '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' => '发起热线呼叫',
+ 'summary' => '调用MakeCall发起呼叫。',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'MakeDoubleCall' => [
+ 'summary' => '调用MakeDoubleCall通过服务端SDK发起呼叫。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', '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' => 'publicInformation'],
'parameters' => [
[
- 'name' => 'ProjectName',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
- ],
- [
- 'name' => 'CheckFreqType',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '100',
- 'minimum' => '1',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_***'],
],
[
- 'name' => 'TimeRangeStart',
+ 'name' => 'AccountName',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['title' => '账号名称', 'description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => '12345'],
],
[
- 'name' => 'TimeRangeEnd',
+ 'name' => 'ServicerPhone',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['title' => '坐席手机号（需要通过坐席手机呼叫才需要填写）', 'description' => '坐席手机号。'."\n"
+ .'> 需要通过坐席手机呼叫才需要填写', 'type' => 'string', 'required' => false, 'example' => '150****1234'],
],
[
- 'name' => 'AnalysisIds',
+ 'name' => 'MemberPhone',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'required' => true,
- 'maxItems' => 3,
- ],
+ 'schema' => ['title' => '用户手机号', 'description' => '用户手机号。', 'type' => 'string', 'required' => true, 'example' => '1502123****'],
],
[
- 'name' => 'InstanceList',
+ 'name' => 'OutboundCallNumber',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- 'required' => true,
- 'maxItems' => 3,
- ],
+ 'schema' => ['title' => '外呼主叫号码', 'description' => '外呼主叫号码。', 'type' => 'string', 'required' => true, 'example' => '0571000****'],
],
[
- 'name' => 'ChannelTouchType',
+ 'name' => 'BizData',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'required' => false,
- 'maxItems' => 3,
- ],
+ 'schema' => ['title' => '业务携带数据（JsonString）', 'description' => '业务携带数据。JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{"bizId": 123456}'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'InstanceId' => [
- 'type' => 'string',
- ],
- 'Version' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ProjectId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
+ 'title' => '返回数据',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Acid' => ['title' => '会话id', 'description' => '会话ID。', 'type' => 'string', 'example' => '68255155365620598'],
],
],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
+ 'Code' => ['title' => '错误码', 'description' => '状态码。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '调用是否成功', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '',
- ],
- 'ChangeChatAgentStatus' => [
- 'summary' => '调用ChangeChatAgentStatus修改在线客服状态。',
- 'methods' => [
- 'post',
+ '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' => '通过服务端SDK发起呼叫',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:00.000Z', 'description' => '错误码发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MakeDoubleCall'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'PageQueryAgentList' => [
+ 'summary' => '分页查询智能体列表。',
+ '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' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'ClientToken',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'clientToken',
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'name' => 'AgentId',
+ 'in' => 'query',
+ 'schema' => ['description' => '智能体ID。', 'type' => 'string', 'required' => false, 'example' => '1231*******'],
],
[
- 'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '示例id',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '页大小，默认10。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '账户名称',
- 'description' => '坐席账号。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'account1',
- ],
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '页编号，从1开始，默认1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'Method',
- 'in' => 'formData',
+ 'name' => 'AgentName',
+ 'in' => 'query',
+ 'schema' => ['description' => '智能体名称。', 'type' => 'string', 'required' => false, 'example' => '测试智能体'],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
'schema' => [
- 'title' => '修改到的状态类型',
- 'description' => '想要切换到的在线状态。目前支持**requestLogout** （申请离线）。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'requestLogout',
- 'enum' => [
- 'requestRest',
- 'requestLogout',
- 'restToWork',
- ],
+ 'description' => '智能体状态。',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'enumValueTitles' => [1 => '已上线', '已下线', '审核中', '审核失败', '构建中', '调试中', '可上线', '构建失败'],
+ 'example' => '7',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'result',
- 'description' => 'result',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => 'message',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'DF6A3FB7-A5AA-43BE-A65B',
- ],
- 'HttpStatusCode' => [
- 'title' => 'httpStatusCode',
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'Access Denied'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '742C9243-2870-B8D6-0C68-C60BEB2DF09A'],
'Data' => [
- 'title' => 'data',
- 'description' => '当前客服状态。取值：'."\n"
- .'- **0**：下班'."\n"
- .'- **3**：小休',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'title' => 'success',
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
+ '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'],
+ 'BusinessTypeName' => ['description' => '业务场景名称', 'type' => 'string', 'example' => '个人客户线索转化'],
+ 'Description' => ['description' => '智能体说明。', 'type' => 'string', 'example' => '用于日常测试'],
+ 'WithConfig' => ['description' => '智能体是否已经配置过。', 'type' => 'boolean', 'example' => 'false'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-10-28 17:10:17'],
+ 'AuditReason' => ['description' => '审核失败原因。', 'type' => 'string', 'example' => '请补充流程说明'],
+ 'AgentName' => ['description' => '智能体名称。', 'type' => 'string', 'example' => '测试智能体'],
+ 'AgentId' => ['description' => '智能体ID。', 'type' => 'string', 'example' => '121312*******'],
+ 'BuildFailReason' => ['description' => '构建失败原因', 'type' => 'string', 'example' => '系统错误'],
+ 'ApplicationCode' => ['description' => '应用Code', 'type' => 'string', 'example' => 'DFAS*****'],
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'PageNo' => ['description' => '页面编号。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ ],
+ 'example' => '',
],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- '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' => '[{"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' => '查询通信智能体列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aiccs:PageQueryAgentList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- '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' => '修改在线客服状态',
- 'description' => '> 目前仅支持将在线客服状态修改为下班状态。',
],
- 'ChangeQualityProjectStatus' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'PageQueryAgentListNew' => [
+ 'summary' => '分页查询智能体列表（代运营模式V2）',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaiccsTY5M4L'],
'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'AgentName',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => '智能体名称。', 'type' => 'string', 'required' => false, 'example' => '智能客服助手'],
],
[
- 'name' => 'Status',
+ 'name' => 'AgentId',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => 'Agent ID', 'type' => 'string', 'format' => 'int64', 'required' => false, 'example' => '12345'],
],
[
- 'name' => 'ProjectId',
+ 'name' => 'PageIndex',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => '分页页码（已废弃，使用PageNo即可）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页大小。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '页码', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'IsAvailable',
+ 'in' => 'query',
+ 'schema' => ['description' => '智能体是否可用于外呼。True表示智能体当前部署分支有已发布的版本，可用于外呼。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
@@ -24676,230 +14018,209 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => 'Access denied due to insufficient permissions'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '12345678-1234-1234-1234-123456789012'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'success'],
'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
+ 'description' => '返回结果数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '41'],
+ 'Total' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'],
+ 'PageNo' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '28'],
+ 'List' => [
+ 'description' => '数据列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'DeployBranchName' => ['description' => '生效中分支的名称', 'type' => 'string', 'example' => 'master'],
+ 'ModifyTime' => ['description' => '最近一次修改时间。', 'type' => 'string', 'example' => '2024-01-15 10:30:00'],
+ 'Description' => ['description' => '智能体说明。', 'type' => 'string', 'example' => '智能客服助手，提供自动化的客户服务支持'],
+ 'AgentMode' => ['description' => '智能体构建方式。枚举值： '."\n"
+ .'0：提示词模式（PROMPT）；'."\n"
+ .' 1：对话流模式（CONVERSATION）', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-01-20 12:00:00'],
+ 'EffectiveVersionId' => ['description' => '生效中的版本ID', 'type' => 'integer', 'format' => 'int64', 'example' => '71'],
+ 'Scene' => ['description' => '场景', 'type' => 'string', 'example' => '个人线索转化'],
+ 'ApplicationCode' => ['description' => '应用Code', 'type' => 'string', 'example' => 'aicc_demo_app'],
+ 'DeployBranchId' => ['description' => '部署中的分支ID', 'type' => 'integer', 'format' => 'int64', 'example' => '24'],
+ 'LatestPublishTime' => ['description' => '最新版本发布时间', 'type' => 'string', 'example' => '2024-01-20 12:00:00'],
+ 'IsAvailable' => ['description' => '智能体是否可用于外呼。True 表示智能体当前部署分支有已发布的版本，可用于外呼。', 'type' => 'boolean', 'example' => 'true'],
+ 'AgentId' => ['description' => '智能体ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '51'],
+ 'AgentName' => ['description' => '智能体名称。', 'type' => 'string', 'example' => '智能客服助手'],
+ 'EffectiveVersionName' => ['description' => '生效中的版本名称', 'type' => 'string', 'example' => 'v1.0.0'],
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorMessage' => 'A system error occurred. Please contact the administrator.',
- 'errorCode' => 'SystemError',
- ],
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '分页查询智能体列表（新模式）',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '',
+ 'ramActions' => [],
+ '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' => '分页查询呼叫任务明细。',
+ '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' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => '1187**************'],
],
[
- 'name' => 'TaskName',
+ 'name' => 'Status',
'in' => 'query',
'schema' => [
- 'type' => 'string',
+ 'description' => '任务状态。取值：'."\n"
+ ."\n"
+ .'- 0：待完成。'."\n"
+ ."\n"
+ .'- 1：已完成。'."\n"
+ ."\n"
+ .'- 2：失败。',
+ 'type' => 'integer',
+ 'format' => 'int64',
'required' => true,
- 'docRequired' => true,
+ 'enumValueTitles' => [],
+ 'example' => '0',
],
],
[
- 'name' => 'Description',
+ 'name' => 'BatchId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '批次号ID。在**呼叫任务管理**界面单击详情查看批次号ID。', 'type' => 'string', 'required' => false, 'example' => '1183**************'."\n"],
],
[
- 'name' => 'StartDate',
+ 'name' => 'CalledNumber',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => false, 'example' => '053714454****'],
],
[
- 'name' => 'EndDate',
+ 'name' => 'EncryptionType',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => '加密方式。0: 不加密；1: MD5；2: SHA256；3: SM3；', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'StartTime',
+ 'name' => 'CallResult',
'in' => 'query',
'schema' => [
+ 'description' => '呼叫结果。取值：'."\n"
+ .'- CALL_FORWARDING：呼叫转移。'."\n"
+ .'- INCOMING_CALL_BARRED：限制呼入。'."\n"
+ .'- CALL_REJECTED：拒接。'."\n"
+ .'- ANSWERED：用户接通。'."\n"
+ .'- USER_BUSY：被叫忙。'."\n"
+ .'- POWERED_OFF：关机。'."\n"
+ .'- NO_USER_RESPONSE：不在服务区。'."\n"
+ .'- OPERATOR_BLOCK：运营商拦截。'."\n"
+ .'- OTHERS：其他状态。'."\n"
+ .'- SUSPEND：停机。'."\n"
+ .'- CANCEL：主叫取消。'."\n"
+ .'- INVALID_NUMBER：空号。'."\n"
+ .'- UNAVAILABLE：暂时无法接通。'."\n"
+ .'- NETWORK_BUSY：网络忙。'."\n"
+ .'- NO_ANSWER：无应答。',
'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'ANSWERED',
],
],
[
- 'name' => 'EndTime',
+ 'name' => 'MajorIntent',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => '主意图。在[通信智能体管理](https://aiccs.console.aliyun.com/agent/customize)界面单击智能体详情查看主意图。', 'type' => 'string', 'required' => false, 'example' => 'A'],
],
[
- 'name' => 'RetryTime',
+ 'name' => 'MinConversationDuration',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '3',
- 'minimum' => '0',
- 'default' => '0',
- ],
+ 'schema' => ['description' => '通话时长下限。单位：分钟。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
],
[
- 'name' => 'RetryInterval',
+ 'name' => 'MaxConversationDuration',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '2880',
- 'minimum' => '0',
- 'default' => '0',
- ],
+ 'schema' => ['description' => '通话时长上限。单位：分钟。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'SkillGroup',
+ 'name' => 'StartImportedTime',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '9223372036854775700',
- 'minimum' => '0',
- ],
+ 'schema' => ['description' => '起始导入时间，时间戳，单位：ms。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748948749000'],
],
[
- 'name' => 'Ani',
+ 'name' => 'EndImportedTime',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => '结束导入时间，时间戳，单位：ms。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748948749000'],
],
[
- 'name' => 'GroupName',
+ 'name' => 'StartCallingTime',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '起始呼叫时间，时间戳，单位：ms。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748948749000'],
],
[
- 'name' => 'Model',
+ 'name' => 'EndCallingTime',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '10',
- 'minimum' => '0',
- ],
+ 'schema' => ['description' => '结束呼叫时间，时间戳，单位：ms。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748948749000'],
],
[
- 'name' => 'DepartmentId',
+ 'name' => 'OutId',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '9223372036854775700',
- 'minimum' => '0',
- ],
+ 'schema' => ['description' => '预留给调用方使用的ID。最终会通过在回执消息中将此ID带回给调用方。', 'type' => 'string', 'required' => false, 'example' => '94ba739b-c01a-ef91-335d-4be006c34899'],
],
[
- 'name' => 'ExtAttrs',
+ 'name' => 'DetailIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'type' => 'string',
+ 'description' => '任务明细ID列表，最多不能超过100个。',
+ 'type' => 'array',
+ 'items' => ['description' => '明细ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '992913231****'],
'required' => false,
+ 'example' => '',
],
],
[
- 'name' => 'CallInfos',
+ 'name' => 'PageNo',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => '每页数量。默认值：**10**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'default' => '10'],
],
],
'responses' => [
@@ -24907,188 +14228,360 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A57441B2-8EB6-5B93-9F37-0A51B8E2C9F5'],
'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
+ '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' => ['description' => '任务明细状态。'."\n"
+ .'- 0:初始化'."\n"
+ .'- 1:等待呼叫中'."\n"
+ .'- 2:等待重试中'."\n"
+ .'- 3:呼叫中'."\n"
+ .'- 4:呼叫结束'."\n"
+ .'- 5:呼叫失败'."\n"
+ ."\n"
+ .'只有4和5属于终态。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
+ 'Options' => ['description' => '运行时用到的变量信息，会以Key-Value的形式存储在该字段中。', 'type' => 'string', 'example' => '{'."\n"
+ .' "date": "666",'."\n"
+ .' "phoneNumber": "777",'."\n"
+ .' "distance": "555",'."\n"
+ .' "mendian": "444",'."\n"
+ .' "sex": "男",'."\n"
+ .' "name": "111",'."\n"
+ .' "age": "222"'."\n"
+ .'}'],
+ 'EncryptionType' => ['description' => '加密方式：0-不加密；1-MD5；2-SHA256；3-SM3', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'CalledNumber' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '0537101****'],
+ 'CallResult' => ['description' => '呼叫结果。', 'type' => 'string', 'example' => '用户接通'],
+ 'ConversationTurnCount' => ['description' => '对话轮次。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '1187**************'],
+ 'BatchId' => ['description' => '批次号ID。', 'type' => 'string', 'example' => '1183**************'],
+ 'MajorIntent' => ['description' => '主意图。', 'type' => 'string', 'example' => 'A'],
+ 'FailedReason' => ['description' => '呼叫失败原因，只有呼叫失败时才会有。', 'type' => 'string', 'example' => '账户停机'],
+ 'BranchId' => ['description' => '分支 ID。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '49'],
+ 'RecordingFilePath' => ['description' => '录音文件下载路径，只有录音文件生成后才有该字段。', 'type' => 'string', 'example' => 'https://*******'],
+ 'CallingTime' => ['description' => '呼叫时间，时间戳，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1748948749000'],
+ 'DetailId' => ['description' => '任务明细ID。', 'type' => 'string', 'example' => '9662*************'],
+ 'OutId' => ['description' => '预留给外部传入的业务流水号，可用唯一 ID 做业务关联。', 'type' => 'string', 'example' => 'outId'],
+ 'BranchVersionId' => ['description' => '版本ID', 'type' => 'integer', 'format' => 'int64', 'example' => '9'],
+ 'ConversationRecord' => ['description' => '聊天记录信息。结构为JSON数组，聊天记录时按照时间顺序已经排序好了。具体如下：'."\n"
+ .'```json'."\n"
+ .'['."\n"
+ .' {'."\n"
+ .' "content":"聊天内容",'."\n"
+ .' "role":"角色",//可取值：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"
+ .']'],
+ 'ConversationDuration' => ['description' => '通话时长，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'VersionNo' => ['description' => '版本序号', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'VersionName' => ['description' => '版本名称。', 'type' => 'string', 'example' => '默认版本'],
+ 'BranchName' => ['description' => '分支名称', 'type' => 'string', 'example' => '默认分支'],
+ 'CallId' => ['description' => '通话ID', 'type' => 'string', 'example' => '123*****456^123*****456'],
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- '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' => '呼叫任务明细',
+ 'description' => '- 在查询呼叫任务明细之前，请确保您已创建呼叫任务。'."\n"
+ ."\n"
+ .'- 若您没有创建呼叫任务，可在**呼叫任务管理**界面创建呼叫任务或者通过[CreateAiCallTask](~~2926796~~)接口创建呼叫任务。',
+ '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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '',
],
- 'CreateQualityProject' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'QueryAiCallTaskDetail' => [
+ 'summary' => '查询呼叫任务基础信息。',
+ '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' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => '1187**************'],
],
- [
- 'name' => 'CheckFreqType',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '100',
- 'minimum' => '1',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '错误信息，正常调用时，不会返回该参数。', 'type' => 'string', 'example' => '参数无效'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '23822ECB-8CAA-5C52-9C9E-807FD82A5A7F'],
+ 'Data' => [
+ 'description' => '返回结果数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '1187**************'."\n"],
+ 'ApplicationName' => ['type' => 'string', 'example' => '示例值', 'description' => ''],
+ 'RetryEnable' => [
+ 'description' => '是否开启呼叫重试。取值：'."\n"
+ .'- true：开启。'."\n"
+ .'- false：未开启。',
+ 'type' => 'boolean',
+ 'enumValueTitles' => [],
+ 'example' => 'true',
+ ],
+ 'StartTime' => ['description' => '任务预设启动时间，时间戳，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1748932499000'],
+ 'RealStartTime' => ['description' => '任务真实启动时间，时间戳，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1748932499000'],
+ 'LinePhoneNum' => ['type' => 'string', 'example' => '示例值', 'description' => ''],
+ 'ApplicationCode' => ['type' => 'string', 'example' => '示例值', 'description' => ''],
+ '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' => '具体重试原因。取值：'."\n"
+ ."\n"
+ .'- CALL_REJECTED：拒接。'."\n"
+ ."\n"
+ .'- USER_BUSY：被叫忙。'."\n"
+ ."\n"
+ .'- SUSPEND：停机。'."\n"
+ ."\n"
+ .'- INVALID_NUMBER：空号。'."\n"
+ ."\n"
+ .'- POWERED_OFF：关机。'."\n"
+ ."\n"
+ .'- NETWORK_BUSY：网络忙。'."\n"
+ ."\n"
+ .'- NO_ANSWER：无应答。',
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'CALL_REJECTED',
+ ],
+ 'example' => '',
+ ],
+ 'RetryCount' => ['description' => '重呼次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ 'PhoneType' => ['type' => 'integer', 'format' => 'int64', 'example' => '17', 'description' => ''],
+ 'TaskName' => ['description' => '任务名称。', 'type' => 'string', 'example' => '测试任务'],
+ 'LineEncoding' => ['type' => 'string', 'example' => '示例值', 'description' => ''],
+ 'StartType' => [
+ 'description' => '启动方式。取值：'."\n"
+ ."\n"
+ .'- IMMEDIATE：立即启动。'."\n"
+ ."\n"
+ .'- SCHEDULE：定时启动。',
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'IMMEDIATE',
+ ],
+ 'AgentName' => ['description' => '智能体名称。', 'type' => 'string', 'example' => '测试智能体'],
+ 'AgentId' => ['description' => '已上线的智能体编码。', 'type' => 'string', 'example' => '1180**************'."\n"],
+ 'RetryInterval' => ['description' => '重试间隔。单位：分钟。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'CallDays' => [
+ 'description' => '可呼叫日列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '可呼叫日。取值：'."\n"
+ ."\n"
+ .'- MONDAY：周一。'."\n"
+ ."\n"
+ .'- TUESDAY：周二。'."\n"
+ ."\n"
+ .'- WEDNESDAY：周三。'."\n"
+ ."\n"
+ .'- THURSDAY：周四。'."\n"
+ ."\n"
+ .'- FRIDAY：周五。'."\n"
+ ."\n"
+ .'- SATURDAY：周六。'."\n"
+ ."\n"
+ .'- SUNDAY：周天。',
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'MONDAY',
+ ],
+ 'example' => '',
+ ],
+ 'ConcurrentCount' => ['description' => '任务并发。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ ],
+ 'example' => '',
+ ],
+ 'Code' => ['description' => '错误编码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'false'],
+ ],
+ 'description' => '',
],
],
+ ],
+ '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' => '查询呼叫任务基础信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ ],
+ 'QueryAiCallTaskPage' => [
+ 'summary' => '查询呼叫任务列表。',
+ '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' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
- 'name' => 'TimeRangeEnd',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时设置的每页行数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'default' => '10'],
],
[
- 'name' => 'InstanceId',
- 'in' => 'formData',
+ 'name' => 'Status',
+ 'in' => 'query',
'schema' => [
+ 'description' => '任务状态。取值：'."\n"
+ .'- INIT：初始化（未启动）。'."\n"
+ .'- FAILED：启动失败。'."\n"
+ .'- RUNNING：运行中。'."\n"
+ .'- 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,
+ 'enumValueTitles' => [],
+ 'example' => 'INIT',
],
],
[
- 'name' => 'GroupList',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'required' => false,
- 'maxItems' => 3,
- ],
+ 'name' => 'TaskName',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务名称，系统根据任务名称模糊检索。', 'type' => 'string', 'required' => false, 'example' => '测试任务'],
],
[
- 'name' => 'ServicerList',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- 'required' => false,
- 'maxItems' => 3,
- ],
+ 'name' => 'AgentName',
+ 'in' => 'query',
+ 'schema' => ['description' => '智能体名称，系统根据智能体名称模糊检索。', 'type' => 'string', 'required' => false, 'example' => '测试智能体'],
],
[
- 'name' => 'AnalysisIds',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'required' => true,
- 'maxItems' => 3,
- ],
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务ID。', 'type' => 'string', 'required' => false, 'example' => '1187**************'."\n"],
],
],
'responses' => [
@@ -25096,125 +14589,95 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '错误信息，正常调用时，不会返回该参数。', 'type' => 'string', 'example' => '参数不合法'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B99C5955-5664-573D-97BE-A7CC1AFD8401'],
'Data' => [
+ 'description' => '任务详细信息。',
'type' => 'object',
'properties' => [
- 'InstanceId' => [
- 'type' => 'string',
- ],
- 'Version' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'ProjectId' => [
- 'type' => 'integer',
- 'format' => 'int64',
+ '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' => '任务ID。',
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => '1187**************',
+ ],
+ 'CompleteRate' => ['description' => '任务完成率。', 'type' => 'string', 'example' => '70%'],
+ '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'],
+ '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' => '1180**************'."\n"],
+ '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' => '历史接通率。历史接通率=历史接通数量➗累计呼叫量（TotalCallCount）。', 'type' => 'string', 'example' => '95.89%'],
+ 'DayConnectRate' => ['description' => '当天接通率。当天接通率=当天接通数➗当天呼叫量（DayCallCount）。', 'type' => 'string', 'example' => '74.14%'],
+ ],
+ ],
+ 'example' => '',
],
],
],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- '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' => '查询呼叫任务列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '',
+ 'ramActions' => [],
],
- 'CreateQualityRule' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'QueryAiVoiceAgentDetail' => [
+ 'summary' => '查询通信智能体详情信息。',
+ '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' => '智能体ID。', 'type' => 'string', 'required' => false, 'example' => '123123********'],
],
],
'responses' => [
@@ -25222,271 +14685,647 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID。', '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' => '可取值唯一ID。', 'type' => 'string', 'example' => 'd5606d80-7625-dcea-xxxx-17f66fbb564a'],
+ ],
+ 'description' => '',
+ ],
+ 'example' => '',
+ ],
+ 'MainPurposeName' => ['description' => '主意图名称。', 'type' => 'string', 'example' => '通话效果评级'],
+ 'MainPurposeType' => ['description' => '主意图取值类型。目前只有ENUM类型。', 'type' => 'string', 'example' => 'ENUM'],
+ 'MainPurposeDescription' => ['description' => '主意图说明。', 'type' => 'string', 'example' => '通话效果评级：A、B、C、D，（A最好）'],
+ 'Id' => ['description' => '主意图ID。', 'type' => 'string', 'example' => '1ee6e994-08e0-xxxx-f662-1659cc54d409'],
+ ],
+ 'example' => '',
+ ],
+ 'ChildTaskList' => [
+ 'description' => '子任务配置列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ChildTaskName' => ['description' => '子任务名称。', 'type' => 'string', 'example' => '开场与邀约'],
+ 'ChildTaskDescription' => ['description' => '子任务描述。', 'type' => 'string', 'example' => '新用户邀约: \\"喂，家长您好！我是*****的王老师，我们现在有**课程100个试听名额，想帮宝贝安排一下体验，您看什么时候比较方便呢？\\'],
+ 'Id' => ['description' => '子任务唯一ID。', 'type' => 'string', 'example' => '280cd4bf-*******df472c'],
+ ],
+ 'description' => '',
+ ],
+ 'example' => '',
+ ],
+ 'CustomExceptionFileName' => ['description' => '自定义异常文件名称。', 'type' => 'string', 'example' => '异常测试文件.xlsx'],
+ 'StartWordType' => ['type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''],
+ 'BusinessType' => [
+ 'description' => '业务场景。',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'enumValueTitles' => [1 => '个人客户线索转化', '企业客户线索转化', '会员提醒-续费/复购场景', '会员提醒-促销/赠券场景', '简单客服-答疑类客服场景', '其他'],
+ 'example' => '1',
+ ],
+ 'CustomExceptionUrlPath' => ['description' => '废弃字段，后续会下掉。', 'type' => 'string', 'example' => '-'],
+ 'KnowledgeId' => ['description' => '知识库ID。', 'type' => 'string', 'example' => '1232131*******'],
+ 'KnowledgeDocOriginalNameList' => [
+ 'description' => '知识库文档原始文件名列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '文件名。', 'type' => 'string', 'example' => '**会话引擎测试.xlsx'],
+ 'example' => '',
+ ],
+ 'KnowledgeEnable' => ['description' => '是否关联知识库。', 'type' => 'boolean', 'example' => 'false'],
+ 'CustomExceptionEnable' => ['description' => '是否开启自定义异常处理。', 'type' => 'boolean', 'example' => 'false'],
+ 'Prologue' => ['description' => '开场白。', 'type' => 'string', 'example' => '你好，这里是******。'],
+ 'CustomExceptionFileId' => ['description' => '自定义异常文件ID。', 'type' => 'string', 'example' => 'OSS文件ID'],
+ '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' => '变量唯一ID。', 'type' => 'string', 'example' => '280cd4bf-*******df472c'."\n"],
+ 'PhoneTagSource' => ['type' => 'string', 'example' => '示例值', 'description' => ''],
+ 'PhoneTagDescription' => ['description' => '变量描述。', 'type' => 'string', 'example' => '用户感兴趣的车系。'],
+ 'PhoneTagEnum' => [
+ 'description' => '变量枚举值列表。只有变量值类型为ENUM时才有该字段。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['description' => '枚举值描述。', 'type' => 'string', 'example' => '客户完全不接受挽留'],
+ 'Value' => ['description' => '枚举值。', 'type' => 'string', 'example' => '完全不接受'],
+ 'Id' => ['description' => '枚举值唯一ID。', 'type' => 'string', 'example' => 'c3d4ff4e-*********bc26dc044682'],
+ ],
+ 'description' => '',
+ ],
+ 'example' => '',
+ ],
+ 'PhoneTagKey' => ['description' => '变量键名。', 'type' => 'string', 'example' => 'testParam'],
+ ],
+ 'description' => '',
+ ],
+ 'example' => '',
+ ],
+ 'FlowDesc' => ['description' => '高级任务流程描述。', 'type' => 'string', 'example' => '这次外呼通过三个核心步骤与家长沟通，........ 3. 用户需求 > 主动介绍'],
+ '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' => '标签枚举值，只有标签值类型为ENUM时才有该字段。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['description' => '标签枚举值描述。', 'type' => 'string', 'example' => '高（非常积极，大概率转化）'],
+ 'Value' => ['description' => '标签枚举值。', 'type' => 'string', 'example' => '高'],
+ 'Id' => ['description' => '标签枚举值唯一ID。', 'type' => 'string', 'example' => '8757************2c499fa'],
+ ],
+ 'description' => '',
+ ],
+ 'example' => '',
+ ],
+ 'OutputTagName' => ['description' => '标签名称。', 'type' => 'string', 'example' => '客户意向度'],
+ 'Id' => ['description' => '标签唯一ID。', 'type' => 'string', 'example' => '8757************2c499fa'."\n"],
+ ],
+ 'description' => '',
+ ],
+ 'example' => '',
+ ],
+ 'CustomExceptionVoiceStyle' => [
+ 'description' => '语言风格。',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'enumValueTitles' => [1 => '平实', '亲切', '专业', '严肃'],
+ 'example' => '2',
+ ],
+ 'RecordingFile' => ['type' => 'string', 'example' => '示例值', 'description' => ''],
+ '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'],
+ ],
+ 'description' => '',
+ ],
+ 'example' => '',
+ ],
+ 'KnowledgeDocNameList' => [
+ 'description' => '知识文档名列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '文件名。', 'type' => 'string', 'example' => '117d2********388f2a615be5c0d3546e.xlsx'],
+ 'example' => '',
+ ],
+ 'KnowledgeDocIdList' => [
+ 'description' => '知识文档ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '知识文档ID。', 'type' => 'string', 'example' => '12213******'],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'KnowledgeName' => ['description' => '知识库名称。', 'type' => 'string', 'example' => '测试知识库'],
+ 'VoiceStyleName' => ['description' => '语言风格名称。', 'type' => 'string', 'example' => '亲切'],
+ 'AgentId' => ['description' => '智能体ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12311212******'],
+ 'AgentName' => ['description' => '智能体名称。', 'type' => 'string', 'example' => '测试智能体'],
+ 'AiVoiceAgentCallConfig' => [
+ 'description' => '智能外呼语音配置。',
+ 'type' => 'object',
+ 'properties' => [
+ 'VocabId' => ['description' => '热词ID', 'type' => 'string', 'example' => 'afb2c43**********83e6df30551c11f7'],
+ 'TtsConfig' => [
+ 'description' => 'TTS配置。',
+ 'type' => 'object',
+ 'properties' => [
+ 'VoiceCode' => ['type' => 'string', 'example' => '示例值', 'description' => ''],
+ 'MixingTemplate' => ['type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''],
+ 'BackgroundEnabled' => ['type' => 'boolean', 'example' => 'true', 'description' => ''],
+ 'TtsVolume' => ['description' => 'TTS 播放的音量。'."\n"
+ .'> '."\n"
+ .'> - 取值范围：0~100，默认值为0。'."\n"
+ .'> - 不设置值时，默认取大模型应用配置的音量。', 'type' => 'integer', 'format' => 'int64', 'example' => '72'],
+ 'TtsStyle' => ['description' => '音色风格。', 'type' => 'string', 'example' => 'longxiaoxia_v2p1'],
+ 'VoiceType' => ['type' => 'string', 'example' => '示例值', 'description' => ''],
+ 'MixingEnabled' => ['type' => 'boolean', 'example' => 'true', 'description' => ''],
+ 'TtsSpeed' => ['description' => 'TTS 播放时的声音速度。'."\n"
+ ."\n"
+ .'> '."\n"
+ .'> - 取值范围：-200~200，默认值为 0；'."\n"
+ .'> - 不设置值时，默认取大模型应用配置的声音速度；', 'type' => 'integer', 'format' => 'int64', 'example' => '34'],
+ 'BackgroundSound' => ['type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''],
+ 'BackgroundVolume' => ['type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'EventConfig' => [
+ 'description' => '通话事件配置。',
+ 'type' => 'object',
+ 'properties' => [
+ 'MuteActive' => ['description' => '第一个静音是否唤起模型。', 'type' => 'boolean', 'example' => 'false'],
+ 'SessionTimeout' => ['description' => '最大通话时长，超时后自动挂断。单位：秒。'."\n"
+ .'>'."\n"
+ .'>- 最大取值：3600s。'."\n"
+ .'>- 最小取值：600s。', 'type' => 'integer', 'format' => 'int64', 'example' => '600'],
+ 'CallAssistantHangup' => ['description' => '识别到智能接听是否挂断。', 'type' => 'boolean', 'example' => 'false'],
+ 'CallAssistantRecognize' => ['description' => '智能接听识别是否开启。', 'type' => 'boolean', 'example' => 'true'],
+ 'MuteDuration' => ['description' => '静音时长。'."\n"
+ .'>'."\n"
+ .'>- 最大取值：15s。'."\n"
+ .'>- 最小取值：3s。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'MuteHangupNum' => ['description' => '连续多少个静音事件主动挂机。'."\n"
+ .'>'."\n"
+ .'>- 最大取值：5。'."\n"
+ .'>- 最小取值：1。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- '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' => '查询通信智能体详情信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:QueryAiVoiceAgentDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '',
],
- 'CreateThirdSsoAgent' => [
- 'summary' => '根据用户账号创建免登到客服工作台的坐席。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'QueryAiVoiceAgentDetailNew' => [
+ 'summary' => '查询指定智能体的详细信息，包括基础信息、分支信息、版本信息等。',
+ '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' => [
- 'title' => 'clientToken',
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'param1',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre***',
- ],
- ],
- [
- 'name' => 'ClientId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'param2',
- 'description' => '颁发给租户实例的clientId。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
- ],
- [
- 'name' => 'AccountId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'param3',
- 'description' => '要同步的账号ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'accountId1',
- ],
- ],
- [
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'param4',
- 'description' => '要同步的账号名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'accountName1',
- ],
- ],
- [
- 'name' => 'DisplayName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'param5',
- 'description' => '坐席显示名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '张三',
- ],
+ 'name' => 'BranchId',
+ 'in' => 'query',
+ 'schema' => ['description' => '分支 ID。为空时自动定位到当前生效分支。'."\n", 'type' => 'string', 'required' => false, 'example' => '12'],
],
[
- 'name' => 'SkillGroupIds',
- 'in' => 'formData',
- 'style' => 'flat',
- 'schema' => [
- 'title' => 'param6',
- 'description' => '技能组ID列表。'."\n"
- ."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '技能组ID。'."\n"
- .'> 所传技能组必须属于同一个技能组分组。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- 'required' => false,
- ],
+ 'name' => 'AgentId',
+ 'in' => 'query',
+ 'schema' => ['description' => '智能体ID。', 'type' => 'string', 'required' => true, 'example' => '1234***5678'],
],
[
- 'name' => 'RoleIds',
- 'in' => 'formData',
- 'style' => 'flat',
- 'schema' => [
- 'title' => 'param7',
- 'description' => '角色ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '角色ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- 'required' => false,
- ],
+ 'name' => 'VersionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '版本 ID。为空时取对应分支的最新发布版本。需与 BranchId 配合使用。', 'type' => 'string', 'required' => false, 'example' => '21'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'result',
- 'description' => 'result',
+ 'description' => '智能体详情数据。'."\n",
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => 'message',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => 'requestId',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'title' => 'httpStatusCode',
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。'."\n", 'type' => 'string', 'example' => 'None'],
+ 'RequestId' => ['description' => '请求 ID。'."\n", 'type' => 'string', 'example' => '742C9243-2870-B8D6-0C68-C12345AABBCC0'],
+ 'Message' => ['description' => '状态码描述。'."\n", 'type' => 'string', 'example' => '成功'],
'Data' => [
- 'title' => '新创建的坐席id',
- 'description' => '创建的坐席ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123456',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => 'success',
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '智能体详情数据。'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'AgentCallConfig' => [
+ 'description' => '智能外呼语音配置。'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'StartWordType' => ['description' => '开场白类型。0为文本，1 为录音。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Prologue' => ['description' => '开场白。'."\n", 'type' => 'string', 'example' => '你好，这里是******。'],
+ 'VocabId' => ['description' => '热词库 ID。'."\n", 'type' => 'string', 'example' => 'afb2c43**********83e6df30551c11f7'],
+ 'TtsConfig' => [
+ 'description' => 'TTS 配置。'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'VoiceCode' => ['description' => '音色编码。'."\n", 'type' => 'string', 'example' => 'V123ABC00'],
+ 'MixingTemplate' => ['description' => '混音模板 ID。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'BackgroundEnabled' => ['description' => '是否开启背景音。'."\n", 'type' => 'boolean', 'example' => 'true'],
+ 'TtsVolume' => ['description' => 'TTS 播放的音量。取值范围：0~100。', 'type' => 'integer', 'format' => 'int64', 'example' => '88'],
+ 'TtsStyle' => ['description' => '音色风格。'."\n", 'type' => 'string', 'example' => 'longxiaoxia_v2p1'],
+ 'ResourceId' => ['description' => '资源ID。（仅三方音色需要）', 'type' => 'string', 'example' => 'voice-12345'],
+ 'CustomerAccountId' => ['description' => '三方音色平台账号', 'type' => 'integer', 'format' => 'int64', 'example' => '75'],
+ 'VoiceType' => ['description' => 'TTS音色类型枚举值。'."\n"
+ ."\n"
+ .'`VOICE_TYPE_SYSTEM`-系统音色。'."\n"
+ ."\n"
+ .'`VOICE_TYPE_CLONE`-克隆音色。'."\n"
+ ."\n"
+ .'`VOICE_TYPE_DOUBAO`-豆包音色。'."\n"
+ ."\n"
+ .'`VOICE_TYPE_MINIMAX`-Minimax音色。'."\n"
+ ."\n"
+ .'`VOICE_TYPE_OPENTTS`-开放音色。'."\n"
+ ."\n"
+ .'`VOICE_TYPE_BL_CUSTOM`-定制精品复刻音色。', 'type' => 'boolean', 'example' => 'VOICE_TYPE_SYSTEM'],
+ 'MixingEnabled' => ['description' => '是否开启混音。'."\n", 'type' => 'boolean', 'example' => 'true'],
+ 'TtsSpeed' => ['description' => 'TTS 播放时的声音速度。取值范围：-200~200，默认 0。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'BackgroundSound' => ['description' => '背景音 ID。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '17'],
+ 'BackgroundVolume' => ['description' => '背景音音量。0-低、1-中、2-高。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ ],
+ 'example' => '',
+ ],
+ 'EventConfig' => [
+ 'description' => '事件配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'MuteActive' => ['description' => '第一个静音是否唤起模型。'."\n", 'type' => 'boolean', 'example' => 'true'],
+ 'SessionTimeout' => ['description' => '最大通话时长（秒）。最小 600s，最大 3600s。超时后自动挂断。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
+ 'CallAssistantHangup' => ['description' => '识别到智能接听是否挂断。'."\n", 'type' => 'boolean', 'example' => 'false'],
+ 'CallAssistantRecognize' => ['description' => '智能接听识别是否开启。'."\n", 'type' => 'boolean', 'example' => 'true'],
+ 'MuteDuration' => ['description' => '静音时长（秒）。最小 3s，最大 15s。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'MuteHangupNum' => ['description' => '连续多少个静音事件主动挂机。最小 1，最大 5。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ ],
+ 'example' => '',
+ ],
+ 'RecordingFile' => ['description' => '开场白录音音频文件地址。仅 StartWordType=1 时有值。'."\n", 'type' => 'string', 'example' => '/oss-file-key'],
+ 'TransferConfig' => [
+ 'description' => '转坐席配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'SeatRouteName' => ['description' => '坐席线路名称', 'type' => 'string', 'example' => '人工座席'],
+ 'CalledNumber' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '123111122222'],
+ 'CustomerRouteCode' => ['description' => '客户线路编码', 'type' => 'string', 'example' => '123'],
+ 'CallingNumberType' => ['description' => '被叫号码类型', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Enabled' => ['description' => '是否启用', 'type' => 'boolean', 'example' => 'false'],
+ 'CallerNumberType' => ['description' => '主叫号码类型', 'type' => 'integer', 'format' => 'int64', 'example' => '48'],
+ 'ExtraInfo' => ['description' => '补充信息。', 'type' => 'string', 'example' => 'Additional information for the agent'],
+ 'TransferType' => ['description' => '转坐席类型', 'type' => 'integer', 'format' => 'int64', 'example' => '73'],
+ 'CallingNumber' => ['description' => '接听方号码。例如用户手机号码、客服坐席号码、机器号码等。', 'type' => 'string', 'example' => '123111122222'],
+ 'CallerNumber' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '123111122222'],
+ 'TransferBizId' => ['description' => '业务id', 'type' => 'string', 'example' => '123'],
+ 'SeatRouteCode' => ['description' => '坐席线路编码', 'type' => 'string', 'example' => 'SEAT_CTI_A_NET'],
+ 'TransferContent' => ['description' => '转人工坐席提示语', 'type' => 'string', 'example' => '提示语'],
+ 'FailureContent' => ['description' => '转人工坐席失败提示', 'type' => 'string', 'example' => '失败说明'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'AgentMode' => ['description' => '构建方式。枚举值：'."\n"
+ .'- 0：提示词模式。'."\n"
+ .'- 1：对话流模式。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'BranchDesc' => ['description' => '分支描述。'."\n", 'type' => 'string', 'example' => '默认分支'],
+ 'BranchDeployStatus' => ['description' => '部署状态。枚举值：'."\n"
+ .'- 0：未生效（NOT_EFFECT）。'."\n"
+ .'- 1：生效中（EFFECT）。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'BranchId' => ['description' => '分支 ID。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '18'],
+ 'BranchName' => ['description' => '分支名称', 'type' => 'string', 'example' => '默认版本'],
+ 'Scene' => ['description' => '场景', 'type' => 'string', 'example' => '个人客户线索转化'],
+ 'AgentDemandConfig' => [
+ 'description' => '智能体业务需求配置。'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'BasicTaskDescription' => ['description' => '基础任务配置。', 'type' => 'string', 'example' => '进行产品营销，介绍优势特点'],
+ 'CoreTarget' => ['description' => '核心目标', 'type' => 'string', 'example' => '销售线索转化'],
+ 'AiGenerate' => ['description' => '是否AI辅助构建', 'type' => 'boolean', 'example' => 'false'],
+ 'UserRole' => ['description' => '用户角色', 'type' => 'string', 'example' => '潜在客户'],
+ 'BusinessType' => ['description' => '业务场景。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'SysRole' => ['description' => '系统角色。', 'type' => 'string', 'example' => '销售'],
+ ],
+ 'example' => '',
+ ],
+ 'SummaryConfig' => [
+ 'description' => '通话小记配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'MainPurpose' => [
+ 'description' => '主意图',
+ 'type' => 'object',
+ 'properties' => [
+ 'MainPurposeEnum' => [
+ 'description' => '主意图可取值',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '主意图可取值枚举',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['description' => '可取值说明。', 'type' => 'string', 'example' => 'Description of the tag value'],
+ 'Value' => ['description' => '可取值。', 'type' => 'string', 'example' => 'Tag value example'],
+ 'Id' => ['description' => '标签唯一ID。', 'type' => 'string', 'example' => 'tag_12345'],
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'MainPurposeName' => ['description' => '主意图名称。', 'type' => 'string', 'example' => 'Customer inquiry handling'],
+ 'MainPurposeType' => ['description' => '主意图取值类型。文本类型: TEXT，可取值类型：ENUM', 'type' => 'string', 'example' => 'ENUM'],
+ 'MainPurposeDescription' => ['description' => '主意图说明。', 'type' => 'string', 'example' => 'Description of the main intent'],
+ 'Id' => ['description' => '主意图ID。', 'type' => 'string', 'example' => '123'],
+ ],
+ 'example' => '',
+ ],
+ 'CallResultTagConfig' => [
+ 'description' => '呼叫结果标签映射配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'MappingTag' => [
+ 'description' => '呼叫结果与标签映射',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'example' => '"CANCEL": "{\\"tag\\":\\"test\\",\\"desc\\":\\"11\\"}"', 'description' => '呼叫结果与标签映射'],
+ ],
+ 'DefaultTag' => [
+ 'description' => '默认兜底标签信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Desc' => ['description' => '说明', 'type' => 'string', 'example' => '标签说明'],
+ 'Tag' => ['description' => '标签', 'type' => 'string', 'example' => '标签1'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'OutputTagConfig' => [
+ 'description' => '输出标签配置',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '输出标签配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'OutputTagDescription' => ['description' => '输出标签描述信息。', 'type' => 'string', 'example' => '用户购买产品的意愿'],
+ 'OutputTagType' => ['description' => '输出标签值类型。文本类型: TEXT，可取值类型：ENUM', 'type' => 'string', 'example' => 'ENUM'],
+ 'OutputTagEnum' => [
+ 'description' => '输出标签可选项。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签枚举值，只有标签值类型为ENUM时才有该字段。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['description' => '标签描述', 'type' => 'string', 'example' => '用户有较高购买意愿'],
+ 'Value' => ['description' => '标签枚举值。', 'type' => 'string', 'example' => '高意愿'],
+ 'Id' => ['description' => '标签ID。', 'type' => 'string', 'example' => '10'],
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'OutputTagName' => ['description' => '输出标签名称。', 'type' => 'string', 'example' => '购买意愿'],
+ 'Id' => ['description' => '输出标签ID', 'type' => 'string', 'example' => '123'],
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'PhoneTagConfig' => [
+ 'description' => '通话变量配置',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '通话变量配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'PhoneTagType' => ['description' => '通话变量类型。文本类型: TEXT，可取值类型：ENUM', 'type' => 'string', 'example' => 'ENUM'],
+ 'PhoneTagName' => ['description' => '通话变量说明', 'type' => 'string', 'example' => '用户性别'],
+ 'PhoneTagRequired' => ['description' => '通话变量是否必填', 'type' => 'boolean', 'example' => 'false'],
+ 'Id' => ['description' => '通话变量ID', 'type' => 'string', 'example' => '123'],
+ 'PhoneTagSource' => ['description' => '通话变量来源', 'type' => 'string', 'example' => 'MANUAL_CREATE'],
+ 'PhoneTagKey' => ['description' => '通话变量键名', 'type' => 'string', 'example' => 'gender'],
+ 'PhoneTagEnum' => [
+ 'description' => '通话变量标签可选值',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '通话变量标签可选值',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['description' => '说明', 'type' => 'string', 'example' => 'gender'],
+ 'Value' => ['description' => '标签值', 'type' => 'string', 'example' => 'male'],
+ 'Id' => ['description' => '标签ID', 'type' => 'string', 'example' => '123'],
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'AgentDesc' => ['description' => '智能体描述。'."\n", 'type' => 'string', 'example' => '日常测试使用。'],
+ 'AgentId' => ['description' => '智能体ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3021893791'],
+ 'AgentName' => ['description' => '智能体名称。', 'type' => 'string', 'example' => '测试智能体'],
+ 'KnowledgeConfig' => [
+ 'description' => '知识库配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'KnowledgeIds' => [
+ 'description' => '知识库集合',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '知识库集合',
+ 'type' => 'object',
+ 'properties' => [
+ 'KnowledgeName' => ['description' => '知识库名称。', 'type' => 'string', 'example' => '产品知识库'],
+ 'KnowledgeId' => ['description' => '知识库ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '68'],
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'RagConfig' => [
+ 'description' => 'RAG 配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['description' => 'RAG检索描述', 'type' => 'string', 'example' => '知识库检索'],
+ 'Enabled' => ['description' => '是否开启RAG检索', 'type' => 'boolean', 'example' => 'false'],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'VersionId' => ['description' => '版本 ID。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '89'],
+ 'VersionPublishTime' => ['description' => '版本最近一次发布时间。'."\n", 'type' => 'string', 'example' => '2024-01-15 10:30:00 '],
+ 'VersionPublishStatus' => ['description' => '版本发布状态。0为未发布，1为已发布，2为草稿', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'VersionName' => ['description' => '版本名称。', 'type' => 'string', 'example' => '测试版本1'],
+ 'VersionDesc' => ['description' => '版本描述', 'type' => 'string', 'example' => '测试第一个版本'],
+ ],
+ 'example' => '',
],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询通信智能体详情（新模式）',
+ 'description' => '## 请求说明'."\n"
+ .'- 该接口用于查询通信智能体的详细信息。'."\n"
+ .'- 当 `BranchId` 和 `VersionId` 均为空时，返回当前生效分支的最新已发布版本配置（如生效分支仅有草稿版本，则不返回）。'."\n"
+ .'- 仅 `BranchId` 有值时，返回该分支的最新已发布版本配置（如生效分支仅有草稿版本，则不返回）。'."\n"
+ .'- `BranchId` 和 `VersionId` 均有值时，返回指定版本对应配置。'."\n"
+ .'- 当 `BranchDeployStatus = 1` (分支已部署上线) 且 `VersionPublishStatus = 1` (版本已发布) 时，该分支配置是目前导入的外呼任务会使用的配置。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- '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' => '创建免登到客服工作台的坐席',
+ 'ramActions' => [],
+ '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' => '查询呼叫通话详情信息。',
+ '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' => '任务ID。在**呼叫任务管理**界面查看任务ID或通过[QueryAiCallTaskPage](~~2926799~~)接口获取任务ID。', 'type' => 'string', 'required' => true, 'example' => '138************'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'DetailId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => '任务明细ID。在**呼叫任务管理**>**详情**>**执行记录**>**已完成**>**通话详情**界面左上角查看任务明细ID或通过[QueryAiCallDetailPage](~~2926853~~)接口获取任务明细ID。', 'type' => 'string', 'required' => true, 'example' => '9662*************'],
+ ],
+ [
+ 'name' => 'BatchId',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务批次ID。即为导入被叫数据时返回的批次ID，在**呼叫任务管理**>**详情**>**执行记录**界面查看任务批次ID或通过[ImportTaskNumberDatas](~~2926815~~)接口导入被叫数据时返回的导入批次ID。', 'type' => 'string', 'required' => true, 'example' => '139*********216'],
],
],
'responses' => [
@@ -25494,46 +15333,183 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F2051E18-FF3F-5C08-8D24-6F150D2AF757'],
'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
+ 'description' => '返回结果数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CallerPhone' => ['description' => '主叫号码', 'type' => 'string', 'example' => '0571*******'],
+ 'CallResult' => ['description' => '呼叫结果。取值：'."\n"
+ .'- CALL_FORWARDING：呼叫转移。'."\n"
+ .'- INCOMING_CALL_BARRED：限制呼入。'."\n"
+ .'- CALL_REJECTED：拒接。'."\n"
+ .'- ANSWERED：用户接通。'."\n"
+ .'- USER_BUSY：被叫忙。'."\n"
+ .'- POWERED_OFF：关机。'."\n"
+ .'- NO_USER_RESPONSE：不在服务区。'."\n"
+ .'- OPERATOR_BLOCK：运营商拦截。'."\n"
+ .'- OTHERS：其他状态。'."\n"
+ .'- SUSPEND：停机。'."\n"
+ .'- CANCEL：主叫取消。'."\n"
+ .'- INVALID_NUMBER：空号。'."\n"
+ .'- UNAVAILABLE：暂时无法接通。'."\n"
+ .'- NETWORK_BUSY：网络忙。'."\n"
+ .'- NO_ANSWER：无应答。', 'type' => 'string', 'example' => 'ANSWERED'],
+ 'StatusMsg' => ['description' => '运营商返回的呼叫状态信息。', 'type' => 'string', 'example' => '呼叫结束（双呼）'],
+ 'StartCallTime' => ['description' => '开始呼叫时间，时间戳，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '123123123123123'],
+ 'MajorIntent' => ['description' => '主意图', 'type' => 'string', 'example' => 'D'],
+ 'CallId' => ['description' => '通话唯一ID。', 'type' => 'string', 'example' => '1231231231213^11231231231'],
+ 'FailedReason' => ['description' => '失败原因', 'type' => 'string', 'example' => '主动取消'],
+ 'Duration' => ['description' => '通话时长，未打通情况下为0，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'],
+ 'HangupDirection' => ['description' => '挂断方向。取值：'."\n"
+ ."\n"
+ .'- **0**：用户。'."\n"
+ .'- **1**：机器人。', 'type' => 'string', 'example' => '用户'],
+ 'StatusCode' => ['description' => '呼叫状态码。在语音服务[呼叫状态码](~~112804~~)中查看。', 'type' => 'string', 'example' => '200005'],
+ 'CalledPhone' => ['description' => '被叫号码', 'type' => 'string', 'example' => '186******'],
+ 'Variables' => [
+ 'description' => '通话变量列表。即为您创建的呼叫任务所关联的通话变量。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '通话变量信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Required' => ['description' => '是否必填。取值：'."\n"
+ ."\n"
+ .'- true：是。'."\n"
+ ."\n"
+ .'- false：否。', 'type' => 'boolean', 'example' => 'false'],
+ 'Value' => ['description' => '变量值。', 'type' => 'string', 'example' => '张三'],
+ 'Id' => ['description' => '变量ID。', 'type' => 'string', 'example' => '22'],
+ 'Key' => ['description' => '变量Key。', 'type' => 'string', 'example' => 'name'],
+ 'Source' => ['type' => 'string', 'example' => '示例值', 'description' => ''],
+ 'Name' => ['description' => '变量名称。', 'type' => 'string', 'example' => '姓名'],
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'RecordingFileDownloadUrl' => ['description' => '录音文件下载地址，只有生成录音文件后才有该字段。', 'type' => 'string', 'example' => 'https://********'],
+ 'ReleaseTime' => ['description' => '通话结束时间，时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '98'],
+ 'PickUpTime' => ['description' => '电话接听时间。时间戳格式，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1754617273000'],
+ 'OutId' => ['description' => '外部传入的业务流水号，可用唯一ID做业务关联。', 'type' => 'string', 'example' => 'bb3bc32d-54b8-49c4-80d3-61583417d22e'."\n"],
+ 'ConversationRecord' => ['description' => '聊天记录信息。结构为JSON数组，聊天记录时按照时间顺序已经排序好了。具体如下：'."\n"
+ .'```json'."\n"
+ .'['."\n"
+ .' {'."\n"
+ .' "content":"聊天内容",'."\n"
+ .' "role":"角色",//可取值：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"
+ .']'],
+ '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' => '标签ID。', 'type' => 'string', 'example' => '9ca2*****************************'],
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- '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' => '呼叫通话详情',
+ 'description' => '- 您可通过此接口查询通话详细，也可在**呼叫任务管理**>**详情**>**执行记录**>**已完成**>**通话详情**界面查看通话详情。'."\n"
+ ."\n"
+ .'- 在调用此接口前，请确保您已创建呼叫任务且已导入被叫数据。'."\n"
+ ."\n"
+ .'- 若您没有已创建的呼叫任务，可在**呼叫任务管理**界面创建呼叫任务并导入被叫数据，或通过[CreateAiCallTask](~~2926796~~)、[ImportTaskNumberDatas](~~2926815~~)接口创建呼叫任务并导入被叫数据。',
+ '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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '',
],
- 'DeleteOuterAccount' => [
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'QueryConversationDetailInfoNew' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -25541,431 +15517,477 @@
],
'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' => '外部账号ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123456',
- ],
+ 'schema' => ['description' => '任务ID。在**呼叫任务管理**界面查看任务ID或通过[QueryAiCallTaskPage](~~2926799~~)接口获取任务ID。', 'type' => 'string', 'required' => true, 'example' => '138************'],
],
[
- 'name' => 'OuterAccountType',
+ 'name' => 'DetailId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部账号类型。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'aliyun',
- ],
+ 'schema' => ['description' => '任务明细ID。在**呼叫任务管理**>**详情**>**执行记录**>**已完成**>**通话详情**界面左上角查看任务明细ID或通过[QueryAiCallDetailPage](~~2926853~~)接口获取任务明细ID。', 'type' => 'string', 'required' => false, 'example' => '9662*************'],
+ ],
+ [
+ 'name' => 'CallId',
+ 'in' => 'query',
+ 'schema' => ['description' => '通话唯一 ID。', 'type' => 'string', 'required' => false, 'example' => '1552********^1420********'],
+ ],
+ [
+ 'name' => 'OutId',
+ 'in' => 'query',
+ 'schema' => ['description' => '预留给外部传入的业务流水号，可用唯一 ID 做业务关联。', 'type' => 'string', 'required' => false, 'example' => '123******'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '状态码描述。 ', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
'Data' => [
- 'description' => '是否成功。取值：'."\n"
- .'- **true**：成功'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '返回结果数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CallerPhone' => ['description' => '主叫号码', 'type' => 'string', 'example' => '0571*******'],
+ 'Options' => ['description' => '运行时用到的变量信息，会以Key-Value的形式存储在该字段中。', 'type' => 'string', 'example' => '{'."\n"
+ .' "date": "666",'."\n"
+ .' "phoneNumber": "777",'."\n"
+ .' "distance": "555",'."\n"
+ .' "mendian": "444",'."\n"
+ .' "sex": "男",'."\n"
+ .' "name": "111",'."\n"
+ .' "age": "222"'."\n"
+ .'}'],
+ 'CallResult' => ['description' => '呼叫结果。取值：'."\n"
+ .'- CALL_FORWARDING：呼叫转移。'."\n"
+ .'- INCOMING_CALL_BARRED：限制呼入。'."\n"
+ .'- CALL_REJECTED：拒接。'."\n"
+ .'- ANSWERED：用户接通。'."\n"
+ .'- USER_BUSY：被叫忙。'."\n"
+ .'- POWERED_OFF：关机。'."\n"
+ .'- NO_USER_RESPONSE：不在服务区。'."\n"
+ .'- OPERATOR_BLOCK：运营商拦截。'."\n"
+ .'- OTHERS：其他状态。'."\n"
+ .'- SUSPEND：停机。'."\n"
+ .'- CANCEL：主叫取消。'."\n"
+ .'- INVALID_NUMBER：空号。'."\n"
+ .'- UNAVAILABLE：暂时无法接通。'."\n"
+ .'- NETWORK_BUSY：网络忙。'."\n"
+ .'- NO_ANSWER：无应答。', 'type' => 'string', 'example' => 'ANSWERED'],
+ 'StatusMsg' => ['description' => '运营商返回的呼叫状态信息。', 'type' => 'string', 'example' => '呼叫结束（双呼）'],
+ 'ConversationTurnCount' => ['description' => '对话轮次。', 'type' => 'integer', 'format' => 'int64', 'example' => '23'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '138************'],
+ 'StartCallTime' => ['description' => '开始呼叫时间，时间戳，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1286987391'],
+ 'StatusCode' => ['description' => '呼叫状态码。在语音服务[呼叫状态码](~~112804~~)中查看。', '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' => '变量ID', 'type' => 'string', 'example' => '123'],
+ 'Key' => ['description' => '变量Key', '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' => '聊天记录信息。结构为JSON数组，聊天记录时按照时间顺序已经排序好了。具体如下：'."\n"
+ .'```json'."\n"
+ .'['."\n"
+ .' {'."\n"
+ .' "content":"聊天内容",'."\n"
+ .' "role":"角色",//可取值：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"
+ .' }]'],
+ 'Status' => ['description' => '智能体状态。', 'type' => 'integer', 'format' => 'int64', 'example' => '72'],
+ 'ImportedTime' => ['description' => '导入时间，时间戳，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '43'],
+ 'EncryptionType' => ['type' => 'integer', 'format' => 'int64', 'example' => '28', 'description' => ''],
+ 'MajorIntent' => ['description' => '主意图', 'type' => 'string', 'example' => 'A'],
+ 'CallId' => ['description' => '通话唯一ID。', 'type' => 'string', 'example' => '123*******^213******'],
+ 'BatchId' => ['description' => '批次号ID。', 'type' => 'string', 'example' => '1234******'],
+ 'FailedReason' => ['description' => '失败原因', 'type' => 'string', 'example' => '主动取消'],
+ 'Duration' => ['description' => '通话时长，未打通情况下为0，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
+ 'HangupDirection' => ['description' => '挂断方向。取值：'."\n"
+ ."\n"
+ .'- **0**：用户。'."\n"
+ .'- **1**：机器人。', 'type' => 'string', 'example' => '0'],
+ 'DetailId' => ['description' => '任务明细ID。', 'type' => 'string', 'example' => '1234*******'],
+ 'ReleaseTime' => ['description' => '通话结束时间，时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
+ 'OutId' => ['description' => '外部传入的业务流水号，可用唯一ID做业务关联。', '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' => '标签ID。', 'type' => 'string', 'example' => '12'],
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorMessage' => 'A system error occurred. Please contact the administrator.',
- 'errorCode' => 'SystemError',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '呼叫任务明细及通话详情',
+ 'summary' => '查询呼叫任务明细信息和通话详情信息。',
+ 'description' => '- 您可通过此接口查询通话详细，也可在**呼叫任务管理**>**详情**>**执行记录**>**已完成**>**通话详情**界面查看通话详情。'."\n"
+ ."\n"
+ .'- 在调用此接口前，请确保您已创建呼叫任务且已导入被叫数据。'."\n"
+ ."\n"
+ .'- 若您没有已创建的呼叫任务，可在**呼叫任务管理**界面创建呼叫任务并导入被叫数据，或通过[CreateAiCallTask](~~2926796~~)、[ImportTaskNumberDatas](~~2926815~~)接口创建呼叫任务并导入被叫数据。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', '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' => '删除外部账号',
- 'summary' => '调用DeleteOuterAccount根据外部账号ID删除外部账号。',
+ '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' => '外部技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
[
- 'name' => 'ProjectId',
+ 'name' => 'OuterGroupType',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '外部技能组类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mybank'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Data' => ['description' => '热线坐席数据。', 'type' => 'string', 'example' => '{"n_online_now":10,"n_idle_now":3,"n_resttype_now":3,"n_acw_now":1}'],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '',
- ],
- 'DeleteQualityRule' => [
- 'methods' => [
- 'post',
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '查询队列中热线',
+ 'summary' => '调用QueryHotlineInQueue根据技能组ID获取热线技能组坐席数据。',
+ 'responseParamsDescription' => 'n_online_now ： 在线客服量'."\n"
+ .'n_idle_now ： 空闲客服量'."\n"
+ .'n_resttype_now： 小休客服量'."\n"
+ .'n_acw_now ： 话后处理客服量',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'QueryHotlineNumber' => [
+ 'summary' => '根据实例ID查询热线号码配置列表，支持通过热线号码模糊查询。',
+ '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' => ['title' => '实例id', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'Id',
+ 'name' => 'CurrentPage',
'in' => 'query',
+ 'schema' => ['title' => '当前页码', 'description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页大小', 'description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '20', 'minimum' => '1', 'example' => '10'],
+ ],
+ [
+ 'name' => 'HotlineNumber',
+ 'in' => 'query',
+ 'schema' => ['title' => '号码（支持模糊查询）', 'description' => '热线号码。支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => '0571****2211'],
+ ],
+ [
+ 'name' => 'DepartmentId',
+ 'in' => 'query',
+ 'schema' => ['title' => '部门id（技能组分组）', 'description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2256****'],
+ ],
+ [
+ 'name' => 'GroupIds',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
+ 'title' => '技能组列表',
+ 'description' => '技能组列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '技能组ID。结合技能组分组ID使用。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '["6083****","6084****"]'],
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE339D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
+ 'title' => '返回结果数据',
+ 'description' => '热线号码配置信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['title' => '数据总量', 'description' => '数据总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
+ 'PageSize' => ['title' => '每页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'CurrentPage' => ['title' => '当前页面', 'description' => '当前页面。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'HotlineNumList' => [
+ 'title' => '号码列表',
+ 'description' => '号码列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '号码列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'FlowId' => ['title' => '入呼流程id', 'description' => '入呼流程ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
+ 'Description' => ['title' => '号码描述', 'description' => '号码描述。', 'type' => 'string', 'example' => '测试'],
+ 'OutboundEnabled' => ['title' => '是否用于外呼', 'description' => '是否用于外呼。', 'type' => 'boolean', 'example' => 'true'],
+ 'CalloutAllDepartment' => ['title' => '外呼针对所有部门生效', 'description' => '外呼针对所有部门生效。', 'type' => 'boolean', 'example' => 'true'],
+ 'FlowName' => ['title' => '入呼流程名称', 'description' => '入呼流程名称。', 'type' => 'string', 'example' => '测试流程'],
+ 'CalloutRangeList' => [
+ 'title' => '外呼生效列表',
+ 'description' => '外呼生效列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '外呼生效列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupDOList' => [
+ 'title' => '技能组列表',
+ 'description' => '技能组列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '技能组列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupName' => ['title' => '技能组名称', 'description' => '技能组名称。', 'type' => 'string', 'example' => '技能组A'],
+ 'GroupId' => ['title' => '技能组id', 'description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '6083****'],
+ ],
+ ],
+ ],
+ 'DepartmentName' => ['title' => '部门名称', 'description' => '部门名称。', 'type' => 'string', 'example' => '部门A'],
+ 'DepartmentId' => ['title' => '部门id', 'description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2256****'],
+ ],
+ ],
+ ],
+ 'HotlineNumber' => ['title' => '号码', 'description' => '热线号码。', 'type' => 'string', 'example' => '0571****2211'],
+ 'EvaluationStatus' => ['title' => '满意度状态', 'description' => '满意度状态。取值：'."\n"
+ .'- **0**：入呼外呼均不开启。'."\n"
+ .'- **1**：入呼开启。'."\n"
+ .'- **2**：外呼开启。'."\n"
+ .'- **3**：入呼外呼均开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Sp' => ['title' => '运营商', 'description' => '运营商。', 'type' => 'string', 'example' => '电信'],
+ 'Location' => ['title' => '归属地', 'description' => '号码归属地。', 'type' => 'string', 'example' => '浙江杭州'],
+ 'InBoundEnabled' => ['title' => '是否用于入呼', 'description' => '是否用于入呼。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ ],
+ ],
+ ],
],
+ 'Code' => ['title' => '错误码', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['title' => '是否成功', 'description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorMessage' => 'A system error occurred. Please contact the administrator.',
- 'errorCode' => 'SystemError',
- ],
- ],
+ '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' => '查询热线号码配置列表',
+ 'description' => '热线号码配置包含热线号码、号码归属地、运营商、是否用于入呼等信息，具体参见[返回参数](#api-detail-40)。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-22T12:36:22.000Z', 'description' => 'OpenAPI 下线'],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryHotlineNumber'],
+ ],
],
- 'responseDemo' => '',
+ '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' => ''],
],
[
- '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'],
],
[
- 'name' => 'ProjectName',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'TaskName',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- 'name' => 'CheckFreqType',
+ 'name' => 'StartDate',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '100',
- 'minimum' => '1',
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- 'name' => 'ProjectVersion',
+ 'name' => 'EndDate',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '100',
- 'minimum' => '1',
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- 'name' => 'ScopeType',
+ 'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '100',
- 'minimum' => '1',
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- 'name' => 'TimeRangeStart',
+ 'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- 'name' => 'TimeRangeEnd',
+ 'name' => 'SkillGroup',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775700', 'minimum' => '0'],
],
[
- '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],
],
[
- '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],
],
[
- '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],
],
[
- 'name' => 'ServicerList',
+ 'name' => 'DepartmentId',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- 'required' => false,
- 'maxItems' => 3,
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
- '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],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'default' => '20'],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'default' => '1'],
],
],
'responses' => [
@@ -25973,232 +15995,267 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'HttpStatusCode' => ['type' => 'string'],
'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'],
+ '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' => 'boolean',
- ],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'string'],
],
],
],
],
'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' => '',
+ '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"}]',
],
- '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' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'Name',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'PageNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1'],
],
[
- 'name' => 'RuleTag',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '20'],
],
[
- 'name' => 'MatchType',
- 'in' => 'formData',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '1000',
- 'minimum' => '1',
- ],
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-****-70b6a298d94d'],
],
[
- 'name' => 'QualityRuleId',
- 'in' => 'formData',
+ 'name' => 'ChannelType',
+ 'in' => 'query',
'schema' => [
+ 'title' => '技能组类型（1：热线，2：在线，4：工单）',
+ 'description' => '技能组渠道类型。取值：'."\n"
+ ."\n"
+ .'- **0**：返回所有技能组。'."\n"
+ .'- **1**：热线技能组。'."\n"
+ .'- **2**：在线技能组。'."\n"
+ .'- **3**：在线+热线技能组。'."\n"
+ .'- **4**：工单技能组。'."\n"
+ .'- **5**：热线+工单节能组。'."\n"
+ .'- **6**：在线+工单技能组。'."\n"
+ .'- **7**：在线+热线+工单技能组。',
'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2',
+ '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' => ['title' => '部门ID', 'description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1023****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
+ 'OnePageSize' => ['description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'TotalPage' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'CurrentPage' => ['description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalResults' => ['description' => '总共记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '76'],
+ 'Data' => [
+ 'description' => '数据。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['description' => '技能组描述。', 'type' => 'string', 'example' => '自动化技能组'],
+ 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '自动化技能组'],
+ 'DisplayName' => ['description' => '技能组对外显示名称。', 'type' => 'string', 'example' => '自动化技能组'],
+ 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
+ 'ChannelType' => ['description' => '技能组渠道类型。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ ],
+ ],
],
],
],
],
],
'errorCodes' => [
- 500 => [
- [
- 'errorMessage' => 'The specified parameter is invalid.',
- 'errorCode' => 'InvalidParameter',
- ],
+ 400 => [
+ ['errorMessage' => 'The specified instance is unavailable or does not exist.', 'errorCode' => 'InvalidInstanceId', 'description' => '当前实例不可用或不存在'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '',
- ],
- 'EditQualityRuleTag' => [
- 'methods' => [
- 'post',
- 'get',
+ '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' => '查询技能组',
+ 'summary' => '根据实例ID查询悉犀客服工作台技能组列表。',
+ 'description' => '此接口可查询技能组的对外显示名称、描述、渠道类型、ID等信息，具体参见[返回参数](#api-detail-40)。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：1000次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [
+ ['createdAt' => '2021-05-21T09:25:21.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ '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],
+ ],
+ [
+ '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',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775700', 'minimum' => '0'],
+ ],
+ [
+ 'name' => 'Ani',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'Dnis',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'Sid',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'DepartmentIdList',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false],
+ ],
+ [
'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
[
- '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'],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '0', 'default' => '1'],
],
],
'responses' => [
@@ -26206,148 +16263,183 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'HttpStatusCode' => ['type' => 'string'],
'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
+ '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'],
+ ],
+ ],
+ ],
+ ],
],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'string'],
],
],
],
],
'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' => '',
+ '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"}]',
],
- 'EncryptPhoneNum' => [
- 'summary' => '调用EncryptPhoneNum将用户手机号码进行加密。',
- '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' => [
- 'title' => '实例Id',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre***',
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => '实例ID。'."\n"
+ ."\n"
+ .'请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**实例管理**中查看实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'PhoneNum',
- 'in' => 'query',
- 'schema' => [
- 'title' => '号码明文',
- 'description' => '号码明文。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '130****0000',
- ],
+ 'name' => 'CaseId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '工单ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '223468****'],
+ ],
+ [
+ 'name' => 'CaseType',
+ 'in' => 'formData',
+ 'schema' => ['description' => '工单类型编号（系统自动分配）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '1223'],
+ ],
+ [
+ 'name' => 'CaseStatus',
+ 'in' => 'formData',
+ 'schema' => ['description' => '工单状态编号。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-100000', 'example' => '2'],
+ ],
+ [
+ 'name' => 'SrType',
+ 'in' => 'formData',
+ 'schema' => ['description' => '工单模板ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '29506'],
+ ],
+ [
+ 'name' => 'TaskStatus',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务状态。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-10000000', 'example' => '3'],
+ ],
+ [
+ 'name' => 'ChannelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '渠道ID。', 'type' => 'string', 'required' => false, 'example' => '02acfefd3fa14049826ac1a89e1xxxxx'],
+ ],
+ [
+ 'name' => 'ChannelType',
+ 'in' => 'formData',
+ 'schema' => ['description' => '渠道类型。取值：'."\n"
+ .'- **0**：未填写'."\n"
+ .'- **1**：热线'."\n"
+ .'- **2**：在线', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-10000000', 'example' => '1'],
+ ],
+ [
+ 'name' => 'TouchId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '接触ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '15030609'],
+ ],
+ [
+ 'name' => 'DealId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '处理人ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123456'],
+ ],
+ [
+ 'name' => 'Extra',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => ['description' => '附加信息。', 'type' => 'object', 'required' => false, 'example' => '无'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => '页大小。默认值为：**10**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'formData',
+ 'schema' => ['description' => '当前页。默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '5000', 'minimum' => '0', 'example' => '1', 'default' => '0'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'Data' => [
- 'title' => '加密后密文',
- 'description' => '加密后密文。',
- 'type' => 'string',
- 'example' => '20nJ****/9Fl/kxx/***7',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '接口调用是否成功',
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Data' => ['description' => '工单信息。', 'type' => 'string', '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}'],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '[{"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' => '查询工单',
+ 'summary' => '调用QueryTickets接口查询工单信息。',
+ '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' => '将用户手机号码进行加密',
+ 'ramActions' => [],
],
- 'FetchCall' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'QueryTouchList' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -26355,304 +16447,386 @@
[
'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' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
+ ],
+ [
+ 'name' => 'TouchId',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '客户请求唯一id，用于幂等校验，可以用uuid生成',
- 'type' => 'string',
+ 'description' => '要精确查询的接触ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '接触ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10****'],
'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
+ 'maxItems' => 200,
],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'ChannelId',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
+ 'description' => '要精确查询的会话ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '会话ID。', 'type' => 'string', 'required' => false, 'example' => '846a7a4aa2524186b899a6ba02****'],
+ 'required' => false,
+ 'maxItems' => 200,
],
],
[
- 'name' => 'AccountName',
+ 'name' => 'ChannelType',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '坐席账号名称（坐席登录名）',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123@123.com',
+ 'description' => '渠道类型。',
+ 'type' => 'array',
+ 'items' => ['description' => '渠道类型。取值：'."\n"
+ .'- **1**：热线。'."\n"
+ .'- **2**：在线。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'required' => false,
+ 'maxItems' => 10,
+ 'enum' => ['1', '2'],
],
],
[
- 'name' => 'CallId',
+ 'name' => 'TouchType',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '入呼后，websocket中的acid',
- 'type' => 'string',
+ 'description' => '接触类型。',
+ 'type' => 'array',
+ 'items' => ['description' => '接触类型。取值：'."\n"
+ .'- **1**：主动接触（外呼）。'."\n"
+ .'- **2**：被动接触（咨询）。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
'required' => false,
- 'docRequired' => true,
- 'example' => '7719786',
+ 'maxItems' => 10,
+ 'enum' => ['1', '2'],
],
],
[
- 'name' => 'JobId',
+ 'name' => 'MemberId',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '入呼后，websocket中的jobId',
- 'type' => 'string',
+ 'description' => '要查询的会员ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '会员ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'],
'required' => false,
- 'docRequired' => true,
- 'example' => '7719787',
+ 'maxItems' => 200,
],
],
[
- 'name' => 'ConnectionId',
+ 'name' => 'MemberName',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '入呼后，websocket中的connId',
- 'type' => 'string',
+ 'description' => '要查询的会员名称列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '会员名称。', 'type' => 'string', 'required' => false, 'example' => 'zhangsan'],
'required' => false,
- 'docRequired' => true,
- 'example' => '7719788',
+ 'maxItems' => 200,
],
],
[
- 'name' => 'HoldConnectionId',
+ 'name' => 'ServicerId',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '入呼后，websocket中的holdConnId（ 仅在双步转时传入）',
- 'type' => 'string',
+ 'description' => '要查询的客服ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '客服ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '70020'],
'required' => false,
- 'docRequired' => true,
- 'example' => '0',
+ 'maxItems' => 200,
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'ServicerName',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'result',
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'description' => '错误描述',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID，用于跟踪错误原因',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Code' => [
- 'description' => '错误编码',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
+ 'description' => '要查询的客服名称列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '客服名称。', 'type' => 'string', 'required' => false, 'example' => 'lisi'],
+ 'required' => false,
+ 'maxItems' => 200,
],
],
- ],
- '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',
+ [
+ 'name' => 'QueueId',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '进线技能组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '进线技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
+ 'required' => false,
+ 'maxItems' => 200,
],
],
- ],
- '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":""}]',
- 'title' => '取回通话信息',
- 'summary' => '取回\\恢复通话。',
- ],
- 'GetAgentById' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'EvaluationStatus',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '评价状态。',
+ 'type' => 'array',
+ 'items' => ['description' => '评价状态。取值：'."\n"
+ .'- **-1**：未发起评价。'."\n"
+ .'- **0**：未评价。'."\n"
+ .'- **1**：已评价。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ 'required' => false,
+ 'maxItems' => 10,
+ 'enum' => ['-1', '0', '1'],
+ ],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'InstanceId',
+ 'name' => 'EvaluationLevel',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
+ 'description' => '满意度等级。',
+ 'type' => 'array',
+ 'items' => ['description' => '满意度等级。取值：'."\n"
+ .'- **2**：二级满意度。'."\n"
+ .'- **3**：三级满意度。'."\n"
+ .'- **4**：四级满意度。'."\n"
+ .'- **5**：五级满意度。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
+ 'required' => false,
+ 'maxItems' => 10,
+ 'enum' => ['2', '3', '4', '5'],
],
],
[
- 'name' => 'AgentId',
+ 'name' => 'EvaluationScore',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
+ 'description' => '满意度评分。',
+ 'type' => 'array',
+ 'items' => ['description' => '满意度评分。取值：'."\n"
+ .'- **1**：很不满。'."\n"
+ .'- **2**：不满。'."\n"
+ .'- **3**：一般。'."\n"
+ .'- **4**：满意。'."\n"
+ .'- **5**：很满意。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
+ 'required' => false,
+ 'maxItems' => 10,
+ 'enum' => ['1', '2', '3', '4', '5'],
],
],
+ [
+ 'name' => 'FirstTimeStart',
+ 'in' => 'formData',
+ 'schema' => ['description' => '会话开始的时间范围左区间。时间戳格式（单位：毫秒）。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614596400000'],
+ ],
+ [
+ 'name' => 'FirstTimeEnd',
+ 'in' => 'formData',
+ 'schema' => ['description' => '会话开始的时间范围右区间。时间戳格式（单位：毫秒）。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614599400000'],
+ ],
+ [
+ 'name' => 'CloseTimeStart',
+ 'in' => 'formData',
+ 'schema' => ['description' => '会话结束的时间范围左区间。时间戳格式（单位：毫秒）。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614600400000'],
+ ],
+ [
+ 'name' => 'CloseTimeEnd',
+ 'in' => 'formData',
+ 'schema' => ['description' => '会话结束的时间范围右区间。时间戳格式（单位：毫秒）。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614600500000'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => '每页大小。取值大于**0**，默认值：**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '20', 'default' => '50'],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'formData',
+ 'schema' => ['description' => '当前页。取值大于**0**，默认值：**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Data' => [
+ 'ResultData' => [
+ 'description' => '数据结果。',
'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',
+ 'Empty' => ['description' => '是否为空。', 'type' => 'boolean', 'example' => 'false'],
+ 'OnePageSize' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'TotalPage' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'CurrentPage' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PreviousPage' => ['description' => '上一页页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'TotalResults' => ['description' => '查询总量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'Data' => [
+ 'description' => '数据。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ParentTouchId' => ['description' => '父接触ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'DepId' => ['description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'GmtModified' => ['description' => '更新时间。时间戳格式（单位：毫秒）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1611207979000'],
+ 'UserTouchId' => ['description' => '用户接触ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1386****'],
+ 'CommonQueueName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '测试1'],
+ 'ChannelId' => ['description' => '会话ID。', 'type' => 'string', 'example' => '4f8807a9de024507a3090b5b66a8****'],
+ 'TouchId' => ['description' => '接触ID。', 'type' => 'string', 'example' => '1386****'],
+ 'MemberId' => ['description' => '会员ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '6400665****'],
+ 'ServicerName' => ['description' => '客服名称。', 'type' => 'string', 'example' => '1390000****'],
+ 'Feedback' => ['description' => '反馈。', 'type' => 'string', 'example' => 'xxxx'],
+ 'TouchType' => ['description' => '接触类型。取值：'."\n"
+ .'- **1**：主动接触。'."\n"
+ .'- **2**：被动接触。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'Status' => ['description' => '接触状态。取值：'."\n"
+ .'- **1**：已进线。'."\n"
+ .'- **2**：小二已接入。'."\n"
+ .'- **3**：通话中。'."\n"
+ .'- **4**：已结束。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'SwitchUser' => ['description' => '转交列表。', 'type' => 'string', 'example' => 'null'],
+ 'FirstTime' => ['description' => '会话接起时间。时间戳格式（单位：毫秒）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1611209971000'],
+ 'FromId' => ['description' => '会话发起者。', 'type' => 'integer', 'format' => 'int64', 'example' => '6400665****'],
+ 'QueueId' => ['description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '111'],
+ 'ExtAttrsString' => ['description' => '大字段。', 'type' => 'object'],
+ 'TouchTime' => ['description' => '会话时长（单位：秒）。', 'type' => 'string', 'example' => '111'],
+ 'ToId' => ['description' => '会话接受者。', 'type' => 'integer', 'format' => 'int64', 'example' => '67****'],
+ 'BuId' => ['description' => '租户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '905'],
+ 'GmtCreate' => ['description' => '创建时间。时间戳格式（单位：毫秒）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1611209971000'],
+ 'CloseTime' => ['description' => '会话结束时间。时间戳格式（单位：毫秒）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1611207976000'],
+ 'ExtAttrs' => [
+ 'description' => '扩展字段。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EvaluationScore' => ['description' => '满意度评分。取值：'."\n"
+ .'- **1**：很不满。'."\n"
+ .'- **2**：不满。'."\n"
+ .'- **3**：一般。'."\n"
+ .'- **4**：满意。'."\n"
+ .'- **5**：很满意。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'OnlineJoinRespInterval' => ['description' => '首次响应时长（单位：秒）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Dnis' => ['description' => '外呼为被叫号码，入呼为被叫号码。', 'type' => 'string', 'example' => '05712688****'],
+ 'OnlineSessionSource' => ['description' => '线上会话源。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'EvaluationStatus' => ['description' => '评价状态。取值：'."\n"
+ .'- **-1**：未发起评价。'."\n"
+ .'- **0**：未评价。'."\n"
+ .'- **1**：已评价。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'EvaluationLevel' => ['description' => '满意度等级。取值：'."\n"
+ .'- **2**：二级满意度。'."\n"
+ .'- **3**：三级满意度。'."\n"
+ .'- **4**：四级满意度。'."\n"
+ .'- **5**：五级满意度。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'OutCallRouteNumber' => ['description' => '外呼为主叫号码。', 'type' => 'string', 'example' => '05712688****'],
+ 'Ani' => ['description' => '入呼为主叫号码。', 'type' => 'string', 'example' => '187****0000'],
+ 'EvaluationSolution' => ['description' => '评估解决方案。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ ],
+ ],
+ 'TouchEndReason' => ['description' => '结束原因。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'MemberName' => ['description' => '会员名称。', 'type' => 'string', 'example' => '访客'],
+ 'ServicerId' => ['description' => '客服ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '67****'],
+ 'ChannelType' => ['description' => '接触渠道。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TouchContent' => ['description' => '会话结束原因。取值：'."\n"
+ .'- **0**：未知。'."\n"
+ .'- **1**：接触未成功。'."\n"
+ .'- **2**：客户终止。'."\n"
+ .'- **3**：坐席终止。'."\n"
+ .'- **4**：通话异常中断。'."\n"
+ .'- **5**：转交终止。'."\n"
+ .'- **6**：系统终止。', 'type' => 'string', 'example' => '1'],
+ ],
+ ],
],
+ 'NextPage' => ['description' => '下一页页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'Success'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '865658FD-80DE-5D49-ABEB-F3CC9863F4F1'],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '',
- ],
- 'GetHotlineRuntimeInfo' => [
- 'summary' => '调用GetHotlineRuntimeInfo接口查询热线运行信息。',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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":""}]',
+ 'title' => '查询接触数据',
+ 'summary' => '根据实例、接触ID列表、会话ID列表等查询接触数据。',
+ 'description' => '此接口可查询接触状态、会话接受者、客服名称、接触渠道、满意度评分、评价状态等接触数据，详情可查看[返回参数](#api-detail-40)。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：50次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2021-05-14T11:26:46.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2021-05-14T06:25:24.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'RemoveAgentFromSkillGroup' => [
+ 'summary' => '通过指定技能组及坐席ID，从技能组移除坐席账号。',
+ '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' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => '实例ID。'."\n"
- ."\n"
- .'请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**实例管理**中查看实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-78v1gnp97002'],
],
[
- 'name' => 'AccountName',
+ 'name' => 'SkillGroupId',
'in' => 'query',
+ 'schema' => ['title' => '技能组id', 'description' => '技能组ID。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1146****'],
+ ],
+ [
+ 'name' => 'AgentIds',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '账号名',
- 'description' => '坐席账号名称。实例内唯一（登录名）。',
- 'type' => 'string',
+ 'title' => '坐席列表',
+ 'description' => '坐席ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '坐席ID。'."\n"
+ ."\n"
+ .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口，查看返回参数的**AgentId**，即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '["6083****","6084****"]'],
'required' => true,
- 'example' => '123@****.com',
],
],
],
@@ -26663,1714 +16837,812 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
- 'title' => '数据结果',
- 'description' => '热线运行信息。',
+ 'title' => '结果信息',
+ 'description' => '返回数据。',
'type' => 'object',
- '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":"坐席签出状态"}',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '接口调用是否成功',
- 'description' => '接口调用是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'properties' => [
+ 'SuccessCount' => ['title' => '成功移除的坐席数', 'description' => '成功移除的坐席数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ ],
],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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 \\"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' => '从技能组移除坐席账号',
+ 'description' => '- 若您需要填写坐席、技能组信息，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ .'- 您可以调用[ListAgentBySkillGroupId](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-listagentbyskillgroupid)获取技能组下坐席信息，判断移除是否符合预期。'."\n"
+ .'- 若误操作移除，您可以调用[UpdateAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-updateagent)更新坐席数据，重新设置坐席的技能组。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：50次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [
+ ['createdAt' => '2021-10-28T02:16:10.000Z', 'description' => 'OpenAPI 下线'],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveAgentFromSkillGroup'],
+ ],
],
- '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' => '查询热线运行信息',
+ 'ramActions' => [],
],
- 'GetHotlineWaitingNumber' => [
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RemoveSkillGroup' => [
+ 'methods' => ['post', 'get'],
+ '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' => 'query',
- 'schema' => [
- 'description' => ' '."\n"
- .'客户请求唯一id，用于幂等校验，可以用uuid生成',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'name' => 'InstanceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'description' => ' '."\n"
- .'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'name' => 'SkillGroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '技能组ID。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
[
- 'name' => 'AccountName',
- 'in' => 'query',
- 'schema' => [
- 'description' => ' '."\n"
- .'坐席账号名称（坐席登录名）',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123@123.com',
- ],
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-****-70b6a298d94d'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => ' '."\n"
- .'result',
+ 'description' => 'result',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误描述',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID，用于跟踪错误原因',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Data' => [
- 'description' => '热线会员排队数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'Code' => [
- 'description' => '错误编码',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => ' '."\n"
- .'接口调用是否成功',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。'."\n", 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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',
- ],
+ 400 => [
+ ['errorMessage' => 'The specified instance is unavailable or does not exist.', 'errorCode' => 'InvalidInstanceId', 'description' => '当前实例不可用或不存在'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '删除技能组',
+ 'summary' => '根据AICCS实例ID、技能组ID删除悉犀客服工作台技能组。',
+ 'description' => '- 删除为敏感操作，请您谨慎操作。'."\n"
+ .'- 删除前，建议您确认AICCS实例ID、需删除的技能组ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ .'- 删除后，可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口查询技能组确认。'."\n"
+ .'- 若误操作删除，可调用[CreateSkillGroup](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-createskillgroup)接口重新创建技能组。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：1000次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- '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":""}]',
- 'title' => '查看当前坐席所在技能组热线排队数量',
- 'summary' => '获取热线会员排队数。',
+ 'ramActions' => [],
],
- 'GetInstanceList' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ResetHotlineNumber' => [
+ 'summary' => '调用ResetHotlineNumber接口重置热线号码的呼入（IVR流程）、呼出（生效范围）配置信息。',
+ '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' => 'PageNumber',
+ 'name' => 'InstanceId',
'in' => 'formData',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['title' => '实例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'HotlineNumber',
'in' => 'formData',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'default' => '20',
- ],
+ 'schema' => ['title' => '号码', 'description' => '热线号码。', 'type' => 'string', 'required' => true, 'example' => '0571********', 'pattern' => '^\\d+$'],
],
[
- 'name' => 'Name',
+ 'name' => 'Description',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- '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',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorMessage' => 'The specified parameter is invalid.',
- 'errorCode' => 'InvalidParameter',
- ],
+ 'schema' => ['title' => '号码描述', 'description' => '号码描述。', 'type' => 'string', 'required' => true, 'example' => '热线号码'],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '',
- ],
- 'GetMcuLvsIp' => [
- 'summary' => '调用GetMcuLvsIp查询热线服务器IP。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'EnableInbound',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否用于入呼', 'description' => '是否用于入呼。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre***',
- ],
+ 'name' => 'InboundFlowId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '入呼ivr流程id', 'description' => '入呼IVR流程ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => 'error message',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'Data' => [
- 'title' => 'result data',
- 'description' => 'IP信息。格式为List类型的JSON字符串。',
- 'type' => 'string',
- 'example' => '{ "xmculvs":[ 0:{ "port":00 "ip":"0.0.0.0" "name":"lvs1" } ]}',
- ],
- 'Code' => [
- 'title' => 'error code',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => 'success',
- 'description' => '调用接口是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ [
+ 'name' => 'EnableOutbound',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否用于外呼', 'description' => '是否用于外呼。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
],
- ],
- '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' => '查询热线服务器IP',
- ],
- 'GetOutbounNumList' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'OutboundAllDepart',
+ 'in' => 'formData',
+ 'schema' => ['title' => '外呼是否对所有部门生效', 'description' => '外呼是否对所有部门生效。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
],
[
- 'BearerToken' => [],
+ 'name' => 'EnableInboundEvaluation',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否开启入呼满意度', 'description' => '是否开启入呼满意度。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'ClientToken',
+ 'name' => 'EnableOutboundEvaluation',
'in' => 'formData',
- 'schema' => [
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d****',
- ],
+ 'schema' => ['title' => '是否开启外呼满意度', 'description' => '是否开启外呼满意度。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'EvaluationLevel',
'in' => 'formData',
'schema' => [
- 'description' => "\n"
- .'实例ID。'."\n"
+ 'title' => '满意度等级',
+ 'description' => '满意度等级。取值：'."\n"
."\n"
- .'请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**实例管理**中查看实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-****',
+ .'- **2**：二级（满意，不满意）'."\n"
+ .'- **3**：三级（满意，一般，不满意）'."\n"
+ .'- **4**：四级（很满意，满意，一般，不满意）'."\n"
+ .'- **5**：五级（很满意，满意，一般，不满意，非常差）',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2',
+ 'enum' => ['2', '3', '4', '5'],
],
],
[
- 'name' => 'AccountName',
+ 'name' => 'OutboundRangeList',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '坐席账号名称（坐席登录名）。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123@****.com',
+ 'title' => '外呼生效范围',
+ 'description' => '外呼生效范围。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '外呼生效范围。',
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupIdList' => [
+ 'title' => '生效技能组列表（部门123下）',
+ 'description' => '生效技能组列表。'."\n"
+ ."\n"
+ .'> 技能组列表为空则对整个部门生效，否则针对部门下指定技能组列表生效。'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
+ 'required' => false,
+ ],
+ 'DepartmentId' => ['title' => '生效部门id', 'description' => '生效部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'result',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- 'Data' => [
- 'description' => '号码列表信息。',
- 'type' => 'object',
- 'properties' => [
- 'Num' => [
- 'description' => '主叫号码信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '主叫号码信息。',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '主叫号码类型。取值：'."\n"
- ."\n"
- .'- **1**：号码。'."\n"
- .'- **2**：号码组。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Description' => [
- 'description' => '主叫号码描述（归属地信息）。',
- 'type' => 'string',
- 'example' => '浙江省杭州市',
- ],
- 'Value' => [
- 'description' => '主叫号码。',
- 'type' => 'string',
- 'example' => '07512234****',
- ],
- ],
- ],
- ],
- 'NumGroup' => [
- 'description' => '号码组信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '号码组信息。',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '号码组类型。取值：'."\n"
- ."\n"
- .'- **1**：号码。'."\n"
- .'- **2**：号码组。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Description' => [
- 'description' => '号码组描述（号码组名称）。',
- 'type' => 'string',
- 'example' => 'Jella',
- ],
- 'Value' => [
- 'description' => '号码组ID。',
- 'type' => 'string',
- 'example' => '7688****',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxx'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Code' => ['title' => '错误码', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['title' => '接口调用是否成功', 'description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxx\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\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' => '重置热线号码',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-22T12:36:22.000Z', 'description' => 'OpenAPI 下线'],
],
- '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' => '获取外呼号码列表',
- 'summary' => '获取外部热线号码列表。',
+ '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' => [
- 'title' => '租户实例ID',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre***',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0'],
],
[
- 'name' => 'ProjectId',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'title' => '质检任务ID',
- 'description' => '质检任务ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '15977801',
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => 'Message',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'title' => 'RequestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Data' => [
- 'title' => 'Data',
- 'description' => '质检任务信息。',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'title' => '质检任务状态',
- 'description' => '质检任务状态。取值：'."\n"
- ."\n"
- .'- **0**：启动'."\n"
- .'- **1**：关闭',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ServicerList' => [
- 'title' => '坐席列表',
- 'description' => '质检抽样范围。',
- 'type' => 'array',
- 'items' => [
- 'description' => '质检抽样范围：客服登录名。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0:55555',
- ],
- ],
- 'ModifyTime' => [
- 'title' => '修改时间',
- 'description' => '修改时间。',
- 'type' => 'string',
- 'example' => '2021-04-07 18:07:19',
- ],
- 'QualityType' => [
- 'title' => '质检类型',
- 'description' => '质检类型 。固定取值为**1**（咨询类）。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'DepList' => [
- 'title' => '技能组分组',
- 'description' => '质检抽样范围。',
- 'type' => 'array',
- 'items' => [
- 'description' => '部门列表：部门列表。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0:10',
- ],
- ],
- 'GroupList' => [
- 'title' => '技能组列表',
- 'description' => '质检抽样范围。',
- 'type' => 'array',
- 'items' => [
- 'description' => '质检抽样范围：技能组列表。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0:123456',
- ],
- ],
- 'ProjectName' => [
- 'title' => '质检任务名称',
- 'description' => '质检任务名称',
- 'type' => 'string',
- 'example' => '自动化质检任务',
- ],
- 'Version' => [
- 'title' => 'Version',
- 'description' => '质检任务版本号。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2021-04-07 18:07:18',
- ],
- 'Id' => [
- 'title' => '质检任务ID',
- 'description' => '质检任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '15977801',
- ],
- 'QualityRuleIds' => [
- 'title' => '质检规则ID',
- 'description' => '质检项规则ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '质检规则数据。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5369',
- ],
- ],
- 'CheckFreqType' => [
- 'title' => '质检周期',
- 'description' => '检查频次类型。取值：'."\n"
- ."\n"
- .'- **1**：周期质检'."\n"
- .'- **4**：临时质检',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- 'Code' => [
- 'title' => 'Code',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => 'Success',
- 'description' => '接口调用是否成功。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'Data' => ['type' => 'string'],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
],
'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' => '获取质检任务详情',
- 'summary' => '调用GetQualityProjectDetail获取质检任务详情。',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- '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' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre***',
- ],
+ 'schema' => ['description' => '呼出主叫号码。在语音服务[真实号管理](https://dyvmsnext.console.aliyun.com/number/list/normal)界面查看。', 'type' => 'string', 'required' => true, 'example' => '132****0849'],
],
[
- 'name' => 'ProjectId',
+ 'name' => 'CalledNumber',
'in' => 'query',
- 'schema' => [
- 'title' => '质检项ID',
- 'description' => '质检任务ID（支持模糊搜索）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '15',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => true, 'example' => '131****2204'],
],
[
- 'name' => 'ProjectName',
+ 'name' => 'RobotId',
'in' => 'query',
- 'schema' => [
- 'title' => '质检项名称',
- 'description' => '质检任务名（支持模糊搜索）。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '质检',
- ],
+ 'schema' => ['description' => '机器人ID，即话术ID。在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面查看审核通过的话术ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1000035******'],
],
[
- 'name' => 'Status',
+ 'name' => 'OutId',
'in' => 'query',
- 'schema' => [
- 'title' => '质检项状态',
- 'description' => '质检任务状态。取值：'."\n"
- ."\n"
- .'- **0**：启动'."\n"
- .'- **1**：关闭'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '预留给调用方使用的 ID，最终会通过回执消息将此 ID 带回给调用方，长度为 1~15 个字节。', 'type' => 'string', 'required' => false, 'example' => '222356****'],
],
[
- 'name' => 'PageNo',
+ 'name' => 'RecordFlag',
'in' => 'query',
- 'schema' => [
- 'title' => 'PageNo',
- 'description' => '当前页。默认为：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '通话过程是否录音。取值：'."\n"
+ ."\n"
+ .'- **false**（默认值）：不录音。'."\n"
+ .'- **true**：录音。'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'EarlyMediaAsr',
'in' => 'query',
- 'schema' => [
- 'title' => 'PageSize',
- 'description' => '每页大小。默认为：**10**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => '是否启用号码状态识别标识。取值：'."\n"
+ ."\n"
+ .'- **false**（默认值）：不启用。'."\n"
+ .'- **true**：启用。'."\n"
+ .'>启用后会记录通话未接听的原因。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'checkFreqType',
+ 'name' => 'Params',
'in' => 'query',
- 'schema' => [
- 'title' => '质检频率',
- 'description' => '检查频次类型。取值：'."\n"
- ."\n"
- .'- **1**：周期质检'."\n"
- .'- **4**：临时质检',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '机器人的参数列表。JSON格式。总长度不要超过512个字节。在[话术管理](https://aiccs.console.aliyun.com/patter/list)>**详情**>**输出输入参数**中查看或通过[ListRobotParams](~~2717999~~)接口查看。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "name": "张三",'."\n"
+ .' "age": "25"'."\n"
+ .'}'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => 'Message',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'title' => 'RequestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Data' => [
- 'title' => 'Data',
- 'description' => '质检任务信息。',
- 'type' => 'object',
- 'properties' => [
- 'PageSize' => [
- 'title' => 'PageSize',
- 'description' => '每页大小。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'QualityProjectList' => [
- 'title' => '质检项列表',
- 'description' => '质检任务列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '质检任务数据。',
- 'type' => 'object',
- 'properties' => [
- 'Status' => [
- 'title' => '质检任务状态',
- 'description' => '质检任务状态。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'ServicerList' => [
- 'title' => '坐席列表',
- 'description' => '质检抽样范围。',
- 'type' => 'array',
- 'items' => [
- 'description' => '质检抽样范围：客服登录名。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0:555555',
- ],
- ],
- 'ModifyTime' => [
- 'title' => '修改时间',
- 'description' => '修改时间。',
- 'type' => 'string',
- 'example' => '2021-04-07 18:07:19',
- ],
- 'QualityType' => [
- 'title' => '质检任务类型',
- 'description' => '质检类型 。固定取值为**1**（咨询类）。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'DepList' => [
- 'title' => '技能组分组列表',
- 'description' => '质检抽样范围。',
- 'type' => 'array',
- 'items' => [
- 'description' => '质检抽样范围：部门列表。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0:10',
- ],
- ],
- 'GroupList' => [
- 'title' => '技能组列表',
- 'description' => '质检抽样范围。',
- 'type' => 'array',
- 'items' => [
- 'description' => '质检抽样范围：技能组列表。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0:123456',
- ],
- ],
- 'ProjectName' => [
- 'title' => '质检任务名称',
- 'description' => '质检任务名称。',
- 'type' => 'string',
- 'example' => '自动化质检任务',
- ],
- 'Version' => [
- 'title' => '版本',
- 'description' => '质检任务版本号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CreateTime' => [
- 'title' => 'CreateTime',
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2021-04-07 18:07:18',
- ],
- 'Id' => [
- 'title' => '质检任务Id',
- 'description' => '质检任务ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '15977801',
- ],
- 'QualityRuleIds' => [
- 'title' => '质检规则列表',
- 'description' => '质检项规则ID。',
- 'type' => 'array',
- 'items' => [
- 'description' => '质检规则数据。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5369',
- ],
- ],
- 'CheckFreqType' => [
- 'title' => '质检任务频率',
- 'description' => '质检任务频率。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'Total' => [
- 'title' => 'Total',
- 'description' => '总记录数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '35',
- ],
- 'PageNo' => [
- 'title' => 'PageNo',
- 'description' => '当前页。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- 'Code' => [
- 'title' => 'Code',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => 'Success',
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D'],
+ 'Data' => ['description' => '此次通话的唯一回执ID，即呼叫唯一ID。', 'type' => 'string', 'example' => '1160128*****^10281427*****'],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'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',
- ],
- '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' => '获取质检任务列表',
- 'summary' => '调用GetQualityProjectList获取质检任务列表。',
- ],
- 'GetQualityProjectLog' => [
- 'methods' => [
- 'post',
- 'get',
+ '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' => '智能联络机器人呼出',
+ 'summary' => '发起智能联络机器人呼出。',
+ 'description' => '- 在发起智能联络机器人呼出之前，请先确保您在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面已有审核通过的话术；在语音服务[真实号管理](https://dyvmsnext.console.aliyun.com/number/list/normal)界面已有申请成功的真实号码。'."\n"
+ ."\n"
+ .'- 呼叫的创建时间可从此接口调用后的**Response Header**中的**date**参数获取。'."\n"
+ .'> 例如，**date**参数为："date": "Mon, 24 Jun 2024 03:40:31 GMT"，则呼叫的创建时间为："2024-06-24 03:40:31"。'."\n"
+ ."\n\n"
+ ."\n\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：1000次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [
+ ['createdAt' => '2021-05-19T13:35:01.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ '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' => '产品名称。默认取值：**aiccs**。', 'type' => 'string', 'required' => false, 'example' => 'aiccs', 'default' => 'aiccs'],
],
[
- 'name' => 'ProjectId',
+ 'name' => 'CalledShowNumber',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- ],
+ 'schema' => ['description' => '被叫显号，必须是已购买的号码。'."\n"
+ ."\n"
+ .'您可以登录[联络中心控制台](https://aiccs.console.aliyun.com/overview?spm=a2c4g.11186623.0.0.7f9bf9658X6jte)，查看已购买的号码。', 'type' => 'string', 'required' => true, 'example' => '0571****0000'],
],
- ],
- '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' => '被叫号码。仅支持中国内地号码。', 'type' => 'string', 'required' => true, 'example' => '137****0000'],
],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorMessage' => 'A system error occurred. Please contact the administrator.',
- 'errorCode' => 'SystemError',
- ],
+ [
+ 'name' => 'VoiceCode',
+ 'in' => 'query',
+ 'schema' => ['description' => '智能外呼放音文件，支持网络文件和TTS方式。其中，支持使用多个文件和TTS参数混播，之间用英文逗号（,）分隔。TTS参数的替换值在**VoiceCodeParam**中指定。'."\n"
+ ."\n"
+ .'- 放音文件为网络文件时：参数VoiceCode指定为可被公网访问的语音文件URL，建议您使用采样频率为8000Hz或16000Hz且为wav格式的语音文件。'."\n"
+ .'- 放音文件为TTS时：参数VoiceCode指定为变量名称如$name$，需要在VoiceCodeParam中设置变量对应的内容。', 'type' => 'string', 'required' => true, 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$'],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '',
- ],
- 'GetQualityResult' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'OutId',
+ 'in' => 'query',
+ 'schema' => ['description' => '预留给调用方使用的ID，最终会通过在回执消息中将此ID带回给调用方。'."\n"
+ .'字符串类型，长度为1~15个字节。', 'type' => 'string', 'required' => false, 'example' => '222356****'],
],
- ],
- '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' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'PageNo',
+ 'name' => 'Volume',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'maximum' => '1000',
- 'minimum' => '1',
- 'default' => '',
- ],
+ 'schema' => ['description' => '播放用户音频的音量，取值范围为：-4~4，建议设置为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'Speed',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- ],
+ 'schema' => ['description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'TouchStartTime',
+ 'name' => 'AsrModelId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => 'ASR模型ID。请在[ASR模型管理页面](https://aiccs.console.aliyun.com/sentence/model/private?spm=a2c4g.11186623.0.0.7f9b2964fYSGv4)查看ASR模型ID。', 'type' => 'string', 'required' => false, 'example' => 'bf71664d30d2478fb8cb8c39c6b6****'],
],
[
- 'name' => 'TouchEndTime',
+ 'name' => 'AsrBaseId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => 'SR基础模型。'."\n"
+ ."\n"
+ .'- **customer_service_8k**：普通话。'."\n"
+ .'- **dialect_customer_service_8k**：重口音。'."\n"
+ .'- 如果仅设置**asrModelId**，表示使用指定的ASR模型。'."\n"
+ .'- 如果仅设置**AsrBaseId**，表示使用指定的ASR基础模型。'."\n"
+ .'- 如果二者均未设置，则使用默认的ASR基础模型，即参数**AsrBaseId**默认为**customer_service_8k**，表示使用ASR普通话基础模型。'."\n"
+ .'- 如果二者同时设置，请确认二者是正确对应的。 '."\n"
+ ."\n"
+ .'> 调用接口**SendCcoSmartCall**时，需要指定使用的ASR模型，建议参数**asrModelId**和**AsrBaseId**二者选填一个。', 'type' => 'string', 'required' => false, 'example' => 'customer_service_8k'],
],
[
- 'name' => 'ChannelType',
+ 'name' => 'AsrAlsAmId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '声学模型ID。', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
[
- 'name' => 'HitStatus',
+ 'name' => 'AsrVocabularyId',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- ],
+ 'schema' => ['description' => '热词ID。请在[ASR热词管理页面](https://aiccs.console.aliyun.com/sentence/vocab?spm=a2c4g.11186623.0.0.7f9bf965IKBpsi)查看ASR热词ID。', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
[
- 'name' => 'GroupIds',
+ 'name' => 'RecordFlag',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'required' => false,
- 'maxItems' => 1,
- ],
+ 'schema' => ['description' => '通话过程中是否录音。'."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'QualityRuleIds',
+ 'name' => 'PauseTime',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'required' => false,
- 'maxItems' => 1,
- ],
+ 'schema' => ['description' => '停顿时长。用于设置用户停顿多久表示一句话结束。单位为毫秒。取值范围为**300~1200**，如果指定值不在参数范围中，则默认PauseTime为**800**。'."\n"
+ ."\n"
+ .'> 首次设置有效，后续设置无效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '800'],
],
[
- 'name' => 'ProjectIds',
+ 'name' => 'MuteTime',
'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'required' => false,
- 'maxItems' => 1,
- ],
+ 'schema' => ['description' => '静音时长，用于设置用户多久不说话通话结束。单位为：毫秒，取值范围为**1000~20000**。'."\n"
+ ."\n"
+ .'- 如果指定值不在参数范围中，则默认MuteTime为**10000**。'."\n"
+ .'- 通话过程中可动态设置，以最后一次设置为准。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000'],
+ ],
+ [
+ 'name' => 'ActionCodeBreak',
+ 'in' => 'query',
+ 'schema' => ['description' => '开场放音文件是否可打断。默认为**true**，即开场放音文件可打断。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'DynamicId',
+ 'in' => 'query',
+ 'schema' => ['description' => '预留给调用方使用的动态扩展ID，在回调地址中带回，用于客户的开发标识。', 'type' => 'string', 'required' => false, 'example' => '123456'],
+ ],
+ [
+ 'name' => 'EarlyMediaAsr',
+ 'in' => 'query',
+ 'schema' => ['description' => '早媒体语音识别标识。设为true会记录通话未接听的原因。默认为**false**，即关闭状态。'."\n"
+ ."\n"
+ .'> 如果需要启用早媒体语音识别标识，请手动设为**true**。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'VoiceCodeParam',
+ 'in' => 'query',
+ 'schema' => ['description' => 'TTS参数传递字符串，格式为JSON。必须与VoiceCode的TTS参数对应。', 'type' => 'string', 'required' => false, 'example' => '{"name":"喂，你好"}'],
+ ],
+ [
+ 'name' => 'SessionTimeout',
+ 'in' => 'query',
+ 'schema' => ['description' => '最大通话时长，单位为秒，超时后自动挂断。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120'],
+ ],
+ [
+ 'name' => 'ActionCodeTimeBreak',
+ 'in' => 'query',
+ 'schema' => ['description' => '基于用户持续说话时长打断，在ActionCodeBreak为**true**时生效。单位为毫秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120'],
+ ],
+ [
+ 'name' => 'TtsConf',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否设置TTS声音参数。'."\n"
+ .'- 指定为**true**：需要通过TtsStyle、TtsVolume、TtsSpeed三个参数来设置声音风格。'."\n"
+ .'- 定为**false**：不需要设置相关参数，即便设置了也不生效。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'TtsStyle',
+ 'in' => 'query',
+ 'schema' => ['description' => 'TTS变量播放时的声音风格，默认为**xiaoyun**，具体风格请参见声音风格列表。', 'type' => 'string', 'required' => false, 'example' => 'xiaoyun'],
+ ],
+ [
+ 'name' => 'TtsVolume',
+ 'in' => 'query',
+ 'schema' => ['description' => 'TTS变量播放的音量，取值范围为**0~100**，默认为**0**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'TtsSpeed',
+ 'in' => 'query',
+ 'schema' => ['description' => 'TTS变量播放时的声音速度，取值范围为：-200~200，默认为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
+ ],
+ [
+ 'name' => 'BackgroundFileCode',
+ 'in' => 'query',
+ 'schema' => ['description' => '用户和机器人对话时播放的背景语音文件ID。您可以登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，选择**智能交互 > 语音文件管理**，单击**详情**，查看对应的语音ID。', 'type' => 'string', 'required' => false, 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav'],
+ ],
+ [
+ 'name' => 'BackgroundVolume',
+ 'in' => 'query',
+ 'schema' => ['description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '4', 'minimum' => '-4', 'example' => '1'],
+ ],
+ [
+ 'name' => 'BackgroundSpeed',
+ 'in' => 'query',
+ 'schema' => ['description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'EnableITN',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否在后处理中执行ITN。'."\n"
+ ."\n"
+ .'> 设置为**true**时，中文数字将转为阿拉伯数字输出，默认为**false**。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'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' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D'],
+ 'Data' => ['description' => '此次通话的唯一回执ID。', 'type' => 'string', 'example' => '16012854210^10281427****'],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'errorCodes' => [
- 500 => [
- [
- 'errorMessage' => 'The specified parameter is invalid.',
- 'errorCode' => 'InvalidParameter',
- ],
+ 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' => '',
- ],
- 'GetQualityRuleDetail' => [
- 'methods' => [
- 'post',
- 'get',
+ '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":""}]',
+ 'title' => '发起智能外呼',
+ 'summary' => '根据被叫显号、被叫号码、智能外呼放音文件发起智能语音交互通话。',
+ 'description' => '- 以下字符不可以在智能语音交互SendCcoSmartCall回调中出现：`@ = : "" $ { } ^ * ￥`。'."\n"
+ .'- 调用此接口后，返回参数的**Data**为此次通话的唯一回执ID，可以用于调用[SendCcoSmartCallOperate](~~2718013~~)接口。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'requestParamsDescription' => '### 声音风格列表'."\n"
+ ."\n"
+ .'- 小云标准女声：xiaoyun'."\n"
+ .'- 小刚标准男声：xiaogang'."\n"
+ .'- 若兮温柔女声：ruoxi'."\n"
+ .'- 小梦标准女声：xiaomeng'."\n"
+ .'- 小威标准男声：xiaowei'."\n"
+ .'- 阿美甜美女声：amei'."\n"
+ .'- 小雪温柔女声：xiaoxue'."\n"
+ .'- 思琪温柔女声：siqi'."\n"
+ .'- 思佳标准女声：sijia'."\n"
+ .'- 思诚标准男声：sicheng'."\n"
+ .'- 思悦温柔女声：siyue'."\n"
+ .'- 小美甜美女声：xiaomei'."\n"
+ .'- 思彤标准童声：sitong'."\n"
+ .'- 宁儿标准女声：ninger'."\n"
+ .'- 小北萝莉女声：xiaobei'."\n"
+ .'- 伊娜浙普女声：yina'."\n",
+ 'changeSet' => [
+ ['createdAt' => '2021-09-02T03:15:43.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ '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' => '产品名称。默认取值：**aiccs**。', 'type' => 'string', 'required' => false, 'example' => 'aiccs', 'default' => 'aiccs'],
],
[
- 'name' => 'QualityRuleId',
+ 'name' => 'CallId',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => '通话的唯一回执ID。可以通过[SendCcoSmartCall](~~311247~~)返回。', 'type' => 'string', 'required' => true, 'example' => '116012854210^102814279****'],
+ ],
+ [
+ 'name' => 'Command',
+ 'in' => 'query',
+ 'schema' => ['description' => '在智能外呼通话中，指定被叫号码发起的动作。'."\n"
+ ."\n"
+ .'> 当前仅支持参数**parallelBridge**，表示指定动作为被叫号码与呼叫中心坐席桥接。', 'type' => 'string', 'required' => true, 'example' => 'parallelBridge'],
+ ],
+ [
+ 'name' => 'Param',
+ 'in' => 'query',
+ 'schema' => ['description' => '扩展字段。', 'type' => 'string', 'required' => false, 'example' => 'Param'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'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' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D'],
+ 'Data' => ['description' => '命令执行的结果。'."\n"
+ .'- **true**：命令执行成功。'."\n"
+ .'- **false**：命令执行失败。', 'type' => 'string', 'example' => 'true'],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
],
],
],
],
'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',
- ],
- 'responseDemo' => '',
- ],
- 'GetQualityRuleList' => [
- 'methods' => [
- 'post',
- 'get',
+ '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' => '发起智能外呼',
+ 'summary' => '在智能外呼通话中，发起指定动作，仅用于并行转人工，人工坐席可旁听人机对话等场景。',
+ 'description' => '- 此接口仅可在智能外呼通话过程中调用成功，调用时请注意：请求参数的**CallId**需要填写正在通话的通话唯一回执ID。'."\n"
+ .'- **CallId**为调用[SendCcoSmartCall](~~2718012~~)接口时，返回参数的**Data**参数。',
+ 'changeSet' => [
+ ['createdAt' => '2021-09-09T06:04:10.000Z', 'description' => '请求参数发生变更'],
],
- '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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
+ ],
+ [
'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'PageNo',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '1000',
- 'minimum' => '1',
- ],
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- ],
+ 'name' => 'Token',
+ 'in' => 'formData',
+ 'schema' => ['description' => '心跳签名。'."\n"
+ ."\n"
+ .'可调用[StartHotlineService](~~2718045~~)接口获取Token。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0079e7a845e373****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'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' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。'."\n", 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '[{"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' => '发送热线心跳',
+ 'summary' => '根据实例ID、坐席账号名称、心跳签名发送热线心跳请求。',
+ 'description' => '### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '',
+ 'ramActions' => [],
],
- 'GetQualityRuleTagList' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'StartAiCallTask' => [
+ 'summary' => '启动呼叫任务。',
+ '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' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => '1187**************'],
],
],
'responses' => [
@@ -28378,59 +17650,42 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '58A32FFF-86EE-5CF0-B365-97E8C574C7F4'],
'Data' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'RuleTagName' => [
- 'type' => 'string',
- ],
- 'RuleTagId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- ],
- ],
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
+ 'description' => '启动结果。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。',
'type' => 'boolean',
+ 'enumValueTitles' => [],
+ 'example' => 'false',
],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorMessage' => 'A system error occurred. Please contact the administrator.',
- 'errorCode' => 'SystemError',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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' => '启动呼叫任务',
+ 'description' => '- 在启动呼出任务之前，请确保您的呼出任务状态为已停止。'."\n"
+ ."\n"
+ .'- 若您没有已创建的呼叫任务，请先在**呼叫任务管理**界面创建呼叫任务或通过[CreateAiCallTask](~~2926796~~)接口创建呼叫任务。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '',
+ 'ramActions' => [],
],
- 'HangUpDoubleCall' => [
- 'summary' => '取消双呼。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'StartAiOutboundTask' => [
+ 'summary' => '根据实例ID、任务ID启动外呼任务。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -28438,94 +17693,61 @@
],
'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' => [
- 'title' => '实例ID',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_****'],
],
[
- 'name' => 'Acid',
+ 'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'title' => '会话ID',
- 'description' => '会话ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '68255155****',
- ],
+ 'schema' => ['title' => '任务id', 'description' => '任务ID。'."\n"
+ ."\n"
+ .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1763****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'title' => '错误信息',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '是否调用成功',
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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 \\"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' => '启动外呼任务',
+ 'description' => '- 调用此接口，可启动暂停状态的外呼任务。'."\n"
+ .'- 终止状态的外呼任务无法再次被启动。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：20次/秒。'."\n"
+ .'- API频率：20次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ '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' => '取消双呼',
+ 'ramActions' => [],
],
- 'HangupThirdCall' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'StartCall' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -28536,144 +17758,75 @@
],
'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' => '客户请求唯一id，用于幂等校验，可以用uuid生成',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
'name' => 'AccountName',
'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称（坐席登录名）',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123@123.com',
- ],
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'],
],
[
- 'name' => 'CallId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => ' '."\n"
- .'入呼后，websocket中的acid',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719786',
- ],
- ],
- [
- 'name' => 'JobId',
+ 'name' => 'Caller',
'in' => 'formData',
- 'schema' => [
- 'description' => '入呼后，websocket中的jobId',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719787',
- ],
+ 'schema' => ['description' => '热线外呼主叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '906****'],
],
[
- 'name' => 'ConnectionId',
+ 'name' => 'Callee',
'in' => 'formData',
- 'schema' => [
- 'description' => "\n"
- .'入呼后，websocket中的connId',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719788',
- ],
+ 'schema' => ['description' => '热线外呼被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1360987****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'result',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误描述',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => ' '."\n"
- .'请求ID，用于跟踪错误原因',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Code' => [
- 'description' => '错误编码',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。'."\n", 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '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' => '[{"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' => '坐席发起外呼',
+ 'summary' => '根据实例ID、坐席账号名称、热线外呼主叫号码、被叫号码发起外呼。',
+ 'description' => '### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ '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":""}]',
- 'title' => '挂断三方通话',
- 'summary' => '挂断第三方通话。',
+ 'ramActions' => [],
],
- 'HoldCall' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'StartCallV2' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -28684,78 +17837,48 @@
],
'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' => '客户请求唯一id，用于幂等校验，可以用uuid生成',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
'name' => 'AccountName',
'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称（坐席登录名）',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123@123.com',
- ],
+ 'schema' => ['description' => '坐席账号名称（坐席登录名）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com'],
],
[
- 'name' => 'CallId',
+ 'name' => 'Caller',
'in' => 'formData',
- 'schema' => [
- 'description' => '入呼后，websocket中的acid',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719786',
- ],
+ 'schema' => ['description' => '热线外呼主叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9065****'],
],
[
- 'name' => 'JobId',
+ 'name' => 'CallerType',
'in' => 'formData',
'schema' => [
- 'description' => '入呼后，websocket中的jobId',
- 'type' => 'string',
- 'required' => false,
+ 'description' => '呼叫类型。取值：'."\n"
+ ."\n"
+ .'- **1**：呼入'."\n"
+ .'- **2**：呼出',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
'docRequired' => true,
- 'example' => '7719787',
+ 'example' => '1',
+ 'enum' => ['1', '2'],
],
],
[
- 'name' => 'ConnectionId',
+ 'name' => 'Callee',
'in' => 'formData',
- 'schema' => [
- 'description' => '入呼后，websocket中的connId',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719788',
- ],
+ 'schema' => ['description' => '热线外呼被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '136****1111'],
],
],
'responses' => [
@@ -28764,153 +17887,90 @@
'description' => 'result',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误描述',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID，用于跟踪错误原因',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Code' => [
- 'description' => '错误编码',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '[{"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' => '坐席发起外呼',
+ 'summary' => '调用StartCallV2发起外呼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":""}]',
- 'title' => '通话保持',
- 'summary' => '保持通话。',
+ 'ramActions' => [],
],
- 'InsertTaskDetail' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'StartChatWork' => [
+ 'summary' => '调用StartChatWork设置在线坐席为上班状态。',
+ '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' => ['title' => 'instanceId', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre***'],
],
[
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'accountName', 'description' => '坐席登录名。', 'type' => 'string', 'required' => true, 'example' => '123@123.com'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'result',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
+ 'Message' => ['title' => 'message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => ['title' => 'data', 'description' => '值为**1**代表用户切换为上班状态。', 'type' => 'string', 'example' => '1'],
+ 'Code' => ['title' => 'code', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => 'success', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '[{"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' => '设置在线坐席为上班状态',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartChatWork'],
+ ],
],
- 'responseDemo' => '',
+ 'ramActions' => [],
],
- 'JoinThirdCall' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'StartHotlineService' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -28921,799 +17981,299 @@
],
'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' => '客户请求唯一id，用于幂等校验，可以用uuid生成',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'schema' => ['title' => 'js sdk中自动生成的鉴权token', 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID，在智能联络中心控制台上可以看到',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
'name' => 'AccountName',
'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称（坐席登录名）',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123@123.com',
- ],
- ],
- [
- 'name' => 'CallId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '入呼后，websocket中的acid',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719786',
- ],
- ],
- [
- 'name' => 'JobId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '入呼后，websocket中的jobId',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719787',
- ],
- ],
- [
- 'name' => 'ConnectionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '入呼后，websocket中的connId',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719788',
- ],
- ],
- [
- 'name' => 'HoldConnectionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '入呼后，websocket中的holdConnId（ 仅在双步转时传入）',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'result',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误描述',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID，用于跟踪错误原因',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Code' => [
- 'description' => '错误编码',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Data' => ['description' => '请求调用成功后返回，发起心跳所需的Token。', 'type' => 'string', 'example' => '0079e7a845e373****'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。'."\n", 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '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' => '[{"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":""}]',
- 'title' => '加入三方通话',
- 'summary' => '将第三方加入到通话中。',
- ],
- 'ListChatRecordDetail' => [
- 'summary' => '调用ListChatRecordDetail根据时间段查询在线会话详情。',
- 'methods' => [
- 'get',
+ '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' => '开始热线服务',
+ 'summary' => '根据实例ID、坐席账号名称进行热线坐席签入，开始热线服务。',
+ 'description' => '- 此接口返回的**Data**参数为发起心跳所需的Token。'."\n"
+ .'- 若坐席小休，需暂停热线服务，可调用[SuspendHotlineService](~~2718046~~)接口。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [
+ ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ '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' => [
- 'title' => 'clientToken',
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'schema' => ['description' => '产品名称。默认取值：**aiccs**。', 'type' => 'string', 'required' => false, 'example' => 'aiccs', 'default' => 'aiccs'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'AccountType',
'in' => 'query',
- 'schema' => [
- 'title' => '实例id',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre***',
- ],
+ 'schema' => ['description' => '账户类型。', 'type' => 'string', 'required' => false, 'example' => 'BUC_TYPE'],
],
[
- 'name' => 'CloseTimeEnd',
+ 'name' => 'AccountId',
'in' => 'query',
- 'schema' => [
- 'title' => '在线挂断的时间范围',
- 'description' => '会话结束的时间范围右区间。时间戳格式，单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1614582000000',
- ],
+ 'schema' => ['description' => '账户ID。', 'type' => 'string', 'required' => false, 'example' => '223457****'],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'CommandCode',
'in' => 'query',
- 'schema' => [
- 'title' => '当前页',
- 'description' => '当前页。默认为：1。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '指令Code。', 'type' => 'string', 'required' => false, 'example' => 'outBound_Call'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'CallingNumber',
'in' => 'query',
- 'schema' => [
- 'title' => '每页数据量',
- 'description' => '每页大小。默认为：**500**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- 'default' => '500',
- ],
+ 'schema' => ['description' => '主叫号码。', 'type' => 'string', 'required' => false, 'example' => '1367123****'],
],
[
- 'name' => 'CloseTimeStart',
+ 'name' => 'CalledNumber',
'in' => 'query',
- 'schema' => [
- 'title' => '在线挂断的时间范围',
- 'description' => '会话结束的时间范围左区间。时间戳格式，单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1614578400000',
- ],
+ 'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => false, 'example' => '0571456****'],
+ ],
+ [
+ 'name' => 'ExtInfo',
+ 'in' => 'query',
+ 'schema' => ['description' => '业务信息。', 'type' => 'string', 'required' => false, 'example' => '{"caseId":23232****}'],
+ ],
+ [
+ 'name' => 'AppName',
+ 'in' => 'query',
+ 'schema' => ['description' => '业务自定义AppName。', 'type' => 'string', 'required' => false, 'example' => 'aliyun'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'result',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'ResultData' => [
- 'title' => 'data',
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'OnePageSize' => [
- 'description' => '每页大小',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'TotalPage' => [
- 'description' => '总页数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'CurrentPage' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TotalResults' => [
- 'description' => '总记录数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'Data' => [
- 'description' => '查询数据结果。',
- 'type' => 'array',
- 'items' => [
- 'description' => '会话列表数据对象。',
- 'type' => 'object',
- 'properties' => [
- 'ServicerName' => [
- 'description' => '客服账号',
- 'type' => 'string',
- 'example' => '123@123.com',
- ],
- 'EndTime' => [
- 'title' => '在线结束时间',
- 'description' => '在线结束时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1614578410000',
- ],
- 'StartTime' => [
- 'title' => '在线开始时间',
- 'description' => '在线开始时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1614578400000',
- ],
- 'MessageList' => [
- 'title' => '在线会话详细信息',
- 'description' => '在线会话详细信息列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '一个会话详情。',
- 'type' => 'object',
- 'properties' => [
- 'SenderName' => [
- 'description' => '发送信息的账号。',
- 'type' => 'string',
- 'example' => 'account1',
- ],
- 'Content' => [
- 'description' => '发送的对话内容',
- 'type' => 'string',
- 'example' => '你好',
- ],
- 'CreateTime' => [
- 'description' => '信息发送时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1614578400000',
- ],
- 'SenderType' => [
- 'description' => '发送信息类型。取值：'."\n"
- .'- **1**：会员'."\n"
- .'- **2**：客服',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'MsgType' => [
- 'description' => '信息类型。',
- 'type' => 'string',
- 'example' => 'MSG',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => 'message',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'title' => 'httpStatusCode',
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => 'success',
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'InvokeCreateTime' => ['description' => '发起创建时间', 'type' => 'string', 'example' => '2019-05-23 17:30:32.525'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'InvokeCmdId' => ['description' => '发起命令ID。', 'type' => 'string', 'example' => '8883f165-4a0d-4da2-a2d2'],
+ 'CustomerInfo' => ['description' => '客户信息。', 'type' => 'string', 'example' => '{\\"caseId\\":2323****}'],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
],
],
],
],
'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' => '[{"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' => '发起呼叫',
+ 'summary' => '调用StartMicroOutbound接口发起外呼请求。',
+ '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' => '根据时间段查询在线会话详情',
- 'description' => '此接口查询在某个时间段范围内完成的在线会话信息，包含会话内容。查询规则如下：'."\n"
- .'- 查询时间段跨度最大为1天。'."\n"
- .'- 如果只传了查询结束时间，则查询起始时间为结束时间前1小时。'."\n"
- .'- 如果只传了查询起始时间，则结束时间为起始时间后1小时。'."\n"
- .'- 如果都没传，则认为结束时间为当前时间，起始时间为结束时间前1小时。'."\n"
- .'- 如果都传了但是时间跨度大于1天，返回异常信息。',
+ 'ramActions' => [],
],
- 'ListHotlineRecordDetail' => [
- 'summary' => '根据时间段查询热线详情列表。',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'StartTask' => [
+ 'summary' => '启动已创建成功的智能联络机器人呼叫任务。',
+ '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' => [
- 'title' => 'clientToken',
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
- ],
- [
- 'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实例id',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre***',
- ],
- ],
- [
- 'name' => 'CloseTimeEnd',
- 'in' => 'query',
- 'schema' => [
- 'title' => '热线挂断的时间范围',
- 'description' => '热线挂断的开始时间。时间戳格式，单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1614582000000',
- ],
- ],
- [
- 'name' => 'CurrentPage',
- 'in' => 'query',
- 'schema' => [
- 'title' => '当前页',
- 'description' => '当前页。默认为：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
+ 'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'title' => '每页数据量',
- 'description' => '每页大小。默认为：**100**。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- 'default' => '100',
- ],
+ 'schema' => ['description' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)页面查看或通过[CreateTask](~~223556~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12****'],
],
[
- 'name' => 'CloseTimeStart',
+ 'name' => 'StartNow',
'in' => 'query',
- 'schema' => [
- 'title' => '热线挂断的时间范围',
- 'description' => '热线挂断的结束时间。时间戳格式，单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1614578400000',
- ],
+ 'schema' => ['description' => '是否立即启动。取值：'."\n"
+ .'- **true**：是。'."\n"
+ .'- **false**：否。代表不启动任务。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'result',
- 'description' => 'Schema of Response',
+ 'title' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'ResultData' => [
- 'title' => 'data',
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'OnePageSize' => [
- 'description' => '每页大小。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'TotalPage' => [
- 'description' => '总页数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'CurrentPage' => [
- 'description' => '当前页。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TotalResults' => [
- 'description' => '总记录数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '945',
- ],
- 'Data' => [
- 'description' => '查询数据结果。',
- 'type' => 'array',
- 'items' => [
- 'description' => '会话列表数据对象。',
- 'type' => 'object',
- 'properties' => [
- 'ServicerName' => [
- 'description' => '客服账号。',
- 'type' => 'string',
- 'example' => '123@123.com',
- ],
- 'EndTime' => [
- 'title' => '热线结束时间',
- 'description' => '热线结束时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1614578410000',
- ],
- 'StartTime' => [
- 'title' => '热线开始时间',
- 'description' => '热线开始时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1614578400000',
- ],
- 'OssUrl' => [
- 'title' => '热线通话录音地址',
- 'description' => '热线通话录音地址。',
- 'type' => 'string',
- 'example' => 'http://xxx.xxxxx/xx.wav',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Message' => [
- 'title' => 'message',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'title' => 'httpStatusCode',
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => 'success',
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => ['description' => '是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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' => '查询热线详情列表',
- 'description' => '此接口查询在某个时间段范围内查询热线详细信息，包含热线通话信息。查询规则如下：'."\n"
- .'- 查询时间段跨度最大为1天。'."\n"
- .'- 如果只传了查询结束时间，则查询起始时间为结束时间前1小时。'."\n"
- .'- 如果只传了查询起始时间，则结束时间为起始时间后1小时。'."\n"
- .'- 如果都没传，则认为结束时间为当前时间，起始时间为结束时间前1小时。'."\n"
- .'- 如果都传了但是时间跨度大于1天，返回异常。'."\n"
- ."\n",
- ],
- 'ListRoles' => [
- 'summary' => '调用ListRoles获取一个租户下的所有角色列表。',
- 'methods' => [
- 'get',
+ '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' => '启动任务',
+ 'description' => '- 您可调用此接口启动已创建成功的智能联络机器人呼叫任务，也可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面手动启动任务。'."\n"
+ ."\n"
+ .'- 在调用此接口之前，请确保您已有创建成功的智能联络机器人呼叫任务。'."\n"
+ ."\n"
+ .'- 若您没有已创建成功的智能联络机器人呼出任务，可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面单击创建任务或通过[CreateTask](~~2718003~~)接口创建任务。'."\n"
+ ."\n\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：500次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aiccs:StartTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'StopAiCallTask' => [
+ 'summary' => '停止呼出任务。',
+ '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',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'clientToken',
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
- ],
- [
- 'name' => 'InstanceId',
+ 'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'title' => '租户实例id',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['description' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => '1187**************'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'result',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => 'message',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'title' => 'httpStatusCode',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7124F972-BAB8-5D1E-90FC-01CB10713B29'],
'Data' => [
- 'title' => 'data',
- 'description' => '角色信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据列表。',
- 'type' => 'object',
- 'properties' => [
- 'RoleGroupId' => [
- 'title' => '所属角色组id',
- 'description' => '所属角色组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'BuId' => [
- 'title' => '租户id',
- 'description' => '租户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Description' => [
- 'title' => '角色描述',
- 'description' => '角色描述。',
- 'type' => 'string',
- 'example' => 'Admin',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间。格式为：<i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z（UTC时间）。',
- 'type' => 'string',
- 'example' => '2020-01-03T20:25:33Z',
- ],
- 'Title' => [
- 'title' => '角色名称',
- 'description' => '角色名称。',
- 'type' => 'string',
- 'example' => '企业管理员',
- ],
- 'RoleGroupName' => [
- 'title' => '所属角色组名称',
- 'description' => '所属角色组名称。',
- 'type' => 'string',
- 'example' => '角色组名称',
- ],
- 'RoleId' => [
- 'title' => '角色id',
- 'description' => '角色ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Code' => [
- 'title' => '角色code',
- 'description' => '角色Code。',
- 'type' => 'string',
- 'example' => 'admin',
- ],
- ],
- ],
- ],
- 'Success' => [
- 'title' => 'success',
- 'description' => '接口调用是否成功。',
+ 'description' => '返回数据结果。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。',
'type' => 'boolean',
+ 'enumValueTitles' => [],
'example' => 'true',
],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- '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',
+ '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' => '停止呼叫任务',
+ 'description' => '- 在停止呼出任务之前，请确保您已创建呼出任务且任务状态为运行中。'."\n"
+ ."\n"
+ .'- 若您没有已创建的呼出任务，请先在呼出任务管理界面创建呼出任务或通过[CreateAiCallTask](~~2926796~~)接口创建呼出任务。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- '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' => '获取角色列表',
+ 'ramActions' => [],
],
- 'MakeCall' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'StopAiOutboundTask' => [
+ 'summary' => '根据实例ID、任务ID暂停外呼任务。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -29721,686 +18281,431 @@
],
'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' => '外部账户ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123456',
- ],
- ],
- [
- 'name' => 'OuterAccountType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '外部账户类型。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ALIPAY',
- ],
- ],
- [
- 'name' => 'CommandCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '操作码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'outBound_Call',
- ],
- ],
- [
- 'name' => 'CallingNumber',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'description' => '主叫号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '0571456****',
- ],
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_***'],
],
[
- 'name' => 'CalledNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '被叫号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '130****0000',
- ],
- ],
- [
- 'name' => 'ExtInfo',
+ 'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '透传业务信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"bizId": 23323}',
- ],
+ 'schema' => ['title' => '任务id', 'description' => '任务ID。'."\n"
+ ."\n"
+ .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'title' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Data' => [
- 'description' => '是否成功。取值：'."\n"
- .'- **true**（成功）'."\n"
- .'- **false**（失败）',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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 \\"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' => '暂停外呼任务',
+ 'description' => '暂停外呼任务后，若需要重新启动外呼任务，可调用[StartAiOutboundTask](~~2718027~~)接口。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：20次/秒。'."\n"
+ .'- API频率：20次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ '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' => '发起热线呼叫',
- 'summary' => '调用MakeCall发起呼叫。',
+ 'ramActions' => [],
],
- 'QueryHotlineInQueue' => [
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'StopTask' => [
+ 'summary' => '暂停已成功启动的智能联络机器人呼叫任务。',
+ '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' => '外部技能组ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123456',
- ],
- ],
- [
- 'name' => 'OuterGroupType',
+ 'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部技能组类型。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'mybank',
- ],
+ 'schema' => ['description' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)页面查看或通过[CreateTask](~~223556~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Data' => [
- 'description' => '热线坐席数据。',
- 'type' => 'string',
- 'example' => '{"n_online_now":10,"n_idle_now":3,"n_resttype_now":3,"n_acw_now":1}',
- ],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => ['description' => '是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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 \\"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' => '查询队列中热线',
- 'summary' => '调用QueryHotlineInQueue根据技能组ID获取热线技能组坐席数据。',
- 'responseParamsDescription' => 'n_online_now ： 在线客服量'."\n"
- .'n_idle_now ： 空闲客服量'."\n"
- .'n_resttype_now： 小休客服量'."\n"
- .'n_acw_now ： 话后处理客服量',
- ],
- 'QueryOutboundTask' => [
- 'methods' => [
- 'post',
- 'get',
+ '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' => '暂停任务',
+ 'description' => '- 你可通过此接口暂停已成功启动的智能联络机器人呼叫任务，也可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面手动暂停任务。'."\n"
+ ."\n"
+ .'- 在调用此接口之前，请确保您已有成功启动的智能联络机器人呼叫任务。'."\n"
+ ."\n"
+ .'- 若您没有已成功启动的智能联络机器人呼叫任务，请在[任务管理](https://aiccs.console.aliyun.com/job/list)界面点击启动或通过[StartTask](~~2718005~~)接口启动任务。'."\n"
+ ."\n\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：500次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aiccs:StopTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'SubmitAudioNote' => [
+ 'summary' => '提交录音小记任务。',
+ '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',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775700',
- 'minimum' => '0',
- 'default' => '',
- ],
- ],
- [
- 'name' => 'TaskType',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '10',
- 'minimum' => '0',
- ],
- ],
- [
- 'name' => 'TaskName',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- [
- 'name' => 'StartDate',
+ 'name' => 'AgentId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '小记智能体ID，需传入已上线的录音小记智能体ID。', 'type' => 'string', 'required' => true, 'example' => '200'],
],
[
- 'name' => 'EndDate',
+ 'name' => 'FilePath',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '录音文件在 OSS 中的存储路径，需使用获取上传地址接口返回的 FilePath。', 'type' => 'string', 'required' => true, 'example' => 'audio-note/100/uuid/test.wav'],
],
[
- 'name' => 'StartTime',
+ 'name' => 'BizId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '业务方自定义任务ID，用于回执或问题排查时关联外部业务记录。', 'type' => 'string', 'required' => false, 'example' => 'biz-001'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'LlmModelId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '小记推理使用的 LLM 模型 ID。不传时使用智能体默认模型配置。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '88'],
],
- [
- 'name' => 'SkillGroup',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775700',
- 'minimum' => '0',
- ],
- ],
- [
- 'name' => 'Ani',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'type' => 'string',
- 'required' => false,
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '12345678-1234-1234-1234-123456789012'],
+ 'Data' => ['description' => '提交成功后返回的录音小记任务 ID，即后续异步小记结果回执中的 CallId。', 'type' => 'string', 'example' => '100000000000000001_100000000000000002'],
+ 'Code' => ['description' => '请求状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交离线语音小记',
+ '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' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'AK' => [],
],
[
- 'name' => 'GroupName',
- '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' => 'DepartmentId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'name' => 'ClientToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
'name' => 'InstanceId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'in' => 'formData',
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '0',
- 'default' => '20',
- ],
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'],
],
[
- 'name' => 'CurrentPage',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '10000',
- 'minimum' => '1',
- 'default' => '1',
- ],
+ 'name' => 'Type',
+ 'in' => 'formData',
+ 'schema' => ['description' => '小休原因。取值：'."\n"
+ .'- **1**：小休（默认值）。'."\n"
+ .'- **2**：就餐。'."\n"
+ .'- **3**：会议。'."\n"
+ .'- **4**：辅导 。'."\n"
+ .'- **5**：培训。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '5', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'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' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。'."\n", 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- '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' => '[{"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' => '暂停热线服务',
+ 'summary' => '在热线坐席小休时，暂停热线服务。',
+ 'description' => '若休息结束，需要开始热线服务，可调用[StartHotlineService](~~2718045~~)接口。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '',
+ 'ramActions' => [],
],
- 'QueryTaskDetail' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'SuspendOutboundTask' => [
+ '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' => 'OutboundTaskId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- [
- 'name' => 'StatusList',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0'],
],
[
- 'name' => 'EndReasonList',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true],
],
- [
- 'name' => 'SkillGroup',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'type' => 'string',
- 'required' => false,
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'Data' => ['type' => 'string'],
+ 'Code' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
+ ],
],
],
- [
- 'name' => 'ServicerName',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ ],
+ '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\\": true\\n}","type":"json"}]',
+ ],
+ 'TerminateAiOutboundTask' => [
+ 'summary' => '根据实例ID、任务ID终止外呼任务。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ServicerId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
[
- 'name' => 'PriorityList',
+ 'name' => 'InstanceId',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['title' => '实例id', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_****'],
],
[
'name' => 'TaskId',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775700',
- 'minimum' => '0',
- ],
- ],
- [
- 'name' => 'Ani',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['title' => '任务id', 'description' => '任务ID。'."\n"
+ ."\n"
+ .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1763****'],
],
- [
- 'name' => 'Dnis',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'type' => 'string',
- 'required' => false,
+ 'title' => 'Schema of Response',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
- [
- 'name' => 'Sid',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ ],
+ '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' => '终止外呼任务',
+ 'description' => '- 此接口支持终止外呼任务，终止后，任务无法重新启动。'."\n"
+ .'- 若需要暂时停止外呼任务，可调用[StopAiOutboundTask](~~2718024~~)接口。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：20次/秒。'."\n"
+ .'- API频率：20次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ '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' => ['title' => '场景ID', 'description' => '场景ID', 'type' => 'string', 'required' => false, 'example' => '1232'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'UserDialogContent',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['title' => '用户对话内容', 'description' => '用户对话内容', 'type' => 'string', 'required' => false, 'example' => '你好。'],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'BaseModel',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '基础模型',
+ 'description' => '基础模型',
+ 'type' => 'array',
+ 'items' => ['description' => '基础模型Code', 'type' => 'string', 'required' => false, 'example' => '[\\"qwen-flash\\"]'],
'required' => false,
- 'maximum' => '10000',
- 'minimum' => '0',
- 'default' => '1',
+ 'example' => '',
],
],
],
@@ -30409,139 +18714,45 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'HttpStatusCode' => [
- 'type' => 'string',
- ],
+ 'AccessDeniedDetail' => ['description' => '鉴权报错信息', 'type' => 'string', 'example' => 'None'],
+ 'RequestId' => ['title' => '', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F2051E18-FF3F-5C08-8D24-6F150D2AF757'],
+ 'Message' => ['title' => '', 'description' => '状态码描述。', 'type' => 'string', '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' => '数据列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => ['title' => '输出结果', 'description' => '输出结果', 'type' => 'string', 'example' => '⌈您好！我是阿里云官网的 AI 小助手。\\n\\n您输入的“得到的”似乎不是一个完整的问题。请问您具体想了解关于阿里云的哪些知识？\\n\\n例如：\\n* 阿里云有哪些核心产品（如 ECS、RDS、OSS 等）？\\n* 如何购买或续费云服务器？\\n* 阿里云的安全防护能力有哪些？\\n* 如何获取技术支持或查看文档？\\n\\n请随时提出您的具体问题，我将为您解答！⌋'],
+ 'ErrorMsg' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '{\\"code\\":\\"InvalidApiKey\\",\\"message\\":\\"Invalid API-key provided.\\",\\"request_id\\":\\"dd14065e-3dd5-90a1-b8ee-d6c80891defe\\"}'],
+ 'ModelVersion' => ['title' => '模型版本号', 'description' => '模型版本号', 'type' => 'string', 'example' => '1'],
+ 'Success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'false'],
],
],
+ 'example' => '',
],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'string',
- ],
+ 'Code' => ['title' => '', 'description' => '状态码。返回OK表示调用成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['title' => '', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorMessage' => 'A system error occurred. Please contact the administrator.',
- 'errorCode' => 'SystemError',
- ],
- ],
+ 'title' => '网关大模型测试',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '',
+ '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"}]',
],
- 'QueryTickets' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'TransferCallToSkillGroup' => [
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -30550,478 +18761,537 @@
'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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
+ ],
+ [
'name' => 'InstanceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '实例ID。'."\n"
- ."\n"
- .'请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**实例管理**中查看实例ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'CaseId',
+ 'name' => 'AccountName',
'in' => 'formData',
- 'schema' => [
- 'description' => '工单ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '223468****',
- ],
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'],
],
[
- 'name' => 'CaseType',
+ 'name' => 'SkillGroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => '工单类型编号（系统自动分配）。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '1223',
- ],
+ 'schema' => ['description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '356543'],
],
[
- 'name' => 'CaseStatus',
+ 'name' => 'CallId',
'in' => 'formData',
- 'schema' => [
- 'description' => '工单状态编号。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '-100000',
- 'example' => '2',
- ],
+ 'schema' => ['description' => '热线会话ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786'],
],
[
- 'name' => 'SrType',
+ 'name' => 'JobId',
'in' => 'formData',
- 'schema' => [
- 'description' => '工单模板ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '1',
- 'example' => '29506',
- ],
+ 'schema' => ['description' => '呼入后，websocket中的jobId。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787'],
],
[
- 'name' => 'TaskStatus',
+ 'name' => 'ConnectionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务状态。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '-10000000',
- 'example' => '3',
- ],
+ 'schema' => ['description' => '呼入后，websocket中的connId。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788'],
],
[
- 'name' => 'ChannelId',
+ 'name' => 'HoldConnectionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '渠道ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '02acfefd3fa14049826ac1a89e1xxxxx',
- ],
+ 'schema' => ['description' => '呼入后，websocket中的holdConnId（仅在双步转时传入）。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0'],
],
[
- 'name' => 'ChannelType',
+ 'name' => 'Type',
'in' => 'formData',
- 'schema' => [
- 'description' => '渠道类型。取值：'."\n"
- .'- **0**：未填写'."\n"
- .'- **1**：热线'."\n"
- .'- **2**：在线',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '-10000000',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '默认值为**1**。取值：'."\n"
+ .'- **1**：单步转。'."\n"
+ .'- **2**：双步转。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
- 'name' => 'TouchId',
+ 'name' => 'IsSingleTransfer',
'in' => 'formData',
+ 'schema' => ['description' => '默认值为**true**，取值：'."\n"
+ .'- **true**：单步转。'."\n"
+ .'- **false**：双步转。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '接触ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '15030609',
+ 'description' => 'result',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Code' => ['description' => '错误编码。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
+ ],
+ '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' => '[{"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":""}]',
+ 'title' => '执行单/双步转交到技能组',
+ 'summary' => '调用TransferCallToSkillGroup接口执行单/双步转交到技能组。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ ],
+ 'UpdateAgent' => [
+ 'methods' => ['put'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
[
- 'name' => 'DealId',
+ 'BearerToken' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
+ [
+ 'name' => 'ClientToken',
'in' => 'formData',
- 'schema' => [
- 'description' => '处理人ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '-1',
- 'example' => '123456',
- ],
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'],
],
[
- 'name' => 'Extra',
+ 'name' => 'InstanceId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '附加信息。',
- 'type' => 'object',
- 'required' => false,
- 'example' => '无',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'AccountName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。'."\n"
+ .'> 不支持更新。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'],
+ ],
+ [
+ 'name' => 'DisplayName',
'in' => 'formData',
+ 'schema' => ['description' => '坐席对外显示名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'XX测试'],
+ ],
+ [
+ 'name' => 'SkillGroupId',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '页大小。默认值为：**10**。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '坐席所属技能组。',
+ 'type' => 'array',
+ 'items' => ['description' => '技能组。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2345****'],
'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
+ 'maxItems' => 200,
],
],
[
- 'name' => 'CurrentPage',
+ 'name' => 'SkillGroupIdList',
'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '当前页。默认值：**1**。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '坐席所属技能组列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '技能组列表。多个技能组用半角逗号（,）分隔。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2321****,4567****'],
'required' => false,
- 'maximum' => '5000',
- 'minimum' => '0',
- 'example' => '1',
- 'default' => '0',
+ 'maxItems' => 200,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Data' => [
- 'description' => '工单信息。',
- 'type' => 'string',
- '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}',
- ],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Code' => ['description' => '状态码。返回Success表示调用成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
500 => [
- [
- 'errorMessage' => 'A system error occurred. Please contact the administrator.',
- 'errorCode' => 'SystemError',
- ],
+ ['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' => '[{"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' => '查询工单',
- 'summary' => '调用QueryTickets接口查询工单信息。',
- ],
- 'RestartOutboundTask' => [
- 'methods' => [
- 'post',
- 'get',
+ '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' => '更新坐席数据',
+ 'summary' => '根据实例ID、坐席账号名称修改悉犀客服工作台坐席信息。支持修改坐席对外显示名称、坐席所属技能组。',
+ 'description' => '- 调用前，建议您确认AICCS实例ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ .'- 更新后，您可调用[GetAgent](~~2717961~~)接口，确认更新是否符合预期。'."\n"
+ ."\n"
+ .'> 目前仅支持修改对外显示名称和所属技能组。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ ],
+ 'UpdateAiCallTask' => [
+ 'summary' => '更新呼叫任务配置。',
+ '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' => '任务名称，同一个账号下不允许重复。', 'type' => 'string', 'required' => true, 'example' => '测试任务'],
+ ],
+ [
+ 'name' => 'VirtualNumber',
'in' => 'query',
+ 'schema' => ['description' => '呼出使用的服务实例。', 'type' => 'string', 'required' => true, 'example' => '0537022*****'],
+ ],
+ [
+ 'name' => 'StartType',
+ 'in' => 'query',
+ 'schema' => ['description' => '启动方式。取值：'."\n"
+ ."\n"
+ .'- IMMEDIATE：立即启动。'."\n"
+ ."\n"
+ .'- SCHEDULE：定时启动。', 'type' => 'string', 'required' => true, 'example' => 'IMMEDIATE'],
+ ],
+ [
+ 'name' => 'MissCallRetry',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启重试。取值：'."\n"
+ ."\n"
+ .'- true：是。'."\n"
+ ."\n"
+ .'- false（默认）：否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'CallRetryReason',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '失败重试原因。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '具体重试原因。取值：'."\n"
+ ."\n"
+ .'- CALL_REJECTED：拒接。'."\n"
+ ."\n"
+ .'- USER_BUSY：被叫忙。'."\n"
+ ."\n"
+ .'- SUSPEND：停机。'."\n"
+ ."\n"
+ .'- INVALID_NUMBER：空号。'."\n"
+ ."\n"
+ .'- POWERED_OFF：关机。'."\n"
+ ."\n"
+ .'- NETWORK_BUSY：网络忙。'."\n"
+ ."\n"
+ .'- NO_ANSWER：无应答。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'CALL_REJECTED',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'CallRetryTimes',
+ 'in' => 'query',
+ 'schema' => ['description' => '重试次数，最大不能超过3次。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
+ ],
+ [
+ 'name' => 'CallRetryInterval',
+ 'in' => 'query',
+ 'schema' => ['description' => '重试间隔，单位：分钟，最大不能超过120分钟。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25'],
+ ],
+ [
+ 'name' => 'CallTime',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '可呼叫时间。',
+ 'type' => 'array',
+ 'items' => ['description' => '呼叫时间段，格式如下：'."\n"
+ .'```json'."\n"
+ .'{"startTime":"09:00:00","endTime":"10:00:00"}'."\n"
+ .'```'."\n"
+ .'`startTime`代表开始时间，`endTime`代表结束时间，仅处于这个时间段内的时刻才会发起呼出调度，否则将等待下一个可调度是间段到来。'."\n"
+ ."\n"
+ .'> - 根据运营商政策要求，最终执行时间以平台调度为准，您可通过[真实号管理](https://dyvms.console.aliyun.com/number/list/normal)查看号码限呼时段。', 'type' => 'string', 'required' => false, 'example' => '{"startTime":"09:00:00","endTime":"10:00:00"}'],
'required' => true,
- 'docRequired' => true,
- 'maximum' => '9223372036854775700',
- 'minimum' => '0',
],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'CallDay',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'type' => 'string',
+ 'description' => '可呼叫日。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '可呼叫日。取值：'."\n"
+ ."\n"
+ .'- MONDAY：周一。'."\n"
+ ."\n"
+ .'- TUESDAY：周二。'."\n"
+ ."\n"
+ .'- WEDNESDAY：周三。'."\n"
+ ."\n"
+ .'- THURSDAY：周四。'."\n"
+ ."\n"
+ .'- FRIDAY：周五。'."\n"
+ ."\n"
+ .'- SATURDAY：周六。'."\n"
+ ."\n"
+ .'- SUNDAY：周天。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['WEDNESDAY' => '周三', 'MONDAY' => '周一', 'THURSDAY' => '周四', 'SUNDAY' => '周天', 'TUESDAY' => '周二', 'FRIDAY' => '周五', 'SATURDAY' => '周六'],
+ 'example' => 'MONDAY',
+ ],
'required' => true,
- 'docRequired' => true,
],
],
+ [
+ 'name' => 'TaskStartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务预设的启动时间，时间戳，单位毫秒。StarType字段为SCHEDULE时该字段有效且必填，任务将在该字段设置的时间进行自动启动。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748923429000'],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => ['description' => '待更新的任务ID。', 'type' => 'string', 'required' => true, 'example' => '1187**************'],
+ ],
+ [
+ 'name' => 'TaskCps',
+ 'in' => 'query',
+ 'schema' => ['description' => '任务并发，最大不超过500。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '57', 'default' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'Message' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '错误信息。仅当返回异常时显示。', 'type' => 'string', 'example' => '参数不合法'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FCD94A7F-316D-54D1-9BFC-814006CB1C34'],
+ 'Data' => ['description' => '更新结果。取值：'."\n"
+ ."\n"
+ .'- **true**：更新成功。'."\n"
+ ."\n"
+ .'- **false**：更新失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- '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' => '更新呼叫任务',
+ 'description' => '在更新呼叫任务配置前，请先确保呼叫任务的状态为已停止。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aiccs:UpdateAiCallTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '',
],
- 'StartCallV2' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateAiOutboundTask' => [
+ 'summary' => '根据实例ID、任务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' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => ['title' => '实例ID', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。'."\n", 'type' => 'string', 'required' => true, 'example' => 'agent_***'],
],
[
- 'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => ['title' => '任务id', 'description' => '任务ID。'."\n"
+ ."\n"
+ .'可调用[CreateAiOutboundTask](~~312260~~)接口，查看返回参数中的**Data**，或者调用[GetAiOutboundTaskList](~~2718026~~)接口，查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'],
],
[
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称（坐席登录名）。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123@123.com',
- ],
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['title' => '任务名（1～15字符）', 'description' => '任务名称。1～15字符。', 'type' => 'string', 'required' => true, 'example' => 'xxxx外呼', 'maxLength' => 15, 'minLength' => 1],
],
[
- 'name' => 'Caller',
- 'in' => 'formData',
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['title' => '任务描述（0～100字符）', 'description' => '任务描述。0～100字符。', 'type' => 'string', 'required' => false, 'example' => '房产销售', 'maxLength' => 100],
+ ],
+ [
+ 'name' => 'OutboundNums',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '热线外呼主叫号码。',
- 'type' => 'string',
+ 'title' => '外呼主叫号码',
+ 'description' => '外呼主叫号码。',
+ 'type' => 'array',
+ 'items' => ['description' => '外呼主叫号码。', 'type' => 'string', 'required' => true, 'example' => '150****0000'],
'required' => true,
- 'docRequired' => true,
- 'example' => '9065****',
],
],
[
- 'name' => 'CallerType',
- 'in' => 'formData',
+ 'name' => 'NumRepeated',
+ 'in' => 'query',
'schema' => [
- 'description' => '呼叫类型。取值：'."\n"
- ."\n"
- .'- **1**：呼入'."\n"
- .'- **2**：呼出',
+ 'title' => '被叫号码重复策略（0:任务内去重，1:任务内不去重）',
+ 'description' => '被叫号码重复策略。'."\n"
+ .'- **0**：任务内去重。'."\n"
+ .'- **1**：任务内不去重。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
- 'docRequired' => true,
'example' => '1',
- 'enum' => [
- '1',
- '2',
- ],
+ 'enum' => ['0', '1'],
],
],
[
- 'name' => 'Callee',
- 'in' => 'formData',
+ 'name' => 'HandlerId',
+ 'in' => 'query',
+ 'schema' => ['title' => '技能组id（预测式外呼）或者ivr id（自动外呼）', 'description' => '技能组ID（预测式外呼）或者IVR ID（自动外呼）。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'],
+ ],
+ [
+ 'name' => 'ExecutionTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '任务执行时间', 'description' => '任务执行时间。'."\n"
+ ."\n"
+ .'> 结束时间（end）需晚于开始时间（start）。', 'type' => 'string', 'required' => true, '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"}]}'],
+ ],
+ [
+ 'name' => 'ConcurrentRate',
+ 'in' => 'query',
+ 'schema' => ['title' => '自动外呼的并发', 'description' => '自动外呼的并发。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'RecallRule',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '热线外呼被叫号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '136****1111',
+ 'title' => '失败重呼策略',
+ 'description' => '失败重呼策略。'."\n"
+ ."\n"
+ .'> 为空则外呼失败时不重呼。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Count' => ['title' => '失败重呼次数（1～3次）', 'description' => '失败重呼次数。取值范围：**1～3**次。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3', 'minimum' => '1', 'example' => '2'],
+ 'Interval' => ['title' => '失败重呼间隔时间（1～60分钟）', 'description' => '失败重呼间隔时间。取值范围：**1～60**，单位：分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '60', 'minimum' => '1', 'example' => '5'],
+ ],
+ 'required' => false,
],
],
+ [
+ 'name' => 'ForecastCallRate',
+ 'in' => 'query',
+ 'schema' => ['title' => '预测式外呼固定外呼比例（>=1）', 'description' => '预测式外呼固定外呼比例。取值范围：**≥1**。', 'type' => 'number', 'format' => 'float', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '1.2'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'result',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Code' => [
- 'description' => '状态码。返回Success表示请求成功。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'ok'],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'ok'],
+ 'Success' => ['description' => '调用接口是否成功。'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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' => '[{"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' => '更新外呼任务',
+ 'description' => '此接口支持更新任务名称、任务描述、外呼主叫号码、技能组ID等信息，具体参见[请求参数](#api-detail-35)。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：20次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ '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' => '坐席发起外呼',
- 'summary' => '调用StartCallV2发起外呼V2。',
+ 'ramActions' => [],
],
- 'StartChatWork' => [
- 'summary' => '调用StartChatWork设置在线坐席为上班状态。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'UpdateDepartment' => [
+ 'summary' => '根据AICCS实例ID、部门ID更新部门名称。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -31029,272 +19299,172 @@
],
'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' => [
- 'title' => 'instanceId',
- 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ccc_xp_pre***',
- ],
+ 'in' => 'query',
+ 'schema' => ['title' => '实例id', 'description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'accountName',
- 'description' => '坐席登录名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123@123.com',
- ],
+ 'name' => 'DepartmentName',
+ 'in' => 'query',
+ 'schema' => ['title' => '部门名称', 'description' => '部门名称。'."\n"
+ ."\n"
+ .'> 支持更新该参数。', 'type' => 'string', 'required' => true, 'example' => '部门A'],
+ ],
+ [
+ 'name' => 'DepartmentId',
+ 'in' => 'query',
+ 'schema' => ['title' => '部门id', 'description' => '部门ID。'."\n"
+ ."\n"
+ .'可调用[GetAllDepartment](~~2717975~~)接口，查看返回参数的**DepartmentId**，即部门ID。'."\n"
+ ."\n"
+ .'> 不支持更新。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'result',
- 'description' => 'Schema of Response',
+ 'title' => 'Schema of Response',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => 'message',
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'title' => 'requestId',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'HttpStatusCode' => [
- 'title' => 'httpStatusCode',
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Data' => [
- 'title' => 'data',
- 'description' => '值为**1**代表用户切换为上班状态。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Code' => [
- 'title' => 'code',
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => 'success',
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ 'Data' => ['description' => '是否成功。取值：'."\n"
+ .'- **true**：成功'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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',
- ],
+ 500 => [
+ ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => '系统错误，请联系管理员！'],
],
],
- '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' => '设置在线坐席为上班状态',
- ],
- 'StartMicroOutbound' => [
- 'methods' => [
- 'post',
- 'get',
+ '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' => '更新部门信息',
+ 'description' => '- 此接口仅支持更新部门名称，不支持更新部门ID。'."\n"
+ .'- 调用此接口前，建议您确认AICCS实例ID及部门ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ .'- 更新完成后，您可以调用[GetAllDepartment](~~2717975~~)接口，确认部门信息是否符合预期。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：100次/秒。'."\n"
+ .'- API频率：100次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T12:37:29.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDepartment'],
+ ],
],
+ 'ramActions' => [],
+ ],
+ 'UpdateLargeModel' => [
+ 'summary' => '更新大模型网关配置。',
+ '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' => '产品名称。默认取值：**aiccs**。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'aiccs',
- 'default' => 'aiccs',
- ],
+ 'schema' => ['title' => '模型编码', 'description' => '模型编码', 'type' => 'string', 'required' => false, 'example' => 'Test Model Name'],
],
[
- 'name' => 'AccountType',
+ 'name' => 'ModelName',
'in' => 'query',
- 'schema' => [
- 'description' => '账户类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'BUC_TYPE',
- ],
+ 'schema' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'required' => false, 'example' => 'Test model'],
],
[
- 'name' => 'AccountId',
+ 'name' => 'ModelUrl',
'in' => 'query',
- 'schema' => [
- 'description' => '账户ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '223457****',
- ],
+ 'schema' => ['title' => '模型地址', 'description' => '模型地址', 'type' => 'string', 'required' => false, 'example' => 'https://xxxxxxxxx'],
],
[
- 'name' => 'CommandCode',
+ 'name' => 'AuthCode',
'in' => 'query',
- 'schema' => [
- 'description' => '指令Code。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'outBound_Call',
- ],
+ 'schema' => ['title' => '授权码', 'description' => '授权码', 'type' => 'string', 'required' => false, 'example' => 'sk-sxxxxx*********xx'],
],
[
- 'name' => 'CallingNumber',
+ 'name' => 'Temperature',
'in' => 'query',
- 'schema' => [
- 'description' => '主叫号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1367123****',
- ],
+ 'schema' => ['title' => '温度', 'description' => '温度', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.1'],
],
[
- 'name' => 'CalledNumber',
+ 'name' => 'TopP',
'in' => 'query',
- 'schema' => [
- 'description' => '被叫号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0571456****',
- ],
+ 'schema' => ['title' => 'topP', 'description' => 'topP', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.1'],
],
[
- 'name' => 'ExtInfo',
+ 'name' => 'TopK',
'in' => 'query',
- 'schema' => [
- 'description' => '业务信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"caseId":23232****}',
- ],
+ 'schema' => ['title' => 'topK', 'description' => 'topK', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
],
[
- 'name' => 'AppName',
+ 'name' => 'BaseModel',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '业务自定义AppName。',
- 'type' => 'string',
+ 'title' => '基础模型',
+ 'description' => '基础模型',
+ 'type' => 'array',
+ 'items' => ['description' => '基础模型名字', 'type' => 'string', 'required' => false, 'example' => 'qwen-max'],
'required' => false,
- 'example' => 'aliyun',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'InvokeCreateTime' => [
- 'description' => '发起创建时间',
- 'type' => 'string',
- 'example' => '2019-05-23 17:30:32.525',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'InvokeCmdId' => [
- 'description' => '发起命令ID。',
- 'type' => 'string',
- 'example' => '8883f165-4a0d-4da2-a2d2',
- ],
- 'CustomerInfo' => [
- 'description' => '客户信息。',
- 'type' => 'string',
- 'example' => '{\\"caseId\\":2323****}',
- ],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'AccessDeniedDetail' => ['description' => '鉴权报错信息', 'type' => 'string', 'example' => 'Access Denied'],
+ 'RequestId' => ['title' => '', 'description' => '请求ID。', 'type' => 'string', 'example' => 'example'],
+ 'Message' => ['title' => '', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'example'],
+ 'Data' => ['title' => '', 'description' => '数据列表。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.',
- 'errorCode' => 'Permission.NotAuthorized',
- ],
- [
- 'errorMessage' => 'Parameter error.',
- 'errorCode' => 'Parameter.Error',
- ],
- ],
+ 'title' => '更新大模型网关配置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- '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' => '发起呼叫',
- 'summary' => '调用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' => [],
@@ -31303,521 +19473,349 @@
'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' => ['title' => '模型应用名称', 'description' => '模型应用名称', 'type' => 'string', 'required' => false, 'example' => '测试应用'],
],
[
- 'name' => 'InstanceId',
+ 'name' => 'ApplicationCode',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'schema' => ['title' => '应用编码', 'description' => '应用编码', 'type' => 'string', 'required' => true, 'example' => ' DKSDLSA'],
],
- ],
- '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' => ['title' => '应用并发请求数', 'description' => '应用并发请求数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12'],
],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorMessage' => 'A system error occurred. Please contact the administrator.',
- 'errorCode' => 'SystemError',
- ],
+ [
+ 'name' => 'ModelCode',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型编码', 'description' => '模型编码', 'type' => 'string', 'required' => false, 'example' => '1231'],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '',
- ],
- 'UpdateOuterAccount' => [
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'ModelVersion',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型版本', 'description' => '模型版本', 'type' => 'string', 'required' => false, 'example' => '1'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'OuterAccountId',
+ 'name' => 'QualificationId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部账号ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123456',
- ],
+ 'schema' => ['title' => '资质ID', 'description' => '资质ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '61'],
],
[
- 'name' => 'OuterAccountType',
+ 'name' => 'QualificationName',
'in' => 'query',
- 'schema' => [
- 'description' => '外部账号类型。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'alipay',
- ],
+ 'schema' => ['title' => '资质名称', 'description' => '资质名称', 'type' => 'string', 'required' => false, 'example' => '测试质检'],
],
[
- 'name' => 'OuterAccountName',
+ 'name' => 'SpeechId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部账号名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '测试',
- ],
+ 'schema' => ['title' => '话束id', 'description' => '话术ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15'],
],
[
- 'name' => 'Avatar',
+ 'name' => 'SpeechContent',
'in' => 'query',
- 'schema' => [
- 'description' => '头像。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://****',
- ],
+ 'schema' => ['title' => '话术内容', 'description' => '话术内容', 'type' => 'string', 'required' => false, 'example' => '测试话术'],
],
[
- 'name' => 'RealName',
+ 'name' => 'UsageDesc',
'in' => 'query',
- 'schema' => [
- 'description' => '账号真实姓名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '张三',
- ],
+ 'schema' => ['title' => '用途', 'description' => '用途', 'type' => 'string', 'required' => false, 'example' => '测试用途'],
],
[
- 'name' => 'OuterDepartmentId',
+ 'name' => 'DyvmsSceneName',
'in' => 'query',
- 'schema' => [
- 'description' => '外部部门ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3',
- ],
+ 'schema' => ['title' => '场景名称', 'description' => '场景名称', 'type' => 'string', 'required' => false, 'example' => '测试场景'],
],
[
- 'name' => 'OuterGroupIds',
+ 'name' => 'StartWord',
'in' => 'query',
- 'schema' => [
- 'description' => '外部技能组ID列表。多个ID用英文逗号（,）分隔。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["222","333","444"]',
- ],
+ 'schema' => ['title' => '开场白', 'description' => '开场白', 'type' => 'string', 'required' => false, 'example' => '你好，这是个测试开场白'],
],
[
- 'name' => 'Ext',
+ 'name' => 'StartWordType',
'in' => 'query',
- 'schema' => [
- 'description' => '扩展字段。JSON字符串。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"备注":"临时技能组"}',
- ],
+ 'schema' => ['description' => '开场白类型', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0：文本'."\n"
+ .'1：录音'."\n"],
],
[
- 'name' => 'OuterGroupType',
+ 'name' => 'RecordingFile',
'in' => 'query',
- 'schema' => [
- 'description' => '技能组类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'mybank',
- ],
+ 'schema' => ['description' => '录音音频文件地址', 'type' => 'string', 'required' => false, 'example' => 'https://xxxxxxxxxxxxxxx.wav'],
],
[
- 'name' => 'OuterDepartmentType',
+ 'name' => 'Prompt',
'in' => 'query',
- 'schema' => [
- 'description' => '外部部门类型：无效部门类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'type_invalid',
- ],
+ 'schema' => ['title' => '提示词', 'description' => '提示词', 'type' => 'string', 'required' => false, 'example' => '测试提示词'],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'TtsConfig',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'Schema of Response',
+ 'title' => 'tts配置，包括音色、音量、音速等。',
+ 'description' => 'tts配置，包括音色、音量、音速等。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Data' => [
- 'description' => '是否成功。取值：'."\n"
- ."\n"
- .'- **true**：成功'."\n"
- .'- **false**：失败',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'VoiceCode' => ['title' => '声音编码', 'description' => '声音编码', 'type' => 'string', 'required' => false, 'example' => '12123213123'],
+ 'MixingTemplate' => ['title' => '混音模版id', 'description' => '混音模版id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
+ 'BackgroundEnabled' => ['description' => '是否开启背景音', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'TtsVolume' => ['title' => 'TTS 变量播放的音量。取值范围：0~100，默认值为 0。', 'description' => 'TTS 变量播放的音量。取值范围：0~100，默认值为 0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11'],
+ 'TtsStyle' => ['title' => '声音风格', 'description' => '声音风格', 'type' => 'string', 'required' => false, 'example' => 'voice'],
+ 'ResourceId' => ['description' => '资源id', 'type' => 'string', 'required' => false, 'example' => '122'],
+ 'CustomerAccountId' => ['description' => '账号id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '47'],
+ 'VoiceType' => ['title' => '声音类型', 'description' => '声音类型'."\n"
+ ."\n"
+ .'```'."\n"
+ .'SYSTEM：系统音色'."\n"
+ .'COSYCLONE：复刻音色'."\n"
+ .'BL-CUSTOM：定制精品复刻音色'."\n"
+ .'```', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM'],
+ 'MixingEnabled' => ['description' => '是否开启混音', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'TtsSpeed' => ['title' => 'TTS 变量播放时的声音速度。取值范围：-200~200，默认值为 0。', 'description' => 'TTS 变量播放时的声音速度。取值范围：-200~200，默认值为 0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7'],
+ 'BackgroundSound' => ['title' => '背景音id', 'description' => '背景音id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
+ 'BackgroundVolume' => ['title' => '背景音音量(id)', 'description' => '背景音音量(id)'."\n"
+ .'取值：0：low，1：medium，2：high', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
+ 'required' => false,
+ 'example' => '',
],
],
- ],
- 'errorCodes' => [
- 500 => [
- [
- 'errorMessage' => 'A system error occurred. Please contact the administrator.',
- 'errorCode' => 'SystemError',
- ],
+ [
+ 'name' => 'MuteDuration',
+ 'in' => 'query',
+ 'schema' => ['title' => '静音时长', 'description' => '静音时长', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '85'],
],
- ],
- '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' => '更新外部账号信息',
- 'summary' => '调用UpdateOuterAccount根据外部账号ID更新外部账号。',
- ],
- 'TransferCallToSkillGroup' => [
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'MuteActive',
+ 'in' => 'query',
+ 'schema' => ['title' => '第一个静音是否唤起模型', 'description' => '第一个静音是否唤起模型', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'BearerToken' => [],
+ 'name' => 'MutePushMode',
+ 'in' => 'query',
+ 'schema' => ['description' => '静音事件推送模式', 'type' => 'string', 'required' => false, 'example' => 'FIRST_ONLY'],
],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'ClientToken',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d',
- ],
+ 'name' => 'MuteHangupNum',
+ 'in' => 'query',
+ 'schema' => ['title' => '连续多少个静音事件主动挂机', 'description' => '连续多少个静音事件主动挂机', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '70'],
],
[
- 'name' => 'InstanceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => 'AICCS实例ID。'."\n"
- .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'ccc_xp_pre-cn-***',
- ],
+ 'name' => 'CallAssistantRecognize',
+ 'in' => 'query',
+ 'schema' => ['title' => '通话助手识别', 'description' => '通话助手识别', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'AccountName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'username@example.com',
- ],
+ 'name' => 'CallAssistantHangup',
+ 'in' => 'query',
+ 'schema' => ['description' => '识别到智能接听是否挂断。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'SkillGroupId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '技能组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '356543',
- ],
+ 'name' => 'EnableMorse',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否启用摩斯码配置，默认不开启', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'CallId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '热线会话ID。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719786',
- ],
+ 'name' => 'SessionTimeout',
+ 'in' => 'query',
+ 'schema' => ['title' => '最大通话时长', 'description' => '最大通话时长', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '49'],
],
[
- 'name' => 'JobId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '呼入后，websocket中的jobId。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '7719787',
- ],
+ 'name' => 'Source',
+ 'in' => 'query',
+ 'schema' => ['title' => '来源', 'description' => '来源。固定值：USER。', 'type' => 'string', 'required' => false, 'example' => 'USER'],
],
[
- 'name' => 'ConnectionId',
- 'in' => 'formData',
+ 'name' => 'InterruptConfig',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '呼入后，websocket中的connId。',
- 'type' => 'string',
+ 'title' => '打断配置',
+ 'description' => '打断配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'EnableStartwordEntireNotInterrupt' => ['title' => '开场白全程不打断', 'description' => '开场白全程不打断', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'EnableAvoidInterrupt' => ['title' => '防止连续抢话功能是否开启', 'description' => '防止连续抢话功能是否开启', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'EnableStartwordNotInterrupt' => ['title' => '开场白不打断配置是否开启', 'description' => '开场白不打断配置是否开启', 'type' => 'boolean', 'required' => false, 'example' => ''],
+ 'StartwordProtectDuration' => ['title' => '开场白保护时长', 'description' => '开场白保护时长', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.4699'],
+ 'EnableInterruptBackchannel' => ['description' => '是否启用打断垫词配置', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'AvoidInterruptDTO' => [
+ 'title' => '防止连续抢话功能配置',
+ 'description' => '防止连续抢话功能配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'InterruptProtectDuration' => ['description' => '打断保护时长', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '16.417547'],
+ 'InterruptNum' => ['description' => '连续打断次数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3'],
+ ],
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
'required' => false,
- 'docRequired' => true,
- 'example' => '7719788',
+ 'example' => '',
],
],
[
- 'name' => 'HoldConnectionId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '呼入后，websocket中的holdConnId（仅在双步转时传入）。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '0',
- ],
+ 'name' => 'EnableDtmfReceive',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启DTMF按键收集，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'Type',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '默认值为**1**。取值：'."\n"
- .'- **1**：单步转。'."\n"
- .'- **2**：双步转。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2',
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'name' => 'DtmfInputTimeout',
+ 'in' => 'query',
+ 'schema' => ['description' => 'DTMF输入超时时长（秒），范围1~10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'IsSingleTransfer',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '默认值为**true**，取值：'."\n"
- .'- **true**：单步转。'."\n"
- .'- **false**：双步转。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'name' => 'DtmfDigitCount',
+ 'in' => 'query',
+ 'schema' => ['description' => 'DTMF按键位数，范围1~12', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'DtmfAutoValidateEnable',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启按键值自动校验', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'DtmfAllowedDigits',
+ 'in' => 'query',
+ 'schema' => ['description' => '按键数字枚举（逗号分隔文本，如：1,2,3；最多20个）', 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'DtmfOutOfRangeAction',
+ 'in' => 'query',
+ 'schema' => ['description' => '超出范围处理：RETURN_MODEL / AUTO_RETRY', 'type' => 'string', 'required' => false, 'example' => 'RETURN_MODEL '],
+ ],
+ [
+ 'name' => 'DtmfRetryPlayTimes',
+ 'in' => 'query',
+ 'schema' => ['description' => '重试次数（PlayTimes，1~3），仅 AUTO_RETRY 生效', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'DtmfRetryPromptText',
+ 'in' => 'query',
+ 'schema' => ['description' => '自定义重试提示音文本（<=50字），为空使用默认“输入错误，请重新输入”', 'type' => 'string', 'required' => false, 'example' => '测试文本'],
+ ],
+ [
+ 'name' => 'EnableDtmfSend',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'DtmfSendWaitTimeout',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '58'],
+ ],
+ [
+ 'name' => 'DtmfSendMaxCount',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '90'],
+ ],
+ [
+ 'name' => 'CallConnectedTriggerModel',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启接听事件推送，默认关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => 'result',
+ 'description' => 'RequestBody参数。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Code' => [
- 'description' => '错误编码。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- .'- **true**：成功。'."\n"
- .'- **false**：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'RequestId' => ['title' => '', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'],
+ 'Message' => ['title' => '', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => ['title' => '', 'description' => '数据列表。', 'type' => 'string', 'example' => 'DKSDLSA'],
+ 'Code' => ['title' => '', 'description' => '请求状态码。返回OK表示请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['title' => '', 'description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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' => '更新大模型应用配置',
+ 'summary' => '修改模型应用',
+ '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":""}]',
- 'title' => '执行单/双步转交到技能组',
- 'summary' => '调用TransferCallToSkillGroup接口执行单/双步转交到技能组。',
+ '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' => '外部的技能组ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '123456',
- ],
+ 'schema' => ['description' => '外部账号ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'],
],
[
- 'name' => 'OuterGroupName',
+ 'name' => 'OuterAccountType',
'in' => 'query',
- 'schema' => [
- 'description' => '外部的技能组名称。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '热线技能组',
- ],
+ 'schema' => ['description' => '外部账号类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alipay'],
],
[
- 'name' => 'OuterGroupType',
+ 'name' => 'OuterAccountName',
'in' => 'query',
- 'schema' => [
- 'description' => '外部的技能组类型。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'mybank',
- ],
+ 'schema' => ['description' => '外部账号名称。', 'type' => 'string', 'required' => false, 'example' => '测试'],
+ ],
+ [
+ 'name' => 'Avatar',
+ 'in' => 'query',
+ 'schema' => ['description' => '头像。', 'type' => 'string', 'required' => false, 'example' => 'http://****'],
+ ],
+ [
+ 'name' => 'RealName',
+ 'in' => 'query',
+ 'schema' => ['description' => '账号真实姓名。', 'type' => 'string', 'required' => false, 'example' => '张三'],
],
[
'name' => 'OuterDepartmentId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部的部门ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456',
- ],
+ 'schema' => ['description' => '外部部门ID', 'type' => 'string', 'required' => false, 'example' => '3'],
+ ],
+ [
+ 'name' => 'OuterGroupIds',
+ 'in' => 'query',
+ 'schema' => ['description' => '外部技能组ID列表。多个ID用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => '["222","333","444"]'],
+ ],
+ [
+ 'name' => 'Ext',
+ 'in' => 'query',
+ 'schema' => ['description' => '扩展字段。JSON字符串。', 'type' => 'string', 'required' => false, 'example' => '{"备注":"临时技能组"}'],
+ ],
+ [
+ 'name' => 'OuterGroupType',
+ 'in' => 'query',
+ 'schema' => ['description' => '技能组类型。', 'type' => 'string', 'required' => false, 'example' => 'mybank'],
],
[
'name' => 'OuterDepartmentType',
'in' => 'query',
- 'schema' => [
- 'description' => '外部的部门类型。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'type_invalid',
- ],
+ 'schema' => ['description' => '外部部门类型：无效部门类型。', 'type' => 'string', 'required' => false, 'example' => 'type_invalid'],
],
],
'responses' => [
@@ -31826,92 +19824,84 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Data' => [
- 'description' => '创建技能组ID。',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'Code' => [
- 'description' => '状态码。返回200表示请求成功。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Data' => ['description' => '是否成功。取值：'."\n"
+ ."\n"
+ .'- **true**：成功'."\n"
+ .'- **false**：失败', 'type' => 'string', 'example' => 'true'],
+ 'Code' => ['description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'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\\": \\"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' => '创建技能组',
- 'summary' => '调用AddSkillGroup创建外部技能组。',
- ],
- 'DeleteSkillGroup' => [
- 'methods' => [
- 'get',
+ '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' => '更新外部账号信息',
+ 'summary' => '调用UpdateOuterAccount根据外部账号ID更新外部账号。',
+ 'changeSet' => [
+ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
],
- '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' => '外部技能组类型,有以下枚举值： 1：热线 2：在线'."\n"
- .'4：工单',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'AICCS实例ID。'."\n"
+ .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的<b>实例管理</b>中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'],
],
[
- 'name' => 'OuterGroupId',
+ 'name' => 'SkillGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部技能组id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456',
- ],
+ 'schema' => ['description' => '技能组ID。'."\n"
+ ."\n"
+ .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口，查看返回参数的**SkillGroupId**，即技能组ID。'."\n"
+ ."\n"
+ .'> 不支持更新。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123456'],
+ ],
+ [
+ 'name' => 'SkillGroupName',
+ 'in' => 'query',
+ 'schema' => ['description' => '技能组名称。'."\n"
+ .'> 不支持更新。', 'type' => 'string', 'required' => false, 'example' => '自动化测试'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '技能组描述。'."\n"
+ .'> 此参数支持更新。', 'type' => 'string', 'required' => false, 'example' => '自动化测试'],
+ ],
+ [
+ 'name' => 'DisplayName',
+ 'in' => 'query',
+ 'schema' => ['description' => '技能组对外显示名称。'."\n"
+ .'> 此参数支持更新。', 'type' => 'string', 'required' => false, 'example' => '自动化测试'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '客户请求唯一ID。用于幂等校验，可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-****-70b6a298d94d'],
],
],
'responses' => [
@@ -31920,267 +19910,985 @@
'description' => 'result',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'description' => '错误描述',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'RequestId' => [
- 'description' => '请求ID，用于跟踪错误原因',
- 'type' => 'string',
- 'example' => 'EE338D98-9BD3-4413-B165',
- ],
- 'Data' => [
- 'description' => '数据',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'description' => '错误编码',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'],
+ 'Code' => ['description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success'],
+ 'Success' => ['description' => '调用接口是否成功。取值：'."\n"
+ .'- **true**：成功。'."\n"
+ .'- **false**：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
- 500 => [
- [
- 'errorMessage' => 'A system error occurred. Please contact the administrator.',
- 'errorCode' => 'SystemError',
- ],
+ 400 => [
+ ['errorMessage' => 'The specified instance is unavailable or does not exist.', 'errorCode' => 'InvalidInstanceId', 'description' => '当前实例不可用或不存在'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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' => '修改技能组',
+ 'summary' => '根据AICCS实例ID、技能组ID更新悉犀客服工作台技能组信息。支持更新技能组描述、技能组对外显示名称。',
+ 'description' => '- 此接口不支持更新技能组ID、技能组名称。'."\n"
+ .'- 更新后，您可以调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口查询技能组信息。'."\n"
+ .'- 若您需要填写AICCS实例ID、技能组ID，请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'- 单用户调用频率：不限流。'."\n"
+ .'- API频率：1000次/秒。'."\n"
+ ."\n"
+ .'> 如果多个用户的总调用超过API频率也会触发流控。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- '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":""}]',
- 'title' => '删除技能组',
- 'summary' => '根据技能组id、技能组渠道类型，删除外部技能组。',
+ 'ramActions' => [],
],
],
'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => '无操作权限'],
+ ['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' => '参数ApplicationCode无效。'],
+ ['code' => 'InvalidParameter.CallDate', 'message' => 'The specified parameter "CallDate" is not valid.', 'http_code' => 400, 'description' => 'CallDate无效。'],
+ ['code' => 'InvalidParameter.CallId', 'message' => 'The parameter CallId is invalid.', 'http_code' => 400, 'description' => '参数CallId无效。'."\n"],
+ ['code' => 'InvalidPartnerId.NotFound', 'message' => 'You must specify PartnerId.', 'http_code' => 400, 'description' => '合作伙伴ID为空'],
+ ['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' => '小计智能体非法'],
+ ['code' => 'INVALID_TASK_NAME', 'message' => 'taskName is invalid.', 'http_code' => 400, 'description' => '无效的任务名称'],
+ ['code' => 'MissingParameter.CallerNumber', 'message' => 'Parameter "CallerNumber" which is mandatory for the request is not provided.', 'http_code' => 400, 'description' => '没有提供请求必须的参数“CallerNumber”。'],
+ ['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' => '模型不存在。'],
+ ['code' => 'ModelStatus.Invalid', 'message' => 'Model state invalid.', 'http_code' => 400, 'description' => '模型状态无效。'],
+ ['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' => '您发送的请求参数异常。请进行核对！'],
+ ['code' => 'SUMMARY_AGENT_NOT_ONLINE', 'message' => 'summary agent is not online.', 'http_code' => 400, 'description' => '小计智能体未在线'],
+ ['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' => '系统处理错误'],
+ ['code' => 'TASK_FILE_NOT_EXIST', 'message' => 'task file is not exist.', 'http_code' => 400, 'description' => '任务文件不存在'],
+ ['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' => '每个词语不能超过10个字'],
+ ['code' => 'WordExceed', 'message' => 'Each group of vocabs cannot exceed 128 words.', 'http_code' => 400, 'description' => '每组热词不能超过128个词'],
+ ],
+ '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 下线', 'api' => 'ImportTaskNumberDatas'],
+ ],
+ 'createdAt' => '2026-02-02T07:39:07.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hangzhou-internal-test-3',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'ImportTaskNumberDatas'],
+ ],
+ 'createdAt' => '2026-02-02T07:38:45.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hangzhou-test-306',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'ImportTaskNumberDatas'],
+ ],
+ 'createdAt' => '2026-02-02T07:38:42.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'GetCallDialogContent'],
+ ],
+ 'createdAt' => '2026-01-09T03:56:48.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hongkong-finance-pop',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'GetCallDialogContent'],
+ ],
+ 'createdAt' => '2026-01-09T03:56:35.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateAiCallTask'],
+ ],
+ 'createdAt' => '2025-12-24T09:12:26.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-huhehaote-nebula-1',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateAiCallTask'],
+ ],
+ 'createdAt' => '2025-12-24T08:27:56.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-north-2-gov-1',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'LlmSmartCall'],
+ ],
+ 'createdAt' => '2025-07-10T15:15:56.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-qingdao-nebula',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'LlmSmartCall'],
+ ],
+ 'createdAt' => '2025-05-30T06:28:35.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DeleteAgent'],
+ ],
+ 'createdAt' => '2025-05-14T01:42:15.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai-et15-b01',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateAgent'],
+ ],
+ 'createdAt' => '2025-05-13T03:56:28.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai-et2-b01',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'LlmSmartCall'],
+ ],
+ 'createdAt' => '2025-05-13T02:44:32.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'LlmSmartCall'],
+ ],
+ 'createdAt' => '2025-04-18T03:55:21.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai-inner',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'LlmSmartCall'],
+ ],
+ 'createdAt' => '2025-04-14T05:49:38.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai-internal-test-1',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'GetHotlineCallAction'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'QueryTaskResult'],
+ ['description' => '请求参数发生变更', 'api' => 'StartTaskByApp'],
+ ],
+ 'createdAt' => '2022-03-07T06:26:24.000Z',
+ 'description' => '优化api的标题、描述',
],
[
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'RemoveAgentFromSkillGroup'],
+ ],
+ 'createdAt' => '2021-10-28T02:18:02.000Z',
+ 'description' => '智能联络中心新增批量移除坐席的技能组接口',
],
[
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'GetCallSoundRecord'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ListRobotNode'],
+ ],
+ 'createdAt' => '2021-10-21T13:05:31.000Z',
+ 'description' => 'add OpenAPI',
],
[
- 'regionId' => 'cn-shenzhen-inner',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'AiccsSmartCall'],
+ ['description' => '请求参数发生变更', 'api' => 'SendCcoSmartCall'],
+ ['description' => '请求参数发生变更', 'api' => 'SendCcoSmartCallOperate'],
+ ],
+ 'createdAt' => '2021-09-09T06:05:02.000Z',
+ 'description' => '更新参数必填',
],
[
- 'regionId' => 'cn-shenzhen-st4-d01',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'AddHotlineNumber'],
+ ['description' => 'OpenAPI 下线', 'api' => 'DeleteHotlineNumber'],
+ ['description' => 'OpenAPI 下线', 'api' => 'QueryHotlineNumber'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ResetHotlineNumber'],
+ ],
+ 'createdAt' => '2021-06-22T12:36:56.000Z',
+ 'description' => '号码管理api',
],
[
- 'regionId' => 'cn-shenzhen-su18-b01',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'QueryTaskResult'],
+ ['description' => '请求参数发生变更', 'api' => 'StartTaskByApp'],
+ ],
+ 'createdAt' => '2021-06-22T12:03:36.000Z',
+ 'description' => '云测，运行自动化接口发布变更',
],
[
- 'regionId' => 'cn-wuhan',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'QueryTaskResult'],
+ ['description' => 'OpenAPI 下线', 'api' => 'StartTaskByApp'],
+ ],
+ 'createdAt' => '2021-06-17T07:33:21.000Z',
+ 'description' => '云测API发布-触发自动化运行',
],
[
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'AddOuterAccount'],
+ ['description' => 'OpenAPI 下线', 'api' => 'AddSkillGroup'],
+ ['description' => 'OpenAPI 下线', 'api' => 'DeleteOuterAccount'],
+ ['description' => 'OpenAPI 下线', 'api' => 'DeleteSkillGroup'],
+ ['description' => '错误码发生变更', 'api' => 'GetCustomerInfo'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetHotlineAgentDetailReport'],
+ ['description' => '错误码发生变更', 'api' => 'GetHotlineAgentStatus'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetIndexCurrentValue'],
+ ['description' => '错误码发生变更', 'api' => 'GetQualityProjectDetail'],
+ ['description' => '错误码发生变更', 'api' => 'GetQualityProjectList'],
+ ],
+ 'createdAt' => '2021-06-02T03:16:31.000Z',
+ 'description' => '规范openapi响应格式',
],
[
- 'regionId' => 'cn-yushanfang',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateDepartment'],
+ ['description' => 'OpenAPI 下线', 'api' => 'DeleteDepartment'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetAllDepartment'],
+ ['description' => 'OpenAPI 下线', 'api' => 'UpdateDepartment'],
+ ],
+ 'createdAt' => '2021-06-01T12:37:57.000Z',
+ 'description' => '部门管理api',
],
[
- 'regionId' => 'cn-zhangbei-na61-b01',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateSkillGroup'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetConfigNumList'],
+ ['description' => 'OpenAPI 下线', 'api' => 'QuerySkillGroups'],
+ ],
+ 'createdAt' => '2021-05-21T09:26:07.000Z',
+ 'description' => 'api支持部门维度',
],
[
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'ListRobotCallDialog'],
+ ['description' => '请求参数发生变更', 'api' => 'RobotCall'],
+ ],
+ 'createdAt' => '2021-05-20T06:41:39.000Z',
+ 'description' => '调整联络中心机器人 API',
],
[
- 'regionId' => 'cn-zhangjiakou-na62-a01',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'QueryTouchList'],
+ ],
+ 'createdAt' => '2021-05-14T11:28:04.000Z',
+ 'description' => '优化QueryTouchList字段类型',
],
[
- 'regionId' => 'cn-zhengzhou-nebula-1',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'QueryTouchList'],
+ ],
+ 'createdAt' => '2021-05-14T06:28:00.000Z',
+ 'description' => '此次发布优化了QueryTouchList的输出字段，对其调用方式并无影响。',
],
[
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'GetDepGroupTreeData'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetQualityProjectDetail'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetQualityProjectList'],
+ ],
+ 'createdAt' => '2021-05-13T16:13:19.000Z',
+ 'description' => 'dev',
],
[
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateAgent'],
+ ['description' => 'OpenAPI 下线', 'api' => 'DeleteAgent'],
+ ['description' => 'OpenAPI 下线', 'api' => 'FinishHotlineService'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GenerateWebSocketSign'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetAgent'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetHotlineAgentDetail'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetHotlineAgentStatus'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetOutbounNumList'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetRecordData'],
+ ['description' => 'OpenAPI 下线', 'api' => 'StartHotlineService'],
+ ],
+ 'createdAt' => '2021-05-12T03:56:02.000Z',
+ 'description' => '规范化响应参数',
],
[
- 'regionId' => 'eu-west-1-oxs',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'EncryptPhoneNum'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetHotlineMessageLog'],
+ ],
+ 'createdAt' => '2021-04-25T12:06:53.000Z',
+ 'description' => '加密 ',
],
[
- 'regionId' => 'me-east-1',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'GetQualityProjectList'],
+ ],
+ 'createdAt' => '2021-04-08T12:44:13.000Z',
+ 'description' => '质检SDK 升级',
],
[
- 'regionId' => 'rus-west-1-pop',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'GetHotlineRuntimeInfo'],
+ ],
+ 'createdAt' => '2021-04-08T02:37:06.000Z',
+ 'description' => '刷新恢复',
],
[
- 'regionId' => 'us-east-1',
- 'endpoint' => 'aiccs.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'GetAgentBasisStatus'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetAgentDetailReport'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetAgentServiceStatus'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetAgentStatistics'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetDepartmentalLatitudeAgentStatus'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetHotlineServiceStatistics'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetOnlineSeatInformation'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetOnlineServiceVolume'],
+ ['description' => 'OpenAPI 下线', 'api' => 'GetQueueInformation'],
+ ['description' => 'OpenAPI 下线', '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' => '智能联络中心',
+ 'ramCodes' => ['aiccs'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'GetCallSoundRecord',
+ 'description' => '获取通话录音文件',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:GetCallSoundRecord',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateTask',
+ 'description' => '创建任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aiccs:CreateTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StartTask',
+ 'description' => '启动任务',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aiccs:StartTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListRobotNode',
+ 'description' => '获取机器人节点信息列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListRobotNode',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryAiVoiceAgentDetailNew',
+ 'description' => '查询通信智能体详情（新模式）',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:QueryAiVoiceAgentDetailNew',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'LlmFullDuplexCallOperate',
+ 'description' => '全双工呼叫控制接口',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aiccs:LlmFullDuplexCallOperate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeRecordData',
+ 'description' => '获取通话记录',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:DescribeRecordData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PageQueryAgentList',
+ 'description' => '查询通信智能体列表',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aiccs:PageQueryAgentList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'HangupOperate',
+ 'description' => '通信智能引擎主动挂断通话',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aiccs:HangupOperate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'LlmSmartCallEncrypt',
+ 'description' => '大模型加密号智能外呼',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aiccs:LlmSmartCallEncrypt',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTask',
+ 'description' => '获取任务列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'LlmSmartCall',
+ 'description' => '大模型智能呼叫',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aiccs:LlmSmartCall',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAvailableTts',
+ 'description' => '获取大模型呼叫支持的TTS音色列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListAvailableTts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTaskDetail',
+ 'description' => '获取任务明细信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListTaskDetail',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateAiCallTask',
+ 'description' => '更新呼叫任务',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aiccs:UpdateAiCallTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ImportOneTaskPhoneNumber',
+ 'description' => '导入单个号码数据',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aiccs:',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAudioNoteUploadUrl',
+ 'description' => '获取语音小记OSS上传信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:GetAudioNoteUploadUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAgent',
+ 'description' => '创建坐席',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aiccs:CreateAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PageQueryAgentListNew',
+ 'description' => '分页查询智能体列表（新模式）',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:PageQueryAgentListNew',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AttachTask',
+ 'description' => '追加明细',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aiccs:AttachTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryConversationDetailInfoNew',
+ 'description' => '呼叫任务明细及通话详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListRobotCallDialog',
+ 'description' => '查询通话记录',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListRobotCallDialog',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListRobotParams',
+ 'description' => '查询机器人参数列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListRobotParams',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'StopTask',
+ 'description' => '暂停任务',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aiccs:StopTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryAiVoiceAgentDetail',
+ 'description' => '查询通信智能体详情信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:QueryAiVoiceAgentDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelAiCallDetails',
+ 'description' => '取消呼叫任务',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aiccs:CancelAiCallDetails',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAiccsRobot',
+ 'description' => '获取话术列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListAiccsRobot',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryAiCallDetailPage',
+ 'description' => '呼叫任务明细',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aiccs:QueryAiCallDetailPage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitAudioNote',
+ 'description' => '提交离线语音小记',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aiccs:SubmitAudioNote',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddLargeModel',
+ 'description' => '添加大模型网关',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aiccs:AddLargeModel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'LlmSmartCallFullDuplex',
+ 'description' => '全双工智能联络中心呼叫',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aiccs:LlmSmartCallFullDuplex',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateLargeModel',
+ 'description' => '更新大模型网关配置',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aiccs:UpdateLargeModel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryConversationDetailInfo',
+ 'description' => '呼叫通话详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:QueryConversationDetailInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDialog',
+ 'description' => '查询对话记录',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aiccs:ListDialog',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddModelApplication',
+ 'description' => '创建大模型应用',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aiccs:AddModelApplication',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelTask',
+ 'description' => '取消任务',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aiccs:CancelTask',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateModelApplication',
+ 'description' => '更新大模型应用配置',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aiccs:UpdateModelApplication',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'TestLargeModel',
+ 'description' => '网关大模型测试',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aiccs:TestLargeModel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCallDialogContent',
+ 'description' => '通过CallId查询近一个月通话已结束的通话对话内容',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aiccs:GetCallDialogContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAgent',
+ 'description' => '删除坐席',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aiccs:DeleteAgent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 22:38:57 +0000