From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/zh_cn/ccc/2017-07-05/api-docs.php | 18225 ++------- data/zh_cn/ccc/2020-05-27/api-docs.php | 61 +- data/zh_cn/ccc/2020-07-01/api-docs.php | 67723 ++++++++++--------------------- 3 files changed, 23904 insertions(+), 62105 deletions(-) (limited to 'data/zh_cn/ccc') diff --git a/data/zh_cn/ccc/2017-07-05/api-docs.php b/data/zh_cn/ccc/2017-07-05/api-docs.php index f87563b..ca8fb3e 100644 --- a/data/zh_cn/ccc/2017-07-05/api-docs.php +++ b/data/zh_cn/ccc/2017-07-05/api-docs.php @@ -1,247 +1,120 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'CCC', - 'version' => '2017-07-05', - ], + 'info' => ['style' => 'RPC', 'product' => 'CCC', 'version' => '2017-07-05'], 'directories' => [ [ 'id' => 58590, 'title' => '统计', 'type' => 'directory', - 'children' => [ - 'ListVoiceAppraise', - 'LaunchAppraise', - 'SaveWebRTCStats', - ], + 'children' => ['ListVoiceAppraise', 'LaunchAppraise', 'SaveWebRTCStats'], ], [ 'id' => 58594, 'title' => '联系流程', 'type' => 'directory', - 'children' => [ - 'CreateContactFlow', - 'ListContactFlows', - 'GetRoutePoint', - 'ListIvrTrackingDetail', - 'CommitContactFlowVersionModification', - 'PublishContactFlowVersion', - ], + 'children' => ['CreateContactFlow', 'ListContactFlows', 'GetRoutePoint', 'ListIvrTrackingDetail', 'CommitContactFlowVersionModification', 'PublishContactFlowVersion'], ], [ 'id' => 58601, 'title' => '录音', 'type' => 'directory', - 'children' => [ - 'GetRecordOssUploadParam', - 'ListRecordingOfDualTrack', - 'ListRecordingsByContactId', - 'DownloadAllTypeRecording', - 'DownloadRecording', - ], + 'children' => ['GetRecordOssUploadParam', 'ListRecordingOfDualTrack', 'ListRecordingsByContactId', 'DownloadAllTypeRecording', 'DownloadRecording'], ], [ 'id' => 58607, 'title' => '通话', 'type' => 'directory', - 'children' => [ - 'ModifyPrivacyNumberCallDetail', - 'StartBack2BackCall', - 'ListCallDetailRecords', - 'ListCallEventDetailByContactId', - 'ListRecentCallRecords', - 'GetConversationDetailByContactId', - 'DialEx', - 'CallOnlinePrivacyNumber', - ], + 'children' => ['ModifyPrivacyNumberCallDetail', 'StartBack2BackCall', 'ListCallDetailRecords', 'ListCallEventDetailByContactId', 'ListRecentCallRecords', 'GetConversationDetailByContactId', 'DialEx', 'CallOnlinePrivacyNumber'], ], [ 'id' => 58618, 'title' => '配置', 'type' => 'directory', - 'children' => [ - 'GetConfig', - 'ListConfig', - ], + 'children' => ['GetConfig', 'ListConfig'], ], [ 'id' => 58621, 'title' => '标签', 'type' => 'directory', - 'children' => [ - 'AddPhoneTags', - 'DeletePhoneTags', - 'ModifyPhoneTags', - 'ListPhoneTags', - ], + 'children' => ['AddPhoneTags', 'DeletePhoneTags', 'ModifyPhoneTags', 'ListPhoneTags'], ], [ 'id' => 58626, 'title' => '号码', 'type' => 'directory', - 'children' => [ - 'AddBulkPhoneNumbers', - 'AddPhoneNumber', - 'ModifyPhoneNumber', - 'GetNumberRegionInfo', - 'GetServiceExtensions', - 'ListPhoneNumbers', - 'CheckNumberAvaliable', - 'PickOutboundNumbers', - 'RemovePhoneNumber', - 'PickGlobalOutboundNumbers', - 'PickLocalNumber', - ], + 'children' => ['AddBulkPhoneNumbers', 'AddPhoneNumber', 'ModifyPhoneNumber', 'GetNumberRegionInfo', 'GetServiceExtensions', 'ListPhoneNumbers', 'CheckNumberAvaliable', 'PickOutboundNumbers', 'RemovePhoneNumber', 'PickGlobalOutboundNumbers', 'PickLocalNumber'], ], [ 'id' => 58638, 'title' => '实例', 'type' => 'directory', - 'children' => [ - 'CreateInstance', - 'CreateVoiceAppraise', - 'DeleteInstance', - 'GetInstance', - 'GetInstanceState', - 'ListInstancesOfUser', - ], + 'children' => ['CreateInstance', 'CreateVoiceAppraise', 'DeleteInstance', 'GetInstance', 'GetInstanceState', 'ListInstancesOfUser'], ], [ 'id' => 58649, 'title' => '供应商', 'type' => 'directory', - 'children' => [ - 'DisableTrunkProviders', - 'ListTrunkProviders', - ], + 'children' => ['DisableTrunkProviders', 'ListTrunkProviders'], ], [ 'id' => 58652, 'title' => '媒体', 'type' => 'directory', - 'children' => [ - 'CreateMedia', - 'DeleteMedia', - 'ListMedias', - ], + 'children' => ['CreateMedia', 'DeleteMedia', 'ListMedias'], ], [ 'id' => 58656, 'title' => 'TURN服务', 'type' => 'directory', - 'children' => [ - 'GetTURNCredentials', - 'GetTURNServerList', - ], + 'children' => ['GetTURNCredentials', 'GetTURNServerList'], ], [ 'id' => 58659, 'title' => '调查', 'type' => 'directory', - 'children' => [ - 'CreateFault', - ], + 'children' => ['CreateFault'], ], [ 'id' => 58667, 'title' => '报表', 'type' => 'directory', - 'children' => [ - 'ListCallMeasureSummaryReports', - 'GetCallMeasureSummaryReport', - 'GetInstanceSummaryReport', - 'GetInstanceSummaryReportByInterval', - 'GetInstanceSummaryReportSinceMidnight', - ], + 'children' => ['ListCallMeasureSummaryReports', 'GetCallMeasureSummaryReport', 'GetInstanceSummaryReport', 'GetInstanceSummaryReportByInterval', 'GetInstanceSummaryReportSinceMidnight'], ], [ 'id' => 58673, 'title' => '客服', 'type' => 'directory', - 'children' => [ - 'CreateUser', - 'GetUserByExtension', - 'AssignUsers', - 'ResetUserStatus', - ], + 'children' => ['CreateUser', 'GetUserByExtension', 'AssignUsers', 'ResetUserStatus'], ], [ 'id' => 58678, 'title' => '用户', 'type' => 'directory', - 'children' => [ - 'ModifyUser', - 'GetUser', - 'ListUsers', - 'ListRoles', - 'FindUsers', - 'RemoveUsers', - ], + 'children' => ['ModifyUser', 'GetUser', 'ListUsers', 'ListRoles', 'FindUsers', 'RemoveUsers'], ], [ 'id' => 58685, 'title' => '坐席', 'type' => 'directory', - 'children' => [ - 'AddAgentDevice', - 'ModifyAgentDevice', - 'ListRealTimeAgent', - 'ListAgentStateLogs', - 'ListAgentStates', - 'ListAgentSummaryReports', - 'ListAgentSummaryReportsByInterval', - 'ListAgentSummaryReportsSinceMidnight', - 'GetAgentData', - 'ListAgentDevices', - 'ListAgentEvents', - 'GenerateAgentStatisticReport', - 'RefreshToken', - 'RequestLoginInfo', - ], + 'children' => ['AddAgentDevice', 'ModifyAgentDevice', 'ListRealTimeAgent', 'ListAgentStateLogs', 'ListAgentStates', 'ListAgentSummaryReports', 'ListAgentSummaryReportsByInterval', 'ListAgentSummaryReportsSinceMidnight', 'GetAgentData', 'ListAgentDevices', 'ListAgentEvents', 'GenerateAgentStatisticReport', 'RefreshToken', 'RequestLoginInfo'], ], [ 'id' => 58700, 'title' => '短信', 'type' => 'directory', - 'children' => [ - 'GetSmsConfig', - 'LaunchShortMessageAppraise', - 'SendPredefinedShortMessage', - ], + 'children' => ['GetSmsConfig', 'LaunchShortMessageAppraise', 'SendPredefinedShortMessage'], ], [ 'id' => 58704, 'title' => '技能组', 'type' => 'directory', - 'children' => [ - 'CreateSkillGroup', - 'DeleteSkillGroup', - 'ModifyPrimaryTrunksOfSkillGroup', - 'ModifySkillGroup', - 'ModifySkillGroupOfUser', - 'ModifySkillGroupOutboundNumbers', - 'ListTrunksOfSkillGroup', - 'ListUsersOfSkillGroup', - 'ListSkillGroupStates', - 'ListSkillGroupSummaryReports', - 'ListSkillGroupSummaryReportsByInterval', - 'ListSkillGroupSummaryReportsSinceMidnight', - 'ListTransferableSkillGroups', - 'ListSkillGroups', - 'ListSkillGroupsOfUser', - 'RemoveUsersFromSkillGroup', - ], + 'children' => ['CreateSkillGroup', 'DeleteSkillGroup', 'ModifyPrimaryTrunksOfSkillGroup', 'ModifySkillGroup', 'ModifySkillGroupOfUser', 'ModifySkillGroupOutboundNumbers', 'ListTrunksOfSkillGroup', 'ListUsersOfSkillGroup', 'ListSkillGroupStates', 'ListSkillGroupSummaryReports', 'ListSkillGroupSummaryReportsByInterval', 'ListSkillGroupSummaryReportsSinceMidnight', 'ListTransferableSkillGroups', 'ListSkillGroups', 'ListSkillGroupsOfUser', 'RemoveUsersFromSkillGroup'], ], [ 'id' => 190044, 'title' => '其他', 'type' => 'directory', - 'children' => [ - 'ListOutboundPhoneNumberOfUser', - 'ListRecordings', - 'ModifySkillGroupBasicInfo', - ], + 'children' => ['ListOutboundPhoneNumberOfUser', 'ListRecordings', 'ModifySkillGroupBasicInfo'], ], ], 'components' => [ @@ -250,14 +123,8 @@ 'apis' => [ 'ListVoiceAppraise' => [ 'summary' => '调用ListVoiceAppraise获取实例的语音满意度。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -271,21 +138,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取电话号码的呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], + 'schema' => ['description' => '待获取电话号码的呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], ], ], 'responses' => [ @@ -293,73 +152,24 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '0FDB996E-9A04-461C-BE0E-A7F8597526AD', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Notice' => [ - 'description' => '创建默认满意度提示。'."\n" - ."\n" - .'若客户自己配置语音满意度有一定难度，可参考模板创建的语音满意度进行修改。', - 'type' => 'string', - 'example' => '无', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '0FDB996E-9A04-461C-BE0E-A7F8597526AD'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Notice' => ['description' => '创建默认满意度提示。'."\n" + ."\n" + .'若客户自己配置语音满意度有一定难度，可参考模板创建的语音满意度进行修改。', 'type' => 'string', 'example' => '无'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], 'ContactFlow' => [ 'description' => '返回的语音满意度的联系流,，包含最新版本信息。', 'type' => 'object', 'properties' => [ - 'ContactFlowDescription' => [ - 'description' => '联系流的简单描述。', - 'type' => 'string', - 'example' => 'SatisfactionSurvey', - ], - 'Type' => [ - 'description' => '流程类型。', - 'type' => 'string', - 'example' => 'Mainflow', - ], - 'ContactFlowName' => [ - 'description' => '联系流名称，在一个实例内名称不能重复。', - 'type' => 'string', - 'example' => 'SatisfactionSurvey', - ], - 'InstanceId' => [ - 'description' => '联系流所归属的呼叫中心实例。', - 'type' => 'string', - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], - 'ContactFlowId' => [ - 'description' => '联系流唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => 'XmRB_0mcsmkj', - ], - 'AppliedVersion' => [ - 'description' => '当前正在工作的版本。', - 'type' => 'string', - 'example' => '20190319160735', - ], + 'ContactFlowDescription' => ['description' => '联系流的简单描述。', 'type' => 'string', 'example' => 'SatisfactionSurvey'], + 'Type' => ['description' => '流程类型。', 'type' => 'string', 'example' => 'Mainflow'], + 'ContactFlowName' => ['description' => '联系流名称，在一个实例内名称不能重复。', 'type' => 'string', 'example' => 'SatisfactionSurvey'], + 'InstanceId' => ['description' => '联系流所归属的呼叫中心实例。', 'type' => 'string', 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], + 'ContactFlowId' => ['description' => '联系流唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => 'XmRB_0mcsmkj'], + 'AppliedVersion' => ['description' => '当前正在工作的版本。', 'type' => 'string', 'example' => '20190319160735'], 'Versions' => [ 'type' => 'object', 'itemNode' => true, @@ -370,41 +180,13 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '当前状态。', - 'type' => 'string', - 'example' => 'Published', - ], - 'LastModified' => [ - 'description' => '联系流版本的最后修改时间。', - 'type' => 'string', - 'example' => '2019-03-19 16:07:46', - ], - 'Version' => [ - 'description' => '联系流版本信息，一般以日期+时间来表示。', - 'type' => 'string', - 'example' => '20190319160735', - ], - 'ContactFlowVersionId' => [ - 'description' => '联系流版本ID，关联的联系流版本。', - 'type' => 'string', - 'example' => 'oEUk_1EAbkcn', - ], - 'ContactFlowVersionDescription' => [ - 'description' => '联系流版本的说明及注解。', - 'type' => 'string', - 'example' => 'SatisfactionSurvey-20180531144213', - ], - 'LastModifiedBy' => [ - 'description' => '联系流版本最后由何人修改。', - 'type' => 'string', - 'example' => 'cloudcallcenter', - ], - 'Content' => [ - 'description' => '符合ACC需求的流程文件内容。', - 'type' => 'string', - 'example' => '请见返回示例。', - ], + 'Status' => ['description' => '当前状态。', 'type' => 'string', 'example' => 'Published'], + 'LastModified' => ['description' => '联系流版本的最后修改时间。', 'type' => 'string', 'example' => '2019-03-19 16:07:46'], + 'Version' => ['description' => '联系流版本信息，一般以日期+时间来表示。', 'type' => 'string', 'example' => '20190319160735'], + 'ContactFlowVersionId' => ['description' => '联系流版本ID，关联的联系流版本。', 'type' => 'string', 'example' => 'oEUk_1EAbkcn'], + 'ContactFlowVersionDescription' => ['description' => '联系流版本的说明及注解。', 'type' => 'string', 'example' => 'SatisfactionSurvey-20180531144213'], + 'LastModifiedBy' => ['description' => '联系流版本最后由何人修改。', 'type' => 'string', 'example' => 'cloudcallcenter'], + 'Content' => ['description' => '符合ACC需求的流程文件内容。', 'type' => 'string', 'example' => '请见返回示例。'], ], ], ], @@ -420,38 +202,12 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Trunks' => [ - 'description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Number' => [ - 'description' => '电话号码。', - 'type' => 'string', - 'example' => '02160664656', - ], - 'RemainingTime' => [ - 'description' => '测试号码剩余的通话时间。单位为分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'InstanceId' => [ - 'description' => '电话号码所归属的呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], - 'PhoneNumberDescription' => [ - 'description' => '电话号码的简单描述。', - 'type' => 'string', - 'example' => 'Ali Telecom', - ], - 'PhoneNumberId' => [ - 'description' => '电话号码ID。', - 'type' => 'string', - 'example' => 'cc583e96-6bae-437e-9aeb-bffd5aeddb73', - ], + 'Trunks' => ['description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'Number' => ['description' => '电话号码。', 'type' => 'string', 'example' => '02160664656'], + 'RemainingTime' => ['description' => '测试号码剩余的通话时间。单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'InstanceId' => ['description' => '电话号码所归属的呼叫中心实例ID。', 'type' => 'string', 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], + 'PhoneNumberDescription' => ['description' => '电话号码的简单描述。', 'type' => 'string', 'example' => 'Ali Telecom'], + 'PhoneNumberId' => ['description' => '电话号码ID。', 'type' => 'string', 'example' => 'cc583e96-6bae-437e-9aeb-bffd5aeddb73'], ], ], ], @@ -472,14 +228,8 @@ ], 'LaunchAppraise' => [ 'summary' => '用来统计满意度发送率。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -494,34 +244,20 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - 'docRequired' => true, - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', 'docRequired' => true], ], [ 'name' => 'Acid', 'in' => 'query', - 'schema' => [ - 'description' => '通话话务ID。'."\n" - ."\n" - .'即contactId，软电话SDK的回调事件中会携带contactId。', - 'type' => 'string', - 'required' => true, - 'example' => '2021372960', - 'docRequired' => true, - ], + 'schema' => ['description' => '通话话务ID。'."\n" + ."\n" + .'即contactId，软电话SDK的回调事件中会携带contactId。', 'type' => 'string', 'required' => true, 'example' => '2021372960', 'docRequired' => true], ], ], 'responses' => [ @@ -529,32 +265,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '返回码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '错误信息', - 'type' => 'string', - 'example' => 'xxx', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '返回码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => 'xxx'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -569,14 +284,8 @@ ], 'SaveWebRTCStats' => [ 'summary' => '保存客服端WebRTC语音传输统计信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -591,111 +300,53 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取用户的呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9f46dde1-207a-46dd-926e-c0f39a124', - ], + 'schema' => ['description' => '待获取用户的呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9f46dde1-207a-46dd-926e-c0f39a124'], ], [ 'name' => 'RecordTime', 'in' => 'query', - 'schema' => [ - 'description' => '调用此API的时间（客户端电脑的时间）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '160765543836', - ], + 'schema' => ['description' => '调用此API的时间（客户端电脑的时间）', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '160765543836'], ], [ 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '294834804', - ], + 'schema' => ['description' => '通话ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '294834804'], ], [ 'name' => 'CallerNumber', 'in' => 'query', - 'schema' => [ - 'description' => '主叫号码', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '021607806', - ], + 'schema' => ['description' => '主叫号码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '021607806'], ], [ 'name' => 'CalleeNumber', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '131228450', - ], + 'schema' => ['description' => '被叫号码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '131228450'], ], [ 'name' => 'CallStartTime', 'in' => 'query', - 'schema' => [ - 'description' => '通话开始时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1607655438368', - ], + 'schema' => ['description' => '通话开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1607655438368'], ], [ 'name' => 'Stats', 'in' => 'query', - 'schema' => [ - 'description' => '从rtcPeerConnection.getStats(selector)中获取的语音传输统计信息（每隔3秒获取一次）', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[XXX]', - ], + 'schema' => ['description' => '从rtcPeerConnection.getStats(selector)中获取的语音传输统计信息（每隔3秒获取一次）', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[XXX]'], ], [ 'name' => 'Uid', 'in' => 'query', - 'schema' => [ - 'description' => '客服的RAM ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '247361754012232', - ], + 'schema' => ['description' => '客服的RAM ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '247361754012232'], ], [ 'name' => 'TenantId', 'in' => 'query', - 'schema' => [ - 'description' => '租户ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acc2626', - ], + 'schema' => ['description' => '租户ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acc2626'], ], ], 'responses' => [ @@ -703,38 +354,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RowCount' => [ - 'description' => '存入数据库后返回的行数，一般为1', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RowCount' => ['description' => '存入数据库后返回的行数，一般为1', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], ], @@ -748,13 +373,8 @@ ], 'CreateContactFlow' => [ 'summary' => '调用CreateContactFlow创建联系流。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -769,70 +389,38 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], + 'schema' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '联系流名称。', - 'type' => 'string', - 'required' => true, - 'example' => '测试流程', - ], + 'schema' => ['description' => '联系流名称。', 'type' => 'string', 'required' => true, 'example' => '测试流程'], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'required' => false, - 'example' => '测试', - ], + 'schema' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => '测试'], ], [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '流程类型。取值：Mainflow、Subflow、System、Reserved、Navigator。', - 'type' => 'string', - 'required' => true, - 'example' => 'Mainflow', - ], + 'schema' => ['description' => '流程类型。取值：Mainflow、Subflow、System、Reserved、Navigator。', 'type' => 'string', 'required' => true, 'example' => 'Mainflow'], ], [ 'name' => 'Canvas', 'in' => 'formData', - 'schema' => [ - 'description' => '画布信息。', - 'type' => 'string', - 'required' => true, - 'example' => '{"lineList":[{"relatedModules":{"begin":1,"end":7},"offsetEndPonit":{"offsetX":12.150491568948121,"offsetY":-4.3527514192484915}},{"relatedModules":{"begin":7,"end":999},"offsetEndPonit":{"offsetX":11.620147014773558,"offsetY":1.633680331939992}}]}', - ], + 'schema' => ['description' => '画布信息。', 'type' => 'string', 'required' => true, 'example' => '{"lineList":[{"relatedModules":{"begin":1,"end":7},"offsetEndPonit":{"offsetX":12.150491568948121,"offsetY":-4.3527514192484915}},{"relatedModules":{"begin":7,"end":999},"offsetEndPonit":{"offsetX":11.620147014773558,"offsetY":1.633680331939992}}]}'], ], [ 'name' => 'Content', 'in' => 'formData', - 'schema' => [ - 'description' => '结点信息。', - 'type' => 'string', - 'required' => true, - 'example' => '[{"nodeType":"start","nodeDescript":"开始","variables":[{"varDescript":"隐藏参数，用于保存分支模块收号内容","varInitial":"","varName":"_press_key","varType":"string"},{"varDescript":"隐藏参数，智能导航中给出\\"转人工队列\\"的动作指令时，附带的参数","varInitial":"","varName":"_vn_control_queueName","varType":"string"}]}]', - ], + 'schema' => ['description' => '结点信息。', 'type' => 'string', 'required' => true, 'example' => '[{"nodeType":"start","nodeDescript":"开始","variables":[{"varDescript":"隐藏参数，用于保存分支模块收号内容","varInitial":"","varName":"_press_key","varType":"string"},{"varDescript":"隐藏参数，智能导航中给出\\"转人工队列\\"的动作指令时，附带的参数","varInitial":"","varName":"_vn_control_queueName","varType":"string"}]}]'], ], ], 'responses' => [ @@ -840,66 +428,21 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], 'ContactFlow' => [ 'description' => '联系流对象。', 'type' => 'object', 'properties' => [ - 'ContactFlowDescription' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'example' => '测试', - ], - 'Type' => [ - 'description' => '流程类型。', - 'type' => 'string', - 'example' => 'Mainflow', - ], - 'ContactFlowName' => [ - 'description' => '联系流名称。', - 'type' => 'string', - 'example' => '测试流程', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], - 'ContactFlowId' => [ - 'description' => '联系流ID。', - 'type' => 'string', - 'example' => 'nk90_9MIXqop', - ], - 'AppliedVersion' => [ - 'description' => '已发布的版本号。', - 'type' => 'string', - 'example' => '27904327097583', - ], + 'ContactFlowDescription' => ['description' => '描述信息。', 'type' => 'string', 'example' => '测试'], + 'Type' => ['description' => '流程类型。', 'type' => 'string', 'example' => 'Mainflow'], + 'ContactFlowName' => ['description' => '联系流名称。', 'type' => 'string', 'example' => '测试流程'], + 'InstanceId' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], + 'ContactFlowId' => ['description' => '联系流ID。', 'type' => 'string', 'example' => 'nk90_9MIXqop'], + 'AppliedVersion' => ['description' => '已发布的版本号。', 'type' => 'string', 'example' => '27904327097583'], 'Versions' => [ 'type' => 'object', 'itemNode' => true, @@ -910,51 +453,15 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '联系流当前状态。', - 'type' => 'string', - 'example' => 'Draft', - ], - 'LastModified' => [ - 'description' => '最近修改时间。', - 'type' => 'string', - 'example' => '2020-12-16 09:40:41', - ], - 'Canvas' => [ - 'description' => '画布信息。', - 'type' => 'string', - 'example' => '无', - ], - 'LockedBy' => [ - 'description' => '此版本的锁定者。', - 'type' => 'string', - 'example' => 'cctest', - ], - 'Version' => [ - 'description' => '联系流版本号。', - 'type' => 'string', - 'example' => '20201216094041', - ], - 'ContactFlowVersionId' => [ - 'description' => '版本ID。', - 'type' => 'string', - 'example' => 'fLXS_2CJPxot', - ], - 'LastModifiedBy' => [ - 'description' => '最近修改者。', - 'type' => 'string', - 'example' => '239999345126843208', - ], - 'ContactFlowVersionDescription' => [ - 'description' => '版本描述。', - 'type' => 'string', - 'example' => '无', - ], - 'Content' => [ - 'description' => '结点信息。', - 'type' => 'string', - 'example' => '无', - ], + 'Status' => ['description' => '联系流当前状态。', 'type' => 'string', 'example' => 'Draft'], + 'LastModified' => ['description' => '最近修改时间。', 'type' => 'string', 'example' => '2020-12-16 09:40:41'], + 'Canvas' => ['description' => '画布信息。', 'type' => 'string', 'example' => '无'], + 'LockedBy' => ['description' => '此版本的锁定者。', 'type' => 'string', 'example' => 'cctest'], + 'Version' => ['description' => '联系流版本号。', 'type' => 'string', 'example' => '20201216094041'], + 'ContactFlowVersionId' => ['description' => '版本ID。', 'type' => 'string', 'example' => 'fLXS_2CJPxot'], + 'LastModifiedBy' => ['description' => '最近修改者。', 'type' => 'string', 'example' => '239999345126843208'], + 'ContactFlowVersionDescription' => ['description' => '版本描述。', 'type' => 'string', 'example' => '无'], + 'Content' => ['description' => '结点信息。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -970,53 +477,15 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'TestOnly' => [ - 'description' => '是否用于测试。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Trunks' => [ - 'description' => '中继。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RemainingTime' => [ - 'description' => '可用时间，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2592000', - ], - 'Number' => [ - 'description' => '号码。', - 'type' => 'string', - 'example' => '6680XXXX083', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], - 'Usage' => [ - 'description' => '用途。', - 'type' => 'string', - 'example' => 'Inbound', - ], - 'AllowOutbound' => [ - 'description' => '是否可以外呼。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PhoneNumberDescription' => [ - 'description' => '号码描述。', - 'type' => 'string', - 'example' => '测试', - ], - 'PhoneNumberId' => [ - 'description' => '号码ID。', - 'type' => 'string', - 'example' => 'kq82ix9f-izbe-7813-a171-334uy290ck3w', - ], + 'TestOnly' => ['description' => '是否用于测试。', 'type' => 'boolean', 'example' => 'true'], + 'Trunks' => ['description' => '中继。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RemainingTime' => ['description' => '可用时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '2592000'], + 'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '6680XXXX083'], + 'InstanceId' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], + 'Usage' => ['description' => '用途。', 'type' => 'string', 'example' => 'Inbound'], + 'AllowOutbound' => ['description' => '是否可以外呼。', 'type' => 'boolean', 'example' => 'true'], + 'PhoneNumberDescription' => ['description' => '号码描述。', 'type' => 'string', 'example' => '测试'], + 'PhoneNumberId' => ['description' => '号码ID。', 'type' => 'string', 'example' => 'kq82ix9f-izbe-7813-a171-334uy290ck3w'], ], ], ], @@ -1037,14 +506,8 @@ ], 'ListContactFlows' => [ 'summary' => '调用ListContactFlows获取呼叫中心实例中的IVR流程列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1058,20 +521,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], ], 'responses' => [ @@ -1079,32 +535,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'F7505505-D727-46E2-9B66-47C5CEBDFCE1', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'F7505505-D727-46E2-9B66-47C5CEBDFCE1'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'ContactFlows' => [ 'type' => 'object', 'itemNode' => true, @@ -1115,36 +550,12 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'ContactFlowDescription' => [ - 'description' => '联系流的简单描述。', - 'type' => 'string', - 'example' => 'Welcome', - ], - 'Type' => [ - 'description' => '流程类型, 定义来自于ContactFlowType。', - 'type' => 'string', - 'example' => 'Mainflow', - ], - 'ContactFlowName' => [ - 'description' => '联系流名称，在一个实例内名称不能重复。', - 'type' => 'string', - 'example' => 'Welcome', - ], - 'InstanceId' => [ - 'description' => '联系流所归属的呼叫中心实例。', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], - 'ContactFlowId' => [ - 'description' => '联系流唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => 'dDMD_0mif4hv', - ], - 'AppliedVersion' => [ - 'description' => '当前正在工作的版本。', - 'type' => 'string', - 'example' => '20180704215641', - ], + 'ContactFlowDescription' => ['description' => '联系流的简单描述。', 'type' => 'string', 'example' => 'Welcome'], + 'Type' => ['description' => '流程类型, 定义来自于ContactFlowType。', 'type' => 'string', 'example' => 'Mainflow'], + 'ContactFlowName' => ['description' => '联系流名称，在一个实例内名称不能重复。', 'type' => 'string', 'example' => 'Welcome'], + 'InstanceId' => ['description' => '联系流所归属的呼叫中心实例。', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], + 'ContactFlowId' => ['description' => '联系流唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => 'dDMD_0mif4hv'], + 'AppliedVersion' => ['description' => '当前正在工作的版本。', 'type' => 'string', 'example' => '20180704215641'], 'Versions' => [ 'type' => 'object', 'itemNode' => true, @@ -1155,43 +566,15 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '当前状态。', - 'type' => 'string', - 'example' => 'Published', - ], - 'LastModified' => [ - 'description' => '联系流版本的最后修改时间。the number of milliseconds since January 1, 1970, 00:00:00 GMT', - 'type' => 'string', - 'example' => '2018-07-04 22:00:55', - ], - 'LockedBy' => [ - 'description' => '联系流版本被何人锁定。'."\n" - ."\n" - .'在开始编辑前必须先将此版本锁定，编辑完成后解锁，这样可以避免多人同时修改一个版本而导致的冲突。在锁定的情况下，只有锁定人才能对其进行操作，其他人无权操作。无人锁定时该属性的值为NULL。', - 'type' => 'string', - 'example' => 'null', - ], - 'Version' => [ - 'description' => '联系流版本信息，一般以日期+时间来表示。', - 'type' => 'string', - 'example' => '20180704215641', - ], - 'ContactFlowVersionId' => [ - 'description' => '联系流版本ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => 'tOMP_0prS2A1', - ], - 'ContactFlowVersionDescription' => [ - 'description' => '联系流版本的说明及注解。', - 'type' => 'string', - 'example' => 'Welcome-20180601142524', - ], - 'LastModifiedBy' => [ - 'description' => '联系流版本最后由何人修改。', - 'type' => 'string', - 'example' => 'cloudcallcenter', - ], + 'Status' => ['description' => '当前状态。', 'type' => 'string', 'example' => 'Published'], + 'LastModified' => ['description' => '联系流版本的最后修改时间。the number of milliseconds since January 1, 1970, 00:00:00 GMT', 'type' => 'string', 'example' => '2018-07-04 22:00:55'], + 'LockedBy' => ['description' => '联系流版本被何人锁定。'."\n" + ."\n" + .'在开始编辑前必须先将此版本锁定，编辑完成后解锁，这样可以避免多人同时修改一个版本而导致的冲突。在锁定的情况下，只有锁定人才能对其进行操作，其他人无权操作。无人锁定时该属性的值为NULL。', 'type' => 'string', 'example' => 'null'], + 'Version' => ['description' => '联系流版本信息，一般以日期+时间来表示。', 'type' => 'string', 'example' => '20180704215641'], + 'ContactFlowVersionId' => ['description' => '联系流版本ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => 'tOMP_0prS2A1'], + 'ContactFlowVersionDescription' => ['description' => '联系流版本的说明及注解。', 'type' => 'string', 'example' => 'Welcome-20180601142524'], + 'LastModifiedBy' => ['description' => '联系流版本最后由何人修改。', 'type' => 'string', 'example' => 'cloudcallcenter'], ], ], ], @@ -1207,65 +590,27 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'TestOnly' => [ - 'description' => '是否是测试号码。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Trunks' => [ - 'description' => '电话号码的中继数量。即可同时支持几路通话，数据来源于大于。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'RemainingTime' => [ - 'description' => '测试号码剩余的通话时间。单位为分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'Number' => [ - 'description' => '电话号码。', - 'type' => 'string', - 'example' => '178888888888', - ], - 'InstanceId' => [ - 'description' => '电话号码所归属的呼叫中心实例ID。', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], - 'Usage' => [ - 'description' => '电话号码的用途。取值：呼入（**Inbound**），呼出（**Outbound**），以及同时用于呼入和呼出（**Bidirection**）。上述值由枚举类型PhoneNumberType定义。'."\n" - ."\n" - .'该值的结果取决于：'."\n" - ."\n" - .'1. 大于的设置，比如400号码不允许外呼'."\n" - .'2. 呼叫中心实例的设置'."\n" - ."\n" - .'> 电话号码一般都允许内呼，如果不允许内呼，可以由大于做设置，用户拨打该号码时听到提示音；该号码不连接人和联系流IVR，但是ACC不建议这么做。', - 'type' => 'string', - 'example' => 'Bidirection', - ], - 'AllowOutbound' => [ - 'description' => '是否允许外呼。结果取决于：'."\n" - ."\n" - .'1. 大于的设置，比如400号码不允许外呼 '."\n" - .'2. 呼叫中心实例的设置'."\n" - ."\n" - .'> 电话号码一般都允许内呼，如果不允许内呼，可以由大于做设置，用户拨打该号码时听到提示音；该号码不绑定联系流IVR，但是ACC不建议这么做。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PhoneNumberDescription' => [ - 'description' => '电话号码的简单描述。', - 'type' => 'string', - 'example' => 'xxx', - ], - 'PhoneNumberId' => [ - 'description' => '电话号码ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => 'xxx', - ], + 'TestOnly' => ['description' => '是否是测试号码。', 'type' => 'boolean', 'example' => 'true'], + 'Trunks' => ['description' => '电话号码的中继数量。即可同时支持几路通话，数据来源于大于。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'RemainingTime' => ['description' => '测试号码剩余的通话时间。单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'Number' => ['description' => '电话号码。', 'type' => 'string', 'example' => '178888888888'], + 'InstanceId' => ['description' => '电话号码所归属的呼叫中心实例ID。', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], + 'Usage' => ['description' => '电话号码的用途。取值：呼入（**Inbound**），呼出（**Outbound**），以及同时用于呼入和呼出（**Bidirection**）。上述值由枚举类型PhoneNumberType定义。'."\n" + ."\n" + .'该值的结果取决于：'."\n" + ."\n" + .'1. 大于的设置，比如400号码不允许外呼'."\n" + .'2. 呼叫中心实例的设置'."\n" + ."\n" + .'> 电话号码一般都允许内呼，如果不允许内呼，可以由大于做设置，用户拨打该号码时听到提示音；该号码不连接人和联系流IVR，但是ACC不建议这么做。', 'type' => 'string', 'example' => 'Bidirection'], + 'AllowOutbound' => ['description' => '是否允许外呼。结果取决于：'."\n" + ."\n" + .'1. 大于的设置，比如400号码不允许外呼 '."\n" + .'2. 呼叫中心实例的设置'."\n" + ."\n" + .'> 电话号码一般都允许内呼，如果不允许内呼，可以由大于做设置，用户拨打该号码时听到提示音；该号码不绑定联系流IVR，但是ACC不建议这么做。', 'type' => 'boolean', 'example' => 'true'], + 'PhoneNumberDescription' => ['description' => '电话号码的简单描述。', 'type' => 'string', 'example' => 'xxx'], + 'PhoneNumberId' => ['description' => '电话号码ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => 'xxx'], ], ], ], @@ -1289,14 +634,8 @@ ], 'GetRoutePoint' => [ 'summary' => '调用GetRoutePoint获取联系流的路由点。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1310,32 +649,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '云呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '云呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'ContactFlowId', 'in' => 'query', - 'schema' => [ - 'description' => '联系流ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dDMD_0mif4hv', - ], + 'schema' => ['description' => '联系流ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dDMD_0mif4hv'], ], ], 'responses' => [ @@ -1343,37 +668,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => '响应状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RoutePoint' => [ - 'description' => '路由点', - 'type' => 'string', - 'example' => '80206198', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'F81866AD-A125-4D9A-A942-1CD6FBA9E9F5', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], + 'HttpStatusCode' => ['description' => '响应状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RoutePoint' => ['description' => '路由点', 'type' => 'string', 'example' => '80206198'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'F81866AD-A125-4D9A-A942-1CD6FBA9E9F5'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], ], ], ], @@ -1386,14 +686,8 @@ ], 'ListIvrTrackingDetail' => [ 'summary' => '获取IVR轨迹,默认查询半个小时之内的数据。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1408,97 +702,48 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '317a38bf-4883-4e00-b65d-761f4a8b****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '317a38bf-4883-4e00-b65d-761f4a8b****'], ], [ 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '话务ID', - 'type' => 'string', - 'required' => false, - 'example' => '3433583180', - ], + 'schema' => ['description' => '话务ID', 'type' => 'string', 'required' => false, 'example' => '3433583180'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1541732850000', - ], + 'schema' => ['description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1541732850000'], ], [ 'name' => 'StopTime', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1541932850000', - ], + 'schema' => ['description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1541932850000'], ], [ 'name' => 'CallingNumber', 'in' => 'query', - 'schema' => [ - 'description' => '主叫号码', - 'type' => 'string', - 'required' => false, - 'example' => '1760031****', - ], + 'schema' => ['description' => '主叫号码', 'type' => 'string', 'required' => false, 'example' => '1760031****'], ], [ 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'required' => false, - 'example' => '05712688****', - ], + 'schema' => ['description' => '被叫号码', 'type' => 'string', 'required' => false, 'example' => '05712688****'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页页码', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '20'], ], ], 'responses' => [ @@ -1506,54 +751,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '2a644ab1-7db5-413c-a744-299247f6537e', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '2a644ab1-7db5-413c-a744-299247f6537e'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'IvrTrackingDetails' => [ 'description' => '获取的IVR轨迹', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '当前页码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '对象总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], + 'PageNumber' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '对象总数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -1564,78 +773,20 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '状态', - 'type' => 'string', - 'example' => '_tts_success', - ], - 'DeviceID' => [ - 'description' => 'IP地址', - 'type' => 'string', - 'example' => 'null', - ], - 'InputData' => [ - 'description' => '传入参数', - 'type' => 'string', - 'example' => 'nui-I1gxblYz_1_1200_当前时间是11:07:39', - ], - 'FlowName' => [ - 'description' => 'IVR名称', - 'type' => 'string', - 'example' => 'flow/acc2626/xxxx', - ], - 'CalledNumber' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'example' => '05712688****', - ], - 'StopTime' => [ - 'description' => '结束时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1541932850000', - ], - 'StartTime' => [ - 'description' => '开始时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1541732850000', - ], - 'NodeType' => [ - 'description' => '节点类型(nodeType)包含: answer(开始) 、waitevent(等待)、getAssociateData(获取随路数据)、 kvget(解析随路数据)、getdigits(获取收号信息)、assign(输出) 、play(放音)、tts(tts放音) 、branching(分支)、branchitem(分支项) 、requestagent(转人工)、onesteptransfer(转外线) 、http(函数)、subflow(子流程)、exit(退出子流程)、hangup（结束）。', - 'type' => 'string', - 'example' => 'waitevent', - ], - 'Description' => [ - 'description' => '描述信息', - 'type' => 'string', - 'example' => 'answer', - ], - 'NodeName' => [ - 'description' => '节点名称', - 'type' => 'string', - 'example' => 'node24000', - ], - 'ContactId' => [ - 'description' => '通话ID', - 'type' => 'string', - 'example' => '3433583180', - ], - 'CallingNumber' => [ - 'description' => '主叫号码', - 'type' => 'string', - 'example' => '1760031****', - ], - 'OutputData' => [ - 'description' => '传出参数', - 'type' => 'string', - 'example' => '8020****', - ], - 'TenantId' => [ - 'description' => '租户ID', - 'type' => 'string', - 'example' => 'acc2626', - ], + 'Status' => ['description' => '状态', 'type' => 'string', 'example' => '_tts_success'], + 'DeviceID' => ['description' => 'IP地址', 'type' => 'string', 'example' => 'null'], + 'InputData' => ['description' => '传入参数', 'type' => 'string', 'example' => 'nui-I1gxblYz_1_1200_当前时间是11:07:39'], + 'FlowName' => ['description' => 'IVR名称', 'type' => 'string', 'example' => 'flow/acc2626/xxxx'], + 'CalledNumber' => ['description' => '被叫号码', 'type' => 'string', 'example' => '05712688****'], + 'StopTime' => ['description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1541932850000'], + 'StartTime' => ['description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1541732850000'], + 'NodeType' => ['description' => '节点类型(nodeType)包含: answer(开始) 、waitevent(等待)、getAssociateData(获取随路数据)、 kvget(解析随路数据)、getdigits(获取收号信息)、assign(输出) 、play(放音)、tts(tts放音) 、branching(分支)、branchitem(分支项) 、requestagent(转人工)、onesteptransfer(转外线) 、http(函数)、subflow(子流程)、exit(退出子流程)、hangup（结束）。', 'type' => 'string', 'example' => 'waitevent'], + 'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => 'answer'], + 'NodeName' => ['description' => '节点名称', 'type' => 'string', 'example' => 'node24000'], + 'ContactId' => ['description' => '通话ID', 'type' => 'string', 'example' => '3433583180'], + 'CallingNumber' => ['description' => '主叫号码', 'type' => 'string', 'example' => '1760031****'], + 'OutputData' => ['description' => '传出参数', 'type' => 'string', 'example' => '8020****'], + 'TenantId' => ['description' => '租户ID', 'type' => 'string', 'example' => 'acc2626'], ], ], ], @@ -1656,13 +807,8 @@ ], 'CommitContactFlowVersionModification' => [ 'summary' => '提交对联系流版本的改动。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1677,50 +823,28 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], + 'schema' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], ], [ 'name' => 'ContactFlowVersionId', 'in' => 'query', - 'schema' => [ - 'description' => '版本ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'fLXS_2CJPxot', - ], + 'schema' => ['description' => '版本ID。', 'type' => 'string', 'required' => true, 'example' => 'fLXS_2CJPxot'], ], [ 'name' => 'Canvas', 'in' => 'formData', - 'schema' => [ - 'description' => '画布信息。', - 'type' => 'string', - 'required' => true, - 'example' => '无', - ], + 'schema' => ['description' => '画布信息。', 'type' => 'string', 'required' => true, 'example' => '无'], ], [ 'name' => 'Content', 'in' => 'formData', - 'schema' => [ - 'description' => 'IVR内容。', - 'type' => 'string', - 'required' => true, - 'example' => '无', - ], + 'schema' => ['description' => 'IVR内容。', 'type' => 'string', 'required' => true, 'example' => '无'], ], ], 'responses' => [ @@ -1728,81 +852,24 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], 'ContactFlowVersion' => [ 'description' => '联系流版本对象。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '联系流当前状态。', - 'type' => 'string', - 'example' => 'Updated', - ], - 'LastModified' => [ - 'description' => '最近修改时间。', - 'type' => 'string', - 'example' => '2020-11-14 17:48:21', - ], - 'Canvas' => [ - 'description' => '画布信息。', - 'type' => 'string', - 'example' => '无', - ], - 'LockedBy' => [ - 'description' => '此版本的锁定者。', - 'type' => 'string', - 'example' => 'cctest', - ], - 'Version' => [ - 'description' => '联系流版本号。', - 'type' => 'string', - 'example' => '20201114174750', - ], - 'ContactFlowVersionId' => [ - 'description' => '版本ID。', - 'type' => 'string', - 'example' => 'fLXS_2CJPxot', - ], - 'LastModifiedBy' => [ - 'description' => '最近修改人。', - 'type' => 'string', - 'example' => 'cctest', - ], - 'ContactFlowVersionDescription' => [ - 'description' => '版本描述。', - 'type' => 'string', - 'example' => 'commitTest-20201114174750', - ], - 'Content' => [ - 'description' => 'IVR内容。', - 'type' => 'string', - 'example' => '无', - ], + 'Status' => ['description' => '联系流当前状态。', 'type' => 'string', 'example' => 'Updated'], + 'LastModified' => ['description' => '最近修改时间。', 'type' => 'string', 'example' => '2020-11-14 17:48:21'], + 'Canvas' => ['description' => '画布信息。', 'type' => 'string', 'example' => '无'], + 'LockedBy' => ['description' => '此版本的锁定者。', 'type' => 'string', 'example' => 'cctest'], + 'Version' => ['description' => '联系流版本号。', 'type' => 'string', 'example' => '20201114174750'], + 'ContactFlowVersionId' => ['description' => '版本ID。', 'type' => 'string', 'example' => 'fLXS_2CJPxot'], + 'LastModifiedBy' => ['description' => '最近修改人。', 'type' => 'string', 'example' => 'cctest'], + 'ContactFlowVersionDescription' => ['description' => '版本描述。', 'type' => 'string', 'example' => 'commitTest-20201114174750'], + 'Content' => ['description' => 'IVR内容。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -1818,14 +885,8 @@ ], 'PublishContactFlowVersion' => [ 'summary' => '调用PublishContactFlowVersion发布IVR流程。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1840,42 +901,23 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'ContactFlowVersionId', 'in' => 'query', - 'schema' => [ - 'description' => '待发布的流程的版本ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2NWG_1Cl7uWu', - ], + 'schema' => ['description' => '待发布的流程的版本ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2NWG_1Cl7uWu'], ], [ 'name' => 'UseTianGong', 'in' => 'query', - 'schema' => [ - 'description' => '是否使用天宫进行发布。调用请传入true。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '是否使用天宫进行发布。调用请传入true。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -1883,32 +925,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -1920,14 +941,8 @@ ], 'GetRecordOssUploadParam' => [ 'summary' => '调用GetRecordOssUploadParam获取录音上传参数。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1941,32 +956,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => '录音文件名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '155887678809600080315543.wav', - ], + 'schema' => ['description' => '录音文件名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '155887678809600080315543.wav'], ], ], 'responses' => [ @@ -1974,67 +975,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'OssAccessKeyId' => [ - 'description' => 'OSS的AK', - 'type' => 'string', - 'example' => 'LTAIvKWEr4Doxxxx', - ], - 'Host' => [ - 'description' => '上传地址', - 'type' => 'string', - 'example' => 'https://cloudcallcenter-online.oss-cn-shanghai.aliyuncs.com', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'OssFileName' => [ - 'description' => '录音文件名', - 'type' => 'string', - 'example' => 'gvDE-1KxEtOj_1059803544828509_20190530143725.wav', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Signature' => [ - 'description' => '签名', - 'type' => 'string', - 'example' => 'KUwzPbvaHaljLOdrKyrYE+S2gWs=', - ], - 'Expires' => [ - 'description' => '过期时间', - 'type' => 'string', - 'example' => '1559201845', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522', - ], - 'Policy' => [ - 'description' => '策略', - 'type' => 'string', - 'example' => 'eyJleHBpcmF0aW9uIjoiMjAxOS0wNS0zMFQwNzozNzoyNS42NDRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJyZWNvcmQvZDI3ODYyOWMtYzY4Ny00YWEzLWIwNDQtNGZ', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Dir' => [ - 'description' => '路径', - 'type' => 'string', - 'example' => 'record/d278629c-c687-4aa3-b044-4fe9b012e7ef/1059803544828509', - ], + 'OssAccessKeyId' => ['description' => 'OSS的AK', 'type' => 'string', 'example' => 'LTAIvKWEr4Doxxxx'], + 'Host' => ['description' => '上传地址', 'type' => 'string', 'example' => 'https://cloudcallcenter-online.oss-cn-shanghai.aliyuncs.com'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'OssFileName' => ['description' => '录音文件名', 'type' => 'string', 'example' => 'gvDE-1KxEtOj_1059803544828509_20190530143725.wav'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Signature' => ['description' => '签名', 'type' => 'string', 'example' => 'KUwzPbvaHaljLOdrKyrYE+S2gWs='], + 'Expires' => ['description' => '过期时间', 'type' => 'string', 'example' => '1559201845'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522'], + 'Policy' => ['description' => '策略', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAxOS0wNS0zMFQwNzozNzoyNS42NDRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJyZWNvcmQvZDI3ODYyOWMtYzY4Ny00YWEzLWIwNDQtNGZ'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Dir' => ['description' => '路径', 'type' => 'string', 'example' => 'record/d278629c-c687-4aa3-b044-4fe9b012e7ef/1059803544828509'], ], ], ], @@ -2045,14 +997,8 @@ ], 'ListRecordingOfDualTrack' => [ 'summary' => '调用ListRecordingOfDualTrack根据通话记录获取通话的双轨录音。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2066,113 +1012,57 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012****'], ], [ 'name' => 'ConnectId', 'in' => 'query', - 'schema' => [ - 'description' => '话务ID', - 'type' => 'string', - 'required' => false, - 'example' => '1300017658', - ], + 'schema' => ['description' => '话务ID', 'type' => 'string', 'required' => false, 'example' => '1300017658'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的开始时间。'."\n" - ."\n" - .'缺省为0，代表早于目前的时间半个小时开始。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1542967200000', - ], + 'schema' => ['description' => '获取的历史数据的开始时间。'."\n" + ."\n" + .'缺省为0，代表早于目前的时间半个小时开始。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1542967200000'], ], [ 'name' => 'StopTime', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的终止时间。'."\n" - ."\n" - .'缺省为0，代表截止到目前的时间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1542997200000', - ], + 'schema' => ['description' => '获取的历史数据的终止时间。'."\n" + ."\n" + .'缺省为0，代表截止到目前的时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1542997200000'], ], [ 'name' => 'CallingNumber', 'in' => 'query', - 'schema' => [ - 'description' => '主叫号码', - 'type' => 'string', - 'required' => false, - 'example' => '0255237****', - ], + 'schema' => ['description' => '主叫号码', 'type' => 'string', 'required' => false, 'example' => '0255237****'], ], [ 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'required' => false, - 'example' => '1573203****', - ], + 'schema' => ['description' => '被叫号码', 'type' => 'string', 'required' => false, 'example' => '1573203****'], ], [ 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID', - 'type' => 'string', - 'required' => false, - 'example' => '101820677302****', - ], + 'schema' => ['description' => '坐席ID', 'type' => 'string', 'required' => false, 'example' => '101820677302****'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '20'], ], ], 'responses' => [ @@ -2180,54 +1070,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'D8135D21-1553-4B18-A876-427D74543841', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D8135D21-1553-4B18-A876-427D74543841'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Recordings' => [ 'description' => '获取到的录音详单', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => '对象总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'TotalCount' => ['description' => '对象总数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -2238,77 +1092,23 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'ContactType' => [ - 'description' => '通话类型。'."\n" - ."\n" - .'参考枚举类型：Inbound(0) 内呼, Outbound(1) 外呼, Internal(2) 内部通话。', - 'type' => 'string', - 'example' => 'Outbound', - ], - 'AgentId' => [ - 'description' => '座席ID。'."\n" - ."\n" - .'坐席ID等同于该座席的RAM子账户ID。', - 'type' => 'string', - 'example' => '101820677302****', - ], - 'AgentName' => [ - 'description' => '座席名称', - 'type' => 'string', - 'example' => '测试', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => 'd278629c-c687-4aa3-b044-4fe9b01****', - ], - 'FileName' => [ - 'description' => '录音文件名', - 'type' => 'string', - 'example' => '4219097556-10-20-49.mkv', - ], - 'CalledNumber' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'example' => '1573203****', - ], - 'StartTime' => [ - 'description' => '电话开始时间，内呼从进入IVR开始，外呼从开始接通计算。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1542968440000', - ], - 'FilePath' => [ - 'description' => '录音文件在OSS中的保存位置', - 'type' => 'string', - 'example' => 'http://xxx', - ], - 'ContactId' => [ - 'description' => '话务ID，全局唯一，对应于ACC的ACID。', - 'type' => 'string', - 'example' => '1300017658', - ], - 'CallingNumber' => [ - 'description' => '主叫号码', - 'type' => 'string', - 'example' => '0255237****', - ], - 'Duration' => [ - 'description' => '通话持续时间，单位为秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '120', - ], - 'FileDescription' => [ - 'description' => '录音文件别名', - 'type' => 'string', - 'example' => 'xxx', - ], - 'Channel' => [ - 'description' => '座席所在音轨标示', - 'type' => 'string', - 'example' => 'xxx', - ], + 'ContactType' => ['description' => '通话类型。'."\n" + ."\n" + .'参考枚举类型：Inbound(0) 内呼, Outbound(1) 外呼, Internal(2) 内部通话。', 'type' => 'string', 'example' => 'Outbound'], + 'AgentId' => ['description' => '座席ID。'."\n" + ."\n" + .'坐席ID等同于该座席的RAM子账户ID。', 'type' => 'string', 'example' => '101820677302****'], + 'AgentName' => ['description' => '座席名称', 'type' => 'string', 'example' => '测试'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => 'd278629c-c687-4aa3-b044-4fe9b01****'], + 'FileName' => ['description' => '录音文件名', 'type' => 'string', 'example' => '4219097556-10-20-49.mkv'], + 'CalledNumber' => ['description' => '被叫号码', 'type' => 'string', 'example' => '1573203****'], + 'StartTime' => ['description' => '电话开始时间，内呼从进入IVR开始，外呼从开始接通计算。', 'type' => 'integer', 'format' => 'int64', 'example' => '1542968440000'], + 'FilePath' => ['description' => '录音文件在OSS中的保存位置', 'type' => 'string', 'example' => 'http://xxx'], + 'ContactId' => ['description' => '话务ID，全局唯一，对应于ACC的ACID。', 'type' => 'string', 'example' => '1300017658'], + 'CallingNumber' => ['description' => '主叫号码', 'type' => 'string', 'example' => '0255237****'], + 'Duration' => ['description' => '通话持续时间，单位为秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '120'], + 'FileDescription' => ['description' => '录音文件别名', 'type' => 'string', 'example' => 'xxx'], + 'Channel' => ['description' => '座席所在音轨标示', 'type' => 'string', 'example' => 'xxx'], ], ], ], @@ -2329,14 +1129,8 @@ ], 'ListRecordingsByContactId' => [ 'summary' => '根据话务ID查找相关的录音详细信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2351,32 +1145,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], ], [ 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '话务ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020927xxxx', - ], + 'schema' => ['description' => '话务ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020927xxxx'], ], ], 'responses' => [ @@ -2384,32 +1164,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '0997CE25-94D3-41DE-8C7A-E6FCFD8C01E0', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '0997CE25-94D3-41DE-8C7A-E6FCFD8C01E0'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Recordings' => [ 'type' => 'object', 'itemNode' => true, @@ -2420,85 +1179,23 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'ContactType' => [ - 'description' => '话务类型', - 'type' => 'string', - 'example' => 'Outbound', - ], - 'AgentId' => [ - 'description' => '坐席ID。'."\n" - ."\n" - .'坐席ID等同于该座席的RAM子账户ID。', - 'type' => 'string', - 'example' => '29393942232031xxxx', - ], - 'AgentName' => [ - 'description' => '坐席名称', - 'type' => 'string', - 'example' => '小芳', - ], - 'InstanceId' => [ - 'description' => '已废弃字段', - 'type' => 'string', - 'example' => '无', - ], - 'FileName' => [ - 'description' => '录音文件名称', - 'type' => 'string', - 'example' => '15312849114340008032xxxx.wav', - ], - 'QualityCheckTid' => [ - 'description' => '智能质检文本ID', - 'type' => 'string', - 'example' => '23A1F0BF-7B30-4918-9424-4DF8B809B9B1', - ], - 'CalledNumber' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'example' => '1558888****', - ], - 'StartTime' => [ - 'description' => '通话开始时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1531284911000', - ], - 'FilePath' => [ - 'description' => '已废弃字段', - 'type' => 'string', - 'example' => '无', - ], - 'ContactId' => [ - 'description' => '话务ID', - 'type' => 'string', - 'example' => '202092xxxx', - ], - 'QualityCheckTaskId' => [ - 'description' => '智能质检任务ID', - 'type' => 'string', - 'example' => '1F0BF809-7B30-4918-9424-4DF23A8BB9B1', - ], - 'CallingNumber' => [ - 'description' => '主叫号码', - 'type' => 'string', - 'example' => '8032****', - ], - 'Duration' => [ - 'description' => '通话时长', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'FileDescription' => [ - 'description' => '录音文件描述', - 'type' => 'string', - 'example' => '20180711125511-小芳', - ], - 'Channel' => [ - 'description' => '已废弃字段', - 'type' => 'string', - 'example' => '无', - ], + 'ContactType' => ['description' => '话务类型', 'type' => 'string', 'example' => 'Outbound'], + 'AgentId' => ['description' => '坐席ID。'."\n" + ."\n" + .'坐席ID等同于该座席的RAM子账户ID。', 'type' => 'string', 'example' => '29393942232031xxxx'], + 'AgentName' => ['description' => '坐席名称', 'type' => 'string', 'example' => '小芳'], + 'InstanceId' => ['description' => '已废弃字段', 'type' => 'string', 'example' => '无'], + 'FileName' => ['description' => '录音文件名称', 'type' => 'string', 'example' => '15312849114340008032xxxx.wav'], + 'QualityCheckTid' => ['description' => '智能质检文本ID', 'type' => 'string', 'example' => '23A1F0BF-7B30-4918-9424-4DF8B809B9B1'], + 'CalledNumber' => ['description' => '被叫号码', 'type' => 'string', 'example' => '1558888****'], + 'StartTime' => ['description' => '通话开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1531284911000'], + 'FilePath' => ['description' => '已废弃字段', 'type' => 'string', 'example' => '无'], + 'ContactId' => ['description' => '话务ID', 'type' => 'string', 'example' => '202092xxxx'], + 'QualityCheckTaskId' => ['description' => '智能质检任务ID', 'type' => 'string', 'example' => '1F0BF809-7B30-4918-9424-4DF23A8BB9B1'], + 'CallingNumber' => ['description' => '主叫号码', 'type' => 'string', 'example' => '8032****'], + 'Duration' => ['description' => '通话时长', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'FileDescription' => ['description' => '录音文件描述', 'type' => 'string', 'example' => '20180711125511-小芳'], + 'Channel' => ['description' => '已废弃字段', 'type' => 'string', 'example' => '无'], ], ], ], @@ -2526,14 +1223,8 @@ ], 'DownloadAllTypeRecording' => [ 'summary' => '通过通话ID来下载原始以及合成录音。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2547,42 +1238,23 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccKYIENB', - ], + 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '待下载录音的通话ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1272014011', - ], + 'schema' => ['description' => '待下载录音的通话ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1272014011'], ], [ 'name' => 'Channel', 'in' => 'query', - 'schema' => [ - 'description' => '座席所在音轨标示，目前不可用。', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxx', - ], + 'schema' => ['description' => '座席所在音轨标示，目前不可用。', 'type' => 'string', 'required' => false, 'example' => 'xxxx'], ], ], 'responses' => [ @@ -2590,32 +1262,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '93CDC17E-3E8A-48F2-99E5-FA2E238DE8B4', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '93CDC17E-3E8A-48F2-99E5-FA2E238DE8B4'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'MediaDownloadParamList' => [ 'type' => 'object', 'itemNode' => true, @@ -2626,18 +1277,10 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SignatureUrl' => [ - 'description' => '录音文件下载URL。'."\n" - ."\n\n" - .'此URL被两个引号包裹，例如：“”urlDetail“”，需要您自行处理一下，此URL有效期为1小时。', - 'type' => 'string', - 'example' => '“”urlDetail“”', - ], - 'FileName' => [ - 'description' => '录音文件名', - 'type' => 'string', - 'example' => '0960005656-03-27-22.mkv', - ], + 'SignatureUrl' => ['description' => '录音文件下载URL。'."\n" + ."\n\n" + .'此URL被两个引号包裹，例如：“”urlDetail“”，需要您自行处理一下，此URL有效期为1小时。', 'type' => 'string', 'example' => '“”urlDetail“”'], + 'FileName' => ['description' => '录音文件名', 'type' => 'string', 'example' => '0960005656-03-27-22.mkv'], ], ], ], @@ -2657,14 +1300,8 @@ ], 'DownloadRecording' => [ 'summary' => '调用DownloadRecording通过录音文件的FileName来下载录音。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2678,42 +1315,23 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccKYIENB', - ], + 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => '待下载录音文件名', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '15312849114340008032****.wav', - ], + 'schema' => ['description' => '待下载录音文件名', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '15312849114340008032****.wav'], ], [ 'name' => 'Channel', 'in' => 'query', - 'schema' => [ - 'description' => '音轨信息，默认为null', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '音轨信息，默认为null', 'type' => 'string', 'required' => false, 'example' => 'null'], ], ], 'responses' => [ @@ -2721,48 +1339,19 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'MediaDownloadParam' => [ 'description' => '获取到的录音文件下载url', 'type' => 'object', 'properties' => [ - 'SignatureUrl' => [ - 'description' => '录音文件下载url。'."\n" - ."\n" - .'此url被两个引号包裹，例如：“”urlDetail“”，需要您自行处理一下，此url有效期为1小时。', - 'type' => 'string', - 'example' => '""urlDetail""', - ], - 'FileName' => [ - 'description' => '录音文件名', - 'type' => 'string', - 'example' => '15312849114340008032****.wav', - ], + 'SignatureUrl' => ['description' => '录音文件下载url。'."\n" + ."\n" + .'此url被两个引号包裹，例如：“”urlDetail“”，需要您自行处理一下，此url有效期为1小时。', 'type' => 'string', 'example' => '""urlDetail""'], + 'FileName' => ['description' => '录音文件名', 'type' => 'string', 'example' => '15312849114340008032****.wav'], ], ], ], @@ -2787,14 +1376,8 @@ ], 'ModifyPrivacyNumberCallDetail' => [ 'summary' => '调用ModifyPrivacyNumberCallDetail更新话务ID。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2809,40 +1392,23 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'description' => '记录外呼虚拟号码操作唯一标识', - 'type' => 'string', - 'required' => true, - 'example' => 'bc984e0a-0dd0-422c-9742-758eff869694', - ], + 'schema' => ['description' => '记录外呼虚拟号码操作唯一标识', 'type' => 'string', 'required' => true, 'example' => 'bc984e0a-0dd0-422c-9742-758eff869694'], ], [ 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '话务ID', - 'type' => 'string', - 'required' => true, - 'example' => '2063169340', - ], + 'schema' => ['description' => '话务ID', 'type' => 'string', 'required' => true, 'example' => '2063169340'], ], ], 'responses' => [ @@ -2850,32 +1416,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '12CE95DF-C91E-4B97-8B7B-0308F191549B', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '12CE95DF-C91E-4B97-8B7B-0308F191549B'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -2887,14 +1432,8 @@ ], 'StartBack2BackCall' => [ 'summary' => '调用StartBack2BackCall发起双呼。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2909,22 +1448,15 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccBCFPY3', - ], + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID。'."\n" - ."\n" - .'背靠背代理所用电话号码需要归属于该呼叫中心实例。', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '呼叫中心实例ID。'."\n" + ."\n" + .'背靠背代理所用电话号码需要归属于该呼叫中心实例。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'WorkflowId', @@ -2936,43 +1468,25 @@ 'type' => 'string', 'required' => false, 'example' => 'null', - 'enum' => [ - 'twoPartiesCallProd', - 'twoPartiesCall', - ], + 'enum' => ['twoPartiesCallProd', 'twoPartiesCall'], ], ], [ 'name' => 'CallCenterNumber', 'in' => 'query', - 'schema' => [ - 'description' => '背靠背代理所用电话号码。'."\n" - ."\n" - .'该电话号码需要归属于**instanceId**指定的呼叫中心实例，若不指定，则会随机选一个指定实例下可用于外呼的号码。', - 'type' => 'string', - 'required' => false, - 'example' => '0256604****', - ], + 'schema' => ['description' => '背靠背代理所用电话号码。'."\n" + ."\n" + .'该电话号码需要归属于**instanceId**指定的呼叫中心实例，若不指定，则会随机选一个指定实例下可用于外呼的号码。', 'type' => 'string', 'required' => false, 'example' => '0256604****'], ], [ 'name' => 'Caller', 'in' => 'query', - 'schema' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'required' => true, - 'example' => '1760066****', - ], + 'schema' => ['description' => '主叫号码。', 'type' => 'string', 'required' => true, 'example' => '1760066****'], ], [ 'name' => 'Callee', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'required' => true, - 'example' => '1880134****', - ], + 'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => true, 'example' => '1880134****'], ], ], 'responses' => [ @@ -2980,52 +1494,15 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'StatusCode' => [ - 'description' => '外呼返回状态码', - 'type' => 'string', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'TimeStamp' => [ - 'description' => '本次外呼的时间戳', - 'type' => 'string', - 'example' => '2018-07-13 14:06:08', - ], - 'TaskId' => [ - 'description' => '本次外呼产生的contactId(即:通话详单中的通话ID)，后续可以据此参数查询话务状态。', - 'type' => 'string', - 'example' => '15716647696706****', - ], - 'StatusDesc' => [ - 'description' => '外呼返回状态描述', - 'type' => 'string', - 'example' => 'Okay', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'StatusCode' => ['description' => '外呼返回状态码', 'type' => 'string', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'TimeStamp' => ['description' => '本次外呼的时间戳', 'type' => 'string', 'example' => '2018-07-13 14:06:08'], + 'TaskId' => ['description' => '本次外呼产生的contactId(即:通话详单中的通话ID)，后续可以据此参数查询话务状态。', 'type' => 'string', 'example' => '15716647696706****'], + 'StatusDesc' => ['description' => '外呼返回状态描述', 'type' => 'string', 'example' => 'Okay'], ], ], ], @@ -3040,14 +1517,8 @@ ], 'ListCallDetailRecords' => [ 'summary' => '获取呼叫中心中的通话详单数据。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3062,109 +1533,59 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREccc5HY0NN', - ], + 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'PhoneNumber', 'in' => 'query', - 'schema' => [ - 'description' => '待获取数据的呼叫中心的电话号码', - 'type' => 'string', - 'required' => false, - 'example' => '1234456****', - ], + 'schema' => ['description' => '待获取数据的呼叫中心的电话号码', 'type' => 'string', 'required' => false, 'example' => '1234456****'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的起始时间。缺省为0，代表从当天的0时开始。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1532448000000', - ], + 'schema' => ['description' => '获取的历史数据的起始时间。缺省为0，代表从当天的0时开始。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1532448000000'], ], [ 'name' => 'StopTime', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的终止时间。缺省为0，代表截止到目前的时间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1532707199000', - ], + 'schema' => ['description' => '获取的历史数据的终止时间。缺省为0，代表截止到目前的时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1532707199000'], ], [ 'name' => 'Criteria', 'in' => 'query', - 'schema' => [ - 'description' => '搜索条件。'."\n" - ."\n" - .'可以根据客户电话、坐席姓名、技能组名称来搜索。', - 'type' => 'string', - 'required' => false, - 'example' => '客服组', - ], + 'schema' => ['description' => '搜索条件。'."\n" + ."\n" + .'可以根据客户电话、坐席姓名、技能组名称来搜索。', 'type' => 'string', 'required' => false, 'example' => '客服组'], ], [ 'name' => 'ContactType', 'in' => 'query', - 'schema' => [ - 'description' => '按呼叫类型筛选。'."\n" - ."\n" - .'取值：Inbound（呼入），Outbound（呼出），Back2Back（双呼），PredictiveDial（预测试外呼），PrivacyDial（虚拟号码外呼） 多个条件以逗号隔开。', - 'type' => 'string', - 'required' => false, - 'example' => 'Outbound,Inbound', - ], + 'schema' => ['description' => '按呼叫类型筛选。'."\n" + ."\n" + .'取值：Inbound（呼入），Outbound（呼出），Back2Back（双呼），PredictiveDial（预测试外呼），PrivacyDial（虚拟号码外呼） 多个条件以逗号隔开。', 'type' => 'string', 'required' => false, 'example' => 'Outbound,Inbound'], ], [ 'name' => 'ContactDisposition', 'in' => 'query', - 'schema' => [ - 'description' => '按挂断类型筛选。'."\n" - ."\n" - .'取值：Success(正常)，NoAnswer(未接通)，AbandonedInContactFlow(IVR中放弃)，AbandonedInQueue(排队放弃)，AbandonedRing(振铃放弃)，QueueOverflow(排队超时)，OneStepTransfer(转外线)，多个条件以逗号隔开。', - 'type' => 'string', - 'required' => false, - 'example' => 'NoAnswer,AbandonedInContactFlow,AbandonedRing', - ], + 'schema' => ['description' => '按挂断类型筛选。'."\n" + ."\n" + .'取值：Success(正常)，NoAnswer(未接通)，AbandonedInContactFlow(IVR中放弃)，AbandonedInQueue(排队放弃)，AbandonedRing(振铃放弃)，QueueOverflow(排队超时)，OneStepTransfer(转外线)，多个条件以逗号隔开。', 'type' => 'string', 'required' => false, 'example' => 'NoAnswer,AbandonedInContactFlow,AbandonedRing'], ], [ 'name' => 'WithRecording', 'in' => 'query', - 'schema' => [ - 'description' => '是否需要录音。默认需要，显式的指明不需要可以加快查询速度。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '是否需要录音。默认需要，显式的指明不需要可以加快查询速度。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '通过指定的contactId来查询某一通电话的记录，contactId可以通过软电话SDK发生通话时获取到。', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => '通过指定的contactId来查询某一通电话的记录，contactId可以通过软电话SDK发生通话时获取到。', 'type' => 'string', 'required' => false, 'example' => '123'], ], [ 'name' => 'OrderBy', @@ -3175,36 +1596,18 @@ 'required' => false, 'example' => 'ASC', 'default' => 'ASC', - 'enum' => [ - 'ASC', - 'DESC', - ], + 'enum' => ['ASC', 'DESC'], ], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '5000', - 'example' => '1', - ], + 'schema' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '5000', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，最大数量为100', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '分页大小，最大数量为100', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], ], 'responses' => [ @@ -3212,54 +1615,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'D70B6625-B54F-4831-BDC4-917A7EBBCE77', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D70B6625-B54F-4831-BDC4-917A7EBBCE77'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'CallDetailRecords' => [ 'description' => '获取到的通话详单', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'TotalCount' => [ - 'description' => '对象总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'TotalCount' => ['description' => '对象总数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -3270,85 +1637,26 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'ContactDisposition' => [ - 'description' => '电话结束原因。'."\n" - ."\n" - .'参考枚举值：Success(正常)，NoAnswer(未接通)，AbandonedInContactFlow(IVR中放弃)，AbandonedInQueue(排队放弃)，AbandonedRing(振铃放弃)，QueueOverflow(排队超时)，OneStepTransfer(转外线)。', - 'type' => 'string', - 'example' => 'Success', - ], - 'ContactType' => [ - 'description' => '通话类型。'."\n" - ."\n" - .'参考枚举值：Inbound(0) 内呼, Outbound(1) 外呼, Internal(2) 内部通话。', - 'type' => 'string', - 'example' => 'Outbound', - ], - 'SkillGroupIdList' => [ - 'description' => '参与通话的座席所述的技能组ID，多个技能组ID以逗号分隔。', - 'type' => 'string', - 'example' => '68536c62-9c25-4201-b4fa-cb15a0d6****,68536c62-9c25-4201-b4fa-cb15a0d****', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => '14b32e95-405b-4514-8118-85e64b22****', - ], - 'CalledNumber' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'example' => '1234444****', - ], - 'AgentNames' => [ - 'description' => '参与通话的座席，多个座席之间以逗号分隔。', - 'type' => 'string', - 'example' => '千牛卖家测试', - ], - 'Satisfaction' => [ - 'description' => '满意度对应的按键，比如1或者2。'."\n" - ."\n" - .'注：只有在发送满意度邀请给客户，并且客户做出评价反馈后，才返回本字段。如果未发送或者发送但未评价，返回内容中不包含本字段。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'StartTime' => [ - 'description' => '电话开始时间，内呼从进入IVR开始，外呼从开始接通计算。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1546575494000', - ], - 'SatisfactionDesc' => [ - 'description' => '在发送满意度客户评价的情况下，该字段为满意度按键（Satisfaction）对应的描述，比如满意、非常满意。若为“未发送”，表示未发送满意度评价邀请给客户；若为“未评价”，表示发送满意度邀请给客户，但客户未评价。', - 'type' => 'string', - 'example' => '不满意', - ], - 'ContactId' => [ - 'description' => '话务ID，全局唯一，对应于 ACC的ACID。', - 'type' => 'string', - 'example' => '2118423213', - ], - 'CallingNumber' => [ - 'description' => '主叫号码', - 'type' => 'string', - 'example' => '07553656****', - ], - 'Duration' => [ - 'description' => '通话持续时间，单位为秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'SkillGroupNames' => [ - 'description' => '参与通话的座席所述的技能组，多个技能组以逗号分隔。', - 'type' => 'string', - 'example' => '默认技能组', - ], - 'Feedback' => [ - 'description' => '不满意度反馈描述', - 'type' => 'string', - 'example' => '基本技能太差', - ], + 'ContactDisposition' => ['description' => '电话结束原因。'."\n" + ."\n" + .'参考枚举值：Success(正常)，NoAnswer(未接通)，AbandonedInContactFlow(IVR中放弃)，AbandonedInQueue(排队放弃)，AbandonedRing(振铃放弃)，QueueOverflow(排队超时)，OneStepTransfer(转外线)。', 'type' => 'string', 'example' => 'Success'], + 'ContactType' => ['description' => '通话类型。'."\n" + ."\n" + .'参考枚举值：Inbound(0) 内呼, Outbound(1) 外呼, Internal(2) 内部通话。', 'type' => 'string', 'example' => 'Outbound'], + 'SkillGroupIdList' => ['description' => '参与通话的座席所述的技能组ID，多个技能组ID以逗号分隔。', 'type' => 'string', 'example' => '68536c62-9c25-4201-b4fa-cb15a0d6****,68536c62-9c25-4201-b4fa-cb15a0d****'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => '14b32e95-405b-4514-8118-85e64b22****'], + 'CalledNumber' => ['description' => '被叫号码', 'type' => 'string', 'example' => '1234444****'], + 'AgentNames' => ['description' => '参与通话的座席，多个座席之间以逗号分隔。', 'type' => 'string', 'example' => '千牛卖家测试'], + 'Satisfaction' => ['description' => '满意度对应的按键，比如1或者2。'."\n" + ."\n" + .'注：只有在发送满意度邀请给客户，并且客户做出评价反馈后，才返回本字段。如果未发送或者发送但未评价，返回内容中不包含本字段。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'StartTime' => ['description' => '电话开始时间，内呼从进入IVR开始，外呼从开始接通计算。', 'type' => 'integer', 'format' => 'int64', 'example' => '1546575494000'], + 'SatisfactionDesc' => ['description' => '在发送满意度客户评价的情况下，该字段为满意度按键（Satisfaction）对应的描述，比如满意、非常满意。若为“未发送”，表示未发送满意度评价邀请给客户；若为“未评价”，表示发送满意度邀请给客户，但客户未评价。', 'type' => 'string', 'example' => '不满意'], + 'ContactId' => ['description' => '话务ID，全局唯一，对应于 ACC的ACID。', 'type' => 'string', 'example' => '2118423213'], + 'CallingNumber' => ['description' => '主叫号码', 'type' => 'string', 'example' => '07553656****'], + 'Duration' => ['description' => '通话持续时间，单位为秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '15'], + 'SkillGroupNames' => ['description' => '参与通话的座席所述的技能组，多个技能组以逗号分隔。', 'type' => 'string', 'example' => '默认技能组'], + 'Feedback' => ['description' => '不满意度反馈描述', 'type' => 'string', 'example' => '基本技能太差'], 'Agents' => [ 'type' => 'object', 'itemNode' => true, @@ -3359,21 +1667,9 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Satisfaction' => [ - 'description' => '满意度', - 'type' => 'string', - 'example' => '不满意', - ], - 'Feedback' => [ - 'description' => '不满意情况下二级反馈信息', - 'type' => 'string', - 'example' => '基本技能太差', - ], - 'AgentId' => [ - 'description' => '座席ID，等同于该座席的RAM子账户ID。', - 'type' => 'string', - 'example' => '101820677302****', - ], + 'Satisfaction' => ['description' => '满意度', 'type' => 'string', 'example' => '不满意'], + 'Feedback' => ['description' => '不满意情况下二级反馈信息', 'type' => 'string', 'example' => '基本技能太差'], + 'AgentId' => ['description' => '座席ID，等同于该座席的RAM子账户ID。', 'type' => 'string', 'example' => '101820677302****'], ], ], ], @@ -3389,53 +1685,15 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'StartTime' => [ - 'description' => '通话开始时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1546575367000', - ], - 'ContactId' => [ - 'description' => '通话ID', - 'type' => 'string', - 'example' => '2118422093', - ], - 'QualityCheckTaskId' => [ - 'description' => '智能质检任务ID', - 'type' => 'string', - 'example' => 'xxx', - ], - 'AgentId' => [ - 'description' => '座席ID，等同于该座席的RAM子账户ID。', - 'type' => 'string', - 'example' => '101820677302****', - ], - 'FileDescription' => [ - 'description' => '录音文件别名', - 'type' => 'string', - 'example' => '20190104121607-千牛卖家测试', - ], - 'Duration' => [ - 'description' => '通话时长', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'AgentName' => [ - 'description' => '座席名称', - 'type' => 'string', - 'example' => '千牛卖家测试', - ], - 'FileName' => [ - 'description' => '录音文件名', - 'type' => 'string', - 'example' => '154657536797300080308468.wav', - ], - 'QualityCheckTid' => [ - 'description' => '智能质检文本ID', - 'type' => 'string', - 'example' => 'xxx', - ], + 'StartTime' => ['description' => '通话开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1546575367000'], + 'ContactId' => ['description' => '通话ID', 'type' => 'string', 'example' => '2118422093'], + 'QualityCheckTaskId' => ['description' => '智能质检任务ID', 'type' => 'string', 'example' => 'xxx'], + 'AgentId' => ['description' => '座席ID，等同于该座席的RAM子账户ID。', 'type' => 'string', 'example' => '101820677302****'], + 'FileDescription' => ['description' => '录音文件别名', 'type' => 'string', 'example' => '20190104121607-千牛卖家测试'], + 'Duration' => ['description' => '通话时长', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'AgentName' => ['description' => '座席名称', 'type' => 'string', 'example' => '千牛卖家测试'], + 'FileName' => ['description' => '录音文件名', 'type' => 'string', 'example' => '154657536797300080308468.wav'], + 'QualityCheckTid' => ['description' => '智能质检文本ID', 'type' => 'string', 'example' => 'xxx'], ], ], ], @@ -3463,14 +1721,8 @@ ], 'ListCallEventDetailByContactId' => [ 'summary' => '根据通话ID获取通话的详细操作日志。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3485,32 +1737,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '通过指定的**contactId**来查询某一通电话的记录，contactId可以通过软电话SDK发生通话时获取到。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1096645650', - ], + 'schema' => ['description' => '通过指定的**contactId**来查询某一通电话的记录，contactId可以通过软电话SDK发生通话时获取到。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1096645650'], ], ], 'responses' => [ @@ -3518,71 +1756,22 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '获取到的通话详单', 'type' => 'object', 'properties' => [ - 'StartTime' => [ - 'description' => '呼叫时间', - 'type' => 'string', - 'example' => '1555492246000', - ], - 'ReleaseReason' => [ - 'description' => '挂断原因', - 'type' => 'string', - 'example' => '487-Request Terminated', - ], - 'CallType' => [ - 'description' => '呼叫类型', - 'type' => 'string', - 'example' => 'Outbound', - ], - 'ReleaseAgent' => [ - 'description' => '挂断方,customer：用户挂机；agent：坐席挂机，同时提醒，目前有部分数据为兼容，如出现特殊数据请反馈给云呼技术值班同学进行挂断方的定位。', - 'type' => 'string', - 'example' => 'agent', - ], - 'Caller' => [ - 'description' => '主叫号码', - 'type' => 'string', - 'example' => '8031****', - ], - 'Callee' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'example' => '1350121****', - ], - 'PrivacyNumber' => [ - 'description' => '虚拟号码', - 'type' => 'string', - 'example' => '1234****', - ], + 'StartTime' => ['description' => '呼叫时间', 'type' => 'string', 'example' => '1555492246000'], + 'ReleaseReason' => ['description' => '挂断原因', 'type' => 'string', 'example' => '487-Request Terminated'], + 'CallType' => ['description' => '呼叫类型', 'type' => 'string', 'example' => 'Outbound'], + 'ReleaseAgent' => ['description' => '挂断方,customer：用户挂机；agent：坐席挂机，同时提醒，目前有部分数据为兼容，如出现特殊数据请反馈给云呼技术值班同学进行挂断方的定位。', 'type' => 'string', 'example' => 'agent'], + 'Caller' => ['description' => '主叫号码', 'type' => 'string', 'example' => '8031****'], + 'Callee' => ['description' => '被叫号码', 'type' => 'string', 'example' => '1350121****'], + 'PrivacyNumber' => ['description' => '虚拟号码', 'type' => 'string', 'example' => '1234****'], 'Events' => [ 'type' => 'object', 'itemNode' => true, @@ -3593,71 +1782,26 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '状态', - 'type' => 'string', - 'example' => 'Dialing', - ], - 'CallMode' => [ - 'description' => '通话类型', - 'type' => 'string', - 'example' => 'Outbound', - ], - 'Event' => [ - 'description' => '事件描述。'."\n" - .'包括：'."\n" - ."\n" - .'- **IVR事件**：EnterIVR （进入IVR）；'."\n" - .'- **队列事件**：EnterQueue（进入队列）、ACDOverflow（队列溢出）、AbandonedRing（振铃放弃）、NormalEnd（队列中正常结束）、AbandonedInQueue（进入放弃队列）、WaitingInQueue（进入等待队列）；'."\n" - .'- **坐席事件**：Ring（振铃）、Talk（通话）、GiveUp（放弃）、End（结束）、Handle（挂断）、CallForHelp（发起求助）、CallForHelpSuccess（求助成功）、SetUpMeeting（会议建立）、Dial（拨号）、LaunchTransfer（转接）。', - 'type' => 'string', - 'example' => 'Dial', - ], - 'TimeStamp' => [ - 'description' => '事件发生时间', - 'type' => 'string', - 'example' => '1555492246000', - ], - 'AgentName' => [ - 'description' => '坐席名', - 'type' => 'string', - 'example' => 'cloudcallcenter', - ], - 'Duration' => [ - 'description' => '持续时间', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9', - ], + 'Status' => ['description' => '状态', 'type' => 'string', 'example' => 'Dialing'], + 'CallMode' => ['description' => '通话类型', 'type' => 'string', 'example' => 'Outbound'], + 'Event' => ['description' => '事件描述。'."\n" + .'包括：'."\n" + ."\n" + .'- **IVR事件**：EnterIVR （进入IVR）；'."\n" + .'- **队列事件**：EnterQueue（进入队列）、ACDOverflow（队列溢出）、AbandonedRing（振铃放弃）、NormalEnd（队列中正常结束）、AbandonedInQueue（进入放弃队列）、WaitingInQueue（进入等待队列）；'."\n" + .'- **坐席事件**：Ring（振铃）、Talk（通话）、GiveUp（放弃）、End（结束）、Handle（挂断）、CallForHelp（发起求助）、CallForHelpSuccess（求助成功）、SetUpMeeting（会议建立）、Dial（拨号）、LaunchTransfer（转接）。', 'type' => 'string', 'example' => 'Dial'], + 'TimeStamp' => ['description' => '事件发生时间', 'type' => 'string', 'example' => '1555492246000'], + 'AgentName' => ['description' => '坐席名', 'type' => 'string', 'example' => 'cloudcallcenter'], + 'Duration' => ['description' => '持续时间', 'type' => 'integer', 'format' => 'int32', 'example' => '9'], 'DetailData' => [ 'description' => '动态添加所需的详细信息', 'type' => 'object', 'properties' => [ - 'HangUper' => [ - 'description' => '被求助者，求助内部坐席，对应坐席名称；求助外部的话，记录外部号码。', - 'type' => 'string', - 'example' => 'byeSystem', - ], - 'EventType' => [ - 'description' => '事件类型 包括：ivr、queue、agent。', - 'type' => 'string', - 'example' => 'agent', - ], - 'SkillGroup' => [ - 'description' => '技能组', - 'type' => 'string', - 'example' => '测试', - ], - 'SatisfactionalResearch' => [ - 'description' => '满意度调查', - 'type' => 'string', - 'example' => '不满意', - ], - 'Helper' => [ - 'description' => '挂机者', - 'type' => 'string', - 'example' => 'xme', - ], + 'HangUper' => ['description' => '被求助者，求助内部坐席，对应坐席名称；求助外部的话，记录外部号码。', 'type' => 'string', 'example' => 'byeSystem'], + 'EventType' => ['description' => '事件类型 包括：ivr、queue、agent。', 'type' => 'string', 'example' => 'agent'], + 'SkillGroup' => ['description' => '技能组', 'type' => 'string', 'example' => '测试'], + 'SatisfactionalResearch' => ['description' => '满意度调查', 'type' => 'string', 'example' => '不满意'], + 'Helper' => ['description' => '挂机者', 'type' => 'string', 'example' => 'xme'], ], ], ], @@ -3680,14 +1824,8 @@ ], 'ListRecentCallRecords' => [ 'summary' => '调用ListRecentCallRecords获取呼叫中心当前坐席的最近通话记录。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3702,79 +1840,40 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的起始时间。缺省为0，代表从当天的0时开始。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1532448000000', - ], + 'schema' => ['description' => '获取的历史数据的起始时间。缺省为0，代表从当天的0时开始。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1532448000000'], ], [ 'name' => 'StopTime', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的终止时间。缺省为0，代表截止到目前的时间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1532707199000', - ], + 'schema' => ['description' => '获取的历史数据的终止时间。缺省为0，代表截止到目前的时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1532707199000'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ 'name' => 'Criteria', 'in' => 'query', - 'schema' => [ - 'description' => '搜索条件。'."\n" - ."\n" - .'可以根据号码（客户电话或坐席号码）来搜索。', - 'type' => 'string', - 'required' => false, - 'example' => '{"phoneNumber": "0411xxxx4588"}', - ], + 'schema' => ['description' => '搜索条件。'."\n" + ."\n" + .'可以根据号码（客户电话或坐席号码）来搜索。', 'type' => 'string', 'required' => false, 'example' => '{"phoneNumber": "0411xxxx4588"}'], ], ], 'responses' => [ @@ -3782,54 +1881,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '032C73C4-3A6F-4502-872B-4F5B41161C6E', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '032C73C4-3A6F-4502-872B-4F5B41161C6E'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'CallDetailRecords' => [ 'description' => '获取到的通话详单', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '对象总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '对象总数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -3840,83 +1903,24 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'ContactDisposition' => [ - 'description' => '电话结束原因。'."\n" - ."\n" - .'参考枚举值：Success(0) 正常, NoAnswer(1) 无应答, Rejected(2)拒绝, Busy(3)忙, AbandonedInContactFlow(4) IVR呼损, AbandonedInQueue(5)队列呼损, AbandonedRing(6) 久振不接, QueueOverflow(7) 等待超时被挂断。', - 'type' => 'string', - 'example' => 'Success', - ], - 'ContactType' => [ - 'description' => '通话类型。'."\n" - ."\n" - .'参考枚举值：Inbound(0) 内呼, Outbound(1) 外呼, Internal(2) 内部通话。', - 'type' => 'string', - 'example' => 'Outbound', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], - 'CalledNumber' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'example' => '0109898****', - ], - 'AgentNames' => [ - 'description' => '参与通话的座席，多个座席之间以逗号分隔。', - 'type' => 'string', - 'example' => 'ccctest', - ], - 'Satisfaction' => [ - 'description' => '满意度', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'StartTime' => [ - 'description' => '电话开始时间，内呼从进入IVR开始，外呼从开始接通计算。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1532448000000', - ], - 'ExtraAttr' => [ - 'description' => '额外信息', - 'type' => 'string', - 'example' => '无', - ], - 'SatisfactionDesc' => [ - 'description' => '满意度描述', - 'type' => 'string', - 'example' => '满意', - ], - 'ContactId' => [ - 'description' => '话务ID，全局唯一，对应于 ACC的ACID。', - 'type' => 'string', - 'example' => '20988909', - ], - 'CallingNumber' => [ - 'description' => '主叫号码', - 'type' => 'string', - 'example' => '1930909****', - ], - 'Duration' => [ - 'description' => '通话持续时间，单位为秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '39', - ], - 'SkillGroupNames' => [ - 'description' => '参与通话的座席所述的技能组，多个技能组以逗号分隔。', - 'type' => 'string', - 'example' => '技能组1', - ], - 'Feedback' => [ - 'description' => '反馈', - 'type' => 'string', - 'example' => '不满意', - ], + 'ContactDisposition' => ['description' => '电话结束原因。'."\n" + ."\n" + .'参考枚举值：Success(0) 正常, NoAnswer(1) 无应答, Rejected(2)拒绝, Busy(3)忙, AbandonedInContactFlow(4) IVR呼损, AbandonedInQueue(5)队列呼损, AbandonedRing(6) 久振不接, QueueOverflow(7) 等待超时被挂断。', 'type' => 'string', 'example' => 'Success'], + 'ContactType' => ['description' => '通话类型。'."\n" + ."\n" + .'参考枚举值：Inbound(0) 内呼, Outbound(1) 外呼, Internal(2) 内部通话。', 'type' => 'string', 'example' => 'Outbound'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], + 'CalledNumber' => ['description' => '被叫号码', 'type' => 'string', 'example' => '0109898****'], + 'AgentNames' => ['description' => '参与通话的座席，多个座席之间以逗号分隔。', 'type' => 'string', 'example' => 'ccctest'], + 'Satisfaction' => ['description' => '满意度', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'StartTime' => ['description' => '电话开始时间，内呼从进入IVR开始，外呼从开始接通计算。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000'], + 'ExtraAttr' => ['description' => '额外信息', 'type' => 'string', 'example' => '无'], + 'SatisfactionDesc' => ['description' => '满意度描述', 'type' => 'string', 'example' => '满意'], + 'ContactId' => ['description' => '话务ID，全局唯一，对应于 ACC的ACID。', 'type' => 'string', 'example' => '20988909'], + 'CallingNumber' => ['description' => '主叫号码', 'type' => 'string', 'example' => '1930909****'], + 'Duration' => ['description' => '通话持续时间，单位为秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '39'], + 'SkillGroupNames' => ['description' => '参与通话的座席所述的技能组，多个技能组以逗号分隔。', 'type' => 'string', 'example' => '技能组1'], + 'Feedback' => ['description' => '反馈', 'type' => 'string', 'example' => '不满意'], 'Agents' => [ 'type' => 'object', 'itemNode' => true, @@ -3927,72 +1931,18 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'AgentId' => [ - 'description' => '座席ID', - 'type' => 'string', - 'example' => '105987678892xxxx', - ], - 'TalkTime' => [ - 'description' => '通话时间，单位为秒', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '54', - ], - 'WorkTime' => [ - 'description' => '话后处理时间，单位为秒', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'AgentName' => [ - 'description' => '座席名称', - 'type' => 'string', - 'example' => 'ccctest', - ], - 'RingTime' => [ - 'description' => '振铃时间，单位为秒', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Satisfaction' => [ - 'description' => '满意度', - 'type' => 'string', - 'example' => '1', - ], - 'StartTime' => [ - 'description' => '通话开始时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1532448000000', - ], - 'ContactId' => [ - 'description' => '话务ID', - 'type' => 'string', - 'example' => '123909012', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称', - 'type' => 'string', - 'example' => '技能组1', - ], - 'HoldTime' => [ - 'description' => '通话保持时间，单位为秒', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'QueueTime' => [ - 'description' => '排队时间，单位为秒', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'Feedback' => [ - 'description' => '反馈', - 'type' => 'string', - 'example' => '不满意', - ], + 'AgentId' => ['description' => '座席ID', 'type' => 'string', 'example' => '105987678892xxxx'], + 'TalkTime' => ['description' => '通话时间，单位为秒', 'type' => 'integer', 'format' => 'int32', 'example' => '54'], + 'WorkTime' => ['description' => '话后处理时间，单位为秒', 'type' => 'integer', 'format' => 'int32', 'example' => '15'], + 'AgentName' => ['description' => '座席名称', 'type' => 'string', 'example' => 'ccctest'], + 'RingTime' => ['description' => '振铃时间，单位为秒', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Satisfaction' => ['description' => '满意度', 'type' => 'string', 'example' => '1'], + 'StartTime' => ['description' => '通话开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000'], + 'ContactId' => ['description' => '话务ID', 'type' => 'string', 'example' => '123909012'], + 'SkillGroupName' => ['description' => '技能组名称', 'type' => 'string', 'example' => '技能组1'], + 'HoldTime' => ['description' => '通话保持时间，单位为秒', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'QueueTime' => ['description' => '排队时间，单位为秒', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'Feedback' => ['description' => '反馈', 'type' => 'string', 'example' => '不满意'], ], ], ], @@ -4008,73 +1958,19 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'ContactType' => [ - 'description' => '通话类型', - 'type' => 'string', - 'example' => 'Outbound', - ], - 'AgentId' => [ - 'description' => '座席ID', - 'type' => 'string', - 'example' => '105987678892xxxx', - ], - 'AgentName' => [ - 'description' => '座席名称', - 'type' => 'string', - 'example' => 'ccctest', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], - 'FileName' => [ - 'description' => '录音文件名', - 'type' => 'string', - 'example' => '0001.wav', - ], - 'CalledNumber' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'example' => '1930909****', - ], - 'StartTime' => [ - 'description' => '通话开始时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1532448000000', - ], - 'FilePath' => [ - 'description' => '录音文件在OSS中的保存位置', - 'type' => 'string', - 'example' => 'oss://cloudcall-test/acc123', - ], - 'ContactId' => [ - 'description' => '话务ID', - 'type' => 'string', - 'example' => '123909012', - ], - 'CallingNumber' => [ - 'description' => '主叫电话', - 'type' => 'string', - 'example' => '0109898****', - ], - 'Duration' => [ - 'description' => '通话时长', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '38', - ], - 'FileDescription' => [ - 'description' => '录音文件别名', - 'type' => 'string', - 'example' => '无', - ], - 'Channel' => [ - 'description' => '座席所在音轨标示', - 'type' => 'string', - 'example' => '无', - ], + 'ContactType' => ['description' => '通话类型', 'type' => 'string', 'example' => 'Outbound'], + 'AgentId' => ['description' => '座席ID', 'type' => 'string', 'example' => '105987678892xxxx'], + 'AgentName' => ['description' => '座席名称', 'type' => 'string', 'example' => 'ccctest'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], + 'FileName' => ['description' => '录音文件名', 'type' => 'string', 'example' => '0001.wav'], + 'CalledNumber' => ['description' => '被叫号码', 'type' => 'string', 'example' => '1930909****'], + 'StartTime' => ['description' => '通话开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000'], + 'FilePath' => ['description' => '录音文件在OSS中的保存位置', 'type' => 'string', 'example' => 'oss://cloudcall-test/acc123'], + 'ContactId' => ['description' => '话务ID', 'type' => 'string', 'example' => '123909012'], + 'CallingNumber' => ['description' => '主叫电话', 'type' => 'string', 'example' => '0109898****'], + 'Duration' => ['description' => '通话时长', 'type' => 'integer', 'format' => 'int32', 'example' => '38'], + 'FileDescription' => ['description' => '录音文件别名', 'type' => 'string', 'example' => '无'], + 'Channel' => ['description' => '座席所在音轨标示', 'type' => 'string', 'example' => '无'], ], ], ], @@ -4100,14 +1996,8 @@ ], 'GetConversationDetailByContactId' => [ 'summary' => '根据话务ID（ContactId）获得此次对话的文本信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4122,56 +2012,28 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取日常性能数据的呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '待获取日常性能数据的呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '话务ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020927020', - ], + 'schema' => ['description' => '话务ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020927020'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '为扩展预留，目前不生效，请传入1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '为扩展预留，目前不生效，请传入1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '为扩展预留，目前不生效，请传入1-99之间数字。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '2', - ], + 'schema' => ['description' => '为扩展预留，目前不生效，请传入1-99之间数字。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2'], ], ], 'responses' => [ @@ -4179,54 +2041,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'D5A4E013-09E1-4CDA-B70A-F5D3B75015A3', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D5A4E013-09E1-4CDA-B70A-F5D3B75015A3'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'DataList' => [ 'description' => '对话结果', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '为扩展预留分页数据', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '为扩展预留分页数据', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalCount' => [ - 'description' => '对话轮数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'PageNumber' => ['description' => '为扩展预留分页数据', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '为扩展预留分页数据', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'TotalCount' => ['description' => '对话轮数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -4237,33 +2063,11 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'End' => [ - 'description' => '对话结束偏移量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3272', - ], - 'Words' => [ - 'description' => '对话文本', - 'type' => 'string', - 'example' => '您好', - ], - 'Role' => [ - 'description' => '角色，客户或者客服。', - 'type' => 'string', - 'example' => '客服', - ], - 'Begin' => [ - 'description' => '对话开始偏移量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1317', - ], - 'Identity' => [ - 'description' => '身份', - 'type' => 'string', - 'example' => 'xxx', - ], + 'End' => ['description' => '对话结束偏移量', 'type' => 'integer', 'format' => 'int64', 'example' => '3272'], + 'Words' => ['description' => '对话文本', 'type' => 'string', 'example' => '您好'], + 'Role' => ['description' => '角色，客户或者客服。', 'type' => 'string', 'example' => '客服'], + 'Begin' => ['description' => '对话开始偏移量', 'type' => 'integer', 'format' => 'int64', 'example' => '1317'], + 'Identity' => ['description' => '身份', 'type' => 'string', 'example' => 'xxx'], ], ], ], @@ -4285,14 +2089,8 @@ ], 'DialEx' => [ 'summary' => '发起后台外呼。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4307,83 +2105,45 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012****'], ], [ 'name' => 'Caller', 'in' => 'query', - 'schema' => [ - 'description' => '主叫号码', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0228519****', - ], + 'schema' => ['description' => '主叫号码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0228519****'], ], [ 'name' => 'Callee', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1573203****', - ], + 'schema' => ['description' => '被叫号码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1573203****'], ], [ 'name' => 'RoutPoint', 'in' => 'query', - 'schema' => [ - 'description' => '- 如果AnswerMode是**0**，则传入联系流ID（ContractFlowId）；'."\n" - .'- 如果AnwserMode是**1**，则传入接听坐席，格式:ram_id@呼叫中心二级域名；'."\n" - .'- 如果AnwserMode是**2**，则传入接听技能组队列(技能组queue)'."\n" - .'> Q:如何查找呼叫中心二级域名？ A: 位置：https://ccc.aliyun.com/workbench/呼叫中心二级域名， *注意：呼叫中心二级域名需要与创建云呼叫中心实例填写的保持一致，此接口会区分二级域名的大小写*', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'paEF_1GAQXXJ', - ], + 'schema' => ['description' => '- 如果AnswerMode是**0**，则传入联系流ID（ContractFlowId）；'."\n" + .'- 如果AnwserMode是**1**，则传入接听坐席，格式:ram_id@呼叫中心二级域名；'."\n" + .'- 如果AnwserMode是**2**，则传入接听技能组队列(技能组queue)'."\n" + .'> Q:如何查找呼叫中心二级域名？ A: 位置：https://ccc.aliyun.com/workbench/呼叫中心二级域名， *注意：呼叫中心二级域名需要与创建云呼叫中心实例填写的保持一致，此接口会区分二级域名的大小写*', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'paEF_1GAQXXJ'], ], [ 'name' => 'AnswerMode', 'in' => 'query', - 'schema' => [ - 'description' => '接听方式。三种方式分别为：'."\n" - ."\n" - .'- **0**：ivr'."\n" - .'- **1**：agent'."\n" - .'- **2**：skillgroupid', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '接听方式。三种方式分别为：'."\n" + ."\n" + .'- **0**：ivr'."\n" + .'- **1**：agent'."\n" + .'- **2**：skillgroupid', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'Provider', 'in' => 'query', - 'schema' => [ - 'description' => '外呼方式', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => '外呼方式', 'type' => 'string', 'required' => false, 'example' => 'null'], ], ], 'responses' => [ @@ -4391,52 +2151,15 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '26D1277F-55BF-453E-A6B2-02B7E6F97699', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'StatusCode' => [ - 'description' => '外呼返回状态码', - 'type' => 'string', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'TimeStamp' => [ - 'description' => '本次外呼的时间戳', - 'type' => 'string', - 'example' => '1554862236398', - ], - 'TaskId' => [ - 'description' => '本次外呼产生的任务ID', - 'type' => 'string', - 'example' => '15548622359772****', - ], - 'StatusDesc' => [ - 'description' => '外呼返回状态描述', - 'type' => 'string', - 'example' => 'Okay', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '26D1277F-55BF-453E-A6B2-02B7E6F97699'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'StatusCode' => ['description' => '外呼返回状态码', 'type' => 'string', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'TimeStamp' => ['description' => '本次外呼的时间戳', 'type' => 'string', 'example' => '1554862236398'], + 'TaskId' => ['description' => '本次外呼产生的任务ID', 'type' => 'string', 'example' => '15548622359772****'], + 'StatusDesc' => ['description' => '外呼返回状态描述', 'type' => 'string', 'example' => 'Okay'], ], ], ], @@ -4458,14 +2181,8 @@ ], 'CallOnlinePrivacyNumber' => [ 'summary' => '调用CallOnlinePrivacyNumber使用虚拟号码外呼。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4480,40 +2197,23 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'TelA', 'in' => 'query', - 'schema' => [ - 'description' => '主叫号码', - 'type' => 'string', - 'required' => true, - 'example' => '0256604****', - ], + 'schema' => ['description' => '主叫号码', 'type' => 'string', 'required' => true, 'example' => '0256604****'], ], [ 'name' => 'TelB', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'required' => true, - 'example' => '1880134****', - ], + 'schema' => ['description' => '被叫号码', 'type' => 'string', 'required' => true, 'example' => '1880134****'], ], ], 'responses' => [ @@ -4521,61 +2221,20 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '返回虚拟号码', 'type' => 'object', 'properties' => [ - 'DateCreated' => [ - 'description' => '虚拟号码呼叫响应时间', - 'type' => 'string', - 'example' => '2018/10/27 15:55:55', - ], - 'Represent' => [ - 'description' => '虚拟号码呼叫错误描述', - 'type' => 'string', - 'example' => '无', - ], - 'TelX' => [ - 'description' => '虚拟号码', - 'type' => 'string', - 'example' => '1302015****', - ], - 'StatusCode' => [ - 'description' => '虚拟号码呼叫返回状态', - 'type' => 'string', - 'example' => '000000', - ], - 'CallId' => [ - 'description' => '虚拟号码通话唯一标识', - 'type' => 'string', - 'example' => '5ec64c6b-4b98-4fd6-8ce8-ad07cf84481b', - ], + 'DateCreated' => ['description' => '虚拟号码呼叫响应时间', 'type' => 'string', 'example' => '2018/10/27 15:55:55'], + 'Represent' => ['description' => '虚拟号码呼叫错误描述', 'type' => 'string', 'example' => '无'], + 'TelX' => ['description' => '虚拟号码', 'type' => 'string', 'example' => '1302015****'], + 'StatusCode' => ['description' => '虚拟号码呼叫返回状态', 'type' => 'string', 'example' => '000000'], + 'CallId' => ['description' => '虚拟号码通话唯一标识', 'type' => 'string', 'example' => '5ec64c6b-4b98-4fd6-8ce8-ad07cf84481b'], ], ], ], @@ -4592,14 +2251,8 @@ ], 'GetConfig' => [ 'summary' => '获取单独某一项的配置信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4613,53 +2266,28 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '配置项名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'AllowHangup', - ], + 'schema' => ['description' => '配置项名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'AllowHangup'], ], [ 'name' => 'ObjectId', 'in' => 'query', - 'schema' => [ - 'description' => '配置维度值。', - 'type' => 'string', - 'required' => false, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '配置维度值。', 'type' => 'string', 'required' => false, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'ObjectType', 'in' => 'query', - 'schema' => [ - 'description' => '配置维度名称，标识该配置作用范围。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'instance', - ], + 'schema' => ['description' => '配置维度名称，标识该配置作用范围。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'instance'], ], ], 'responses' => [ @@ -4667,46 +2295,17 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => 'xxx', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => 'xxx'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '10A1AD70-E48E-476D-98D9-39BD92193837'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'ConfigItem' => [ 'description' => '配置项信息', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '配置项名称', - 'type' => 'string', - 'example' => 'AllowHangup', - ], - 'Value' => [ - 'description' => '配置项的值', - 'type' => 'string', - 'example' => '1', - ], + 'Name' => ['description' => '配置项名称', 'type' => 'string', 'example' => 'AllowHangup'], + 'Value' => ['description' => '配置项的值', 'type' => 'string', 'example' => '1'], ], ], ], @@ -4722,14 +2321,8 @@ ], 'ListConfig' => [ 'summary' => '获取多个配置信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4743,21 +2336,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccTMAX45', - ], + 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'ConfigItem', @@ -4789,9 +2374,7 @@ ."\n" .'例如：`{“Name”:”AllowHangup”,”DimensionName”:”instance”}`。其中，**Name**为配置项名称，**DimensionName**为配置维度名称。这里参数名称为**ConfigItem.1**意为只获取1个配置项，如果要获取两个配置项，则需要有**ConfigItem.1**以及**ConfigItem.2**。'."\n", 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '{“Name”:”AllowHangup”,”DimensionName”:”instance”}', 'maxItems' => 99, @@ -4803,32 +2386,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C81FD1A5-4B99-470A-A527-D80150228784', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'C81FD1A5-4B99-470A-A527-D80150228784'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'ConfigItems' => [ 'type' => 'object', 'itemNode' => true, @@ -4839,16 +2401,8 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => '配置项名称', - 'type' => 'string', - 'example' => 'AllowHangup', - ], - 'Value' => [ - 'description' => '配置项值', - 'type' => 'string', - 'example' => '1', - ], + 'Name' => ['description' => '配置项名称', 'type' => 'string', 'example' => 'AllowHangup'], + 'Value' => ['description' => '配置项值', 'type' => 'string', 'example' => '1'], ], ], ], @@ -4877,14 +2431,8 @@ ], 'AddPhoneTags' => [ 'summary' => '调用接口：AddPhoneTags 添加号码打标信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4899,94 +2447,48 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'ServiceTag', 'in' => 'query', - 'schema' => [ - 'description' => '业务标签', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'M1', - ], + 'schema' => ['description' => '业务标签', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'M1'], ], [ 'name' => 'RegionNameProvince', 'in' => 'query', - 'schema' => [ - 'description' => '归属地省', - 'type' => 'string', - 'required' => false, - 'example' => '北京', - ], + 'schema' => ['description' => '归属地省', 'type' => 'string', 'required' => false, 'example' => '北京'], ], [ 'name' => 'RegionNameCity', 'in' => 'query', - 'schema' => [ - 'description' => '归属地市', - 'type' => 'string', - 'required' => false, - 'example' => '北京', - ], + 'schema' => ['description' => '归属地市', 'type' => 'string', 'required' => false, 'example' => '北京'], ], [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '号码类型，0：普通号码，1：手机号码', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '号码类型，0：普通号码，1：手机号码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'Concurrency', 'in' => 'query', - 'schema' => [ - 'description' => '并发量，默认为1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '15', - ], + 'schema' => ['description' => '并发量，默认为1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '15'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'Provider', 'in' => 'query', - 'schema' => [ - 'description' => '运营商', - 'type' => 'string', - 'required' => false, - 'example' => '全国联通', - ], + 'schema' => ['description' => '运营商', 'type' => 'string', 'required' => false, 'example' => '全国联通'], ], [ 'name' => 'SipTag', 'in' => 'query', - 'schema' => [ - 'description' => 'SIP打标信息', - 'type' => 'string', - 'required' => false, - 'example' => 'AliTelecom', - ], + 'schema' => ['description' => 'SIP打标信息', 'type' => 'string', 'required' => false, 'example' => 'AliTelecom'], ], [ 'name' => 'PhoneNumberList', @@ -4995,9 +2497,7 @@ 'schema' => [ 'description' => '号码集合', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'example' => '01098789876', 'maxItems' => 99, @@ -5009,36 +2509,15 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码'."\n" - ."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE', - ], - 'Success' => [ - 'description' => '是否成功'."\n" - ."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码'."\n" + ."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE'], + 'Success' => ['description' => '是否成功'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -5052,14 +2531,8 @@ ], 'DeletePhoneTags' => [ 'summary' => '调用接口：DeletePhoneTags 删除号码打标信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5074,21 +2547,13 @@ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'PhoneNumberList', @@ -5097,9 +2562,7 @@ 'schema' => [ 'description' => '号码集合。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'example' => '01098789876', 'maxItems' => 99, @@ -5111,32 +2574,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -5150,14 +2592,8 @@ ], 'ModifyPhoneTags' => [ 'summary' => '调用接口：ModifyPhoneTags 修改号码打标信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5172,32 +2608,18 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d ', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d '], ], [ 'name' => 'ServiceTag', 'in' => 'query', - 'schema' => [ - 'description' => '业务标签', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'M1', - ], + 'schema' => ['description' => '业务标签', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'M1'], ], [ 'name' => 'SkillGroupIdList', @@ -5206,9 +2628,7 @@ 'schema' => [ 'description' => '技能组ID集合', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => 'u8109-6260-4a53-ab6e-b13e3fb31f7d ', 'maxItems' => 99, @@ -5220,35 +2640,14 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码'."\n" - ."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码'."\n" + ."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -5262,14 +2661,8 @@ ], 'ListPhoneTags' => [ 'summary' => '调用接口：ListPhoneTags查询号码打标信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5284,66 +2677,33 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450"', - ], + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450"'], ], [ 'name' => 'OutboundOnly', 'in' => 'query', - 'schema' => [ - 'description' => '是否仅外呼', - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'false', - ], + 'schema' => ['description' => '是否仅外呼', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '当前页码', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'Number', 'in' => 'query', - 'schema' => [ - 'description' => '号码', - 'type' => 'string', - 'required' => false, - 'example' => '010989897878', - ], + 'schema' => ['description' => '号码', 'type' => 'string', 'required' => false, 'example' => '010989897878'], ], [ 'name' => 'NumberGroupIds', @@ -5352,9 +2712,7 @@ 'schema' => [ 'description' => '号码组ID列表', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '121318023891274071', 'maxItems' => 99, @@ -5366,139 +2724,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码'."\n" - ."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', - ], - 'Success' => [ - 'description' => '是否成功'."\n" - ."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码'."\n" + ."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '], + 'Success' => ['description' => '是否成功'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true'], 'PhoneNumbers' => [ 'description' => '打标号码集合', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '29', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总大小', 'type' => 'integer', 'format' => 'int32', 'example' => '29'], 'List' => [ 'description' => '打标号码集合', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '号码类型，0：普通号码，1：手机号码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ServiceTag' => [ - 'description' => '业务标签', - 'type' => 'string', - 'example' => 'M1', - ], - 'CreateTime' => [ - 'description' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1554862236398', - ], - 'City' => [ - 'description' => '城市', - 'type' => 'string', - 'example' => '北京', - ], - 'InstanceId' => [ - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], - 'Usage' => [ - 'description' => '电话号码的用途，呼入，呼出，已经同时用于呼入和呼出。 Inbound, Outbound, Bidirection。', - 'type' => 'string', - 'example' => 'Bidirection', - ], - 'PhoneNumberId' => [ - 'description' => '号码ID', - 'type' => 'string', - 'example' => '129031-joriew-EIOD', - ], - 'Provider' => [ - 'description' => '供应商', - 'type' => 'string', - 'example' => 'ali Telecom', - ], - 'Number' => [ - 'description' => '号码', - 'type' => 'string', - 'example' => '01009090909', - ], - 'ContactFlowId' => [ - 'description' => '联系流ID', - 'type' => 'string', - 'example' => '1231jfowei-uoer012091i', - ], - 'PhoneNumberDescription' => [ - 'description' => '号码描述', - 'type' => 'string', - 'example' => '无', - ], - 'Province' => [ - 'description' => '省份', - 'type' => 'string', - 'example' => '北京', - ], - 'Concurrency' => [ - 'description' => '并发量，默认是1'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'Type' => ['description' => '号码类型，0：普通号码，1：手机号码', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ServiceTag' => ['description' => '业务标签', 'type' => 'string', 'example' => 'M1'], + 'CreateTime' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1554862236398'], + 'City' => ['description' => '城市', 'type' => 'string', 'example' => '北京'], + 'InstanceId' => ['description' => '实例ID', 'type' => 'string', 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], + 'Usage' => ['description' => '电话号码的用途，呼入，呼出，已经同时用于呼入和呼出。 Inbound, Outbound, Bidirection。', 'type' => 'string', 'example' => 'Bidirection'], + 'PhoneNumberId' => ['description' => '号码ID', 'type' => 'string', 'example' => '129031-joriew-EIOD'], + 'Provider' => ['description' => '供应商', 'type' => 'string', 'example' => 'ali Telecom'], + 'Number' => ['description' => '号码', 'type' => 'string', 'example' => '01009090909'], + 'ContactFlowId' => ['description' => '联系流ID', 'type' => 'string', 'example' => '1231jfowei-uoer012091i'], + 'PhoneNumberDescription' => ['description' => '号码描述', 'type' => 'string', 'example' => '无'], + 'Province' => ['description' => '省份', 'type' => 'string', 'example' => '北京'], + 'Concurrency' => ['description' => '并发量，默认是1'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'SkillGroupIdList' => [ 'type' => 'array', - 'items' => [ - 'description' => '技能组ID集合', - 'type' => 'string', - 'example' => '[]', - ], + 'items' => ['description' => '技能组ID集合', 'type' => 'string', 'example' => '[]'], ], ], ], @@ -5518,14 +2781,8 @@ ], 'AddBulkPhoneNumbers' => [ 'summary' => '调用AddBulkPhoneNumbers批量新增号码。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5540,44 +2797,25 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待添加电话号码的呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012****', - ], + 'schema' => ['description' => '待添加电话号码的呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012****'], ], [ 'name' => 'Usage', 'in' => 'query', - 'schema' => [ - 'description' => '该电话号码的用途。取值：**Inbound**（呼入），**Outboung**（呼出），**Bidirection**（同时用于呼入和呼出）。'."\n" - ."\n" - .'> 如果传入的号码包含400号码，该值只能传入**Inbound**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Bidirection', - ], + 'schema' => ['description' => '该电话号码的用途。取值：**Inbound**（呼入），**Outboung**（呼出），**Bidirection**（同时用于呼入和呼出）。'."\n" + ."\n" + .'> 如果传入的号码包含400号码，该值只能传入**Inbound**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Bidirection'], ], [ 'name' => 'ContactFlowId', 'in' => 'query', - 'schema' => [ - 'description' => '和电话号码绑定的联系流ID。', - 'type' => 'string', - 'required' => false, - 'example' => '8Cvg_0mcsm6K', - ], + 'schema' => ['description' => '和电话号码绑定的联系流ID。', 'type' => 'string', 'required' => false, 'example' => '8Cvg_0mcsm6K'], ], [ 'name' => 'PhoneNumber', @@ -5588,9 +2826,7 @@ ."\n" .'参数名称为**PhoneNumber.1**表示只获取1个技能组信息，如果要获取多个技能组信息，则需要有PhoneNumber.1以及PhoneNumber.2，以此类推。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'example' => '0216066****', 'maxItems' => 99, @@ -5605,9 +2841,7 @@ ."\n" .'参数名称为**SkillGroupId.1**表示只获取1个技能组信息。如果要获取多个技能组信息，则需要有SkillGroupId.1以及SkillGroupId.2，以此类推。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0', 'maxItems' => 99, @@ -5619,43 +2853,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], 'ArrearagePhoneNumbers' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ArrearagePhoneNumber' => [ 'type' => 'array', - 'items' => [ - 'description' => '欠费号码的信息。', - 'type' => 'string', - 'example' => '{"ArrearagePhoneNumber":[ ]}', - ], + 'items' => ['description' => '欠费号码的信息。', 'type' => 'string', 'example' => '{"ArrearagePhoneNumber":[ ]}'], ], ], ], @@ -5665,11 +2874,7 @@ 'properties' => [ 'FailedPhoneNumber' => [ 'type' => 'array', - 'items' => [ - 'description' => '添加失败号码的信息。', - 'type' => 'string', - 'example' => '{"FailedPhoneNumber":[ ]}', - ], + 'items' => ['description' => '添加失败号码的信息。', 'type' => 'string', 'example' => '{"FailedPhoneNumber":[ ]}'], ], ], ], @@ -5679,11 +2884,7 @@ 'properties' => [ 'UserdPhoneNumber' => [ 'type' => 'array', - 'items' => [ - 'description' => '已经被使用号码的信息。', - 'type' => 'string', - 'example' => '{"UserdPhoneNumber":[ ]}', - ], + 'items' => ['description' => '已经被使用号码的信息。', 'type' => 'string', 'example' => '{"UserdPhoneNumber":[ ]}'], ], ], ], @@ -5697,65 +2898,27 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'TestOnly' => [ - 'description' => '是否是测试号码。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Trunks' => [ - 'description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'RemainingTime' => [ - 'description' => '测试号码剩余的通话时间。单位为分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'Number' => [ - 'description' => '电话号码。', - 'type' => 'string', - 'example' => '1788888****', - ], - 'InstanceId' => [ - 'description' => '电话号码所归属的呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], - 'Usage' => [ - 'description' => '电话号码的用途，呼入（**Inbound**），呼出（**Outbound**），已经同时用于呼入和呼出（**Bidirection**）。上述值由枚举类型PhoneNumberType定义。'."\n" - ."\n" - .'该值的结果取决于：'."\n" - ."\n" - .'- 大于的设置，比如400号码不允许外呼'."\n" - .'- 呼叫中心实例的设置'."\n" - ."\n" - .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音。2）该号码不连接人和联系流IVR，但是ACC不建议这么做。', - 'type' => 'string', - 'example' => 'Bidirection', - ], - 'AllowOutbound' => [ - 'description' => '是否允许外呼，结果取决于：'."\n" - ."\n" - .'- 大于的设置，比如400号码不允许外呼'."\n" - .'- 呼叫中心实例的设置'."\n" - ."\n" - .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不绑定联系流IVR，但是ACC不建议这么做。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PhoneNumberDescription' => [ - 'description' => '电话号码的简单描述。', - 'type' => 'string', - 'example' => 'xxx', - ], - 'PhoneNumberId' => [ - 'description' => '电话号码ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '125435986', - ], + 'TestOnly' => ['description' => '是否是测试号码。', 'type' => 'boolean', 'example' => 'true'], + 'Trunks' => ['description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'RemainingTime' => ['description' => '测试号码剩余的通话时间。单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'Number' => ['description' => '电话号码。', 'type' => 'string', 'example' => '1788888****'], + 'InstanceId' => ['description' => '电话号码所归属的呼叫中心实例ID。', 'type' => 'string', 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], + 'Usage' => ['description' => '电话号码的用途，呼入（**Inbound**），呼出（**Outbound**），已经同时用于呼入和呼出（**Bidirection**）。上述值由枚举类型PhoneNumberType定义。'."\n" + ."\n" + .'该值的结果取决于：'."\n" + ."\n" + .'- 大于的设置，比如400号码不允许外呼'."\n" + .'- 呼叫中心实例的设置'."\n" + ."\n" + .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音。2）该号码不连接人和联系流IVR，但是ACC不建议这么做。', 'type' => 'string', 'example' => 'Bidirection'], + 'AllowOutbound' => ['description' => '是否允许外呼，结果取决于：'."\n" + ."\n" + .'- 大于的设置，比如400号码不允许外呼'."\n" + .'- 呼叫中心实例的设置'."\n" + ."\n" + .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不绑定联系流IVR，但是ACC不建议这么做。', 'type' => 'boolean', 'example' => 'true'], + 'PhoneNumberDescription' => ['description' => '电话号码的简单描述。', 'type' => 'string', 'example' => 'xxx'], + 'PhoneNumberId' => ['description' => '电话号码ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '125435986'], 'SkillGroups' => [ 'type' => 'object', 'itemNode' => true, @@ -5766,16 +2929,8 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SkillGroupName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => '预测试外呼技能组', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0', - ], + 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '预测试外呼技能组'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0'], ], ], ], @@ -5785,31 +2940,11 @@ 'description' => '电话号码所连接的联系流IVR。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '流程类型, 定义来自于ContactFlowType。', - 'type' => 'string', - 'example' => '0', - ], - 'ContactFlowDescription' => [ - 'description' => '联系流的简单描述。', - 'type' => 'string', - 'example' => 'Welcome', - ], - 'InstanceId' => [ - 'description' => '联系流所归属的呼叫中心实例。', - 'type' => 'string', - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], - 'ContactFlowName' => [ - 'description' => '联系流名称，在一个实例内名称不能重复。', - 'type' => 'string', - 'example' => 'Welcome', - ], - 'ContactFlowId' => [ - 'description' => '联系流唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '2932', - ], + 'Type' => ['description' => '流程类型, 定义来自于ContactFlowType。', 'type' => 'string', 'example' => '0'], + 'ContactFlowDescription' => ['description' => '联系流的简单描述。', 'type' => 'string', 'example' => 'Welcome'], + 'InstanceId' => ['description' => '联系流所归属的呼叫中心实例。', 'type' => 'string', 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], + 'ContactFlowName' => ['description' => '联系流名称，在一个实例内名称不能重复。', 'type' => 'string', 'example' => 'Welcome'], + 'ContactFlowId' => ['description' => '联系流唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '2932'], ], ], ], @@ -5831,14 +2966,8 @@ ], 'AddPhoneNumber' => [ 'summary' => '调用AddPhoneNumber新增号码。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5853,52 +2982,30 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREccc1MRAID', - ], + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待添加电话号码的呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '待添加电话号码的呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'PhoneNumber', 'in' => 'query', - 'schema' => [ - 'description' => '待添加电话号码。', - 'type' => 'string', - 'required' => true, - 'example' => '05316896****', - ], + 'schema' => ['description' => '待添加电话号码。', 'type' => 'string', 'required' => true, 'example' => '05316896****'], ], [ 'name' => 'Usage', 'in' => 'query', - 'schema' => [ - 'description' => '该电话号码的用途。取值：呼入（**Inbound**），呼出（**Outboung**），已经同时用于呼入和呼出（**Bidirection**）。'."\n" - ."\n" - .'> 如果传入号码为400号码，该值只能传入**Inbound**。', - 'type' => 'string', - 'required' => true, - 'example' => 'Bidirection', - ], + 'schema' => ['description' => '该电话号码的用途。取值：呼入（**Inbound**），呼出（**Outboung**），已经同时用于呼入和呼出（**Bidirection**）。'."\n" + ."\n" + .'> 如果传入号码为400号码，该值只能传入**Inbound**。', 'type' => 'string', 'required' => true, 'example' => 'Bidirection'], ], [ 'name' => 'ContactFlowId', 'in' => 'query', - 'schema' => [ - 'description' => '和电话号码绑定的联系流ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'dDMD_0mif4hv', - ], + 'schema' => ['description' => '和电话号码绑定的联系流ID。', 'type' => 'string', 'required' => false, 'example' => 'dDMD_0mif4hv'], ], ], 'responses' => [ @@ -5906,124 +3013,45 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'PhoneNumber' => [ 'description' => '新添加的电话号码的信息', 'type' => 'object', 'properties' => [ - 'TestOnly' => [ - 'description' => '是否是测试号码。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Trunks' => [ - 'description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'RemainingTime' => [ - 'description' => '测试号码剩余的通话时间。单位为分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'Number' => [ - 'description' => '电话号码。', - 'type' => 'string', - 'example' => '1788888****', - ], - 'InstanceId' => [ - 'description' => '电话号码所归属的呼叫中心实例ID。', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], - 'Usage' => [ - 'description' => '电话号码的用途。取值：呼入（Inbound），呼出（Outbound），已经同时用于呼入和呼出（Bidirection）上述值由枚举类型PhoneNumberType定义。'."\n" - ."\n" - .'该值的结果取决于：'."\n" - ."\n" - .'- 大于的设置，比如400号码不允许外呼'."\n" - .'- 呼叫中心实例的设置'."\n" - ."\n" - .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不连接人和联系流IVR，但是ACC不建议这么做。', - 'type' => 'string', - 'example' => 'Bidirection', - ], - 'AllowOutbound' => [ - 'description' => '是否允许外呼，结果取决于：'."\n" - ."\n" - .'- 大于的设置，比如400号码不允许外呼'."\n" - .'- 呼叫中心实例的设置'."\n" - ."\n" - .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不绑定联系流IVR，但是ACC不建议这么做。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PhoneNumberDescription' => [ - 'description' => '电话号码的简单描述。', - 'type' => 'string', - 'example' => '无', - ], - 'PhoneNumberId' => [ - 'description' => '电话号码ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '9191956d-3464-402b-8017-ea8df5d8****', - ], + 'TestOnly' => ['description' => '是否是测试号码。', 'type' => 'boolean', 'example' => 'true'], + 'Trunks' => ['description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'RemainingTime' => ['description' => '测试号码剩余的通话时间。单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'Number' => ['description' => '电话号码。', 'type' => 'string', 'example' => '1788888****'], + 'InstanceId' => ['description' => '电话号码所归属的呼叫中心实例ID。', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], + 'Usage' => ['description' => '电话号码的用途。取值：呼入（Inbound），呼出（Outbound），已经同时用于呼入和呼出（Bidirection）上述值由枚举类型PhoneNumberType定义。'."\n" + ."\n" + .'该值的结果取决于：'."\n" + ."\n" + .'- 大于的设置，比如400号码不允许外呼'."\n" + .'- 呼叫中心实例的设置'."\n" + ."\n" + .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不连接人和联系流IVR，但是ACC不建议这么做。', 'type' => 'string', 'example' => 'Bidirection'], + 'AllowOutbound' => ['description' => '是否允许外呼，结果取决于：'."\n" + ."\n" + .'- 大于的设置，比如400号码不允许外呼'."\n" + .'- 呼叫中心实例的设置'."\n" + ."\n" + .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不绑定联系流IVR，但是ACC不建议这么做。', 'type' => 'boolean', 'example' => 'true'], + 'PhoneNumberDescription' => ['description' => '电话号码的简单描述。', 'type' => 'string', 'example' => '无'], + 'PhoneNumberId' => ['description' => '电话号码ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '9191956d-3464-402b-8017-ea8df5d8****'], 'ContactFlow' => [ 'description' => '电话号码所连接的联系流IVR。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '流程类型, 定义来自于ContactFlowType。', - 'type' => 'string', - 'example' => '0', - ], - 'ContactFlowDescription' => [ - 'description' => '联系流的简单描述。', - 'type' => 'string', - 'example' => 'Welcome', - ], - 'InstanceId' => [ - 'description' => '联系流所归属的呼叫中心实例。', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], - 'ContactFlowName' => [ - 'description' => '联系流名称，在一个实例内名称不能重复。', - 'type' => 'string', - 'example' => 'Welcome', - ], - 'ContactFlowId' => [ - 'description' => '联系流唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '2957', - ], + 'Type' => ['description' => '流程类型, 定义来自于ContactFlowType。', 'type' => 'string', 'example' => '0'], + 'ContactFlowDescription' => ['description' => '联系流的简单描述。', 'type' => 'string', 'example' => 'Welcome'], + 'InstanceId' => ['description' => '联系流所归属的呼叫中心实例。', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], + 'ContactFlowName' => ['description' => '联系流名称，在一个实例内名称不能重复。', 'type' => 'string', 'example' => 'Welcome'], + 'ContactFlowId' => ['description' => '联系流唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '2957'], ], ], ], @@ -6042,14 +3070,8 @@ ], 'ModifyPhoneNumber' => [ 'summary' => '比如内呼和外呼属性以及绑定的IVR流程。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6064,53 +3086,28 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], ], [ 'name' => 'PhoneNumberId', 'in' => 'query', - 'schema' => [ - 'description' => '待修改的电话号码ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc583e96-6bae-437e-9aeb-bffd5aeddb73', - ], + 'schema' => ['description' => '待修改的电话号码ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc583e96-6bae-437e-9aeb-bffd5aeddb73'], ], [ 'name' => 'Usage', 'in' => 'query', - 'schema' => [ - 'description' => '该电话号码的用途。取值：呼入（**Inbound**），呼出（**Outbound**），已经同时用于呼入和呼出（**Bidirection**）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Bidirection', - ], + 'schema' => ['description' => '该电话号码的用途。取值：呼入（**Inbound**），呼出（**Outbound**），已经同时用于呼入和呼出（**Bidirection**）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Bidirection'], ], [ 'name' => 'ContactFlowId', 'in' => 'query', - 'schema' => [ - 'description' => '和电话号码绑定的联系流ID', - 'type' => 'string', - 'required' => false, - 'example' => '8Cvg_0mcsm6', - ], + 'schema' => ['description' => '和电话号码绑定的联系流ID', 'type' => 'string', 'required' => false, 'example' => '8Cvg_0mcsm6'], ], [ 'name' => 'SkillGroupId', @@ -6121,9 +3118,7 @@ ."\n\n" .'参数名称**SkillGroupId.1**表示只获取1个技能组信息。如果要获取多个技能组信息，则需要有SkillGroupId.1以及SkillGroupId.2。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0', 'maxItems' => 99, @@ -6135,95 +3130,36 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '54F6A60E-541A-4C3B-8A9D-F69FEA9DD704', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '54F6A60E-541A-4C3B-8A9D-F69FEA9DD704'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'PhoneNumber' => [ 'description' => '电话号码信息', 'type' => 'object', 'properties' => [ - 'TestOnly' => [ - 'description' => '是否是测试号码。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Trunks' => [ - 'description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'RemainingTime' => [ - 'description' => '测试号码剩余的通话时间。单位为分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'Number' => [ - 'description' => '电话号码。', - 'type' => 'string', - 'example' => '17788888888', - ], - 'InstanceId' => [ - 'description' => '电话号码所归属的呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], - 'Usage' => [ - 'description' => '电话号码的用途，呼入（**Inbound**），呼出（**Outbound**），已经同时用于呼入和呼出（**Bidirection**）。上述值由枚举类型PhoneNumberType定义。'."\n" - ."\n" - .'该值的结果取决于：'."\n" - ."\n" - .'- 大于的设置，比如400号码不允许外呼'."\n" - .'- 呼叫中心实例的设置'."\n" - ."\n" - .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不连接人和联系流IVR，但是ACC不建议这么做。', - 'type' => 'string', - 'example' => 'Bidirection', - ], - 'AllowOutbound' => [ - 'description' => '是否允许外呼，结果取决于：'."\n" - ."\n" - .'- 大于的设置，比如400号码不允许外呼'."\n" - .'- 呼叫中心实例的设置'."\n" - ."\n" - .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不绑定联系流IVR，但是ACC不建议这么做。'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'PhoneNumberDescription' => [ - 'description' => '电话号码的简单描述。', - 'type' => 'string', - 'example' => 'Ali Telecom', - ], - 'PhoneNumberId' => [ - 'description' => '电话号码ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '346489', - ], + 'TestOnly' => ['description' => '是否是测试号码。', 'type' => 'boolean', 'example' => 'false'], + 'Trunks' => ['description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'RemainingTime' => ['description' => '测试号码剩余的通话时间。单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'Number' => ['description' => '电话号码。', 'type' => 'string', 'example' => '17788888888'], + 'InstanceId' => ['description' => '电话号码所归属的呼叫中心实例ID。', 'type' => 'string', 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], + 'Usage' => ['description' => '电话号码的用途，呼入（**Inbound**），呼出（**Outbound**），已经同时用于呼入和呼出（**Bidirection**）。上述值由枚举类型PhoneNumberType定义。'."\n" + ."\n" + .'该值的结果取决于：'."\n" + ."\n" + .'- 大于的设置，比如400号码不允许外呼'."\n" + .'- 呼叫中心实例的设置'."\n" + ."\n" + .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不连接人和联系流IVR，但是ACC不建议这么做。', 'type' => 'string', 'example' => 'Bidirection'], + 'AllowOutbound' => ['description' => '是否允许外呼，结果取决于：'."\n" + ."\n" + .'- 大于的设置，比如400号码不允许外呼'."\n" + .'- 呼叫中心实例的设置'."\n" + ."\n" + .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不绑定联系流IVR，但是ACC不建议这么做。'."\n", 'type' => 'boolean', 'example' => 'true'], + 'PhoneNumberDescription' => ['description' => '电话号码的简单描述。', 'type' => 'string', 'example' => 'Ali Telecom'], + 'PhoneNumberId' => ['description' => '电话号码ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '346489'], 'SkillGroups' => [ 'type' => 'object', 'itemNode' => true, @@ -6234,16 +3170,8 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SkillGroupName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => '预测试外呼技能组', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0', - ], + 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '预测试外呼技能组'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0'], ], ], ], @@ -6253,31 +3181,11 @@ 'description' => '电话号码所连接的联系流IVR。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '流程类型, 定义来自于ContactFlowType。', - 'type' => 'string', - 'example' => '0', - ], - 'ContactFlowDescription' => [ - 'description' => '联系流的简单描述。', - 'type' => 'string', - 'example' => 'Welcome', - ], - 'InstanceId' => [ - 'description' => '联系流所归属的呼叫中心实例。', - 'type' => 'string', - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], - 'ContactFlowName' => [ - 'description' => '联系流名称，在一个实例内名称不能重复。', - 'type' => 'string', - 'example' => 'Welcome', - ], - 'ContactFlowId' => [ - 'description' => '联系流唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '2932', - ], + 'Type' => ['description' => '流程类型, 定义来自于ContactFlowType。', 'type' => 'string', 'example' => '0'], + 'ContactFlowDescription' => ['description' => '联系流的简单描述。', 'type' => 'string', 'example' => 'Welcome'], + 'InstanceId' => ['description' => '联系流所归属的呼叫中心实例。', 'type' => 'string', 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], + 'ContactFlowName' => ['description' => '联系流名称，在一个实例内名称不能重复。', 'type' => 'string', 'example' => 'Welcome'], + 'ContactFlowId' => ['description' => '联系流唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '2932'], ], ], ], @@ -6295,14 +3203,8 @@ ], 'GetNumberRegionInfo' => [ 'summary' => '调用GetNumberRegionInfo获取号码归属地信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6316,32 +3218,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREccc8HB4RI', - ], + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'Number', 'in' => 'query', - 'schema' => [ - 'description' => '电话号码', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1888888****', - ], + 'schema' => ['description' => '电话号码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1888888****'], ], ], 'responses' => [ @@ -6349,45 +3237,17 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'PhoneNumber' => [ 'description' => '号码及其归属地', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'description' => '号码', - 'type' => 'string', - 'example' => '1888888****', - ], - 'City' => [ - 'description' => '号码归属地市', - 'type' => 'string', - 'example' => '北京', - ], - 'Province' => [ - 'description' => '号码归属地省', - 'type' => 'string', - 'example' => '北京', - ], + 'Number' => ['description' => '号码', 'type' => 'string', 'example' => '1888888****'], + 'City' => ['description' => '号码归属地市', 'type' => 'string', 'example' => '北京'], + 'Province' => ['description' => '号码归属地省', 'type' => 'string', 'example' => '北京'], ], ], ], @@ -6403,14 +3263,8 @@ ], 'GetServiceExtensions' => [ 'summary' => '调用GetServiceExtensions获取服务号码，。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6424,32 +3278,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'ServiceType', 'in' => 'query', - 'schema' => [ - 'description' => '需要获取的服务号码的服务类型，比如满意度调查（SatisfactionSurvey）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SatisfactionSurvey', - ], + 'schema' => ['description' => '需要获取的服务号码的服务类型，比如满意度调查（SatisfactionSurvey）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SatisfactionSurvey'], ], ], 'responses' => [ @@ -6457,32 +3297,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C40E28B8-9EDF-421E-8F6B-B77F0E2A82E0', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'C40E28B8-9EDF-421E-8F6B-B77F0E2A82E0'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'ServiceExtensions' => [ 'type' => 'object', 'itemNode' => true, @@ -6493,16 +3312,8 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Number' => [ - 'description' => '服务号码', - 'type' => 'string', - 'example' => '80202768', - ], - 'Name' => [ - 'description' => '服务名称', - 'type' => 'string', - 'example' => 'SatisfactionSurvey', - ], + 'Number' => ['description' => '服务号码', 'type' => 'string', 'example' => '80202768'], + 'Name' => ['description' => '服务名称', 'type' => 'string', 'example' => 'SatisfactionSurvey'], ], ], ], @@ -6522,14 +3333,8 @@ ], 'ListPhoneNumbers' => [ 'summary' => '获取呼叫中心实例的所有电话号码。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6543,32 +3348,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREccc1MRAID', - ], + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取电话号码的呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '待获取电话号码的呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'OutboundOnly', 'in' => 'query', - 'schema' => [ - 'description' => '仅包含外呼电话号码', - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'false', - ], + 'schema' => ['description' => '仅包含外呼电话号码', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false'], ], ], 'responses' => [ @@ -6576,32 +3367,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'D38E508B-5190-4E1A-AA88-709B0BA547A3', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D38E508B-5190-4E1A-AA88-709B0BA547A3'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'PhoneNumbers' => [ 'type' => 'object', 'itemNode' => true, @@ -6612,91 +3382,32 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'TestOnly' => [ - 'description' => '是否是测试号码。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'SipTelX' => [ - 'description' => 'sip虚拟号码', - 'type' => 'string', - 'example' => '1970169****', - ], - 'RemainingTime' => [ - 'description' => '测试号码剩余的通话时间。单位为分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'City' => [ - 'description' => '电话号码的城市。', - 'type' => 'string', - 'example' => '杭州', - ], - 'InstanceId' => [ - 'description' => '电话号码所归属的呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d****', - ], - 'AllowOutbound' => [ - 'description' => '是否允许外呼，结果取决于：'."\n" - ."\n" - .'- 大于的设置，比如400号码不允许外呼'."\n" - .'- 呼叫中心实例的设置'."\n" - ."\n" - .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不绑定联系流IVR，但是ACC不建议这么做。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Usage' => [ - 'description' => '电话号码的用途，呼入（Inbound），呼出（Outbound），已经同时用于呼入和呼出（Bidirection）。上述值由枚举类型PhoneNumberType定义。'."\n" - ."\n" - .'该值的结果取决于：'."\n" - ."\n" - .'- 大于的设置，比如400号码不允许外呼'."\n" - .'- 呼叫中心实例的设置'."\n" - ."\n" - .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不连接人和联系流IVR，但是ACC不建议这么做。', - 'type' => 'string', - 'example' => 'Bidirection', - ], - 'Assignee' => [ - 'description' => '号码占用者,如技能组ID', - 'type' => 'string', - 'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f****', - ], - 'PhoneNumberId' => [ - 'description' => '电话号码ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '0010faaa-0c07-4421-8929-9ea6a051****', - ], - 'Trunks' => [ - 'description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Number' => [ - 'description' => '电话号码。', - 'type' => 'string', - 'example' => '05712823****', - ], - 'PhoneNumberDescription' => [ - 'description' => '电话号码的简单描述。', - 'type' => 'string', - 'example' => 'Ali Telecom', - ], - 'NumberCommodityStatus' => [ - 'description' => '号码商品状态 0 正常 1 欠费 2 实例已删除', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Province' => [ - 'description' => '电话号码的省份。', - 'type' => 'string', - 'example' => '浙江', - ], + 'TestOnly' => ['description' => '是否是测试号码。', 'type' => 'boolean', 'example' => 'false'], + 'SipTelX' => ['description' => 'sip虚拟号码', 'type' => 'string', 'example' => '1970169****'], + 'RemainingTime' => ['description' => '测试号码剩余的通话时间。单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'City' => ['description' => '电话号码的城市。', 'type' => 'string', 'example' => '杭州'], + 'InstanceId' => ['description' => '电话号码所归属的呼叫中心实例ID。', 'type' => 'string', 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d****'], + 'AllowOutbound' => ['description' => '是否允许外呼，结果取决于：'."\n" + ."\n" + .'- 大于的设置，比如400号码不允许外呼'."\n" + .'- 呼叫中心实例的设置'."\n" + ."\n" + .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不绑定联系流IVR，但是ACC不建议这么做。', 'type' => 'boolean', 'example' => 'true'], + 'Usage' => ['description' => '电话号码的用途，呼入（Inbound），呼出（Outbound），已经同时用于呼入和呼出（Bidirection）。上述值由枚举类型PhoneNumberType定义。'."\n" + ."\n" + .'该值的结果取决于：'."\n" + ."\n" + .'- 大于的设置，比如400号码不允许外呼'."\n" + .'- 呼叫中心实例的设置'."\n" + ."\n" + .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不连接人和联系流IVR，但是ACC不建议这么做。', 'type' => 'string', 'example' => 'Bidirection'], + 'Assignee' => ['description' => '号码占用者,如技能组ID', 'type' => 'string', 'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f****'], + 'PhoneNumberId' => ['description' => '电话号码ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '0010faaa-0c07-4421-8929-9ea6a051****'], + 'Trunks' => ['description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'Number' => ['description' => '电话号码。', 'type' => 'string', 'example' => '05712823****'], + 'PhoneNumberDescription' => ['description' => '电话号码的简单描述。', 'type' => 'string', 'example' => 'Ali Telecom'], + 'NumberCommodityStatus' => ['description' => '号码商品状态 0 正常 1 欠费 2 实例已删除', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Province' => ['description' => '电话号码的省份。', 'type' => 'string', 'example' => '浙江'], 'SkillGroups' => [ 'type' => 'object', 'itemNode' => true, @@ -6707,16 +3418,8 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SkillGroupName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => '预测试外呼技能组', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f****', - ], + 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '预测试外呼技能组'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f****'], ], ], ], @@ -6726,82 +3429,26 @@ 'description' => '电话号码所连接的联系流IVR。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '流程类型, 定义来自于ContactFlowType。', - 'type' => 'string', - 'example' => '0', - ], - 'ContactFlowDescription' => [ - 'description' => '联系流的简单描述。', - 'type' => 'string', - 'example' => 'Welcome', - ], - 'InstanceId' => [ - 'description' => '联系流所归属的呼叫中心实例。', - 'type' => 'string', - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012****', - ], - 'ContactFlowName' => [ - 'description' => '联系流名称，在一个实例内名称不能重复。', - 'type' => 'string', - 'example' => 'Welcome', - ], - 'ContactFlowId' => [ - 'description' => '联系流唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '2932', - ], + 'Type' => ['description' => '流程类型, 定义来自于ContactFlowType。', 'type' => 'string', 'example' => '0'], + 'ContactFlowDescription' => ['description' => '联系流的简单描述。', 'type' => 'string', 'example' => 'Welcome'], + 'InstanceId' => ['description' => '联系流所归属的呼叫中心实例。', 'type' => 'string', 'example' => 'd278629c-c687-4aa3-b044-4fe9b012****'], + 'ContactFlowName' => ['description' => '联系流名称，在一个实例内名称不能重复。', 'type' => 'string', 'example' => 'Welcome'], + 'ContactFlowId' => ['description' => '联系流唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '2932'], ], ], 'PrivacyNumber' => [ 'description' => '电话号码所绑定的虚拟号码关系。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '选择绑定虚拟号码的类型，包括**AXN**和**AXB**。', - 'type' => 'string', - 'example' => 'AXN', - ], - 'PoolId' => [ - 'description' => '虚拟号码所在池子ID。', - 'type' => 'string', - 'example' => '18b74553-484f-40c7-b6f9-81be0cbe****', - ], - 'SubId' => [ - 'description' => '类型为AXN，返回的绑定关系唯一标识，若类型为AXB，则此字段为空。', - 'type' => 'string', - 'example' => '6a5f6c7c2f774fb38b4aaf35c4e7****', - ], - 'PhoneNumber' => [ - 'description' => '绑定的呼叫中心号码。', - 'type' => 'string', - 'example' => '05712823****', - ], - 'PoolName' => [ - 'description' => '虚拟号码池名称。', - 'type' => 'string', - 'example' => '个人虚拟号码', - ], - 'BizId' => [ - 'description' => '第三方业务ID。', - 'type' => 'string', - 'example' => '4b32b62d3aae4d86a6c4bb26c3ee****', - ], - 'RegionNameCity' => [ - 'description' => '虚拟号码归属地市。', - 'type' => 'string', - 'example' => '上海市', - ], - 'Extra' => [ - 'description' => '其他参数，以Json字符串存入。', - 'type' => 'string', - 'example' => '{"name":"amy","cardno":"1****************9"}', - ], - 'TelX' => [ - 'description' => '选择AXN模式绑定的虚拟号码，若类型为AXB，则此字段为空。', - 'type' => 'string', - 'example' => '1302015****', - ], + 'Type' => ['description' => '选择绑定虚拟号码的类型，包括**AXN**和**AXB**。', 'type' => 'string', 'example' => 'AXN'], + 'PoolId' => ['description' => '虚拟号码所在池子ID。', 'type' => 'string', 'example' => '18b74553-484f-40c7-b6f9-81be0cbe****'], + 'SubId' => ['description' => '类型为AXN，返回的绑定关系唯一标识，若类型为AXB，则此字段为空。', 'type' => 'string', 'example' => '6a5f6c7c2f774fb38b4aaf35c4e7****'], + 'PhoneNumber' => ['description' => '绑定的呼叫中心号码。', 'type' => 'string', 'example' => '05712823****'], + 'PoolName' => ['description' => '虚拟号码池名称。', 'type' => 'string', 'example' => '个人虚拟号码'], + 'BizId' => ['description' => '第三方业务ID。', 'type' => 'string', 'example' => '4b32b62d3aae4d86a6c4bb26c3ee****'], + 'RegionNameCity' => ['description' => '虚拟号码归属地市。', 'type' => 'string', 'example' => '上海市'], + 'Extra' => ['description' => '其他参数，以Json字符串存入。', 'type' => 'string', 'example' => '{"name":"amy","cardno":"1****************9"}'], + 'TelX' => ['description' => '选择AXN模式绑定的虚拟号码，若类型为AXB，则此字段为空。', 'type' => 'string', 'example' => '1302015****'], ], ], ], @@ -6822,14 +3469,8 @@ ], 'CheckNumberAvaliable' => [ 'summary' => '判断主被叫号码是否可用，主要是限制号码外呼频次。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6844,42 +3485,23 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'Callee', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '18801341234', - ], + 'schema' => ['description' => '被叫号码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '18801341234'], ], [ 'name' => 'Caller', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心主叫号码', - 'type' => 'string', - 'required' => false, - 'example' => '01012345678', - ], + 'schema' => ['description' => '呼叫中心主叫号码', 'type' => 'string', 'required' => false, 'example' => '01012345678'], ], ], 'responses' => [ @@ -6887,66 +3509,29 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码'."\n" - ."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID'."\n" - ."\n", - 'type' => 'string', - 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3', - ], - 'Success' => [ - 'description' => '是否成功'."\n" - ."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码'."\n" + ."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID'."\n" + ."\n", 'type' => 'string', 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3'], + 'Success' => ['description' => '是否成功'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true'], 'CallerAvaliable' => [ 'description' => '主叫号码的相关信息', 'type' => 'object', 'properties' => [ - 'Avaliable' => [ - 'description' => '是否可用', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Reason' => [ - 'description' => '如果可用不返回，不可用返回原因，例："Instance Blacklist: Number 18801341234 can not be called from current instance", "System Blacklist: Number 18801341234 can not be called from all ccc users", "System Blacklist: Number 18801341234 can not be called from current ccc user", "Outbound Control: Number 18801341234\'s call times beyonds limit, 3 times/h"', - 'type' => 'string', - 'example' => 'Instance Blacklist: Number 18801341234 can not be called from current instance', - ], + 'Avaliable' => ['description' => '是否可用', 'type' => 'boolean', 'example' => 'true'], + 'Reason' => ['description' => '如果可用不返回，不可用返回原因，例："Instance Blacklist: Number 18801341234 can not be called from current instance", "System Blacklist: Number 18801341234 can not be called from all ccc users", "System Blacklist: Number 18801341234 can not be called from current ccc user", "Outbound Control: Number 18801341234\'s call times beyonds limit, 3 times/h"', 'type' => 'string', 'example' => 'Instance Blacklist: Number 18801341234 can not be called from current instance'], ], ], 'CalleeAvaliable' => [ 'description' => '被叫号码相关信息', 'type' => 'object', 'properties' => [ - 'Avaliable' => [ - 'description' => '是否可用', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Reason' => [ - 'description' => '如果可用不返回，不可用返回原因，例："Instance Blacklist: Number 18801341234 can not be called from current instance", "System Blacklist: Number 18801341234 can not be called from all ccc users", "System Blacklist: Number 18801341234 can not be called from current ccc user", "Outbound Control: Number 18801341234\'s call times beyonds limit, 3 times/h"', - 'type' => 'string', - 'example' => 'Instance Blacklist: Number 18801341234 can not be called from current instance', - ], + 'Avaliable' => ['description' => '是否可用', 'type' => 'boolean', 'example' => 'true'], + 'Reason' => ['description' => '如果可用不返回，不可用返回原因，例："Instance Blacklist: Number 18801341234 can not be called from current instance", "System Blacklist: Number 18801341234 can not be called from all ccc users", "System Blacklist: Number 18801341234 can not be called from current ccc user", "Outbound Control: Number 18801341234\'s call times beyonds limit, 3 times/h"', 'type' => 'string', 'example' => 'Instance Blacklist: Number 18801341234 can not be called from current instance'], ], ], ], @@ -6962,14 +3547,8 @@ ], 'PickOutboundNumbers' => [ 'summary' => '调用接口： PickOutboundNumbers 获取外呼号码。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6983,44 +3562,23 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'CalleeNumber', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '16578787****', - ], + 'schema' => ['description' => '被叫号码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '16578787****'], ], [ 'name' => 'Count', 'in' => 'query', - 'schema' => [ - 'description' => '选中的号码个数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '选中的号码个数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'CandidateNumber', @@ -7029,9 +3587,7 @@ 'schema' => [ 'description' => '候选主叫号码', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'example' => '0108976****', 'maxItems' => 99, @@ -7043,35 +3599,14 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码'."\n" - ."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码'."\n" + ."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'DialNumberPairs' => [ 'type' => 'object', 'itemNode' => true, @@ -7086,42 +3621,18 @@ 'description' => '被叫号码信息', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'description' => '号码', - 'type' => 'string', - 'example' => '165787876****', - ], - 'City' => [ - 'description' => '城市', - 'type' => 'string', - 'example' => '北京', - ], - 'Province' => [ - 'description' => '省份', - 'type' => 'string', - 'example' => '北京', - ], + 'Number' => ['description' => '号码', 'type' => 'string', 'example' => '165787876****'], + 'City' => ['description' => '城市', 'type' => 'string', 'example' => '北京'], + 'Province' => ['description' => '省份', 'type' => 'string', 'example' => '北京'], ], ], 'Caller' => [ 'description' => '主叫号码信息', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'description' => '号码', - 'type' => 'string', - 'example' => '01089767****', - ], - 'City' => [ - 'description' => '城市', - 'type' => 'string', - 'example' => '北京', - ], - 'Province' => [ - 'description' => '省份', - 'type' => 'string', - 'example' => '北京', - ], + 'Number' => ['description' => '号码', 'type' => 'string', 'example' => '01089767****'], + 'City' => ['description' => '城市', 'type' => 'string', 'example' => '北京'], + 'Province' => ['description' => '省份', 'type' => 'string', 'example' => '北京'], ], ], ], @@ -7143,14 +3654,8 @@ ], 'RemovePhoneNumber' => [ 'summary' => '和该电话号码绑定的IVR流程的关系也将被解绑，号码将无法呼入呼出。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7165,30 +3670,18 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREccc1MRAID', - ], + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待移除号码的呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '待移除号码的呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'PhoneNumberId', 'in' => 'query', - 'schema' => [ - 'description' => '待移除电话号码ID', - 'type' => 'string', - 'required' => true, - 'example' => '9fee6c73-bd0c-40e7-a012-4b97368bf235', - ], + 'schema' => ['description' => '待移除电话号码ID', 'type' => 'string', 'required' => true, 'example' => '9fee6c73-bd0c-40e7-a012-4b97368bf235'], ], ], 'responses' => [ @@ -7196,32 +3689,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C7BB5095-7479-4C48-93A7-483C1350B893', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'C7BB5095-7479-4C48-93A7-483C1350B893'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -7232,14 +3704,8 @@ ], 'PickGlobalOutboundNumbers' => [ 'summary' => '调用PickGlobalOutboundNumbers按照被叫归属地自主选择号码。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7253,53 +3719,28 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'CalleeNumber', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1599090****', - ], + 'schema' => ['description' => '被叫号码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1599090****'], ], [ 'name' => 'Count', 'in' => 'query', - 'schema' => [ - 'description' => '候选号码个数。可不传，默认为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => '候选号码个数。可不传，默认为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], ], [ 'name' => 'IsVirtual', 'in' => 'query', - 'schema' => [ - 'description' => '是否使用虚拟号码外呼', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '是否使用虚拟号码外呼', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'SkillGroupId', @@ -7310,9 +3751,7 @@ ."\n" .'如果该参数需要传多个，SkillGroupId.1、SkillGroupId.2、SkillGroupId.3，以此类推。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'example' => '5c412119-9e1c-4304-8484-2b2c8f56f9dc', 'maxItems' => 99, @@ -7324,32 +3763,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '5DA0BD19-066E-426D-B75E-65DF434A1A63', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '5DA0BD19-066E-426D-B75E-65DF434A1A63'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'DialNumberPairs' => [ 'type' => 'object', 'itemNode' => true, @@ -7364,42 +3782,18 @@ 'description' => '被叫号码', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'description' => '号码', - 'type' => 'string', - 'example' => '1880134****', - ], - 'City' => [ - 'description' => '号码归属地市', - 'type' => 'string', - 'example' => '北京', - ], - 'Province' => [ - 'description' => '号码归属地省', - 'type' => 'string', - 'example' => '北京', - ], + 'Number' => ['description' => '号码', 'type' => 'string', 'example' => '1880134****'], + 'City' => ['description' => '号码归属地市', 'type' => 'string', 'example' => '北京'], + 'Province' => ['description' => '号码归属地省', 'type' => 'string', 'example' => '北京'], ], ], 'Caller' => [ 'description' => '主叫号码', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'description' => '号码', - 'type' => 'string', - 'example' => '0592329****', - ], - 'City' => [ - 'description' => '号码归属地市', - 'type' => 'string', - 'example' => '厦门', - ], - 'Province' => [ - 'description' => '号码归属地省', - 'type' => 'string', - 'example' => '福建', - ], + 'Number' => ['description' => '号码', 'type' => 'string', 'example' => '0592329****'], + 'City' => ['description' => '号码归属地市', 'type' => 'string', 'example' => '厦门'], + 'Province' => ['description' => '号码归属地省', 'type' => 'string', 'example' => '福建'], ], ], ], @@ -7423,14 +3817,8 @@ ], 'PickLocalNumber' => [ 'summary' => '根据本地号码优先策略选择号码。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7444,32 +3832,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccIPHVDY', - ], + 'abilityTreeNodes' => ['FEATUREcccIPHVDY'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'CalleeNumber', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1657865****', - ], + 'schema' => ['description' => '被叫号码', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1657865****'], ], [ 'name' => 'CandidateNumber', @@ -7478,9 +3852,7 @@ 'schema' => [ 'description' => '候选主叫号码', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'example' => '0108989****', 'maxItems' => 99, @@ -7492,26 +3864,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '号码信息', 'type' => 'object', @@ -7520,42 +3876,18 @@ 'description' => '被叫号码信息', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'description' => '号码', - 'type' => 'string', - 'example' => '1657865****', - ], - 'City' => [ - 'description' => '城市', - 'type' => 'string', - 'example' => '北京', - ], - 'Province' => [ - 'description' => '省份', - 'type' => 'string', - 'example' => '北京', - ], + 'Number' => ['description' => '号码', 'type' => 'string', 'example' => '1657865****'], + 'City' => ['description' => '城市', 'type' => 'string', 'example' => '北京'], + 'Province' => ['description' => '省份', 'type' => 'string', 'example' => '北京'], ], ], 'Caller' => [ 'description' => '主叫号码信息', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'description' => '号码', - 'type' => 'string', - 'example' => '0108989****', - ], - 'City' => [ - 'description' => '城市', - 'type' => 'string', - 'example' => '北京', - ], - 'Province' => [ - 'description' => '省份', - 'type' => 'string', - 'example' => '北京', - ], + 'Number' => ['description' => '号码', 'type' => 'string', 'example' => '0108989****'], + 'City' => ['description' => '城市', 'type' => 'string', 'example' => '北京'], + 'Province' => ['description' => '省份', 'type' => 'string', 'example' => '北京'], ], ], ], @@ -7574,14 +3906,8 @@ ], 'CreateInstance' => [ 'summary' => '调用CreateInstance新增呼叫中心实例。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7596,86 +3922,43 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREcccTMAX45', - ], + 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '待创建的呼叫中心实例的名称，账号下唯一。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '云呼测试', - ], + 'schema' => ['description' => '待创建的呼叫中心实例的名称，账号下唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '云呼测试'], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '待创建的呼叫中心实例的简单描述。', - 'type' => 'string', - 'required' => false, - 'example' => '测试', - ], + 'schema' => ['description' => '待创建的呼叫中心实例的简单描述。', 'type' => 'string', 'required' => false, 'example' => '测试'], ], [ 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '待创建的呼叫中心实例的二级域名，全局唯一。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cctest', - ], + 'schema' => ['description' => '待创建的呼叫中心实例的二级域名，全局唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cctest'], ], [ 'name' => 'StorageMaxDays', 'in' => 'query', - 'schema' => [ - 'description' => '录音文件最多存贮天数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '30', - ], + 'schema' => ['description' => '录音文件最多存贮天数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '30'], ], [ 'name' => 'StorageMaxSize', 'in' => 'query', - 'schema' => [ - 'description' => '录音文件最多存贮容量，单位GB。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1024', - ], + 'schema' => ['description' => '录音文件最多存贮容量，单位GB。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1024'], ], [ 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => '目录服务ID，即阿里云UID。', - 'type' => 'string', - 'required' => false, - 'example' => '1028571882648254', - ], + 'schema' => ['description' => '目录服务ID，即阿里云UID。', 'type' => 'string', 'required' => false, 'example' => '1028571882648254'], ], [ 'name' => 'PhoneNumber', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心对外服务的电话号码。', - 'type' => 'string', - 'required' => false, - 'example' => '010xxxx8557', - ], + 'schema' => ['description' => '呼叫中心对外服务的电话号码。', 'type' => 'string', 'required' => false, 'example' => '010xxxx8557'], ], [ 'name' => 'AdminRamId', @@ -7684,9 +3967,7 @@ 'schema' => [ 'description' => '待创建的呼叫中心实例管理员ID列表，如果不指定，则默认指定当前执行创建操作的用户为呼叫中心管理员。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '282075438293882116', 'maxItems' => 99, @@ -7699,9 +3980,7 @@ 'schema' => [ 'description' => '需要添加到呼叫中心的号码列表。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '无', 'maxItems' => 99, @@ -7714,9 +3993,7 @@ 'schema' => [ 'description' => '创建呼叫中心的同时创建多个用户。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '无', 'maxItems' => 99, @@ -7728,110 +4005,29 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Instance' => [ 'description' => '呼叫中心实例对象。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '实例状态。', - 'type' => 'string', - 'example' => 'Creating', - ], - 'Owner' => [ - 'description' => '呼叫中心系统规格所对应的阿里云账户ID。', - 'type' => 'string', - 'example' => '1028571882648254', - ], - 'StorageMaxDays' => [ - 'description' => '录音文件最多存贮天数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'StorageMaxSize' => [ - 'description' => '录音文件最多存贮容量，单位GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - ], - 'MaxOnlineAgents' => [ - 'description' => '呼叫中心实例的最大同时登陆在线的座席数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'e3jsl2e7-89wu-4d55-9812-80ysec29ueka', - ], - 'InstanceDescription' => [ - 'description' => '实例描述信息。', - 'type' => 'string', - 'example' => '测试', - ], - 'DomainName' => [ - 'description' => '呼叫中心的域名，全局唯一。', - 'type' => 'string', - 'example' => 'cctest', - ], - 'ConsoleUrl' => [ - 'description' => '呼叫中心实例的url地址。', - 'type' => 'string', - 'example' => 'ccc.aliyun.com/workbench/cctest', - ], - 'InstanceName' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'example' => '云呼测试', - ], - 'StorageBucket' => [ - 'description' => '录音文件存贮位置，如果不指定，则存放在一个公共的存贮空间。', - 'type' => 'string', - 'example' => 'cloudcallcenter-online', - ], - 'CreatedTime' => [ - 'description' => '实例创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1607181612000', - ], - 'DirectoryId' => [ - 'description' => '目录ID，即阿里云UID。', - 'type' => 'string', - 'example' => '1028571882648254', - ], - 'TenantId' => [ - 'description' => 'CC核心服务对应的租户ID。外表存贮。', - 'type' => 'string', - 'example' => 'acc2722', - ], + 'Status' => ['description' => '实例状态。', 'type' => 'string', 'example' => 'Creating'], + 'Owner' => ['description' => '呼叫中心系统规格所对应的阿里云账户ID。', 'type' => 'string', 'example' => '1028571882648254'], + 'StorageMaxDays' => ['description' => '录音文件最多存贮天数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'StorageMaxSize' => ['description' => '录音文件最多存贮容量，单位GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '1024'], + 'MaxOnlineAgents' => ['description' => '呼叫中心实例的最大同时登陆在线的座席数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'InstanceId' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'example' => 'e3jsl2e7-89wu-4d55-9812-80ysec29ueka'], + 'InstanceDescription' => ['description' => '实例描述信息。', 'type' => 'string', 'example' => '测试'], + 'DomainName' => ['description' => '呼叫中心的域名，全局唯一。', 'type' => 'string', 'example' => 'cctest'], + 'ConsoleUrl' => ['description' => '呼叫中心实例的url地址。', 'type' => 'string', 'example' => 'ccc.aliyun.com/workbench/cctest'], + 'InstanceName' => ['description' => '实例名称。', 'type' => 'string', 'example' => '云呼测试'], + 'StorageBucket' => ['description' => '录音文件存贮位置，如果不指定，则存放在一个公共的存贮空间。', 'type' => 'string', 'example' => 'cloudcallcenter-online'], + 'CreatedTime' => ['description' => '实例创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1607181612000'], + 'DirectoryId' => ['description' => '目录ID，即阿里云UID。', 'type' => 'string', 'example' => '1028571882648254'], + 'TenantId' => ['description' => 'CC核心服务对应的租户ID。外表存贮。', 'type' => 'string', 'example' => 'acc2722'], 'Admin' => [ 'type' => 'object', 'itemNode' => true, @@ -7842,50 +4038,18 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'e3jsl2e7-89wu-4d55-9812-80ysec29ueka', - ], - 'RamId' => [ - 'description' => 'RamId，即访问控制中的用户ID，或者是阿里云UID。', - 'type' => 'string', - 'example' => '1028571882648254', - ], - 'UserId' => [ - 'description' => '云呼UserId。', - 'type' => 'string', - 'example' => '9d-487c-96ad-9181d85cf802', - ], + 'InstanceId' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'example' => 'e3jsl2e7-89wu-4d55-9812-80ysec29ueka'], + 'RamId' => ['description' => 'RamId，即访问控制中的用户ID，或者是阿里云UID。', 'type' => 'string', 'example' => '1028571882648254'], + 'UserId' => ['description' => '云呼UserId。', 'type' => 'string', 'example' => '9d-487c-96ad-9181d85cf802'], 'Detail' => [ 'description' => '详情。', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'description' => '姓名。', - 'type' => 'string', - 'example' => '测试1', - ], - 'Email' => [ - 'description' => '电子邮箱地址。', - 'type' => 'string', - 'example' => 'xxxx@aliyun-inc.com', - ], - 'LoginName' => [ - 'description' => '阿里云登录名', - 'type' => 'string', - 'example' => 'cctest', - ], - 'Department' => [ - 'description' => '部门。', - 'type' => 'string', - 'example' => 'IT', - ], - 'Phone' => [ - 'description' => '联系电话。', - 'type' => 'string', - 'example' => '131xxxx3215', - ], + 'DisplayName' => ['description' => '姓名。', 'type' => 'string', 'example' => '测试1'], + 'Email' => ['description' => '电子邮箱地址。', 'type' => 'string', 'example' => 'xxxx@aliyun-inc.com'], + 'LoginName' => ['description' => '阿里云登录名', 'type' => 'string', 'example' => 'cctest'], + 'Department' => ['description' => '部门。', 'type' => 'string', 'example' => 'IT'], + 'Phone' => ['description' => '联系电话。', 'type' => 'string', 'example' => '131xxxx3215'], ], ], ], @@ -7903,53 +4067,15 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'TestOnly' => [ - 'description' => '是否为测试号码。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Trunks' => [ - 'description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RemainingTime' => [ - 'description' => '测试号码剩余的通话时间。单位为分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Number' => [ - 'description' => '号码。', - 'type' => 'string', - 'example' => '010xxxx8557', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'e3jsl2e7-89wu-4d55-9812-80ysec29ueka', - ], - 'Usage' => [ - 'description' => '电话号码的用途。', - 'type' => 'string', - 'example' => 'Outbound', - ], - 'AllowOutbound' => [ - 'description' => '是否可以外呼。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PhoneNumberDescription' => [ - 'description' => '号码描述信息。', - 'type' => 'string', - 'example' => '无', - ], - 'PhoneNumberId' => [ - 'description' => '号码ID。', - 'type' => 'string', - 'example' => 'd8beaee2-b6c5-407a-b290-54111wsu6aff', - ], + 'TestOnly' => ['description' => '是否为测试号码。', 'type' => 'boolean', 'example' => 'false'], + 'Trunks' => ['description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RemainingTime' => ['description' => '测试号码剩余的通话时间。单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '010xxxx8557'], + 'InstanceId' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'example' => 'e3jsl2e7-89wu-4d55-9812-80ysec29ueka'], + 'Usage' => ['description' => '电话号码的用途。', 'type' => 'string', 'example' => 'Outbound'], + 'AllowOutbound' => ['description' => '是否可以外呼。', 'type' => 'boolean', 'example' => 'true'], + 'PhoneNumberDescription' => ['description' => '号码描述信息。', 'type' => 'string', 'example' => '无'], + 'PhoneNumberId' => ['description' => '号码ID。', 'type' => 'string', 'example' => 'd8beaee2-b6c5-407a-b290-54111wsu6aff'], ], ], ], @@ -7961,11 +4087,7 @@ 'properties' => [ 'SuccessPhoneNumber' => [ 'type' => 'array', - 'items' => [ - 'description' => '导入成功的号码列表。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '导入成功的号码列表。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -7975,11 +4097,7 @@ 'properties' => [ 'SuccessLoginName' => [ 'type' => 'array', - 'items' => [ - 'description' => '导入成功的用户列表。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '导入成功的用户列表。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -7989,11 +4107,7 @@ 'properties' => [ 'FailPhoneNumber' => [ 'type' => 'array', - 'items' => [ - 'description' => '添加失败的电话号码。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '添加失败的电话号码。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -8003,11 +4117,7 @@ 'properties' => [ 'FailLoginName' => [ 'type' => 'array', - 'items' => [ - 'description' => '添加失败的用户名。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '添加失败的用户名。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -8026,13 +4136,8 @@ ], 'CreateVoiceAppraise' => [ 'summary' => '调用CreateVoiceAppraise开通实例的语音满意度。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8047,56 +4152,31 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取电话号码的呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], + 'schema' => ['description' => '待获取电话号码的呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], ], [ 'name' => 'ContactFlowVersionId', 'in' => 'query', - 'schema' => [ - 'description' => '联系流版本ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'EX9Q_1EATgHX', - ], + 'schema' => ['description' => '联系流版本ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'EX9Q_1EATgHX'], ], [ 'name' => 'Content', 'in' => 'formData', - 'schema' => [ - 'description' => '语音满意度内容。'."\n" - ."\n" - .'1. Content中需要注意设置的按键信息与提示音要对应。'."\n" - .'2. 按键信息与url.pressKeyMapping中的mapping中的内容要对应。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"nodeId":1,"nodeDescript":"开始","nextNodeId":2,"nodeType":"start","variables":["varDescript":"","varName":"satisfaction","varType":"string","varInitial":""}]', - ], + 'schema' => ['description' => '语音满意度内容。'."\n" + ."\n" + .'1. Content中需要注意设置的按键信息与提示音要对应。'."\n" + .'2. 按键信息与url.pressKeyMapping中的mapping中的内容要对应。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"nodeId":1,"nodeDescript":"开始","nextNodeId":2,"nodeType":"start","variables":["varDescript":"","varName":"satisfaction","varType":"string","varInitial":""}]'], ], [ 'name' => 'IsAppraise', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启语音满意度，默认开启（**true**）。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '是否开启语音满意度，默认开启（**true**）。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -8104,32 +4184,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'B06B3244-1B44-481B-90C4-F2F92E59D6B5', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'B06B3244-1B44-481B-90C4-F2F92E59D6B5'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -8140,14 +4199,8 @@ ], 'DeleteInstance' => [ 'summary' => '调用DeleteInstance通过呼叫中心实例ID删除该实例。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8162,20 +4215,13 @@ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '需要删除的呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], + 'schema' => ['description' => '需要删除的呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], ], ], 'responses' => [ @@ -8183,32 +4229,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -8223,14 +4248,8 @@ ], 'GetInstance' => [ 'summary' => '通过呼叫中心实例ID获取该实例相关信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8244,20 +4263,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取信息的呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], + 'schema' => ['description' => '待获取信息的呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], ], ], 'responses' => [ @@ -8265,110 +4277,29 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Instance' => [ 'description' => '呼叫中心实例信息', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '实例状态。', - 'type' => 'string', - 'example' => 'Creating', - ], - 'Owner' => [ - 'description' => '实例的拥有者。', - 'type' => 'string', - 'example' => '1059803544828509', - ], - 'StorageMaxDays' => [ - 'description' => '录音文件最多存贮多少天。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'StorageMaxSize' => [ - 'description' => '录音文件最大存贮容量GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'MaxOnlineAgents' => [ - 'description' => '呼叫中心实例的最大同时登陆在线的座席数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], - 'InstanceDescription' => [ - 'description' => '实例描述信息。', - 'type' => 'string', - 'example' => '测试实例', - ], - 'DomainName' => [ - 'description' => '呼叫中心实例的二级域名，全局唯一。', - 'type' => 'string', - 'example' => '111', - ], - 'ConsoleUrl' => [ - 'description' => '呼叫中心控制台URL，由阿里云呼叫中心官方URL加呼叫中心实例的域名组成。', - 'type' => 'string', - 'example' => 'ccc.aliyun.com/workbench/111', - ], - 'InstanceName' => [ - 'description' => '呼叫中心实例的名称。', - 'type' => 'string', - 'example' => '测试11111', - ], - 'StorageBucket' => [ - 'description' => '录音文件存贮位置，如果不指定，则存放在一个公共的存贮空间。', - 'type' => 'string', - 'example' => 'cloudcallcenter-online', - ], - 'CreatedTime' => [ - 'description' => '创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1537867125000', - ], - 'DirectoryId' => [ - 'description' => '目录ID，即阿里云UID。', - 'type' => 'string', - 'example' => '无', - ], - 'TenantId' => [ - 'description' => '租户ID。', - 'type' => 'string', - 'example' => 'acc2985', - ], + 'Status' => ['description' => '实例状态。', 'type' => 'string', 'example' => 'Creating'], + 'Owner' => ['description' => '实例的拥有者。', 'type' => 'string', 'example' => '1059803544828509'], + 'StorageMaxDays' => ['description' => '录音文件最多存贮多少天。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'StorageMaxSize' => ['description' => '录音文件最大存贮容量GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'MaxOnlineAgents' => ['description' => '呼叫中心实例的最大同时登陆在线的座席数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'InstanceId' => ['description' => '呼叫中心实例ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], + 'InstanceDescription' => ['description' => '实例描述信息。', 'type' => 'string', 'example' => '测试实例'], + 'DomainName' => ['description' => '呼叫中心实例的二级域名，全局唯一。', 'type' => 'string', 'example' => '111'], + 'ConsoleUrl' => ['description' => '呼叫中心控制台URL，由阿里云呼叫中心官方URL加呼叫中心实例的域名组成。', 'type' => 'string', 'example' => 'ccc.aliyun.com/workbench/111'], + 'InstanceName' => ['description' => '呼叫中心实例的名称。', 'type' => 'string', 'example' => '测试11111'], + 'StorageBucket' => ['description' => '录音文件存贮位置，如果不指定，则存放在一个公共的存贮空间。', 'type' => 'string', 'example' => 'cloudcallcenter-online'], + 'CreatedTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1537867125000'], + 'DirectoryId' => ['description' => '目录ID，即阿里云UID。', 'type' => 'string', 'example' => '无'], + 'TenantId' => ['description' => '租户ID。', 'type' => 'string', 'example' => 'acc2985'], 'Admin' => [ 'type' => 'object', 'itemNode' => true, @@ -8379,50 +4310,18 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '用户所归属的呼叫中心实例。', - 'type' => 'string', - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], - 'RamId' => [ - 'description' => '用户所对应的RAM账户ID。', - 'type' => 'string', - 'example' => '1059803544828509', - ], - 'UserId' => [ - 'description' => '用户ID， 全局唯一。', - 'type' => 'string', - 'example' => '无', - ], + 'InstanceId' => ['description' => '用户所归属的呼叫中心实例。', 'type' => 'string', 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], + 'RamId' => ['description' => '用户所对应的RAM账户ID。', 'type' => 'string', 'example' => '1059803544828509'], + 'UserId' => ['description' => '用户ID， 全局唯一。', 'type' => 'string', 'example' => '无'], 'Detail' => [ 'description' => '详细信息。', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'description' => '用户的全名。', - 'type' => 'string', - 'example' => '测试test', - ], - 'Email' => [ - 'description' => '用户的电子邮件地址。', - 'type' => 'string', - 'example' => '123@xx.com', - ], - 'LoginName' => [ - 'description' => '用户登陆名。', - 'type' => 'string', - 'example' => 'cctest', - ], - 'Department' => [ - 'description' => '部门。', - 'type' => 'string', - 'example' => 'IT', - ], - 'Phone' => [ - 'description' => '用户的电话号码。', - 'type' => 'string', - 'example' => '131xxxx1234', - ], + 'DisplayName' => ['description' => '用户的全名。', 'type' => 'string', 'example' => '测试test'], + 'Email' => ['description' => '用户的电子邮件地址。', 'type' => 'string', 'example' => '123@xx.com'], + 'LoginName' => ['description' => '用户登陆名。', 'type' => 'string', 'example' => 'cctest'], + 'Department' => ['description' => '部门。', 'type' => 'string', 'example' => 'IT'], + 'Phone' => ['description' => '用户的电话号码。', 'type' => 'string', 'example' => '131xxxx1234'], ], ], ], @@ -8442,53 +4341,15 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'TestOnly' => [ - 'description' => '是否是测试号码。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Trunks' => [ - 'description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RemainingTime' => [ - 'description' => '测试号码剩余的通话时间。单位为分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Number' => [ - 'description' => '电话号码。', - 'type' => 'string', - 'example' => '02500000000', - ], - 'InstanceId' => [ - 'description' => '电话号码所归属的呼叫中心实例。', - 'type' => 'string', - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], - 'Usage' => [ - 'description' => '电话号码的用途。', - 'type' => 'string', - 'example' => 'Bidirection', - ], - 'AllowOutbound' => [ - 'description' => '是否允许外呼。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PhoneNumberDescription' => [ - 'description' => '该电话号码的简单描述。', - 'type' => 'string', - 'example' => 'Ali Telecom', - ], - 'PhoneNumberId' => [ - 'description' => '电话号码ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '51349d57-e7a1-4dba-bd16-34d93251207d', - ], + 'TestOnly' => ['description' => '是否是测试号码。', 'type' => 'boolean', 'example' => 'false'], + 'Trunks' => ['description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RemainingTime' => ['description' => '测试号码剩余的通话时间。单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Number' => ['description' => '电话号码。', 'type' => 'string', 'example' => '02500000000'], + 'InstanceId' => ['description' => '电话号码所归属的呼叫中心实例。', 'type' => 'string', 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], + 'Usage' => ['description' => '电话号码的用途。', 'type' => 'string', 'example' => 'Bidirection'], + 'AllowOutbound' => ['description' => '是否允许外呼。', 'type' => 'boolean', 'example' => 'true'], + 'PhoneNumberDescription' => ['description' => '该电话号码的简单描述。', 'type' => 'string', 'example' => 'Ali Telecom'], + 'PhoneNumberId' => ['description' => '电话号码ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '51349d57-e7a1-4dba-bd16-34d93251207d'], ], ], ], @@ -8509,14 +4370,8 @@ ], 'GetInstanceState' => [ 'summary' => '获取实例下各个状态的坐席数量。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8531,21 +4386,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], ], 'responses' => [ @@ -8553,32 +4400,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], 'RealTimeInstanceState' => [ 'description' => '状态统计。', 'type' => 'object', @@ -8593,17 +4419,8 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'State' => [ - 'description' => '状态，注意 “未上线” 状态不会计入统计。', - 'type' => 'string', - 'example' => 'Ready', - ], - 'Count' => [ - 'description' => '数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'State' => ['description' => '状态，注意 “未上线” 状态不会计入统计。', 'type' => 'string', 'example' => 'Ready'], + 'Count' => ['description' => '数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], ], @@ -8624,14 +4441,8 @@ ], 'ListInstancesOfUser' => [ 'summary' => '调用接口：ListInstancesOfUser获取用户所属的呼叫中心实例。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8645,9 +4456,7 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccTMAX45', - ], + 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [], 'responses' => [ @@ -8655,35 +4464,14 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID'."\n" - ."\n", - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID'."\n" + ."\n", 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Instances' => [ 'type' => 'object', 'itemNode' => true, @@ -8694,80 +4482,20 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '实例状态', - 'type' => 'string', - 'example' => 'Creating', - ], - 'Owner' => [ - 'description' => '呼叫中心系统规格所对应的阿里云账户ID。', - 'type' => 'string', - 'example' => '105980354482xxxx', - ], - 'StorageMaxDays' => [ - 'description' => '录音文件最多存贮多少天。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'StorageMaxSize' => [ - 'description' => '录音文件最大存贮容量GB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'MaxOnlineAgents' => [ - 'description' => '呼叫中心实例最大同时在线座席的数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cxxxx', - ], - 'InstanceDescription' => [ - 'description' => '呼叫中心实例描述信息', - 'type' => 'string', - 'example' => '测试11111', - ], - 'DomainName' => [ - 'description' => '呼叫中心实例的二级域名，全局唯一。', - 'type' => 'string', - 'example' => '111', - ], - 'ConsoleUrl' => [ - 'description' => '呼叫中心控制台URL，由阿里云呼叫中心官方URL加呼叫中心实例的域名组成', - 'type' => 'string', - 'example' => 'ccc.aliyun.com/workbench/111', - ], - 'InstanceName' => [ - 'description' => '呼叫中心实例名称', - 'type' => 'string', - 'example' => '测试11111', - ], - 'StorageBucket' => [ - 'description' => '录音文件存贮位置，如果不指定，则存放在一个公共的存贮空间。', - 'type' => 'string', - 'example' => 'cloudcallcenter-online', - ], - 'CreatedTime' => [ - 'description' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1537867125000', - ], - 'DirectoryId' => [ - 'description' => '目录服务提供的目录ID。', - 'type' => 'string', - 'example' => '无', - ], - 'TenantId' => [ - 'description' => 'CC核心服务对应的租户ID。外表存贮。', - 'type' => 'string', - 'example' => 'accxxxx', - ], + 'Status' => ['description' => '实例状态', 'type' => 'string', 'example' => 'Creating'], + 'Owner' => ['description' => '呼叫中心系统规格所对应的阿里云账户ID。', 'type' => 'string', 'example' => '105980354482xxxx'], + 'StorageMaxDays' => ['description' => '录音文件最多存贮多少天。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'StorageMaxSize' => ['description' => '录音文件最大存贮容量GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'MaxOnlineAgents' => ['description' => '呼叫中心实例最大同时在线座席的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cxxxx'], + 'InstanceDescription' => ['description' => '呼叫中心实例描述信息', 'type' => 'string', 'example' => '测试11111'], + 'DomainName' => ['description' => '呼叫中心实例的二级域名，全局唯一。', 'type' => 'string', 'example' => '111'], + 'ConsoleUrl' => ['description' => '呼叫中心控制台URL，由阿里云呼叫中心官方URL加呼叫中心实例的域名组成', 'type' => 'string', 'example' => 'ccc.aliyun.com/workbench/111'], + 'InstanceName' => ['description' => '呼叫中心实例名称', 'type' => 'string', 'example' => '测试11111'], + 'StorageBucket' => ['description' => '录音文件存贮位置，如果不指定，则存放在一个公共的存贮空间。', 'type' => 'string', 'example' => 'cloudcallcenter-online'], + 'CreatedTime' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1537867125000'], + 'DirectoryId' => ['description' => '目录服务提供的目录ID。', 'type' => 'string', 'example' => '无'], + 'TenantId' => ['description' => 'CC核心服务对应的租户ID。外表存贮。', 'type' => 'string', 'example' => 'accxxxx'], 'Admin' => [ 'type' => 'object', 'itemNode' => true, @@ -8778,50 +4506,18 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '用户所归属的呼叫中心实例。', - 'type' => 'string', - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cxxxx', - ], - 'RamId' => [ - 'description' => '用户所对应的RAM账户ID。', - 'type' => 'string', - 'example' => '105980354482xxxx', - ], - 'UserId' => [ - 'description' => '用户ID， 系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '9d-487c-96ad-9181d85cxxxx', - ], + 'InstanceId' => ['description' => '用户所归属的呼叫中心实例。', 'type' => 'string', 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cxxxx'], + 'RamId' => ['description' => '用户所对应的RAM账户ID。', 'type' => 'string', 'example' => '105980354482xxxx'], + 'UserId' => ['description' => '用户ID， 系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '9d-487c-96ad-9181d85cxxxx'], 'Detail' => [ 'description' => '用户详细信息', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'description' => '用户的全名。', - 'type' => 'string', - 'example' => '云呼测试', - ], - 'Email' => [ - 'description' => '用户的电子邮件地址。', - 'type' => 'string', - 'example' => '123xxxx@123.com', - ], - 'LoginName' => [ - 'description' => '用户登录名。', - 'type' => 'string', - 'example' => '云呼测试', - ], - 'Department' => [ - 'description' => '所属部门。', - 'type' => 'string', - 'example' => '云呼测试', - ], - 'Phone' => [ - 'description' => '用户的电话号码。', - 'type' => 'string', - 'example' => '1320909xxxx', - ], + 'DisplayName' => ['description' => '用户的全名。', 'type' => 'string', 'example' => '云呼测试'], + 'Email' => ['description' => '用户的电子邮件地址。', 'type' => 'string', 'example' => '123xxxx@123.com'], + 'LoginName' => ['description' => '用户登录名。', 'type' => 'string', 'example' => '云呼测试'], + 'Department' => ['description' => '所属部门。', 'type' => 'string', 'example' => '云呼测试'], + 'Phone' => ['description' => '用户的电话号码。', 'type' => 'string', 'example' => '1320909xxxx'], ], ], ], @@ -8839,53 +4535,15 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'TestOnly' => [ - 'description' => '是否是测试号码。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Trunks' => [ - 'description' => '电话号码的中继数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'RemainingTime' => [ - 'description' => '测试号码剩余的通话时间。单位为分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Number' => [ - 'description' => '电话号码。', - 'type' => 'string', - 'example' => '0250000xxxx', - ], - 'InstanceId' => [ - 'description' => '电话号码所归属的呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cxxxx', - ], - 'Usage' => [ - 'description' => '电话号码的用途，呼入，呼出，已经同时用于呼入和呼出。 Inbound, Outbound, Bidirection', - 'type' => 'string', - 'example' => 'Bidirection', - ], - 'AllowOutbound' => [ - 'description' => '是否允许外呼', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PhoneNumberDescription' => [ - 'description' => '电话号码的简单描述。', - 'type' => 'string', - 'example' => 'Ali Telecom', - ], - 'PhoneNumberId' => [ - 'description' => '电话号码ID', - 'type' => 'string', - 'example' => '51349d57-e7a1-4dba-bd16-34d93251207d', - ], + 'TestOnly' => ['description' => '是否是测试号码。', 'type' => 'boolean', 'example' => 'false'], + 'Trunks' => ['description' => '电话号码的中继数量', 'type' => 'integer', 'format' => 'int32', 'example' => '15'], + 'RemainingTime' => ['description' => '测试号码剩余的通话时间。单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'Number' => ['description' => '电话号码。', 'type' => 'string', 'example' => '0250000xxxx'], + 'InstanceId' => ['description' => '电话号码所归属的呼叫中心实例ID。', 'type' => 'string', 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cxxxx'], + 'Usage' => ['description' => '电话号码的用途，呼入，呼出，已经同时用于呼入和呼出。 Inbound, Outbound, Bidirection', 'type' => 'string', 'example' => 'Bidirection'], + 'AllowOutbound' => ['description' => '是否允许外呼', 'type' => 'boolean', 'example' => 'true'], + 'PhoneNumberDescription' => ['description' => '电话号码的简单描述。', 'type' => 'string', 'example' => 'Ali Telecom'], + 'PhoneNumberId' => ['description' => '电话号码ID', 'type' => 'string', 'example' => '51349d57-e7a1-4dba-bd16-34d93251207d'], ], ], ], @@ -8909,14 +4567,8 @@ ], 'DisableTrunkProviders' => [ 'summary' => '调用接口：DisableTrunkProviders 注销供应商。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8931,9 +4583,7 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ @@ -8943,9 +4593,7 @@ 'schema' => [ 'description' => '线路供应商名称集合。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '联通全国', 'maxItems' => 99, @@ -8957,42 +4605,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'UserPermission', - 'errorMessage' => 'User \'%s\' has no permission to \'%s\'', - ], + ['errorCode' => 'UserPermission', 'errorMessage' => 'User \'%s\' has no permission to \'%s\''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"无\\nDE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\n200\\nOK\\ntrue","errorExample":""}]', @@ -9004,14 +4628,8 @@ ], 'ListTrunkProviders' => [ 'summary' => '调用接口：ListTrunkProviders 查询指定用户下正在使用的供应商信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9026,9 +4644,7 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [], 'responses' => [ @@ -9036,53 +4652,24 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码'."\n" - ."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID'."\n" - ."\n", - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE', - ], - 'Success' => [ - 'description' => '是否成功'."\n" - ."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码'."\n" + ."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID'."\n" + ."\n", 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE'], + 'Success' => ['description' => '是否成功'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true'], 'TrunkProviders' => [ 'description' => '供应商列表信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '线路供应商使用状态, 默认enable', - 'type' => 'string', - 'example' => 'enable', - ], - 'ProviderName' => [ - 'description' => '线路供应商名称', - 'type' => 'string', - 'example' => '联通全国', - ], + 'Status' => ['description' => '线路供应商使用状态, 默认enable', 'type' => 'string', 'example' => 'enable'], + 'ProviderName' => ['description' => '线路供应商名称', 'type' => 'string', 'example' => '联通全国'], ], ], ], @@ -9092,10 +4679,7 @@ ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'UserPermission', - 'errorMessage' => 'User \'%s\' has no permission to \'%s\'', - ], + ['errorCode' => 'UserPermission', 'errorMessage' => 'User \'%s\' has no permission to \'%s\''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"Success\\": true,\\n \\"TrunkProviders\\": [\\n {\\n \\"Status\\": \\"enable\\",\\n \\"ProviderName\\": \\"联通全国\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\n200\\n\\n enable\\n 联通全国\\n\\nOK\\ntrue","errorExample":""}]', @@ -9107,14 +4691,8 @@ ], 'CreateMedia' => [ 'summary' => '调用CreateMedia创建语音。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9129,100 +4707,53 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], + 'schema' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '待创建的音频文件的名字。', - 'type' => 'string', - 'required' => true, - 'example' => '音频测试', - ], + 'schema' => ['description' => '待创建的音频文件的名字。', 'type' => 'string', 'required' => true, 'example' => '音频测试'], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '待创建的音频文件的描述。', - 'type' => 'string', - 'required' => false, - 'example' => '音频测试', - ], + 'schema' => ['description' => '待创建的音频文件的描述。', 'type' => 'string', 'required' => false, 'example' => '音频测试'], ], [ 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => '待创建的音频文件名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-test.wav', - ], + 'schema' => ['description' => '待创建的音频文件名称。', 'type' => 'string', 'required' => true, 'example' => 'cc-test.wav'], ], [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '语音文件类型 Audio-语音文件 TTS-文本文件。', - 'type' => 'string', - 'required' => true, - 'example' => 'Audio', - ], + 'schema' => ['description' => '语音文件类型 Audio-语音文件 TTS-文本文件。', 'type' => 'string', 'required' => true, 'example' => 'Audio'], ], [ 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'description' => '待创建的音频文件的文本内容。', - 'type' => 'string', - 'required' => false, - 'example' => '无', - ], + 'schema' => ['description' => '待创建的音频文件的文本内容。', 'type' => 'string', 'required' => false, 'example' => '无'], ], [ 'name' => 'OssFileName', 'in' => 'query', - 'schema' => [ - 'description' => 'OSS文件名。', - 'type' => 'string', - 'required' => true, - 'example' => '0693df6e-3eaf-48ce-bf69-24103f23a25a.wav', - ], + 'schema' => ['description' => 'OSS文件名。', 'type' => 'string', 'required' => true, 'example' => '0693df6e-3eaf-48ce-bf69-24103f23a25a.wav'], ], [ 'name' => 'OssFilePath', 'in' => 'query', - 'schema' => [ - 'description' => 'OSS文件路径。', - 'type' => 'string', - 'required' => true, - 'example' => 'oss://ccc-online/media/7082312b-2a31-47c6-b529-e72b3d6354bd', - ], + 'schema' => ['description' => 'OSS文件路径。', 'type' => 'string', 'required' => true, 'example' => 'oss://ccc-online/media/7082312b-2a31-47c6-b529-e72b3d6354bd'], ], [ 'name' => 'UploadResult', 'in' => 'query', - 'schema' => [ - 'description' => '上传结果，Success 或 Fail。', - 'type' => 'string', - 'required' => true, - 'example' => 'Success', - ], + 'schema' => ['description' => '上传结果，Success 或 Fail。', 'type' => 'string', 'required' => true, 'example' => 'Success'], ], ], 'responses' => [ @@ -9230,66 +4761,21 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8707EB29-BAED-4302-B999-40BA61877437', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], 'MediaUploadParam' => [ 'description' => '上传的文件参数。', 'type' => 'object', 'properties' => [ - 'Instance' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], - 'OssFilePath' => [ - 'description' => 'OSS文件路径。', - 'type' => 'string', - 'example' => 'oss://ccc-online/media/7082312b-2a31-47c6-b529-e72b3d6354bd', - ], - 'FileName' => [ - 'description' => '文件名。', - 'type' => 'string', - 'example' => 'cc-test.wav', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => '音频测试', - ], - 'Id' => [ - 'description' => 'ID', - 'type' => 'string', - 'example' => '53211', - ], - 'OssFileName' => [ - 'description' => 'OSS文件名。', - 'type' => 'string', - 'example' => '0693df6e-3eaf-48ce-bf69-24103f23a25a.wav', - ], + 'Instance' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], + 'OssFilePath' => ['description' => 'OSS文件路径。', 'type' => 'string', 'example' => 'oss://ccc-online/media/7082312b-2a31-47c6-b529-e72b3d6354bd'], + 'FileName' => ['description' => '文件名。', 'type' => 'string', 'example' => 'cc-test.wav'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => '音频测试'], + 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '53211'], + 'OssFileName' => ['description' => 'OSS文件名。', 'type' => 'string', 'example' => '0693df6e-3eaf-48ce-bf69-24103f23a25a.wav'], ], ], ], @@ -9305,14 +4791,8 @@ ], 'DeleteMedia' => [ 'summary' => '调用DeleteMedia删除语音。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9324,30 +4804,18 @@ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], + 'schema' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '待删除的音频文件的名字。', - 'type' => 'string', - 'required' => true, - 'example' => '音频测试', - ], + 'schema' => ['description' => '待删除的音频文件的名字。', 'type' => 'string', 'required' => true, 'example' => '音频测试'], ], ], 'responses' => [ @@ -9355,32 +4823,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8707EB29-BAED-4302-B999-40BA61877437', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -9394,14 +4841,8 @@ ], 'ListMedias' => [ 'summary' => '查询语音列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9415,53 +4856,29 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例。', - 'type' => 'string', - 'required' => true, - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], + 'schema' => ['description' => '呼叫中心实例。', 'type' => 'string', 'required' => true, 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], ], [ 'name' => 'NamePrefix', 'in' => 'query', - 'schema' => [ - 'description' => '音频文件前缀', - 'type' => 'string', - 'required' => false, - 'example' => '809128080', - ], + 'schema' => ['description' => '音频文件前缀', 'type' => 'string', 'required' => false, 'example' => '809128080'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], ], ], 'responses' => [ @@ -9469,58 +4886,22 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码'."\n" - ."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '8707EB29-BAED-4302-B999-40BA61877437', - ], - 'Success' => [ - 'description' => '是否成功'."\n" - ."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码'."\n" + ."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'], + 'Success' => ['description' => '是否成功'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true'], 'Medias' => [ 'description' => '音频文件集合', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '29', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '29'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -9531,51 +4912,15 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '转码状态', - 'type' => 'string', - 'example' => 'Success', - ], - 'Type' => [ - 'description' => '语音文件类型 Audio-语音文件 TTS-文本文件', - 'type' => 'string', - 'example' => 'TTS', - ], - 'FilePath' => [ - 'description' => '文件路径', - 'type' => 'string', - 'example' => 'OSS://cloudcall-test', - ], - 'Instance' => [ - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], - 'Description' => [ - 'description' => '音频文件的简单描述。', - 'type' => 'string', - 'example' => '测试音频', - ], - 'FileName' => [ - 'description' => '文件名', - 'type' => 'string', - 'example' => '测试音频', - ], - 'Name' => [ - 'description' => '文件名称', - 'type' => 'string', - 'example' => '001.wav', - ], - 'Content' => [ - 'description' => '待通过TTS创建的音频文件的文本内容。', - 'type' => 'string', - 'example' => '云呼TTS测试', - ], - 'OssFileName' => [ - 'description' => 'oss文件', - 'type' => 'string', - 'example' => '001.wav', - ], + 'Status' => ['description' => '转码状态', 'type' => 'string', 'example' => 'Success'], + 'Type' => ['description' => '语音文件类型 Audio-语音文件 TTS-文本文件', 'type' => 'string', 'example' => 'TTS'], + 'FilePath' => ['description' => '文件路径', 'type' => 'string', 'example' => 'OSS://cloudcall-test'], + 'Instance' => ['description' => '实例ID', 'type' => 'string', 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], + 'Description' => ['description' => '音频文件的简单描述。', 'type' => 'string', 'example' => '测试音频'], + 'FileName' => ['description' => '文件名', 'type' => 'string', 'example' => '测试音频'], + 'Name' => ['description' => '文件名称', 'type' => 'string', 'example' => '001.wav'], + 'Content' => ['description' => '待通过TTS创建的音频文件的文本内容。', 'type' => 'string', 'example' => '云呼TTS测试'], + 'OssFileName' => ['description' => 'oss文件', 'type' => 'string', 'example' => '001.wav'], ], ], ], @@ -9596,14 +4941,8 @@ ], 'GetTURNCredentials' => [ 'summary' => '调用GetTURNCredentials获取TURN服务所需用户名和密码。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9617,32 +4956,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'UserName', 'in' => 'query', - 'schema' => [ - 'description' => '用户的RamId。或者传“0”(服务端自行获取当前用户的RamId)。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0', - ], + 'schema' => ['description' => '用户的RamId。或者传“0”(服务端自行获取当前用户的RamId)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0'], ], ], 'responses' => [ @@ -9650,42 +4975,13 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Password' => [ - 'description' => '访问Turn服务用的密码', - 'type' => 'string', - 'example' => 'SMP4FH/BhK3Ffh+LW4OM+7mv0jQ=', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'D39CD25C-2C52-488B-9D9E-DC61F1F69812', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'Username' => [ - 'description' => '访问Turn服务用的用户名', - 'type' => 'string', - 'example' => '1566545336:1059803544828509', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Password' => ['description' => '访问Turn服务用的密码', 'type' => 'string', 'example' => 'SMP4FH/BhK3Ffh+LW4OM+7mv0jQ='], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D39CD25C-2C52-488B-9D9E-DC61F1F69812'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'Username' => ['description' => '访问Turn服务用的用户名', 'type' => 'string', 'example' => '1566545336:1059803544828509'], ], ], ], @@ -9699,14 +4995,8 @@ ], 'GetTURNServerList' => [ 'summary' => '调用GetTURNServerList获取TURN服务列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9721,21 +5011,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], ], 'responses' => [ @@ -9743,37 +5025,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '35783199-DB04-40E8-9FCB-C190008AEFA4', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => 'xxx', - ], - 'TurnServerListConfig' => [ - 'description' => 'Turn服务列表', - 'type' => 'string', - 'example' => '{"region":"shanghai","name":"上海","domain":"turn3.ccc.aliyuncs.com","cidr":"192.1.25.64/28"}', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '35783199-DB04-40E8-9FCB-C190008AEFA4'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => 'xxx'], + 'TurnServerListConfig' => ['description' => 'Turn服务列表', 'type' => 'string', 'example' => '{"region":"shanghai","name":"上海","domain":"turn3.ccc.aliyuncs.com","cidr":"192.1.25.64/28"}'], ], ], ], @@ -9787,14 +5044,8 @@ ], 'CreateFault' => [ 'summary' => '调用CreateFault上报故障信息，。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9809,218 +5060,108 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席的RAM ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '293285256197663688', - ], + 'schema' => ['description' => '坐席的RAM ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '293285256197663688'], ], [ 'name' => 'ConnectId', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1341443161', - ], + 'schema' => ['description' => '通话ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1341443161'], ], [ 'name' => 'AgentOssFileName', 'in' => 'query', - 'schema' => [ - 'description' => '坐席录音文件名', - 'type' => 'string', - 'required' => false, - 'example' => 'xiaofang', - ], + 'schema' => ['description' => '坐席录音文件名', 'type' => 'string', 'required' => false, 'example' => 'xiaofang'], ], [ 'name' => 'AgentFilePath', 'in' => 'query', - 'schema' => [ - 'description' => '坐席录音地址', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], + 'schema' => ['description' => '坐席录音地址', 'type' => 'string', 'required' => false, 'example' => 'xxx'], ], [ 'name' => 'CustomOssFileName', 'in' => 'query', - 'schema' => [ - 'description' => '客户录音文件名', - 'type' => 'string', - 'required' => false, - 'example' => 'xiaohong', - ], + 'schema' => ['description' => '客户录音文件名', 'type' => 'string', 'required' => false, 'example' => 'xiaohong'], ], [ 'name' => 'CustomFilePath', 'in' => 'query', - 'schema' => [ - 'description' => '客户录音文件地址', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], + 'schema' => ['description' => '客户录音文件地址', 'type' => 'string', 'required' => false, 'example' => 'xxx'], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '报障信息描述', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], + 'schema' => ['description' => '报障信息描述', 'type' => 'string', 'required' => false, 'example' => 'xxx'], ], [ 'name' => 'ClientIp', 'in' => 'query', - 'schema' => [ - 'description' => '客户端IP', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - ], + 'schema' => ['description' => '客户端IP', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'], ], [ 'name' => 'ClientPort', 'in' => 'query', - 'schema' => [ - 'description' => '客户端端口', - 'type' => 'string', - 'required' => false, - 'example' => '8000', - ], + 'schema' => ['description' => '客户端端口', 'type' => 'string', 'required' => false, 'example' => '8000'], ], [ 'name' => 'OperatingSystemVersion', 'in' => 'query', - 'schema' => [ - 'description' => '操作系统版本', - 'type' => 'string', - 'required' => false, - 'example' => 'windows10', - ], + 'schema' => ['description' => '操作系统版本', 'type' => 'string', 'required' => false, 'example' => 'windows10'], ], [ 'name' => 'BrowserVersion', 'in' => 'query', - 'schema' => [ - 'description' => '浏览器版本', - 'type' => 'string', - 'required' => false, - 'example' => '浏览器内核类型：chrome，浏览器版本：74.0.3729.169', - ], + 'schema' => ['description' => '浏览器版本', 'type' => 'string', 'required' => false, 'example' => '浏览器内核类型：chrome，浏览器版本：74.0.3729.169'], ], [ 'name' => 'MicrophoneList', 'in' => 'query', - 'schema' => [ - 'description' => '麦克风列表', - 'type' => 'string', - 'required' => false, - 'example' => '[]', - ], + 'schema' => ['description' => '麦克风列表', 'type' => 'string', 'required' => false, 'example' => '[]'], ], [ 'name' => 'MicrophoneEquipment', 'in' => 'query', - 'schema' => [ - 'description' => '当前麦克风设备', - 'type' => 'string', - 'required' => false, - 'example' => '无', - ], + 'schema' => ['description' => '当前麦克风设备', 'type' => 'string', 'required' => false, 'example' => '无'], ], [ 'name' => 'SpeakerList', 'in' => 'query', - 'schema' => [ - 'description' => '扬声器列表', - 'type' => 'string', - 'required' => false, - 'example' => '[]', - ], + 'schema' => ['description' => '扬声器列表', 'type' => 'string', 'required' => false, 'example' => '[]'], ], [ 'name' => 'SpeakerEquipment', 'in' => 'query', - 'schema' => [ - 'description' => '当前扬声器设备', - 'type' => 'string', - 'required' => false, - 'example' => '无', - ], + 'schema' => ['description' => '当前扬声器设备', 'type' => 'string', 'required' => false, 'example' => '无'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1558439900000', - ], + 'schema' => ['description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1558439900000'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1558443508000', - ], + 'schema' => ['description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1558443508000'], ], [ 'name' => 'ServiceIp', 'in' => 'query', - 'schema' => [ - 'description' => '服务端IP', - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - ], + 'schema' => ['description' => '服务端IP', 'type' => 'string', 'required' => false, 'example' => '127.0.0.1'], ], [ 'name' => 'ServicePort', 'in' => 'query', - 'schema' => [ - 'description' => '服务端端口号', - 'type' => 'string', - 'required' => false, - 'example' => '8000', - ], + 'schema' => ['description' => '服务端端口号', 'type' => 'string', 'required' => false, 'example' => '8000'], ], ], 'responses' => [ @@ -10028,32 +5169,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '87107935-A19D-442B-9D94-267A9A518C8E', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '87107935-A19D-442B-9D94-267A9A518C8E'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -10068,14 +5188,8 @@ ], 'ListCallMeasureSummaryReports' => [ 'summary' => '调用ListCallMeasureSummaryReports按月或按天查询呼叫计量数据列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10090,21 +5204,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'IntervalType', 'in' => 'query', - 'schema' => [ - 'description' => '按月查询或者按天查询(**Monthly**/**Daily**)', - 'type' => 'string', - 'required' => true, - 'example' => 'Monthly', - 'docRequired' => true, - ], + 'schema' => ['description' => '按月查询或者按天查询(**Monthly**/**Daily**)', 'type' => 'string', 'required' => true, 'example' => 'Monthly', 'docRequired' => true], ], ], 'responses' => [ @@ -10112,32 +5218,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '184F6B94-18EE-42D9-B628-A9A895E804F3', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '184F6B94-18EE-42D9-B628-A9A895E804F3'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'CallMeasureSummaryReportList' => [ 'type' => 'object', 'itemNode' => true, @@ -10148,45 +5233,13 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Day' => [ - 'description' => '日期', - 'type' => 'string', - 'example' => '2', - ], - 'Year' => [ - 'description' => '年份', - 'type' => 'string', - 'example' => '2018', - ], - 'InboundDurationByMinute' => [ - 'description' => '呼入通话时长/分钟', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OutboundCount' => [ - 'description' => '呼出接通次数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OutboundDurationByMinute' => [ - 'description' => '呼出通话时长/分钟', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'InboundCount' => [ - 'description' => '呼入接通次数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Month' => [ - 'description' => '月份', - 'type' => 'string', - 'example' => '10', - ], + 'Day' => ['description' => '日期', 'type' => 'string', 'example' => '2'], + 'Year' => ['description' => '年份', 'type' => 'string', 'example' => '2018'], + 'InboundDurationByMinute' => ['description' => '呼入通话时长/分钟', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OutboundCount' => ['description' => '呼出接通次数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OutboundDurationByMinute' => ['description' => '呼出通话时长/分钟', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'InboundCount' => ['description' => '呼入接通次数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Month' => ['description' => '月份', 'type' => 'string', 'example' => '10'], ], ], ], @@ -10202,14 +5255,8 @@ ], 'GetCallMeasureSummaryReport' => [ 'summary' => '查询某天或某月各个号码的呼叫计量数据列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10224,78 +5271,38 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'IntervalType', 'in' => 'query', - 'schema' => [ - 'description' => '按月查询或者按天查询(**Monthly** | **Daily**)', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Monthly', - ], + 'schema' => ['description' => '按月查询或者按天查询(**Monthly** | **Daily**)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Monthly'], ], [ 'name' => 'Year', 'in' => 'query', - 'schema' => [ - 'description' => '年份', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '2019', - ], + 'schema' => ['description' => '年份', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2019'], ], [ 'name' => 'Month', 'in' => 'query', - 'schema' => [ - 'description' => '月份', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '12', - ], + 'schema' => ['description' => '月份', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '12'], ], [ 'name' => 'Day', 'in' => 'query', - 'schema' => [ - 'description' => '日期', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '日期', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，默认1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号，默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，默认50，最大100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'schema' => ['description' => '分页大小，默认50，最大100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], ], ], 'responses' => [ @@ -10303,102 +5310,31 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'SummaryReport' => [ 'description' => '当天或当月的汇总报表', 'type' => 'object', 'properties' => [ - 'Day' => [ - 'description' => '日期', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'Year' => [ - 'description' => '年份', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2018', - ], - 'InboundDurationByMinute' => [ - 'description' => '呼入通话时长/分钟', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '47', - ], - 'OutboundCount' => [ - 'description' => '呼出接通次数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '65', - ], - 'OutboundDurationByMinute' => [ - 'description' => '呼出通话时长/分钟', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3390', - ], - 'InboundCount' => [ - 'description' => '呼入接通次数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Month' => [ - 'description' => '月份', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'Day' => ['description' => '日期', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'Year' => ['description' => '年份', 'type' => 'integer', 'format' => 'int32', 'example' => '2018'], + 'InboundDurationByMinute' => ['description' => '呼入通话时长/分钟', 'type' => 'integer', 'format' => 'int64', 'example' => '47'], + 'OutboundCount' => ['description' => '呼出接通次数', 'type' => 'integer', 'format' => 'int64', 'example' => '65'], + 'OutboundDurationByMinute' => ['description' => '呼出通话时长/分钟', 'type' => 'integer', 'format' => 'int64', 'example' => '3390'], + 'InboundCount' => ['description' => '呼入接通次数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Month' => ['description' => '月份', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], 'NumberReports' => [ 'description' => '号码计量数据报表', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'TotalCount' => [ - 'description' => '个数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '22', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], + 'TotalCount' => ['description' => '个数', 'type' => 'integer', 'format' => 'int32', 'example' => '22'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -10409,53 +5345,14 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Day' => [ - 'description' => '日期', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '31', - ], - 'Year' => [ - 'description' => '年份', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2018', - ], - 'InboundDurationByMinute' => [ - 'description' => '呼入通话时长/分钟', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OutboundCount' => [ - 'description' => '呼出接通次数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18', - ], - 'OutboundDurationByMinute' => [ - 'description' => '呼出通话时长/分钟', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2108', - ], - 'Number' => [ - 'description' => '号码', - 'type' => 'string', - 'example' => '07318888****', - ], - 'InboundCount' => [ - 'description' => '呼入接通次数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Month' => [ - 'description' => '月份', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'Day' => ['description' => '日期', 'type' => 'integer', 'format' => 'int32', 'example' => '31'], + 'Year' => ['description' => '年份', 'type' => 'integer', 'format' => 'int32', 'example' => '2018'], + 'InboundDurationByMinute' => ['description' => '呼入通话时长/分钟', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OutboundCount' => ['description' => '呼出接通次数', 'type' => 'integer', 'format' => 'int64', 'example' => '18'], + 'OutboundDurationByMinute' => ['description' => '呼出通话时长/分钟', 'type' => 'integer', 'format' => 'int64', 'example' => '2108'], + 'Number' => ['description' => '号码', 'type' => 'string', 'example' => '07318888****'], + 'InboundCount' => ['description' => '呼入接通次数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Month' => ['description' => '月份', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], @@ -10476,14 +5373,8 @@ ], 'GetInstanceSummaryReport' => [ 'summary' => '实例汇总报表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10498,65 +5389,33 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '起始日期，格式yyyy-MM-dd HH:mm:ss，不得早于6个月前的时间点。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2019-09-09 11:11:11', - ], + 'schema' => ['description' => '起始日期，格式yyyy-MM-dd HH:mm:ss，不得早于6个月前的时间点。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-09-09 11:11:11'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '终止日期，格式yyyy-MM-dd HH:mm:ss。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2019-09-09 11:11:11', - ], + 'schema' => ['description' => '终止日期，格式yyyy-MM-dd HH:mm:ss。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-09-09 11:11:11'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], ], ], 'responses' => [ @@ -10564,386 +5423,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '24BE19E8-BF7D-4992-A35E-15EBA874F2E5', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '24BE19E8-BF7D-4992-A35E-15EBA874F2E5'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'InstanceSummaryReport' => [ 'description' => '报表', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], 'Overall' => [ 'description' => '整体指标', 'type' => 'object', 'properties' => [ - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '46914', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '109', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.003922070376574993', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '75', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21194', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1608', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '46644', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '51', - ], - 'TotalCalls' => [ - 'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '46914'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '109'], + 'OccupancyRate' => ['description' => '座席利用率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0.003922070376574993'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '75'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '13'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '21194'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1608'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '46644'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '51'], + 'TotalCalls' => ['description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], ], ], 'Inbound' => [ 'description' => '呼入指标', 'type' => 'object', 'properties' => [ - 'CallsIncomingLine' => [ - 'description' => '电话进线量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '电话应答数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInIVR' => [ - 'description' => 'IVR放弃量,即电话进入IVR流程之后在IVR环节放弃。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWaitTime' => [ - 'description' => '平均等待时长，平均每通电话的坐席接起时等待时长。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsIncomingQueue' => [ - 'description' => '技能组进线量,即电话进入技能组量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWaitTime' => [ - 'description' => '总等待时长，等待时长是指来电进入队列开始算到坐席接起之间的耗时。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'string', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsIncomingIVR' => [ - 'description' => 'IVR进线量,即电话进入IVR流程。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '电话呼入数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWaitTime' => [ - 'description' => '最大等待时长，所有坐席接起通话里面最大等待时长。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '服务水平，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInQueue' => [ - 'description' => '队列放弃量,即电话进入技能组之后在排队环节放弃。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'CallsIncomingLine' => ['description' => '电话进线量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInIVR' => ['description' => 'IVR放弃量,即电话进入IVR流程之后在IVR环节放弃。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWaitTime' => ['description' => '平均等待时长，平均每通电话的坐席接起时等待时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsIncomingQueue' => ['description' => '技能组进线量,即电话进入技能组量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWaitTime' => ['description' => '总等待时长，等待时长是指来电进入队列开始算到坐席接起之间的耗时。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'string', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsIncomingIVR' => ['description' => 'IVR进线量,即电话进入IVR流程。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '电话呼入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWaitTime' => ['description' => '最大等待时长，所有坐席接起通话里面最大等待时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ServiceLevel20' => ['description' => '服务水平，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInQueue' => ['description' => '队列放弃量,即电话进入技能组之后在排队环节放弃。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Outbound' => [ 'description' => '呼出指标', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '109', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'CallsDialed' => [ - 'description' => '电话拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'CallsAnswered' => [ - 'description' => '电话接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'AnswerRate' => [ - 'description' => '接通率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.800000011920929', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '75', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '135', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '51', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '109'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'CallsDialed' => ['description' => '电话拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], + 'AnswerRate' => ['description' => '接通率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0.800000011920929'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '75'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '135'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '13'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '51'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '13'], ], ], ], @@ -10960,14 +5520,8 @@ ], 'GetInstanceSummaryReportByInterval' => [ 'summary' => '调用GetInstanceSummaryReportByInterval汇总实例分段报表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10982,78 +5536,41 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], ], [ 'name' => 'Interval', 'in' => 'query', - 'schema' => [ - 'description' => '间隔类型。'."\n" - ."\n" - .'- Daily:天'."\n" - .'- Minute5:5分钟', - 'type' => 'string', - 'required' => false, - 'example' => 'Daily', - ], + 'schema' => ['description' => '间隔类型。'."\n" + ."\n" + .'- Daily:天'."\n" + .'- Minute5:5分钟', 'type' => 'string', 'required' => false, 'example' => 'Daily'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '起始日期，格式yyyy-MM-dd HH:mm:ss，不得早于6个月前的时间点', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2019-09-09 11:11:11', - ], + 'schema' => ['description' => '起始日期，格式yyyy-MM-dd HH:mm:ss，不得早于6个月前的时间点', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-09-09 11:11:11'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '终止日期，格式yyyy-MM-dd HH:mm:ss', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2019-09-09 11:11:11', - ], + 'schema' => ['description' => '终止日期，格式yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-09-09 11:11:11'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], ], ], 'responses' => [ @@ -11061,41 +5578,16 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'InstanceTimeIntervalReport' => [ 'description' => '报表', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], + 'InstanceId' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], 'IntervalList' => [ 'type' => 'object', 'itemNode' => true, @@ -11106,361 +5598,79 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], - 'Timestamp' => [ - 'description' => '分段统计的开始时间。', - 'type' => 'string', - 'example' => '2020-11-14 10:45:00', - ], + 'InstanceId' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], + 'Timestamp' => ['description' => '分段统计的开始时间。', 'type' => 'string', 'example' => '2020-11-14 10:45:00'], 'Overall' => [ 'description' => '整体指标。', 'type' => 'object', 'properties' => [ - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '49', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.44897958636283275', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'TotalCalls' => [ - 'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '49'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'OccupancyRate' => ['description' => '座席利用率。', 'type' => 'number', 'format' => 'float', 'example' => '0.44897958636283275'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'SatisfactionIndex' => ['description' => '满意度指数。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'TotalCalls' => ['description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], 'Inbound' => [ 'description' => '呼入指标。', 'type' => 'object', 'properties' => [ - 'CallsIncomingLine' => [ - 'description' => '电话进线量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '电话应答数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInIVR' => [ - 'description' => 'IVR放弃量,即电话进入IVR流程之后在IVR环节放弃。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWaitTime' => [ - 'description' => '平均等待时长(等待时长=振铃时长+队列等待时长)，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsIncomingQueue' => [ - 'description' => '技能组进线量,即电话进入技能组量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWaitTime' => [ - 'description' => '总等待时长(等待时长=振铃时长+队列等待时长)，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'string', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsIncomingIVR' => [ - 'description' => 'IVR进线量,即电话进入IVR流程。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '电话呼入数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWaitTime' => [ - 'description' => '最大等待时长(等待时长=振铃时长+队列等待时长)，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '20s应答率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInQueue' => [ - 'description' => '队列放弃量,即电话进入技能组之后在排队环节放弃。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'CallsIncomingLine' => ['description' => '电话进线量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInIVR' => ['description' => 'IVR放弃量,即电话进入IVR流程之后在IVR环节放弃。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWaitTime' => ['description' => '平均等待时长(等待时长=振铃时长+队列等待时长)，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsIncomingQueue' => ['description' => '技能组进线量,即电话进入技能组量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWaitTime' => ['description' => '总等待时长(等待时长=振铃时长+队列等待时长)，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'string', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsIncomingIVR' => ['description' => 'IVR进线量,即电话进入IVR流程。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '电话呼入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWaitTime' => ['description' => '最大等待时长(等待时长=振铃时长+队列等待时长)，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ServiceLevel20' => ['description' => '20s应答率。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInQueue' => ['description' => '队列放弃量,即电话进入技能组之后在排队环节放弃。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Outbound' => [ 'description' => '呼出指标。', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'CallsDialed' => [ - 'description' => '电话拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CallsAnswered' => [ - 'description' => '电话接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AnswerRate' => [ - 'description' => '接通率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], + 'CallsDialed' => ['description' => '电话拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AnswerRate' => ['description' => '接通率。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'SatisfactionIndex' => ['description' => '满意度指数。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], ], ], ], @@ -11482,14 +5692,8 @@ ], 'GetInstanceSummaryReportSinceMidnight' => [ 'summary' => '实例当日的汇总报表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11504,43 +5708,23 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], ], ], 'responses' => [ @@ -11548,391 +5732,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '8707EB29-BAED-4302-B999-40BA61877437', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'InstanceSummaryReport' => [ 'description' => '报表', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx', - ], - 'Timestamp' => [ - 'description' => '日期，格式yyyy-MM-dd HH:mm:ss', - 'type' => 'string', - 'example' => '2018-09-13 00:00:00', - ], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx'], + 'Timestamp' => ['description' => '日期，格式yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2018-09-13 00:00:00'], 'Overall' => [ 'description' => '整体指标', 'type' => 'object', 'properties' => [ - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OccupancyRate' => ['description' => '座席利用率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Inbound' => [ 'description' => '呼入指标', 'type' => 'object', 'properties' => [ - 'CallsIncomingLine' => [ - 'description' => '电话进线量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '电话应答数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInIVR' => [ - 'description' => 'IVR放弃量,即电话进入IVR流程之后在IVR环节放弃。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWaitTime' => [ - 'description' => '平均等待时长，平均每通电话的坐席接起时等待时长。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsIncomingQueue' => [ - 'description' => '技能组进线量,即电话进入技能组量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWaitTime' => [ - 'description' => '总等待时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'string', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsIncomingIVR' => [ - 'description' => 'IVR进线量,即电话进入IVR流程。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '电话呼入数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWaitTime' => [ - 'description' => '最大等待时长，所有坐席接起通话里面最大等待时长。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '服务水平，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInQueue' => [ - 'description' => '队列放弃量,即电话进入技能组之后在排队环节放弃。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'CallsIncomingLine' => ['description' => '电话进线量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInIVR' => ['description' => 'IVR放弃量,即电话进入IVR流程之后在IVR环节放弃。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWaitTime' => ['description' => '平均等待时长，平均每通电话的坐席接起时等待时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsIncomingQueue' => ['description' => '技能组进线量,即电话进入技能组量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWaitTime' => ['description' => '总等待时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'string', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsIncomingIVR' => ['description' => 'IVR进线量,即电话进入IVR流程。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '电话呼入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWaitTime' => ['description' => '最大等待时长，所有坐席接起通话里面最大等待时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ServiceLevel20' => ['description' => '服务水平，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInQueue' => ['description' => '队列放弃量,即电话进入技能组之后在排队环节放弃。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Outbound' => [ 'description' => '呼出指标', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '电话拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAnswered' => [ - 'description' => '电话接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnswerRate' => [ - 'description' => '接通率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsDialed' => ['description' => '电话拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnswerRate' => ['description' => '接通率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], ], @@ -11950,14 +5831,8 @@ ], 'CreateUser' => [ 'summary' => '创建用户。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11972,72 +5847,40 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'DisplayName', 'in' => 'query', - 'schema' => [ - 'description' => '用户的全名', - 'type' => 'string', - 'required' => true, - 'example' => '张先生', - ], + 'schema' => ['description' => '用户的全名', 'type' => 'string', 'required' => true, 'example' => '张先生'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待创建用户的呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '待创建用户的呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'LoginName', 'in' => 'query', - 'schema' => [ - 'description' => '用户登录名', - 'type' => 'string', - 'required' => true, - 'example' => 'yourUserName', - ], + 'schema' => ['description' => '用户登录名', 'type' => 'string', 'required' => true, 'example' => 'yourUserName'], ], [ 'name' => 'Phone', 'in' => 'query', - 'schema' => [ - 'description' => '用户电话号码', - 'type' => 'string', - 'required' => false, - 'example' => '1886666****', - ], + 'schema' => ['description' => '用户电话号码', 'type' => 'string', 'required' => false, 'example' => '1886666****'], ], [ 'name' => 'Email', 'in' => 'query', - 'schema' => [ - 'description' => '用户电子邮件地址。'."\n" - ."\n" - .'新建成功后会发送邮件，邮件中包含呼叫中心登录地址，以及用户名密码。', - 'type' => 'string', - 'required' => true, - 'example' => 'username@example.com', - ], + 'schema' => ['description' => '用户电子邮件地址。'."\n" + ."\n" + .'新建成功后会发送邮件，邮件中包含呼叫中心登录地址，以及用户名密码。', 'type' => 'string', 'required' => true, 'example' => 'username@example.com'], ], [ 'name' => 'PrivateOutboundNumberId', 'in' => 'query', - 'schema' => [ - 'description' => '个人外呼号码的PhoneNumberId', - 'type' => 'string', - 'required' => false, - 'example' => 'a08d255e-12a5-48f8-93e0-6b8e1b6d****', - ], + 'schema' => ['description' => '个人外呼号码的PhoneNumberId', 'type' => 'string', 'required' => false, 'example' => 'a08d255e-12a5-48f8-93e0-6b8e1b6d****'], ], [ 'name' => 'RoleId', @@ -12046,9 +5889,7 @@ 'schema' => [ 'description' => '指定待创建用户的角色，需传入角色ID', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'example' => '4c2e158e-ddd9-464a-a3fc-338eca102***', 'maxItems' => 99, @@ -12063,9 +5904,7 @@ ."\n" .'SkillGroupId.1意为只绑定到一个技能组中，如果绑定多个技能组，则需要传多个，例如 SkillGroupId.1、SkillGroupId.2、SkillGroupId.3，以此类推。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18****', 'maxItems' => 99, @@ -12080,10 +5919,7 @@ ."\n\n" .'SkillLevel.1表示为SkillGroupId.1的技能组等级，如果SkillGroupId为多个，则SkillLevel也需要多个，并且数量需要保持一致，具体请参考下方的请求示例。', 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'items' => ['type' => 'integer', 'format' => 'int32'], 'required' => false, 'example' => '4', 'maxItems' => 99, @@ -12095,39 +5931,14 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '4A2E1761-8C19-4788-BA76-6C8902A6D5E9', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'UserId' => [ - 'description' => '新创建的用户信息。'."\n" - ."\n\n" - .'> 这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', - 'type' => 'string', - 'example' => '7ed274a5-6351-4dbd-9f13-6ac63c8e****', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '4A2E1761-8C19-4788-BA76-6C8902A6D5E9'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'UserId' => ['description' => '新创建的用户信息。'."\n" + ."\n\n" + .'> 这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', 'type' => 'string', 'example' => '7ed274a5-6351-4dbd-9f13-6ac63c8e****'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], ], ], ], @@ -12142,14 +5953,8 @@ ], 'GetUserByExtension' => [ 'summary' => '根据坐席分机号获取用户信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12164,32 +5969,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], + 'schema' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], ], [ 'name' => 'Extension', 'in' => 'query', - 'schema' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8037****', - ], + 'schema' => ['description' => '坐席分机号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8037****'], ], ], 'responses' => [ @@ -12197,77 +5988,28 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], 'User' => [ 'description' => '用户信息。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '用户所归属的呼叫中心实例ID。', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], - 'RamId' => [ - 'description' => '用户所对应的RAM账户ID。', - 'type' => 'string', - 'example' => '20225462120879xxxx', - ], - 'UserId' => [ - 'description' => '用户ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '6f3e7751-fa61-453f-8057-a2fe9741xxxx', - ], + 'InstanceId' => ['description' => '用户所归属的呼叫中心实例ID。', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], + 'RamId' => ['description' => '用户所对应的RAM账户ID。', 'type' => 'string', 'example' => '20225462120879xxxx'], + 'UserId' => ['description' => '用户ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '6f3e7751-fa61-453f-8057-a2fe9741xxxx'], 'Roles' => [ 'description' => '用户的角色列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '用户所归属的呼叫中心实例ID。', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], - 'RoleName' => [ - 'description' => '角色名称。', - 'type' => 'string', - 'example' => 'ADMIN', - ], - 'RoleDescription' => [ - 'description' => '角色描述。', - 'type' => 'string', - 'example' => '管理员', - ], - 'RoleId' => [ - 'description' => '角色ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '59a3d864-2f98-4f5e-84ec-c1ea13afxxxx', - ], + 'InstanceId' => ['description' => '用户所归属的呼叫中心实例ID。', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], + 'RoleName' => ['description' => '角色名称。', 'type' => 'string', 'example' => 'ADMIN'], + 'RoleDescription' => ['description' => '角色描述。', 'type' => 'string', 'example' => '管理员'], + 'RoleId' => ['description' => '角色ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '59a3d864-2f98-4f5e-84ec-c1ea13afxxxx'], ], ], ], @@ -12277,41 +6019,16 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SkillLevelId' => [ - 'description' => '技能级别唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '181792', - ], - 'Level' => [ - 'description' => '技能级别。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], + 'SkillLevelId' => ['description' => '技能级别唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '181792'], + 'Level' => ['description' => '技能级别。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], 'Skill' => [ 'description' => '技能组。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '技能组所归属的呼叫中心实例。', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], - 'SkillGroupDescription' => [ - 'description' => '技能组简单描述。', - 'type' => 'string', - 'example' => '描述', - ], - 'SkillGroupId' => [ - 'description' => '技能组唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => 'a053e6d5-16ee-4283-9c81-631b78aexxxx', - ], - 'SkillGroupName' => [ - 'description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', - 'type' => 'string', - 'example' => '默认技能组', - ], + 'InstanceId' => ['description' => '技能组所归属的呼叫中心实例。', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], + 'SkillGroupDescription' => ['description' => '技能组简单描述。', 'type' => 'string', 'example' => '描述'], + 'SkillGroupId' => ['description' => '技能组唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => 'a053e6d5-16ee-4283-9c81-631b78aexxxx'], + 'SkillGroupName' => ['description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', 'type' => 'string', 'example' => '默认技能组'], ], ], ], @@ -12321,36 +6038,12 @@ 'description' => '用户详细信息。', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'description' => '用户的姓名。', - 'type' => 'string', - 'example' => 'test', - ], - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8037****', - ], - 'LoginName' => [ - 'description' => '用户登录名（用户名）。', - 'type' => 'string', - 'example' => 'test123', - ], - 'Email' => [ - 'description' => '用户的电子邮件地址。', - 'type' => 'string', - 'example' => 'test@alibaba-inc.com', - ], - 'Department' => [ - 'description' => '用户的部门。', - 'type' => 'string', - 'example' => 'IT', - ], - 'Phone' => [ - 'description' => '用户的电话号码。', - 'type' => 'string', - 'example' => '1360176****', - ], + 'DisplayName' => ['description' => '用户的姓名。', 'type' => 'string', 'example' => 'test'], + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8037****'], + 'LoginName' => ['description' => '用户登录名（用户名）。', 'type' => 'string', 'example' => 'test123'], + 'Email' => ['description' => '用户的电子邮件地址。', 'type' => 'string', 'example' => 'test@alibaba-inc.com'], + 'Department' => ['description' => '用户的部门。', 'type' => 'string', 'example' => 'IT'], + 'Phone' => ['description' => '用户的电话号码。', 'type' => 'string', 'example' => '1360176****'], ], ], ], @@ -12361,10 +6054,7 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterFormat', - 'errorMessage' => 'The format of parameter \'%s\' is incorrect.', - ], + ['errorCode' => 'ParameterFormat', 'errorMessage' => 'The format of parameter \'%s\' is incorrect.'], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"Success\\": true,\\n \\"User\\": {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"RamId\\": \\"20225462120879xxxx\\",\\n \\"UserId\\": \\"6f3e7751-fa61-453f-8057-a2fe9741xxxx\\",\\n \\"Roles\\": [\\n {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"RoleName\\": \\"ADMIN\\",\\n \\"RoleDescription\\": \\"管理员\\",\\n \\"RoleId\\": \\"59a3d864-2f98-4f5e-84ec-c1ea13afxxxx\\"\\n }\\n ],\\n \\"SkillLevels\\": [\\n {\\n \\"SkillLevelId\\": \\"181792\\",\\n \\"Level\\": 4,\\n \\"Skill\\": {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"SkillGroupDescription\\": \\"描述\\",\\n \\"SkillGroupId\\": \\"a053e6d5-16ee-4283-9c81-631b78aexxxx\\",\\n \\"SkillGroupName\\": \\"默认技能组\\"\\n }\\n }\\n ],\\n \\"Detail\\": {\\n \\"DisplayName\\": \\"test\\",\\n \\"Extension\\": \\"8037****\\",\\n \\"LoginName\\": \\"test123\\",\\n \\"Email\\": \\"test@alibaba-inc.com\\",\\n \\"Department\\": \\"IT\\",\\n \\"Phone\\": \\"1360176****\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n 6f3e7751-fa61-453f-8057-a2fe9741xxxx\\n 20225462120879xxxx\\n \\n 181792\\n 4\\n \\n 默认技能组\\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n a053e6d5-16ee-4283-9c81-631b78aexxxx\\n 描述\\n \\n \\n \\n ADMIN\\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n 管理员\\n 59a3d864-2f98-4f5e-84ec-c1ea13afxxxx\\n \\n \\n 8037****\\n test123\\n IT\\n test@alibaba-inc.com\\n 1360176****\\n test\\n \\n\\n无\\n9FBA26B0-462B-4D77-B78F-AF35560DBC71\\n200\\nOK\\ntrue","errorExample":""}]', @@ -12375,14 +6065,8 @@ ], 'AssignUsers' => [ 'summary' => '把目录服务中的一组用户添加到一个呼叫中心实例中。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12397,20 +6081,13 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREccc8HB4RI', - ], + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待添加用户的呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '待添加用户的呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'UserRamId', @@ -12419,9 +6096,7 @@ 'schema' => [ 'description' => '待添加的目录服务中的用户RAM ID', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'example' => '6f3e7751-fa61-453f-8057-a2fe9741a387', 'maxItems' => 99, @@ -12434,9 +6109,7 @@ 'schema' => [ 'description' => '新添加用户的角色ID', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '4c2e158e-ddd9-464a-a3fc-338eca10277c', 'maxItems' => 99, @@ -12449,9 +6122,7 @@ 'schema' => [ 'description' => '待创建用户所归属的技能组ID', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18ef28', 'maxItems' => 99, @@ -12464,10 +6135,7 @@ 'schema' => [ 'description' => '待创建用户所具有的技能级别', 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'items' => ['type' => 'integer', 'format' => 'int32'], 'required' => false, 'example' => '4', 'maxItems' => 99, @@ -12479,32 +6147,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'type' => 'object', 'itemNode' => true, @@ -12514,18 +6161,10 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'type' => 'string', - ], - 'UserId' => [ - 'type' => 'string', - ], - 'RamId' => [ - 'type' => 'string', - ], - 'Primary' => [ - 'type' => 'boolean', - ], + 'InstanceId' => ['type' => 'string'], + 'UserId' => ['type' => 'string'], + 'RamId' => ['type' => 'string'], + 'Primary' => ['type' => 'boolean'], ], ], ], @@ -12543,14 +6182,8 @@ ], 'ResetUserStatus' => [ 'summary' => '重置异常状态的坐席。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12565,21 +6198,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '云呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], + 'schema' => ['description' => '云呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], ], [ 'name' => 'RamIdList', @@ -12588,10 +6213,7 @@ 'schema' => [ 'description' => '云呼叫中心子账号的RamId，管理员可重置该实例异常坐席的状态信息，技能组组长可用于重置该技能组下异常坐席的状态信息，可通过[ListUsers](https://help.aliyun.com/document_detail/63052.html?spm=a2c4g.11186623.6.669.60a42ec43cAdOk)接口进行查询获取', 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'items' => ['type' => 'integer', 'format' => 'int64'], 'required' => false, 'example' => '12345678', 'maxItems' => 99, @@ -12603,32 +6225,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => '响应状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应提示信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID,可用于接口的日志查询', - 'type' => 'string', - 'example' => '2D4F3E45-96CD-4210-B15B-F27BAC29FE29', - ], - 'Success' => [ - 'description' => '是否调用成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => '响应状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应提示信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID,可用于接口的日志查询', 'type' => 'string', 'example' => '2D4F3E45-96CD-4210-B15B-F27BAC29FE29'], + 'Success' => ['description' => '是否调用成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -12642,14 +6243,8 @@ ], 'ModifyUser' => [ 'summary' => '调用ModifyUser修改用户数据。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12664,72 +6259,40 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREccc8HB4RI', - ], + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'DisplayName', 'in' => 'query', - 'schema' => [ - 'description' => '用户的全名', - 'type' => 'string', - 'required' => true, - 'example' => '张先生', - ], + 'schema' => ['description' => '用户的全名', 'type' => 'string', 'required' => true, 'example' => '张先生'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '待修改的用户ID。'."\n" - ."\n\n" - .'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', - 'type' => 'string', - 'required' => true, - 'example' => '6f3e7751-fa61-453f-8057-a2fe9741****', - ], + 'schema' => ['description' => '待修改的用户ID。'."\n" + ."\n\n" + .'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', 'type' => 'string', 'required' => true, 'example' => '6f3e7751-fa61-453f-8057-a2fe9741****'], ], [ 'name' => 'Phone', 'in' => 'query', - 'schema' => [ - 'description' => '用户的电话号码', - 'type' => 'string', - 'required' => true, - 'example' => '1886666****', - ], + 'schema' => ['description' => '用户的电话号码', 'type' => 'string', 'required' => true, 'example' => '1886666****'], ], [ 'name' => 'Email', 'in' => 'query', - 'schema' => [ - 'description' => '用户的电子邮件', - 'type' => 'string', - 'required' => true, - 'example' => 'username@example.com', - ], + 'schema' => ['description' => '用户的电子邮件', 'type' => 'string', 'required' => true, 'example' => 'username@example.com'], ], [ 'name' => 'PrivateOutboundNumberId', 'in' => 'query', - 'schema' => [ - 'description' => '个人外呼号码的PhoneNumberId', - 'type' => 'string', - 'required' => false, - 'example' => 'a08d255e-12a5-48f8-93e0-6b8e1b6d****', - ], + 'schema' => ['description' => '个人外呼号码的PhoneNumberId', 'type' => 'string', 'required' => false, 'example' => 'a08d255e-12a5-48f8-93e0-6b8e1b6d****'], ], [ 'name' => 'RoleId', @@ -12738,9 +6301,7 @@ 'schema' => [ 'description' => '指定待创建用户的角色，需传入角色ID', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'example' => '4c2e158e-ddd9-464a-a3fc-338eca10****', 'maxItems' => 99, @@ -12755,9 +6316,7 @@ ."\n\n" .'SkillGroupId.1意为只绑定到一个技能组中，如果绑定多个技能组，则需要传多个，例如 SkillGroupId.1、SkillGroupId.2、SkillGroupId.3，以此类推。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18****', 'maxItems' => 99, @@ -12772,10 +6331,7 @@ ."\n" .'**SkillLevel.1**表示为SkillGroupId.1的技能组等级，如果SkillGroupId为多个，则SkillLevel也需要多个，并且数量需要保持一致。', 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'items' => ['type' => 'integer', 'format' => 'int32'], 'required' => false, 'example' => '4', 'maxItems' => 99, @@ -12787,32 +6343,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -12826,14 +6361,8 @@ ], 'GetUser' => [ 'summary' => '调用GetUser根据用户ID获取用户信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12848,34 +6377,20 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '用户ID。'."\n" - ."\n" - .'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '6f3e7751-fa61-453f-8057-a2fe9741xxxx', - ], + 'schema' => ['description' => '用户ID。'."\n" + ."\n" + .'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6f3e7751-fa61-453f-8057-a2fe9741xxxx'], ], ], 'responses' => [ @@ -12883,53 +6398,20 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'User' => [ 'description' => '用户信息', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '用户所归属的呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], - 'RamId' => [ - 'description' => '用户所对应的RAM账户ID', - 'type' => 'string', - 'example' => '20225462120879xxxx', - ], - 'UserId' => [ - 'description' => '用户ID，系统自动生成的唯一标示符。'."\n" - ."\n" - .'> 注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', - 'type' => 'string', - 'example' => '6f3e7751-fa61-453f-8057-a2fe9741xxxx', - ], + 'InstanceId' => ['description' => '用户所归属的呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], + 'RamId' => ['description' => '用户所对应的RAM账户ID', 'type' => 'string', 'example' => '20225462120879xxxx'], + 'UserId' => ['description' => '用户ID，系统自动生成的唯一标示符。'."\n" + ."\n" + .'> 注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', 'type' => 'string', 'example' => '6f3e7751-fa61-453f-8057-a2fe9741xxxx'], 'Roles' => [ 'type' => 'object', 'itemNode' => true, @@ -12940,26 +6422,10 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '角色所归属的呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], - 'RoleName' => [ - 'description' => '角色名称', - 'type' => 'string', - 'example' => 'AGENT', - ], - 'RoleDescription' => [ - 'description' => '角色描述', - 'type' => 'string', - 'example' => '坐席', - ], - 'RoleId' => [ - 'description' => '角色ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '4c2e158e-ddd9-464a-a3fc-338eca10xxxx', - ], + 'InstanceId' => ['description' => '角色所归属的呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], + 'RoleName' => ['description' => '角色名称', 'type' => 'string', 'example' => 'AGENT'], + 'RoleDescription' => ['description' => '角色描述', 'type' => 'string', 'example' => '坐席'], + 'RoleId' => ['description' => '角色ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '4c2e158e-ddd9-464a-a3fc-338eca10xxxx'], ], ], ], @@ -12975,41 +6441,16 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SkillLevelId' => [ - 'description' => '技能级别唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '121335', - ], - 'Level' => [ - 'description' => '技能级别', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], + 'SkillLevelId' => ['description' => '技能级别唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '121335'], + 'Level' => ['description' => '技能级别', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], 'Skill' => [ 'description' => '技能', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '技能组所归属的呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], - 'SkillGroupDescription' => [ - 'description' => '技能组简单描述', - 'type' => 'string', - 'example' => '售后技术支持人员使用', - ], - 'SkillGroupId' => [ - 'description' => '技能组唯一ID,系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx', - ], - 'SkillGroupName' => [ - 'description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', - 'type' => 'string', - 'example' => '售后技术支持技能组', - ], + 'InstanceId' => ['description' => '技能组所归属的呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], + 'SkillGroupDescription' => ['description' => '技能组简单描述', 'type' => 'string', 'example' => '售后技术支持人员使用'], + 'SkillGroupId' => ['description' => '技能组唯一ID,系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx'], + 'SkillGroupName' => ['description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', 'type' => 'string', 'example' => '售后技术支持技能组'], ], ], ], @@ -13021,31 +6462,11 @@ 'description' => '用户详细信息。@Transient', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'description' => '用户的全名', - 'type' => 'string', - 'example' => '王明', - ], - 'Email' => [ - 'description' => '用户的电子邮件地址', - 'type' => 'string', - 'example' => '1886666****@163.com', - ], - 'LoginName' => [ - 'description' => '用户登录名', - 'type' => 'string', - 'example' => 'user05', - ], - 'Department' => [ - 'description' => '所属部门', - 'type' => 'string', - 'example' => 'IT', - ], - 'Phone' => [ - 'description' => '用户的电话号码', - 'type' => 'string', - 'example' => '1886666****', - ], + 'DisplayName' => ['description' => '用户的全名', 'type' => 'string', 'example' => '王明'], + 'Email' => ['description' => '用户的电子邮件地址', 'type' => 'string', 'example' => '1886666****@163.com'], + 'LoginName' => ['description' => '用户登录名', 'type' => 'string', 'example' => 'user05'], + 'Department' => ['description' => '所属部门', 'type' => 'string', 'example' => 'IT'], + 'Phone' => ['description' => '用户的电话号码', 'type' => 'string', 'example' => '1886666****'], ], ], ], @@ -13064,14 +6485,8 @@ ], 'ListUsers' => [ 'summary' => '调用ListUsers获取呼叫中心实例中的所有用户。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13085,42 +6500,23 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取用户的呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], + 'schema' => ['description' => '待获取用户的呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'], ], ], 'responses' => [ @@ -13128,54 +6524,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '707EF054-E614-4A4A-98D4-F4457073F111', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '707EF054-E614-4A4A-98D4-F4457073F111'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Users' => [ 'description' => '获取到的呼叫中心实例中的用户列表', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalCount' => [ - 'description' => '对象总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '14', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'TotalCount' => ['description' => '对象总数', 'type' => 'integer', 'format' => 'int32', 'example' => '14'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -13186,33 +6546,13 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'PrivateOutboundNumberId' => [ - 'description' => '个人外呼号码的PhoneNumberId', - 'type' => 'string', - 'example' => 'a08d255e-12a5-48f8-93e0-6b8e1b6dxxxx', - ], - 'Primary' => [ - 'description' => '是否为主账户', - 'type' => 'boolean', - 'example' => 'false', - ], - 'InstanceId' => [ - 'description' => '用户所归属的呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], - 'RamId' => [ - 'description' => '用户所对应的RAM子账户ID', - 'type' => 'string', - 'example' => '29303293146891xxxx', - ], - 'UserId' => [ - 'description' => '用户ID，系统自动生成的唯一标示符。'."\n" - ."\n\n" - .'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', - 'type' => 'string', - 'example' => 'b80bd838-a5a5-4ed3-ac9a-30be353dxxxx', - ], + 'PrivateOutboundNumberId' => ['description' => '个人外呼号码的PhoneNumberId', 'type' => 'string', 'example' => 'a08d255e-12a5-48f8-93e0-6b8e1b6dxxxx'], + 'Primary' => ['description' => '是否为主账户', 'type' => 'boolean', 'example' => 'false'], + 'InstanceId' => ['description' => '用户所归属的呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], + 'RamId' => ['description' => '用户所对应的RAM子账户ID', 'type' => 'string', 'example' => '29303293146891xxxx'], + 'UserId' => ['description' => '用户ID，系统自动生成的唯一标示符。'."\n" + ."\n\n" + .'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', 'type' => 'string', 'example' => 'b80bd838-a5a5-4ed3-ac9a-30be353dxxxx'], 'Roles' => [ 'type' => 'object', 'itemNode' => true, @@ -13223,26 +6563,10 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '角色所归属的呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], - 'RoleName' => [ - 'description' => '角色名称', - 'type' => 'string', - 'example' => 'AGENT', - ], - 'RoleDescription' => [ - 'description' => '角色描述', - 'type' => 'string', - 'example' => '坐席', - ], - 'RoleId' => [ - 'description' => '角色ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '4c2e158e-ddd9-464a-a3fc-338eca10xxxx', - ], + 'InstanceId' => ['description' => '角色所归属的呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], + 'RoleName' => ['description' => '角色名称', 'type' => 'string', 'example' => 'AGENT'], + 'RoleDescription' => ['description' => '角色描述', 'type' => 'string', 'example' => '坐席'], + 'RoleId' => ['description' => '角色ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '4c2e158e-ddd9-464a-a3fc-338eca10xxxx'], ], ], ], @@ -13258,41 +6582,16 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SkillLevelId' => [ - 'description' => '技能级别唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '121335', - ], - 'Level' => [ - 'description' => '技能级别', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], + 'SkillLevelId' => ['description' => '技能级别唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '121335'], + 'Level' => ['description' => '技能级别', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], 'Skill' => [ 'description' => '技能', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '技能组所归属的呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], - 'SkillGroupDescription' => [ - 'description' => '技能组简单描述', - 'type' => 'string', - 'example' => '售后技术支持人员使用', - ], - 'SkillGroupId' => [ - 'description' => '技能组唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx', - ], - 'SkillGroupName' => [ - 'description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', - 'type' => 'string', - 'example' => '售后技术支持技能组', - ], + 'InstanceId' => ['description' => '技能组所归属的呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], + 'SkillGroupDescription' => ['description' => '技能组简单描述', 'type' => 'string', 'example' => '售后技术支持人员使用'], + 'SkillGroupId' => ['description' => '技能组唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx'], + 'SkillGroupName' => ['description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', 'type' => 'string', 'example' => '售后技术支持技能组'], ], ], ], @@ -13304,31 +6603,11 @@ 'description' => '用户详细信息。', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'description' => '用户的全名', - 'type' => 'string', - 'example' => '王明', - ], - 'Email' => [ - 'description' => '用户的电子邮件地址', - 'type' => 'string', - 'example' => '1886666****@163.com', - ], - 'LoginName' => [ - 'description' => '用户登录名', - 'type' => 'string', - 'example' => 'user05', - ], - 'Department' => [ - 'description' => '所属部门', - 'type' => 'string', - 'example' => 'IT', - ], - 'Phone' => [ - 'description' => '用户的电话号码', - 'type' => 'string', - 'example' => '1886666****', - ], + 'DisplayName' => ['description' => '用户的全名', 'type' => 'string', 'example' => '王明'], + 'Email' => ['description' => '用户的电子邮件地址', 'type' => 'string', 'example' => '1886666****@163.com'], + 'LoginName' => ['description' => '用户登录名', 'type' => 'string', 'example' => 'user05'], + 'Department' => ['description' => '所属部门', 'type' => 'string', 'example' => 'IT'], + 'Phone' => ['description' => '用户的电话号码', 'type' => 'string', 'example' => '1886666****'], ], ], ], @@ -13352,14 +6631,8 @@ ], 'ListRoles' => [ 'summary' => '获取的账号所能管理的角色。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13373,20 +6646,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取角色列表的呼叫中心实例的ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '待获取角色列表的呼叫中心实例的ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], ], 'responses' => [ @@ -13394,32 +6660,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '711D948F-C616-4E23-8573-0F260513CE09', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '711D948F-C616-4E23-8573-0F260513CE09'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Roles' => [ 'type' => 'object', 'itemNode' => true, @@ -13430,26 +6675,10 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '角色所归属的呼叫中心实例', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], - 'RoleName' => [ - 'description' => '角色名称', - 'type' => 'string', - 'example' => 'SKILL_GROUP_ADMIN', - ], - 'RoleDescription' => [ - 'description' => '角色描述', - 'type' => 'string', - 'example' => '技能组组长', - ], - 'RoleId' => [ - 'description' => '角色ID，系统自动生成的唯一标示符', - 'type' => 'string', - 'example' => '42d97cec-386b-4770-ad7b-0e6a4e665c74', - ], + 'InstanceId' => ['description' => '角色所归属的呼叫中心实例', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], + 'RoleName' => ['description' => '角色名称', 'type' => 'string', 'example' => 'SKILL_GROUP_ADMIN'], + 'RoleDescription' => ['description' => '角色描述', 'type' => 'string', 'example' => '技能组组长'], + 'RoleId' => ['description' => '角色ID，系统自动生成的唯一标示符', 'type' => 'string', 'example' => '42d97cec-386b-4770-ad7b-0e6a4e665c74'], ], ], ], @@ -13468,14 +6697,8 @@ ], 'FindUsers' => [ 'summary' => '搜索呼叫中心实例中的所有用户。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13489,52 +6712,28 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREccc8HB4RI', - ], + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取用户的呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '待获取用户的呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'Criteria', 'in' => 'query', - 'schema' => [ - 'description' => '待查询名称，可以传登录名或者展示名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '待查询名称，可以传登录名或者展示名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'], ], ], 'responses' => [ @@ -13542,54 +6741,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Users' => [ 'description' => '获取到的呼叫中心实例中的用户列表', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '对象总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '对象总数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -13600,28 +6763,12 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'PrivateOutboundNumberId' => [ - 'description' => '个人外呼号码的PhoneNumberId', - 'type' => 'string', - 'example' => 'a08d255e-12a5-48f8-93e0-6b8e1b6d****', - ], - 'InstanceId' => [ - 'description' => '用户所归属的呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], - 'RamId' => [ - 'description' => '用户所对应的RAM账户ID', - 'type' => 'string', - 'example' => '29491103620126****', - ], - 'UserId' => [ - 'description' => '用户唯一标识。'."\n" - ."\n\n" - .'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', - 'type' => 'string', - 'example' => '674a5953-21d5-4ee9-9b42-eb8813d6****', - ], + 'PrivateOutboundNumberId' => ['description' => '个人外呼号码的PhoneNumberId', 'type' => 'string', 'example' => 'a08d255e-12a5-48f8-93e0-6b8e1b6d****'], + 'InstanceId' => ['description' => '用户所归属的呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], + 'RamId' => ['description' => '用户所对应的RAM账户ID', 'type' => 'string', 'example' => '29491103620126****'], + 'UserId' => ['description' => '用户唯一标识。'."\n" + ."\n\n" + .'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', 'type' => 'string', 'example' => '674a5953-21d5-4ee9-9b42-eb8813d6****'], 'Roles' => [ 'type' => 'object', 'itemNode' => true, @@ -13632,26 +6779,10 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '角色所归属的呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], - 'RoleName' => [ - 'description' => '角色名称', - 'type' => 'string', - 'example' => 'ADMIN', - ], - 'RoleDescription' => [ - 'description' => '角色描述', - 'type' => 'string', - 'example' => '管理员', - ], - 'RoleId' => [ - 'description' => '角色ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '59a3d864-2f98-4f5e-84ec-c1ea13af****', - ], + 'InstanceId' => ['description' => '角色所归属的呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], + 'RoleName' => ['description' => '角色名称', 'type' => 'string', 'example' => 'ADMIN'], + 'RoleDescription' => ['description' => '角色描述', 'type' => 'string', 'example' => '管理员'], + 'RoleId' => ['description' => '角色ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '59a3d864-2f98-4f5e-84ec-c1ea13af****'], ], ], ], @@ -13667,41 +6798,16 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SkillLevelId' => [ - 'description' => '技能级别唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '181792', - ], - 'Level' => [ - 'description' => '技能级别', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], + 'SkillLevelId' => ['description' => '技能级别唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '181792'], + 'Level' => ['description' => '技能级别', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], 'Skill' => [ 'description' => '技能组', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '技能组所归属的呼叫中心实例', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], - 'SkillGroupDescription' => [ - 'description' => '技能组简单描述', - 'type' => 'string', - 'example' => '描述', - ], - 'SkillGroupId' => [ - 'description' => '技能组唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => 'a053e6d5-16ee-4283-9c81-631b78ae****', - ], - 'SkillGroupName' => [ - 'description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', - 'type' => 'string', - 'example' => '默认技能组', - ], + 'InstanceId' => ['description' => '技能组所归属的呼叫中心实例', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], + 'SkillGroupDescription' => ['description' => '技能组简单描述', 'type' => 'string', 'example' => '描述'], + 'SkillGroupId' => ['description' => '技能组唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => 'a053e6d5-16ee-4283-9c81-631b78ae****'], + 'SkillGroupName' => ['description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', 'type' => 'string', 'example' => '默认技能组'], ], ], ], @@ -13713,31 +6819,11 @@ 'description' => '用户详细信息', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'description' => '用户的全名', - 'type' => 'string', - 'example' => 'test', - ], - 'Email' => [ - 'description' => '用户的电子邮件地址', - 'type' => 'string', - 'example' => 'test@alibaba-inc.com', - ], - 'LoginName' => [ - 'description' => '用户登录名', - 'type' => 'string', - 'example' => 'test123', - ], - 'Department' => [ - 'description' => '用户的部门', - 'type' => 'string', - 'example' => 'IT', - ], - 'Phone' => [ - 'description' => '用户的电话号码', - 'type' => 'string', - 'example' => '1360176****', - ], + 'DisplayName' => ['description' => '用户的全名', 'type' => 'string', 'example' => 'test'], + 'Email' => ['description' => '用户的电子邮件地址', 'type' => 'string', 'example' => 'test@alibaba-inc.com'], + 'LoginName' => ['description' => '用户登录名', 'type' => 'string', 'example' => 'test123'], + 'Department' => ['description' => '用户的部门', 'type' => 'string', 'example' => 'IT'], + 'Phone' => ['description' => '用户的电话号码', 'type' => 'string', 'example' => '1360176****'], ], ], ], @@ -13761,14 +6847,8 @@ ], 'RemoveUsers' => [ 'summary' => '调用RemoveUsers从一个呼叫中心实例中移除一组用户。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13783,20 +6863,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREccc8HB4RI', - ], + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待移除用户的呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '待移除用户的呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'UserId', @@ -13807,9 +6880,7 @@ ."\n\n" .'**UserId.1**意为只移除一个坐席，如果移除多个，则需要传多个，例如 UserId.1、UserId.2、UserId.3，以此类推，具体请参考下方的请求示例。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'example' => '7ed274a5-6351-4dbd-9f13-6ac63c8ef296', 'maxItems' => 99, @@ -13821,32 +6892,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '1F9834D8-6D09-4A1B-BADB-B019D9D444D8', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '1F9834D8-6D09-4A1B-BADB-B019D9D444D8'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -13857,14 +6907,8 @@ ], 'AddAgentDevice' => [ 'summary' => '当坐席上线时，保存坐席设备的基本信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13879,63 +6923,33 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREccc8HB4RI', - ], + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'ClientIp', 'in' => 'query', - 'schema' => [ - 'description' => '客户端IP地址', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '127.0.0.1', - ], + 'schema' => ['description' => '客户端IP地址', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '127.0.0.1'], ], [ 'name' => 'ClientPort', 'in' => 'query', - 'schema' => [ - 'description' => '客户端IP端口', - 'type' => 'string', - 'required' => false, - 'example' => '8080', - ], + 'schema' => ['description' => '客户端IP端口', 'type' => 'string', 'required' => false, 'example' => '8080'], ], [ 'name' => 'BrowserVersion', 'in' => 'formData', - 'schema' => [ - 'description' => '浏览器版本信息', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Chrome/74.0.3729.169', - ], + 'schema' => ['description' => '浏览器版本信息', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Chrome/74.0.3729.169'], ], [ 'name' => 'Remark', 'in' => 'formData', - 'schema' => [ - 'description' => '其他备注信息', - 'type' => 'string', - 'required' => false, - 'example' => '备注', - ], + 'schema' => ['description' => '其他备注信息', 'type' => 'string', 'required' => false, 'example' => '备注'], ], ], 'responses' => [ @@ -13943,40 +6957,14 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'AgentDeviceId' => [ - 'description' => '保存数据的ID。'."\n" - ."\n" - .'用于给ModifyAgentDevice提供数据来记录登录是否成功。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '456', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'A13BB835-94AA-4E55-8D9E-5EA585CE6555"', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'AgentDeviceId' => ['description' => '保存数据的ID。'."\n" + ."\n" + .'用于给ModifyAgentDevice提供数据来记录登录是否成功。', 'type' => 'integer', 'format' => 'int64', 'example' => '456'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'A13BB835-94AA-4E55-8D9E-5EA585CE6555"'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], ], ], ], @@ -13991,14 +6979,8 @@ ], 'ModifyAgentDevice' => [ 'summary' => '当坐席上线成功时，更新坐席设备中的坐席的登录状态。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14013,48 +6995,26 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'IsLogin', 'in' => 'query', - 'schema' => [ - 'description' => '是否签入成功。取值：'."\n" - ."\n" - .'- 0（默认）：签入失败'."\n" - .'- 1：签入成功', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '是否签入成功。取值：'."\n" + ."\n" + .'- 0（默认）：签入失败'."\n" + .'- 1：签入成功', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'AgentDeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席设备唯一标识', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '456', - ], + 'schema' => ['description' => '坐席设备唯一标识', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '456'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], ], 'responses' => [ @@ -14062,32 +7022,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'A13BB835-94AA-4E55-8D9E-5EA585CEA98D', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'A13BB835-94AA-4E55-8D9E-5EA585CEA98D'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -14100,14 +7039,8 @@ ], 'ListRealTimeAgent' => [ 'summary' => '获取呼叫中心实例中的所有可转接的坐席，其中可转接是指坐席处于空闲状态或者坐席存有个人手机号。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14121,21 +7054,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取用户的呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '待获取用户的呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], ], 'responses' => [ @@ -14143,32 +7068,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '51DE4272-1711-4FF3-805F-7FBD2251AA0D', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '51DE4272-1711-4FF3-805F-7FBD2251AA0D'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'type' => 'object', 'itemNode' => true, @@ -14179,36 +7083,12 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'description' => '坐席展示名', - 'type' => 'string', - 'example' => '模板导入坐席', - ], - 'StateDesc' => [ - 'description' => '坐席状态描述', - 'type' => 'string', - 'example' => '未上线', - ], - 'Dn' => [ - 'description' => '坐席分机号', - 'type' => 'string', - 'example' => '8031****', - ], - 'State' => [ - 'description' => '坐席状态', - 'type' => 'string', - 'example' => '3', - ], - 'RamId' => [ - 'description' => '坐席RAM子账号', - 'type' => 'string', - 'example' => '21577102482268****', - ], - 'Phone' => [ - 'description' => '坐席手机号', - 'type' => 'string', - 'example' => '1880134****', - ], + 'DisplayName' => ['description' => '坐席展示名', 'type' => 'string', 'example' => '模板导入坐席'], + 'StateDesc' => ['description' => '坐席状态描述', 'type' => 'string', 'example' => '未上线'], + 'Dn' => ['description' => '坐席分机号', 'type' => 'string', 'example' => '8031****'], + 'State' => ['description' => '坐席状态', 'type' => 'string', 'example' => '3'], + 'RamId' => ['description' => '坐席RAM子账号', 'type' => 'string', 'example' => '21577102482268****'], + 'Phone' => ['description' => '坐席手机号', 'type' => 'string', 'example' => '1880134****'], 'SkillLevels' => [ 'type' => 'object', 'itemNode' => true, @@ -14219,41 +7099,16 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SkillLevelId' => [ - 'description' => '技能级别唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '101271', - ], - 'Level' => [ - 'description' => '技能级别', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], + 'SkillLevelId' => ['description' => '技能级别唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '101271'], + 'Level' => ['description' => '技能级别', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], 'Skill' => [ 'description' => '技能', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '技能组所归属的呼叫中心实例。', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], - 'SkillGroupDescription' => [ - 'description' => '技能组简单描述。', - 'type' => 'string', - 'example' => '默认技能组', - ], - 'SkillGroupId' => [ - 'description' => '技能组唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '0ee27b3b-6765-499a-a741-61b16a90****', - ], - 'SkillGroupName' => [ - 'description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', - 'type' => 'string', - 'example' => 'Default', - ], + 'InstanceId' => ['description' => '技能组所归属的呼叫中心实例。', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], + 'SkillGroupDescription' => ['description' => '技能组简单描述。', 'type' => 'string', 'example' => '默认技能组'], + 'SkillGroupId' => ['description' => '技能组唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '0ee27b3b-6765-499a-a741-61b16a90****'], + 'SkillGroupName' => ['description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', 'type' => 'string', 'example' => 'Default'], ], ], ], @@ -14279,14 +7134,8 @@ ], 'ListAgentStateLogs' => [ 'summary' => '获取呼叫中心实例中坐席的状态日志。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14301,81 +7150,38 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取用户的呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], + 'schema' => ['description' => '待获取用户的呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], ], [ 'name' => 'RamId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席的RAM ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '233600862826937630', - ], + 'schema' => ['description' => '坐席的RAM ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '233600862826937630'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1607911199000', - ], + 'schema' => ['description' => '开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1607911199000'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间，注意查询时间范围不能大于2小时，否则会报错。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1607918399000', - ], + 'schema' => ['description' => '结束时间，注意查询时间范围不能大于2小时，否则会报错。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1607918399000'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '2', - ], + 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2'], ], ], 'responses' => [ @@ -14383,107 +7189,33 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], 'AgentStateLogPage' => [ 'description' => '坐席状态日志列表。', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '对象总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'PageNumber' => ['description' => '分页序号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '对象总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'List' => [ 'description' => '对象列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'StateCode' => [ - 'description' => '坐席子状态。', - 'type' => 'string', - 'example' => 'StartMonitoring', - ], - 'ContactId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => '2952482622', - ], - 'State' => [ - 'description' => '坐席状态。', - 'type' => 'string', - 'example' => 'Talking', - ], - 'ConnectId' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'example' => '2952482621', - ], - 'StateTime' => [ - 'description' => '状态对应的时刻。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1607911119000', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], - 'RamId' => [ - 'description' => '坐席的RamId。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '233600862826937630', - ], - 'SkillGroupIds' => [ - 'description' => '坐席所在的技能组列表。', - 'type' => 'string', - 'example' => 'f762fa1d-d8cb-4d4c-aa0a-b3e0c1f05347,b09c567c-9d74-43e6-9106-86e1bf2da52b', - ], - 'CounterParty' => [ - 'description' => '对端：所监听对象的RamId。非监听场景或被监听者不展示此字段。', - 'type' => 'string', - 'example' => '135600862836930633', - ], + 'StateCode' => ['description' => '坐席子状态。', 'type' => 'string', 'example' => 'StartMonitoring'], + 'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => '2952482622'], + 'State' => ['description' => '坐席状态。', 'type' => 'string', 'example' => 'Talking'], + 'ConnectId' => ['description' => '话务ID。', 'type' => 'string', 'example' => '2952482621'], + 'StateTime' => ['description' => '状态对应的时刻。', 'type' => 'integer', 'format' => 'int64', 'example' => '1607911119000'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], + 'RamId' => ['description' => '坐席的RamId。', 'type' => 'integer', 'format' => 'int64', 'example' => '233600862826937630'], + 'SkillGroupIds' => ['description' => '坐席所在的技能组列表。', 'type' => 'string', 'example' => 'f762fa1d-d8cb-4d4c-aa0a-b3e0c1f05347,b09c567c-9d74-43e6-9106-86e1bf2da52b'], + 'CounterParty' => ['description' => '对端：所监听对象的RamId。非监听场景或被监听者不展示此字段。', 'type' => 'string', 'example' => '135600862836930633'], ], ], ], @@ -14502,14 +7234,8 @@ ], 'ListAgentStates' => [ 'summary' => '调用ListAgentStates获取坐席状态。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14524,77 +7250,42 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID', - 'type' => 'string', - 'required' => false, - 'example' => 'XXX', - ], + 'schema' => ['description' => '技能组ID', 'type' => 'string', 'required' => false, 'example' => 'XXX'], ], [ 'name' => 'AgentIds', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID列表。'."\n" - ."\n" - .'坐席ID等同于该座席的RAM子账户ID，最多50个坐席；不传则查询全部。', - 'type' => 'string', - 'required' => false, - 'example' => '237432034227828673', - ], + 'schema' => ['description' => '坐席ID列表。'."\n" + ."\n" + .'坐席ID等同于该座席的RAM子账户ID，最多50个坐席；不传则查询全部。', 'type' => 'string', 'required' => false, 'example' => '237432034227828673'], ], [ 'name' => 'State', 'in' => 'query', - 'schema' => [ - 'description' => '坐席状态列表。'."\n" - ."\n" - .'不传查询全部。枚举值：ACW:话后处理中,Break:小休,Dialing:拨号,Ringing:振铃,Ready:等待,Talking:通话。', - 'type' => 'string', - 'required' => false, - 'example' => 'ACW', - ], + 'schema' => ['description' => '坐席状态列表。'."\n" + ."\n" + .'不传查询全部。枚举值：ACW:话后处理中,Break:小休,Dialing:拨号,Ringing:振铃,Ready:等待,Talking:通话。', 'type' => 'string', 'required' => false, 'example' => 'ACW'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，默认值为1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号，默认值为1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，默认值为10，最大是100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '分页大小，默认值为10，最大是100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -14602,54 +7293,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求iD', - 'type' => 'string', - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求iD', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '报表', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalCount' => [ - 'description' => '总个数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'TotalCount' => ['description' => '总个数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -14660,41 +7315,13 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'LoginName' => [ - 'description' => '座席登录名', - 'type' => 'string', - 'example' => 'paige', - ], - 'Dn' => [ - 'description' => '分机号码', - 'type' => 'string', - 'example' => '80301522', - ], - 'StateDuration' => [ - 'description' => '坐席状态持续时长', - 'type' => 'string', - 'example' => '10', - ], - 'State' => [ - 'description' => '座席状态描述，会有以下描述：会议、发起求助、处理、小休、拨号、振铃、求助、等待、通话。', - 'type' => 'string', - 'example' => 'Ready', - ], - 'AgentId' => [ - 'description' => '座席ID，等同于该座席的RAM子账户ID。', - 'type' => 'string', - 'example' => '237432034227828673', - ], - 'AgentName' => [ - 'description' => '座席名称', - 'type' => 'string', - 'example' => '派鸽', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'LoginName' => ['description' => '座席登录名', 'type' => 'string', 'example' => 'paige'], + 'Dn' => ['description' => '分机号码', 'type' => 'string', 'example' => '80301522'], + 'StateDuration' => ['description' => '坐席状态持续时长', 'type' => 'string', 'example' => '10'], + 'State' => ['description' => '座席状态描述，会有以下描述：会议、发起求助、处理、小休、拨号、振铃、求助、等待、通话。', 'type' => 'string', 'example' => 'Ready'], + 'AgentId' => ['description' => '座席ID，等同于该座席的RAM子账户ID。', 'type' => 'string', 'example' => '237432034227828673'], + 'AgentName' => ['description' => '座席名称', 'type' => 'string', 'example' => '派鸽'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], ], ], @@ -14719,14 +7346,8 @@ ], 'ListAgentSummaryReports' => [ 'summary' => '查询坐席指标的某个时间范围汇总报表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14741,85 +7362,43 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], ], [ 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID', - 'type' => 'string', - 'required' => false, - 'example' => 'fb654c6-17c6-4501-ba57-f5ddeb919814', - ], + 'schema' => ['description' => '技能组ID', 'type' => 'string', 'required' => false, 'example' => 'fb654c6-17c6-4501-ba57-f5ddeb919814'], ], [ 'name' => 'AgentIds', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID列表(使用“,”隔开)，坐席ID等同于该座席的RAM子账户ID，最多50个坐席；不传查询全部。', - 'type' => 'string', - 'required' => false, - 'example' => '2769707711429472695', - ], + 'schema' => ['description' => '坐席ID列表(使用“,”隔开)，坐席ID等同于该座席的RAM子账户ID，最多50个坐席；不传查询全部。', 'type' => 'string', 'required' => false, 'example' => '2769707711429472695'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '起始日期，格式yyyy-MM-dd HH:mm:ss；需要注意目前仅支持按天维度的查询，参数设置请参考案例。同时时间设置不得早于6个月前的时间点', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-08-01 00:00:00', - ], + 'schema' => ['description' => '起始日期，格式yyyy-MM-dd HH:mm:ss；需要注意目前仅支持按天维度的查询，参数设置请参考案例。同时时间设置不得早于6个月前的时间点', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-08-01 00:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '终止日期，格式：yyyy-MM-dd HH:mm:ss；需要注意目前仅支持按天维度的查询，参数设置请参考案例。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-08-07 00:00:00', - ], + 'schema' => ['description' => '终止日期，格式：yyyy-MM-dd HH:mm:ss；需要注意目前仅支持按天维度的查询，参数设置请参考案例。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-08-07 00:00:00'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，默认值为10，最大是100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '分页大小，默认值为10，最大是100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], ], 'responses' => [ @@ -14827,54 +7406,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '685904F9-C253-49EF-8255-384888B794D2', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '685904F9-C253-49EF-8255-384888B794D2'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'PagedAgentSummaryReport' => [ 'description' => '报表', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalCount' => [ - 'description' => '总个数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'TotalCount' => ['description' => '总个数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -14885,349 +7428,78 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'LoginName' => [ - 'description' => '座席登录名', - 'type' => 'string', - 'example' => 'weichao', - ], - 'AgentId' => [ - 'description' => '座席ID，等同于该座席的RAM子账户ID。', - 'type' => 'string', - 'example' => '2769707711429472695', - ], - 'AgentName' => [ - 'description' => '座席显示名称', - 'type' => 'string', - 'example' => '默默', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], - 'SkillGroupNames' => [ - 'description' => '技能组名称', - 'type' => 'string', - 'example' => '其他服务', - ], - 'SkillGroupIds' => [ - 'description' => '技能组ID列表', - 'type' => 'string', - 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814', - ], - 'Overall' => [ - 'description' => '整体指标', - 'type' => 'object', - 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'LastLogOutTime' => [ - 'description' => '最后登出时间', - 'type' => 'string', - 'example' => '2018-08-04 18:00:00', - ], - 'FirstLogInTime' => [ - 'description' => '首次登录时间', - 'type' => 'string', - 'example' => '2018-08-04 09:00:00', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OneTransferCalls' => [ - 'description' => '总转接量，即坐席发起直接转接的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], + 'LoginName' => ['description' => '座席登录名', 'type' => 'string', 'example' => 'weichao'], + 'AgentId' => ['description' => '座席ID，等同于该座席的RAM子账户ID。', 'type' => 'string', 'example' => '2769707711429472695'], + 'AgentName' => ['description' => '座席显示名称', 'type' => 'string', 'example' => '默默'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], + 'SkillGroupNames' => ['description' => '技能组名称', 'type' => 'string', 'example' => '其他服务'], + 'SkillGroupIds' => ['description' => '技能组ID列表', 'type' => 'string', 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814'], + 'Overall' => [ + 'description' => '整体指标', + 'type' => 'object', + 'properties' => [ + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OccupancyRate' => ['description' => '座席利用率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'LastLogOutTime' => ['description' => '最后登出时间', 'type' => 'string', 'example' => '2018-08-04 18:00:00'], + 'FirstLogInTime' => ['description' => '首次登录时间', 'type' => 'string', 'example' => '2018-08-04 09:00:00'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OneTransferCalls' => ['description' => '总转接量，即坐席发起直接转接的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], ], 'Inbound' => [ 'description' => '呼入指标', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '电话呼入数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '电话应答数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '服务水平，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '电话呼入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ServiceLevel20' => ['description' => '服务水平，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Outbound' => [ 'description' => '呼出指标', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '电话拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAnswered' => [ - 'description' => '电话接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnswerRate' => [ - 'description' => '接通率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。总话后处理时长，单位秒。', - 'type' => 'string', - 'example' => '0', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsDialed' => ['description' => '电话拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnswerRate' => ['description' => '接通率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。总话后处理时长，单位秒。', 'type' => 'string', 'example' => '0'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], ], @@ -15251,14 +7523,8 @@ ], 'ListAgentSummaryReportsByInterval' => [ 'summary' => '调用ListAgentSummaryReportsByInterval查询坐席指标的分段汇总报表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15273,97 +7539,50 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx'], ], [ 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID', - 'type' => 'string', - 'required' => false, - 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb91xxxx', - ], + 'schema' => ['description' => '技能组ID', 'type' => 'string', 'required' => false, 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb91xxxx'], ], [ 'name' => 'AgentIds', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID列表（使用“,”隔开），坐席ID等同于该座席的RAM子账户ID，最多50个坐席；不传查询全部。', - 'type' => 'string', - 'required' => false, - 'example' => '276970771142947xxxx', - ], + 'schema' => ['description' => '坐席ID列表（使用“,”隔开），坐席ID等同于该座席的RAM子账户ID，最多50个坐席；不传查询全部。', 'type' => 'string', 'required' => false, 'example' => '276970771142947xxxx'], ], [ 'name' => 'Interval', 'in' => 'query', - 'schema' => [ - 'description' => '间隔类型。'."\n" - .'- Daily：天'."\n" - .'- Minute5：5分钟', - 'type' => 'string', - 'required' => false, - 'example' => 'Daily', - ], + 'schema' => ['description' => '间隔类型。'."\n" + .'- Daily：天'."\n" + .'- Minute5：5分钟', 'type' => 'string', 'required' => false, 'example' => 'Daily'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '起始日期，格式yyyy-MM-dd HH:mm:ss，不得早于6个月前的时间点', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-09-12 14:45:00', - ], + 'schema' => ['description' => '起始日期，格式yyyy-MM-dd HH:mm:ss，不得早于6个月前的时间点', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-09-12 14:45:00'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '终止日期，格式yyyy-MM-dd HH:mm:ss', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-09-12 14:45:00', - ], + 'schema' => ['description' => '终止日期，格式yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-09-12 14:45:00'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，默认值为10，最大是100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '分页大小，默认值为10，最大是100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], ], 'responses' => [ @@ -15371,54 +7590,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DCF128C7-3817-4409-8557-15A0C49DA1B8', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DCF128C7-3817-4409-8557-15A0C49DA1B8'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'PagedAgentSummaryReport' => [ 'description' => '报表', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总个数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总个数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -15429,11 +7612,7 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'AgentId' => [ - 'description' => '坐席ID', - 'type' => 'string', - 'example' => '276970771142947xxxx', - ], + 'AgentId' => ['description' => '坐席ID', 'type' => 'string', 'example' => '276970771142947xxxx'], 'IntervalList' => [ 'type' => 'object', 'itemNode' => true, @@ -15444,355 +7623,79 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'LoginName' => [ - 'description' => '座席登录名', - 'type' => 'string', - 'example' => 'weichao', - ], - 'AgentId' => [ - 'description' => '座席ID，等同于该座席的RAM子账户ID。', - 'type' => 'string', - 'example' => '276970771142947xxxx', - ], - 'AgentName' => [ - 'description' => '座席显示名称', - 'type' => 'string', - 'example' => '默默', - ], - 'SkillGroupNames' => [ - 'description' => '技能组名称', - 'type' => 'string', - 'example' => '其他服务', - ], - 'Timestamp' => [ - 'description' => '日期，格式yyyy-MM-dd HH:mm:ss', - 'type' => 'string', - 'example' => '2018-09-12 14:45:00', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxx', - ], - 'SkillGroupIds' => [ - 'description' => '技能组ID列表', - 'type' => 'string', - 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb91981', - ], + 'LoginName' => ['description' => '座席登录名', 'type' => 'string', 'example' => 'weichao'], + 'AgentId' => ['description' => '座席ID，等同于该座席的RAM子账户ID。', 'type' => 'string', 'example' => '276970771142947xxxx'], + 'AgentName' => ['description' => '座席显示名称', 'type' => 'string', 'example' => '默默'], + 'SkillGroupNames' => ['description' => '技能组名称', 'type' => 'string', 'example' => '其他服务'], + 'Timestamp' => ['description' => '日期，格式yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2018-09-12 14:45:00'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxx'], + 'SkillGroupIds' => ['description' => '技能组ID列表', 'type' => 'string', 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb91981'], 'Overall' => [ 'description' => '整体指标', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'LastLogOutTime' => [ - 'description' => '最后下线时间。', - 'type' => 'string', - 'example' => '2018-09-12 14:50:00', - ], - 'FirstLogInTime' => [ - 'description' => '首次登录时间。', - 'type' => 'string', - 'example' => '2018-09-12 14:46:00', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OneTransferCalls' => [ - 'description' => '总转接量，即坐席发送直接转接的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'OccupancyRate' => ['description' => '座席利用率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'LastLogOutTime' => ['description' => '最后下线时间。', 'type' => 'string', 'example' => '2018-09-12 14:50:00'], + 'FirstLogInTime' => ['description' => '首次登录时间。', 'type' => 'string', 'example' => '2018-09-12 14:46:00'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OneTransferCalls' => ['description' => '总转接量，即坐席发送直接转接的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Inbound' => [ 'description' => '呼入指标', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '电话呼入数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '电话应答数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '20s应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '电话呼入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ServiceLevel20' => ['description' => '20s应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Outbound' => [ 'description' => '呼出指标', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '电话拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAnswered' => [ - 'description' => '电话接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnswerRate' => [ - 'description' => '接通率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsDialed' => ['description' => '电话拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnswerRate' => ['description' => '接通率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], ], @@ -15821,14 +7724,8 @@ ], 'ListAgentSummaryReportsSinceMidnight' => [ 'summary' => '调用ListAgentSummaryReportsSinceMidnight查询坐席指标的当天汇总报表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15843,65 +7740,35 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], ], [ 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID', - 'type' => 'string', - 'required' => false, - 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814', - ], + 'schema' => ['description' => '技能组ID', 'type' => 'string', 'required' => false, 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814'], ], [ 'name' => 'AgentIds', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID列表(使用“,”隔开)。'."\n" - ."\n" - .'坐席ID等同于该座席的RAM子账户ID，最多50个坐席；不传查询全部.', - 'type' => 'string', - 'required' => false, - 'example' => '2769707711429472695', - ], + 'schema' => ['description' => '坐席ID列表(使用“,”隔开)。'."\n" + ."\n" + .'坐席ID等同于该座席的RAM子账户ID，最多50个坐席；不传查询全部.', 'type' => 'string', 'required' => false, 'example' => '2769707711429472695'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，默认值为10，最大是100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '分页大小，默认值为10，最大是100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -15909,54 +7776,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '27DD30C4-CAE2-481A-97CC-D3C54625341D', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应信息', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '27DD30C4-CAE2-481A-97CC-D3C54625341D'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'PagedAgentSummaryReport' => [ 'description' => '报表', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalCount' => [ - 'description' => '总个数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'TotalCount' => ['description' => '总个数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -15967,344 +7798,77 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'LoginName' => [ - 'description' => '座席登录名', - 'type' => 'string', - 'example' => 'weichao', - ], - 'AgentId' => [ - 'description' => '座席ID，等同于该座席的RAM子账户ID。', - 'type' => 'string', - 'example' => '2769707711429472695', - ], - 'AgentName' => [ - 'description' => '座席名称', - 'type' => 'string', - 'example' => '默默', - ], - 'SkillGroupNames' => [ - 'description' => '技能组名称', - 'type' => 'string', - 'example' => '其他服务', - ], - 'Timestamp' => [ - 'description' => '日期，格式yyyy-MM-dd HH:mm:ss', - 'type' => 'string', - 'example' => '2018-09-13 00:00:00', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], - 'SkillGroupIds' => [ - 'description' => '技能组ID列表', - 'type' => 'string', - 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814', - ], + 'LoginName' => ['description' => '座席登录名', 'type' => 'string', 'example' => 'weichao'], + 'AgentId' => ['description' => '座席ID，等同于该座席的RAM子账户ID。', 'type' => 'string', 'example' => '2769707711429472695'], + 'AgentName' => ['description' => '座席名称', 'type' => 'string', 'example' => '默默'], + 'SkillGroupNames' => ['description' => '技能组名称', 'type' => 'string', 'example' => '其他服务'], + 'Timestamp' => ['description' => '日期，格式yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2018-09-13 00:00:00'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], + 'SkillGroupIds' => ['description' => '技能组ID列表', 'type' => 'string', 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814'], 'Overall' => [ 'description' => '整体指标', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '65', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '37', - ], - 'OneTransferCalls' => [ - 'description' => '总转接量，坐席发起直接转接的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '65', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '65'], + 'OccupancyRate' => ['description' => '座席利用率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '32'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '37'], + 'OneTransferCalls' => ['description' => '总转接量，坐席发起直接转接的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '65'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Inbound' => [ 'description' => '呼入指标', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '电话呼入数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '电话应答数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '20s应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '电话呼入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ServiceLevel20' => ['description' => '20s应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Outbound' => [ 'description' => '呼出指标', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '电话拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAnswered' => [ - 'description' => '电话接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnswerRate' => [ - 'description' => '接通率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'string', - 'example' => '0', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsDialed' => ['description' => '电话拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnswerRate' => ['description' => '接通率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'string', 'example' => '0'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], ], @@ -16327,14 +7891,8 @@ ], 'GetAgentData' => [ 'summary' => '调用GetAgentData获取单个坐席报表数据。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16349,77 +7907,38 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], + 'schema' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], ], [ 'name' => 'StartDay', 'in' => 'query', - 'schema' => [ - 'description' => '起始日期，格式yyyy-MM-dd。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-01-05', - ], + 'schema' => ['description' => '起始日期，格式yyyy-MM-dd。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-01-05'], ], [ 'name' => 'EndDay', 'in' => 'query', - 'schema' => [ - 'description' => '终止日期，格式yyyy-MM-dd。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-01-06', - ], + 'schema' => ['description' => '终止日期，格式yyyy-MM-dd。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-01-06'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '阿里云账号的lgoinName。', - 'type' => 'string', - 'required' => false, - 'example' => 'cctest', - ], + 'schema' => ['description' => '阿里云账号的lgoinName。', 'type' => 'string', 'required' => false, 'example' => 'cctest'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，最大值100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号，最大值100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], ], 'responses' => [ @@ -16427,441 +7946,102 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5E4AE8BE-282D-47DD-A9CB-AAC211F95DDB', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5E4AE8BE-282D-47DD-A9CB-AAC211F95DDB'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], 'DataList' => [ 'description' => '报表数据。', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => '对象总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'PageNumber' => ['description' => '分页序号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalCount' => ['description' => '对象总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'List' => [ 'description' => '对象列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16225', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'LoginName' => [ - 'description' => '座席登录名。', - 'type' => 'string', - 'example' => 'cctest', - ], - 'AgentId' => [ - 'description' => '座席ID，等同于该座席的RAM子账户ID，或阿里云UID。', - 'type' => 'string', - 'example' => '233482729826925174', - ], - 'RecordDate' => [ - 'description' => '日期。', - 'type' => 'string', - 'example' => '2021-01-05', - ], - 'AgentName' => [ - 'description' => 'Display/姓名。', - 'type' => 'string', - 'example' => '云呼测试', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef9', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SkillGroupNames' => [ - 'description' => '座席所属技能组名称列表。', - 'type' => 'string', - 'example' => '默认技能组', - ], - 'SkillGroupIds' => [ - 'description' => '座席所属技能组ID列表。', - 'type' => 'string', - 'example' => '1fa8bb2f-e738-4981-aea8-264e67a175bc', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '146', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16225'], + 'OccupancyRate' => ['description' => '座席利用率。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'LoginName' => ['description' => '座席登录名。', 'type' => 'string', 'example' => 'cctest'], + 'AgentId' => ['description' => '座席ID，等同于该座席的RAM子账户ID，或阿里云UID。', 'type' => 'string', 'example' => '233482729826925174'], + 'RecordDate' => ['description' => '日期。', 'type' => 'string', 'example' => '2021-01-05'], + 'AgentName' => ['description' => 'Display/姓名。', 'type' => 'string', 'example' => '云呼测试'], + 'InstanceId' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef9'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SkillGroupNames' => ['description' => '座席所属技能组名称列表。', 'type' => 'string', 'example' => '默认技能组'], + 'SkillGroupIds' => ['description' => '座席所属技能组ID列表。', 'type' => 'string', 'example' => '1fa8bb2f-e738-4981-aea8-264e67a175bc'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '146'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'Inbound' => [ 'description' => '呼入指标。', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '电话呼入数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '电话应答数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '33'], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '电话呼入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Outbound' => [ 'description' => '呼出指标。', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '260', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '电话拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18', - ], - 'CallsAnswered' => [ - 'description' => '电话接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'AnswerRate' => [ - 'description' => '接通率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '50', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '260'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsDialed' => ['description' => '电话拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '18'], + 'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'AnswerRate' => ['description' => '接通率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '50'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Overall' => [ 'description' => '整体指标。', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '293', - ], - 'MaxHoldTime' => [ - 'description' => '最大保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '70', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '293'], + 'MaxHoldTime' => ['description' => '最大保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '70'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '19'], ], ], ], @@ -16882,14 +8062,8 @@ ], 'ListAgentDevices' => [ 'summary' => '当坐席出现异常下线的情况时，查询坐席的设备信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16904,55 +8078,30 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'RamIds', 'in' => 'query', - 'schema' => [ - 'description' => 'RamID的集合。'."\n" - ."\n" - .'如果没有数据则查询当前坐席的设备信息，查询多个ramID信息用“,”分隔。', - 'type' => 'string', - 'required' => false, - 'example' => '123,456', - ], + 'schema' => ['description' => 'RamID的集合。'."\n" + ."\n" + .'如果没有数据则查询当前坐席的设备信息，查询多个ramID信息用“,”分隔。', 'type' => 'string', 'required' => false, 'example' => '123,456'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间，默认当天时间的0点时刻。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '13465000', - ], + 'schema' => ['description' => '开始时间，默认当天时间的0点时刻。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13465000'], ], [ 'name' => 'StopTime', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间，默认当前时间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1645645700', - ], + 'schema' => ['description' => '结束时间，默认当前时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1645645700'], ], ], 'responses' => [ @@ -16960,32 +8109,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'A13BB835-94AA-4E55-8D9E-5EA585CEA99Y', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'A13BB835-94AA-4E55-8D9E-5EA585CEA99Y'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'AgentDeviceList' => [ 'type' => 'object', 'itemNode' => true, @@ -16996,51 +8124,16 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'LoginTime' => [ - 'description' => '登录时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1559113107000', - ], - 'ClientPort' => [ - 'description' => '客户端Port', - 'type' => 'string', - 'example' => '8080', - ], - 'Remark' => [ - 'description' => '备注信息', - 'type' => 'string', - 'example' => '无', - ], - 'BrowserVersion' => [ - 'description' => '客户端浏览器信息', - 'type' => 'string', - 'example' => '浏览器内核类型：chrome，浏览器版本：74.0.3729.169', - ], - 'ClientIp' => [ - 'description' => '客户端IP', - 'type' => 'string', - 'example' => '30.52.180.90', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], - 'IsLogin' => [ - 'description' => '是否签入成功。 '."\n" - ."\n" - .'**0**:签入失败;**1**:签入成功;', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RamId' => [ - 'description' => '座席的RAM子账户ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1059803544828509', - ], + 'LoginTime' => ['description' => '登录时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1559113107000'], + 'ClientPort' => ['description' => '客户端Port', 'type' => 'string', 'example' => '8080'], + 'Remark' => ['description' => '备注信息', 'type' => 'string', 'example' => '无'], + 'BrowserVersion' => ['description' => '客户端浏览器信息', 'type' => 'string', 'example' => '浏览器内核类型：chrome，浏览器版本：74.0.3729.169'], + 'ClientIp' => ['description' => '客户端IP', 'type' => 'string', 'example' => '30.52.180.90'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], + 'IsLogin' => ['description' => '是否签入成功。 '."\n" + ."\n" + .'**0**:签入失败;**1**:签入成功;', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RamId' => ['description' => '座席的RAM子账户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1059803544828509'], ], ], ], @@ -17059,14 +8152,8 @@ ], 'ListAgentEvents' => [ 'summary' => '调用ListAgentEvents获取呼叫中心实例中坐席的事件状态信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17081,45 +8168,25 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取用户的呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], + 'schema' => ['description' => '待获取用户的呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间。'."\n" - ."\n" - .'默认是当前时间前一小时，注意查询时间范围小于1小时，否则会报错。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1555297200000', - ], + 'schema' => ['description' => '开始时间。'."\n" + ."\n" + .'默认是当前时间前一小时，注意查询时间范围小于1小时，否则会报错。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1555297200000'], ], [ 'name' => 'StopTime', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间，默认是当前时间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1555300800000', - ], + 'schema' => ['description' => '结束时间，默认是当前时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1555300800000'], ], [ 'name' => 'RamId', @@ -17128,9 +8195,7 @@ 'schema' => [ 'description' => '坐席的RAM ID。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'example' => '1059803544828509', 'maxItems' => 99, @@ -17145,9 +8210,7 @@ ."\n" .'包括：”签入”,”签出”,”小休”,”等待”,”振铃”,”通话”,”放弃”,”结束”,”处理”,”发起求助”,”求助成功”,”会议建立”,”会议结束”,”拨号”。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '签入', 'maxItems' => 99, @@ -17159,32 +8222,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'ADB327AC-6ABF-4FE9-A52E-AAB9894CD0E7', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'ADB327AC-6ABF-4FE9-A52E-AAB9894CD0E7'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'AgentEventList' => [ 'type' => 'object', 'itemNode' => true, @@ -17195,33 +8237,11 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Event' => [ - 'description' => '座席事件状态描述。', - 'type' => 'string', - 'example' => '签出', - ], - 'EventTime' => [ - 'description' => '事件触发时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1555299918000', - ], - 'LoginName' => [ - 'description' => '座席登录名', - 'type' => 'string', - 'example' => 'ccctest', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], - 'RamId' => [ - 'description' => '座席的RAM子账户ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2059803544828509', - ], + 'Event' => ['description' => '座席事件状态描述。', 'type' => 'string', 'example' => '签出'], + 'EventTime' => ['description' => '事件触发时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1555299918000'], + 'LoginName' => ['description' => '座席登录名', 'type' => 'string', 'example' => 'ccctest'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], + 'RamId' => ['description' => '座席的RAM子账户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2059803544828509'], 'SkillGroupIds' => [ 'type' => 'object', 'itemNode' => true, @@ -17232,16 +8252,8 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SkillGroupName' => [ - 'description' => '技能组名称', - 'type' => 'string', - 'example' => 'Default', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID', - 'type' => 'string', - 'example' => '014a9696-931d-49db-ae96-111d2098a548', - ], + 'SkillGroupName' => ['description' => '技能组名称', 'type' => 'string', 'example' => 'Default'], + 'SkillGroupId' => ['description' => '技能组ID', 'type' => 'string', 'example' => '014a9696-931d-49db-ae96-111d2098a548'], ], ], ], @@ -17265,14 +8277,8 @@ ], 'GenerateAgentStatisticReport' => [ 'summary' => '调用GenerateAgentStatisticReport返回调用者自己的坐席报表数据，用在坐席工作台-我的工作页面。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17287,77 +8293,38 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef8', - 'docRequired' => true, - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef8', 'docRequired' => true], ], [ 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '座席ID，等同于该座席的RAM子账户ID。', - 'type' => 'string', - 'required' => false, - 'example' => '233482729826925174', - ], + 'schema' => ['description' => '座席ID，等同于该座席的RAM子账户ID。', 'type' => 'string', 'required' => false, 'example' => '233482729826925174'], ], [ 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '起始日期，格式yyyy-MM-dd，包括当前日期。', - 'type' => 'string', - 'required' => true, - 'example' => '2018-05-20 11:11:11', - 'docRequired' => true, - ], + 'schema' => ['description' => '起始日期，格式yyyy-MM-dd，包括当前日期。', 'type' => 'string', 'required' => true, 'example' => '2018-05-20 11:11:11', 'docRequired' => true], ], [ 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '终止日期，格式yyyy-MM-dd，包括当前日期。', - 'type' => 'string', - 'required' => true, - 'example' => '2018-05-20 11:11:11', - 'docRequired' => true, - ], + 'schema' => ['description' => '终止日期，格式yyyy-MM-dd，包括当前日期。', 'type' => 'string', 'required' => true, 'example' => '2018-05-20 11:11:11', 'docRequired' => true], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - 'docRequired' => true, - ], + 'schema' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'docRequired' => true], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - 'docRequired' => true, - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'docRequired' => true], ], ], 'responses' => [ @@ -17365,54 +8332,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'DataList' => [ 'description' => '报表数据。', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalCount' => [ - 'description' => '对象总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'TotalCount' => ['description' => '对象总数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -17423,387 +8354,84 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'LoginName' => [ - 'description' => '座席登录名。', - 'type' => 'string', - 'example' => 'cctest', - ], - 'AgentId' => [ - 'description' => '座席ID，等同于该座席的RAM子账户ID。', - 'type' => 'string', - 'example' => '233482729826925174', - ], - 'RecordDate' => [ - 'description' => '日期。', - 'type' => 'string', - 'example' => '无', - ], - 'AgentName' => [ - 'description' => 'Display/姓名。', - 'type' => 'string', - 'example' => '云呼测试', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef9', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SkillGroupNames' => [ - 'description' => '座席所属技能组名称列表。', - 'type' => 'string', - 'example' => 'Default,测试技能组', - ], - 'SkillGroupIds' => [ - 'description' => '座席所属技能组ID列表。', - 'type' => 'string', - 'example' => 'b0cc307c-9c74-43e6-4328-86e1bf98272b,f792751d-d4cb-4d4c-ccs4-b0oiw1f05247', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OccupancyRate' => ['description' => '座席利用率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'LoginName' => ['description' => '座席登录名。', 'type' => 'string', 'example' => 'cctest'], + 'AgentId' => ['description' => '座席ID，等同于该座席的RAM子账户ID。', 'type' => 'string', 'example' => '233482729826925174'], + 'RecordDate' => ['description' => '日期。', 'type' => 'string', 'example' => '无'], + 'AgentName' => ['description' => 'Display/姓名。', 'type' => 'string', 'example' => '云呼测试'], + 'InstanceId' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef9'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SkillGroupNames' => ['description' => '座席所属技能组名称列表。', 'type' => 'string', 'example' => 'Default,测试技能组'], + 'SkillGroupIds' => ['description' => '座席所属技能组ID列表。', 'type' => 'string', 'example' => 'b0cc307c-9c74-43e6-4328-86e1bf98272b,f792751d-d4cb-4d4c-ccs4-b0oiw1f05247'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'Inbound' => [ 'description' => '呼入指标。', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '电话呼入数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '电话应答数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '电话呼入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Outbound' => [ 'description' => '呼出指标。', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '电话拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAnswered' => [ - 'description' => '电话接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnswerRate' => [ - 'description' => '接通率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsDialed' => ['description' => '电话拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnswerRate' => ['description' => '接通率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Overall' => [ 'description' => '整体指标。', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], ], @@ -17826,14 +8454,8 @@ ], 'RefreshToken' => [ 'summary' => '刷新坐席工作台的Token，用来保持坐席工作台有效的登录状态。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17848,21 +8470,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], ], 'responses' => [ @@ -17870,48 +8484,19 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'EF438794-B498-4559-A536-3CD0BA33A1BF', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'EF438794-B498-4559-A536-3CD0BA33A1BF'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Token' => [ 'description' => '更新的令牌信息', 'type' => 'object', 'properties' => [ - 'SignData' => [ - 'description' => '待签名数据', - 'type' => 'string', - 'example' => '{"tenantId": "acc2631", "serviceId":"249353919874654122", "dn":"80326034", "source":"aliyun", "timestamp":1531452126, "expireTime":1531453926}', - ], - 'Signature' => [ - 'description' => '签名信息。'."\n" - ."\n" - .'签名格式：`{“tenantId”: “aliyun-xxx”, “serviceId”:”sam.zhang”, “dn”:”802001”, “source”:”aliyun”, “timestamp”:1423333, “expireTime”:1423933}`。', - 'type' => 'string', - 'example' => '{“tenantId”: “aliyun-xxx”, “serviceId”:”sam.zhang”, “dn”:”802001”, “source”:”aliyun”, “timestamp”:1423333, “expireTime”:1423933}', - ], + 'SignData' => ['description' => '待签名数据', 'type' => 'string', 'example' => '{"tenantId": "acc2631", "serviceId":"249353919874654122", "dn":"80326034", "source":"aliyun", "timestamp":1531452126, "expireTime":1531453926}'], + 'Signature' => ['description' => '签名信息。'."\n" + ."\n" + .'签名格式：`{“tenantId”: “aliyun-xxx”, “serviceId”:”sam.zhang”, “dn”:”802001”, “source”:”aliyun”, “timestamp”:1423333, “expireTime”:1423933}`。', 'type' => 'string', 'example' => '{“tenantId”: “aliyun-xxx”, “serviceId”:”sam.zhang”, “dn”:”802001”, “source”:”aliyun”, “timestamp”:1423333, “expireTime”:1423933}'], ], ], ], @@ -17928,14 +8513,8 @@ ], 'RequestLoginInfo' => [ 'summary' => '调用RequestLoginInfo获取坐席工作台的登陆信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17950,32 +8529,20 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '用户唯一标识。'."\n" - ."\n" - .'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', - 'type' => 'string', - 'required' => false, - 'example' => '674a5953-21d5-4ee9-9b42-eb8813d6**** ', - ], + 'schema' => ['description' => '用户唯一标识。'."\n" + ."\n" + .'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', 'type' => 'string', 'required' => false, 'example' => '674a5953-21d5-4ee9-9b42-eb8813d6**** '], ], ], 'responses' => [ @@ -17983,86 +8550,25 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '9D902FCA-FBBA-4888-9F85-4900EE85DA3D', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '9D902FCA-FBBA-4888-9F85-4900EE85DA3D'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'LoginInfo' => [ 'description' => '获取到的Region信息', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'description' => '座席展示名，来源于IMS目录服务', - 'type' => 'string', - 'example' => '小李', - ], - 'Signature' => [ - 'description' => '签名信息', - 'type' => 'string', - 'example' => '****', - ], - 'Extension' => [ - 'description' => '分机号码', - 'type' => 'string', - 'example' => '8032****', - ], - 'SignData' => [ - 'description' => '签名数据', - 'type' => 'string', - 'example' => '{"tenantId": "acc2631", "serviceId":"24935391987465****", "dn":"8032****", "source":"aliyun", "timestamp":1531454246, "expireTime":1531456046}', - ], - 'PhoneNumber' => [ - 'description' => '手机号码', - 'type' => 'string', - 'example' => '1766666****', - ], - 'Region' => [ - 'description' => '区域信息', - 'type' => 'string', - 'example' => 'aliyunccc', - ], - 'AgentServerUrl' => [ - 'description' => 'Agent Server集群VIP地址', - 'type' => 'string', - 'example' => 'as.ccc.aliyuncs.com:80', - ], - 'UserName' => [ - 'description' => '座席登录名（用户名），来源于IMS目录服务', - 'type' => 'string', - 'example' => '4935391987465****@hotCallCenter2', - ], - 'WebRtcUrl' => [ - 'description' => 'WebRTC2SIP服务器地址', - 'type' => 'string', - 'example' => 'sip.ccc.aliyuncs.com:9443', - ], - 'TenantId' => [ - 'description' => '租户ID', - 'type' => 'string', - 'example' => 'acc2631', - ], + 'DisplayName' => ['description' => '座席展示名，来源于IMS目录服务', 'type' => 'string', 'example' => '小李'], + 'Signature' => ['description' => '签名信息', 'type' => 'string', 'example' => '****'], + 'Extension' => ['description' => '分机号码', 'type' => 'string', 'example' => '8032****'], + 'SignData' => ['description' => '签名数据', 'type' => 'string', 'example' => '{"tenantId": "acc2631", "serviceId":"24935391987465****", "dn":"8032****", "source":"aliyun", "timestamp":1531454246, "expireTime":1531456046}'], + 'PhoneNumber' => ['description' => '手机号码', 'type' => 'string', 'example' => '1766666****'], + 'Region' => ['description' => '区域信息', 'type' => 'string', 'example' => 'aliyunccc'], + 'AgentServerUrl' => ['description' => 'Agent Server集群VIP地址', 'type' => 'string', 'example' => 'as.ccc.aliyuncs.com:80'], + 'UserName' => ['description' => '座席登录名（用户名），来源于IMS目录服务', 'type' => 'string', 'example' => '4935391987465****@hotCallCenter2'], + 'WebRtcUrl' => ['description' => 'WebRTC2SIP服务器地址', 'type' => 'string', 'example' => 'sip.ccc.aliyuncs.com:9443'], + 'TenantId' => ['description' => '租户ID', 'type' => 'string', 'example' => 'acc2631'], 'Roles' => [ 'type' => 'object', 'itemNode' => true, @@ -18073,26 +8579,10 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '角色所归属的呼叫中心实例', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], - 'RoleName' => [ - 'description' => '角色名称', - 'type' => 'string', - 'example' => 'AGENT', - ], - 'RoleDescription' => [ - 'description' => '角色描述', - 'type' => 'string', - 'example' => '坐席', - ], - 'RoleId' => [ - 'description' => '角色ID，系统自动生成的唯一标示符', - 'type' => 'string', - 'example' => '4c2e158e-ddd9-464a-a3fc-338eca10277c', - ], + 'InstanceId' => ['description' => '角色所归属的呼叫中心实例', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], + 'RoleName' => ['description' => '角色名称', 'type' => 'string', 'example' => 'AGENT'], + 'RoleDescription' => ['description' => '角色描述', 'type' => 'string', 'example' => '坐席'], + 'RoleId' => ['description' => '角色ID，系统自动生成的唯一标示符', 'type' => 'string', 'example' => '4c2e158e-ddd9-464a-a3fc-338eca10277c'], ], ], ], @@ -18114,14 +8604,8 @@ ], 'GetSmsConfig' => [ 'summary' => '获取短信配置信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18135,21 +8619,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREccc1MRAID', - ], + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'Scenario', @@ -18160,10 +8636,7 @@ ."\n" .'参数名称**Scenario.1**表示只获取1个场景下的短信配置信息，如果要获取多个场景的短信配置信息，则需要有Scenario.1以及Scenario.2，以此类推，请参考下方的请求示例。', 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'items' => ['type' => 'integer', 'format' => 'int32'], 'required' => true, 'example' => '2', 'maxItems' => 99, @@ -18175,32 +8648,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'E993D7CD-D546-4F88-9B04-62DFB05ED7E1', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'E993D7CD-D546-4F88-9B04-62DFB05ED7E1'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'SmsConfigs' => [ 'type' => 'object', 'itemNode' => true, @@ -18211,58 +8663,16 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Instance' => [ - 'description' => '实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], - 'Description' => [ - 'description' => '短信模板内容', - 'type' => 'string', - 'example' => '验证码${code}，您正在进行身份验证，不要告诉别人哦！', - ], - 'TemplateCode' => [ - 'description' => '短信模板CODE', - 'type' => 'string', - 'example' => 'SMS_96955021', - ], - 'GmtCreate' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '无', - ], - 'Scenario' => [ - 'description' => '场景', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'GmtModified' => [ - 'description' => '更新时间', - 'type' => 'string', - 'example' => '无', - ], - 'Name' => [ - 'description' => '名称', - 'type' => 'string', - 'example' => '身份验证', - ], - 'Extra' => [ - 'description' => '额外参数，与具体场景有关', - 'type' => 'string', - 'example' => '无', - ], - 'SignName' => [ - 'description' => '短信签名名称', - 'type' => 'string', - 'example' => '阿里大于测试专用', - ], - 'Id' => [ - 'description' => '短信配置ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '36230', - ], + 'Instance' => ['description' => '实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], + 'Description' => ['description' => '短信模板内容', 'type' => 'string', 'example' => '验证码${code}，您正在进行身份验证，不要告诉别人哦！'], + 'TemplateCode' => ['description' => '短信模板CODE', 'type' => 'string', 'example' => 'SMS_96955021'], + 'GmtCreate' => ['description' => '创建时间', 'type' => 'string', 'example' => '无'], + 'Scenario' => ['description' => '场景', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'GmtModified' => ['description' => '更新时间', 'type' => 'string', 'example' => '无'], + 'Name' => ['description' => '名称', 'type' => 'string', 'example' => '身份验证'], + 'Extra' => ['description' => '额外参数，与具体场景有关', 'type' => 'string', 'example' => '无'], + 'SignName' => ['description' => '短信签名名称', 'type' => 'string', 'example' => '阿里大于测试专用'], + 'Id' => ['description' => '短信配置ID', 'type' => 'integer', 'format' => 'int64', 'example' => '36230'], ], ], ], @@ -18281,14 +8691,8 @@ ], 'LaunchShortMessageAppraise' => [ 'summary' => '调用LaunchShortMessageAppraise统计短信满意度发送率。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18303,70 +8707,38 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'Acid', 'in' => 'query', - 'schema' => [ - 'description' => '通话话务ID。'."\n" - ."\n" - .'即contactId，软电话SDK的回调事件中会携带contactId。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2029401778', - ], + 'schema' => ['description' => '通话话务ID。'."\n" + ."\n" + .'即contactId，软电话SDK的回调事件中会携带contactId。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2029401778'], ], [ 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], + 'schema' => ['description' => '技能组ID', 'type' => 'string', 'required' => false, 'example' => 'xxx'], ], [ 'name' => 'ContactType', 'in' => 'query', - 'schema' => [ - 'description' => '呼入还是呼出。取值：'."\n" - ."\n" - .'- 0：呼入'."\n" - .'- 1：呼出', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '呼入还是呼出。取值：'."\n" + ."\n" + .'- 0：呼入'."\n" + .'- 1：呼出', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PhoneNumbers', 'in' => 'query', - 'schema' => [ - 'description' => '要发送短信的手机号码，多个号码以逗号分隔', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1763333****', - ], + 'schema' => ['description' => '要发送短信的手机号码，多个号码以逗号分隔', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1763333****'], ], ], 'responses' => [ @@ -18374,32 +8746,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -18414,14 +8765,8 @@ ], 'SendPredefinedShortMessage' => [ 'summary' => '根据预告定义的短信模板发送短信，例如发送漏话短信。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18436,53 +8781,30 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'PhoneNumbers', 'in' => 'query', - 'schema' => [ - 'description' => '手机号码', - 'type' => 'string', - 'required' => true, - 'example' => '1760066****', - ], + 'schema' => ['description' => '手机号码', 'type' => 'string', 'required' => true, 'example' => '1760066****'], ], [ 'name' => 'ConfigId', 'in' => 'query', - 'schema' => [ - 'description' => '短信配置项ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '23', - ], + 'schema' => ['description' => '短信配置项ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '23'], ], [ 'name' => 'TemplateParam', 'in' => 'query', - 'schema' => [ - 'description' => '短信模板变量替换JSON串。'."\n" - ."\n" - .'> 如果JSON中需要带换行符，请参照标准的JSON协议。', - 'type' => 'string', - 'required' => false, - 'example' => '{"totalSum":"13422","minutes":"3423","outBound":"1333","inBound":"2333"}', - ], + 'schema' => ['description' => '短信模板变量替换JSON串。'."\n" + ."\n" + .'> 如果JSON中需要带换行符，请参照标准的JSON协议。', 'type' => 'string', 'required' => false, 'example' => '{"totalSum":"13422","minutes":"3423","outBound":"1333","inBound":"2333"}'], ], ], 'responses' => [ @@ -18490,37 +8812,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '28349E33-294F-4413-A9F3-EE828F4C2FE7', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'BizId' => [ - 'description' => '短信服务返回的Bizid', - 'type' => 'string', - 'example' => '35681823605595****', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '28349E33-294F-4413-A9F3-EE828F4C2FE7'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'BizId' => ['description' => '短信服务返回的Bizid', 'type' => 'string', 'example' => '35681823605595****'], ], ], ], @@ -18534,14 +8831,8 @@ ], 'CreateSkillGroup' => [ 'summary' => '调用CreateSkillGroup创建技能组。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18556,62 +8847,33 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccPBOQGO', - ], + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待创建的技能组所归属的呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '待创建的技能组所归属的呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '待创建的技能组名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '售前技能组', - ], + 'schema' => ['description' => '待创建的技能组名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '售前技能组'], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '待创建的技能组的描述。', - 'type' => 'string', - 'required' => false, - 'example' => '售前坐席使用', - ], + 'schema' => ['description' => '待创建的技能组的描述。', 'type' => 'string', 'required' => false, 'example' => '售前坐席使用'], ], [ 'name' => 'RoutingStrategy', 'in' => 'query', - 'schema' => [ - 'description' => '匹配方式。取值：default（默认模式）、acquaintance（熟人模式）。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => '匹配方式。取值：default（默认模式）、acquaintance（熟人模式）。', 'type' => 'string', 'required' => false, 'example' => 'default'], ], [ 'name' => 'AllowPrivateOutboundNumber', 'in' => 'query', - 'schema' => [ - 'description' => '是否允许使用个人外呼号码。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '是否允许使用个人外呼号码。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'OutboundPhoneNumberId', @@ -18622,9 +8884,7 @@ ."\n\n" .'参数名称为**OutboundPhoneNumberId.1**意为只绑定一个外呼号码，如果绑定多个号码，则需要传多个，例如 OutboundPhoneNumberId.1、OutboundPhoneNumberId.2、OutboundPhoneNumberId.3，以此类推。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '2ead4b47-db37-43b3-8e32-ae71d81620af', 'maxItems' => 99, @@ -18639,9 +8899,7 @@ ."\n" .'**UserId.1**意为只绑定一个坐席，如果绑定多个，则需要传多个，例如 UserId.1、UserId.2、UserId.3，以此类推。注意UserId指RAM子账号在呼叫中心实例的唯一标识UserId，并非RAM子账号的RamId。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '8b33d247-128c-4013-b79d-ec11a6a8f108', 'maxItems' => 99, @@ -18656,10 +8914,7 @@ ."\n" .'**SkillLevel.1**代表为上面的**UserId.1**设置技能组等级，如果userId为多个，则SkillLevel也需要多个，并且数量需要保持一致。', 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'items' => ['type' => 'integer', 'format' => 'int32'], 'required' => false, 'example' => '5', 'maxItems' => 99, @@ -18671,37 +8926,12 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '05B8C64B-008A-427B-8B27-84E372A291D6', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], - 'SkillGroupId' => [ - 'description' => '新创建的技能组ID', - 'type' => 'string', - 'example' => '8fc24faa-4e15-43af-9c94-5bb9ee568bb2', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '05B8C64B-008A-427B-8B27-84E372A291D6'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + 'SkillGroupId' => ['description' => '新创建的技能组ID', 'type' => 'string', 'example' => '8fc24faa-4e15-43af-9c94-5bb9ee568bb2'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], ], ], ], @@ -18715,14 +8945,8 @@ ], 'DeleteSkillGroup' => [ 'summary' => '调用DeleteSkillGroup删除技能组。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18737,32 +8961,18 @@ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待删除技能组所属呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '待删除技能组所属呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '待删除的技能组ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '8fc24faa-4e15-43af-9c94-5bb9ee568bb2', - ], + 'schema' => ['description' => '待删除的技能组ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8fc24faa-4e15-43af-9c94-5bb9ee568bb2'], ], ], 'responses' => [ @@ -18770,32 +8980,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'A450574A-337F-43E2-BC59-9C6594C994C6', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'A450574A-337F-43E2-BC59-9C6594C994C6'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -18807,14 +8996,8 @@ ], 'ModifyPrimaryTrunksOfSkillGroup' => [ 'summary' => '调用接口：ModifyPrimaryTrunksOfSkillGroup 修改技能组线路中继配置信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18829,32 +9012,18 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '809wer75-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '技能组ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '809wer75-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'PrimaryProviderName', @@ -18863,9 +9032,7 @@ 'schema' => [ 'description' => '主线路名称', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '联通全国', 'maxItems' => 99, @@ -18877,45 +9044,21 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码'."\n" - ."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码'."\n" + ."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'UserPermission', - 'errorMessage' => 'User \'%s\' has no permission to \'%s\'', - ], + ['errorCode' => 'UserPermission', 'errorMessage' => 'User \'%s\' has no permission to \'%s\''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"无\\nDE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\t\\n200\\nOK\\ntrue","errorExample":""}]', @@ -18927,14 +9070,8 @@ ], 'ModifySkillGroup' => [ 'summary' => '修改技能组的名称、描述、外呼号码以及组内坐席。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18949,73 +9086,38 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待编辑技能组所属呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '待编辑技能组所属呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '待修改的技能组ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18ef28', - ], + 'schema' => ['description' => '待修改的技能组ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18ef28'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '技能组的新名称', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '售后技术支持技能组', - ], + 'schema' => ['description' => '技能组的新名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '售后技术支持技能组'], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '技能组的新的简单描述', - 'type' => 'string', - 'required' => false, - 'example' => '售后技术支持人员使用', - ], + 'schema' => ['description' => '技能组的新的简单描述', 'type' => 'string', 'required' => false, 'example' => '售后技术支持人员使用'], ], [ 'name' => 'RoutingStrategy', 'in' => 'query', - 'schema' => [ - 'description' => '匹配方式', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => '匹配方式', 'type' => 'string', 'required' => false, 'example' => 'default'], ], [ 'name' => 'AllowPrivateOutboundNumber', 'in' => 'query', - 'schema' => [ - 'description' => '是否允许使用个人外呼号码', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '是否允许使用个人外呼号码', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'OutboundPhoneNumberId', @@ -19026,9 +9128,7 @@ ."\n\n" .'参数名称**OutboundPhoneNumberId.1**意为只绑定一个外呼号码，如果绑定多个号码，则需要传多个，例如 OutboundPhoneNumberId.1、OutboundPhoneNumberId.2、OutboundPhoneNumberId.3，以此类推。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '2ead4b47-db37-43b3-8e32-ae71d81620af', 'maxItems' => 99, @@ -19043,9 +9143,7 @@ ."\n" .'**UserId.1**意为只绑定一个坐席，如果绑定多个，则需要传多个，例如 UserId.1、UserId.2、UserId.3，以此类推。注意UserId指RAM子账号在呼叫中心实例的唯一标识UserId，并非RAM子账号的RamId。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '8b33d247-128c-4013-b79d-ec11a6a8f108', 'maxItems' => 99, @@ -19060,10 +9158,7 @@ ."\n" .'**SkillLevel.1**代表为**UserId.1**设置技能组等级，如果userId为多个，则SkillLevel也需要多个，并且数量需要保持一致。', 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'items' => ['type' => 'integer', 'format' => 'int32'], 'required' => false, 'example' => '5', 'maxItems' => 99, @@ -19075,32 +9170,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'E49E170E-4481-40A2-BC33-3D789263F50E', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'E49E170E-4481-40A2-BC33-3D789263F50E'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -19114,14 +9188,8 @@ ], 'ModifySkillGroupOfUser' => [ 'summary' => '调用ModifySkillGroupOfUser修改坐席从属的技能组。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19136,30 +9204,18 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccPBOQGO', - ], + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '待修改的用户ID', - 'type' => 'string', - 'required' => true, - 'example' => 'b394cf26-8d5c-4494-8f40-68a2aba8ba64', - ], + 'schema' => ['description' => '待修改的用户ID', 'type' => 'string', 'required' => true, 'example' => 'b394cf26-8d5c-4494-8f40-68a2aba8ba64'], ], [ 'name' => 'RoleId', @@ -19168,9 +9224,7 @@ 'schema' => [ 'description' => '用户所具有的角色ID', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'example' => '4c2e158e-ddd9-464a-a3fc-338eca10277c', 'maxItems' => 99, @@ -19183,9 +9237,7 @@ 'schema' => [ 'description' => '待创建用户所归属的技能组ID', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18ef28', 'maxItems' => 99, @@ -19198,10 +9250,7 @@ 'schema' => [ 'description' => '修改后的技能级别', 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'items' => ['type' => 'integer', 'format' => 'int32'], 'required' => false, 'example' => '4', 'maxItems' => 99, @@ -19213,32 +9262,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '4A2E1761-8C19-4788-BA76-6C8902A6D5E9', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '4A2E1761-8C19-4788-BA76-6C8902A6D5E9'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -19249,14 +9277,8 @@ ], 'ModifySkillGroupOutboundNumbers' => [ 'summary' => '调用ModifySkillGroupOutboundNumbers修改技能组的外呼电话列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19271,49 +9293,28 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待编辑技能组所属呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '待编辑技能组所属呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '待修改的技能组ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c6010943-c0f6-44e5-8f94-60a85a647178', - ], + 'schema' => ['description' => '待修改的技能组ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c6010943-c0f6-44e5-8f94-60a85a647178'], ], [ 'name' => 'OperationType', 'in' => 'query', - 'schema' => [ - 'description' => '支持新增、删除、重置。'."\n" - ."\n" - .'- 1 = 新增，把传入的所有号码添加到当前的外呼列表中，'."\n" - .'- 2 = 删除，把传入的所有号码从当前的外呼列表中删除'."\n" - .'- 3 = 重置，把当前外呼号码列表中的号码情况，把传入的所有号码增加到外呼号码列表中。'."\n" - .'- 其他值无效，返回错误。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '支持新增、删除、重置。'."\n" + ."\n" + .'- 1 = 新增，把传入的所有号码添加到当前的外呼列表中，'."\n" + .'- 2 = 删除，把传入的所有号码从当前的外呼列表中删除'."\n" + .'- 3 = 重置，把当前外呼号码列表中的号码情况，把传入的所有号码增加到外呼号码列表中。'."\n" + .'- 其他值无效，返回错误。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'OutboundPhoneNumberId', @@ -19324,9 +9325,7 @@ ."\n" .'参数名称**OutboundPhoneNumberId.1**意为只绑定一个外呼号码，如果绑定多个号码，则需要传多个，例如 OutboundPhoneNumberId.1、OutboundPhoneNumberId.2、OutboundPhoneNumberId.3，以此类推。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'example' => '2ead4b47-db37-43b3-8e32-ae71d81620af', 'maxItems' => 99, @@ -19338,32 +9337,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '05B8C64B-008A-427B-8B27-84E372A291D6', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '05B8C64B-008A-427B-8B27-84E372A291D6'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -19374,14 +9352,8 @@ ], 'ListTrunksOfSkillGroup' => [ 'summary' => '调用接口：ListTrunksOfSkillGroup 查询用户技能组下中继线路配置信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19396,32 +9368,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'sdiuwd875-6260-4a53-ab6e-b13e3fb31f', - ], + 'schema' => ['description' => '技能组ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sdiuwd875-6260-4a53-ab6e-b13e3fb31f'], ], ], 'responses' => [ @@ -19429,53 +9387,24 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码'."\n" - ."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID'."\n" - ."\n", - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE', - ], - 'Success' => [ - 'description' => '是否成功'."\n" - ."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码'."\n" + ."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID'."\n" + ."\n", 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE'], + 'Success' => ['description' => '是否成功'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true'], 'TrunkConfigs' => [ 'description' => '中继线路配置信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ProviderName' => [ - 'description' => '线路供应商名称', - 'type' => 'string', - 'example' => '联通全国', - ], - 'Primary' => [ - 'description' => '线路供应商使用状态', - 'type' => 'boolean', - 'example' => 'false', - ], + 'ProviderName' => ['description' => '线路供应商名称', 'type' => 'string', 'example' => '联通全国'], + 'Primary' => ['description' => '线路供应商使用状态', 'type' => 'boolean', 'example' => 'false'], ], ], ], @@ -19485,10 +9414,7 @@ ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'UserPermission', - 'errorMessage' => 'User \'%s\' has no permission to \'%s\'', - ], + ['errorCode' => 'UserPermission', 'errorMessage' => 'User \'%s\' has no permission to \'%s\''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"Success\\": true,\\n \\"TrunkConfigs\\": [\\n {\\n \\"ProviderName\\": \\"联通全国\\",\\n \\"Primary\\": false\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\n200\\n\\n 联通全国\\n false\\n\\nOK\\ntrue","errorExample":""}]', @@ -19500,14 +9426,8 @@ ], 'ListUsersOfSkillGroup' => [ 'summary' => '调用ListUsersOfSkillGroup获取一个技能组的用户列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19521,56 +9441,28 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取用户列表的技能组所属呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], + 'schema' => ['description' => '待获取用户列表的技能组所属呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], ], [ 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取用户列表的技能组ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx', - ], + 'schema' => ['description' => '待获取用户列表的技能组ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '5', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '5'], ], ], 'responses' => [ @@ -19578,54 +9470,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C0628E65-1D39-4C26-9AF8-E64775D4BE0F', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'C0628E65-1D39-4C26-9AF8-E64775D4BE0F'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Users' => [ 'description' => '获取到的一个技能组的所有用户', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'TotalCount' => [ - 'description' => '对象总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'TotalCount' => ['description' => '对象总数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -19636,23 +9492,11 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '用户所归属的呼叫中心实ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], - 'RamId' => [ - 'description' => '用户所对应的RAM账户ID', - 'type' => 'string', - 'example' => '20643462717516xxxx', - ], - 'UserId' => [ - 'description' => '用户ID，系统自动生成的唯一标示符。'."\n" - ."\n" - .'注意这里是RAM子账号在呼叫中心实例的唯一标示符并非RamId，即UUID。', - 'type' => 'string', - 'example' => '8b33d247-128c-4013-b79d-ec11a6a8xxxx', - ], + 'InstanceId' => ['description' => '用户所归属的呼叫中心实ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], + 'RamId' => ['description' => '用户所对应的RAM账户ID', 'type' => 'string', 'example' => '20643462717516xxxx'], + 'UserId' => ['description' => '用户ID，系统自动生成的唯一标示符。'."\n" + ."\n" + .'注意这里是RAM子账号在呼叫中心实例的唯一标示符并非RamId，即UUID。', 'type' => 'string', 'example' => '8b33d247-128c-4013-b79d-ec11a6a8xxxx'], 'Roles' => [ 'type' => 'object', 'itemNode' => true, @@ -19663,32 +9507,11 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'UserCount' => [ - 'description' => '拥有该角色的用户的数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RoleName' => [ - 'description' => '角色名称', - 'type' => 'string', - 'example' => 'AGENT', - ], - 'InstanceId' => [ - 'description' => '角色所归属的呼叫中心实例', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], - 'RoleDescription' => [ - 'description' => '角色描述', - 'type' => 'string', - 'example' => '坐席', - ], - 'RoleId' => [ - 'description' => '角色ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '4c2e158e-ddd9-464a-a3fc-338eca10xxxx', - ], + 'UserCount' => ['description' => '拥有该角色的用户的数量', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'RoleName' => ['description' => '角色名称', 'type' => 'string', 'example' => 'AGENT'], + 'InstanceId' => ['description' => '角色所归属的呼叫中心实例', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], + 'RoleDescription' => ['description' => '角色描述', 'type' => 'string', 'example' => '坐席'], + 'RoleId' => ['description' => '角色ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '4c2e158e-ddd9-464a-a3fc-338eca10xxxx'], 'Privileges' => [ 'type' => 'object', 'itemNode' => true, @@ -19699,21 +9522,9 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'PrivilegeName' => [ - 'description' => '权限名称，需要唯一。', - 'type' => 'string', - 'example' => 'xxx', - ], - 'PrivilegeId' => [ - 'description' => '权限ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => 'xxx', - ], - 'PrivilegeDescription' => [ - 'description' => '权限描述', - 'type' => 'string', - 'example' => 'xxx', - ], + 'PrivilegeName' => ['description' => '权限名称，需要唯一。', 'type' => 'string', 'example' => 'xxx'], + 'PrivilegeId' => ['description' => '权限ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => 'xxx'], + 'PrivilegeDescription' => ['description' => '权限描述', 'type' => 'string', 'example' => 'xxx'], ], ], ], @@ -19734,41 +9545,16 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SkillLevelId' => [ - 'description' => '技能级别唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '121131', - ], - 'Level' => [ - 'description' => '技能级别', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], + 'SkillLevelId' => ['description' => '技能级别唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '121131'], + 'Level' => ['description' => '技能级别', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], 'Skill' => [ 'description' => '技能', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '技能组所归属的呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], - 'SkillGroupDescription' => [ - 'description' => '技能组简单描述', - 'type' => 'string', - 'example' => '售后技术支持人员使用', - ], - 'SkillGroupId' => [ - 'description' => '技能组唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx', - ], - 'SkillGroupName' => [ - 'description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', - 'type' => 'string', - 'example' => '售后技术支持技能组', - ], + 'InstanceId' => ['description' => '技能组所归属的呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], + 'SkillGroupDescription' => ['description' => '技能组简单描述', 'type' => 'string', 'example' => '售后技术支持人员使用'], + 'SkillGroupId' => ['description' => '技能组唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx'], + 'SkillGroupName' => ['description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', 'type' => 'string', 'example' => '售后技术支持技能组'], ], ], ], @@ -19780,31 +9566,11 @@ 'description' => '用户详细信息', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'description' => '用户的全名', - 'type' => 'string', - 'example' => '馨言', - ], - 'Email' => [ - 'description' => '用户的电子邮件地址', - 'type' => 'string', - 'example' => '1783922****@163.com', - ], - 'LoginName' => [ - 'description' => '用户登录名', - 'type' => 'string', - 'example' => 'xinyan', - ], - 'Department' => [ - 'description' => '所属部门', - 'type' => 'string', - 'example' => 'IT', - ], - 'Phone' => [ - 'description' => '用户的电话号码', - 'type' => 'string', - 'example' => '12345****', - ], + 'DisplayName' => ['description' => '用户的全名', 'type' => 'string', 'example' => '馨言'], + 'Email' => ['description' => '用户的电子邮件地址', 'type' => 'string', 'example' => '1783922****@163.com'], + 'LoginName' => ['description' => '用户登录名', 'type' => 'string', 'example' => 'xinyan'], + 'Department' => ['description' => '所属部门', 'type' => 'string', 'example' => 'IT'], + 'Phone' => ['description' => '用户的电话号码', 'type' => 'string', 'example' => '12345****'], ], ], ], @@ -19827,14 +9593,8 @@ ], 'ListSkillGroupStates' => [ 'summary' => '技能组瞬时状态列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19849,53 +9609,28 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - 'docRequired' => true, - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', 'docRequired' => true], ], [ 'name' => 'SkillGroupIds', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID列表，使用’,’隔开，最多50个技能组；不传查询全部。', - 'type' => 'string', - 'required' => false, - 'example' => '{"SkillGroup":[{"SkillGroupName":"Default","SkillGroupId":"014a9696-931d-49db-ae96-111d2098a548"}]}', - ], + 'schema' => ['description' => '技能组ID列表，使用’,’隔开，最多50个技能组；不传查询全部。', 'type' => 'string', 'required' => false, 'example' => '{"SkillGroup":[{"SkillGroupName":"Default","SkillGroupId":"014a9696-931d-49db-ae96-111d2098a548"}]}'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，默认值为10，最大是100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '分页大小，默认值为10，最大是100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -19903,54 +9638,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '66BD5D25-3785-46D1-BAE7-F81920E501F2', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '66BD5D25-3785-46D1-BAE7-F81920E501F2'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '报表', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalCount' => [ - 'description' => '总个数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'TotalCount' => ['description' => '总个数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -19961,63 +9660,16 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'WorkingAgents' => [ - 'description' => '话后处理坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LoggedInAgents' => [ - 'description' => '在线坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'BreakingAgents' => [ - 'description' => '小休坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LongestCall' => [ - 'description' => '最大等待时长。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'WaitingCalls' => [ - 'description' => '当前排队电话个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TalkingAgents' => [ - 'description' => '正在通话坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SkillGroupName' => [ - 'description' => '技能组展示名。', - 'type' => 'string', - 'example' => '其他服务', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814', - ], - 'ReadyAgents' => [ - 'description' => '空闲坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], + 'WorkingAgents' => ['description' => '话后处理坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'LoggedInAgents' => ['description' => '在线坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'BreakingAgents' => ['description' => '小休坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'LongestCall' => ['description' => '最大等待时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'WaitingCalls' => ['description' => '当前排队电话个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TalkingAgents' => ['description' => '正在通话坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SkillGroupName' => ['description' => '技能组展示名。', 'type' => 'string', 'example' => '其他服务'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814'], + 'ReadyAgents' => ['description' => '空闲坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'InstanceId' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], ], ], ], @@ -20044,14 +9696,8 @@ ], 'ListSkillGroupSummaryReports' => [ 'summary' => '调用接口：ListSkillGroupSummaryReports获取技能组汇总报表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20066,75 +9712,38 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], ], [ 'name' => 'SkillGroupIds', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID列表，使用“,”隔开，最多50个；不传查询全部.', - 'type' => 'string', - 'required' => false, - 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814', - ], + 'schema' => ['description' => '技能组ID列表，使用“,”隔开，最多50个；不传查询全部.', 'type' => 'string', 'required' => false, 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '起始日期，格式yyyy-MM-dd HH:mm:ss，；需要注意目前仅支持按天维度的查询，参数设置请参考案例，同时不得早于31天前的时间点。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-01-10 00:00:00', - ], + 'schema' => ['description' => '起始日期，格式yyyy-MM-dd HH:mm:ss，；需要注意目前仅支持按天维度的查询，参数设置请参考案例，同时不得早于31天前的时间点。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-01-10 00:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '终止日期，格式yyyy-MM-dd HH:mm:ss；需要注意目前仅支持按天维度的查询，参数设置请参考案例。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-01-10 00:00:00', - ], + 'schema' => ['description' => '终止日期，格式yyyy-MM-dd HH:mm:ss；需要注意目前仅支持按天维度的查询，参数设置请参考案例。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-01-10 00:00:00'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，默认值为10，最大是100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => '分页大小，默认值为10，最大是100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], ], ], 'responses' => [ @@ -20142,54 +9751,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '11C37A88-C5D4-4538-A768-AFFFC2397896', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '11C37A88-C5D4-4538-A768-AFFFC2397896'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'PagedSkillGroupSummaryReport' => [ 'description' => '报表', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalCount' => [ - 'description' => '总个数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'TotalCount' => ['description' => '总个数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -20200,372 +9773,81 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID', - 'type' => 'string', - 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称', - 'type' => 'string', - 'example' => '其他服务', - ], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], + 'SkillGroupId' => ['description' => '技能组ID', 'type' => 'string', 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814'], + 'SkillGroupName' => ['description' => '技能组名称', 'type' => 'string', 'example' => '其他服务'], 'Overall' => [ 'description' => '整体指标', 'type' => 'object', 'properties' => [ - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1158', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.0025906735099852085', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MaxWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '480', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '225', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1126', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'TotalCalls' => [ - 'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1158'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'OccupancyRate' => ['description' => '座席利用率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0.0025906735099852085'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MaxWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '480'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '225'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1126'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'TotalCalls' => ['description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], 'Inbound' => [ 'description' => '呼入指标', 'type' => 'object', 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '电话应答数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'QueueMaxWaitTimeDuration' => [ - 'description' => '队列最大等待时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AnsweredByAgentOfQueueWaitTimeDuration' => [ - 'description' => '坐席接起时队列等待时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'InComingQueueOfQueueCount' => [ - 'description' => '技能组呼入次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'string', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '分配到坐席并振铃的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AbandonedInQueueOfQueueCount' => [ - 'description' => '技能组排队放弃次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OverFlowInQueueOfQueueCount' => [ - 'description' => '技能组排队超时次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnsweredByAgentOfQueueMaxWaitTimeDuration' => [ - 'description' => '坐席接起时队列最大等待时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '服务水平即20s应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnsweredByAgentOfQueueCount' => [ - 'description' => '技能组人工接起次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'GiveUpByAgentOfQueueCount' => [ - 'description' => '技能组振铃放弃次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'QueueWaitTimeDuration' => [ - 'description' => '队列等待时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'QueueMaxWaitTimeDuration' => ['description' => '队列最大等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AnsweredByAgentOfQueueWaitTimeDuration' => ['description' => '坐席接起时队列等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'InComingQueueOfQueueCount' => ['description' => '技能组呼入次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'string', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '分配到坐席并振铃的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AbandonedInQueueOfQueueCount' => ['description' => '技能组排队放弃次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OverFlowInQueueOfQueueCount' => ['description' => '技能组排队超时次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnsweredByAgentOfQueueMaxWaitTimeDuration' => ['description' => '坐席接起时队列最大等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ServiceLevel20' => ['description' => '服务水平即20s应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnsweredByAgentOfQueueCount' => ['description' => '技能组人工接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'GiveUpByAgentOfQueueCount' => ['description' => '技能组振铃放弃次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'QueueWaitTimeDuration' => ['description' => '队列等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Outbound' => [ 'description' => '呼出指标', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14', - ], - 'CallsDialed' => [ - 'description' => '电话拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'CallsAnswered' => [ - 'description' => '电话接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnswerRate' => [ - 'description' => '接通率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MaxWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '28', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '14'], + 'CallsDialed' => ['description' => '电话拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnswerRate' => ['description' => '接通率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MaxWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '28'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '14'], ], ], ], @@ -20588,14 +9870,8 @@ ], 'ListSkillGroupSummaryReportsByInterval' => [ 'summary' => '技能组的分段汇总报表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20610,88 +9886,46 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccOQKOLI', - ], + 'abilityTreeNodes' => ['FEATUREcccOQKOLI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], ], [ 'name' => 'SkillGroupIds', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID列表，使用“,”隔开，最多50个；不传查询全部。', - 'type' => 'string', - 'required' => false, - 'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0', - ], + 'schema' => ['description' => '技能组ID列表，使用“,”隔开，最多50个；不传查询全部。', 'type' => 'string', 'required' => false, 'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0'], ], [ 'name' => 'Interval', 'in' => 'query', - 'schema' => [ - 'description' => '间隔类型。'."\n" - ."\n" - .'- Daily:天'."\n" - .'- Minute5:5分钟', - 'type' => 'string', - 'required' => false, - 'example' => 'Daily', - ], + 'schema' => ['description' => '间隔类型。'."\n" + ."\n" + .'- Daily:天'."\n" + .'- Minute5:5分钟', 'type' => 'string', 'required' => false, 'example' => 'Daily'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '起始日期，格式yyyy-MM-dd HH:mm:ss，不得早于6个月前的时间点', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-10-20 00:00:00', - ], + 'schema' => ['description' => '起始日期，格式yyyy-MM-dd HH:mm:ss，不得早于6个月前的时间点', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-10-20 00:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '终止日期，格式yyyy-MM-dd HH:mm:ss', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-10-20 00:00:00', - ], + 'schema' => ['description' => '终止日期，格式yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-10-20 00:00:00'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，默认值为10，最大是100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '分页大小，默认值为10，最大是100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], ], 'responses' => [ @@ -20699,54 +9933,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'PagedSkillGroupSummaryReport' => [ 'description' => '报表', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TotalCount' => [ - 'description' => '总个数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'TotalCount' => ['description' => '总个数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -20757,11 +9955,7 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SkillGroupId' => [ - 'description' => '技能组ID', - 'type' => 'string', - 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814', - ], + 'SkillGroupId' => ['description' => '技能组ID', 'type' => 'string', 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814'], 'IntervalList' => [ 'type' => 'object', 'itemNode' => true, @@ -20772,378 +9966,82 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Timestamp' => [ - 'description' => '日期，格式yyyy-MM-dd HH:mm:ss', - 'type' => 'string', - 'example' => '2018-09-12 15:45:00', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称', - 'type' => 'string', - 'example' => '其他服务', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID', - 'type' => 'string', - 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814', - ], + 'Timestamp' => ['description' => '日期，格式yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2018-09-12 15:45:00'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], + 'SkillGroupName' => ['description' => '技能组名称', 'type' => 'string', 'example' => '其他服务'], + 'SkillGroupId' => ['description' => '技能组ID', 'type' => 'string', 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814'], 'Overall' => [ 'description' => '整体指标', 'type' => 'object', 'properties' => [ - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OccupancyRate' => ['description' => '座席利用率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Inbound' => [ 'description' => '呼入指标', 'type' => 'object', 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '电话应答数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'QueueMaxWaitTimeDuration' => [ - 'description' => '队列最大等待时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AnsweredByAgentOfQueueWaitTimeDuration' => [ - 'description' => '坐席接起时队列等待时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'InComingQueueOfQueueCount' => [ - 'description' => '技能组呼入次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '电话呼入数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AbandonedInQueueOfQueueCount' => [ - 'description' => '技能组排队放弃次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OverFlowInQueueOfQueueCount' => [ - 'description' => '技能组排队超时次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnsweredByAgentOfQueueMaxWaitTimeDuration' => [ - 'description' => '坐席接起时队列最大等待时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '20s应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnsweredByAgentOfQueueCount' => [ - 'description' => '技能组人工接起次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'GiveUpByAgentOfQueueCount' => [ - 'description' => '技能组振铃放弃次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'QueueWaitTimeDuration' => [ - 'description' => '队列等待时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'QueueMaxWaitTimeDuration' => ['description' => '队列最大等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AnsweredByAgentOfQueueWaitTimeDuration' => ['description' => '坐席接起时队列等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'InComingQueueOfQueueCount' => ['description' => '技能组呼入次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '电话呼入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AbandonedInQueueOfQueueCount' => ['description' => '技能组排队放弃次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OverFlowInQueueOfQueueCount' => ['description' => '技能组排队超时次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnsweredByAgentOfQueueMaxWaitTimeDuration' => ['description' => '坐席接起时队列最大等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ServiceLevel20' => ['description' => '20s应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnsweredByAgentOfQueueCount' => ['description' => '技能组人工接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'GiveUpByAgentOfQueueCount' => ['description' => '技能组振铃放弃次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'QueueWaitTimeDuration' => ['description' => '队列等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], 'Outbound' => [ 'description' => '呼出指标', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'CallsDialed' => [ - 'description' => '电话拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'CallsAnswered' => [ - 'description' => '电话接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AnswerRate' => [ - 'description' => '接通率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'MaxWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'CallsDialed' => ['description' => '电话拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AnswerRate' => ['description' => '接通率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'MaxWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], ], ], ], @@ -21171,14 +10069,8 @@ ], 'ListSkillGroupSummaryReportsSinceMidnight' => [ 'summary' => '技能组当天汇总报表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -21193,53 +10085,28 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], + 'schema' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], ], [ 'name' => 'SkillGroups', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID列表，使用“,”隔开，最多50个坐席；不传查询全部。', - 'type' => 'string', - 'required' => false, - 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814', - ], + 'schema' => ['description' => '技能组ID列表，使用“,”隔开，最多50个坐席；不传查询全部。', 'type' => 'string', 'required' => false, 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，默认值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，默认值为10，最大是100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '分页大小，默认值为10，最大是100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], ], 'responses' => [ @@ -21247,54 +10114,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '19D09CCC-F298-4124-849A-AFA217819011', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '19D09CCC-F298-4124-849A-AFA217819011'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'PagedSkillGroupSummaryReport' => [ 'description' => '报表', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总个数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总个数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -21305,391 +10136,86 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Timestamp' => [ - 'description' => '日期'."\n" - ."\n" - .'格式yyyy-MM-dd HH:mm:ss', - 'type' => 'string', - 'example' => '2018-09-13 00:00:00', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称', - 'type' => 'string', - 'example' => '其他服务', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID', - 'type' => 'string', - 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814', - ], + 'Timestamp' => ['description' => '日期'."\n" + ."\n" + .'格式yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2018-09-13 00:00:00'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], + 'SkillGroupName' => ['description' => '技能组名称', 'type' => 'string', 'example' => '其他服务'], + 'SkillGroupId' => ['description' => '技能组ID', 'type' => 'string', 'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814'], 'Overall' => [ 'description' => '整体指标', - 'type' => 'object', - 'properties' => [ - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '516', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '398', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '51', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '515', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - 'Inbound' => [ - 'description' => '呼入指标', - 'type' => 'object', - 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '电话应答数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'QueueMaxWaitTimeDuration' => [ - 'description' => '队列最大等待时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AnsweredByAgentOfQueueWaitTimeDuration' => [ - 'description' => '坐席接起时队列等待时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'InComingQueueOfQueueCount' => [ - 'description' => '技能组呼入次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'string', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '分配到坐席并振铃的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AbandonedInQueueOfQueueCount' => [ - 'description' => '技能组排队放弃次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OverFlowInQueueOfQueueCount' => [ - 'description' => '技能组排队超时次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnsweredByAgentOfQueueMaxWaitTimeDuration' => [ - 'description' => '坐席接起时队列最大等待时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '20s应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnsweredByAgentOfQueueCount' => [ - 'description' => '技能组人工接起次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'GiveUpByAgentOfQueueCount' => [ - 'description' => '技能组振铃放弃次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'QueueWaitTimeDuration' => [ - 'description' => '队列等待时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsServiceLevel20' => [ - 'description' => '等待20s内坐席接起次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsServiceLevel30' => [ - 'description' => '等待30s内坐席接起次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - 'Outbound' => [ - 'description' => '呼出指标', - 'type' => 'object', - 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '电话拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAnswered' => [ - 'description' => '电话接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnswerRate' => [ - 'description' => '接通率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'type' => 'object', + 'properties' => [ + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '516'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OccupancyRate' => ['description' => '座席利用率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '398'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '51'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '515'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Inbound' => [ + 'description' => '呼入指标', + 'type' => 'object', + 'properties' => [ + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'QueueMaxWaitTimeDuration' => ['description' => '队列最大等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AnsweredByAgentOfQueueWaitTimeDuration' => ['description' => '坐席接起时队列等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'InComingQueueOfQueueCount' => ['description' => '技能组呼入次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'string', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '分配到坐席并振铃的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AbandonedInQueueOfQueueCount' => ['description' => '技能组排队放弃次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OverFlowInQueueOfQueueCount' => ['description' => '技能组排队超时次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnsweredByAgentOfQueueMaxWaitTimeDuration' => ['description' => '坐席接起时队列最大等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ServiceLevel20' => ['description' => '20s应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnsweredByAgentOfQueueCount' => ['description' => '技能组人工接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'GiveUpByAgentOfQueueCount' => ['description' => '技能组振铃放弃次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'QueueWaitTimeDuration' => ['description' => '队列等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsServiceLevel20' => ['description' => '等待20s内坐席接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsServiceLevel30' => ['description' => '等待30s内坐席接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Outbound' => [ + 'description' => '呼出指标', + 'type' => 'object', + 'properties' => [ + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsDialed' => ['description' => '电话拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnswerRate' => ['description' => '接通率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], ], @@ -21711,14 +10237,8 @@ ], 'ListTransferableSkillGroups' => [ 'summary' => '调用接口：ListTransferableSkillGroups 获取呼叫中心实例的可转接技能组。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -21733,21 +10253,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], ], 'responses' => [ @@ -21755,88 +10267,30 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID'."\n" - ."\n", - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE', - ], - 'Success' => [ - 'description' => '是否成功'."\n" - ."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID'."\n" + ."\n", 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE'], + 'Success' => ['description' => '是否成功'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true'], 'SkillGroups' => [ 'description' => '待转接技能组信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'AllowPrivateOutboundNumber' => [ - 'description' => '是否允许技能组内用户使用个人外呼号码', - 'type' => 'boolean', - 'example' => 'false', - ], - 'RoutingStrategy' => [ - 'description' => '路由策略', - 'type' => 'string', - 'example' => '无', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称', - 'type' => 'string', - 'example' => 'test', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID', - 'type' => 'string', - 'example' => '223048-9cf-4a53-ab6e-b13e3fb31f7d ', - ], - 'UserCount' => [ - 'description' => '归属于该技能组的座席数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'AccQueueName' => [ - 'description' => 'acc队列名字', - 'type' => 'string', - 'example' => '无', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d ', - ], - 'SkillGroupDescription' => [ - 'description' => '技能组描述信息', - 'type' => 'string', - 'example' => 'test', - ], - 'AccSkillGroupName' => [ - 'description' => 'acc技能组名字', - 'type' => 'string', - 'example' => '无', - ], + 'AllowPrivateOutboundNumber' => ['description' => '是否允许技能组内用户使用个人外呼号码', 'type' => 'boolean', 'example' => 'false'], + 'RoutingStrategy' => ['description' => '路由策略', 'type' => 'string', 'example' => '无'], + 'SkillGroupName' => ['description' => '技能组名称', 'type' => 'string', 'example' => 'test'], + 'SkillGroupId' => ['description' => '技能组ID', 'type' => 'string', 'example' => '223048-9cf-4a53-ab6e-b13e3fb31f7d '], + 'UserCount' => ['description' => '归属于该技能组的座席数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'AccQueueName' => ['description' => 'acc队列名字', 'type' => 'string', 'example' => '无'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d '], + 'SkillGroupDescription' => ['description' => '技能组描述信息', 'type' => 'string', 'example' => 'test'], + 'AccSkillGroupName' => ['description' => 'acc技能组名字', 'type' => 'string', 'example' => '无'], ], ], ], @@ -21846,10 +10300,7 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterNull', - 'errorMessage' => 'Parameter \'%s\' can not be null or empty.', - ], + ['errorCode' => 'ParameterNull', 'errorMessage' => 'Parameter \'%s\' can not be null or empty.'], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"Success\\": true,\\n \\"SkillGroups\\": [\\n {\\n \\"AllowPrivateOutboundNumber\\": false,\\n \\"RoutingStrategy\\": \\"无\\",\\n \\"SkillGroupName\\": \\"test\\",\\n \\"SkillGroupId\\": \\"223048-9cf-4a53-ab6e-b13e3fb31f7d\\\\t\\",\\n \\"UserCount\\": 10,\\n \\"AccQueueName\\": \\"无\\",\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\\\t\\",\\n \\"SkillGroupDescription\\": \\"test\\",\\n \\"AccSkillGroupName\\": \\"无\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\n200\\n\\n false\\n test\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\n 10\\n 223048-9cf-4a53-ab6e-b13e3fb31f7d\\n test\\n\\nOK\\ntrue","errorExample":""}]', @@ -21860,14 +10311,8 @@ ], 'ListSkillGroups' => [ 'summary' => '调用ListSkillGroups获取呼叫中心实例的所有技能组。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -21881,21 +10326,13 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccPBOQGO', - ], + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取技能组的呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '待获取技能组的呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'SkillGroupId', @@ -21904,9 +10341,7 @@ 'schema' => [ 'description' => '技能组ID。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '0ee27b3b-6765-499a-a741-61b16a901e51', 'maxItems' => 500, @@ -21919,9 +10354,7 @@ 'schema' => [ 'description' => '技能组名称。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => false, 'example' => '售前技能组', 'maxItems' => 500, @@ -21933,32 +10366,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '19D09CCC-F298-4124-849A-AFA217819011', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '19D09CCC-F298-4124-849A-AFA217819011'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'SkillGroups' => [ 'type' => 'object', 'itemNode' => true, @@ -21969,47 +10381,14 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'RoutingStrategy' => [ - 'description' => '匹配方式', - 'type' => 'string', - 'example' => 'default', - ], - 'SkillGroupId' => [ - 'description' => '技能组唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '0ee27b3b-6765-499a-a741-61b16a901e51', - ], - 'SkillGroupName' => [ - 'description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', - 'type' => 'string', - 'example' => 'Default', - ], - 'UserCount' => [ - 'description' => '归属于该技能组的座席数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '14', - ], - 'InstanceId' => [ - 'description' => '技能组所归属的呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], - 'AccQueueName' => [ - 'description' => 'acc队列名字', - 'type' => 'string', - 'example' => 'AliQ_acc2631_0ee27b3b-6765-499a-a741-61b16a901e51', - ], - 'AccSkillGroupName' => [ - 'description' => 'acc技能组名字', - 'type' => 'string', - 'example' => 'AliS_acc2631_0ee27b3b-6765-499a-a741-61b16a901e51', - ], - 'SkillGroupDescription' => [ - 'description' => '技能组简单描述', - 'type' => 'string', - 'example' => '默认技能组', - ], + 'RoutingStrategy' => ['description' => '匹配方式', 'type' => 'string', 'example' => 'default'], + 'SkillGroupId' => ['description' => '技能组唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '0ee27b3b-6765-499a-a741-61b16a901e51'], + 'SkillGroupName' => ['description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', 'type' => 'string', 'example' => 'Default'], + 'UserCount' => ['description' => '归属于该技能组的座席数量', 'type' => 'integer', 'format' => 'int32', 'example' => '14'], + 'InstanceId' => ['description' => '技能组所归属的呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], + 'AccQueueName' => ['description' => 'acc队列名字', 'type' => 'string', 'example' => 'AliQ_acc2631_0ee27b3b-6765-499a-a741-61b16a901e51'], + 'AccSkillGroupName' => ['description' => 'acc技能组名字', 'type' => 'string', 'example' => 'AliS_acc2631_0ee27b3b-6765-499a-a741-61b16a901e51'], + 'SkillGroupDescription' => ['description' => '技能组简单描述', 'type' => 'string', 'example' => '默认技能组'], 'OutboundPhoneNumbers' => [ 'type' => 'object', 'itemNode' => true, @@ -22020,53 +10399,15 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'TestOnly' => [ - 'description' => '是否是测试号码', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Trunks' => [ - 'description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RemainingTime' => [ - 'description' => '测试号码剩余的通话时间。单位为分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Number' => [ - 'description' => '电话号码', - 'type' => 'string', - 'example' => '02566040852', - ], - 'InstanceId' => [ - 'description' => '电话号码所归属的呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], - 'Usage' => [ - 'description' => '电话号码的用途，呼入（Inbound），呼出（Outbound），以及同时用于呼入和呼出（Bidirection）。', - 'type' => 'string', - 'example' => 'Inbound', - ], - 'AllowOutbound' => [ - 'description' => '是否允许外呼。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PhoneNumberDescription' => [ - 'description' => '电话号码的简单描述', - 'type' => 'string', - 'example' => 'Ali Telecom', - ], - 'PhoneNumberId' => [ - 'description' => '电话号码ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => 'f49392e1-9714-42b1-a15a-9a2f0cd88ef1', - ], + 'TestOnly' => ['description' => '是否是测试号码', 'type' => 'boolean', 'example' => 'false'], + 'Trunks' => ['description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RemainingTime' => ['description' => '测试号码剩余的通话时间。单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Number' => ['description' => '电话号码', 'type' => 'string', 'example' => '02566040852'], + 'InstanceId' => ['description' => '电话号码所归属的呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], + 'Usage' => ['description' => '电话号码的用途，呼入（Inbound），呼出（Outbound），以及同时用于呼入和呼出（Bidirection）。', 'type' => 'string', 'example' => 'Inbound'], + 'AllowOutbound' => ['description' => '是否允许外呼。', 'type' => 'boolean', 'example' => 'true'], + 'PhoneNumberDescription' => ['description' => '电话号码的简单描述', 'type' => 'string', 'example' => 'Ali Telecom'], + 'PhoneNumberId' => ['description' => '电话号码ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => 'f49392e1-9714-42b1-a15a-9a2f0cd88ef1'], ], ], ], @@ -22089,14 +10430,8 @@ ], 'ListSkillGroupsOfUser' => [ 'summary' => '调用ListSkillGroupsOfUser获取坐席所归属的技能组列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22110,34 +10445,20 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccPBOQGO', - ], + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取技能组列表的用户ID。'."\n" - ."\n" - .'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c8b21767-bd0e-4a6e-937e-c46cd07fxxxx', - ], + 'schema' => ['description' => '待获取技能组列表的用户ID。'."\n" + ."\n" + .'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c8b21767-bd0e-4a6e-937e-c46cd07fxxxx'], ], ], 'responses' => [ @@ -22145,32 +10466,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'E35B41EA-C06C-44D6-8BE9-9FE8960641FD', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'E35B41EA-C06C-44D6-8BE9-9FE8960641FD'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'SkillLevels' => [ 'type' => 'object', 'itemNode' => true, @@ -22181,46 +10481,17 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'SkillLevelId' => [ - 'description' => '技能级别唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '116786', - ], - 'Level' => [ - 'description' => '技能级别', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], + 'SkillLevelId' => ['description' => '技能级别唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '116786'], + 'Level' => ['description' => '技能级别', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], 'Skill' => [ 'description' => '技能', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '技能组所归属的呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], - 'RoutingStrategy' => [ - 'description' => '匹配方式', - 'type' => 'string', - 'example' => 'default', - ], - 'SkillGroupDescription' => [ - 'description' => '技能组简单描述', - 'type' => 'string', - 'example' => '售后技术支持人员使用', - ], - 'SkillGroupName' => [ - 'description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', - 'type' => 'string', - 'example' => '售后技术支持技能组', - ], - 'SkillGroupId' => [ - 'description' => '技能组唯一ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx', - ], + 'InstanceId' => ['description' => '技能组所归属的呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], + 'RoutingStrategy' => ['description' => '匹配方式', 'type' => 'string', 'example' => 'default'], + 'SkillGroupDescription' => ['description' => '技能组简单描述', 'type' => 'string', 'example' => '售后技术支持人员使用'], + 'SkillGroupName' => ['description' => '技能组名字，需要在所归属的呼叫中心实例中唯一。', 'type' => 'string', 'example' => '售后技术支持技能组'], + 'SkillGroupId' => ['description' => '技能组唯一ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx'], 'OutboundPhoneNumbers' => [ 'type' => 'object', 'itemNode' => true, @@ -22231,63 +10502,17 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'TestOnly' => [ - 'description' => '是否是测试号码', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Trunks' => [ - 'description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RemainingTime' => [ - 'description' => '测试号码剩余的通话时间。单位为分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Number' => [ - 'description' => '电话号码', - 'type' => 'string', - 'example' => '0108648xxxx', - ], - 'City' => [ - 'description' => '号码归属地市。', - 'type' => 'string', - 'example' => '北京', - ], - 'InstanceId' => [ - 'description' => '电话号码所归属的呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], - 'Usage' => [ - 'description' => '电话号码的用途，呼入，呼出，已经同时用于呼入和呼出。 Inbound, Outbound, Bidirection。上述值由枚举类型PhoneNumberType定义。该值的结果取决于1）大于的设置，比如400号码不允许外呼 2）呼叫中心实例的设置。电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不连接人和联系流IVR，但是ACC不建议这么做。', - 'type' => 'string', - 'example' => 'Bidirection', - ], - 'AllowOutbound' => [ - 'description' => '是否允许外呼，结果取决于1）大于的设置，比如400号码不允许外呼 2）呼叫中心实例的设置。电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不绑定联系流IVR，但是ACC不建议这么做。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PhoneNumberDescription' => [ - 'description' => '电话号码的简单描述', - 'type' => 'string', - 'example' => 'Ali Telecom', - ], - 'Province' => [ - 'description' => '号码归属地省。', - 'type' => 'string', - 'example' => '北京', - ], - 'PhoneNumberId' => [ - 'description' => '电话号码ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '2ead4b47-db37-43b3-8e32-ae71d81620af', - ], + 'TestOnly' => ['description' => '是否是测试号码', 'type' => 'boolean', 'example' => 'false'], + 'Trunks' => ['description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RemainingTime' => ['description' => '测试号码剩余的通话时间。单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Number' => ['description' => '电话号码', 'type' => 'string', 'example' => '0108648xxxx'], + 'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '北京'], + 'InstanceId' => ['description' => '电话号码所归属的呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], + 'Usage' => ['description' => '电话号码的用途，呼入，呼出，已经同时用于呼入和呼出。 Inbound, Outbound, Bidirection。上述值由枚举类型PhoneNumberType定义。该值的结果取决于1）大于的设置，比如400号码不允许外呼 2）呼叫中心实例的设置。电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不连接人和联系流IVR，但是ACC不建议这么做。', 'type' => 'string', 'example' => 'Bidirection'], + 'AllowOutbound' => ['description' => '是否允许外呼，结果取决于1）大于的设置，比如400号码不允许外呼 2）呼叫中心实例的设置。电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不绑定联系流IVR，但是ACC不建议这么做。', 'type' => 'boolean', 'example' => 'true'], + 'PhoneNumberDescription' => ['description' => '电话号码的简单描述', 'type' => 'string', 'example' => 'Ali Telecom'], + 'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '北京'], + 'PhoneNumberId' => ['description' => '电话号码ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '2ead4b47-db37-43b3-8e32-ae71d81620af'], ], ], ], @@ -22312,14 +10537,8 @@ ], 'RemoveUsersFromSkillGroup' => [ 'summary' => '调用RemoveUsersFromSkillGroup从一个技能组中移除用户。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22334,30 +10553,18 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待移除用户的呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '18b4f6bd-12f7-4ab6-91d1-bf43b854f35c', - ], + 'schema' => ['description' => '待移除用户的呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '18b4f6bd-12f7-4ab6-91d1-bf43b854f35c'], ], [ 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '待移除用户的技能组ID', - 'type' => 'string', - 'required' => true, - 'example' => 'b9458ffa-b3aa-4747-acb0-f0c8acbabe95', - ], + 'schema' => ['description' => '待移除用户的技能组ID', 'type' => 'string', 'required' => true, 'example' => 'b9458ffa-b3aa-4747-acb0-f0c8acbabe95'], ], [ 'name' => 'UserId', @@ -22368,9 +10575,7 @@ ."\n" .'**UserId.1**意为只移除一个坐席，如果移除多个，则需要传多个，例如 UserId.1、UserId.2、UserId.3，以此类推。注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], 'required' => true, 'example' => 'ad7dea7f-c735-4f00-a725-7278d7e802dd', 'maxItems' => 99, @@ -22382,32 +10587,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'AF9834D8-6D09-4A1B-BADB-B019D9D444C8', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'AF9834D8-6D09-4A1B-BADB-B019D9D444C8'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -22418,14 +10602,8 @@ ], 'ListOutboundPhoneNumberOfUser' => [ 'summary' => '调用ListOutboundPhoneNumberOfUser获取坐席的所有外呼电话列表，包含个人外呼号码及所属技能组外呼号码。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22440,56 +10618,30 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '待获取外呼号码列表的用户ID。'."\n" - ."\n" - .'> 这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c8b21767-bd0e-4a6e-937e-c46cd07f****', - ], + 'schema' => ['description' => '待获取外呼号码列表的用户ID。'."\n" + ."\n" + .'> 这里是RAM子账号在呼叫中心实例的唯一标识并非RamId，即UUID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c8b21767-bd0e-4a6e-937e-c46cd07f****'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -22497,43 +10649,18 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DB6F6562-C76A-4A4D-892A-F33F638C058D', - ], - 'Success' => [ - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DB6F6562-C76A-4A4D-892A-F33F638C058D'], + 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], 'NumberList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Number' => [ 'type' => 'array', - 'items' => [ - 'description' => '真实外呼号码列表。', - 'type' => 'string', - 'example' => '["05712823****"]', - ], + 'items' => ['description' => '真实外呼号码列表。', 'type' => 'string', 'example' => '["05712823****"]'], ], ], ], @@ -22547,134 +10674,44 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'PrivateFlag' => [ - 'description' => '标识该号码是否为个人外呼号码。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'TestOnly' => [ - 'description' => '是否是测试号码。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'SipTelX' => [ - 'description' => 'sip虚拟号码', - 'type' => 'string', - 'example' => '1302015****', - ], - 'RemainingTime' => [ - 'description' => '测试号码剩余的通话时间。单位为分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'City' => [ - 'description' => '号码归属地市。', - 'type' => 'string', - 'example' => '北京', - ], - 'InstanceId' => [ - 'description' => '电话号码所归属的呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d****', - ], - 'AllowOutbound' => [ - 'description' => '是否允许外呼，结果取决于：'."\n" - ."\n" - .'- 大于的设置，比如400号码不允许外呼'."\n" - .'- 呼叫中心实例的设置'."\n" - ."\n" - .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不绑定联系流IVR，但是ACC不建议这么做。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Usage' => [ - 'description' => '电话号码的用途，呼入（Inbound），呼出（Outbound），已经同时用于呼入和呼出（Bidirection）。上述值由枚举类型PhoneNumberType定义。'."\n" - ."\n" - .'该值的结果取决于：'."\n" - ."\n" - .'- 大于的设置，比如400号码不允许外呼'."\n" - .'- 呼叫中心实例的设置'."\n" - ."\n\n" - .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不连接人和联系流IVR，但是ACC不建议这么做。', - 'type' => 'string', - 'example' => 'Bidirection', - ], - 'PhoneNumberId' => [ - 'description' => '电话号码ID，系统自动生成的唯一标示符。', - 'type' => 'string', - 'example' => '0010faaa-0c07-4421-8929-9ea6a051****', - ], - 'Trunks' => [ - 'description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Number' => [ - 'description' => '电话号码。', - 'type' => 'string', - 'example' => '05712823****', - ], - 'PhoneNumberDescription' => [ - 'description' => '电话号码的简单描述。', - 'type' => 'string', - 'example' => 'Ali Telecom', - ], - 'Province' => [ - 'description' => '号码归属地省。', - 'type' => 'string', - 'example' => '北京', - ], + 'PrivateFlag' => ['description' => '标识该号码是否为个人外呼号码。', 'type' => 'boolean', 'example' => 'true'], + 'TestOnly' => ['description' => '是否是测试号码。', 'type' => 'boolean', 'example' => 'false'], + 'SipTelX' => ['description' => 'sip虚拟号码', 'type' => 'string', 'example' => '1302015****'], + 'RemainingTime' => ['description' => '测试号码剩余的通话时间。单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '北京'], + 'InstanceId' => ['description' => '电话号码所归属的呼叫中心实例ID。', 'type' => 'string', 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d****'], + 'AllowOutbound' => ['description' => '是否允许外呼，结果取决于：'."\n" + ."\n" + .'- 大于的设置，比如400号码不允许外呼'."\n" + .'- 呼叫中心实例的设置'."\n" + ."\n" + .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不绑定联系流IVR，但是ACC不建议这么做。', 'type' => 'boolean', 'example' => 'true'], + 'Usage' => ['description' => '电话号码的用途，呼入（Inbound），呼出（Outbound），已经同时用于呼入和呼出（Bidirection）。上述值由枚举类型PhoneNumberType定义。'."\n" + ."\n" + .'该值的结果取决于：'."\n" + ."\n" + .'- 大于的设置，比如400号码不允许外呼'."\n" + .'- 呼叫中心实例的设置'."\n" + ."\n\n" + .'> 电话号码一般都允许内呼，如果不允许内呼，可以1）由大于做设置，用户拨打该号码时听到提示音 2）该号码不连接人和联系流IVR，但是ACC不建议这么做。', 'type' => 'string', 'example' => 'Bidirection'], + 'PhoneNumberId' => ['description' => '电话号码ID，系统自动生成的唯一标示符。', 'type' => 'string', 'example' => '0010faaa-0c07-4421-8929-9ea6a051****'], + 'Trunks' => ['description' => '电话号码的中继数量，即可同时支持几路通话，数据来源于大于。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'Number' => ['description' => '电话号码。', 'type' => 'string', 'example' => '05712823****'], + 'PhoneNumberDescription' => ['description' => '电话号码的简单描述。', 'type' => 'string', 'example' => 'Ali Telecom'], + 'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '北京'], 'PrivacyNumber' => [ 'description' => '电话号码所绑定的虚拟号码关系。', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '选择绑定虚拟号码的类型，包括**AXN**和**AXB**。', - 'type' => 'string', - 'example' => 'AXN', - ], - 'PoolId' => [ - 'description' => '虚拟号码所在池子ID。', - 'type' => 'string', - 'example' => '18b74553-484f-40c7-b6f9-81be0cbe****', - ], - 'SubId' => [ - 'description' => '类型为AXN，返回的绑定关系唯一标识，若类型为AXB，则此字段为空。', - 'type' => 'string', - 'example' => '6a5f6c7c2f774fb38b4aaf35c4e7****', - ], - 'PhoneNumber' => [ - 'description' => '绑定的呼叫中心号码。', - 'type' => 'string', - 'example' => '05712823****', - ], - 'PoolName' => [ - 'description' => '虚拟号码池名称。', - 'type' => 'string', - 'example' => '个人虚拟号码', - ], - 'BizId' => [ - 'description' => '第三方业务ID。', - 'type' => 'string', - 'example' => '4b32b62d3aae4d86a6c4bb26c3ee****', - ], - 'RegionNameCity' => [ - 'description' => '虚拟号码归属地市。', - 'type' => 'string', - 'example' => '上海市', - ], - 'Extra' => [ - 'description' => '其他参数，以Json字符串存入。', - 'type' => 'string', - 'example' => '{"name":"amy","cardno":"130226198001110819"}', - ], - 'TelX' => [ - 'description' => '选择AXN模式绑定的虚拟号码，若类型为AXB，则此字段为空。', - 'type' => 'string', - 'example' => '1302015****', - ], + 'Type' => ['description' => '选择绑定虚拟号码的类型，包括**AXN**和**AXB**。', 'type' => 'string', 'example' => 'AXN'], + 'PoolId' => ['description' => '虚拟号码所在池子ID。', 'type' => 'string', 'example' => '18b74553-484f-40c7-b6f9-81be0cbe****'], + 'SubId' => ['description' => '类型为AXN，返回的绑定关系唯一标识，若类型为AXB，则此字段为空。', 'type' => 'string', 'example' => '6a5f6c7c2f774fb38b4aaf35c4e7****'], + 'PhoneNumber' => ['description' => '绑定的呼叫中心号码。', 'type' => 'string', 'example' => '05712823****'], + 'PoolName' => ['description' => '虚拟号码池名称。', 'type' => 'string', 'example' => '个人虚拟号码'], + 'BizId' => ['description' => '第三方业务ID。', 'type' => 'string', 'example' => '4b32b62d3aae4d86a6c4bb26c3ee****'], + 'RegionNameCity' => ['description' => '虚拟号码归属地市。', 'type' => 'string', 'example' => '上海市'], + 'Extra' => ['description' => '其他参数，以Json字符串存入。', 'type' => 'string', 'example' => '{"name":"amy","cardno":"130226198001110819"}'], + 'TelX' => ['description' => '选择AXN模式绑定的虚拟号码，若类型为AXB，则此字段为空。', 'type' => 'string', 'example' => '1302015****'], ], ], ], @@ -22695,14 +10732,8 @@ ], 'ListRecordings' => [ 'summary' => '调用接口：ListRecordings 获取录音列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22716,94 +10747,48 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'StopTime', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的终止时间。缺省为0，代表截止到目前的时间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '获取的历史数据的终止时间。缺省为0，代表截止到目前的时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d ', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d '], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的起始时间。缺省为0，代表从当天的0时开始。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '获取的历史数据的起始时间。缺省为0，代表从当天的0时开始。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ 'name' => 'PhoneNumber', 'in' => 'query', - 'schema' => [ - 'description' => '待获取数据的呼叫中心的电话号码', - 'type' => 'string', - 'required' => false, - 'example' => '01099998888', - ], + 'schema' => ['description' => '待获取数据的呼叫中心的电话号码', 'type' => 'string', 'required' => false, 'example' => '01099998888'], ], [ 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '座席ID，对应于RamId', - 'type' => 'string', - 'required' => false, - 'example' => '2384025204570273452', - ], + 'schema' => ['description' => '座席ID，对应于RamId', 'type' => 'string', 'required' => false, 'example' => '2384025204570273452'], ], [ 'name' => 'Criteria', 'in' => 'query', - 'schema' => [ - 'description' => '搜索条件', - 'type' => 'string', - 'required' => false, - 'example' => '01099998888', - ], + 'schema' => ['description' => '搜索条件', 'type' => 'string', 'required' => false, 'example' => '01099998888'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], ], ], 'responses' => [ @@ -22811,59 +10796,23 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码'."\n" - ."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID'."\n" - ."\n", - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE', - ], - 'Success' => [ - 'description' => '是否成功'."\n" - ."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码'."\n" + ."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID'."\n" + ."\n", 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE'], + 'Success' => ['description' => '是否成功'."\n" + ."\n", 'type' => 'boolean', 'example' => 'true'], 'Recordings' => [ 'description' => '录音信息集合', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总条数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '29', - ], + 'PageNumber' => ['description' => '分页序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '29'], 'List' => [ 'type' => 'object', 'itemNode' => true, @@ -22874,73 +10823,19 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'ContactType' => [ - 'description' => '通话类型, 参考枚举类型 ContactType，Inbound 内呼, Outbound 外呼', - 'type' => 'string', - 'example' => 'Outbound', - ], - 'AgentId' => [ - 'description' => '座席ID，对应于RamId', - 'type' => 'string', - 'example' => '2384025204570273452', - ], - 'AgentName' => [ - 'description' => '座席名称', - 'type' => 'string', - 'example' => 'ccctest1', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], - 'FileName' => [ - 'description' => '录音文件名', - 'type' => 'string', - 'example' => '8420398402-45937.wav', - ], - 'CalledNumber' => [ - 'description' => '被叫电话', - 'type' => 'string', - 'example' => '1870169190889', - ], - 'StartTime' => [ - 'description' => '通话开始时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1576295278000', - ], - 'FilePath' => [ - 'description' => '录音文件在OSS中的保存位置', - 'type' => 'string', - 'example' => 'oss://cloudcall-test/', - ], - 'ContactId' => [ - 'description' => '通话ID', - 'type' => 'string', - 'example' => '209887678', - ], - 'CallingNumber' => [ - 'description' => '主叫电话', - 'type' => 'string', - 'example' => '01099998888', - ], - 'Duration' => [ - 'description' => '通话时长', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'FileDescription' => [ - 'description' => '录音文件别名', - 'type' => 'string', - 'example' => '无', - ], - 'Channel' => [ - 'description' => '座席所在音轨标示', - 'type' => 'string', - 'example' => '无', - ], + 'ContactType' => ['description' => '通话类型, 参考枚举类型 ContactType，Inbound 内呼, Outbound 外呼', 'type' => 'string', 'example' => 'Outbound'], + 'AgentId' => ['description' => '座席ID，对应于RamId', 'type' => 'string', 'example' => '2384025204570273452'], + 'AgentName' => ['description' => '座席名称', 'type' => 'string', 'example' => 'ccctest1'], + 'InstanceId' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], + 'FileName' => ['description' => '录音文件名', 'type' => 'string', 'example' => '8420398402-45937.wav'], + 'CalledNumber' => ['description' => '被叫电话', 'type' => 'string', 'example' => '1870169190889'], + 'StartTime' => ['description' => '通话开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1576295278000'], + 'FilePath' => ['description' => '录音文件在OSS中的保存位置', 'type' => 'string', 'example' => 'oss://cloudcall-test/'], + 'ContactId' => ['description' => '通话ID', 'type' => 'string', 'example' => '209887678'], + 'CallingNumber' => ['description' => '主叫电话', 'type' => 'string', 'example' => '01099998888'], + 'Duration' => ['description' => '通话时长', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], + 'FileDescription' => ['description' => '录音文件别名', 'type' => 'string', 'example' => '无'], + 'Channel' => ['description' => '座席所在音轨标示', 'type' => 'string', 'example' => '无'], ], ], ], @@ -22961,14 +10856,8 @@ ], 'ModifySkillGroupBasicInfo' => [ 'summary' => '修改技能组基础信息,包括技能组名称、技能组描述、匹配模式、个人外呼号码标识等基础信息', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22983,62 +10872,38 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccPBOQGO', - ], + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'RoutingStrategy', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'AllowPrivateOutboundNumber', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false'], ], ], 'responses' => [ @@ -23046,22 +10911,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int32'], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], @@ -23069,9 +10923,6 @@ ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'ccc.cn-shanghai.aliyuncs.com', - ], + ['regionId' => 'cn-shanghai', 'endpoint' => 'ccc.cn-shanghai.aliyuncs.com'], ], ]; diff --git a/data/zh_cn/ccc/2020-05-27/api-docs.php b/data/zh_cn/ccc/2020-05-27/api-docs.php index 798ed93..3ed8776 100644 --- a/data/zh_cn/ccc/2020-05-27/api-docs.php +++ b/data/zh_cn/ccc/2020-05-27/api-docs.php @@ -1,18 +1,12 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'CCC', - 'version' => '2020-05-27', - ], + 'info' => ['style' => 'RPC', 'product' => 'CCC', 'version' => '2020-05-27'], 'directories' => [ [ 'id' => 0, 'title' => '其它', 'type' => 'directory', - 'children' => [ - 'CheckServiceLinkedRoleForDeleting', - ], + 'children' => ['CheckServiceLinkedRoleForDeleting'], ], ], 'components' => [ @@ -20,14 +14,8 @@ ], 'apis' => [ 'CheckServiceLinkedRoleForDeleting' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -40,34 +28,22 @@ [ 'name' => 'RoleArn', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'SPIRegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'DeletionTaskId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], ], 'responses' => [ @@ -75,25 +51,17 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DeleTable' => [ - 'type' => 'boolean', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'DeleTable' => ['type' => 'boolean'], + 'RequestId' => ['type' => 'string'], 'RoleUsages' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Region' => [ - 'type' => 'string', - ], + 'Region' => ['type' => 'string'], 'Resources' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string'], ], ], ], @@ -107,9 +75,6 @@ ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'ccc.cn-shanghai.aliyuncs.com', - ], + ['regionId' => 'cn-shanghai', 'endpoint' => 'ccc.cn-shanghai.aliyuncs.com'], ], ]; diff --git a/data/zh_cn/ccc/2020-07-01/api-docs.php b/data/zh_cn/ccc/2020-07-01/api-docs.php index d924900..ec1789a 100644 --- a/data/zh_cn/ccc/2020-07-01/api-docs.php +++ b/data/zh_cn/ccc/2020-07-01/api-docs.php @@ -1,416 +1,150 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'CCC', - 'version' => '2020-07-01', - ], + 'info' => ['style' => 'RPC', 'product' => 'CCC', 'version' => '2020-07-01'], 'directories' => [ [ - 'id' => 168396, - 'title' => '权限', + 'children' => ['ListPrivilegesOfUser'], 'type' => 'directory', - 'children' => [ - 'ListPrivilegesOfUser', - 'ListRoles', - ], + 'title' => '权限', + 'id' => 346786, ], [ - 'id' => 168399, - 'title' => '实例', + 'children' => ['ListInstancesOfUser', 'ModifyInstance'], 'type' => 'directory', - 'children' => [ - 'DeleteInstance', - 'CreateInstance', - 'GetInstance', - 'ListInstances', - 'ListInstancesOfUser', - 'ModifyInstance', - ], + 'title' => '实例', + 'id' => 346789, ], [ - 'id' => 168405, - 'title' => '号码', + 'children' => ['AddPersonalNumbersToUser', 'AddPhoneNumbers', 'AddPhoneNumberToSkillGroups', 'ListOutboundNumbersOfUser', 'ListPersonalNumbersOfUser', 'ListPhoneNumbers', 'ListPhoneNumbersOfSkillGroup', 'ListUnassignedNumbers', 'ModifyPhoneNumber', 'ImportCorpNumbers', 'RemovePersonalNumbersFromUser', 'RemovePhoneNumberFromSkillGroups', 'RemovePhoneNumbers', 'RemovePhoneNumbersFromSkillGroup'], 'type' => 'directory', - 'children' => [ - 'AddPersonalNumbersToUser', - 'AddPhoneNumbers', - 'AddPhoneNumberToSkillGroups', - 'ListOutboundNumbersOfUser', - 'ListPersonalNumbersOfUser', - 'ListPhoneNumbers', - 'ListPhoneNumbersOfSkillGroup', - 'ListUnassignedNumbers', - 'ModifyPhoneNumber', - 'ImportCorpNumbers', - 'RemovePersonalNumbersFromUser', - 'RemovePhoneNumberFromSkillGroups', - 'RemovePhoneNumbers', - 'RemovePhoneNumbersFromSkillGroup', - ], + 'title' => '号码', + 'id' => 346796, ], [ - 'id' => 168421, - 'title' => '技能组', + 'children' => ['AddNumbersToSkillGroup', 'AddUsersToSkillGroup', 'GetSkillGroup', 'ListBriefSkillGroups', 'ListSkillGroups', 'ListSkillLevelsOfUser', 'ModifySkillGroup', 'ModifySkillLevelsOfUser', 'RemoveSkillGroupsFromUser'], 'type' => 'directory', - 'children' => [ - 'AddNumbersToSkillGroup', - 'AddUsersToSkillGroup', - 'CreateSkillGroup', - 'DeleteSkillGroup', - 'GetSkillGroup', - 'ListBriefSkillGroups', - 'ListSkillGroups', - 'ListSkillLevelsOfUser', - 'ModifySkillGroup', - 'ModifySkillLevelsOfUser', - 'RemoveSkillGroupsFromUser', - ], + 'title' => '技能组', + 'id' => 346822, ], [ - 'id' => 168433, - 'title' => '坐席', + 'children' => ['ImportRamUsers', 'ChangeVisibility', 'AddSkillGroupsToUser', 'AssignUsers', 'ChangeWorkMode', 'ImportAdmins', 'ListDevices', 'ListRamUsers', 'ListUserLevelsOfSkillGroup', 'ModifyUserLevelsOfSkillGroup', 'RegisterDevice', 'RegisterDevices', 'RemoveUsersFromSkillGroup', 'ResetAgentState', 'UnregisterDevice'], 'type' => 'directory', - 'children' => [ - 'ImportRamUsers', - 'ChangeVisibility', - 'AddSkillGroupsToUser', - 'AssignUsers', - 'ChangeWorkMode', - 'CreateUser', - 'GetUser', - 'ImportAdmins', - 'ListDevices', - 'ListRamUsers', - 'ListUserLevelsOfSkillGroup', - 'ListUsers', - 'ModifyUser', - 'ModifyUserLevelsOfSkillGroup', - 'RegisterDevice', - 'RegisterDevices', - 'RemoveUsers', - 'RemoveUsersFromSkillGroup', - 'ResetAgentState', - 'ResetUserPassword', - 'UnregisterDevice', - ], + 'title' => '坐席', + 'id' => 346834, ], [ - 'id' => 168452, - 'title' => '话务', - 'type' => 'directory', 'children' => [ - 'AnswerCall', - 'BargeInCall', - 'BlindTransfer', - 'CancelAttendedTransfer', - 'CoachCall', - 'CompleteAttendedTransfer', - 'EndConference', - 'GetNumberLocation', - 'HoldCall', - 'InitiateAttendedTransfer', - 'InterceptCall', - 'LaunchAuthentication', - 'LaunchSurvey', - 'MakeCall', - 'MonitorCall', - 'MuteCall', - 'PickOutboundNumbers', - 'PollUserStatus', - 'ReadyForService', - 'RedialCall', - 'ReleaseCall', - 'RetrieveCall', - 'SaveRTCStatsV2', - 'SaveTerminalLog', - 'SaveWebRtcInfo', - 'SaveWebRTCStats', - 'SendDtmfSignaling', - 'SignInGroup', - 'SignOutGroup', - 'StartBack2BackCall', - 'StartConference', - 'StartPredictiveCall', - 'StartPrivacyCall', - 'SwitchToConference', - 'TakeBreak', - 'UnmuteCall', + 'BargeInCall', 'BlindTransfer', 'CancelAttendedTransfer', 'CoachCall', 'CompleteAttendedTransfer', 'EndConference', 'GetNumberLocation', 'InitiateAttendedTransfer', 'InterceptCall', 'LaunchAuthentication', 'LaunchSurvey', 'MonitorCall', 'MuteCall', 'PickOutboundNumbers', 'PollUserStatus', 'ReadyForService', 'RedialCall', 'ReleaseCall', 'RetrieveCall', 'SaveRTCStatsV2', + 'SaveTerminalLog', 'SaveWebRtcInfo', 'SaveWebRTCStats', 'SendDtmfSignaling', 'SignInGroup', 'SignOutGroup', 'StartBack2BackCall', 'StartConference', 'StartPredictiveCall', 'StartPrivacyCall', 'SwitchToConference', 'TakeBreak', 'UnmuteCall', ], + 'type' => 'directory', + 'title' => '话务', + 'id' => 346856, ], [ - 'id' => 168487, - 'title' => '预测式外呼', + 'children' => ['ModifyCampaignNumbers', 'AbortCampaign', 'AddCases', 'AppendCases', 'CreateCampaign', 'GetCampaign', 'GetCaseFileUploadUrl', 'GetHistoricalCampaignReport', 'GetRealtimeCampaignStats', 'ListAttempts', 'ListCampaigns', 'ListCampaignTrendingReport', 'ListCases', 'PauseCampaign', 'ResumeCampaign', 'UpdateCampaign', 'SubmitCampaign'], 'type' => 'directory', - 'children' => [ - 'ModifyCampaignNumbers', - 'AbortCampaign', - 'AddCases', - 'AppendCases', - 'CreateCampaign', - 'GetCampaign', - 'GetCaseFileUploadUrl', - 'GetHistoricalCampaignReport', - 'GetRealtimeCampaignStats', - 'ListAttempts', - 'ListCampaigns', - 'ListCampaignTrendingReport', - 'ListCases', - 'PauseCampaign', - 'ResumeCampaign', - 'UpdateCampaign', - 'SubmitCampaign', - ], + 'title' => '预测式外呼', + 'id' => 346893, ], [ - 'id' => 168500, - 'title' => '报表', - 'type' => 'directory', 'children' => [ - 'GetIvrTrackingSummary', - 'ListIntervalAgentSkillGroupReport', - 'ListHistoricalAgentSkillGroupReport', - 'GetCallDetailRecord', - 'GetConversationDetail', - 'GetConversationDetail', - 'GetHistoricalCallerReport', - 'GetHistoricalInstanceReport', - 'GetInstanceTrendingReport', - 'GetRealtimeInstanceStates', - 'ListAgentStateLogs', - 'ListCallDetailRecords', - 'ListCallDetailRecordsV2', - 'ListHistoricalAgentReport', - 'ListHistoricalSkillGroupReport', - 'ListIntervalAgentReport', - 'ListIntervalInstanceReport', - 'ListIntervalSkillGroupReport', - 'ListIvrTrackingDetails', - 'ListRealtimeAgentStates', - 'ListRealtimeSkillGroupStates', - 'ListRecentCallDetailRecords', - 'ListAgentStates', - 'ListAgentSummaryReportsSinceMidnight', - 'ListLegacyAgentEventLogs', - 'ListLegacyAgentStatusLogs', - 'ListLegacyQueueEventLogs', - 'ListSkillGroupStates', - 'ListSkillGroupSummaryReportsSinceMidnight', - 'ListVoicemails', - 'ListGroupChatMessages', + 'GetIvrTrackingSummary', 'ListIntervalAgentSkillGroupReport', 'ListHistoricalAgentSkillGroupReport', 'GetConversationDetail', 'GetHistoricalCallerReport', 'GetHistoricalInstanceReport', 'GetInstanceTrendingReport', 'GetRealtimeInstanceStates', 'ListAgentStateLogs', 'ListCallDetailRecordsV2', 'ListHistoricalAgentReport', 'ListHistoricalSkillGroupReport', 'ListIntervalAgentReport', 'ListIntervalInstanceReport', 'ListIntervalSkillGroupReport', 'ListIvrTrackingDetails', 'ListRealtimeAgentStates', 'ListRealtimeSkillGroupStates', 'ListRecentCallDetailRecords', 'ListAgentStates', + 'ListAgentSummaryReportsSinceMidnight', 'ListLegacyAgentEventLogs', 'ListLegacyAgentStatusLogs', 'ListLegacyQueueEventLogs', 'ListSkillGroupStates', 'ListSkillGroupSummaryReportsSinceMidnight', 'ListVoicemails', 'ListGroupChatMessages', ], + 'type' => 'directory', + 'title' => '报表', + 'id' => 346911, ], [ - 'id' => 171708, - 'title' => '录音', + 'children' => ['RestoreArchivedRecordings', 'GetMonoRecording', 'GetMultiChannelRecording', 'GetVoicemailRecording', 'GetEarlyMediaRecording', 'ListMultiChannelRecordings', 'ListMonoRecordings'], 'type' => 'directory', - 'children' => [ - 'RestoreArchivedRecordings', - 'GetMonoRecording', - 'GetMultiChannelRecording', - 'GetVoicemailRecording', - 'GetEarlyMediaRecording', - 'ListMultiChannelRecordings', - 'ListMonoRecordings', - ], + 'title' => '录音', + 'id' => 346975, ], [ - 'id' => 168531, - 'title' => '音频', + 'children' => ['CreateAudioFile', 'DeleteAudioFile', 'GetAudioFile', 'GetAudioFileDownloadUrl', 'GetAudioFileUploadParameters', 'ListAudioFiles', 'ModifyAudioFile'], 'type' => 'directory', - 'children' => [ - 'CreateAudioFile', - 'DeleteAudioFile', - 'GetAudioFile', - 'GetAudioFileDownloadUrl', - 'GetAudioFileUploadParameters', - 'ListAudioFiles', - 'ModifyAudioFile', - ], + 'title' => '音频', + 'id' => 346942, ], [ - 'id' => 168539, - 'title' => '配置', + 'children' => ['GetLoginDetails', 'GetTurnCredentials', 'GetTurnServerList', 'ListConfigItems', 'UpdateConfigItems'], 'type' => 'directory', - 'children' => [ - 'GetLoginDetails', - 'GetTurnCredentials', - 'GetTurnServerList', - 'ListConfigItems', - 'UpdateConfigItems', - ], + 'title' => '配置', + 'id' => 346950, ], [ - 'id' => 282482, - 'title' => 'IM', + 'children' => ['ProcessCustomIMCallback', 'CreateChatMediaUrl', 'ListVisitorChatMessages', 'GetChatRoutingProfile', 'UpdateChatRoutingProfile', 'GetChatMediaUrl', 'ListWaitingChats', 'ClaimChat', 'ReleaseChat', 'StartChat', 'RejectChat', 'GetVisitorLoginDetails', 'AcceptChat'], 'type' => 'directory', - 'children' => [ - 'ProcessCustomIMCallback', - 'CreateChatMediaUrl', - 'ListVisitorChatMessages', - 'GetChatRoutingProfile', - 'UpdateChatRoutingProfile', - 'GetChatMediaUrl', - 'ListWaitingChats', - 'ClaimChat', - 'ReleaseChat', - 'StartChat', - 'RejectChat', - 'GetVisitorLoginDetails', - 'AcceptChat', - ], + 'title' => 'IM', + 'id' => 346998, ], [ - 'id' => 282483, - 'title' => '工单', + 'children' => ['FinishTicketTask', 'UpdateTicket', 'GetTicket', 'ListCommonTicketFields', 'TerminateTicket', 'GetTicketSummaryReport', 'ResubmitTicket', 'DeleteTicketTemplate', 'RejectTicket', 'DisableTicketTemplate', 'WithdrawTicket', 'ListTicketTasks', 'ListTickets', 'TransferTicketTask', 'EnableTicketTemplate', 'AddTicketTask', 'ListTicketTemplates', 'ListCategories', 'GetTicketTemplate'], 'type' => 'directory', - 'children' => [ - 'FinishTicketTask', - 'UpdateTicket', - 'GetTicket', - 'ListCommonTicketFields', - 'TerminateTicket', - 'GetTicketSummaryReport', - 'ResubmitTicket', - 'DeleteTicketTemplate', - 'RejectTicket', - 'DisableTicketTemplate', - 'WithdrawTicket', - 'ListTicketTasks', - 'ListTickets', - 'TransferTicketTask', - 'DeleteTicket', - 'EnableTicketTemplate', - 'AddTicketTask', - 'ListTicketTemplates', - 'CreateTicket', - 'ListCategories', - 'GetTicketTemplate', - ], + 'title' => '工单', + 'id' => 347012, ], [ - 'id' => 168545, - 'title' => '呼入控制', + 'children' => ['AddBlacklistCallTagging', 'CreateCallTags', 'CreateCustomCallTagging', 'DeleteCallTag', 'DeleteCustomCallTagging', 'ExportCustomCallTagging', 'ImportCustomCallTagging', 'ListBlacklistCallTaggings', 'ListCallTags', 'ListCustomCallTagging', 'ModifyCustomCallTagging', 'RemoveBlacklistCallTagging'], 'type' => 'directory', - 'children' => [ - 'AddBlacklistCallTagging', - 'CreateCallTags', - 'CreateCustomCallTagging', - 'DeleteCallTag', - 'DeleteCustomCallTagging', - 'ExportCustomCallTagging', - 'ImportCustomCallTagging', - 'ListBlacklistCallTaggings', - 'ListCallTags', - 'ListCustomCallTagging', - 'ModifyCustomCallTagging', - 'RemoveBlacklistCallTagging', - ], + 'title' => '呼入控制', + 'id' => 346956, ], [ - 'id' => 168555, - 'title' => '外呼控制', + 'children' => ['ExportDoNotCallNumbers', 'GetDoNotCallFileUploadParameters', 'ImportDoNotCallNumbers', 'ListDoNotCallNumbers', 'RemoveDoNotCallNumbers'], 'type' => 'directory', - 'children' => [ - 'ExportDoNotCallNumbers', - 'GetDoNotCallFileUploadParameters', - 'ImportDoNotCallNumbers', - 'ListDoNotCallNumbers', - 'RemoveDoNotCallNumbers', - ], + 'title' => '外呼控制', + 'id' => 346969, ], [ - 'id' => 282484, - 'title' => '短信', + 'children' => ['ListFlashSmsSettings', 'ListFlashSmsApplications', 'ListFlashSmsTemplates', 'ListSmsMetadata'], 'type' => 'directory', - 'children' => [ - 'ListFlashSmsSettings', - 'ListFlashSmsApplications', - 'ListFlashSmsTemplates', - 'ListSmsMetadata', - ], + 'title' => '短信', + 'id' => 347034, ], [ - 'id' => 168419, - 'title' => 'IVR', + 'children' => ['ExportContactFlow', 'ImportContactFlow', 'CreateContactFlow', 'ListContactFlows', 'GetContactFlow', 'StartEditContactFlow', 'CommitContactFlow', 'PublishContactFlow', 'DiscardEditingContactFlow', 'DeleteContactFlow'], 'type' => 'directory', - 'children' => [ - 'ExportContactFlow', - 'ImportContactFlow', - 'CreateContactFlow', - 'ListContactFlows', - 'GetContactFlow', - 'StartEditContactFlow', - 'CommitContactFlow', - 'PublishContactFlow', - 'DiscardEditingContactFlow', - 'DeleteContactFlow', - ], + 'title' => 'IVR', + 'id' => 346811, ], [ - 'id' => 192288, - 'title' => '客户', + 'children' => ['DeleteSchemaProperty', 'DisableSchemaProperty', 'EnableSchemaProperty', 'GetDocumentUploadParameters', 'UpdateSchemaProperty', 'SaveDocument', 'DeleteDocuments', 'ImportDocuments', 'AddSchemaProperty'], 'type' => 'directory', - 'children' => [ - 'DeleteSchemaProperty', - 'DisableSchemaProperty', - 'EnableSchemaProperty', - 'GetSchema', - 'DeleteSchema', - 'GetDocumentUploadParameters', - 'UpdateSchemaProperty', - 'SaveDocument', - 'DeleteDocuments', - 'DeleteDocument', - 'ListDocuments', - 'ImportDocuments', - 'CreateSchema', - 'AddSchemaProperty', - ], + 'title' => '客户', + 'id' => 346983, ], [ - 'id' => 282485, - 'title' => '坐席辅助', + 'children' => ['GetSummaryTemplate', 'UpdateCallSummary', 'CreateCallSummary', 'ListCallSummaries', 'AnalyzeConversation', 'AddFeedback'], 'type' => 'directory', - 'children' => [ - 'GetSummaryTemplate', - 'UpdateCallSummary', - 'CreateCallSummary', - 'ListCallSummaries', - 'AnalyzeConversation', - 'AddFeedback', - ], + 'title' => '坐席辅助', + 'id' => 347039, ], [ - 'id' => 282486, - 'title' => '质检', + 'children' => ['GetUploadAudioDataParams'], 'type' => 'directory', - 'children' => [ - 'GetUploadAudioDataParams', - ], + 'title' => '质检', + 'id' => 347046, ], [ - 'id' => 365417, - 'title' => '其他', - 'type' => 'directory', 'children' => [ - 'ListFeedbacks', + 'ListFeedbacks', 'AnswerCall', 'ClaimCall', 'CreateInstance', 'CreateSchema', 'CreateSkillGroup', 'CreateTicket', 'CreateUser', 'DeleteDocument', 'DeleteInstance', 'DeleteSchema', 'DeleteSkillGroup', 'DeleteTicket', 'GetCallDetailRecord', 'GetInstance', 'GetSchema', 'GetUser', 'HoldCall', 'ListCallDetailRecords', 'ListDocuments', + 'ListInstances', 'ListNotificationRecords', 'ListRoles', 'ListUsers', 'MakeCall', 'ModifyUser', 'RemoveUsers', 'ResetUserPassword', 'UpdateSubscription', ], + 'type' => 'directory', + 'title' => '其他', + 'id' => 347048, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'ListPrivilegesOfUser' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AbortCampaign' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -419,9 +153,14 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], + ], 'parameters' => [ [ 'name' => 'InstanceId', @@ -430,94 +169,46 @@ 'description' => '实例ID。', 'type' => 'string', 'required' => true, - 'docRequired' => true, + 'enumValueTitles' => [], 'example' => 'ccc-test', ], ], + [ + 'name' => 'CampaignId', + 'in' => 'query', + 'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应参数。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Scope' => [ - 'description' => '权限范围。', - 'type' => 'string', - 'enumValueTitles' => [ - 'SELF_ONLY' => '仅可访问自己的所有数据', - 'INSTANCE' => '整个实例下的数据皆可访问', - 'SKILL_GROUP' => '可以访问自己所在技能组的所有数据', - ], - 'example' => 'SELF_ONLY', - ], - 'Name' => [ - 'description' => '权限名称，普通客户无需了解具体的权限名称，该接口主要由坐席工作台调用。', - 'type' => 'string', - 'example' => 'Workbench:Call', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315'], + 'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 'title' => '终止预测式外呼活动', + 'summary' => '调用AbortCampaign终止指定实例下指定活动ID对应的预测式外呼活动。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbortCampaign'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Scope\\": \\"SELF_ONLY\\",\\n \\"Name\\": \\"Workbench:Call\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n200\\n\\n SELF_ONLY\\n ccc-test\\n Workbench:Call\\n\\nOK","errorExample":""}]', - 'title' => '获取坐席的权限列表', - 'summary' => '调用ListPrivilegesOfUser获取当前用户拥有的权限。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\n OK\\n 无\\n 200\\n","errorExample":""}]', ], - 'ListRoles' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AcceptChat' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -526,20 +217,19 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => '话务ID。', 'type' => 'string', 'required' => true, 'example' => 'chat-65382141036853491'], ], ], 'responses' => [ @@ -547,76 +237,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '711D948F-C616-4E23-8573-0F260513CE09', - ], - 'Data' => [ - 'description' => '角色列表。'."\n" - ."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '角色名称。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Agent' => '坐席', - 'Admin' => '管理员', - 'Manager' => '技能组组长', - ], - 'example' => 'Admin', - ], - 'RoleId' => [ - 'description' => '角色ID，格式为：角色@实例ID。', - 'type' => 'string', - 'example' => 'Admin@ccc-test', - ], - ], - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Invalid', - 'errorMessage' => 'The parameter %s is invalid. %s.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid.', 'description' => ''], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + 409 => [ + ['errorCode' => 'AlreadyExists.SkillGroup', 'errorMessage' => 'The skill group %s already exists in instance %s.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"711D948F-C616-4E23-8573-0F260513CE09\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"Admin\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取角色列表', - 'summary' => '调用ListRoles获取指定实例下的所有角色。', - ], - 'DeleteInstance' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\"\\n}","type":"json"}]', + 'title' => '接受聊天', + 'summary' => '调用AcceptChat接受指定实例下指定话务ID对应的聊天。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'AddBlacklistCallTagging' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -628,90 +284,70 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '251524', - 'abilityTreeNodes' => [ - 'FEATUREccc8HB4RI', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'Number', + 'in' => 'query', + 'schema' => ['description' => '电话号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1764590****'], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => '通话ID。号码为加密号码（带有*），需要填写JobId，非加密号码，不需要填写该字段。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6582589278232****'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '返回结果，删除任务ID。', - 'type' => 'string', - 'example' => 'b7feb007-994a-497f-8934-2f0c6f89867c', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], ], ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'LimitExceed.CallTagsPerNumber', 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', 'description' => '号码标签数量超出单个呼入号码标记的上线阈值。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.CustomCallTagging', 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', 'description' => '呼入号码标记不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"b7feb007-994a-497f-8934-2f0c6f89867c\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '删除实例', - ], - 'CreateInstance' => [ - 'summary' => '调用CreateInstance创建一个云联络中心实例。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '添加号码黑名标签', + 'summary' => '对指定号码添加黑名单标签，可结合IVR设置，防止其频繁呼入骚扰。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', + ], + 'AddCases' => [ + 'summary' => '调用AddCases添加外呼名单到指定实例下指定ID对应的预测式外呼活动。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -723,132 +359,75 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREcccTMAX45', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例名称，长度4-32个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '测试实例', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '实例的描述，长度不超过256个字符。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '云联络中心的测试实例。', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'DomainName', + 'name' => 'CampaignId', 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例的二级域名，即实例ID，全局唯一。长度为4-48个字符，仅可包含大小写英文字母、数字、下划线（_）和短横线（-）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => 'c58b9719-3bc3-441d-a4d3-fc0309ef7066'."\n"], ], [ - 'name' => 'NumberList', + 'name' => 'CaseList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '待创建的云联络中心实例的号码列表，要求当前账户拥有号码使用权且号码未被其他实例使用。', - 'type' => 'string', + 'description' => '外呼名单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '外呼名单。', + 'type' => 'object', + 'properties' => [ + 'ReferenceId' => ['description' => '业务ID，客户业务系统标识，用于集成场景。'."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => '01'], + 'PhoneNumber' => ['description' => '联系人电话号码。', 'type' => 'string', 'required' => false, 'example' => '188888****'], + 'CustomVariables' => ['description' => '客户自定义变量，格式为JSON对象，对象最多包含10个属性，每个属性的名称和值均由客户自定义。', 'type' => 'string', 'required' => false, 'example' => '{"name":"customer","客户标签":"tag"}'."\n"], + 'MaskedCallee' => ['description' => '脱敏后的被叫号码，如果该字段不为空，表示需要对被叫号码脱敏，脱敏规则由客户自行定义，只需将脱敏后的被叫号码填入即可，使用脱敏被叫会导致某些场景下看到的是脱敏后的被叫号码，无法查看真实被叫号码。', 'type' => 'string', 'required' => false, 'example' => '166******66'], + 'Caller' => ['description' => '主叫号码，该字段指定号码后，对应联系人将会使用对应的号码进行外呼，不再随机选择号码。', 'type' => 'string', 'required' => false, 'example' => '185022xxxx'], + ], + 'required' => false, + ], 'required' => false, - 'docRequired' => false, - 'example' => '["0830011xxxx", "0830312xxxx"]', - ], - ], - [ - 'name' => 'AdminRamIdList', - 'in' => 'query', - 'schema' => [ - 'description' => '作为该云联络中心实例管理员的RAM ID列表，成功创建后，该列表下的RAM ID将自动以管理员的身份导入到新创建的实例中。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["24861380681070****","105980354482****"]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据，返回的是后台创建实例的工作流的ID。', - 'type' => 'string', - 'example' => '75c1346c-1dc2-4ed8-973f-edf8b1e5fe77', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '41298961-CAD7-5270-9378-FFD69F153144'], + 'Code' => ['title' => 'code', 'description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.Number', - 'errorMessage' => 'The specified number %s does not exist in instance %s.', - ], - ], - 409 => [ - [ - 'errorCode' => 'AlreadyExists.InstanceId', - 'errorMessage' => 'The instance %s already exists.', - ], + 'title' => '添加预测式外呼名单', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddCases'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"75c1346c-1dc2-4ed8-973f-edf8b1e5fe77\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\"\\n}","type":"json"}]', - 'title' => '创建实例', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"41298961-CAD7-5270-9378-FFD69F153144\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], - 'GetInstance' => [ - 'summary' => '调用GetInstance获取指定实例ID所对应的云联络中心实例的详细信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddFeedback' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -857,27 +436,39 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccTMAX45', - ], - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'AI任务ID。', 'type' => 'string', 'required' => false, 'example' => 'f780ade8-****-458b-b067-63077946a570'], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => '任务类型。'."\n" + .'- Abstract:fields（字段抽取）'."\n" + .'- Abstract:keywords（热词）'."\n" + .'- Abstract:title_summary（小结）', 'type' => 'string', 'required' => false, 'example' => 'Abstract:fields'."\n"], + ], + [ + 'name' => 'Feedback', + 'in' => 'query', + 'schema' => ['description' => '用户回流的数据。', 'type' => 'string', 'required' => false, 'example' => '{"问题描述":"客户询问沙发生产周期并尝试加快", "客服方案":"订单确认，建议联系在线客服", "完成度判断":"否"}'."\n"], + ], + [ + 'name' => 'Rating', + 'in' => 'query', + 'schema' => ['description' => '评价：'."\n" + .'- thumbsDown：点踩。 '."\n" + .'- thumbsUp：点赞。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'thumbsUp'], ], ], 'responses' => [ @@ -885,282 +476,39 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '实例状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RELEASED' => '已释放', - 'RUNNING' => '正常运行中', - 'STOPPED' => '已停服', - 'CREATING' => '创建中', - ], - 'example' => 'RUNNING', - ], - 'ConsoleUrl' => [ - 'description' => '云联络中心实例的网址，用于访问云联络中心实例的主页面，由云联络中心的特定网址加上实例ID组成。', - 'type' => 'string', - 'example' => 'https://ccc-v2.aliyun.com/#/workbench/ccc-test', - ], - 'Description' => [ - 'description' => '实例的描述。', - 'type' => 'string', - 'example' => '云联络中心的测试实例。', - ], - 'AliyunUid' => [ - 'description' => '实例所属的阿里云账户ID。', - 'type' => 'string', - 'example' => '157123456789****', - ], - 'Name' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'example' => '测试实例', - ], - 'DomainName' => [ - 'description' => '实例的域名，全局唯一。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Id' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test'."\n", - ], - 'AdminList' => [ - 'description' => '管理员列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '管理员的名称。', - 'type' => 'string', - 'example' => '管理员', - ], - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'LoginName' => [ - 'description' => '坐席登录名。', - 'type' => 'string', - 'example' => 'agent', - ], - 'Email' => [ - 'description' => '邮箱。', - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'WorkMode' => [ - 'description' => '工作模式。'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1382114****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'RoleName' => [ - 'description' => '角色名称。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Agent' => '坐席', - 'Manager' => '技能组组长', - 'Admin' => '管理员', - ], - 'example' => 'Admin', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'RoleId' => [ - 'description' => '角色ID，格式为：角色@实例ID。', - 'type' => 'string', - 'example' => 'Admin@ccc-test', - ], - ], - ], - ], - 'NumberList' => [ - 'description' => '号码列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Active' => [ - 'description' => '是否可用。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'UserId' => [ - 'description' => '坐席ID。如果此参数不为空，说明该号码是座席个人外呼号码。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Number' => [ - 'description' => '号码。', - 'type' => 'string', - 'example' => '0830011****', - ], - 'City' => [ - 'description' => '号码归属地市。', - 'type' => 'string', - 'example' => '乐山', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Usage' => [ - 'description' => '号码用途。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Outbound' => '呼出', - 'Inbound' => '呼入', - 'Bidirection' => '呼入及呼出', - ], - 'example' => 'Bidirection', - ], - 'ContactFlowId' => [ - 'description' => '该电话号码所关联的联系流ID（IVR）。', - 'type' => 'string', - 'example' => '2ec7a58f-3243-4815-bb21-97b480b95f5e', - ], - 'Province' => [ - 'description' => '号码归属地省。', - 'type' => 'string', - 'example' => '四川', - ], - 'SkillGroups' => [ - 'description' => '号码所关联的技能组列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '技能组展示名。', - 'type' => 'string', - 'example' => '测试技能组', - ], - 'Description' => [ - 'description' => '技能组描述。', - 'type' => 'string', - 'example' => '云联络中心的测试技能组。', - ], - 'PhoneNumberCount' => [ - 'description' => '技能组关联的号码数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'UserCount' => [ - 'description' => '技能组关联的坐席数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Name' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => 'skillgroup', - ], - ], - ], - ], - ], - ], - ], - 'ChatbotBusinessUnit' => [ - 'type' => 'object', - 'properties' => [ - 'UnitId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'UnitKey' => [ - 'type' => 'string', - ], - ], - ], - 'AgentType' => [ - 'type' => 'string', - ], - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C81FD1A5-4B99-470A-A527-D80150228784'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 400 => [ + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"Data\\": {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ConsoleUrl\\": \\"https://ccc-v2.aliyun.com/#/workbench/ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试实例。\\",\\n \\"AliyunUid\\": \\"157123456789****\\",\\n \\"Name\\": \\"测试实例\\",\\n \\"DomainName\\": \\"ccc-test\\",\\n \\"Id\\": \\"ccc-test\\\\n\\",\\n \\"AdminList\\": [\\n {\\n \\"DisplayName\\": \\"管理员\\",\\n \\"Extension\\": \\"8032****\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ],\\n \\"NumberList\\": [\\n {\\n \\"Active\\": true,\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Number\\": \\"0830011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowId\\": \\"2ec7a58f-3243-4815-bb21-97b480b95f5e\\",\\n \\"Province\\": \\"四川\\",\\n \\"SkillGroups\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"UserCount\\": 3,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\"\\n }\\n ]\\n }\\n ],\\n \\"ChatbotBusinessUnit\\": {\\n \\"UnitId\\": 0,\\n \\"UnitKey\\": \\"\\"\\n },\\n \\"AgentType\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => '获取实例', - ], - 'ListInstances' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C81FD1A5-4B99-470A-A527-D80150228784\\"\\n}","type":"json"}]', + 'title' => 'AI总结打分', + 'summary' => '使用AddFeedback接口对AI功能进行评价打分。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'AddNumbersToSkillGroup' => [ + 'summary' => '调用AddNumbersToSkillGroup添加一个或多个号码到同一个技能组下。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1169,253 +517,163 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PageSize', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', + 'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'], + ], + [ + 'name' => 'NumberList', + 'in' => 'query', + 'schema' => ['description' => '号码列表，请确保号码已在当前实例下。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["0103182****","0102387****"]'], + ], + [ + 'name' => 'InstNumberGroupIdList', + 'in' => 'query', + 'schema' => ['description' => '号码集合列表', 'type' => 'string', 'required' => false, 'example' => '["38f5b191-b764-45b8-bd93-4b65f839e13a"]'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + ], + 'description' => '', ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'], + ], + ], + 'title' => '添加多个号码到技能组', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-07T07:21:05.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddNumbersToSkillGroup'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', + ], + 'AddPersonalNumbersToUser' => [ + 'summary' => '调用AddPersonalNumbersToUser添加一个或多个个人外呼号码到指定实例下的指定坐席。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'], + ], + [ + 'name' => 'NumberList', + 'in' => 'query', + 'schema' => ['description' => '待添加的号码列表，要求号码可被UserId对应的坐席绑定，如果不清楚坐席可绑定哪些号码，请参考ListPersonalNumbersOfUser接口。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["0101234****","0105678****"]'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'List' => [ - 'description' => '列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '实例状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RELEASED' => '已释放', - 'RUNNING' => '正常运行中', - 'STOPPED' => '已停服', - 'CREATING' => '创建中', - ], - 'example' => 'RUNNING', - ], - 'ConsoleUrl' => [ - 'description' => '云联络中心实例的网址，用于访问云呼叫中心实例的主页面，由云呼叫中心的特定网址加上实例ID组成。', - 'type' => 'string', - 'example' => 'https://ccc-v2.aliyun.com/#/workbench/ccc-test', - ], - 'Description' => [ - 'description' => '实例的描述。', - 'type' => 'string', - 'example' => '云联络中心的测试实例。', - ], - 'CreateTime' => [ - 'description' => '实例的创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1624679747000', - ], - 'AliyunUid' => [ - 'description' => '实例所属的阿里云账户ID。', - 'type' => 'string', - 'example' => '157123456789****', - ], - 'Name' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'example' => '测试实例', - ], - 'DomainName' => [ - 'description' => '实例的域名，全局唯一。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Id' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'AdminList' => [ - 'description' => '管理员列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '管理员的姓名。', - 'type' => 'string', - 'example' => '测试坐席', - ], - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****'."\n", - ], - 'LoginName' => [ - 'description' => '坐席登录名。', - 'type' => 'string', - 'example' => 'agent', - ], - 'Email' => [ - 'description' => '邮箱。', - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1382114****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'RoleName' => [ - 'description' => '角色名称。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Mannager' => '技能组组长', - 'Agent' => '坐席', - 'Admin' => '管理员', - ], - 'example' => 'Admin', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'RoleId' => [ - 'description' => '角色ID，格式为：角色@实例ID。', - 'type' => 'string', - 'example' => 'Admin@ccc-test', - ], - ], - ], - ], - 'NumberList' => [ - 'description' => '号码列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Number' => [ - 'description' => '号码。', - 'type' => 'string', - 'example' => '0830011****', - ], - ], - ], - ], - ], - ], - ], - ], + 'description' => '添加失败的号码列表。', + 'type' => 'array', + 'items' => ['description' => '号码', 'type' => 'string', 'example' => '0101234****'], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ConsoleUrl\\": \\"https://ccc-v2.aliyun.com/#/workbench/ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试实例。\\",\\n \\"CreateTime\\": 1624679747000,\\n \\"AliyunUid\\": \\"157123456789****\\",\\n \\"Name\\": \\"测试实例\\",\\n \\"DomainName\\": \\"ccc-test\\",\\n \\"Id\\": \\"ccc-test\\",\\n \\"AdminList\\": [\\n {\\n \\"DisplayName\\": \\"测试坐席\\",\\n \\"Extension\\": \\"8032****\\\\n\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ],\\n \\"NumberList\\": [\\n {\\n \\"Number\\": \\"0830011****\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '获取实例列表', - 'summary' => '调用ListInstances获取当前阿里云账号下的云联络中心实例列表。', - 'description' => '若RAM子账号需要调用该接口，则需具有“管理云呼叫中心(CCC)的权限”（AliyunCCCFullAccess）。', + 'title' => '添加多个号码到坐席', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListInstancesOfUser' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPersonalNumbersToUser'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": [\\n \\"0101234****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n[\\"0100xxxx009\\"]\\nOK","errorExample":""}]', + ], + 'AddPhoneNumberToSkillGroups' => [ + 'summary' => '调用AddPhoneNumberToSkillGroups将号码关联到指定实例下的一个或多个技能组。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1424,401 +682,236 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'Number', + 'in' => 'query', + 'schema' => ['description' => '号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0101234****'], + ], + [ + 'name' => 'SkillGroupIdList', 'in' => 'query', + 'schema' => ['description' => '技能组ID列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '添加号码到多个技能组', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPhoneNumberToSkillGroups'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', + ], + 'AddPhoneNumbers' => [ + 'summary' => '调用AddPhoneNumbers添加一个或多个号码到指定实例下。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], [ - 'name' => 'PageSize', + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'ContactFlowId', + 'in' => 'query', + 'schema' => ['description' => '绑定的IVR联系流ID，仅当号码用途包含呼入时，该参数才有效，非必填，默认为空。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dDMD_0mif4hv'], + ], + [ + 'name' => 'Usage', 'in' => 'query', 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '号码的用途，注意，如果传入的号码为400号码，则用途只能填Inbound。', + 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => '10', + 'enumValueTitles' => ['Outbound' => '呼出', 'Inbound' => '呼入', 'Bidirection' => '呼入和呼出'], + 'example' => 'Bidirection', ], ], + [ + 'name' => 'NumberList', + 'in' => 'query', + 'schema' => ['description' => '待添加的号码列表。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["0101234****", "0105678****"]'], + ], + [ + 'name' => 'NumberGroupId', + 'in' => 'query', + 'schema' => ['description' => '号码组ID，在云联络中心控制台可以看到号码分组信息，非必填，默认为空。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2cb77c29-5f60-4b90-b21e-9d2ba9833f14'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '3969FC68-CEC2-4398-B76A-60D2F7EDEBAF', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'List' => [ - 'description' => '列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '实例状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RELEASED（已注销）' => 'RELEASED（已注销）', - 'CREATING（创建中）' => 'CREATING（创建中）', - 'RUNNING（正常运行中）' => 'RUNNING（正常运行中）', - 'STOPPED（已停服）' => 'STOPPED（已停服）', - ], - 'example' => 'RUNNING', - ], - 'ConsoleUrl' => [ - 'description' => '云联络中心实例的网址，用于访问云联络中心实例的主页面，由云联络中心的特定网址加上实例ID组成。', - 'type' => 'string', - 'example' => 'https://ccc-v2.aliyun.com/#/workbench/ccc-test', - ], - 'Description' => [ - 'description' => '实例的描述。', - 'type' => 'string', - 'example' => '云联络中心的测试实例。', - ], - 'AliyunUid' => [ - 'description' => '实例所属的阿里云账户ID。', - 'type' => 'string', - 'example' => '157123456789****', - ], - 'Name' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'example' => '测试实例', - ], - 'DomainName' => [ - 'description' => '实例的域名，全局唯一。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Id' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'AdminList' => [ - 'description' => '管理员列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '管理员的姓名。', - 'type' => 'string', - 'example' => '测试坐席', - ], - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'LoginName' => [ - 'description' => '坐席登录名。', - 'type' => 'string', - 'example' => 'agent', - ], - 'Email' => [ - 'description' => '邮箱。', - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'OFF_SITE（场外模式）' => 'OFF_SITE（场外模式）', - 'ON_SITE（场内模式）' => 'ON_SITE（场内模式）', - 'OFFICE_PHONE（办公电话模式）' => 'OFFICE_PHONE（办公电话模式）', - ], - 'example' => 'ON_SITE', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1382114****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'RoleName' => [ - 'description' => '角色名称。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Agent' => '坐席', - 'Manager（技能组组长）' => 'Manager（技能组组长）', - 'Admin（管理员）' => 'Admin（管理员）', - ], - 'example' => 'Admin', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'RoleId' => [ - 'description' => '角色ID，格式为：角色@实例ID。', - 'type' => 'string', - 'example' => 'Admin@ccc-test', - ], - ], - ], - ], - 'NumberList' => [ - 'description' => '号码列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Active' => [ - 'description' => '是否可用。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'UserId' => [ - 'description' => '坐席ID，如果此参数不为空，说明该号码是座席个人外呼号码。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Number' => [ - 'description' => '号码。', - 'type' => 'string', - 'example' => '0830011****', - ], - 'City' => [ - 'description' => '号码归属地市。', - 'type' => 'string', - 'example' => '乐山', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Usage' => [ - 'description' => '号码用途。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Bidirection（呼入及呼出）' => 'Bidirection（呼入及呼出）', - 'Inbound（呼入）' => 'Inbound（呼入）', - 'Outbound（呼出）' => 'Outbound（呼出）', - ], - 'example' => 'Bidirection', - ], - 'ContactFlowId' => [ - 'description' => '该电话号码所关联的联系流ID（IVR）。', - 'type' => 'string', - 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek', - ], - 'Province' => [ - 'description' => '号码归属地省。', - 'type' => 'string', - 'example' => '四川', - ], - 'SkillGroups' => [ - 'description' => '号码所关联的技能组列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '技能组展示名。', - 'type' => 'string', - 'example' => '测试技能组', - ], - 'Description' => [ - 'description' => '技能组描述。', - 'type' => 'string', - 'example' => '云联络中心的测试技能组。', - ], - 'PhoneNumberCount' => [ - 'description' => '技能组关联的号码数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'UserCount' => [ - 'description' => '技能组关联的坐席数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Name' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => 'skillgroup', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'description' => '添加失败的号码列表。', + 'type' => 'array', + 'items' => ['description' => '号码。', 'type' => 'string', 'example' => '0101234****'], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"3969FC68-CEC2-4398-B76A-60D2F7EDEBAF\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ConsoleUrl\\": \\"https://ccc-v2.aliyun.com/#/workbench/ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试实例。\\",\\n \\"AliyunUid\\": \\"157123456789****\\",\\n \\"Name\\": \\"测试实例\\",\\n \\"DomainName\\": \\"ccc-test\\",\\n \\"Id\\": \\"ccc-test\\",\\n \\"AdminList\\": [\\n {\\n \\"DisplayName\\": \\"测试坐席\\",\\n \\"Extension\\": \\"8032****\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ],\\n \\"NumberList\\": [\\n {\\n \\"Active\\": true,\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Number\\": \\"0830011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\",\\n \\"SkillGroups\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"UserCount\\": 2,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"3969FC68-CEC2-4398-B76A-60D2F7EDEBAF\\n无\\n200\\n无\\n\\n 1\\n 10\\n 1\\n \\n RUNNING\\n 测试实例\\n ccc-test\\n https://ccc-v2.aliyun.com/#/workbench/ccc-test\\n 157123456789****\\n ccc-test\\n 云呼测试实例\\n \\n 8032****\\n user-test\\n Admin\\n 1886666****@163.com\\n ccc-test\\n user-test@ccc-test\\n 云呼测试1\\n Admin@ccc-test\\n 1382114****\\n ON_SITE\\n \\n \\n Bidirection\\n true\\n 0830011****\\n ccc-test\\n a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\n user-test@ccc-test\\n 乐山\\n 四川\\n \\n 测试\\n 1\\n ccc-test\\n 2\\n 测试技能组\\n test@ccc-test\\n test\\n \\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '获取用户所属的实例列表', - 'summary' => '调用ListInstancesOfUser获取用户所属的云联络中心实例列表。', + 'title' => '添加号码', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyInstance' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPhoneNumbers'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n \\"0101234****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\nOK","errorExample":""}]', + ], + 'AddSchemaProperty' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'name' => 'SchemaId', + 'in' => 'formData', + 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'], ], [ - 'name' => 'Description', - 'in' => 'query', + 'name' => 'Property', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '实例的描述，长度不超过256个字符。', - 'type' => 'string', + 'description' => '字段', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'name'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => '-'], + 'Name' => ['description' => '名称', 'type' => 'string', 'required' => true, 'example' => 'name'], + 'DataType' => ['description' => '数据类型', 'type' => 'string', 'required' => true, 'example' => 'string'], + 'Pattern' => ['description' => '正则表达式校验规则', 'type' => 'string', 'required' => false, 'example' => '*'], + 'PatternErrorMessage' => ['description' => '正则表达式校验错误提示信息', 'type' => 'string', 'required' => false, 'example' => '格式错误'], + 'MinLength' => ['description' => '最小长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'MaxLength' => ['description' => '最大长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + 'Minimum' => ['description' => '数字最小值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1'], + 'Maximum' => ['description' => '数字最大值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1'], + 'Required' => ['description' => '是否必填', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'Disabled' => ['description' => '是否被禁用', 'type' => 'boolean', 'required' => false, 'example' => 'False'], + 'Array' => ['description' => '是否是数组', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'ReadOnly' => ['description' => '是否只读', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'EditorType' => ['description' => '编辑器类型', 'type' => 'string', 'required' => false, 'example' => 'textbox'], + 'Attributes' => ['description' => '扩展属性', 'type' => 'string', 'required' => false, 'example' => '{\\"newName\\":\\"小桔充电-demo\\",\\"appId\\":\\"69FRKB4193W8BYP0\\"}'], + 'DisplayOrder' => ['description' => '列表展示顺序', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], 'required' => false, - 'docRequired' => true, - 'example' => '新的实例描述。', ], ], + [ + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'AddSchemaPropertyResponse', + 'description' => 'AddSchemaPropertyResponse', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '83TKE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'string', - 'example' => '无', + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111'], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -1826,28 +919,21 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"83TKE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"83TKE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n无\\nOK","errorExample":""}]', - 'title' => '修改实例', - 'summary' => '调用ModifyInstance修改云联络中心实例。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'AddPersonalNumbersToUser' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA633111\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '添加Schema字段', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'AddSkillGroupsToUser' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1856,42 +942,29 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'NumberList', + 'name' => 'SkillLevelList', 'in' => 'query', - 'schema' => [ - 'description' => '待添加的号码列表，要求号码可被UserId对应的坐席绑定，如果不清楚坐席可绑定哪些号码，请参考ListPersonalNumbersOfUser接口。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["0101234****","0105678****"]', - ], + 'schema' => ['description' => '技能组的技能等级列表，格式为JSON数组的字符串，数组元素是一个对象，包含两个字段：skillGroupId和skillLevel，skillGroupId填写要添加的技能组ID，skillLevel填写要添加的技能等级，取值范围1-10，值越小，业务能力越强，单位时间内能处理更多的通话。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"skillGroupId":"test1@ccc-test","skillLevel":5},{"skillGroupId":"test2@ccc-test","skillLevel":5}]'], ], ], 'responses' => [ @@ -1899,236 +972,128 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'Data' => [ - 'description' => '添加失败的号码列表。', - 'type' => 'array', - 'items' => [ - 'description' => '号码', - 'type' => 'string', - 'example' => '0101234****', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA7F9545-8312-4190-9BD0-63144B3F1ACC'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 403 => [ + ['errorCode' => 'Permission.SkillGroup', 'errorMessage' => 'You have no permission to access skill group(s) %s.', 'description' => '您无权访问这些技能组。'], + ], + [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": [\\n \\"0101234****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n[\\"0100xxxx009\\"]\\nOK","errorExample":""}]', - 'title' => '添加多个号码到坐席', - 'summary' => '调用AddPersonalNumbersToUser添加一个或多个个人外呼号码到指定实例下的指定坐席。', + 'title' => '添加多个技能组到坐席', + 'summary' => '调用AddSkillGroupsToUser添加一个或多个技能组到指定实例下的指定坐席。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AddPhoneNumbers' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSkillGroupsToUser'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA7F9545-8312-4190-9BD0-63144B3F1ACC\\"\\n}","errorExample":""},{"type":"xml","example":"BA7F9545-8312-4190-9BD0-63144B3F1ACC\\n无\\n200\\n无\\nOK","errorExample":""}]', + ], + 'AddTicketTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'TicketId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => true, 'example' => '3d26b90a-c5d2-4b09-8219-********'], ], [ - 'name' => 'ContactFlowId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '绑定的IVR联系流ID，仅当号码用途包含呼入时，该参数才有效，非必填，默认为空。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'dDMD_0mif4hv', - ], + 'schema' => ['description' => '工单流程节点ID。', 'type' => 'string', 'required' => true, 'example' => '3b8c672f-48f6-45f5-bf41-9d4cb2b4a716'], ], [ - 'name' => 'Usage', + 'name' => 'Assignee', 'in' => 'query', - 'schema' => [ - 'description' => '号码的用途，注意，如果传入的号码为400号码，则用途只能填Inbound。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'Outbound' => '呼出', - 'Inbound' => '呼入', - 'Bidirection' => '呼入和呼出', - ], - 'example' => 'Bidirection', - ], + 'schema' => ['description' => '加签指派的处理人。', 'type' => 'string', 'required' => true, 'example' => 'assignee@ccc-test'], ], [ - 'name' => 'NumberList', + 'name' => 'Comment', 'in' => 'query', - 'schema' => [ - 'description' => '待添加的号码列表。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '["0101234****", "0105678****"]', - ], + 'schema' => ['description' => '处理意见。', 'type' => 'string', 'required' => true, 'example' => '请assignee处理。'], ], [ - 'name' => 'NumberGroupId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '号码组ID，在云联络中心控制台可以看到号码分组信息，非必填，默认为空。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2cb77c29-5f60-4b90-b21e-9d2ba9833f14', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'Position', + 'in' => 'query', + 'schema' => ['description' => '加签位置。'."\n" + .'- Before： 在我之前'."\n" + .'- After: 在我之后', 'type' => 'string', 'required' => false, 'example' => 'After'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'AddAssigneeToTicketTaskResponse', + 'description' => 'AddAssigneeToTicketTaskResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '添加失败的号码列表。', + 'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B06B3244-1B44-481B-90C4-F2F92E59D6B5'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '号码。', - 'type' => 'string', - 'example' => '0101234****', - ], + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n \\"0101234****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\nOK","errorExample":""}]', - 'title' => '添加号码', - 'summary' => '调用AddPhoneNumbers添加一个或多个号码到指定实例下。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'AddPhoneNumberToSkillGroups' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"B06B3244-1B44-481B-90C4-F2F92E59D6B5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '工单加签', + 'summary' => '使用AddTicketTask进行加签操作，添加处理人。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'AddUsersToSkillGroup' => [ + 'summary' => '调用AddUsersToSkillGroup添加一个或多个坐席到同一个技能组。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2139,40 +1104,27 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Number', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0101234****', - ], + 'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test1@ccc-test'], ], [ - 'name' => 'SkillGroupIdList', + 'name' => 'UserSkillLevelList', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]', - ], + 'schema' => ['description' => '坐席技能组等级列表，格式为JSON数组的字符串，数组元素是一个对象，包含两个字段，userId和skillLevel，userId为待添加的坐席ID，skillLevel为该坐席加入技能组后的技能等级，技能等级为1-10，值越小，服务能力越强，单位时间内能处理更多的通话。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"userId":"agent1@ccc-test","skillLevel":10},{"userId":"agent2@ccc-test","skillLevel":10}]'], ], ], 'responses' => [ @@ -2180,66 +1132,43 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', - 'title' => '添加号码到多个技能组', - 'summary' => '调用AddPhoneNumberToSkillGroups将号码关联到指定实例下的一个或多个技能组。', + 'title' => '添加多个坐席到技能组', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListOutboundNumbersOfUser' => [ - 'summary' => '调用ListOutboundNumbersOfUser获取指定实例下指定坐席的可外呼号码。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUsersToSkillGroup'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', + ], + 'AnalyzeConversation' => [ + 'summary' => '分析指定的文字通话内容，提取摘要类相关信息，比如标题，关键词、小结以及其他指定的信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2251,69 +1180,48 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccBCFPY3', - ], + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '云联络中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ - 'name' => 'PageNumber', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => false, 'example' => 'job-10963442671187****'], ], [ - 'name' => 'PageSize', + 'name' => 'TaskListJson', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '分析的任务类型列表。其内容可以是：'."\n" + .'- title：标题'."\n" + .'- summary：小结'."\n" + .'- keywords：关键词'."\n" + .'- fields：字段'."\n" + ."\n" + .'目前仅summary和title可同时传递，其他的参数只能单独传递。', 'type' => 'string', 'required' => false, 'example' => '["keywords"]'], ], [ - 'name' => 'SkillGroupIdList', + 'name' => 'FieldListJson', 'in' => 'query', - 'schema' => [ - 'description' => '签入技能组ID列表，非必填，默认为空，表示查询UserId归属的所有技能组的外呼号码，如果有值，则查询该值指定的技能组下的外呼号码。注意，此处传入的技能组ID必须是UserId所在的技能组的ID。', - 'type' => 'string', - 'required' => false, - 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]', - ], + 'schema' => ['description' => '当TaskListJson参数为fields, 此参数指定要提取的字段内容。', 'type' => 'string', 'required' => false, 'example' => '['."\n" + .' {'."\n" + .' "code": "OrderNo",'."\n" + .' "name": "订单号",'."\n" + .' "description": "订单号"'."\n" + .' },'."\n" + .' {'."\n" + .' "code": "ProductName",'."\n" + .' "name": "商品名称",'."\n" + .' "description": "商品名称"'."\n" + .' }'."\n" + .']'], ], ], 'responses' => [ @@ -2321,142 +1229,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'List' => [ - 'description' => '号码列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Number' => [ - 'description' => '号码。', - 'type' => 'string', - 'example' => '0830019****', - ], - 'City' => [ - 'description' => '号码归属地市。', - 'type' => 'string', - 'example' => '乐山', - ], - 'Province' => [ - 'description' => '号码归属地省。'."\n" - ."\n", - 'type' => 'string', - 'example' => '四川', - ], - 'Provider' => [ - 'type' => 'string', - ], - 'ProviderCode' => [ - 'type' => 'string', - 'deprecated' => true, - ], - 'ProviderDisplayName' => [ - 'type' => 'string', - 'deprecated' => true, - ], - 'ProviderShortName' => [ - 'type' => 'string', - ], - 'ProviderType' => [ - 'type' => 'string', - 'enum' => [ - 'THIRD_PARTY', - 'SELF_HOSTED', - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID,可用于接口的日志查询', 'type' => 'string', 'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522'], + 'Data' => ['description' => '返回结果。根据分析任务的不同，返回的内容也不相同。', 'type' => 'string', 'example' => '{'."\n" + .' "订单号": "1234",'."\n" + .' "商品名称": "笔记本"'."\n" + .'}'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"0830019****\\",\\n \\"City\\": \\"乐山\\",\\n \\"Province\\": \\"四川\\",\\n \\"Provider\\": \\"\\",\\n \\"ProviderCode\\": \\"\\",\\n \\"ProviderDisplayName\\": \\"\\",\\n \\"ProviderShortName\\": \\"\\",\\n \\"ProviderType\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"1\\nEEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n10\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n 乐山\\n 083xxxx0019\\n 四川\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取坐席的外呼号码列表', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListPersonalNumbersOfUser' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '分析对话内容', + 'description' => '此接口可用于在线会话以及语音会话。当用于语音会话时，需要实现开启语音实时转写的功能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"9F766284-F103-4298-8EC5-19F9F9BE5522\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"订单号\\\\\\": \\\\\\"1234\\\\\\",\\\\n \\\\\\"商品名称\\\\\\": \\\\\\"笔记本\\\\\\"\\\\n}\\"\\n}","type":"json"}]', + ], + 'AnswerCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2465,215 +1273,185 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'user-test@ccc-test', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'PageSize', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], ], [ - 'name' => 'IsMember', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '是否关联坐席，若为true，则查询UserId关联的个人外呼号码列表，若为false，则查询UserId可关联但未关联的个人外呼号码列表。通常和AddPersonalNumbersToUser接口一起使用。', - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-65382141036853491'], ], - [ - 'name' => 'SearchPattern', - 'in' => 'query', - 'schema' => [ - 'description' => '根据号码进行模糊匹配，非必填，不填默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => '0833', - ], - ], - ], - 'responses' => [ - 200 => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'List' => [ - 'description' => '号码列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Active' => [ - 'description' => '号码是否可用。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Number' => [ - 'description' => '号码。', - 'type' => 'string', - 'example' => '08330011****', - ], - 'City' => [ - 'description' => '号码归属地市。', - 'type' => 'string', - 'example' => '乐山', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'ContactFlowId' => [ - 'description' => '该号码关联的IVR联系流ID。', - 'type' => 'string', - 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek', + 'ContextId' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '103655'], + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => 'Channel在通话过程中创建的顺序。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'ANSWERED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'SkillGroupId' => ['description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'INBOUND', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + 'ChannelVariables' => ['description' => '随路数据', 'type' => 'string', 'example' => 'a=b;c=d;'], + ], ], - 'Province' => [ - 'description' => '号码归属地省。', - 'type' => 'string', - 'example' => '四川', + ], + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', ], + 'example' => 'INBOUND', + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], ], ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], + ['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is not allowed in current state.', 'description' => ''], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Active\\": true,\\n \\"Number\\": \\"08330011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n true\\n 083xxxx0011\\n ccc-test\\n a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\n 乐山\\n 四川\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取坐席的个人号码列表', - 'summary' => '调用ListPersonalNumbersOfUser获取指定实例下指定坐席的个人外呼号码列表，也可通过该接口反查可添加为坐席个人外呼号码的号码列表。', - 'description' => '注意：如果号码已绑定了技能组，则不会出现在可作为个人外呼号码的号码列表中。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103655,\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"INBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"ChannelVariables\\": \\"a=b;c=d;\\"\\n }\\n ],\\n \\"CallType\\": \\"INBOUND\\"\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n skg-default@ccc-test\\n \\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', + 'title' => '接听通话', + 'summary' => '调用AnswerCall接听指定实例下指定通话ID对应的通话。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListPhoneNumbers' => [ - 'summary' => '调用ListPhoneNumbers获取指定实例下的号码列表。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-02-05T03:20:14.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-10-26T07:15:58.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-06-05T23:22:12.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-21T04:35:33.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnswerCall'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'AppendCases' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2682,288 +1460,203 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'SearchPattern', + 'name' => 'CampaignId', 'in' => 'query', + 'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '78cf6864-9a22-4ea8-a59d-5adc2d747b0e'], + ], + [ + 'name' => 'body', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '根据号码进行模糊匹配，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', + 'description' => '外呼名单列表，Body参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReferenceId' => ['description' => '业务ID，客户业务系统标识，用于集成场景。'."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => '01'], + 'PhoneNumber' => ['description' => '联系人电话号码。', 'type' => 'string', 'required' => false, 'example' => '188888****'], + 'CustomVariables' => ['description' => '客户自定义变量，格式为JSON对象，对象最多包含10个属性，每个属性的名称和值均由客户自定义。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "name": "customer",'."\n" + .' "客户标签": "tag"'."\n" + .'}'], + 'MaskedCallee' => ['description' => '脱敏后的被叫号码，如果该字段不为空，表示需要对被叫号码脱敏，脱敏规则由客户自行定义，只需将脱敏后的被叫号码填入即可，使用脱敏被叫会导致某些场景下看到的是脱敏后的被叫号码，无法查看真实被叫号码。', 'type' => 'string', 'required' => false, 'example' => '071*****801'], + 'Caller' => ['description' => '主叫号码，该字段若不为空，外呼式会优先使用传入的号码作为主叫发起呼叫；该字段若为空，系统会自动选取主叫发起呼叫。', 'type' => 'string', 'required' => false, 'example' => '01012345678'], + 'AgentId' => ['description' => '坐席ID，指定的转接坐席，该字段不为空，系统会将该电话转至对应坐席；该字段若为空，系统会分配给技能组中的空闲坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], + ], + 'required' => false, + 'description' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => '0833', ], ], - [ - 'name' => 'Usage', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '号码的用途，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'Outbound' => '呼出', - 'Inbound' => '呼入', - 'Bidirection' => '呼入和呼出', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E'], + 'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReferenceId' => ['type' => 'string', 'description' => ''], + 'PhoneNumber' => ['type' => 'string', 'description' => ''], + 'CustomVariables' => ['type' => 'string', 'description' => ''], + ], + 'description' => '', + ], + 'description' => '', + ], ], - 'example' => 'Bidirection', - 'maxLength' => 200, - 'minLength' => 1, ], ], + ], + 'title' => '追加预测式外呼名单', + 'summary' => '添加外呼名单到指定实例下指定ID对应的预测式外呼活动。', + 'changeSet' => [ + ['createdAt' => '2025-11-13T08:46:17.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AppendCases'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"ReferenceId\\": \\"\\",\\n \\"PhoneNumber\\": \\"\\",\\n \\"CustomVariables\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'AssignUsers' => [ + 'summary' => '调用AssignUsers将一个或多个RAM账户导入到指定实例中，成功导入后，RAM账户将以坐席的形式存在于实例中。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], [ - 'name' => 'Active', + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '号码是否可用，非必填，默认为空，为空表示不过滤。', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PageNumber', + 'name' => 'RoleId', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '角色ID，坐席导入成功后在实例中的角色，包括管理员、技能组组长和坐席三种角色。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Agent@ccc-test'], ], [ - 'name' => 'PageSize', + 'name' => 'SkillLevelList', + 'in' => 'query', + 'schema' => ['description' => '技能组的技能等级列表，格式为JSON数组的字符串，数组元素是一个对象，包含两个字段：skillGroupId和skillLevel，skillGroupId填写坐席想要关联的技能组ID，skillLevel填写坐席在该技能组的技能等级，取值范围1-10，值越小，业务能力越强，单位时间内能处理更多的通话。', 'type' => 'string', 'required' => false, 'example' => '[{"skillGroupId":"skillgroup@ccc-test","skillLevel":5}]'], + ], + [ + 'name' => 'RamIdList', + 'in' => 'query', + 'schema' => ['description' => '待添加的RAM用户ID列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["28036411123456****","29234301123456****"]'], + ], + [ + 'name' => 'WorkMode', 'in' => 'query', 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '工作模式。', + 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => '20', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', ], ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'default' => 'true'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页序号，范围1-100', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'List' => [ - 'description' => '号码列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Active' => [ - 'description' => '号码是否可用。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CreateTime' => [ - 'description' => '号码创建时间，即关联到实例的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'string', - 'example' => '1617958538000', - ], - 'UserId' => [ - 'description' => '坐席ID，如果此参数不为空，说明该号码是座席专属号码。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Tags' => [ - 'description' => '号码业务标签，主要用于给号码打标，做一些扩展业务，普通客户无需关心。', - 'type' => 'string', - 'example' => 'M1', - ], - 'City' => [ - 'description' => '号码归属地市。', - 'type' => 'string', - 'example' => '乐山', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Usage' => [ - 'description' => '号码用途。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Outbound' => '呼出', - 'Inbound' => '呼入', - 'Bidirection' => '呼入和呼出', - ], - 'example' => 'Bidirection', - ], - 'ContactFlowName' => [ - 'description' => '号码关联的IVR联系流名称。', - 'type' => 'string', - 'example' => '默认联系流', - ], - 'Provider' => [ - 'description' => '号码供应商名称。', - 'type' => 'string', - 'example' => 'alicom', - ], - 'Number' => [ - 'description' => '号码。', - 'type' => 'string', - 'example' => '08330011****', - ], - 'ContactFlowId' => [ - 'description' => '号码关联的IVR联系流ID。', - 'type' => 'string', - 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek', - ], - 'Province' => [ - 'description' => '号码归属地省。', - 'type' => 'string', - 'example' => '四川', - ], - 'SkillGroups' => [ - 'description' => '号码关联的技能组列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '技能组展示名。', - 'type' => 'string', - 'example' => '测试技能组', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Name' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => 'skillgroup', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => '数据，内容与工作流ID相同。', 'type' => 'string', 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'WorkflowId' => ['description' => '工作流ID。', 'type' => 'string', 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Active\\": true,\\n \\"CreateTime\\": \\"1617958538000\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Tags\\": \\"M1\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowName\\": \\"默认联系流\\",\\n \\"Provider\\": \\"alicom\\",\\n \\"Number\\": \\"08330011****\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\",\\n \\"SkillGroups\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n20\\n无\\n1\\n200\\n\\n 1\\n 20\\n 1\\n \\n Bidirection\\n true\\n 083xxxx0011\\n ccc-test\\n a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\n user-test@ccc-test\\n 1617958538000\\n 测试IVR\\n 乐山\\n M1\\n 四川\\n ali\\n \\n ccc-test\\n 测试技能组\\n test@ccc-test\\n test\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '获取号码列表', + 'staticInfo' => [ + 'substitutions' => ['CCC::2020-07-01::ImportRamUsers'], + ], + 'title' => '导入多个坐席', + 'description' => '拥有RAM权限的账号可以到RAM控制台查询阿里云主账号下管理的所有RAM子账号，RAM控制台地址：https://ram.console.aliyun.com/users', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListPhoneNumbersOfSkillGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssignUsers'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Code\\": \\"OK\\",\\n \\"WorkflowId\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n1ca2b084-6f0a-454b-9851-29768a9a5832\\n1ca2b084-6f0a-454b-9851-29768a9a5832\\n无\\nOK","errorExample":""}]', + ], + 'BargeInCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2972,86 +1665,44 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'SkillGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'skillgroup@ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PageNumber', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '发起强插的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'PageSize', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], ], [ - 'name' => 'IsMember', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '是否关联技能组，若为true，则查询SkillgroupId关联的号码列表，若为false，则查询SkillgroupId可关联但未关联的号码列表。通常和AddNumbersToSkillGroup接口一起使用。', - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'], ], [ - 'name' => 'SearchPattern', + 'name' => 'BargedUserId', 'in' => 'query', - 'schema' => [ - 'description' => '根据号码进行模糊匹配，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', - 'required' => false, - 'example' => '0833', - ], + 'schema' => ['description' => '被强插的座席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent2@ccc-test'], ], [ - 'name' => 'Active', + 'name' => 'TimeoutSeconds', 'in' => 'query', - 'schema' => [ - 'description' => '号码是否可用，非必填，默认为空，为空表示不过滤。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '强插超时时间，经过指定的时间强插仍未成功，则取消强插，正常情况下，强插操作会马上成功，设置超时时间是为了防止异常发生，此字段选填，默认30，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '60'], ], ], 'responses' => [ @@ -3059,152 +1710,155 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'List' => [ - 'description' => '号码列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Active' => [ - 'description' => '号码是否可用。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Number' => [ - 'description' => '号码。', - 'type' => 'string', - 'example' => '08330011****', - ], - 'City' => [ - 'description' => '号码归属地市。', - 'type' => 'string', - 'example' => '乐山', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', ], - 'Usage' => [ - 'description' => '号码用途。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Outbound' => '呼出', - 'Inbound' => '呼入', - 'Bidirection' => '呼入和呼出', + 'example' => 'BARGE', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'ANSWERED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'MONITORING', + ], + 'SkillGroupId' => ['description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'BARGE', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], ], - 'example' => 'Bidirection', - ], - 'ContactFlowId' => [ - 'description' => '号码关联的IVR联系流ID。', - 'type' => 'string', - 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek', - ], - 'Province' => [ - 'description' => '号码归属地省。', - 'type' => 'string', - 'example' => '四川', ], ], ], ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], + ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'InvalidOperation.DeviceState', 'errorMessage' => 'The operation is not allowed. Device state (%s) does not meet expectations (%s).', 'description' => '非法操作。 设备状态不符合预期。'], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.SkillGroupId', - 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Active\\": true,\\n \\"Number\\": \\"08330011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n Bidirection\\n true\\n 083xxxx0011\\n ccc-test\\n a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\n 乐山\\n 四川\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取技能组的号码列表', - 'summary' => '调用ListPhoneNumbersOfSkillGroup获取指定实例下指定技能组关联的号码列表，也可以通过该接口反查未关联但可关联到该技能组的号码。', - 'description' => '注意：如果号码已作为个人外呼号码使用，则不会出现在可添加到技能组的号码列表中。', + 'title' => '强插通话', + 'summary' => '调用BargeInCall强行插入指定实例下指定通话ID对应的正在通话中的通话，强插成功后，通话将由原来的双方通话变成三人会议。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListUnassignedNumbers' => [ - 'summary' => '调用ListUnassignedNumbers获取阿里云主账号下未分配到实例的号码列表。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:48.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BargeInCall'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"BARGE\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"BARGE\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 10\\n skg-test1@ccc-test\\n 无\\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'BlindTransfer' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3213,247 +1867,103 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ - 'name' => 'SearchPattern', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '根据号码进行模糊匹配，非必填，默认为空，为空表示不过滤。'."\n" - ."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '0833', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PageNumber', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => '发起直接转接的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'PageSize', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ACC-YUNBS-1.0.10-****'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F ', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'List' => [ - 'description' => '号码列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Number' => [ - 'description' => '号码。'."\n" - ."\n", - 'type' => 'string', - 'example' => '08330011****', - ], - 'City' => [ - 'description' => '号码归属地市。'."\n" - ."\n", - 'type' => 'string', - 'example' => '乐山', - ], - 'Province' => [ - 'description' => '号码归属地省。'."\n" - ."\n", - 'type' => 'string', - 'example' => '四川', - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'name' => 'Transferor', + 'in' => 'query', + 'schema' => ['description' => '转接发起方，当场景是直接转接到外部号码时，用此参数指定的号码作为主叫，转内部坐席或技能组时，此参数无效，发起方由UserId指定。', 'type' => 'string', 'required' => false, 'example' => '08314325****'], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], + [ + 'name' => 'Transferee', + 'in' => 'query', + 'schema' => ['description' => '被转接方，可以是坐席ID或技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + [ + 'name' => 'TimeoutSeconds', + 'in' => 'query', + 'schema' => ['description' => '直接转接超时时间，超过指定时间被转接方没有接起通话，则挂断通话，此字段选填，默认30，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '120', 'minimum' => '3', 'example' => '60'], ], - 500 => [ - [ - 'errorCode' => 'InternalService.ResourcePlatform', - 'errorMessage' => 'An internal ResourcePlatform service error occurred. %s', - ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\\\t\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"08330011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\t\\n无\\n200\\n\\n 1\\n 20\\n 1\\n \\n true\\n true\\n 083xxxx0011\\t\\n 乐山\\n 四川\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取未分配号码列表', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyPhoneNumber' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'CallPriority', + 'in' => 'query', + 'schema' => ['description' => '转接到技能组队列时的排队优先级，取值范围0-9，0优先级最高，9最低。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], ], [ - 'BearerToken' => [], + 'name' => 'StrategyName', + 'in' => 'query', + 'schema' => ['description' => '转接到技能组队列时的座席分配策略名称。', 'type' => 'string', 'required' => false, 'example' => 'MOST_IDLE，MOST_SKILLED，MOST_ACQUAINTED，CUSTOMIZED等'], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'StrategyParams', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '转接到技能组队列时的座席分配策略参数。', 'type' => 'string', 'required' => false, 'example' => '当分配策略为CUSTOMIZED时，本参数的内容为如下格式：'."\n" + .' {'."\n" + .' "functionId": "512fed64-e379-400f-a1a5-14d5730xxxxx",'."\n" + .' "functionName": "routing-strategy-test-2"'."\n" + .'}'], ], [ - 'name' => 'Number', + 'name' => 'TransfereeType', 'in' => 'query', - 'schema' => [ - 'description' => '号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0102134****', - ], + 'schema' => ['description' => '转接目的类型，可选值为AGENT，SKILL_GROUP，IVR和EXTERNAL_NUMBER。如果此参数不传，则系统会根据转接的目标号码的格式进行判断，如果发现有判不准确的情况，则需要指定此参数。', 'type' => 'string', 'required' => false, 'example' => 'SKILL_GROUP'], ], [ - 'name' => 'Usage', + 'name' => 'ContactFlowVariables', 'in' => 'query', - 'schema' => [ - 'description' => '号码用途。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'Outbound' => '呼出', - 'Inbound' => '呼入', - 'Bidirection' => '呼入和呼出', - ], - 'example' => 'Bidirection', - 'maxLength' => 200, - 'minLength' => 1, - ], + 'schema' => ['description' => '传递给联系流的变量，选填，这里配置的变量，可以在IVR流程中拿到并使用，格式为JSON字符串格式的键值对集合。', 'type' => 'string', 'required' => false, 'example' => '{"name":"王先生","time":"19点20分","address":"某某中心"}'], ], [ - 'name' => 'ContactFlowId', + 'name' => 'RoutingType', 'in' => 'query', - 'schema' => [ - 'description' => '号码绑定的IVR联系流ID，仅在号码用途为Inbound或Bidirection时，该字段才有效。', - 'type' => 'string', - 'required' => false, - 'example' => '78128960-bb00-4ddc-8a82-923a8c5bd22d', - ], + 'schema' => ['description' => '话务分配类型，可选参数为自动分配(Automatic)或者手动分配(Manual)。如果此参数为空，则默认为自动分配的方式，这也是当前系统的默认行为。选择手动分配方式时，需要您自己配合调用ClaimCall等接口把电话分给指定的座席。', 'type' => 'string', 'required' => false, 'example' => 'Manual'], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => ['description' => '随路数据，主要用于扩展需求，普通用户无需关心。', 'type' => 'string', 'required' => false, 'example' => '5295578135#WAEtqY5U&Biz_Package_Rexian_Zhuanjieanquanyungaojie_2527'], + ], + [ + 'name' => 'QueuingTimeoutSeconds', + 'in' => 'query', + 'schema' => ['description' => '当转接目标是技能组队列时排队超时时间，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'QueuingOverflowThreshold', + 'in' => 'query', + 'schema' => ['description' => '当转接目标是技能组队列时排队溢出阈值。默认值为0，表示不溢出。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'query', + 'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => false, 'example' => 'ee914df4-82bf-4919-bcb3-9cb8aa437f35'], ], ], 'responses' => [ @@ -3461,201 +1971,356 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'ContextId' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '103654'], + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道', + 'type' => 'object', + 'properties' => [ + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'ANSWERED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'MONITORING', + ], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + ], + ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => '该参数无效。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.Number', - 'errorMessage' => 'The specified number %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', - 'title' => '修改号码', - 'summary' => '调用ModifyPhoneNumber修改指定实例下指定号码的信息，主要是修改号码用途和绑定的联系流ID。', + 'title' => '直接转接通话', + 'summary' => '直接转接通话到其他坐席或某个技能组队列或外部号码，直接转接也叫盲转或单步转。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ImportCorpNumbers' => [ - 'summary' => '导入自有线路号码，首次导入前，需联系云联络中心-售后技术支持进行加白。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-10-28T02:30:26.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-04-01T09:23:01.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T07:21:07.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-04-25T07:33:48.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-04-12T02:15:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-21T09:15:55.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BlindTransfer'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103654,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n \\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'CancelAttendedTransfer' => [ + 'summary' => '调用CancelAttendedTransfer取消咨询转接，在发起咨询转接后，完成咨询转接前，均可调用该接口取消咨询转接，即使被转接方已经接通，也可以取消。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREccc1MRAID', - ], + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ - 'name' => 'NumberList', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '号码列表', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[\'029xxxxxx\']', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'TagList', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '业务标签', - 'type' => 'string', - 'required' => false, - 'example' => '无', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'Province', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '省份', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '陕西', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], ], [ - 'name' => 'City', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '城市', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '西安', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'], ], - [ - 'name' => 'Provider', - 'in' => 'query', - 'schema' => [ - 'description' => '线路信息', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'xxx通信-陕西线路', - ], - ], - [ - 'name' => 'CorpName', - 'in' => 'query', - 'schema' => [ - 'description' => '企业名称', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx公司', - ], - ], - ], - 'responses' => [ - 200 => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '错误码', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息', - 'type' => 'string', - 'example' => '无', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'C42981C7-93D9-55CD-B078-784F8522E0E1', + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'ContextId' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '103656'], + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => '系统自增ID，客户不用关注。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'ANSWERED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'MONITORING', + ], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'CONSULTANT', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], + ], + ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], + ], + 404 => [ + ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C42981C7-93D9-55CD-B078-784F8522E0E1\\"\\n}","type":"json"}]', - 'title' => '导入自有线路号码', - ], - 'RemovePersonalNumbersFromUser' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '取消咨询转移', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:48.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelAttendedTransfer'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103656,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"CONSULTANT\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 10\\n 无\\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'ChangeVisibility' => [ + 'summary' => '修改隐身状态（等同于仅外呼场景）。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3666,40 +2331,27 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'szpczf'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'example' => 'sam@szpczf'], ], [ - 'name' => 'NumberList', + 'name' => 'Invisible', 'in' => 'query', - 'schema' => [ - 'description' => '待删除的个人外呼号码列表，通过调用ListPersonalNumbersOfUser可获取坐席当前关联的个人外呼号码列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["0101234****", "0105678****"]', - ], + 'schema' => ['description' => '是否切换为隐身状态。隐身状态和仅外呼含义一致。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -3707,77 +2359,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => 'Internal service issue. Detail:.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '24BE19E8-BF7D-4992-A35E-15EBA874F2E5'], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '座席分机号。'."\n", 'type' => 'string', 'example' => '8001****'], + 'WorkMode' => ['description' => '工作模式。', 'type' => 'string', 'example' => 'ON_SITE'], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'Yealink SIP-T23G 44.84.203.6'], + 'JobId' => ['description' => '通话ID，如果该字段有值，说明坐席当前处于通话过程中。', 'type' => 'string', 'example' => 'job-330557290544431104'], + 'UserId' => ['description' => '座席ID。', 'type' => 'string', 'example' => 'sam@szpczf'], + 'BreakCode' => ['description' => '小休代码。', 'type' => 'string', 'example' => '会议'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'szpczf'], + 'OutboundScenario' => ['description' => '坐席是否为仅外呼状态。', 'type' => 'boolean', 'example' => 'False'], + 'UserState' => ['description' => '用户状态。', 'type' => 'string', 'example' => 'Ready'], + 'SignedSkillGroupIdList' => [ + 'description' => '技能组ID。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\nOK","errorExample":""}]', - 'title' => '删除坐席关联的多个号码', - 'summary' => '调用RemovePersonalNumbersFromUser删除指定实例下指定坐席的一个或多个个人外呼号码。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RemovePhoneNumberFromSkillGroups' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Internal service issue. Detail:.\\",\\n \\"RequestId\\": \\"24BE19E8-BF7D-4992-A35E-15EBA874F2E5\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"Yealink SIP-T23G 44.84.203.6\\",\\n \\"JobId\\": \\"job-330557290544431104\\",\\n \\"UserId\\": \\"sam@szpczf\\",\\n \\"BreakCode\\": \\"会议\\",\\n \\"InstanceId\\": \\"szpczf\\",\\n \\"OutboundScenario\\": true,\\n \\"UserState\\": \\"Ready\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup@ccc-test\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '修改座席可见性', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ChangeWorkMode' => [ + 'summary' => '调用ChangeWorkMode改变坐席的工作模式。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3788,122 +2427,132 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Number', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '待解绑的号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0101234****', - ], + 'schema' => ['description' => '坐席ID，不填默认使用当前RAM账号映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'SkillGroupIdList', + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'required' => false, 'example' => 'ACC-YUNBS-1.0.10-****'], + ], + [ + 'name' => 'WorkMode', 'in' => 'query', 'schema' => [ - 'description' => '待解绑的技能组ID列表，请确保技能组与号码之间原本就存在绑定关系。', + 'description' => '工作模式。', 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', ], ], + [ + 'name' => 'SignedSkillGroupIdList', + 'in' => 'query', + 'schema' => ['description' => '需要签入的技能组列表。当修改工作模式到场外模式时，可以通过此参数指定场外座席需要签入的技能组列表。', 'type' => 'string', 'required' => false, 'example' => '["online-1@ccc-test","online-2@ccc-test","online-3@ccc-test","skg-default@ccc-test"]'], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => ['description' => '坐席的个人电话号码，该号码在场外模式下会用到，坐席可以使用该号码进行场外模式接听。', 'type' => 'string', 'required' => false, 'example' => '1382114****'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => '87731ED1-6224-48A5-99E3-6237FF9B1C00'], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + 'Data' => [ + 'description' => '数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '座席分机号。'."\n", 'type' => 'string', 'example' => '8001****'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'JobId' => ['description' => '通话ID，如果该字段有值，说明坐席当前处于通话过程中。'."\n", 'type' => 'string', 'example' => '无'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休码包括：Warm-up'."\n" + .'（坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否开启了仅外呼模式。'."\n", 'type' => 'boolean', 'example' => 'false'], + 'UserState' => [ + 'description' => '座席状态。'."\n", + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'OFFLINE', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid. %s', - ], - [ - 'errorCode' => 'Parameter.Invalid', - 'errorMessage' => 'The parameter %s is invalid. %s.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', - 'title' => '删除多个技能组关联的号码', - 'summary' => '调用RemovePhoneNumberFromSkillGroups删除指定实例下指定号码关联的一个或多个技能组与该号码的绑定关系，删除的是号码与技能组的绑定关系，并不是真实号码。', + 'title' => '改变坐席工作模式', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RemovePhoneNumbers' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-11-28T07:08:39.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeWorkMode'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"87731ED1-6224-48A5-99E3-6237FF9B1C00\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"OFFLINE\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"87731ED1-6224-48A5-99E3-6237FF9B1C00\\n无\\n200\\n无\\n\\n 80011474\\n OFFLINE\\n ccc-test\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bs990cd82101cc000176af19ec8e\\n Warm-up\\n false\\n ON_SITE\\n 无\\n [\\"skill-group@ccc-test\\"]\\n\\nOK","errorExample":""}]', + ], + 'ClaimCall' => [ + 'summary' => '调用接口ClaimCall把一个电话分配给一个坐席。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3912,41 +2561,49 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'NumberList', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '待删除的号码列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["0101234****","0105678****"]', - ], + 'schema' => ['description' => '调用者坐席ID。', 'type' => 'string', 'required' => false, 'example' => 'invoker@ccc-test'], ], [ - 'name' => 'Force', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '是否强制删除，如果号码关联了技能组、联系流或坐席，只有将该字段设置为true才可以执行删除，非必填，默认false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '话务ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'query', + 'schema' => ['description' => '待分配电话的技能组ID。', 'type' => 'string', 'required' => false, 'example' => 'test_sg_****@ccc-test'], + ], + [ + 'name' => 'CandidateUserListJson', + 'in' => 'query', + 'schema' => ['description' => '可以认领此电话的座席及对应的技能组列表', 'type' => 'string', 'required' => false, 'example' => '['."\n" + .'{'."\n" + .'"f0": "zeren001@report-test-2",'."\n" + .'"f1": "desktop-voip-box@report-test-2"'."\n" + .'}'."\n" + .']'], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => ['description' => '调度专用唯一业务ID，后续事件通知携带此标志', 'type' => 'string', 'required' => false, 'example' => 'tags'], ], ], 'responses' => [ @@ -3954,127 +2611,117 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '删除失败的号码列表。', - 'type' => 'array', - 'items' => [ - 'description' => '号码。', - 'type' => 'string', - 'example' => '0101234****', - ], - 'example' => '无', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '93CDC17E-3E8A-48F2-99E5-FA2E238DE8B4'], 'Params' => [ + 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], + ], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'ccc-test'], + 'ChannelContexts' => [ + 'description' => '话务通道上下文。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => ['description' => '话务通道的状态。', 'type' => 'string', 'example' => 'ANSWERED'], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'invoker@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609225718295'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'], + 'CallType' => ['description' => '话务通道的通话类型。', 'type' => 'string', 'example' => 'OUTBOUND'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6573574060089****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], + 'UserExtension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8059****'], + 'ChannelVariables' => ['description' => '随路数据。', 'type' => 'string', 'example' => 'a=b;c=d;'], + ], + ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '分机号。', 'type' => 'string', 'example' => '0830019****'], + 'WorkMode' => ['description' => '工作模式。', 'type' => 'string', 'example' => 'ON_SITE'], + 'DeviceId' => ['description' => '设备ID。', 'type' => 'string', 'example' => 'device-xxxx'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6573574060089****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'user@ccc-test'], + 'BreakCode' => ['description' => '小休状态码。', 'type' => 'string', 'example' => 'Customized'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '是否为场外模式。', 'type' => 'boolean', 'example' => 'false'], + 'UserState' => ['description' => '坐席状态。', 'type' => 'string', 'example' => 'Dialing'], + 'SignedSkillGroupIdList' => [ + 'description' => '签入的技能组列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skill@ccc-test'], + ], + ], + ], + 'ContextId' => ['description' => '上下文ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n \\"0101234****\\"\\n ],\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n无\\n无\\nOK","errorExample":""}]', - 'title' => '删除号码', - 'summary' => '调用RemovePhoneNumbers删除指定实例下的一个或多个号码。并非真实删除某个号码，而是将这个号码与实例进行解绑，包括号码关联的技能组、联系流、坐席等，都将随之解绑。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RemovePhoneNumbersFromSkillGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '分配电话', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"93CDC17E-3E8A-48F2-99E5-FA2E238DE8B4\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"invoker@ccc-test\\",\\n \\"Timestamp\\": 1609225718295,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8059****\\",\\n \\"ChannelVariables\\": \\"a=b;c=d;\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"0830019****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"device-xxxx\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"UserId\\": \\"user@ccc-test\\",\\n \\"BreakCode\\": \\"Customized\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"Dialing\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skill@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 123456\\n }\\n}","type":"json"}]', + ], + 'ClaimChat' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'NumberList', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '号码列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["0101234****","0105678****"]', - ], + 'schema' => ['description' => '按技能组ID过滤。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'], ], [ - 'name' => 'SkillGroupId', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'skillgroup@ccc-test', - ], + 'schema' => ['description' => '话务ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'chat-65382141036853491'], ], ], 'responses' => [ @@ -4082,85 +2729,109 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'ContextId' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789'], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为 Unix 时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'."\n"], + 'WorkMode' => ['description' => '工作模式。Chat场景无需关心。'."\n" + ."\n" + .'枚举值：'."\n" + .'- ON_SITE：场内模式。'."\n" + .'- OFF_SITE：场外模式。'."\n" + .'- OFFICE_PHONE：办公电话模式。', 'type' => 'string', 'example' => 'ON_SITE'], + 'DeviceId' => ['description' => '设备 ID。', 'type' => 'string', 'example' => 'CCC-169.254.165.2-browser125.0.0-bs48b41903450e6c8'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'userId@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，格式为 Unix 时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => 'false'], + 'BreakCode' => ['description' => '小休状态码。', 'type' => 'string', 'example' => 'Warm-up'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '仅外呼场景。Chat业务无需关心。', 'type' => 'boolean', 'example' => 'false'], + 'DeviceState' => ['description' => '设备状态。', 'type' => 'string', 'example' => 'ONLINE'], + 'Mobile' => ['description' => '坐席的个人电话号码。Chat场景无需关心。', 'type' => 'string', 'example' => '18******102'], + 'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'chat-65382141036853491'."\n"], + 'UserState' => ['description' => '座席状态。'."\n" + ."\n" + .'枚举值：'."\n" + .'- READY：空闲。'."\n" + .'- WORKING：话后处理中。'."\n" + .'- BREAK：小休。'."\n" + .'- OFFLINE：离线。'."\n" + .'- TALKING：聊天中。'."\n" + .'- RINGING：聊天进线中。', 'type' => 'string', 'example' => 'TALKING'], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组 ID 列表。', + 'type' => 'array', + 'items' => ['description' => '技能组 ID。', 'type' => 'string', 'example' => 'skg-default@ccc-test'], + ], + ], + ], + 'ChatContexts' => [ + 'description' => '会话上下文环境。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'chat-65382141036853491'."\n"], + 'ChatType' => ['description' => '会话类型。', 'type' => 'string', 'example' => 'INBOUND'], + 'CallVariables' => ['description' => '随路数据。', 'type' => 'string', 'example' => '无'], + 'AccessChannelId' => ['description' => '网络业务渠道ID。', 'type' => 'string', 'example' => '226****-cbb6-****-8fea-1e71baf7bfa7'], + 'AccessChannelType' => ['description' => '网络业务渠道类型。', 'type' => 'string', 'example' => 'Web'], + 'AccessChannelName' => ['description' => '网络业务渠道名字。', 'type' => 'string', 'example' => '测试渠道'], + 'BeingAssigned' => ['description' => '会话是否已分配坐席。', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', + ], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid. %s', - ], - [ - 'errorCode' => 'Parameter.Invalid', - 'errorMessage' => 'The parameter %s is invalid. %s.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.SkillGroupId', - 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', - 'title' => '删除技能组关联的多个号码', - 'summary' => '调用RemovePhoneNumbersFromSkillGroup删除指定实例下指定技能组关联的一个或多个号码与该技能组的关联关系。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'AddNumbersToSkillGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 123456789,\\n \\"UserContext\\": {\\n \\"Heartbeat\\": 1609136956378,\\n \\"Extension\\": \\"8032****\\\\n\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"CCC-169.254.165.2-browser125.0.0-bs48b41903450e6c8\\",\\n \\"UserId\\": \\"userId@ccc-test\\",\\n \\"Reserved\\": 0,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"ONLINE\\",\\n \\"Mobile\\": \\"18******102\\",\\n \\"JobId\\": \\"chat-65382141036853491\\\\n\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skg-default@ccc-test\\"\\n ]\\n },\\n \\"ChatContexts\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"chat-65382141036853491\\\\n\\",\\n \\"ChatType\\": \\"INBOUND\\",\\n \\"CallVariables\\": \\"无\\",\\n \\"AccessChannelId\\": \\"226****-cbb6-****-8fea-1e71baf7bfa7\\",\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"AccessChannelName\\": \\"测试渠道\\",\\n \\"BeingAssigned\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '认领聊天', + 'summary' => '调用ClaimChat认领指定实例下指定话务ID对应的聊天。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'CoachCall' => [ + 'summary' => '调用CoachCall辅导指定实例下指定通话ID对应的通话中的指定坐席，辅导过程中被辅导坐席可以听到辅导者的声音，客户无法听到辅导者的声音。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4170,51 +2841,42 @@ ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'SkillGroupId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'skillgroup@ccc-test', - ], + 'schema' => ['description' => '发起辅导的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'NumberList', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '号码列表，请确保号码已在当前实例下。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '["0103182****","0102387****"]', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], ], [ - 'name' => 'InstNumberGroupIdList', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '号码集合列表', - 'type' => 'string', - 'required' => false, - 'example' => '["38f5b191-b764-45b8-bd93-4b65f839e13a"]', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-65382141036853491'], + ], + [ + 'name' => 'CoachedUserId', + 'in' => 'query', + 'schema' => ['description' => '被辅导的坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'coached-agent@ccc-test'], + ], + [ + 'name' => 'TimeoutSeconds', + 'in' => 'query', + 'schema' => ['description' => '辅导超时时间，超过指定时间辅导没有建立，则取消辅导操作，此字段选填，默认30，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '30'], ], ], 'responses' => [ @@ -4222,187 +2884,164 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.SkillGroupId', - 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', - 'title' => '添加多个号码到技能组', - 'summary' => '调用AddNumbersToSkillGroup添加一个或多个号码到同一个技能组下。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'AddUsersToSkillGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'SkillGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test1@ccc-test', - ], - ], - [ - 'name' => 'UserSkillLevelList', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席技能组等级列表，格式为JSON数组的字符串，数组元素是一个对象，包含两个字段，userId和skillLevel，userId为待添加的坐席ID，skillLevel为该坐席加入技能组后的技能等级，技能等级为1-10，值越小，服务能力越强，单位时间内能处理更多的通话。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"userId":"agent1@ccc-test","skillLevel":10},{"userId":"agent2@ccc-test","skillLevel":10}]', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'COACH', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'ANSWERED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'COACHING', + ], + 'SkillGroupId' => ['description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'COACH', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], + ], + ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956370'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'DeviceState' => [ + 'description' => 'SIP话机设备的状态，如果未注册SIP话机，则状态为UNREGISTERED（未注册），如过SIP话机注册过但是不在线，则状态为OFFLINE（离线），如果SIP话机注册过并且在线则为ONLINE（在线）。', + 'type' => 'string', + 'enumValueTitles' => ['UNREGISTERED' => '未注册', 'OFFLINE' => '离线', 'ONLINE' => '在线'], + 'example' => 'UNREGISTERED', + ], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], + ['errorCode' => 'InvalidOperation.DeviceState', 'errorMessage' => 'The operation is not allowed. Device state (%s) does not meet expectations (%s).', 'description' => '非法操作。 设备状态不符合预期。'], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'UserBusy', 'errorMessage' => 'The user %s you called was busy. Please try again later.', 'description' => '您呼叫的用户正忙，请稍后再试。'], ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.SkillGroupId', - 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', - ], + 403 => [ + ['errorCode' => 'Permission.Common', 'errorMessage' => 'You have no permission to access. %s', 'description' => '您无权进行访问。'], + ], + [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', - 'title' => '添加多个坐席到技能组', - 'summary' => '调用AddUsersToSkillGroup添加一个或多个坐席到同一个技能组。', + 'title' => '辅导通话', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateSkillGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-01-11T08:11:36.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CoachCall'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"COACH\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"COACHING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"COACH\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956370,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"UNREGISTERED\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n无\\n\\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 1\\n 无\\n skg-default@ccc-test\\n ch:user:139xxxx0501->8032xxxx:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n COACHING\\n user-test@ccc-test\\n 8032xxxx\\n job-65382141036853491\\n \\n \\n \\n BREAK\\n ccc-test\\n Warm-up\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n false\\n 86-132xxxx4730\\n 无\\n 8032xxxx\\n UNREGISTERED\\n user-test@ccc-test\\n 1609136956378\\n job-65382141036853491\\n ON_SITE\\n 1609136956370\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', + ], + 'CommitContactFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4411,62 +3050,39 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Name', + 'name' => 'ContactFlowId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组名称，长度为1-64个字符，可以包含数字、字母、下划线（_）、短横线（-），必须以字母开头。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'skillgroup', - ], + 'schema' => ['description' => '联系流ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7d706489-d06d-4a92-8666-8c9dba2c5cb1'], ], [ - 'name' => 'DisplayName', + 'name' => 'Definition', 'in' => 'query', - 'schema' => [ - 'description' => '技能组展示名，长度为1-64个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '测试技能组', - ], + 'schema' => ['description' => 'IVR的定义。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好，欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}'], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '技能组的描述，非必填，不填默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => '云联络中心的测试技能组。', - ], + 'schema' => ['description' => '版本描述。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'MediaType', + 'name' => 'DraftId', 'in' => 'query', - 'schema' => [ - 'description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', - 'type' => 'string', - 'required' => false, - 'example' => 'CHAT', - ], + 'schema' => ['description' => '草稿ID，当前联系流对应的草稿版本ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b28f74ca-5846-4496-8bbd-34fb1750798c'], ], ], 'responses' => [ @@ -4474,108 +3090,34 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Description' => [ - 'description' => '技能组的描述。', - 'type' => 'string', - 'example' => '云联络中心的测试技能组。', - ], - 'Name' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => 'skillgroup', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID，格式为：技能组名称@实例ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'MediaType' => [ - 'description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', - 'type' => 'string', - 'example' => 'VIDEO', - ], - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '937617D5-01E9-5A39-B52D-15D5C143260C'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid. %s', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - 409 => [ - [ - 'errorCode' => 'AlreadyExists.SkillGroupId', - 'errorMessage' => 'Skill group %s already exists in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], - 500 => [ - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"Name\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 测试\\n ccc-test\\n skg-test@ccc-test\\n test\\n\\nOK","errorExample":""}]', - 'title' => '创建技能组', - 'summary' => '调用CreateSkillGroup在指定实例下创建一个技能组。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteSkillGroup' => [ - 'methods' => [ - 'post', - 'get', ], - 'schemes' => [ - 'http', - 'https', + 'title' => '提交联系流', + 'summary' => '提交联系流。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"937617D5-01E9-5A39-B52D-15D5C143260C\\"\\n}","type":"json"}]', + ], + 'CompleteAttendedTransfer' => [ + 'summary' => '调用CompleteAttendedTransfer完成咨询转。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4586,43 +3128,32 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'SkillGroupId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'skillgroup@ccc-test', - ], + 'schema' => ['description' => '发起咨询转接的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'Force', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '是否强制删除，如果技能组关联了号码或坐席，需要启用强制删除标志才能删除成功。', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => true, - 'maximum' => '200', - 'minimum' => '1', - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'], ], ], 'responses' => [ @@ -4630,74 +3161,159 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], - ], - ], - ], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'ContextId' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '103652'], + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => '系统自增ID，客户不用关注。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'ANSWERED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'MONITORING', + ], + 'SkillGroupId' => ['description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], + ], + ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'."\n"], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '在呼叫状态时的通话ID。', 'type' => 'string', 'example' => 'job-65382141036853491'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - [ - 'errorCode' => 'InUse.SkillGroup', - 'errorMessage' => 'Skill group %s is in use now.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', - 'title' => '删除技能组', - 'summary' => '调用DeleteSkillGroup删除指定实例下指定技能组ID对应的技能组。', + 'title' => '完成咨询转接', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetSkillGroup' => [ - 'summary' => '调用GetSkillGroup获取指定实例下指定技能组ID对应的技能组的信息。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:48.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CompleteAttendedTransfer'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103652,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\\\n\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-65382141036853491\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 10\\n skg-default@ccc-test\\n 无\\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'CreateAudioFile' => [ + 'summary' => '调用CreateAudioFile在指定实例下创建一个音频资源，创建好的音频资源可以在实例中应用，比如在IVR放音时可以选择创建好的音频文件。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4706,31 +3322,39 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccKYIENB'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'SkillGroupId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID，格式为：技能组名称@实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'skillgroup@ccc-test', - ], + 'schema' => ['description' => '音频展示名，长度为1-32的字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '欢迎语'], + ], + [ + 'name' => 'AudioFileName', + 'in' => 'query', + 'schema' => ['description' => '音频文件名称，长度为1-32个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-file.wav'], + ], + [ + 'name' => 'OssFileKey', + 'in' => 'query', + 'schema' => ['description' => 'OSS文件的Key，由GetAudioFileUploadParameters接口返回。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test/test-file.wav'], + ], + [ + 'name' => 'Usage', + 'in' => 'query', + 'schema' => ['description' => '音频文件用途，默认为General（用于IVR等场景）, 其他可选值为HoldMusic（通话保持等待音）。', 'type' => 'string', 'required' => false, 'example' => 'General'], ], ], 'responses' => [ @@ -4738,268 +3362,164 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '技能组展示名。', - 'type' => 'string', - 'example' => '测试技能组', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Name' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => 'skillgroup', - ], - 'Description' => [ - 'description' => '技能组的描述。', - 'type' => 'string', - 'example' => '云联络中心的测试技能组。', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID，格式为：技能组名称@实例ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'MediaType' => [ - 'description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', - 'type' => 'string', - 'example' => 'VIDEO', - ], - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '数据，音频资源的ID，唯一标识一个音频资源。', 'type' => 'string', 'example' => '2301b83f-1f9f-491e-9f97-2f832ed92f0b'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '94E29B9B-DBC6-5951-B3DD-C85C1BDF20ED'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"CF1C21B9-2D49-4B54-880F-FBE248C16903\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n}","type":"json"}]', - 'title' => '获取技能组', - ], - 'ListBriefSkillGroups' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '创建音频文件', + 'changeSet' => [ + ['createdAt' => '2023-11-22T01:05:25.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAudioFile'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"2301b83f-1f9f-491e-9f97-2f832ed92f0b\\",\\n \\"RequestId\\": \\"94E29B9B-DBC6-5951-B3DD-C85C1BDF20ED\\"\\n}","type":"json"}]', + ], + 'CreateCallSummary' => [ + 'summary' => '使用CreateCallSummary创建会话小结。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'CustomerId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['title' => '客户ID', 'description' => '客户ID', 'type' => 'string', 'required' => false, 'example' => '51e155ce-3747-*****-b402-13c69597b920'], ], [ - 'name' => 'SearchPattern', + 'name' => 'Context', 'in' => 'query', - 'schema' => [ - 'description' => '根据技能组名称或技能组展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'skillgroup', - ], + 'schema' => ['title' => 'summary信息', 'description' => 'summary信息', 'type' => 'string', 'required' => false, 'example' => '{"summaryTitle":"标题","summaryContent":"内容","keywords":"关键信息"}'], ], [ - 'name' => 'PageNumber', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'required' => false, 'example' => 'job-522327189435260928'], ], [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分页大小，范围1-100。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', + 'title' => 'CreateTicketResponse', + 'description' => 'CreateTicketResponse', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => '数据，小结ID。', 'type' => 'string', 'example' => 'c58b9719-3bc3-441d-a4d3-fc0309ef7066'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], + ], + ], ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '创建会话小结', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"c58b9719-3bc3-441d-a4d3-fc0309ef7066\\",\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + ], + 'CreateCallTags' => [ + 'summary' => '调用CreateCallTags在指定实例下创建多个号码标签。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], [ - 'name' => 'MediaType', + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括CHAT和 VIDEO。', - 'type' => 'string', - 'required' => false, - 'example' => 'CHAT', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'CallTagNameList', + 'in' => 'query', + 'schema' => ['description' => '号码标签名称列表，格式为JSON数组的字符串，数组元素是待创建的号码标签名称，号码标签名称的长度要求1-10个字符。', 'type' => 'string', 'required' => true, 'example' => '["TagA","TagB"]'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => '3969FC68-CEC2-4398-B76A-60D2F7EDEBAF', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'List' => [ - 'description' => '技能组概要信息列表。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '技能组', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '技能组展示名。', - 'type' => 'string', - 'example' => '测试技能组', - ], - 'Description' => [ - 'description' => '技能组的描述。', - 'type' => 'string', - 'example' => '云联络中心的测试技能组。', - ], - 'PhoneNumberCount' => [ - 'description' => '技能组关联的号码数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => 'skillgroup', - ], - 'UserCount' => [ - 'description' => '技能组关联的坐席数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'MediaType' => [ - 'description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', - 'type' => 'string', - 'example' => 'VIDEO', - ], - ], + 'description' => '创建失败的号码标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '创建失败的号码标签信息。', + 'type' => 'object', + 'properties' => [ + 'Item' => ['description' => '创建失败的号码标签的名称。', 'type' => 'string', 'example' => 'TagC'], + 'Reason' => [ + 'description' => '号码标签创建失败原因。', + 'type' => 'string', + 'enumValueTitles' => ['CALL_TAG_NAME_DUPLICATED' => '传入的列表中存在重复项', 'CALL_TAG_NAME_INSERT_DUPLICATED' => '后台写入号码标签时存在重复项', 'CALL_TAG_NAME_ILLEGAL' => '传入的列表中存在格式不合法的号码标签'], + 'example' => 'CALL_TAG_NAME_DUPLICATED', ], ], ], @@ -5010,42 +3530,35 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'LimitExceed.CallTagsPerInstance', 'errorMessage' => 'The total number of call tag of the instance exceeds the limit %s.', 'description' => '号码标签数量超出单个实例的上限阈值。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"3969FC68-CEC2-4398-B76A-60D2F7EDEBAF\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"UserCount\\": 10,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"3969FC68-CEC2-4398-B76A-60D2F7EDEBAF\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n 测试技能组\\n 测试技能组\\n 1\\n ccc-test\\n 1\\n 测试技能组\\n test@ccc-test\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取技能组概要列表', - 'summary' => '调用ListBriefSkillGroups获取指定实例下的技能组概要信息列表。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListSkillGroups' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '创建多个号码标签', + 'changeSet' => [ + ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCallTags'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"Item\\": \\"TagC\\",\\n \\"Reason\\": \\"CALL_TAG_NAME_DUPLICATED\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"无\\nEEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n200\\n\\n TagA\\n CUSTOM_NUMBER_DUPLICATED\\n\\nOK","errorExample":""}]', + ], + 'CreateCampaign' => [ + 'summary' => '调用CreateCampaign在指定实例下创建预测式外呼活动。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5054,410 +3567,246 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'SearchPattern', + 'name' => 'CaseList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '根据技能组名称或技能组展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', + 'description' => '预测式外呼名单列表，不能与CaseFileKey（从文件导入）同时使用，文件导入和列表导入只能选择一种。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '预测式外呼名单。', + 'type' => 'object', + 'properties' => [ + 'ReferenceId' => ['description' => '业务ID，客户业务系统标识，用于集成场景。', 'type' => 'string', 'required' => false, 'example' => '01'], + 'PhoneNumber' => ['description' => '联系人电话号码。', 'type' => 'string', 'required' => false, 'example' => '1888888888'], + 'CustomVariables' => ['description' => '客户自定义变量，格式为JSON对象，对象最多包含10个属性，每个属性的名称和值均由客户自定义。', 'type' => 'string', 'required' => false, 'example' => '{"name":"customer","客户标签":"tag"}'], + ], + 'required' => false, + ], 'required' => false, - 'docRequired' => false, - 'example' => '测试技能组', ], ], [ - 'name' => 'PageNumber', + 'name' => 'QueueId', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '预测式外呼活动关联的技能组ID。', 'type' => 'string', 'required' => true, 'example' => 'skillgroup@ccc-test'], ], [ - 'name' => 'PageSize', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '预测式外呼活动名称。', 'type' => 'string', 'required' => true, 'example' => 'test-campaign'], ], [ - 'name' => 'MediaType', + 'name' => 'CaseFileKey', 'in' => 'query', - 'schema' => [ - 'description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', - 'type' => 'string', - 'required' => false, - 'example' => 'Audio', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'List' => [ - 'description' => '技能组列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '技能组展示名。', - 'type' => 'string', - 'example' => '测试技能组', - ], - 'Description' => [ - 'description' => '技能组的描述。', - 'type' => 'string', - 'example' => '云联络中心的测试技能组。', - ], - 'PhoneNumberCount' => [ - 'description' => '技能组关联的号码数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => 'skillgroup', - ], - 'UserCount' => [ - 'description' => '技能组关联的坐席数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'MediaType' => [ - 'description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', - 'type' => 'string', - 'example' => 'CHAT', - ], - ], - ], - ], - ], - ], - ], - ], + 'schema' => ['description' => '预测式外呼名单文件，是一个OSS对象的Key，通过GetCaseFileUploadUrl接口获取。', 'type' => 'string', 'required' => false, 'example' => 'ccc-test/namelist.csv'], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], + [ + 'name' => 'ContactFlowId', + 'in' => 'query', + 'schema' => ['description' => '预测式外呼活动关联的联系流ID。', 'type' => 'string', 'required' => true, 'example' => 'c1f2bc75-422e-43c7-9c9d9d95633a'], ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '预测式外呼活动开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'string', 'required' => true, 'example' => '1634140800000'], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"UserCount\\": 2,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"MediaType\\": \\"CHAT\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n test\\n 测试\\n 1\\n ccc-test\\n 2\\n 测试技能组\\n test@ccc-test\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取技能组列表', - 'summary' => '调用ListSkillGroups获取指定实例下的技能组列表。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListSkillLevelsOfUser' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '预测式外呼活动结束时间，格式为Unix时间戳，单位毫秒。', 'type' => 'string', 'required' => true, 'example' => '1634313600000'], ], [ - 'BearerToken' => [], + 'name' => 'CallableTime', + 'in' => 'query', + 'schema' => ['description' => '预测式外呼活动的可外呼时段，格式为JSON对象，对象包含两个属性，beginTime和EndTime，例如：[{"beginTime":"00:00:00","endTime":"23:00:00" }]。', 'type' => 'string', 'required' => true, 'example' => '[{"beginTime":"00:00:00","endTime":"23:00:00" }]'], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'StrategyType', 'in' => 'query', 'schema' => [ - 'description' => '实例ID。', + 'description' => '预测式外呼活动的策略模式。'."\n", 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', + 'enumValueTitles' => ['PACING' => '固定比例外呼，外呼数量=空闲坐席*比例。', 'PID' => '系统基于PID控制策略，自动调整外呼电话数量。'], + 'example' => 'PACING', + 'enum' => ['SP', 'PID', 'PACING', 'ASAP', 'CUSTOMIZED'], ], ], [ - 'name' => 'UserId', + 'name' => 'StrategyParameters', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '预测式外呼活动的策略参数，PID策略下的格式参数示例：{"abandonRate":"5","historicalConnectedRate":"35"}，PACING策略下的格式参数示例：{"ratio":1}。abandonRate表示期望呼损率，historicalConnectedRate表示历史参考接通率，ratio表示固定外呼比例。', 'type' => 'string', 'required' => true, 'example' => '{"ratio":1}'], ], [ - 'name' => 'IsMember', + 'name' => 'MaxAttemptCount', 'in' => 'query', - 'schema' => [ - 'description' => '是否与传入的坐席关联，如果值为true，表示获取传入的坐席关联的技能组的技能等级列表，如果值为false，表示获取坐席可关联但未关联的技能组列表。默认值为true。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '预测式外呼活动的最大尝试次数，表示当活动的号码呼叫失败时，最多重呼几次。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ - 'name' => 'PageNumber', + 'name' => 'MinAttemptInterval', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '预测式外呼活动的最小重呼间隔，表示失败重呼时的最小间隔，单位分钟。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ - 'name' => 'PageSize', + 'name' => 'Simulation', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '是否是模拟活动，用于测试，普通客户无需关心。', 'type' => 'boolean', 'required' => false, 'example' => '无', 'default' => 'false'], ], [ - 'name' => 'SearchPattern', + 'name' => 'SimulationParameters', + 'in' => 'query', + 'schema' => ['description' => '模拟参数，用于测试，普通客户无需关心。', 'type' => 'string', 'required' => false, 'example' => '无'], + ], + [ + 'name' => 'ExecutingUntilTimeout', + 'in' => 'query', + 'schema' => ['description' => '是否在活动到期前保持执行状态。默认值fasle，当活动的所有联系人都呼叫完成后，活动会自动变为已完成状态；如果为True，当活动的所有联系人都呼叫完成后，活动不会自动变成已完成状态，仍是执行中状态，可以继续像活动中追加联系人，进而继续进行拨打，直到任务到期或手动终止。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'FlashSmsParameters', + 'in' => 'query', + 'schema' => ['title' => '闪信参数', 'description' => '闪信参数', 'type' => 'string', 'required' => false, 'example' => '{"applicationId":"08e6b63a-****-****-****-689a288cdbb5","templateId":"325"}'], + ], + [ + 'name' => 'NumberList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '根据技能组名称或技能组展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', + 'title' => '主叫号码列表', + 'description' => '主叫号码列表', + 'type' => 'array', + 'items' => ['title' => '号码', 'description' => '号码', 'type' => 'string', 'required' => false, 'example' => '01012345678'], 'required' => false, - 'example' => 'skillgroup', ], ], + [ + 'name' => 'InstGroupId', + 'in' => 'query', + 'schema' => ['title' => '号码集合ID', 'description' => '号码集合ID', 'type' => 'string', 'required' => false, 'example' => '0d368091-2c70-4d26-979a-6997ddc9c34f'], + ], ], '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' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315'], + 'Data' => ['title' => 'campaign id', 'description' => '预测式外呼活动ID。', 'type' => 'string', 'example' => 'c58b9719-3bc3-441d-a4d3-fc0309ef7066'], + 'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Data\\": \\"c58b9719-3bc3-441d-a4d3-fc0309ef7066\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n 7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\n 6badb397-a8b5-40b6-21019d382a09\\n OK\\n 无\\n 200\\n","errorExample":""}]', + 'title' => '创建预测式外呼活动', + 'changeSet' => [ + ['createdAt' => '2021-12-21T04:35:33.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCampaign'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + ], + 'CreateChatMediaUrl' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '263385', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], + 'parameters' => [ + [ + 'name' => 'MimeType', + 'in' => 'formData', + 'schema' => ['title' => 'media id', 'description' => 'media id', 'type' => 'string', 'required' => true, 'example' => 'jpg'], + ], + [ + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '云联络中心实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'GetChatMediaUrlResponse', + 'description' => 'GetChatMediaUrlResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'List' => [ - 'description' => '技能组等级列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SkillLevel' => [ - 'description' => '技能等级，取值范围1-10，数值越小，业务能力越强，单位时间内能处理更多的通话。', - 'type' => 'string', - 'example' => '5', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => 'skillgroup', - ], - 'MediaType' => [ - 'description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', - 'type' => 'string', - 'example' => 'VIDEO', - ], - ], - ], - ], + 'MediaId' => ['description' => '媒体ID。', 'type' => 'string', 'example' => '$iAHNCNQCo21wMwMGBAAFAAbaACOEAaQhIH6TAqogDGyb-qD2Hbj0A88AAAGRLKYVnwTOACwwYwcACM8AAAGRLRPynQ'], + 'Url' => ['description' => '文件url', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****'], ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '[\'OFFLINE\', \'BREAK,READY,WORKING\']'], + ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"SkillLevel\\": \\"5\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n 5\\n 测试技能组\\n test@ccc-test\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取坐席的技能组等级列表', - 'summary' => '获取指定实例下指定坐席关联的技能组的技能等级列表，也可以使用该接口查询坐席可关联但未关联的技能组列表。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifySkillGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"MediaId\\": \\"$iAHNCNQCo21wMwMGBAAFAAbaACOEAaQhIH6TAqogDGyb-qD2Hbj0A88AAAGRLKYVnwTOACwwYwcACM8AAAGRLRPynQ\\",\\n \\"Url\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****\\"\\n },\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"[\'OFFLINE\', \'BREAK,READY,WORKING\']\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取媒体文件上传地址', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'CreateContactFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5466,54 +3815,37 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'SkillGroupId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'skillgroup@ccc-test', - ], + 'schema' => ['description' => '联系流名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '默认流程'], ], [ - 'name' => 'DisplayName', + 'name' => 'Definition', 'in' => 'query', - 'schema' => [ - 'description' => '技能组展示名，长度为1-64个字符。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '新测试技能组', - 'maxLength' => 200, - 'minLength' => 1, - ], + 'schema' => ['description' => 'IVR的内容。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好，欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}'], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '技能组的描述，非必填，默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => '云联络中心的新测试技能组。', - ], + 'schema' => ['description' => '版本描述。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => '流程类型。 '."\n" + .'主流程：MAIN\\_FLOW '."\n" + .'子流程：SUB\\_FLOW '."\n" + .'满意度流程：SURVEY\\_FLOW', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MAIN_FLOW'], ], ], 'responses' => [ @@ -5521,65 +3853,37 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => 'IVR联系流ID。', 'type' => 'string', 'example' => '78128960-bb00-4ddc-8e82-923a8c5bd22d'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.SkillGroupId', - 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', - 'title' => '修改技能组', - 'summary' => '调用ModifySkillGroup修改指定实例下指定技能组ID对应的技能组的信息，主要是修改技能组展示名和技能组的描述信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifySkillLevelsOfUser' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"78128960-bb00-4ddc-8e82-923a8c5bd22d\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\"\\n}","type":"json"}]', + 'title' => '创建联系流', + 'summary' => '创建一个IVR流程。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateContactFlow'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'CreateCustomCallTagging' => [ + 'summary' => '调用CreateCustomCallTagging在指定实例下创建一个或多个呼入号码标记。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5589,126 +3893,94 @@ ], ], 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'SkillLevelList', + 'name' => 'CustomNumberList', 'in' => 'query', - 'schema' => [ - 'description' => '技能组的技能等级列表，格式为JSON数组的字符串，数组元素是一个对象，包含两个字段：skillGroupId和skillLevel，skillGroupId填写想要修改的技能组ID，skillLevel填写想要修改的技能等级，取值范围1-10，值越小，业务能力越强，单位时间内能处理更多的通话。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"skillGroupId":"skillgroup1@ccc-test","skillLevel":1},{"skillGroupId":"skillgroup2@ccc-test","skillLevel":10}]', - ], + 'schema' => ['description' => '呼入控制标记列表，格式为JSON数组的字符串，要求数组元素个数范围为1-10000。数组的元素是一个对象，包括以下属性：number（格式要求为4-32位的数字）、description、callTagNameList，其中callTagNameList是一个数组，元素是号码标签，（确保号码标签是已创建的号码标签）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"number":"1312121****","description":"王先生","callTagNameList":["TagA"]},{"number":"1388888****","description":"张先生","callTagNameList":["TagB"]}]'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E49D8B83-A3EC-44D4-A920-578BC3C698AD', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Data' => [ - 'description' => '数据。', - 'type' => 'string', - 'example' => '无', + 'description' => '创建失败的呼入号码标记列表。', + 'type' => 'array', + 'items' => [ + 'description' => '创建失败的呼入号码标记信息。', + 'type' => 'object', + 'properties' => [ + 'Item' => ['description' => '创建失败的呼入号码标记的号码。', 'type' => 'string', 'example' => '1312121****'], + 'Reason' => [ + 'description' => '呼入号码标记创建失败原因。', + 'type' => 'string', + 'enumValueTitles' => ['CUSTOM_NUMBER_ILLEGAL' => '传入的列表中存在格式不合法的号码', 'CUSTOM_NUMBER_DUPLICATED' => '传入的列表中存在重复的号码', 'CUSTOM_NUMBER_ALREADY_EXISTS' => '传入的列表中存在已创建的号码标记', 'CUSTOM_NUMBER_TAG_NOT_EXIST' => '传入的列表中存在未创建的号码标签', 'CUSTOM_NUMBER_INSERT_DUPLICATED' => '后台写入呼入号码标记时存在重复项', 'CUSTOM_NUMBER_TOO_MANY_TAGS' => '传入的列表中存在超出号码标签个数上限的号码'], + 'example' => 'CUSTOM_NUMBER_DUPLICATED', + ], + ], + 'enumValueTitles' => [], + ], ], ], + 'enumValueTitles' => [], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], ], - 403 => [ - [ - 'errorCode' => 'Permission.User', - 'errorMessage' => 'You have no permission to access user(s) %s.', - ], - [ - 'errorCode' => 'Permission.SkillGroup', - 'errorMessage' => 'You have no permission to access skill group(s) %s.', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.RamId', 'errorMessage' => 'RAM user %s does not exist.', 'description' => '指定的RAM用户不存在。'], ], - [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 409 => [ + ['errorCode' => 'AlreadyExists.CustomNumber', 'errorMessage' => 'Custom number already exists.', 'description' => '呼入号码标记已存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E49D8B83-A3EC-44D4-A920-578BC3C698AD\\",\\n \\"Data\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"E49D8B83-A3EC-44D4-A920-578BC3C698AD\\n无\\n200\\n无\\nOK","errorExample":""}]', - 'title' => '修改坐席的多个技能等级', - 'summary' => '修改指定实例下指定坐席的一个或多个技能组下的技能等级。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RemoveSkillGroupsFromUser' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => [ + 'substitutions' => ['CCC::2020-07-01::CreateCustomCallTaggings'], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '创建多个呼入号码标记', + 'changeSet' => [ + ['createdAt' => '2022-02-24T14:31:19.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomCallTagging'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"Item\\": \\"1312121****\\",\\n \\"Reason\\": \\"CUSTOM_NUMBER_DUPLICATED\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"无\\nBA03159C-E808-4FF1-B27E-A61B6E888D7F\\n200\\n\\n TagA\\n CUSTOM_NUMBER_DUPLICATED\\n\\nOK","errorExample":""}]', + ], + 'CreateInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5719,260 +3991,180 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREcccTMAX45'], + ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例名称，长度4-32个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试实例'], ], [ - 'name' => 'UserId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '实例的描述，长度不超过256个字符。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '云联络中心的测试实例。'], ], [ - 'name' => 'SkillGroupIdList', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '取消关联的技能组ID列表，格式为JSON数组的字符串，数组元素是技能组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]', - ], + 'schema' => ['description' => '云联络中心实例的二级域名，即实例ID，全局唯一。长度为4-48个字符，仅可包含大小写英文字母、数字、下划线（_）和短横线（-）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', + [ + 'name' => 'NumberList', + 'in' => 'query', + 'schema' => ['description' => '待创建的云联络中心实例的号码列表，要求当前账户拥有号码使用权且号码未被其他实例使用。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["0830011xxxx", "0830312xxxx"]'], + ], + [ + 'name' => 'AdminRamIdList', + 'in' => 'query', + 'schema' => ['description' => '作为该云联络中心实例管理员的RAM ID列表，成功创建后，该列表下的RAM ID将自动以管理员的身份导入到新创建的实例中。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["24861380681070****","105980354482****"]'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '数据，返回的是后台创建实例的工作流的ID。', 'type' => 'string', 'example' => '75c1346c-1dc2-4ed8-973f-edf8b1e5fe77'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的号码。'], + ], + 409 => [ + ['errorCode' => 'AlreadyExists.InstanceId', 'errorMessage' => 'The instance %s already exists.', 'description' => '云联络中心实例已存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\nOK","errorExample":""}]', - 'title' => '删除坐席关联的多个技能组', - 'summary' => '调用RemoveSkillGroupsFromUser删除指定实例下指定坐席关联的一个或多个技能组与该坐席之间的关联关系。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ImportRamUsers' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '创建实例', + 'summary' => '调用CreateInstance创建一个云联络中心实例。', + 'changeSet' => [ + ['createdAt' => '2025-10-28T09:55:19.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"75c1346c-1dc2-4ed8-973f-edf8b1e5fe77\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\"\\n}","type":"json"}]', + ], + 'CreateSchema' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => false, 'example' => 'profile'], ], [ - 'name' => 'RoleId', - 'in' => 'query', - 'schema' => [ - 'description' => '角色ID，坐席导入成功后在实例中的角色，包括管理员、技能组组长和坐席三种角色。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Agent@ccc-test'."\n", - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => '信息描述', 'type' => 'string', 'required' => false, 'example' => '-'], ], [ - 'name' => 'SkillLevelList', - 'in' => 'query', + 'name' => 'Properties', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '技能组的技能等级列表，格式为JSON数组的字符串，数组元素是一个对象，包含两个字段：skillGroupId和skillLevel，skillGroupId填写坐席想要关联的技能组ID，skillLevel填写坐席在该技能组的技能等级，取值范围1-10，值越小，业务能力越强，单位时间内能处理更多的通话。', - 'type' => 'string', + 'description' => '字段列表', + 'type' => 'array', + 'items' => [ + 'description' => '字段列表', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '坐席展示名。', 'type' => 'string', 'required' => false, 'example' => '显示名称'], + 'Description' => ['description' => '版本描述。', 'type' => 'string', 'required' => false, 'example' => '-'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'required' => true, 'example' => 'name'], + 'DataType' => ['description' => '数据类型', 'type' => 'string', 'required' => true, 'example' => 'string'], + 'Pattern' => ['description' => '正则表达式校验规则', 'type' => 'string', 'required' => false, 'example' => '*'], + 'PatternErrorMessage' => ['description' => '正则表达式校验错误提示信息', 'type' => 'string', 'required' => false, 'example' => '错误的格式'], + 'MinLength' => ['description' => '最小长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'MaxLength' => ['description' => '最大长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + 'Minimum' => ['description' => '数字最小值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1'], + 'Maximum' => ['description' => '数字最大值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1'], + 'Required' => ['description' => '是否必填', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'Disabled' => ['description' => '是否被禁用', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'Array' => ['description' => '是否是数组', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'ReadOnly' => ['description' => '是否只读', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'EditorType' => ['description' => '编辑器类型', 'type' => 'string', 'required' => false, 'example' => 'textbox'], + 'Attributes' => ['description' => '扩展属性', 'type' => 'string', 'required' => false, 'example' => '{\'Clusters\': {\'Description\': \'The list of clusters.\'}, \'ClusterIds\': {\'Description\': \'The list of cluster IDs.\'}}'], + 'DisplayOrder' => ['description' => '列表展示顺序', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + ], + 'required' => false, + ], 'required' => false, - 'example' => '[{"skillGroupId":"skillgroup@ccc-test","skillLevel":5}]'."\n", ], ], [ - 'name' => 'RamIdList', - 'in' => 'query', - 'schema' => [ - 'description' => '待添加的RAM用户ID列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["28036411123456****","29234301123456****"]'."\n", - ], + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'], ], [ - 'name' => 'WorkMode', - 'in' => 'query', - 'schema' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ON_SITE', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'CreateSchemaResponse', + 'description' => 'CreateSchemaResponse', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => '数据，导入执行ID。', - 'type' => 'string', - 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832'."\n", - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\\\n\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', - 'title' => '从RAM中导入坐席', - 'summary' => '将RAM中已存在的子账号导入为联络中心坐席。', - ], - 'ChangeVisibility' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\",\\n \\"RequestId\\": \\"9F766284-F103-4298-8EC5-19F9F9BE5522\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '创建Schema', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'CreateSkillGroup' => [ + 'summary' => '调用CreateSkillGroup在指定实例下创建一个技能组。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5983,38 +4175,37 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'szpczf', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'sam@szpczf', - ], + 'schema' => ['description' => '技能组名称，长度为1-64个字符，可以包含数字、字母、下划线（_）、短横线（-），必须以字母开头。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup'], ], [ - 'name' => 'Invisible', + 'name' => 'DisplayName', 'in' => 'query', - 'schema' => [ - 'description' => '是否切换为隐身状态。隐身状态和仅外呼含义一致。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '技能组展示名，长度为1-64个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试技能组'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '技能组的描述，非必填，不填默认为空。', 'type' => 'string', 'required' => false, 'example' => '云联络中心的测试技能组。'], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', 'type' => 'string', 'required' => false, 'example' => 'CHAT'], ], ], 'responses' => [ @@ -6022,137 +4213,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => 'Internal service issue. Detail:.', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '24BE19E8-BF7D-4992-A35E-15EBA874F2E5', - ], - 'Params' => [ - 'description' => '响应参数。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'Extension' => [ - 'description' => '座席分机号。'."\n", - 'type' => 'string', - 'example' => '8001****', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'Yealink SIP-T23G 44.84.203.6', - ], - 'JobId' => [ - 'description' => '通话ID，如果该字段有值，说明坐席当前处于通话过程中。', - 'type' => 'string', - 'example' => 'job-330557290544431104', - ], - 'UserId' => [ - 'description' => '座席ID。', - 'type' => 'string', - 'example' => 'sam@szpczf', - ], - 'BreakCode' => [ - 'description' => '小休代码。', - 'type' => 'string', - 'example' => '会议', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'szpczf', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否为仅外呼状态。', - 'type' => 'boolean', - 'example' => 'False', - ], - 'UserState' => [ - 'description' => '用户状态。', - 'type' => 'string', - 'example' => 'Ready', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '技能组ID。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Description' => ['description' => '技能组的描述。', 'type' => 'string', 'example' => '云联络中心的测试技能组。'], + 'Name' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'], + 'SkillGroupId' => ['description' => '技能组ID，格式为：技能组名称@实例ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'MediaType' => ['description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', 'type' => 'string', 'example' => 'VIDEO'], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + 409 => [ + ['errorCode' => 'AlreadyExists.SkillGroupId', 'errorMessage' => 'Skill group %s already exists in instance %s.', 'description' => '云联络中心实例中已经存在指定的技能组。'], + ], + 500 => [ + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Internal service issue. Detail:.\\",\\n \\"RequestId\\": \\"24BE19E8-BF7D-4992-A35E-15EBA874F2E5\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"Yealink SIP-T23G 44.84.203.6\\",\\n \\"JobId\\": \\"job-330557290544431104\\",\\n \\"UserId\\": \\"sam@szpczf\\",\\n \\"BreakCode\\": \\"会议\\",\\n \\"InstanceId\\": \\"szpczf\\",\\n \\"OutboundScenario\\": true,\\n \\"UserState\\": \\"Ready\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup@ccc-test\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => '修改座席可见性', - ], - 'AddSkillGroupsToUser' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '创建技能组', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-06T05:44:50.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSkillGroup'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"Name\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 测试\\n ccc-test\\n skg-test@ccc-test\\n test\\n\\nOK","errorExample":""}]', + ], + 'CreateTicket' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6163,40 +4277,42 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '工单模板ID。', 'type' => 'string', 'required' => false, 'example' => 'e9e4c76c-948d-4a6e-9ce2-9da0f5967a73'], ], [ - 'name' => 'SkillLevelList', + 'name' => 'CustomerId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组的技能等级列表，格式为JSON数组的字符串，数组元素是一个对象，包含两个字段：skillGroupId和skillLevel，skillGroupId填写要添加的技能组ID，skillLevel填写要添加的技能等级，取值范围1-10，值越小，业务能力越强，单位时间内能处理更多的通话。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"skillGroupId":"test1@ccc-test","skillLevel":5},{"skillGroupId":"test2@ccc-test","skillLevel":5}]', - ], + 'schema' => ['description' => '客户ID，云联络中心客户资料中的客户ID。', 'type' => 'string', 'required' => false, 'example' => '51e155ce-3747-4f21-b402-13c69597b920'], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => ['description' => '工单标题。', 'type' => 'string', 'required' => false, 'example' => '售后工单。'], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => '工单来源。', 'type' => 'string', 'required' => false, 'example' => 'CHAT'], + ], + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => false, 'example' => 'job-38860977107324****'], + ], + [ + 'name' => 'Context', + 'in' => 'query', + 'schema' => ['description' => '工单字段信息。', 'type' => 'string', 'required' => false, 'example' => '{"productName":"玩具1"}'], ], ], 'responses' => [ @@ -6204,79 +4320,43 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA7F9545-8312-4190-9BD0-63144B3F1ACC', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A450574A-337F-43E2-BC59-9C6594C994C6'], + 'Data' => ['description' => '返回数据，工单ID。', 'type' => 'string', 'example' => '3d26b90a-c5d2-4b09-8219-60cda1******'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'Permission.SkillGroup', - 'errorMessage' => 'You have no permission to access skill group(s) %s.', - ], - ], - [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.SkillGroupId', - 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA7F9545-8312-4190-9BD0-63144B3F1ACC\\"\\n}","errorExample":""},{"type":"xml","example":"BA7F9545-8312-4190-9BD0-63144B3F1ACC\\n无\\n200\\n无\\nOK","errorExample":""}]', - 'title' => '添加多个技能组到坐席', - 'summary' => '调用AddSkillGroupsToUser添加一个或多个技能组到指定实例下的指定坐席。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'AssignUsers' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"A450574A-337F-43E2-BC59-9C6594C994C6\\",\\n \\"Data\\": \\"3d26b90a-c5d2-4b09-8219-60cda1******\\"\\n}","type":"json"}]', + 'title' => '创建工单', + 'summary' => '使用CreateTicket创建工单。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'CreateUser' => [ + 'summary' => '调用CreateUser在指定实例下创建一个新的坐席。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6286,51 +4366,38 @@ ], ], 'operationType' => 'write', - 'deprecated' => true, - 'systemTags' => [], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'RoleId', + 'name' => 'LoginName', 'in' => 'query', - 'schema' => [ - 'description' => '角色ID，坐席导入成功后在实例中的角色，包括管理员、技能组组长和坐席三种角色。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Agent@ccc-test', - ], + 'schema' => ['description' => '坐席登录名，长度为4-64个字符，可包含英文大小写字母、数字、英文句点“.”、下划线“_”或短划线“-”。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent'], ], [ - 'name' => 'SkillLevelList', + 'name' => 'DisplayName', 'in' => 'query', - 'schema' => [ - 'description' => '技能组的技能等级列表，格式为JSON数组的字符串，数组元素是一个对象，包含两个字段：skillGroupId和skillLevel，skillGroupId填写坐席想要关联的技能组ID，skillLevel填写坐席在该技能组的技能等级，取值范围1-10，值越小，业务能力越强，单位时间内能处理更多的通话。', - 'type' => 'string', - 'required' => false, - 'example' => '[{"skillGroupId":"skillgroup@ccc-test","skillLevel":5}]', - ], + 'schema' => ['description' => '坐席展示名，长度为1-128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '坐席小王', 'maxLength' => 500, 'minLength' => 0], ], [ - 'name' => 'RamIdList', + 'name' => 'Mobile', 'in' => 'query', - 'schema' => [ - 'description' => '待添加的RAM用户ID列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["28036411123456****","29234301123456****"]', - ], + 'schema' => ['description' => '坐席的个人电话号码，该号码在场外模式下会用到，坐席可以使用该号码进行场外模式接听。', 'type' => 'string', 'required' => false, 'example' => '1382114****'], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => ['description' => '坐席邮箱地址，坐席创建成功后会发送邮件到该邮箱，邮件中包含云联络中心登录地址，以及RAM账户的用户名和密码，请妥善保管。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'], ], [ 'name' => 'WorkMode', @@ -6338,187 +4405,50 @@ 'schema' => [ 'description' => '工作模式。', 'type' => 'string', - 'required' => true, + 'required' => false, 'docRequired' => true, - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], 'example' => 'ON_SITE', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => '数据，内容与工作流ID相同。', - 'type' => 'string', - 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'WorkflowId' => [ - 'description' => '工作流ID。', - 'type' => 'string', - 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'staticInfo' => [ - 'substitutions' => [ - 'CCC::2020-07-01::ImportRamUsers', - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Code\\": \\"OK\\",\\n \\"WorkflowId\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n1ca2b084-6f0a-454b-9851-29768a9a5832\\n1ca2b084-6f0a-454b-9851-29768a9a5832\\n无\\nOK","errorExample":""}]', - 'title' => '导入多个坐席', - 'summary' => '调用AssignUsers将一个或多个RAM账户导入到指定实例中，成功导入后，RAM账户将以坐席的形式存在于实例中。', - 'description' => '拥有RAM权限的账号可以到RAM控制台查询阿里云主账号下管理的所有RAM子账号，RAM控制台地址：https://ram.console.aliyun.com/users', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ChangeWorkMode' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], [ - 'BearerToken' => [], + 'name' => 'RoleId', + 'in' => 'query', + 'schema' => ['description' => '角色ID，格式为：角色@实例ID，包含三种角色：Admin（管理员）、Manager（技能组组长）、Agent（坐席）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Agent@ccc-test'], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'SkillLevelList', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '技能组的技能等级列表，格式为JSON数组的字符串，数组元素最大为100个，数组元素是一个对象，包含两个字段：skillGroupId和skillLevel，skillGroupId填写要添加的技能组ID，skillLevel填写要添加的技能等级，取值范围1-10，值越小，业务能力越强，单位时间内能处理更多的通话。', 'type' => 'string', 'required' => false, 'example' => '[{"skillGroupId":"skillgroup1@ccc-test","skillLevel":1},{"skillGroupId":"skillgroup2@ccc-test","skillLevel":10}]'], ], [ - 'name' => 'UserId', + 'name' => 'ResetPassword', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID，不填默认使用当前RAM账号映射的坐席。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '首次登录时是否需要重置密码，如果为true，则在首次登录RAM账户时会提示重置密码，否则不提示。默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'DeviceId', + 'name' => 'DisplayId', 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'required' => false, - 'example' => 'ACC-YUNBS-1.0.10-****', - ], + 'schema' => ['description' => '坐席的工号，客户可根据需要自行设置。', 'type' => 'string', 'required' => false, 'example' => '1001'], ], [ - 'name' => 'WorkMode', + 'name' => 'AvatarUrl', 'in' => 'query', - 'schema' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], + 'schema' => ['description' => '坐席头像地址。', 'type' => 'string', 'required' => false, 'example' => 'http://abc.com/sam.jpg'], ], [ - 'name' => 'SignedSkillGroupIdList', + 'name' => 'Nickname', 'in' => 'query', - 'schema' => [ - 'description' => '需要签入的技能组列表。当修改工作模式到场外模式时，可以通过此参数指定场外座席需要签入的技能组列表。', - 'type' => 'string', - 'required' => false, - 'example' => '["online-1@ccc-test","online-2@ccc-test","online-3@ccc-test","skg-default@ccc-test"]', - ], + 'schema' => ['description' => '座席昵称。', 'type' => 'string', 'required' => false, 'example' => '老王'], ], [ - 'name' => 'Mobile', + 'name' => 'NeedEmailNotification', 'in' => 'query', - 'schema' => [ - 'description' => '坐席的个人电话号码，该号码在场外模式下会用到，坐席可以使用该号码进行场外模式接听。', - 'type' => 'string', - 'required' => false, - 'example' => '1382114****', - ], + 'schema' => ['title' => '是否需要邮件通知。'."\n" + .'- true: 发送'."\n" + .'- false: 不发送', 'description' => '是否需要邮件通知。'."\n" + .'- true: 发送'."\n" + .'- false: 不发送', 'type' => 'string', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -6526,148 +4456,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => '87731ED1-6224-48A5-99E3-6237FF9B1C00', - ], - 'Params' => [ - 'description' => '响应参数。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], 'Data' => [ - 'description' => '数据。'."\n", + 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'Extension' => [ - 'description' => '座席分机号。'."\n", - 'type' => 'string', - 'example' => '8001****', - ], + 'DisplayName' => ['description' => '坐席展示名。', 'type' => 'string', 'example' => '坐席小王'], + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'], + 'LoginName' => ['description' => '坐席登录名。', 'type' => 'string', 'example' => 'agent'], 'WorkMode' => [ 'description' => '工作模式。', 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], 'example' => 'ON_SITE', ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'JobId' => [ - 'description' => '通话ID，如果该字段有值，说明坐席当前处于通话过程中。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休码包括：Warm-up'."\n" - .'（坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否开启了仅外呼模式。'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'UserState' => [ - 'description' => '座席状态。'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'OFFLINE', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - ], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1382114****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'AvatarUrl' => ['description' => '坐席头像地址。', 'type' => 'string', 'example' => 'http://abc.com/sam.jpg'], + 'Nickname' => ['description' => '座席昵称。', 'type' => 'string', 'example' => '老王。'], ], ], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ], + 403 => [ + ['errorCode' => 'Permission.StsToken', 'errorMessage' => 'You have no permission to access sts token %s.', 'description' => '您无权访问STS Token。'], + ], + [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.RoleId', 'errorMessage' => 'Role %s does not exist.', 'description' => '指定的角色不存在。'], + ], + 409 => [ + ['errorCode' => 'AlreadyExists.User', 'errorMessage' => 'User %s already exists in instance %s.', 'description' => '云联络中心实例下已存在指定的用户。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"87731ED1-6224-48A5-99E3-6237FF9B1C00\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"OFFLINE\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"87731ED1-6224-48A5-99E3-6237FF9B1C00\\n无\\n200\\n无\\n\\n 80011474\\n OFFLINE\\n ccc-test\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bs990cd82101cc000176af19ec8e\\n Warm-up\\n false\\n ON_SITE\\n 无\\n [\\"skill-group@ccc-test\\"]\\n\\nOK","errorExample":""}]', - 'title' => '改变坐席工作模式', - 'summary' => '调用ChangeWorkMode改变坐席的工作模式。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"Extension\\": \\"8032****\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"AvatarUrl\\": \\"http://abc.com/sam.jpg\\",\\n \\"Nickname\\": \\"老王。\\"\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n无\\n\\n 8032****\\n user-test-1\\n 1886666****@163.com\\n user-test-1@ccc-test\\n 云呼测试1\\n 1382114****\\n ON_SITE\\n\\nOK","errorExample":""}]', + 'title' => '创建坐席', + 'description' => '创建坐席实际上就是创建一个RAM子账户，云联络中心的坐席与RAM子账户是相互映射的，所以创建时传入的参数就和创建RAM账户时类似，比如：LoginName就是RAM账号的登录名，Email就是创建RAM账号时预留的邮箱，该邮箱会接收到带有RAM账户初始登录密码的邮件。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateUser' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-12-22T03:22:03.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-07T07:21:07.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2021-12-21T09:15:55.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUser'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'DeleteAudioFile' => [ + 'summary' => '调用DeleteAudioFile删除指定实例下指定音频资源ID对应的音频文件。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6678,292 +4540,130 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'LoginName', + 'name' => 'AudioResourceId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席登录名，长度为4-64个字符，可包含英文大小写字母、数字、英文句点“.”、下划线“_”或短划线“-”。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent', - ], + 'schema' => ['description' => '音频资源ID，音频文件的唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77'], ], - [ - 'name' => 'DisplayName', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席展示名，长度为1-128个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '坐席小王', - 'maxLength' => 500, - 'minLength' => 0, - ], - ], - [ - 'name' => 'Mobile', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席的个人电话号码，该号码在场外模式下会用到，坐席可以使用该号码进行场外模式接听。', - 'type' => 'string', - 'required' => false, - 'example' => '1382114****', - ], - ], - [ - 'name' => 'Email', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席邮箱地址，坐席创建成功后会发送邮件到该邮箱，邮件中包含云联络中心登录地址，以及RAM账户的用户名和密码，请妥善保管。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'username@example.com', - ], - ], - [ - 'name' => 'WorkMode', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FB77821C-912F-57FF-8834-6336A6479093'], ], - 'example' => 'ON_SITE', + 'description' => '', ], ], - [ - 'name' => 'RoleId', - 'in' => 'query', - 'schema' => [ - 'description' => '角色ID，格式为：角色@实例ID，包含三种角色：Admin（管理员）、Manager（技能组组长）、Agent（坐席）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Agent@ccc-test', - ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], - [ - 'name' => 'SkillLevelList', - 'in' => 'query', - 'schema' => [ - 'description' => '技能组的技能等级列表，格式为JSON数组的字符串，数组元素最大为100个，数组元素是一个对象，包含两个字段：skillGroupId和skillLevel，skillGroupId填写要添加的技能组ID，skillLevel填写要添加的技能等级，取值范围1-10，值越小，业务能力越强，单位时间内能处理更多的通话。', - 'type' => 'string', - 'required' => false, - 'example' => '[{"skillGroupId":"skillgroup1@ccc-test","skillLevel":1},{"skillGroupId":"skillgroup2@ccc-test","skillLevel":10}]', - ], + ], + 'title' => '删除音频文件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAudioFile'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"FB77821C-912F-57FF-8834-6336A6479093\\"\\n}","type":"json"}]', + ], + 'DeleteCallTag' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ResetPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '首次登录时是否需要重置密码，如果为true，则在首次登录RAM账户时会提示重置密码，否则不提示。默认为false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'AK' => [], ], [ - 'name' => 'DisplayId', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席的工号，客户可根据需要自行设置。', - 'type' => 'string', - 'required' => false, - 'example' => '1001', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], + 'parameters' => [ [ - 'name' => 'AvatarUrl', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席头像地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'http://abc.com/sam.jpg', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Nickname', + 'name' => 'TagName', 'in' => 'query', - 'schema' => [ - 'description' => '座席昵称。', - 'type' => 'string', - 'required' => false, - 'example' => '老王', - ], + 'schema' => ['description' => '号码标签名称，请确保传入的标签是已创建的号码标签。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TagA'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '坐席展示名。', - 'type' => 'string', - 'example' => '坐席小王', - ], - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Email' => [ - 'description' => '邮箱。', - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'LoginName' => [ - 'description' => '坐席登录名。', - 'type' => 'string', - 'example' => 'agent', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1382114****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'AvatarUrl' => [ - 'description' => '坐席头像地址。', - 'type' => 'string', - 'example' => 'http://abc.com/sam.jpg', - ], - 'Nickname' => [ - 'description' => '座席昵称。', - 'type' => 'string', - 'example' => '老王。', - ], - ], - ], - 'Params' => [ - 'description' => '响应参数。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], ], - 403 => [ - [ - 'errorCode' => 'Permission.StsToken', - 'errorMessage' => 'You have no permission to access sts token %s.', - ], - ], - [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.RoleId', - 'errorMessage' => 'Role %s does not exist.', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], - 409 => [ - [ - 'errorCode' => 'AlreadyExists.User', - 'errorMessage' => 'User %s already exists in instance %s.', - ], + 500 => [ + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"Extension\\": \\"8032****\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"AvatarUrl\\": \\"http://abc.com/sam.jpg\\",\\n \\"Nickname\\": \\"老王。\\"\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n无\\n\\n 8032****\\n user-test-1\\n 1886666****@163.com\\n user-test-1@ccc-test\\n 云呼测试1\\n 1382114****\\n ON_SITE\\n\\nOK","errorExample":""}]', - 'title' => '创建坐席', - 'summary' => '调用CreateUser在指定实例下创建一个新的坐席。', - 'description' => '创建坐席实际上就是创建一个RAM子账户，云联络中心的坐席与RAM子账户是相互映射的，所以创建时传入的参数就和创建RAM账户时类似，比如：LoginName就是RAM账号的登录名，Email就是创建RAM账号时预留的邮箱，该邮箱会接收到带有RAM账户初始登录密码的邮件。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetUser' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '删除号码标签', + 'summary' => '调用DeleteCallTag删除指定实例下的号码标签。', + 'changeSet' => [ + ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCallTag'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"无\\nEEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n200\\nOK","errorExample":""}]', + ], + 'DeleteContactFlow' => [ + 'summary' => '删除指定联系流。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6972,40 +4672,29 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'ContactFlowId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID，选填，UserId和Extension任选一个填写即可。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '联系流ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0f87c997-b0c1-41d4-9e9e-1b791de6ad1f'], ], [ - 'name' => 'Extension', + 'name' => 'Force', 'in' => 'query', - 'schema' => [ - 'description' => '坐席分机号，选填，UserId和Extension任选一个填写即可。', - 'type' => 'string', - 'required' => false, - 'example' => '8003****', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''], ], ], 'responses' => [ @@ -7013,165 +4702,36 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '坐席展示名。', - 'type' => 'string', - 'example' => '坐席小王', - ], - 'DisplayId' => [ - 'description' => '坐席的工号。', - 'type' => 'string', - 'example' => '1001', - ], - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8003****', - ], - 'LoginName' => [ - 'description' => '坐席登录名。', - 'type' => 'string', - 'example' => 'agent', - ], - 'Email' => [ - 'description' => '邮箱。', - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1391234****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'RoleName' => [ - 'description' => '角色名称。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Agent' => '坐席', - 'Admin' => '管理员', - 'Manager' => '技能组组长', - ], - 'example' => 'Admin', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'RoleId' => [ - 'description' => '角色ID，格式为：角色@实例ID。', - 'type' => 'string', - 'example' => 'Admin@ccc-test', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'DeviceExt' => [ - 'description' => 'SIP话机分机号，如果座席注册了SIP话机，则此参数为SIP话机设备的分机号。', - 'type' => 'string', - 'example' => '8033****', - ], - 'DeviceState' => [ - 'description' => 'SIP话机设备的状态，如果未注册SIP话机，则状态为UNREGISTERED（未注册），如果SIP话机注册过但是不在线，则状态为OFFLINE（离线），如果SIP话机注册过并且在线则为ONLINE（在线）。', - 'type' => 'string', - 'enumValueTitles' => [ - 'UNREGISTERED' => '未注册', - 'OFFLINE' => '离线', - 'ONLINE' => '在线', - ], - 'example' => 'OFFLINE', - ], - 'Nickname' => [ - 'description' => '坐席昵称', - 'type' => 'string', - 'example' => '阿云', - ], - 'AvatarUrl' => [ - 'description' => '坐席头像地址。', - 'type' => 'string', - 'example' => 'http://xxx.com/xxx.jpg', - ], - ], - ], - 'Params' => [ - 'description' => '扩展参数', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '07511949-6DC4-5D0B-8FA8-FF8FA29B4217'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"DisplayId\\": \\"1001\\",\\n \\"Extension\\": \\"8003****\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1391234****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"DeviceExt\\": \\"8033****\\",\\n \\"DeviceState\\": \\"OFFLINE\\",\\n \\"Nickname\\": \\"阿云\\",\\n \\"AvatarUrl\\": \\"http://xxx.com/xxx.jpg\\"\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n 80xxxx91\\n user-test\\n OFFLINE\\n Admin\\n user-test@aliyun-cc.com\\n ccc-test\\n Yealink SIP-T23G 44.84.203.6\\n user-test@ccc-test\\n 测试用户\\n 80xxxx33\\n Admin@ccc-test\\n 139xxxx1234\\n ON_SITE\\n\\nOK","errorExample":""}]', - 'title' => '获取坐席', - 'summary' => '调用GetUser获取指定实例下指定坐席ID对应的坐席信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ImportAdmins' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '删除联系流', + 'changeSet' => [ + ['createdAt' => '2025-06-18T03:18:59.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContactFlow'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"07511949-6DC4-5D0B-8FA8-FF8FA29B4217\\"\\n}","type":"json"}]', + ], + 'DeleteCustomCallTagging' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7182,520 +4742,204 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' ccc-test'], ], [ - 'name' => 'RamIdList', + 'name' => 'Number', 'in' => 'query', - 'schema' => [ - 'description' => '阿里云RAM账户的UID列表，格式为JSON数组的字符串，数组元素最多20个。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["26972543893791****"]', - ], + 'schema' => ['description' => '号码呼入标记的号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312121****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '响应数据', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1CDB5C94-ACFB-59B5-85FE-C1DAF8049C63', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'RoleId' => [ - 'description' => '角色ID。', - 'type' => 'string', - 'example' => 'Admin@ccc-test', - ], - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8021****', - ], - 'RamId' => [ - 'description' => '阿里云RAM账户的UID。', - 'type' => 'string', - 'example' => '26972543893791****', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1CDB5C94-ACFB-59B5-85FE-C1DAF8049C63\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"Extension\\": \\"8021****\\",\\n \\"RamId\\": \\"26972543893791****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '导入多个管理员', - 'summary' => '调用ImportAdmins导入一个或多个管理员到指定实例下，调用者需要拥有AliyunCCCFullAccess的权限，可以在RAM控制台进行授权。', - ], - 'ListDevices' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '删除呼入号码标记', + 'summary' => '调用DeleteCustomCallTagging删除指定实例下指定号码对应的呼入号码标记。', + 'changeSet' => [ + ['createdAt' => '2022-02-24T14:31:19.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomCallTagging'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"无\\nBA03159C-E808-4FF1-B27E-A61B6E888D7F\\n200\\nOK","errorExample":""}]', + ], + 'DeleteDocument' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'name' => 'SchemaId', + 'in' => 'formData', + 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'], ], [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'name' => 'DocumentId', + 'in' => 'formData', + 'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => true, 'example' => 'xxx'], + ], + [ + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012****'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'DeleteDocumentResponse', + 'description' => 'DeleteDocumentResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息'."\n" + ."\n", 'type' => 'string', 'example' => '无'], 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - 'Data' => [ - 'description' => '设备列表。', + 'description' => '响应参数。', 'type' => 'array', - 'items' => [ - 'description' => '设备信息。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Expires' => [ - 'description' => '设备注册过期时间，格式为Unix时间戳，单位毫秒，如果设备过期未重新注册，则会导致设备离线。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609118499750', - ], - 'Contact' => [ - 'description' => '设备地址信息。', - 'type' => 'string', - 'example' => 'sip:8032****@33.89.XX.XX:64189;transport=tcp;registering_acc=18_134_23_4', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'CallId' => [ - 'description' => '设备发起的注册信令中的Call ID。', - 'type' => 'string', - 'example' => 'd7b818c3-8d3a-732f-bc9e-1782wa16****', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'DeviceType' => [ - 'description' => '设备类型', - 'type' => 'string', - 'example' => 'CHAT', - ], - ], - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Permission.User', - 'errorMessage' => 'You have no permission to access user(s) %s.', - ], - ], - [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": [\\n {\\n \\"Extension\\": \\"8032****\\",\\n \\"Expires\\": 1609118499750,\\n \\"Contact\\": \\"sip:8032****@33.89.XX.XX:64189;transport=tcp;registering_acc=18_134_23_4\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"CallId\\": \\"d7b818c3-8d3a-732f-bc9e-1782wa16****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"DeviceType\\": \\"CHAT\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n 80326034\\n ccc-test\\n user-test@ccc-test\\n BS-2020-09-01-11:11:11.888-192_168_12_123\\n 561d53be3fa11c4700a40ce8592ef880@0:0:0:0:0:0:0:0\\n 1609118499750\\n sip:80326034@33.89.9.338:64189;transport=tcp;registering_acc=18_134_23_4\\n\\nOK","errorExample":""}]', - 'title' => '获取设备列表', - 'summary' => '获取指定实例下指定坐席的设备列表。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListRamUsers' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '删除文档', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'DeleteDocuments' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n" - ."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test ', - ], + 'name' => 'SchemaId', + 'in' => 'formData', + 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'], ], [ - 'name' => 'SearchPattern', - 'in' => 'query', + 'name' => 'DocumentIds', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '根据坐席登录名或坐席展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', + 'description' => '文档id列表', + 'type' => 'array', + 'items' => ['description' => '文档id', 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'required' => false, - 'docRequired' => false, - 'example' => 'agent', ], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-1000。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100000', - 'minimum' => '1', - 'example' => '1', - ], + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3'], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'DeleteDocumentsResponse', + 'description' => 'DeleteDocumentsResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n" - ."\n", - 'type' => 'string', - 'example' => '24753D71-C91D-1A38-A8AD-372BF12453F6', - ], - 'Data' => [ - 'description' => '数据。'."\n" - ."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-1000。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'List' => [ - 'description' => 'RAM用户列表。'."\n" - ."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'RAM用户', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => 'RAM账户姓名。', - 'type' => 'string', - 'example' => '测试账号', - ], - 'Email' => [ - 'description' => '邮箱。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'LoginName' => [ - 'description' => 'RAM用户名。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'agent', - ], - 'Mobile' => [ - 'description' => 'RAM账户预留的个人电话号码。', - 'type' => 'string', - 'example' => '1382114****', - ], - 'AliyunUid' => [ - 'description' => 'RAM账户所属的阿里云主账号UID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15772400000****', - ], - 'Primary' => [ - 'description' => 'RAM账号是否为主账号。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'RamId' => [ - 'description' => 'RAM用户的UID。', - 'type' => 'string', - 'example' => '28036411123456****', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A450574A-337F-43E2-BC59-9C6594C994C6'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Params' => [ + 'description' => '参数信息。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"24753D71-C91D-1A38-A8AD-372BF12453F6\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"测试账号\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"AliyunUid\\": 0,\\n \\"Primary\\": false,\\n \\"RamId\\": \\"28036411123456****\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"24753D71-C91D-1A38-A8AD-372BF12453F6\\n无\\n200\\n无\\n\\n 1\\n 10\\n 1\\n \\n user-test\\n 1886666****@163.com\\t\\n false\\n 157724000000000\\n 28036411123456xxxx\\n 测试用户\\t\\n 1382114****\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取RAM用户列表', - 'summary' => '调用ListRamUsers获取未导入指定实例下的RAM用户列表。', - 'description' => '一个RAM用户可以作为坐席导入到多个实例下，但是一个坐席只能指向一个RAM账户，如果我们在实例下创建坐席，实际上是创建了一个RAM账户的，此时如果想创建一个新的实例又不想创建多余的RAM账户，就可以调用ListRamUsers接口获取未导入实例下的RAM用户列表，然后再调用导入RAM用户的接口将RAM用户导入到实例下。这样可以避免过多的创建RAM账户，造成资源浪费。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListUserLevelsOfSkillGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A450574A-337F-43E2-BC59-9C6594C994C6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '删除文档（批量）', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'DeleteInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7704,310 +4948,214 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '251524', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], - [ - 'name' => 'SkillGroupId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'skillgroup@ccc-test', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '返回结果，删除任务ID。', 'type' => 'string', 'example' => 'b7feb007-994a-497f-8934-2f0c6f89867c'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"b7feb007-994a-497f-8934-2f0c6f89867c\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '删除实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + ], + 'DeleteSchema' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IsMember', - 'in' => 'query', - 'schema' => [ - 'description' => '是否与传入的技能组关联，如果值为true，表示获取SkillgroupId关联的坐席的技能等级列表，如果值为false，表示获取可关联但未关联SkillgroupId的坐席列表。默认值为true。', - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'name' => 'SchemaId', + 'in' => 'formData', + 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3'], ], [ - 'name' => 'SearchPattern', - 'in' => 'query', - 'schema' => [ - 'description' => '根据坐席登录名或坐席展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', - 'required' => false, - 'example' => '测试坐席', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'DeleteSchemaResponse', + 'description' => 'DeleteSchemaResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'List' => [ - 'description' => '技能等级列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能等级信息。', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '坐席展示名。', - 'type' => 'string', - 'example' => '坐席小王', - ], - 'SkillLevel' => [ - 'description' => '坐席技能等级。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'LoginName' => [ - 'description' => '坐席登录名。', - 'type' => 'string', - 'example' => 'agent', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => 'skillgroup', - ], - 'RoleName' => [ - 'description' => '角色名称。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Agent' => '坐席', - 'Admin' => '管理员', - 'Manager' => '技能组组长', - ], - 'example' => 'Admin', - ], - 'RoleId' => [ - 'description' => '角色ID，格式为：角色@实例ID。', - 'type' => 'string', - 'example' => 'Admin@ccc-test', - ], - 'RamId' => [ - 'description' => '用户的RAM账号。', - 'type' => 'string', - 'example' => '28036411123456****', - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.SkillGroupId', - 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"SkillLevel\\": 5,\\n \\"LoginName\\": \\"agent\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"RamId\\": \\"28036411123456****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n user-test\\n Admin\\n 5\\n Default\\n user-test@ccc-test\\n 测试坐席\\n skg-default@ccc-test\\n Admin@ccc-test\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取技能组的坐席等级列表', - 'summary' => '调用ListUserLevelsOfSkillGroup获取指定实例下指定技能组下属的坐席技能等级列表，也可以调用该接口反差可关联但未关联指定技能组的坐席列表。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListUsers' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"678F7002-CA01-4ABF-A112-585AFBDF3A3B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '删除Schema', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'DeleteSchemaProperty' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], 'parameters' => [ + [ + 'name' => 'SchemaId', + 'in' => 'formData', + 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'], + ], + [ + 'name' => 'PropertyName', + 'in' => 'formData', + 'schema' => ['description' => '字段名', 'type' => 'string', 'required' => true, 'example' => 'name'], + ], + [ + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'], + ], [ 'name' => 'InstanceId', - 'in' => 'query', + 'in' => 'formData', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', + 'title' => 'DeleteSchemaPropertyResponse', + 'description' => 'DeleteSchemaPropertyResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'User 244715989906081477 does not exist in instance worldfirst01.'], + 'Params' => [ + 'description' => '错误参数信息', + 'type' => 'array', + 'items' => ['description' => '错误参数', 'type' => 'string', 'example' => 'id格式错误'], + ], + ], ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"User 244715989906081477 does not exist in instance worldfirst01.\\",\\n \\"Params\\": [\\n \\"id格式错误\\"\\n ]\\n}","type":"json"}]', + 'title' => '删除Scheme字段', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + ], + 'DeleteSkillGroup' => [ + 'summary' => '调用DeleteSkillGroup删除指定实例下指定技能组ID对应的技能组。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SearchPattern', - 'in' => 'query', - 'schema' => [ - 'description' => '根据坐席登录名或坐席展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'agent', - ], + 'AK' => [], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], + ], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ankedayaopin@zcwlwhkf', - ], + 'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => ['description' => '是否强制删除，如果技能组关联了号码或坐席，需要启用强制删除标志才能删除成功。', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'example' => 'true', 'default' => 'false'], ], ], 'responses' => [ @@ -8015,746 +5163,282 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'List' => [ - 'description' => '坐席列表。', - 'type' => 'array', - 'items' => [ - 'description' => '坐席信息。', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '坐席展示名。', - 'type' => 'string', - 'example' => '坐席小王', - ], - 'LoginName' => [ - 'description' => '坐席登录名。', - 'type' => 'string', - 'example' => 'agent', - ], - 'Email' => [ - 'description' => '邮箱。', - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1382114****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'DisplayId' => [ - 'description' => '坐席的工号。', - 'type' => 'string', - 'example' => '1001', - ], - 'RoleName' => [ - 'description' => '角色名称。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Mannager' => '技能组组长', - 'Agent' => '坐席', - 'Admin' => '管理员', - ], - 'example' => 'Admin', - ], - 'RoleId' => [ - 'description' => '角色ID，格式为：角色@实例ID。', - 'type' => 'string', - 'example' => 'Admin@ccc-test', - ], - 'PrimaryAccount' => [ - 'description' => '坐席映射的RAM账户是否为RAM主账号。', - 'type' => 'boolean', - 'example' => '已弃用，请使用Primary代替此参数。', - 'default' => '已弃用，请使用Primary代替此参数', - ], - 'PersonalOutboundNumberList' => [ - 'description' => '坐席个人外呼号码列表。', - 'type' => 'array', - 'items' => [ - 'description' => '号码信息。', - 'type' => 'object', - 'properties' => [ - 'Number' => [ - 'description' => '号码。', - 'type' => 'string', - 'example' => '0830011****', - ], - 'Active' => [ - 'description' => '是否可用。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'City' => [ - 'description' => '号码归属地市。', - 'type' => 'string', - 'example' => '乐山', - ], - 'Usage' => [ - 'description' => '号码用途。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Outbound' => '呼出', - 'Inbound' => '呼入', - 'Bidirection' => '呼入及呼出', - ], - 'example' => 'Bidirection', - ], - 'Province' => [ - 'description' => '号码归属地省。', - 'type' => 'string', - 'example' => '四川', - ], - ], - ], - ], - 'SkillLevelList' => [ - 'description' => '坐席关联的技能组等级列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组等级信息。', - 'type' => 'object', - 'properties' => [ - 'SkillLevel' => [ - 'description' => '技能等级。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => 'skillgroup', - ], - ], - ], - ], - 'RamId' => [ - 'description' => '坐席关联的RAM账号的UID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21234502254620****', - ], - 'Extension' => [ - 'description' => '座机分机号。', - 'type' => 'string', - 'example' => '8031****', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'DeviceExt' => [ - 'description' => 'SIP话机分机号，如果座席注册了SIP话机，则此参数为SIP话机设备的分机号。', - 'type' => 'string', - 'example' => '8033****', - ], - 'DeviceState' => [ - 'description' => 'SIP话机设备的状态，如果未注册SIP话机，则状态为UNREGISTERED（未注册），如过SIP话机注册过但是不在线，则状态为OFFLINE（离线），如果SIP话机注册过并且在线则为ONLINE（在线）。', - 'type' => 'string', - 'enumValueTitles' => [ - 'UNREGISTERED' => '未注册', - 'OFFLINE' => '离线', - 'ONLINE' => '在线', - ], - 'example' => 'OFFLINE', - ], - 'Primary' => [ - 'description' => '坐席映射的RAM账户是否为RAM主账号。', - 'type' => 'boolean', - ], - ], - ], - ], - ], - ], - 'Params' => [ - 'description' => '响应参数。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ['errorCode' => 'InUse.SkillGroup', 'errorMessage' => 'Skill group %s is in use now.', 'description' => '技能组正在被使用，该状态表明技能组可能关联着号码或坐席。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"DisplayId\\": \\"1001\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"PrimaryAccount\\": true,\\n \\"PersonalOutboundNumberList\\": [\\n {\\n \\"Number\\": \\"0830011****\\",\\n \\"Active\\": true,\\n \\"City\\": \\"乐山\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ],\\n \\"SkillLevelList\\": [\\n {\\n \\"SkillLevel\\": 5,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\"\\n }\\n ],\\n \\"RamId\\": 0,\\n \\"Extension\\": \\"8031****\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"DeviceExt\\": \\"8033****\\",\\n \\"DeviceState\\": \\"OFFLINE\\",\\n \\"Primary\\": true\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n 1\\n 10\\n 1\\n \\n user-test\\n 1886666****@163.com\\n Yealink SIP-T23G 44.84.203.6\\n false\\n 2022546208793\\n 1001\\n Admin@ccc-test\\n 1382114****\\n 80xxxx31\\n OFFLINE\\n Admin\\n user-test@ccc-test\\n 测试用户\\n 80xxxx33\\n ON_SITE\\n \\n Bidirection\\n true\\n 083xxxx0011\\n 乐山\\n 四川\\n \\n \\n skg-test\\n 5\\n skg-test@ccc-test\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '获取坐席列表', - 'summary' => '调用ListUsers获取指定实例下的坐席列表。', + 'title' => '删除技能组', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyUser' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSkillGroup'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', + ], + 'DeleteTicket' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'UserId', + 'name' => 'TicketId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'user-test@ccc-test', - ], + 'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => false, 'example' => '3d26b90a-c5d2-4b09-8219-********'], ], [ - 'name' => 'Mobile', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席个人电话号码。', - 'type' => 'string', - 'required' => false, - 'example' => '1382114****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], - [ - 'name' => 'WorkMode', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', + 'title' => 'DeleteTicketResponse', + 'description' => 'DeleteTicketResponse', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => '响应数据。', 'type' => 'any', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数', 'type' => 'string', 'example' => '无'], + ], ], - 'example' => 'ON_SITE', - ], - ], - [ - 'name' => 'RoleId', - 'in' => 'query', - 'schema' => [ - 'description' => '角色ID，格式为：角色@实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Admin@ccc-test', - ], - ], - [ - 'name' => 'DisplayId', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席的工号。', - 'type' => 'string', - 'required' => false, - 'example' => '1001', ], ], - [ - 'name' => 'DisplayName', - 'in' => 'query', - 'schema' => [ - 'description' => '用户的全名', - 'type' => 'string', - 'required' => false, - 'example' => '张三疯', - ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '删除工单', + 'summary' => '通过DeleteTicket删除指定工单。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + ], + 'DeleteTicketTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Force', - 'in' => 'query', - 'schema' => [ - 'description' => '是否强制修改。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'Nickname', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席昵称', - 'type' => 'string', - 'required' => false, - 'example' => '老王', - ], + 'schema' => ['description' => '工单模板ID。', 'type' => 'string', 'required' => false, 'example' => '**43c2671b-8939-4223-***-6bd187905cc8_1717664210492'], ], [ - 'name' => 'AvatarUrl', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席头像地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'http://abc.com/sam.jpb', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'DeleteTicketTemplateResponse', + 'description' => 'DeleteTicketTemplateResponse', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'string', - 'example' => '无', - ], + 'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Params' => [ - 'description' => '响应参数。', + 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Permission.Common', - 'errorMessage' => 'You have no permission to access. %s', - ], - [ - 'errorCode' => 'Permission.SkillGroup', - 'errorMessage' => 'You have no permission to access skill group(s) %s.', - ], - ], - [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.RoleId', - 'errorMessage' => 'Role %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n无\\nOK","errorExample":""}]', - 'title' => '修改坐席', - 'summary' => '调用ModifyUser修改指定实例下指定坐席的信息，可修改电话号码、工作模式、角色和工号。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyUserLevelsOfSkillGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '删除工单模板', + 'summary' => '使用DeleteTicketTemplate删除指定工单模板。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'DisableSchemaProperty' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'name' => 'SchemaId', + 'in' => 'formData', + 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'], ], [ - 'name' => 'SkillGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'skillgroup@ccc-test', - ], + 'name' => 'PropertyName', + 'in' => 'formData', + 'schema' => ['description' => '字段名', 'type' => 'string', 'required' => true, 'example' => 'name'], ], [ - 'name' => 'UserLevelList', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席技能等级列表，格式为JSON数组的字符串，数组元素是一个对象，包含两个字段：userId和skillLevel，userId填写想要修改的坐席ID，skillLevel填写想要修改的技能等级，取值范围1-10，值越小，业务能力越强，单位时间内能处理更多的通话。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"userId":"agent1@ccc-test","skillLevel":1},{"userId":"agent2@ccc-test","skillLevel":10}]', - ], + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'DisableSchemaPropertyResponse', + 'description' => 'DisableSchemaPropertyResponse', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E49D8B83-A3EC-44D4-A920-578BC3C698AD', + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '附加信息', 'type' => 'string', 'example' => 'User 244715989906081477 does not exist in instance worldfirst01.'], + 'Params' => [ + 'description' => '参数信息。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '[\'userId\']'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.SkillGroupId', - 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"E49D8B83-A3EC-44D4-A920-578BC3C698AD\\"\\n}","errorExample":""},{"type":"xml","example":"E49D8B83-A3EC-44D4-A920-578BC3C698AD\\n无\\n200\\n无\\nOK","errorExample":""}]', - 'title' => '修改技能组的多个坐席等级', - 'summary' => '调用ModifyUserLevelsOfSkillGroup修改指定实例下指定技能组下属的一个或多个坐席的技能等级。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RegisterDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"User 244715989906081477 does not exist in instance worldfirst01.\\",\\n \\"Params\\": [\\n \\"[\'userId\']\\"\\n ]\\n}","type":"json"}]', + 'title' => '禁用Schema字段', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'DisableTicketTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], - ], - [ - 'name' => 'DeviceId', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，用户可自行设置，无特殊要求，字符串形式即可。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-device', - ], + 'schema' => ['description' => '工单模板ID。', 'type' => 'string', 'required' => false, 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492'], ], [ - 'name' => 'Password', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '设备密码，该密码用于在SIP设备发起注册信令时做鉴权校验，请妥善保管。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'password', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'DisableTicketTemplateResponse', + 'description' => 'DisableTicketTemplateResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], + 'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Params' => [ + 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be blank.', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\nOK","errorExample":""}]', - 'title' => '注册设备', - 'summary' => '调用RegisterDevice注册SIP设备到指定实例下的指定坐席， SIP设备可以是SIP话机或SIP软电话。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RegisterDevices' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '下线工单模板', + 'summary' => '使用DisableTicketTemplate进行工单模板的下线操作，下线状态的模板在新建工单时不能被选中。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'DiscardEditingContactFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8763,53 +5447,24 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'UserIdListJson', - 'in' => 'query', - 'schema' => [ - 'description' => ' 座席ID列表，格式为JSON数组的字符串，数组元素是坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '["user-test@ccc-test"]', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'DeviceId', + 'name' => 'ContactFlowId', 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，用户可自行设置，无特殊要求，字符串形式即可。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-device', - ], + 'schema' => ['description' => '联系流ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3ff4e021-fd63-4572-ad8c-10ed69972965'], ], [ - 'name' => 'Password', + 'name' => 'DraftId', 'in' => 'query', - 'schema' => [ - 'description' => '设备密码，该密码用于在SIP设备发起注册信令时做鉴权校验，请妥善保管。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'password', - ], + 'schema' => ['description' => '草稿ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0aa493d6-58eb-4290-9ba2-e1c2c615b46b'], ], ], 'responses' => [ @@ -8817,327 +5472,159 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'Params' => [ - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CB72B537-B531-598F-9617-A636FB8040C0'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n无\\nOK","errorExample":""}]', - 'title' => '注册多个设备', - 'summary' => '调用RegisterDevices注册一个或多个SIP设备到指定实例下的指定坐席，SIP设备可以是SIP话机或SIP软电话。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RemoveUsers' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"CB72B537-B531-598F-9617-A636FB8040C0\\"\\n}","type":"json"}]', + 'title' => '撤销联系流编辑', + 'summary' => '撤销联系流编辑，丢弃对应草稿。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DiscardEditingContactFlow'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'EnableSchemaProperty' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'UserIdList', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID列表，格式为JSON数组的字符串，数组元素是坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '["agent1@ccc-test","agent2@ccc-test"]', - ], + 'name' => 'SchemaId', + 'in' => 'formData', + 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'], ], [ - 'name' => 'Force', - 'in' => 'query', - 'schema' => [ - 'description' => '是否强制删除。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'PropertyName', + 'in' => 'formData', + 'schema' => ['description' => '字段名', 'type' => 'string', 'required' => true, 'example' => 'name'], ], [ - 'name' => 'FilePath', - 'in' => 'query', - 'schema' => [ - 'description' => '待删除用户列表文件的OSS对象的ObjectKey。', - 'type' => 'string', - 'required' => false, - 'example' => 'temp/removeUsers.xlsx', - ], + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], ], [ - 'name' => 'NotificationEmail', - 'in' => 'query', - 'schema' => [ - 'description' => '通知邮件地址。', - 'type' => 'string', - 'required' => false, - 'example' => '123@abc.com', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'title' => 'EnableSchemaPropertyResponse', + 'description' => 'EnableSchemaPropertyResponse', + 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => 'The operation is not allowed. User state (READY) does not meet expectations (OFFLINE).'], 'Params' => [ 'description' => '响应参数。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '[\'wudi@zcwlwhkf\']'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\nOK","errorExample":""}]', - 'title' => '删除坐席', - 'summary' => '调用RemoveUsers删除指定实例下的一个或多个坐席，该操作仅将RAM账户与实例解绑，然后将RAM账户映射的坐席从实例中删除，并不会删除RAM账户本身。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RemoveUsersFromSkillGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"The operation is not allowed. User state (READY) does not meet expectations (OFFLINE).\\",\\n \\"Params\\": [\\n \\"[\'wudi@zcwlwhkf\']\\"\\n ]\\n}","type":"json"}]', + 'title' => '启用Schema字段', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'EnableTicketTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'SkillGroupId', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'skillgroup@ccc-test', - ], + 'schema' => ['description' => '工单模板ID。', 'type' => 'string', 'required' => false, 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492'], ], [ - 'name' => 'UserIdList', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["agent1@ccc-test","agent2@ccc-test"]', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'EnableTicketTemplateResponse', + 'description' => 'EnableTicketTemplateResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + 'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.SkillGroupId', - 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', - 'title' => '删除技能组关联的多个坐席', - 'summary' => '调用RemoveUsersFromSkillGroup删除指定实例下指定技能组关联的一个或多个坐席，该操作仅删除技能组与坐席之间的关联关系，并不会删除坐席。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ResetAgentState' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '上线工单模板', + 'summary' => '使用EnableTicketTemplate上线工单模板，上线中状态的工单模板，可以用于创建工单。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'EndConference' => [ + 'summary' => '调用EndConference使指定坐席退出指定实例下指定通话ID对应的通话，该通话必须处于会议状态。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9148,39 +5635,27 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID，非必填，不填默认使用当前RAM账户映射的坐席。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '需要退出会议的坐席ID，选填，不填默认为当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'DeviceId', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，可以随便填写，无特殊作用，无特殊要求。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'example' => 'job-6538214103685****'], ], ], 'responses' => [ @@ -9188,310 +5663,294 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3'], 'Params' => [ + 'description' => '响应参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '参数信息。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], 'Data' => [ - 'description' => '坐席状态数据。', + 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'JobId' => [ - 'description' => '通话ID，如果该字段有值，说明坐席当前处于通话过程中。', - 'type' => 'string', - 'example' => '无', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休码包括：Warm-up'."\n" - .'（坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否开启了仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'UserState' => [ - 'description' => '坐席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'CREATED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '8001****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609225718294:job-65700074013925376'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + ], + ], + ], ], - 'example' => 'OFFLINE', ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'DeviceState' => [ + 'description' => 'SIP话机设备的状态，如果未注册SIP话机，则状态为UNREGISTERED（未注册），如过SIP话机注册过但是不在线，则状态为OFFLINE（离线），如果SIP话机注册过并且在线则为ONLINE（在线）。', + 'type' => 'string', + 'enumValueTitles' => ['UNREGISTERED' => '未注册', 'OFFLINE' => '离线', 'ONLINE' => '在线'], + 'example' => 'UNREGISTERED', + ], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], ], ], + 'ContextId' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '103655'], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"OFFLINE\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n200\\n\\n 80011112\\n OFFLINE\\n ccc-test\\n user-test@ccc-test\\n false\\n ON_SITE\\n\\nOK","errorExample":""}]', - 'title' => '重置坐席状态', - 'summary' => '调用ResetAgentState重置指定实例下指定坐席的坐席状态。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ResetUserPassword' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '退出会议', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EndConference'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0630E5DF-CEB0-445B-8626-D5C7481181C3\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-65700074013925376\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"DeviceState\\": \\"UNREGISTERED\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 103655\\n }\\n}","type":"json"}]', + ], + 'ExportContactFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '251084', + 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], + ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'name' => 'FlowId', + 'in' => 'formData', + 'schema' => ['description' => 'IVR联系流ID。', 'type' => 'string', 'required' => true, 'example' => 'lc-uf61xdtm0mf73k'], ], [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => 'AF9834D8-6D09-4A1B-BADB-B019D9D444C8'], ], [ - 'name' => 'Password', - 'in' => 'query', - 'schema' => [ - 'description' => '新的密码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'password', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'ExportFlowResponse', + 'description' => 'ExportFlowResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', + 'FlowPackageData' => ['description' => '数据', 'type' => 'string', 'example' => '{}'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], - 403 => [ - [ - 'errorCode' => 'Permission.Role', - 'errorMessage' => 'You have no permission to access role %s.', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FlowPackageData\\": \\"{}\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '导出IVR流程', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + ], + 'ExportCustomCallTagging' => [ + 'summary' => '调用ExportCustomCallTagging导出指定实例下的全部呼入号码标记。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], + 'parameters' => [ [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], - [ - 'errorCode' => 'InternalService.RAM', - 'errorMessage' => 'An internal RAM service error occurred. %s', - ], - [ - 'errorCode' => 'InternalService.STS', - 'errorMessage' => 'An internal STS service error occurred. %s', + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '数据，导出结果所在的OSS的下载链接，链接有效期为24小时。', 'type' => 'string', 'example' => 'http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/tagging.xlsx ?Expires=1610910578&OSSAccessKeyId=****&Signature=****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F
'], + ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\nOK","errorExample":""}]', - 'title' => '重置坐席密码', - 'summary' => '调用ResetUserPassword重置指定实例下指定坐席的登录密码。实际上坐席并没有登录密码，修改的是坐席关联的RAM账户的登录密码，通常用于客服忘记自己的RAM账户登录密码的场景。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UnregisterDevice' => [ - 'summary' => '调用UnregisterDevice删除指定实例下指定坐席的设备注册记录，删除后将导致与坐席关联的SIP话机或SIP软电话不可用。', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['CCC::2020-07-01::ExportCustomCallTaggings'], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '导出呼入号码标记', + 'changeSet' => [ + ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportCustomCallTagging'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/tagging.xlsx ?Expires=1610910578&OSSAccessKeyId=****&Signature=****\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F
\\"\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F
\\n无\\n200\\n无\\nhttp://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/tagging.xlsx ?Expires=1610910578&OSSAccessKeyId=KZEA4GDDtCg431rmXTiEhr1q&Signature=4bXjOtUYgXl2z9iWpk3tXxS8SGY%3D\\nOK","errorExample":""}]', + ], + 'ExportDoNotCallNumbers' => [ + 'summary' => '调用ExportDoNotCallNumbers导出指定实例下指定搜索条件过滤后的禁止外呼号码列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'SearchPattern', + 'in' => 'query', + 'schema' => ['description' => '根据号码或者备注进行模糊匹配，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RemarkA'], + ], + [ + 'name' => 'Scope', 'in' => 'query', 'schema' => [ - 'description' => '坐席ID。', + 'description' => '应用范围，包括SYSTEM和INSTANCE，分别对应系统级禁止外呼和客户自定义禁止外呼，SYSTEM是关联实例所属的阿里云主账号的，INSTANCE只和当前实例关联，非必填，默认值INSTANCE。', 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', + 'enumValueTitles' => ['SYSTEM' => '系统级禁止外呼配置', 'INSTANCE' => '实例级禁止外呼配置'], + 'example' => 'INSTANCE', ], ], ], @@ -9500,69 +5959,119 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '数据，导出结果的OSS下载链接，链接有效期24小时。', 'type' => 'string', 'example' => 'https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/blacklist.xlsx?Expires=3294624578&OSSAccessKeyId=****&Signature=****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'Params' => [ + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], ], - 403 => [ - [ - 'errorCode' => 'Permission.User', - 'errorMessage' => 'You have no permission to access user(s) %s.', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '导出禁止外呼号码', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-06T05:44:50.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportDoNotCallNumbers'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/blacklist.xlsx?Expires=3294624578&OSSAccessKeyId=****&Signature=****\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n无\\nhttps://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/temp/blacklist/export/157724711549xxxx/ccc-test/Tue%20Mar%2015%2010%3A14%3A48%20CST%202022/blacklist.xlsx?Expires=3294624578&OSSAccessKeyId=XXXX&Signature=XXXX\\nOK","errorExample":""}]', + ], + 'FinishTicketTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + 'AK' => [], ], - 500 => [ - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'TicketId', + 'in' => 'query', + 'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => false, 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => '节点ID。', 'type' => 'string', 'required' => false, 'example' => 'b52a34dc-f514-4600-9c39-3cf657167c97'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => '处理意见。', 'type' => 'string', 'required' => true, 'example' => '同意'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'FinishTicketTaskResponse', + 'description' => 'FinishTicketTaskResponse', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数', 'type' => 'string', 'example' => '无'], + ], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\nOK","errorExample":""}]', - 'title' => '删除注册设备', - ], - 'AnswerCall' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '工单处理', + 'summary' => '使用FinishTicketTask对工单进行处理。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'GetAudioFile' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9571,53 +6080,97 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccKYIENB'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'AudioResourceId', 'in' => 'query', + 'schema' => ['description' => '音频资源ID，音频文件的唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c1a06b46-302a-4c6e-928b-a43c0df485cf'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。'."\n" + ."\n", 'type' => 'string', 'example' => 'EEE26562-D921-5CB2-AE49-E4C45A42D432'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => [ + 'description' => '音频文件数据。', + 'type' => 'object', + 'properties' => [ + 'AudioFileName' => ['description' => '音频文件名称。', 'type' => 'string', 'example' => 'test-file.wav'], + 'OssFileKey' => ['description' => '音频资源文件在OSS中的Key。', 'type' => 'string', 'example' => 'ccc-test/test-file.wav'], + 'UpdatedTime' => ['description' => '音频资源的最后修改时间。', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0'], + 'AudioResourceId' => ['description' => '音频资源ID，音频文件的唯一标识。', 'type' => 'string', 'example' => 'c1a06b46-302a-4c6e-928b-a43c0df485cf'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Name' => ['description' => '音频展示名。', 'type' => 'string', 'example' => '欢迎语'."\n"], + 'CreatedTime' => ['description' => '音频资源的创建时间。', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0'], + ], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '获取音频文件', + 'summary' => '调用GetAudioFile获取指定实例下指定音频资源ID对应的音频文件信息。', + 'changeSet' => [ + ['createdAt' => '2022-06-30T02:20:46.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFile'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"EEE26562-D921-5CB2-AE49-E4C45A42D432\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"AudioFileName\\": \\"test-file.wav\\",\\n \\"OssFileKey\\": \\"ccc-test/test-file.wav\\",\\n \\"UpdatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"AudioResourceId\\": \\"c1a06b46-302a-4c6e-928b-a43c0df485cf\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"欢迎语\\\\n\\",\\n \\"CreatedTime\\": \\"2021-07-14 10:48:43.0\\"\\n }\\n}","type":"json"}]', + ], + 'GetAudioFileDownloadUrl' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DeviceId', + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'JobId', + 'name' => 'AudioResourceId', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-65382141036853491', - ], + 'schema' => ['description' => '音频资源ID，唯一标识一个音频文件。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acc300c4-75c9-41ba-ba5e-2a365c96c248'], ], ], 'responses' => [ @@ -9625,330 +6178,37 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'ContextId' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '103655', - ], - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => 'Channel在通话过程中创建的顺序。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'ANSWERED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'SkillGroupId' => [ - 'description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'INBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'ChannelVariables' => [ - 'description' => '随路数据', - 'type' => 'string', - 'example' => 'a=b;c=d;', - ], - ], - ], - ], - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'INBOUND', - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '数据，音频资源文件的OSS下载链接，请注意，下载链接的有效期为24小时，请勿长期存储该链接。', 'type' => 'string', 'example' => 'https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/****.wav?Expires=1656472158&OSSAccessKeyId=****&Signature=****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidOperation', - 'errorMessage' => 'The operation is not allowed in current state.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.ChannelId', - 'errorMessage' => 'The specified channel %s does not exist in call %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred.', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/****.wav?Expires=1656472158&OSSAccessKeyId=****&Signature=****\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\"\\n}","type":"json"}]', + 'title' => '获取音频文件下载链接', + 'summary' => '调用GetAudioFileDownloadUrl获取指定实例下指定音频资源的OSS下载链接。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFileDownloadUrl'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103655,\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"INBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"ChannelVariables\\": \\"a=b;c=d;\\"\\n }\\n ],\\n \\"CallType\\": \\"INBOUND\\"\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n skg-default@ccc-test\\n \\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '接听通话', - 'summary' => '调用AnswerCall接听指定实例下指定通话ID对应的通话。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], ], - 'BargeInCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAudioFileUploadParameters' => [ + 'summary' => '调用GetAudioFileUploadParameters获取音频文件上传参数，创建音频文件时，需要先调用该接口拿到上传参数，然后再调用CreateAudioFile创建音频文件。该接口通常由云联络中心提供的公有云默认CRM系统调用，不建议集成客户调用该接口，因为需要在页面上操作上传文件，上传完成后，才能调用GetAudioFileUploadParameters接口。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9959,75 +6219,98 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccKYIENB'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'AudioFileName', 'in' => 'query', + 'schema' => ['description' => '音频文件名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-file.wav'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '发起强插的坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C81FD1A5-4B99-470A-A527-D80150228784'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'FilePath' => ['description' => 'OSS文件的Key。', 'type' => 'string', 'example' => 'ccc-test/test-file.wav'], + 'Signature' => ['description' => '文件上传临时凭证的签名信息，用于上传时验证合法性。', 'type' => 'string', 'example' => 'HIyClras8IcVlbTV7RIJWJbU****'], + 'Host' => ['description' => 'OSS的接入域名。', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com'], + 'Policy' => ['description' => '签名策略。', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMi0wNi0yOVQwMDoyOTowMC42NTRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiYXVkaW8vMTU3NzI0NzExNTQ5MDQwMS9seS1vbmxpbmUvMjAyMjA2MjkwNzI5MDAvIl1d****'], + 'ExpireTime' => ['description' => '过期时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '1647313420'], + 'AccessKeyId' => ['description' => '签名使用的AccessKeyId。', 'type' => 'string', 'example' => '****'], + ], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '获取音频文件上传参数', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFileUploadParameters'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C81FD1A5-4B99-470A-A527-D80150228784\\",\\n \\"Data\\": {\\n \\"FilePath\\": \\"ccc-test/test-file.wav\\",\\n \\"Signature\\": \\"HIyClras8IcVlbTV7RIJWJbU****\\",\\n \\"Host\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyMi0wNi0yOVQwMDoyOTowMC42NTRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiYXVkaW8vMTU3NzI0NzExNTQ5MDQwMS9seS1vbmxpbmUvMjAyMjA2MjkwNzI5MDAvIl1d****\\",\\n \\"ExpireTime\\": 1647313420,\\n \\"AccessKeyId\\": \\"****\\"\\n }\\n}","type":"json"}]', + ], + 'GetCallDetailRecord' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + 'AK' => [], ], [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6538214103685****', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], + ], + 'parameters' => [ [ - 'name' => 'BargedUserId', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '被强插的座席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent2@ccc-test', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-10963442671187****'], ], [ - 'name' => 'TimeoutSeconds', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '强插超时时间，经过指定的时间强插仍未成功，则取消强插，正常情况下，强插操作会马上成功，设置超时时间是为了防止异常发生，此字段选填，默认30，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '3600', - 'minimum' => '0', - 'example' => '60', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], ], 'responses' => [ @@ -10035,334 +6318,288 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'BARGE', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', + 'ReleaseInitiator' => [ + 'description' => '挂断方。', + 'type' => 'string', + 'enumValueTitles' => ['agent ' => '坐席', 'customer ' => '客户'], + 'example' => 'customer', + ], + 'ContactDisposition' => [ + 'description' => '电话结束原因，注意：语音邮箱、转人工失败、排队超时、排队溢出、IVR异常的挂断原因需要客户配置挂断原因节点才能体现出来，如果没有配置且IVR中无转人工模块，这时候的挂断原因默认为IVR放弃。', + 'type' => 'string', + 'enumValueTitles' => [ + 'AbandonedInQueue' => '排队放弃', 'NoAnswer' => '客户未接', 'QueuingTimeout' => '排队超时', 'Voicemail' => '转语音邮箱', 'QueuingFailed' => '转人工失败', 'QueuingOverflow' => '排队溢出', 'AbandonedInVoiceNavigator' => '智能导航中放弃', 'Success' => '正常结束', 'IVRException' => 'IVR系统异常', 'AbandonedInRing' => '振铃放弃', + 'AbandonedInIVR' => 'IVR放弃', 'Reject' => '客户拒接', 'ForwardToOutsideNumber' => '转外线', + ], + 'example' => 'Success', + ], + 'ContactType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => ['INBOUND' => '呼入', 'CONFERENCE' => '会议', 'INTERNAL' => '内部呼叫', 'PRIVACY_DIAL' => '加密通话', 'OUTBOUND' => '呼出', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼'], + 'example' => 'OUTBOUND', + ], + 'AgentIds' => ['description' => '坐席ID列表，表示通话流经的坐席，多个值用逗号分隔。', 'type' => 'string', 'example' => 'agent1@ccc-test,agent2@ccc-test'], + 'CallDuration' => ['description' => '通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'RecordingReady' => ['description' => '录音是否已经生成，若通话还没有建立，返回false。', 'type' => 'boolean', 'example' => 'true'], + 'EstablishedTime' => ['description' => '通话建立的时间，如果通话没有建立，此值为空，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532458000000'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'SatisfactionSurveyOffered' => ['description' => '是否发送了满意度调查。', 'type' => 'boolean', 'example' => 'true'], + 'CalledNumber' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1332315****'], + 'AgentNames' => ['description' => '坐席名称列表，表示通话流经的坐席，多个值用逗号隔开。', 'type' => 'string', 'example' => 'agent1,agent2'], + 'Satisfaction' => ['description' => '满意度结果，满意度的取值及含义由客户自定义。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'StartTime' => ['description' => '通话开始时间，呼入从进入IVR开始，呼出从开始接通计算，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532458000000'], + 'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-10963442671187****'], + 'SatisfactionSurveyChannel' => [ + 'description' => '发起满意度调查的渠道。', + 'type' => 'string', + 'enumValueTitles' => ['IVR' => '语音满意度', 'SMS' => '短信满意度'], + 'example' => 'IVR', + ], + 'ReleaseTime' => ['description' => '通话结束时间，以参与通话的所有对象中最后一个挂断的时间为准，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532458000000'], + 'CallingNumber' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '0533128****'], + 'SkillGroupNames' => ['description' => '参与通话的座席所属的技能组名称，多个技能组以逗号分隔。', 'type' => 'string', 'example' => '测试技能组'], + 'SkillGroupIds' => ['description' => '参与通话的座席所属的技能组ID，多个技能组以逗号分隔。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'AgentEvents' => [ + 'description' => '坐席事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '坐席事件。', + 'type' => 'object', + 'properties' => [ + 'AgentName' => ['description' => '坐席名称。', 'type' => 'string', 'example' => '坐席小王'], + 'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'EventSequence' => [ + 'description' => '事件序列。', + 'type' => 'array', + 'items' => [ + 'description' => '事件。', + 'type' => 'object', + 'properties' => [ + 'Event' => [ + 'description' => '事件类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Released' => '挂机', 'BlindTransfer' => '直接转接', 'Coaching' => '辅导', 'Barging' => '强插', 'Consulting' => '咨询转接', 'Ringing' => '振铃', 'StartConference' => '开始会议', 'Established' => '通话建立', 'Dialing' => '拨号', 'Intercepting' => '强拆', + 'Monitoring' => '监控', + ], + 'example' => 'Dialing', ], - 'example' => 'ANSWERED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1390501****', + 'EventTime' => ['description' => '事件发生时间戳，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'], + 'Duration' => ['description' => '时间的持续时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', + ], + ], + ], + ], + ], + 'IvrEvents' => [ + 'description' => 'IVR事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IVR事件。', + 'type' => 'object', + 'properties' => [ + 'FlowId' => ['description' => 'IVR联系流ID。', 'type' => 'string', 'example' => 'edaf2eaa-8f88-44ca-812e-41b3cd2b7a90'], + 'EventSequence' => [ + 'description' => '事件序列。', + 'type' => 'array', + 'items' => [ + 'description' => '事件。', + 'type' => 'object', + 'properties' => [ + 'Event' => [ + 'description' => '事件类型。', + 'type' => 'string', + 'enumValueTitles' => ['Route2IVR' => '进入IVR', 'Abandoned' => 'IVR中放弃'], + 'example' => 'Route2IVR', ], - 'example' => 'MONITORING', - ], - 'SkillGroupId' => [ - 'description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', + 'EventTime' => ['description' => '事件发生时间戳，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'], ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', + ], + ], + 'FlowType' => [ + 'description' => '联系流类型。', + 'type' => 'string', + 'enumValueTitles' => ['SURVEY_FLOW' => '满意度流程', 'MAIN_FLOW' => '主流程'], + 'example' => 'MAIN_FLOW', + ], + ], + ], + ], + 'QueueEvents' => [ + 'description' => '队列事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '队列事件。', + 'type' => 'object', + 'properties' => [ + 'QueueId' => ['description' => '队列ID，如果是技能组队列，则为技能组ID，如果是坐席个人队列，则为坐席ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'QueueName' => ['description' => '队列名称。', 'type' => 'string', 'example' => '测试技能组'], + 'FlowId' => ['description' => '联系流ID。', 'type' => 'string', 'example' => 'edaf2eaa-8f88-44ca-812e-41b3cd2b7a90'], + 'QueueType' => [ + 'description' => '队列类型。', + 'type' => 'integer', + 'format' => 'int32', + 'enumValueTitles' => [1 => '技能组', '坐席'], + 'example' => '1', + ], + 'EventSequence' => [ + 'description' => '事件序列。', + 'type' => 'array', + 'items' => [ + 'description' => '事件。', + 'type' => 'object', + 'properties' => [ + 'Event' => [ + 'description' => '事件类型。', + 'type' => 'string', + 'enumValueTitles' => ['AssignAgent' => '分配坐席', 'GiveUp' => '振铃放弃', 'Enqueue' => '进队列', 'QueueingOverflow' => '排队溢出', 'Abandoned' => '队列放弃', 'QueueingTimeout' => '排队超时'], + 'example' => 'Enqueue', ], - 'example' => 'BARGE', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', + 'EventTime' => ['description' => '事件发生时间戳，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'], ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', + ], + ], + ], + ], + ], + 'CustomerEvents' => [ + 'description' => '客户事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '客户事件。', + 'type' => 'object', + 'properties' => [ + 'CustomerId' => ['description' => '客户ID，通常为客户号码。', 'type' => 'string', 'example' => '1332315****'], + 'EventSequence' => [ + 'description' => '事件序列。', + 'type' => 'array', + 'items' => [ + 'description' => '事件。', + 'type' => 'object', + 'properties' => [ + 'Event' => [ + 'description' => '事件类型。', + 'type' => 'string', + 'enumValueTitles' => ['established' => '通话建立', 'ringing' => '振铃', 'released' => '挂机'], + 'example' => 'Released', + ], + 'EventTime' => ['description' => '事件发生时间戳，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532458000000'], ], ], ], ], ], ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', + 'CallerLocation' => ['description' => '主叫号码的归属地信息。', 'type' => 'string', 'example' => ' 山东省-淄博'], + 'CalleeLocation' => ['description' => '被叫号码的归属地信息。', 'type' => 'string', 'example' => '河北省-唐山'], + 'EarlyMediaState' => [ + 'description' => '早媒体状态，指通话在早媒体阶段发生异常，此时通常是呼叫客户的阶段，发生异常会导致呼叫客户失败，因此该状态是根据早媒体的状态分析出来的可能的未接通原因。', + 'type' => 'string', + 'enumValueTitles' => ['NoAnswer' => '无人接听', 'OutOfService' => '停机', 'NotExist' => '空号', 'Restricted' => '呼叫受限', 'Busy' => '占线', 'NotConnected' => '无法接通', 'PowerOff' => '关机'], + 'example' => 'NotConnected', + ], + 'ReleaseReason' => ['description' => '通话结束原因，一般是 SipCode加文字描述格式.', 'type' => 'string', 'example' => '200 - OK'], + 'AnalyticsReportReady' => ['type' => 'boolean', 'description' => ''], + 'AnalyticsReport' => [ 'type' => 'object', 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', + 'ProblemSolving' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['type' => 'string', 'description' => ''], + 'Success' => ['type' => 'boolean', 'description' => ''], + 'Solved' => ['type' => 'boolean', 'description' => ''], + 'Problem' => ['type' => 'string', 'description' => ''], + 'Solution' => ['type' => 'string', 'description' => ''], ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', + 'description' => '', ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', + 'Emotion' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['type' => 'string', 'description' => ''], + 'Success' => ['type' => 'boolean', 'description' => ''], + 'Type' => ['type' => 'string', 'description' => ''], + 'Confidence' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'Remark' => ['type' => 'string', 'description' => ''], ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', + 'description' => '', ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', + 'Satisfaction' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['type' => 'string', 'description' => ''], + 'Success' => ['type' => 'boolean', 'description' => ''], + 'SatisfactionDescription' => ['type' => 'string', 'description' => ''], + 'Remark' => ['type' => 'string', 'description' => ''], ], - 'example' => 'TALKING', + 'description' => '', ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', + 'TodoList' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['type' => 'string', 'description' => ''], + 'Success' => ['type' => 'boolean', 'description' => ''], + 'Tasks' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => ''], + 'description' => '', + ], ], + 'description' => '', ], ], + 'description' => '', ], + 'OutsideNumberReleaseReason' => ['type' => 'string', 'description' => ''], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'InvalidOperation.DeviceState', - 'errorMessage' => 'The operation is not allowed. Device state (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"BARGE\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"BARGE\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 10\\n skg-test1@ccc-test\\n 无\\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '强插通话', - 'summary' => '调用BargeInCall强行插入指定实例下指定通话ID对应的正在通话中的通话，强插成功后，通话将由原来的双方通话变成三人会议。', + 'title' => '获取通话详情', + 'summary' => '调用GetCallDetailRecord获取指定实例下指定通话ID对应的通话的详情。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'BlindTransfer' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-06-12T11:54:29.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-10-14T06:47:33.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-03-03T08:33:16.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-02-23T06:53:06.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-09-08T02:42:38.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCallDetailRecord'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"Data\\": {\\n \\"ReleaseInitiator\\": \\"customer\\",\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"OUTBOUND\\",\\n \\"AgentIds\\": \\"agent1@ccc-test,agent2@ccc-test\\",\\n \\"CallDuration\\": 50,\\n \\"RecordingReady\\": true,\\n \\"EstablishedTime\\": 1532458000000,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SatisfactionSurveyOffered\\": true,\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"AgentNames\\": \\"agent1,agent2\\",\\n \\"Satisfaction\\": 1,\\n \\"StartTime\\": 1532458000000,\\n \\"ContactId\\": \\"job-10963442671187****\\",\\n \\"SatisfactionSurveyChannel\\": \\"IVR\\",\\n \\"ReleaseTime\\": 1532458000000,\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"SkillGroupNames\\": \\"测试技能组\\",\\n \\"SkillGroupIds\\": \\"skillgroup@ccc-test\\",\\n \\"AgentEvents\\": [\\n {\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Dialing\\",\\n \\"EventTime\\": 1604639129000,\\n \\"Duration\\": 3\\n }\\n ]\\n }\\n ],\\n \\"IvrEvents\\": [\\n {\\n \\"FlowId\\": \\"edaf2eaa-8f88-44ca-812e-41b3cd2b7a90\\",\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Route2IVR\\",\\n \\"EventTime\\": 1604639129000\\n }\\n ],\\n \\"FlowType\\": \\"MAIN_FLOW\\"\\n }\\n ],\\n \\"QueueEvents\\": [\\n {\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"QueueName\\": \\"测试技能组\\",\\n \\"FlowId\\": \\"edaf2eaa-8f88-44ca-812e-41b3cd2b7a90\\",\\n \\"QueueType\\": 1,\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Enqueue\\",\\n \\"EventTime\\": 1604639129000\\n }\\n ]\\n }\\n ],\\n \\"CustomerEvents\\": [\\n {\\n \\"CustomerId\\": \\"1332315****\\",\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Released\\",\\n \\"EventTime\\": 1532458000000\\n }\\n ]\\n }\\n ],\\n \\"CallerLocation\\": \\" 山东省-淄博\\",\\n \\"CalleeLocation\\": \\"河北省-唐山\\",\\n \\"EarlyMediaState\\": \\"NotConnected\\",\\n \\"ReleaseReason\\": \\"200 - OK\\",\\n \\"AnalyticsReportReady\\": true,\\n \\"AnalyticsReport\\": {\\n \\"ProblemSolving\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": true,\\n \\"Solved\\": true,\\n \\"Problem\\": \\"\\",\\n \\"Solution\\": \\"\\"\\n },\\n \\"Emotion\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": true,\\n \\"Type\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Remark\\": \\"\\"\\n },\\n \\"Satisfaction\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": true,\\n \\"SatisfactionDescription\\": \\"\\",\\n \\"Remark\\": \\"\\"\\n },\\n \\"TodoList\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": true,\\n \\"Tasks\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"OutsideNumberReleaseReason\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\n无\\n200\\n\\n skg-default@ccc-test\\n 133xxxx2315\\n Outbound\\n ccc-test\\n Success\\n customer\\n 1\\n NotConnected\\n 1532458000000\\n job-109634426711871319\\n 50\\n 053xxxx3128\\n 北京\\n 1532458000000\\n true\\n 默认技能组\\n 语音\\n true\\n user-test@ccc-test\\t\\n 1532458000000\\n 北京\\n 云呼测试坐席\\n \\n skg-default@ccc-test\\n user-test@ccc-test\\n 测试坐席\\t\\n \\n 1604639129000\\n Dialing\\n \\n \\n \\n edaf2eaa-8f88-44ca-812e-41b3cd2b7a90\\n skg-default@ccc-test\\n Defalut\\n 1\\n \\n 1604639129000\\n Enqueue\\n \\n \\n \\n 133xxxx2315\\n \\n 1532458000000\\n Released\\n \\n \\n \\n edaf2eaa-8f88-44ca-812e-41b3cd2b7a90\\n MAIN_FLOW\\n \\n 1604639129000\\n Route2IVR\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'GetCampaign' => [ + 'summary' => '调用GetCampaign获取指定实例下指定ID对应的预测式外呼活动。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10371,198 +6608,348 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'CampaignId', 'in' => 'query', - 'schema' => [ - 'description' => '发起直接转接的坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'], ], - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ACC-YUNBS-1.0.10-****', + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '数据', + 'type' => 'object', + 'properties' => [ + 'ActualEndTime' => ['description' => '预测式外呼活动实际结束时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634008800000'], + 'ActualStartTime' => ['description' => '预测式外呼活动实际开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634000460000'], + 'CasesAborted' => ['description' => '取消呼叫的联系人数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CasesUncompleted' => ['description' => '未完呼叫的联系人数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CasesConnected' => ['description' => '已接通的联系人数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '40'], + 'MaxAttemptCount' => ['description' => '预测式外呼活动的最大尝试次数，表示当活动的号码呼叫失败时，最多重呼几次。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MinAttemptInterval' => ['description' => '预测式外呼活动的最小重呼间隔，表示失败重呼时的最小间隔，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['description' => '预测式外呼活动名称。', 'type' => 'string', 'example' => 'test-campaign'], + 'PlanedEndTime' => ['description' => '预测式外呼活动计划结束时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634054400000'], + 'PlanedStartTime' => ['description' => '预测式外呼活动计划开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1633968000000'], + 'QueueName' => ['description' => '关联的技能组名称。', 'type' => 'string', 'example' => '测试技能组'], + 'TotalCases' => ['description' => '联系人总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'State' => [ + 'description' => '预测式外呼活动状态。', + 'type' => 'string', + 'enumValueTitles' => ['Draft' => '草稿', 'Completed' => '已完成', 'Executing' => '执行中', 'Pending' => '待执行', 'Aborted' => '已取消', 'Paused' => '已暂停'], + 'example' => 'Completed', + ], + 'CampaignId' => ['title' => 'id', 'description' => '预测式外呼活动ID。', 'type' => 'string', 'example' => '6badb397-a8b5-40b6-21019d382a09'], + 'StrategyType' => [ + 'description' => '预测式外呼活动的策略模式。', + 'type' => 'string', + 'enumValueTitles' => ['PACING' => '固定比例外呼，外呼数量 = 空闲坐席 * 比例', 'PID' => '系统基于PID控制策略，自动调整外呼电话数量'], + 'example' => 'PACING', + ], + 'StrategyParameters' => ['description' => '预测式外呼活动的策略参数，PID策略下的格式参数示例：{"abandonRate":"5","historicalConnectedRate":"35"}，PACING策略下的格式参数示例：{"ratio":1}。abandonRate表示期望呼损率，historicalConnectedRate表示历史参考接通率，ratio表示固定外呼比例。', 'type' => 'string', 'example' => '{"ratio":1}'], + 'QueueId' => ['description' => '关联的技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Simulation' => ['description' => '是否为模拟活动，用于测试，普通客户无需关心。', 'type' => 'boolean', 'example' => 'false'], + 'SimulationParameters' => ['description' => '模拟活动参数，用于测试，普通客户无需关心。', 'type' => 'string', 'example' => '无'], + 'CasesUncompletedAfterAttempted' => ['description' => '尝试呼叫过但未接通，且未达到最大尝试次数的联系人数量。即经过重试后呼叫成功的联系人。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'CasesUncompletedAfterAttempt' => ['type' => 'string', 'description' => ''], + 'CompletionRate' => ['type' => 'number', 'format' => 'float', 'description' => ''], + 'ContactFlowId' => ['type' => 'string', 'description' => ''], + ], + ], + ], + 'description' => '', ], ], + ], + 'title' => '获取预测式外呼活动', + 'changeSet' => [ + ['createdAt' => '2024-06-06T11:38:12.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCampaign'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"ActualEndTime\\": 1634008800000,\\n \\"ActualStartTime\\": 1634000460000,\\n \\"CasesAborted\\": 0,\\n \\"CasesUncompleted\\": 0,\\n \\"CasesConnected\\": 40,\\n \\"MaxAttemptCount\\": 1,\\n \\"MinAttemptInterval\\": 1,\\n \\"Name\\": \\"test-campaign\\",\\n \\"PlanedEndTime\\": 1634054400000,\\n \\"PlanedStartTime\\": 1633968000000,\\n \\"QueueName\\": \\"测试技能组\\",\\n \\"TotalCases\\": 100,\\n \\"State\\": \\"Completed\\",\\n \\"CampaignId\\": \\"6badb397-a8b5-40b6-21019d382a09\\",\\n \\"StrategyType\\": \\"PACING\\",\\n \\"StrategyParameters\\": \\"{\\\\\\"ratio\\\\\\":1}\\",\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"Simulation\\": false,\\n \\"SimulationParameters\\": \\"无\\",\\n \\"CasesUncompletedAfterAttempted\\": 1,\\n \\"CasesUncompletedAfterAttempt\\": \\"\\",\\n \\"CompletionRate\\": 0,\\n \\"ContactFlowId\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'GetCaseFileUploadUrl' => [ + 'summary' => '调用GetCaseFileUploadUrl获取指定实例下预测式外呼名单文件的OSS上传参数，当使用文件导入的方式创建预测式外呼活动时，需要先调用此接口拿到文件上传参数，然后再调用CreateCampaign接口。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Transferor', - 'in' => 'query', - 'schema' => [ - 'description' => '转接发起方，当场景是直接转接到外部号码时，用此参数指定的号码作为主叫，转内部坐席或技能组时，此参数无效，发起方由UserId指定。', - 'type' => 'string', - 'required' => false, - 'example' => '08314325****', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], + ], + 'parameters' => [ [ - 'name' => 'Transferee', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '被转接方，可以是坐席ID或技能组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'TimeoutSeconds', + 'name' => 'FileName', 'in' => 'query', + 'schema' => ['description' => '预测式外呼活动名单文件名称，名称的格式要求为英文大小写字母，文件格式要求csv格式。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'case.csv'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '直接转接超时时间，超过指定时间被转接方没有接起通话，则挂断通话，此字段选填，默认30，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '120', - 'minimum' => '3', - 'example' => '60', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => '用于上传文件的预签名的OSS文件上传链接，有效期为一小时。', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****'], + 'CaseFileKey' => ['description' => 'OSS文件的Key。', 'type' => 'string', 'example' => 'ccc-test/namelist.csv'], + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '获取预测式外呼名单上传参数', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCaseFileUploadUrl'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"Url\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****\\",\\n \\"CaseFileKey\\": \\"ccc-test/namelist.csv\\"\\n },\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","type":"json"}]', + ], + 'GetChatMediaUrl' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6538214103685****', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'CallPriority', - 'in' => 'query', - 'schema' => [ - 'description' => '转接到技能组队列时的排队优先级，取值范围0-9，0优先级最高，9最低。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'name' => 'MediaId', + 'in' => 'formData', + 'schema' => ['title' => 'media id', 'description' => 'media id', 'type' => 'string', 'required' => true, 'example' => '$iAHNCNQCo3dhdgMGBAAFAAbaACOEAaQhIEeoAqpjjBl42N6o_kg7A88AAAGRIRRuBgTOACrxHgcACM8AAAGRIYJLBQ'], ], [ - 'name' => 'StrategyName', - 'in' => 'query', - 'schema' => [ - 'description' => '转接到技能组队列时的座席分配策略名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'MOST_IDLE，MOST_SKILLED，MOST_ACQUAINTED，CUSTOMIZED等', - ], + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => '8707EB29-BAED-4302-B999-40BA61877437'], ], [ - 'name' => 'StrategyParams', - 'in' => 'query', + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '转接到技能组队列时的座席分配策略参数。', - 'type' => 'string', - 'required' => false, - 'example' => '当分配策略为CUSTOMIZED时，本参数的内容为如下格式：'."\n" - .' {'."\n" - .' "functionId": "512fed64-e379-400f-a1a5-14d5730xxxxx",'."\n" - .' "functionName": "routing-strategy-test-2"'."\n" - .'}', + 'title' => 'GetChatMediaUrlResponse', + 'description' => 'GetChatMediaUrlResponse', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => '返回数据结果。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息'."\n" + ."\n", 'type' => 'string', 'example' => 'Internal service issue. Detail:.'], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '[\'OFFLINE\', \'READY,RINGING,TALKING\']'], + ], + ], ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Internal service issue. Detail:.\\",\\n \\"Params\\": [\\n \\"[\'OFFLINE\', \'READY,RINGING,TALKING\']\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取聊天消息媒体文件访问URL', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + ], + 'GetChatRoutingProfile' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TransfereeType', - 'in' => 'query', - 'schema' => [ - 'description' => '转接目的类型，可选值为AGENT，SKILL_GROUP，IVR和EXTERNAL_NUMBER。如果此参数不传，则系统会根据转接的目标号码的格式进行判断，如果发现有判不准确的情况，则需要指定此参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'SKILL_GROUP', - ], + 'AK' => [], ], [ - 'name' => 'ContactFlowVariables', - 'in' => 'query', - 'schema' => [ - 'description' => '传递给联系流的变量，选填，这里配置的变量，可以在IVR流程中拿到并使用，格式为JSON字符串格式的键值对集合。', - 'type' => 'string', - 'required' => false, - 'example' => '{"name":"王先生","time":"19点20分","address":"某某中心"}', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'RoutingType', + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '话务分配类型，可选参数为自动分配(Automatic)或者手动分配(Manual)。如果此参数为空，则默认为自动分配的方式，这也是当前系统的默认行为。选择手动分配方式时，需要您自己配合调用ClaimCall等接口把电话分给指定的座席。', - 'type' => 'string', - 'required' => false, - 'example' => 'Manual', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'RoutingType' => ['description' => '话务分配类型。'."\n" + .'- 自动分配(Automatic)。'."\n" + .'- 手动分配(Manual)。', 'type' => 'string', 'example' => 'Automatic'], + 'AgentConcurrencySettings' => ['description' => '坐席会话并发配置。'."\n" + .'- AllowExceedingLimitWhenTransferring，转接时是否允许超出上限，向其他坐席转接会话时，允许超出对方上限数量，但最多不能超过30个。'."\n" + .'- AllowExceedingLimitWhenClaiming，认领时是否允许超出上限，坐席从队列中主动认领会话时，允许超出上限数量，但最多不能超过30个。'."\n" + .'- ConcurrencyLimit，允许坐席同时处理的网络业务会话数量。'."\n" + .'- Enabled，是否启用该配置。', 'type' => 'string', 'example' => '{'."\n" + .' "AllowExceedingLimitWhenTransferring": false,'."\n" + .' "ConcurrencyLimit": 4,'."\n" + .' "AllowExceedingLimitWhenClaiming": true,'."\n" + .' "Enabled": true'."\n" + .'}'], + 'DistributionSettings' => ['description' => '坐席会话分配配置。'."\n" + .'- AgentRingTimeoutSeconds，坐席处理超时限制。'."\n" + .'- MaxNumberOfConversationsAgentCanMiss，允许坐席最多连续未响应的会话数量。'."\n" + .'- PostAgentMissingConversionsAction，坐席连续未响应超过设置的数量后，系统设置的作息状态，如小休Break, 隐身Invisible，保持不变Nothing;'."\n" + .'- Enabled，是否启用。', 'type' => 'string', 'example' => '{'."\n" + .' "AgentRingTimeoutSeconds": 30,'."\n" + .' "Enabled": true,'."\n" + .' "MaxNumberOfConversationsAgentCanMiss": 5,'."\n" + .' "PostAgentMissingConversionsAction": "Nothing"'."\n" + .'}'], + 'ChatSettings' => ['description' => '会话配置。'."\n" + .'- IdleChatTimeoutSeconds，会话自动结束时间，特定时间内未收到客户响应，则系统结束会话，单位秒。', 'type' => 'string', 'example' => '{"IdleChatTimeoutSeconds":300}'], + ], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"30C7D235-DDCF-4C7F-A462-5E2598252C2B\\",\\n \\"Data\\": {\\n \\"RoutingType\\": \\"Automatic\\",\\n \\"AgentConcurrencySettings\\": \\"{\\\\n \\\\\\"AllowExceedingLimitWhenTransferring\\\\\\": false,\\\\n \\\\\\"ConcurrencyLimit\\\\\\": 4,\\\\n \\\\\\"AllowExceedingLimitWhenClaiming\\\\\\": true,\\\\n \\\\\\"Enabled\\\\\\": true\\\\n}\\",\\n \\"DistributionSettings\\": \\"{\\\\n \\\\\\"AgentRingTimeoutSeconds\\\\\\": 30,\\\\n \\\\\\"Enabled\\\\\\": true,\\\\n \\\\\\"MaxNumberOfConversationsAgentCanMiss\\\\\\": 5,\\\\n \\\\\\"PostAgentMissingConversionsAction\\\\\\": \\\\\\"Nothing\\\\\\"\\\\n}\\",\\n \\"ChatSettings\\": \\"{\\\\\\"IdleChatTimeoutSeconds\\\\\\":300}\\"\\n }\\n}","type":"json"}]', + 'title' => '获取会话转接配置', + 'summary' => '使用GetChatRoutingProfile获取会话转接配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + ], + 'GetContactFlow' => [ + 'summary' => '获取指定联系流。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], [ - 'name' => 'Tags', - 'in' => 'query', - 'schema' => [ - 'description' => '随路数据，主要用于扩展需求，普通用户无需关心。', - 'type' => 'string', - 'required' => false, - 'example' => '5295578135#WAEtqY5U&Biz_Package_Rexian_Zhuanjieanquanyungaojie_2527', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], + ], + 'parameters' => [ [ - 'name' => 'QueuingTimeoutSeconds', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '当转接目标是技能组队列时排队超时时间，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'QueuingOverflowThreshold', + 'name' => 'ContactFlowId', 'in' => 'query', - 'schema' => [ - 'description' => '当转接目标是技能组队列时排队溢出阈值。默认值为0，表示不溢出。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '联系流ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '274601be-a6d5-4429-bcef-32b51d031c6e'], ], [ - 'name' => 'SkillGroupId', + 'name' => 'DraftId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ee914df4-82bf-4919-bcb3-9cb8aa437f35', - ], + 'schema' => ['description' => '草稿ID，当前联系流对应的可编辑草稿版本ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '566399d7-5558-447c-a72f-9be2768b6a82'], ], ], 'responses' => [ @@ -10570,327 +6957,55 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'ContextId' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '103654', - ], - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道', - 'type' => 'object', - 'properties' => [ - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'ANSWERED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => 'MONITORING', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - ], - ], - ], + 'Type' => ['description' => '流程类型： '."\n" + .'MAIN\\_FLOW（主流程） '."\n" + .'SUB\\_FLOW（子流程） '."\n" + .'SURVEY\\_FLOW（满意度流程）', 'type' => 'string', 'example' => 'MAIN_FLOW'], + 'Definition' => ['description' => 'IVR的内容。', 'type' => 'string', 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好，欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}'], + 'DraftId' => ['description' => '草稿ID，当前联系流对应的可编辑草稿版本ID。', 'type' => 'string', 'example' => '566399d7-5558-447c-a72f-9be2768b6a82'."\n"], + 'Description' => ['description' => '版本描述。', 'type' => 'string', 'example' => '1.0'."\n"], + 'UpdatedTime' => ['description' => '上次修改的时间。', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0'], + 'Editor' => ['description' => '此草稿的当前编辑者的坐席登录名。', 'type' => 'string', 'example' => 'editor-xxx'], + 'Published' => ['description' => '是否已发布 True：已发布：False：未发布', 'type' => 'boolean', 'example' => 'False'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Name' => ['description' => 'IVR名称。', 'type' => 'string', 'example' => '欢迎语'], + 'ContactFlowId' => ['description' => '联系流ID。', 'type' => 'string', 'example' => '274601be-a6d5-4429-bcef-32b51d031c6e'."\n"], + 'CreatedTime' => ['description' => '联系流程草稿创建时间。', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0'], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Invalid', - 'errorMessage' => 'The parameter %s is invalid. %s.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ], + 'title' => '获取指定联系流', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetContactFlow'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103654,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n \\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '直接转接通话', - 'summary' => '直接转接通话到其他坐席或某个技能组队列或外部号码，直接转接也叫盲转或单步转。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\",\\n \\"Data\\": {\\n \\"Type\\": \\"MAIN_FLOW\\",\\n \\"Definition\\": \\"{\\\\\\"activities\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"INCOMING_CALL\\\\\\",\\\\\\"id\\\\\\":\\\\\\"e98f0d47\\\\\\",\\\\\\"name\\\\\\":\\\\\\"开始\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":263,\\\\\\"y\\\\\\":164}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"41f7dbd0\\\\\\"}],\\\\\\"nodeIndex\\\\\\":0},{\\\\\\"type\\\\\\":\\\\\\"HANGUP\\\\\\",\\\\\\"id\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"挂机\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":765,\\\\\\"y\\\\\\":185}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":null}],\\\\\\"nodeIndex\\\\\\":999},{\\\\\\"type\\\\\\":\\\\\\"PLAY_SAY\\\\\\",\\\\\\"id\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"放音\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"say\\\\\\":\\\\\\"您好，欢迎来到云联络中心。\\\\\\",\\\\\\"audioResourceId\\\\\\":\\\\\\"\\\\\\",\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":485.5,\\\\\\"y\\\\\\":153.5},\\\\\\"audioType\\\\\\":\\\\\\"tts\\\\\\",\\\\\\"audioInterrupt\\\\\\":false},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"e1af4f1f\\\\\\"}],\\\\\\"nodeIndex\\\\\\":1}],\\\\\\"description\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"DraftId\\": \\"566399d7-5558-447c-a72f-9be2768b6a82\\\\n\\",\\n \\"Description\\": \\"1.0\\\\n\\",\\n \\"UpdatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"Editor\\": \\"editor-xxx\\",\\n \\"Published\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"欢迎语\\",\\n \\"ContactFlowId\\": \\"274601be-a6d5-4429-bcef-32b51d031c6e\\\\n\\",\\n \\"CreatedTime\\": \\"2021-07-14 10:48:43.0\\"\\n }\\n}","type":"json"}]', ], - 'CancelAttendedTransfer' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetConversationDetail' => [ + 'summary' => '调用GetConversationDetail获取指定实例下指定通话ID对应的通话的对话详情，注意，实例及技能组需要开通质检推送才能获取到对话详情。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10899,53 +7014,112 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '136495', + 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'example' => 'job-25884193037652****'], ], [ - 'name' => 'DeviceId', + 'name' => 'AgentId', 'in' => 'query', + 'schema' => ['title' => '坐席ID。', 'description' => '坐席ID。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7E407F9B-A278-52A0-B193-3EE5471D7A87'], + 'Phrases' => [ + 'description' => '对话列表。', + 'type' => 'array', + 'items' => [ + 'description' => '对话信息。', + 'type' => 'object', + 'properties' => [ + 'Identity' => ['description' => '角色标识，系统内部使用，主要用于判断角色，客户无需关心。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Role' => [ + 'description' => '角色。', + 'type' => 'string', + 'enumValueTitles' => ['客服' => '客服', '客户' => '客户'], + 'example' => '客服', + ], + 'Begin' => ['description' => '句子开始时间相对会话开始时间的偏移量，单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '240'], + 'End' => ['description' => '句子结束时间相对会话开始时间的偏移量，单位毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '1280'], + 'Words' => ['description' => '对话文本内容。', 'type' => 'string', 'example' => '欢迎致电云联络中心'], + 'Finished' => ['description' => '是否完结', 'type' => 'boolean', 'example' => 'false'], + ], + ], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7E407F9B-A278-52A0-B193-3EE5471D7A87\\",\\n \\"Phrases\\": [\\n {\\n \\"Identity\\": \\"agent@ccc-test\\",\\n \\"Role\\": \\"客服\\",\\n \\"Begin\\": 240,\\n \\"End\\": 1280,\\n \\"Words\\": \\"欢迎致电云联络中心\\",\\n \\"Finished\\": false\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取对话详情', + 'changeSet' => [ + ['createdAt' => '2024-12-12T15:20:46.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConversationDetail'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + ], + 'GetDoNotCallFileUploadParameters' => [ + 'summary' => '调用GetDoNotCallFileUploadParameters获取禁呼文件的上传参数，当通过文件导入禁止外呼号码时，需要先调用此接口将禁呼号码文件上传到云联络中心的公共OSS空间，之后再调用ImportDoNotCallNumbers执行导入。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'JobId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTMAX45'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6538214103685****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => '禁止外呼号码文件的名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'blacklist.xlsx'], ], ], 'responses' => [ @@ -10953,341 +7127,125 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'ContextId' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '103656', - ], - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => '系统自增ID，客户不用关注。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'ANSWERED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => 'MONITORING', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'CONSULTANT', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - ], - ], - ], + 'FilePath' => ['description' => 'OSS文件的Key。', 'type' => 'string', 'example' => 'ccc-test/blacklist.xlsx'], + 'Signature' => ['description' => '文件上传临时凭证的签名信息，用于上传时验证合法性。', 'type' => 'string', 'example' => 'zi31STIMtIfa/UN2l+6lww****'], + 'Host' => ['description' => 'OSS的接入域名。', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com'], + 'Policy' => ['description' => '签名策略。', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMi0wMy0xNVQwMzowMzo0MC4zMTJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwidGVtcC9ibGFja2xpc3QvaW1wb3J0LzE1NzcyNDcxMTU0OTA0MDEvY2NjVjIta216LzIwMjIE1MTAwMzQwLyJd****'], + 'ExpireTime' => ['description' => '过期时间，格式为Unix时间戳，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '1647313420'], + 'AccessKeyId' => ['description' => '签名使用的accessKeyId。', 'type' => 'string', 'example' => '****'], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.ChannelId', - 'errorMessage' => 'The specified channel %s does not exist in call %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103656,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"CONSULTANT\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 10\\n 无\\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '取消咨询转移', - 'summary' => '调用CancelAttendedTransfer取消咨询转接，在发起咨询转接后，完成咨询转接前，均可调用该接口取消咨询转接，即使被转接方已经接通，也可以取消。', + 'title' => '获取禁呼文件上传参数', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDoNotCallFileUploadParameters'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"FilePath\\": \\"ccc-test/blacklist.xlsx\\",\\n \\"Signature\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"Host\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyMi0wMy0xNVQwMzowMzo0MC4zMTJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwidGVtcC9ibGFja2xpc3QvaW1wb3J0LzE1NzcyNDcxMTU0OTA0MDEvY2NjVjIta216LzIwMjIE1MTAwMzQwLyJd****\\",\\n \\"ExpireTime\\": 1647313420,\\n \\"AccessKeyId\\": \\"****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n\\n eyJleHBpcmF0aW9uIjoiMjAyMi0wMy0xNVQwMzowMzo0MC4zMTJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwidGVtcC9ibGFja2xpc3QvaW1wb3J0LzE1NzcyNDcxMTU0OTA0MDEvY2NjVjIta216LzIwMjIE1MTAwMzQwLyJdXX0=\\n temp/blacklist/import/157724711549xxxx/ccc-test/20220315100340/blacklist.xlsx\\n LTAI4GDDtCgcY8HmXTiExxxx\\n zi31STIMtIfa/UN2l+6lwwe9o=\\n https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com\\n 1647313420\\n\\nOK\\ntrue","errorExample":""}]', ], - 'CoachCall' => [ - 'methods' => [ - 'post', - 'get', + 'GetDocumentUploadParameters' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => ['description' => '文件名称。', 'type' => 'string', 'required' => true, 'example' => 'blacklist.xlsx'], + ], + [ + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '24BE19E8-BF7D-4992-A35E-15EBA874F2E5'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'GetTempAttachmentUploadUrlResponse', + 'description' => 'GetTempAttachmentUploadUrlResponse', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'AccessKeyId' => ['title' => '签名使用的accessKeyId', 'description' => '签名使用的accessKeyId', 'type' => 'string', 'example' => '****'], + 'Policy' => ['title' => '签名策略', 'description' => '签名策略', 'type' => 'string', 'example' => 'Permit'], + 'Signature' => ['title' => '签名', 'description' => '签名', 'type' => 'string', 'example' => 'zi31STIMtIfa/UN2l+6lww****'], + 'FilePath' => ['title' => 'oss文件路径', 'description' => 'oss文件路径', 'type' => 'string', 'example' => 'ccc-test/blacklist.xlsx'], + 'Host' => ['title' => 'oss host', 'description' => 'oss host', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com'], + 'ExpireTime' => ['title' => '到期时间', 'description' => '到期时间', 'type' => 'integer', 'format' => 'int32', 'example' => '1647313420'], + ], + ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"AccessKeyId\\": \\"****\\",\\n \\"Policy\\": \\"Permit\\",\\n \\"Signature\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"FilePath\\": \\"ccc-test/blacklist.xlsx\\",\\n \\"Host\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com\\",\\n \\"ExpireTime\\": 1647313420\\n },\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取导入Document上传地址', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'GetEarlyMediaRecording' => [ + 'summary' => '获取指定实例下的通话早媒体音频。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11296,76 +7254,109 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccKYIENB'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'ContactId', 'in' => 'query', + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103689****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '发起辅导的坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'FileUrl' => ['description' => '录音文件的OSS下载地址，注意下载地址的过期时间，下载地址的有效期为1天。', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****'], + 'FileName' => ['description' => '录音文件名称。', 'type' => 'string', 'example' => 'job-6538214103689****-earlyMedia.wav'], + ], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '获取通话早媒体音频', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEarlyMediaRecording'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"job-6538214103689****-earlyMedia.wav\\"\\n }\\n}","type":"json"}]', + ], + 'GetHistoricalCallerReport' => [ + 'summary' => '调用GetHistoricalCallerReport获取指定实例下指定来电号码的历史呼入报表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DeviceId', + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'JobId', + 'name' => 'CallingNumber', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-65382141036853491', - ], + 'schema' => ['description' => '来电号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1900000****'], ], [ - 'name' => 'CoachedUserId', + 'name' => 'StopTime', 'in' => 'query', - 'schema' => [ - 'description' => '被辅导的坐席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'coached-agent@ccc-test', - ], + 'schema' => ['description' => '查询的结束时间戳，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '4102416000000', 'minimum' => '0', 'example' => '1646928000000'], ], [ - 'name' => 'TimeoutSeconds', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '辅导超时时间，超过指定时间辅导没有建立，则取消辅导操作，此字段选填，默认30，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '3600', - 'minimum' => '0', - 'example' => '30', - ], + 'schema' => ['description' => '查询的开始时间戳，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '4102416000000', 'minimum' => '0', 'example' => '1646841600000'], ], ], 'responses' => [ @@ -11373,354 +7364,50 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'COACH', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'ANSWERED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => 'COACHING', - ], - 'SkillGroupId' => [ - 'description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'COACH', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956370', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DeviceState' => [ - 'description' => 'SIP话机设备的状态，如果未注册SIP话机，则状态为UNREGISTERED（未注册），如过SIP话机注册过但是不在线，则状态为OFFLINE（离线），如果SIP话机注册过并且在线则为ONLINE（在线）。', - 'type' => 'string', - 'enumValueTitles' => [ - 'UNREGISTERED' => '未注册', - 'OFFLINE' => '离线', - 'ONLINE' => '在线', - ], - 'example' => 'UNREGISTERED', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - ], - ], - ], + 'LastCallingTime' => ['description' => '最近一次来电时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1646917200000'], + 'TotalCalls' => ['description' => '该号码在查询时间段的总来电次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidOperation.DeviceState', - 'errorMessage' => 'The operation is not allowed. Device state (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'UserBusy', - 'errorMessage' => 'The user %s you called was busy. Please try again later.', - ], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'], + ['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => '该参数无效。'], ], - 403 => [ - [ - 'errorCode' => 'Permission.Common', - 'errorMessage' => 'You have no permission to access. %s', - ], - ], - [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"COACH\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"COACHING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"COACH\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956370,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"UNREGISTERED\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n无\\n\\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 1\\n 无\\n skg-default@ccc-test\\n ch:user:139xxxx0501->8032xxxx:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n COACHING\\n user-test@ccc-test\\n 8032xxxx\\n job-65382141036853491\\n \\n \\n \\n BREAK\\n ccc-test\\n Warm-up\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n false\\n 86-132xxxx4730\\n 无\\n 8032xxxx\\n UNREGISTERED\\n user-test@ccc-test\\n 1609136956378\\n job-65382141036853491\\n ON_SITE\\n 1609136956370\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', - 'title' => '辅导通话', - 'summary' => '调用CoachCall辅导指定实例下指定通话ID对应的通话中的指定坐席，辅导过程中被辅导坐席可以听到辅导者的声音，客户无法听到辅导者的声音。', + 'title' => '获取历史来电报表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CompleteAttendedTransfer' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalCallerReport'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"LastCallingTime\\": 1646917200000,\\n \\"TotalCalls\\": 10\\n }\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n\\n 1646917200000\\n 10\\n\\nOK","errorExample":""}]', + ], + 'GetHistoricalCampaignReport' => [ + 'summary' => '调用GetHistoricalCampaignReport接口获取指定实例下指定ID对应的预测式外呼活动的历史数据报表。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11729,53 +7416,107 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'CampaignId', 'in' => 'query', + 'schema' => ['title' => '活动ID', 'description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '4fc85829-f6fc-476e-9c0d-c350184e36f1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '发起咨询转接的坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E3A847C1-9800-57DF-9172-2CDDC026388D'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'CallsConnected' => ['description' => '已接通数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'CallsDialed' => ['description' => '已呼叫次数，包括重呼次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAbandoned' => ['description' => '已呼损数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'ConnectedRate' => ['description' => '已废弃，请参考AnswerRate。', 'type' => 'number', 'format' => 'float', 'example' => '0.50'], + 'AnswerRate' => ['description' => '接通率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0.50'], + 'AbandonedRate' => ['description' => '已废弃，请参考AbandonRate。', 'type' => 'number', 'format' => 'float', 'example' => '0.10'], + 'AbandonRate' => ['description' => '呼损率，计算方式为：已呼损数量/总数。', 'type' => 'number', 'format' => 'float', 'example' => '0.10'], + 'OccupancyRate' => ['description' => '坐席利用率，计算方式为：（总通话时长+总话后处理时长）/总坐席在线时长，总坐席在线时长表示该活动关联的技能组下的所有坐席的在线时长。', 'type' => 'number', 'format' => 'float', 'example' => '0.50'], + ], + ], + ], ], ], + ], + 'title' => '获取预测式外呼活动历史数据报表', + 'changeSet' => [ + ['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalCampaignReport'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E3A847C1-9800-57DF-9172-2CDDC026388D\\",\\n \\"Data\\": {\\n \\"CallsConnected\\": 50,\\n \\"CallsDialed\\": 100,\\n \\"CallsAbandoned\\": 5,\\n \\"ConnectedRate\\": 0.5,\\n \\"AnswerRate\\": 0.5,\\n \\"AbandonedRate\\": 0.1,\\n \\"AbandonRate\\": 0.1,\\n \\"OccupancyRate\\": 0.5\\n }\\n}","type":"json"}]', + ], + 'GetHistoricalInstanceReport' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], [ - 'name' => 'DeviceId', + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'JobId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6538214103685****', - ], + 'schema' => ['description' => '获取的历史数据的起始时间，格式为Unix时间戳，单位毫秒，非必填，默认为当天的0时，最早为当前时间往前180天，统计的时间精度为小时，向前取整，闭区间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '获取的历史数据的终止时间，格式为Unix时间戳，单位毫秒，非必填，默认为当前时间，统计的时间精度为小时，向后取整，开区间。例如：开始时间为11:12:20，结束时间为11:45:50，则对齐后的入参时间范围为[11:00:00,12:00:00) ，即大于等于11点，小于12点。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000'], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO'], ], ], 'responses' => [ @@ -11783,346 +7524,350 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'ContextId' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '103652', - ], - 'CallContext' => [ - 'description' => '话务上下文环境。', + 'Inbound' => [ + 'description' => '呼入数据。', 'type' => 'object', 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsVoicemail' => ['description' => '转语音信箱的通话数量，当通话进入了IVR中配置的语音信箱模块，计数加1。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxAbandonedInIVRTime' => ['description' => '最大IVR放弃时长，单位秒。IVR放弃的定义是客户在IVR交互过程中挂机，不包括排队状态下客户挂机，不包括通话分配坐席后坐席振铃过程中客户挂机。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsHandled' => ['description' => '应答量，即被坐席应答的通话数量，若一通电话被多个坐席应答，只算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsIVRException' => ['description' => '发生IVR异常的通话数量，判定条件是IVR进入了挂机原因节点且挂机原因节点设置的挂机原因为转人工失败，此时计数加1。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInIVR' => ['description' => 'IVR放弃量，即电话进入IVR流程之后在IVR环节客户挂机的数量，判断依据为通话详情的挂断原因为IVR放弃。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxAbandonTime' => ['description' => '最大放弃时长，单位秒。放弃的定义是通话进入IVR后，坐席接起前，客户发起挂机。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageAbandonTime' => ['description' => '平均放弃时长，单位秒。计算公式为：TotalAbandonTime/CallsAbandoned。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsRinged' => ['description' => '座席振铃的电话数量，若一通电话分配给多个座席并产生了振铃，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsQueuingFailed' => ['description' => '队列失败量，即电话进入队列之后在排队环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AbandonRate' => ['description' => '放弃率。计算公式为：CallsAbandoned/CallsOffered（由于放弃事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxAbandonedInRingTime' => ['description' => '最大振铃放弃时长，单位秒。振铃放弃的定义是通话分配到坐席后，坐席正在振铃，此时客户挂机。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsBlindTransferred' => ['description' => '直接转接量，即发生直接转接的电话数量。若一通电话发起多次转接，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageAbandonedInIVRTime' => ['description' => '平均IVR放弃时长，单位秒。计算公式为：TotalAbandonedInIVRTime/CallsAbandonedInIVR。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageAbandonedInQueueTime' => ['description' => '平均排队放弃时长，单位秒。计算公式为：TotalAbandonedInQueueTime/CallsAbandonedInQueue。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxWaitTime' => ['description' => '最大等待时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsAttendedTransferred' => ['description' => '咨询转接量，即发生咨询转接的电话数量。若一通电话发起多次转接，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalAbandonedInIVRTime' => ['description' => '总IVR放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsQueuingOverflow' => ['description' => '队列溢出的通话数量，队列溢出指通话在IVR排队时队列溢出。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInRing' => ['description' => '振铃放弃量，即坐席振铃过程中发生客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalAbandonedInRingTime' => ['description' => '总振铃放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWaitTime' => ['description' => '平均等待时长，平均每通电话的坐席接起前等待时长。计算公式为： TotalWaitTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为： TotalWorkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsQueued' => ['description' => '进入队列的电话数量，若一通电话多次进入队列，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageAbandonedInRingTime' => ['description' => '平均振铃放弃时长，单位秒。计算公式为：TotalAbandonedInRingTime/CallsAbandonedInRing。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsAbandoned' => ['description' => '放弃量。计算公式为：CallsAbandonedInIVR+CallsAbandonedInQueue+CallsAbandonedInRing。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxAbandonedInQueueTime' => ['description' => '最大排队放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInVoiceNavigator' => ['description' => '通话在智能导航模块放弃的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWaitTime' => ['description' => '总等待时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalAbandonTime' => ['description' => '总放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '呼入到云联络中心的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsQueuingTimeout' => ['description' => '在排队阶段超时的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ServiceLevel20' => ['description' => '20S服务水平，等待时长小于等于20秒的电话数量/CallsQueued。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsForwardToOutsideNumber' => ['description' => '发生转外线的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的电话数量。若一通电话保持多次，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsAbandonedInQueue' => ['description' => '队列放弃量，即电话进入队列之后在排队环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalAbandonedInQueueTime' => ['description' => '总排队放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsCausedIVRException' => ['description' => '导致IVR异常的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsToVoicemail' => ['description' => '进入语音信箱的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'ServiceLevel15' => ['description' => '15秒服务水平。', 'type' => 'number', 'format' => 'float', 'example' => '0.78'], + 'ServiceLevel30' => ['description' => '30秒服务水平。', 'type' => 'number', 'format' => 'float', 'example' => '0.9'], + 'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], + 'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长，单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '12'], + 'AccessChannelTypeDetailList' => [ + 'description' => '各渠道的统计数据。', 'type' => 'array', 'items' => [ - 'description' => '话务通道。', + 'description' => '渠道的统计数据。', 'type' => 'object', 'properties' => [ - 'Index' => [ - 'description' => '系统自增ID，客户不用关注。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'ANSWERED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => 'MONITORING', - ], - 'SkillGroupId' => [ - 'description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', - ], + 'AccessChannelType' => ['description' => '渠道类型。', 'type' => 'string', 'example' => 'Web'], + 'CallsOffered' => ['description' => '分配的会话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], ], ], ], + 'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '15'], ], ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', + 'Outbound' => [ + 'description' => '呼出指标。', 'type' => 'object', 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****'."\n", - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsRinged' => ['description' => '坐席振铃的电话数量，若一通电话分配给多个坐席并产生了振铃，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsBlindTransferred' => ['description' => '直接转接量，即发生直接转接的电话数量。若一通电话发起多次转接，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsAnswered。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsAttendedTransferred' => ['description' => '咨询转接量，即发生咨询转接的电话数量。若一通电话发起多次转接，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的电话数量。若一通电话保持多次，算一次。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。计算公式为：TotalDialingTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + ], + ], + 'Overall' => [ + 'description' => '整体指标。', + 'type' => 'object', + 'properties' => [ + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。不包含小休时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OccupancyRate' => ['description' => '座席利用率，计算公式为： (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageBreakTime' => ['description' => '平均小休时长，单位秒。计算公式为：TotalBreakTime/小休次数。小休次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxBreakTime' => ['description' => '最大小休时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/TotalCalls。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/(CallsAnswered+CallsHandled)。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位秒。计算公式为：TotalReadyTime/就绪次数，就绪次数暂不对外暴露。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话量。计算公式为：CallsOffered + CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxLoggedInAgents' => ['description' => '此时间范围内最多同时登录的座席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '102'], + ], + ], + 'Internal' => [ + 'description' => '内部呼叫指标。', + 'type' => 'object', + 'properties' => [ + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], + ], + 'title' => '获取历史实例数据报表', + 'summary' => '调用GetHistoricalInstanceReport获取指定实例的历史数据报表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalInstanceReport'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": {\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsVoicemail\\": 0,\\n \\"MaxAbandonedInIVRTime\\": 100,\\n \\"CallsHandled\\": 0,\\n \\"CallsIVRException\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsQueuingFailed\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"AbandonRate\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AverageAbandonedInIVRTime\\": 0,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"MaxWaitTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"TotalAbandonedInIVRTime\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"AverageWaitTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsQueued\\": 0,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInVoiceNavigator\\": 0,\\n \\"TotalWaitTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"CallsForwardToOutsideNumber\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"CallsCausedIVRException\\": 0,\\n \\"CallsToVoicemail\\": 3,\\n \\"ServiceLevel15\\": 0.78,\\n \\"ServiceLevel30\\": 0.9,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 8,\\n \\"TotalMessagesSentByCustomer\\": 4,\\n \\"AverageFirstResponseTime\\": 12,\\n \\"AccessChannelTypeDetailList\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 5\\n }\\n ],\\n \\"AverageResponseTime\\": 15\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0,\\n \\"MaxLoggedInAgents\\": 102\\n },\\n \\"Internal\\": {\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"943D8EF3-3321-471F-A104-51C96FCA94D6\\n无\\n200\\n\\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n\\nOK","errorExample":""}]', + ], + 'GetInstance' => [ + 'summary' => '调用GetInstance获取指定实例ID所对应的云联络中心实例的详细信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTMAX45'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '实例状态。', + 'type' => 'string', + 'enumValueTitles' => ['RELEASED' => '已释放', 'RUNNING' => '正常运行中', 'STOPPED' => '已停服', 'CREATING' => '创建中'], + 'example' => 'RUNNING', + ], + 'ConsoleUrl' => ['description' => '云联络中心实例的网址，用于访问云联络中心实例的主页面，由云联络中心的特定网址加上实例ID组成。', 'type' => 'string', 'example' => 'https://ccc-v2.aliyun.com/#/workbench/ccc-test'], + 'Description' => ['description' => '实例的描述。', 'type' => 'string', 'example' => '云联络中心的测试实例。'], + 'AliyunUid' => ['description' => '实例所属的阿里云账户ID。', 'type' => 'string', 'example' => '157123456789****'], + 'Name' => ['description' => '实例名称。', 'type' => 'string', 'example' => '测试实例'], + 'DomainName' => ['description' => '实例的域名，全局唯一。', 'type' => 'string', 'example' => 'ccc-test'], + 'Id' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'."\n"], + 'AdminList' => [ + 'description' => '管理员列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '管理员的名称。', 'type' => 'string', 'example' => '管理员'], + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'LoginName' => ['description' => '坐席登录名。', 'type' => 'string', 'example' => 'agent'], + 'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'], + 'WorkMode' => [ + 'description' => '工作模式。'."\n", + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '在呼叫状态时的通话ID。', - 'type' => 'string', - 'example' => 'job-65382141036853491', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1382114****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'RoleName' => [ + 'description' => '角色名称。', + 'type' => 'string', + 'enumValueTitles' => ['Agent' => '坐席', 'Manager' => '技能组组长', 'Admin' => '管理员'], + 'example' => 'Admin', ], - 'example' => 'TALKING', + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'RoleId' => ['description' => '角色ID，格式为：角色@实例ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'], ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', + 'description' => '', + ], + ], + 'NumberList' => [ + 'description' => '号码列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Active' => ['description' => '是否可用。', 'type' => 'boolean', 'example' => 'true'], + 'UserId' => ['description' => '坐席ID。如果此参数不为空，说明该号码是座席个人外呼号码。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '0830011****'], + 'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '乐山'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Usage' => [ + 'description' => '号码用途。', 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', + 'enumValueTitles' => ['Outbound' => '呼出', 'Inbound' => '呼入', 'Bidirection' => '呼入及呼出'], + 'example' => 'Bidirection', + ], + 'ContactFlowId' => ['description' => '该电话号码所关联的联系流ID（IVR）。', 'type' => 'string', 'example' => '2ec7a58f-3243-4815-bb21-97b480b95f5e'], + 'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '四川'], + 'SkillGroups' => [ + 'description' => '号码所关联的技能组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '技能组展示名。', 'type' => 'string', 'example' => '测试技能组'], + 'Description' => ['description' => '技能组描述。', 'type' => 'string', 'example' => '云联络中心的测试技能组。'], + 'PhoneNumberCount' => ['description' => '技能组关联的号码数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'UserCount' => ['description' => '技能组关联的坐席数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Name' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'], + ], + 'description' => '', + ], ], ], + 'description' => '', + ], + ], + 'ChatbotBusinessUnit' => [ + 'type' => 'object', + 'properties' => [ + 'UnitId' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'UnitKey' => ['type' => 'string', 'description' => ''], ], + 'description' => '', ], + 'AgentType' => ['type' => 'string', 'description' => ''], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.ChannelId', - 'errorMessage' => 'The specified channel %s does not exist in call %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103652,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\\\n\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-65382141036853491\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 10\\n skg-default@ccc-test\\n 无\\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '完成咨询转接', - 'summary' => '调用CompleteAttendedTransfer完成咨询转。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'EndConference' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"Data\\": {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ConsoleUrl\\": \\"https://ccc-v2.aliyun.com/#/workbench/ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试实例。\\",\\n \\"AliyunUid\\": \\"157123456789****\\",\\n \\"Name\\": \\"测试实例\\",\\n \\"DomainName\\": \\"ccc-test\\",\\n \\"Id\\": \\"ccc-test\\\\n\\",\\n \\"AdminList\\": [\\n {\\n \\"DisplayName\\": \\"管理员\\",\\n \\"Extension\\": \\"8032****\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ],\\n \\"NumberList\\": [\\n {\\n \\"Active\\": true,\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Number\\": \\"0830011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowId\\": \\"2ec7a58f-3243-4815-bb21-97b480b95f5e\\",\\n \\"Province\\": \\"四川\\",\\n \\"SkillGroups\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"UserCount\\": 3,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\"\\n }\\n ]\\n }\\n ],\\n \\"ChatbotBusinessUnit\\": {\\n \\"UnitId\\": 0,\\n \\"UnitKey\\": \\"\\"\\n },\\n \\"AgentType\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '获取实例', + 'changeSet' => [ + ['createdAt' => '2025-10-16T07:13:16.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'GetInstanceTrendingReport' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12131,39 +7876,34 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '需要退出会议的坐席ID，选填，不填默认为当前RAM账户映射的坐席。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '开始时间戳，默认是当天开始时间，最早为当前时间往前180天，开始和截止时间间隔不能超过7天，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604639129000'], ], [ - 'name' => 'JobId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'job-6538214103685****', - ], + 'schema' => ['description' => '截止时间戳，默认是当前时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604725528000'], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'Audio'], ], ], 'responses' => [ @@ -12171,266 +7911,89 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'CREATED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '8001****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:131888****->8001****:1609225718294:job-65700074013925376', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - ], - ], + 'Inbound' => [ + 'description' => '呼入指标。', + 'type' => 'array', + 'items' => [ + 'description' => '呼入指标分段统计数据。', + 'type' => 'object', + 'properties' => [ + 'StatsTime' => ['description' => '分段统计的开始时间点，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'], + 'CallsQueued' => ['description' => '进入队列的电话数，如果一个电话多次进队列，算一通。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInRing' => ['description' => '振铃放弃量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '座席应答电话数。一通电话分给多个座席，算一通。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总进线量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInIVR' => ['description' => 'IVR放弃量，即电话进入IVR流程之后在IVR环节放弃。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInQueue' => ['description' => '队列放弃量，即电话进入技能组之后在排队环节放弃。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'DeviceState' => [ - 'description' => 'SIP话机设备的状态，如果未注册SIP话机，则状态为UNREGISTERED（未注册），如过SIP话机注册过但是不在线，则状态为OFFLINE（离线），如果SIP话机注册过并且在线则为ONLINE（在线）。', - 'type' => 'string', - 'enumValueTitles' => [ - 'UNREGISTERED' => '未注册', - 'OFFLINE' => '离线', - 'ONLINE' => '在线', - ], - 'example' => 'UNREGISTERED', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], + 'Outbound' => [ + 'description' => '呼出指标。', + 'type' => 'array', + 'items' => [ + 'description' => '呼出指标分段统计数据。', + 'type' => 'object', + 'properties' => [ + 'StatsTime' => ['description' => '分段统计的开始时间点，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'], + 'CallsAnswered' => ['description' => '外呼接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总外呼量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], ], - 'ContextId' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '103655', + 'Overall' => [ + 'description' => '整体指标。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StatsTime' => ['description' => '分段统计的开始时间点，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'], + 'MaxLoggedInAgents' => ['description' => '此时间范围内最多同时登录的座席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '102'], + ], + 'description' => '', + ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0630E5DF-CEB0-445B-8626-D5C7481181C3\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-65700074013925376\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"DeviceState\\": \\"UNREGISTERED\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 103655\\n }\\n}","type":"json"}]', - 'title' => '退出会议', - 'summary' => '调用EndConference使指定坐席退出指定实例下指定通话ID对应的通话，该通话必须处于会议状态。', - ], - 'GetNumberLocation' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '获取实例趋势报表', + 'summary' => '调用GetInstanceTrendingReport获取指定实例的变化趋势报表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-07T07:21:05.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceTrendingReport'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": {\\n \\"Inbound\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"CallsQueued\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalCalls\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"CallsAbandonedInQueue\\": 0\\n }\\n ],\\n \\"Outbound\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"CallsAnswered\\": 0,\\n \\"TotalCalls\\": 0\\n }\\n ],\\n \\"Overall\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"MaxLoggedInAgents\\": 102\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"943D8EF3-3321-471F-A104-51C96FCA94D6\\n无\\n200\\n\\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 1604639129000\\n 0\\n \\n \\n 0\\n 0\\n 1604639129000\\n \\n\\nOK","errorExample":""}]', + ], + 'GetIvrTrackingSummary' => [ + 'summary' => '获取IVR轨迹小结', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -12439,31 +8002,25 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccKJSOHN'], + ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'example' => 'job-489361145506897920'], ], [ - 'name' => 'Number', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待查询的号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1312121****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0f7ad007-ab50-4b3d-a87a-56864eb40dab'], ], ], 'responses' => [ @@ -12471,83 +8028,37 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '584AA2E3-9AC4-561B-BC8D-C74BA11B1387', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'Number' => [ - 'description' => '号码。', - 'type' => 'string', - 'example' => '1312121****', - ], - 'City' => [ - 'description' => '号码归属地市。', - 'type' => 'string', - 'example' => '北京', - ], - 'Province' => [ - 'description' => '号码归属地省。', - 'type' => 'string', - 'example' => '北京', - ], - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Unknown error code \'NoPermission.Recording\'. Reason: null'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '], + 'Data' => ['description' => '返回数据结果。', 'type' => 'string', 'example' => '无'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'], ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"584AA2E3-9AC4-561B-BC8D-C74BA11B1387\\",\\n \\"Data\\": {\\n \\"Number\\": \\"1312121****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n }\\n}","type":"json"}]', - 'title' => '获取号码归属地信息', - 'summary' => '调用接口GetNumberLocation获取号码归属地信息。', - ], - 'HoldCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Unknown error code \'NoPermission.Recording\'. Reason: null\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"Data\\": \\"无\\"\\n}","type":"json"}]', + 'title' => '获取IVR轨迹总结', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'GetLoginDetails' => [ + 'summary' => '调用GetLoginDetails获取坐席的登录信息，包括坐席基本信息、服务器地址信息、鉴权信息等，该接口只允许自己调用，管理员无权替他人调用。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12556,74 +8067,29 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBRR180'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], - ], - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '座席端提供的唯一ID，用来表示一个座席工作台，一个座席可以有多个不同类型的座席台，比如浏览器，iOS, Android等， 但是在同一时间，只能有一个生效。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - ], - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6582589278232****', - ], - ], - [ - 'name' => 'ChannelId', - 'in' => 'query', - 'schema' => [ - 'description' => '待保持的通道ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ch:customer:010123****->1318888****:1609255715825:job-6582589278232****', - ], + 'schema' => ['description' => '坐席ID，非必填，不填则默认使用当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'Music', + 'name' => 'ChatDeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '通话保持音乐的名称，非必填，默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => '无', - ], + 'schema' => ['description' => 'Chat设备ID。', 'type' => 'string', 'required' => false, 'example' => '4c51c9116c36537cb850dc1081d745df'], ], ], 'responses' => [ @@ -12631,321 +8097,82 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '174F7777-2F6C-4F10-B889-C698E26C1AE0', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F1A4774A-F28B-5C40-AEF6-D88D2DD6C7E4'], 'Params' => [ - 'description' => '响应参数列表。', + 'description' => '响应参数', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], 'Data' => [ - 'description' => '数据。', + 'description' => '登录信息数据。', 'type' => 'object', 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。'."\n", - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。'."\n", - 'type' => 'string', - 'example' => 'job-6582589278232****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。'."\n", - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'ANSWERED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '8001****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'SkillGroupId' => [ - 'description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609255716900', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6582589278232****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '1318888****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - ], - ], - ], - ], + 'DisplayName' => ['description' => '坐席展示名。', 'type' => 'string', 'example' => '坐席小王'], + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'], + 'Signature' => ['description' => '签名信息，使用非对称加密算法生成，注册SIP服务器时需要使用该信息进行鉴权。', 'type' => 'string', 'example' => 'zi31STIMtIfa/UN2l+6lww****'], + 'SipServerUrl' => ['description' => 'SIP注册服务器地址，坐席需要以SIP用户的身份注册到服务器上才能进行话务操作。', 'type' => 'string', 'example' => 'sh-sip-ccc.aliyuncs.com:443'], + 'DeviceId' => ['description' => '如果座席注册了SIP话机，则此参数是SIP话机设备的设备ID，否则为空。', 'type' => 'string', 'example' => 'Yealink SIP-T23G 44.84.XX.XX'], + 'AgentServerUrl' => ['description' => '坐席数据推送服务器地址，连接成功后，服务器会推送坐席状态数据到坐席工作台。', 'type' => 'string', 'example' => 'sh-wss-ccc.aliyuncs.com'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'UserKey' => ['description' => '签名数据，用于生成签名信息，由于该签名机制不支持中文，所以目前都使用UserKey2进行签名。', 'type' => 'string', 'example' => '坐席@aliyun:802001:1656406628862'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', ], - 'UserContext' => [ - 'description' => '坐席上下文环境。'."\n", - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609255716908', - ], - 'WorkMode' => [ - 'description' => '工作模式。'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609255715822', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1390000****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6582589278232****', - ], - 'UserState' => [ - 'description' => '座席状态。'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - ], - ], + 'UserKey2' => ['description' => '签名数据，用于生成签名信息，由于UserKey不支持中文签名，因此新增了UserKey2。', 'type' => 'string', 'example' => '802001:1656406628862"'], + 'Signature2' => ['description' => '签名信息，使用非对称加密算法生成，注册SIP服务器时需要使用该信息进行鉴权。', 'type' => 'string', 'example' => 'zi31STIMtIfa/UN2l+6lww****'], + 'DeviceExt' => ['description' => 'SIP设备分机号，使用SIP话机时需要用到该字段。', 'type' => 'string', 'example' => '8033****'], + 'DeviceState' => [ + 'description' => 'SIP设备状态。', + 'type' => 'string', + 'enumValueTitles' => ['UNREGISTERED' => '未注册', 'ONLINE' => '在线', 'OFFLINE' => '离线'], + 'example' => 'OFFLINE', ], + 'ChatUserId' => ['description' => 'Chat会话设备ID。', 'type' => 'string', 'example' => 'A-8000100x'], + 'ChatDeviceId' => ['description' => 'Chat设备ID。', 'type' => 'string', 'example' => '4c51c9116c36537cb850dc1081d745df'], + 'ChatLoginToken' => ['description' => 'Chat会话登录令牌。', 'type' => 'string', 'example' => '{"accessToken":"oauth_cloud_key:4xxx0=","accessTokenExpiredTime":864xxxx,"refreshToken":"oauth_cloud_key:Paxxxx=="}'], + 'ChatAppId' => ['description' => 'Chat会话应用ID。', 'type' => 'string', 'example' => '7pjxxx'], + 'ChatAppKey' => ['description' => 'Chat会话应用密钥。', 'type' => 'string', 'example' => '955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0'], + 'ChatServerUrl' => ['description' => 'Chat会话服务器地址。', 'type' => 'string', 'example' => 'wss://wss.im.dingtalk.cn'], + 'Nickname' => ['description' => '坐席昵称', 'type' => 'string', 'example' => '老王'], + 'AvatarUrl' => ['description' => '坐席头像地址。', 'type' => 'string', 'example' => 'http://abc.com/sam.jpb'], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.ChannelId', - 'errorMessage' => 'The specified channel %s does not exist in call %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"174F7777-2F6C-4F10-B889-C698E26C1AE0\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6582589278232****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609255716900,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6582589278232****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8001****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609255716908,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609255715822,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6582589278232****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"174F7777-2F6C-4F10-B889-C698E26C1AE0\\n无\\n200\\n无\\n\\n \\n 无\\n OUTBOUND\\n job-65825892782321664\\n \\n 8001****\\n ANSWERED\\n 无\\n 1318888****\\n 无\\n user-test@ccc-test\\n 8001****\\n OUTBOUND\\n 无\\n skill-group@ccc-test\\n ch:user:1318888****->8001****:1609255715825:job-65825892782321664\\n 1609255716900\\n job-65825892782321664\\n \\n \\n \\n 8001****\\n TALKING\\n ccc-test\\n Warm-up\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bs990cd82101cc000176af19ec8e\\n 1609255716908\\n false\\n 1390000****\\n job-65825892782321664\\n ON_SITE\\n 1609255715822\\n [\\"skill-group@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', - 'title' => '保持通话', - 'summary' => '调用HoldCall保持指定实例下指定通话ID对应的通话，通话被保持后，将暂时被挂起，此时被保持方会听到保持音乐。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'InitiateAttendedTransfer' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '获取登录信息', + 'changeSet' => [ + ['createdAt' => '2023-11-07T07:21:07.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-12-22T06:05:17.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLoginDetails'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"F1A4774A-F28B-5C40-AEF6-D88D2DD6C7E4\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"Extension\\": \\"8001****\\",\\n \\"Signature\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"SipServerUrl\\": \\"sh-sip-ccc.aliyuncs.com:443\\",\\n \\"DeviceId\\": \\"Yealink SIP-T23G 44.84.XX.XX\\",\\n \\"AgentServerUrl\\": \\"sh-wss-ccc.aliyuncs.com\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"UserKey\\": \\"坐席@aliyun:802001:1656406628862\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"UserKey2\\": \\"802001:1656406628862\\\\\\"\\",\\n \\"Signature2\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"DeviceExt\\": \\"8033****\\",\\n \\"DeviceState\\": \\"OFFLINE\\",\\n \\"ChatUserId\\": \\"A-8000100x\\",\\n \\"ChatDeviceId\\": \\"4c51c9116c36537cb850dc1081d745df\\",\\n \\"ChatLoginToken\\": \\"{\\\\\\"accessToken\\\\\\":\\\\\\"oauth_cloud_key:4xxx0=\\\\\\",\\\\\\"accessTokenExpiredTime\\\\\\":864xxxx,\\\\\\"refreshToken\\\\\\":\\\\\\"oauth_cloud_key:Paxxxx==\\\\\\"}\\",\\n \\"ChatAppId\\": \\"7pjxxx\\",\\n \\"ChatAppKey\\": \\"955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0\\",\\n \\"ChatServerUrl\\": \\"wss://wss.im.dingtalk.cn\\",\\n \\"Nickname\\": \\"老王\\",\\n \\"AvatarUrl\\": \\"http://abc.com/sam.jpb\\"\\n }\\n}","type":"json"}]', + ], + 'GetMonoRecording' => [ + 'summary' => '调用GetMonoRecording获取指定实例下指定通话的单轨录音，单轨录音只有一个音轨，坐席侧和客户侧的录音合并到了同一个音轨上，格式为WAV。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12954,185 +8181,188 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '发起咨询转接的坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103689****'], ], [ - 'name' => 'DeviceId', + 'name' => 'ExpireSeconds', 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ACC-YUNBS-1.0.10-****', - ], + 'schema' => ['description' => '过期时间，单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300'], ], - [ - 'name' => 'Transferor', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '转接发起方，当场景是咨询转接到外部号码时，用此参数指定的号码作为主叫，转内部坐席或技能组时，此参数无效，发起方由UserId指定。', - 'type' => 'string', - 'required' => false, - 'example' => '无', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'FileUrl' => ['description' => '录音文件的OSS下载地址，注意下载地址的过期时间，下载地址的有效期为1天。', 'type' => 'string', 'example' => 'http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-6538214103689****.wav?Expires=1610910578&OSSAccessKeyId=****&Signature=****'], + 'FileName' => ['description' => '录音文件名称。', 'type' => 'string', 'example' => 'job-6538214103689****.wav'], + 'Duration' => ['description' => '录音时长，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '30000'], + ], + ], + ], + 'description' => '', ], ], - [ - 'name' => 'Transferee', - 'in' => 'query', - 'schema' => [ - 'description' => '被转接方，可以是坐席ID或技能组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent2@ccc-test', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], ], - [ - 'name' => 'TimeoutSeconds', - 'in' => 'query', - 'schema' => [ - 'description' => '咨询转接超时时间，超过指定时间被转接方没有接起通话，则挂断通话，此字段选填，默认30，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6538214103685****', - ], + ], + 'title' => '获取单轨录音', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-06-05T09:01:48.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '400', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMonoRecording'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-6538214103689****.wav?Expires=1610910578&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"job-6538214103689****.wav\\",\\n \\"Duration\\": 30000\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-65382141036893491.wav?Expires=1610910578&OSSAccessKeyId=XXXX&Signature=XXXX\\n job-65382141036893491.wav\\n\\nOK","errorExample":""}]', + ], + 'GetMultiChannelRecording' => [ + 'summary' => '调用GetMultiChannelRecording获取指定实例下指定通话的多轨录音，多轨录音中坐席和客户的录音分布在不同的声道上，每次播放时只能单个声道播放，也就是只能听到其中一方的声音，格式为MKV。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CallPriority', - 'in' => 'query', - 'schema' => [ - 'description' => '转接到技能组队列时的排队优先级，取值范围0-9，0优先级最高，9最低。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'AK' => [], ], [ - 'name' => 'StrategyName', - 'in' => 'query', - 'schema' => [ - 'description' => '转接到技能组队列时的座席分配策略名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'MOST_IDLE，MOST_SKILLED，MOST_ACQUAINTED，CUSTOMIZED等', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccKYIENB'], + ], + 'parameters' => [ [ - 'name' => 'StrategyParams', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '转接到技能组队列时的座席分配策略参数。', - 'type' => 'string', - 'required' => false, - 'example' => '当分配策略为CUSTOMIZED时，本参数的内容为如下格式：'."\n" - .' {'."\n" - .' "functionId": "512fed64-e379-400f-a1a5-14d5730xxxxx",'."\n" - .' "functionName": "routing-strategy-test-2"'."\n" - .'}', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'TransfereeType', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '转接目的类型，可选值为AGENT，SKILL_GROUP和EXTERNAL。如果此参数不传，则系统会根据转接的目标号码的格式进行判断，如果发现有判不准确的情况，则需要指定此参数。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'AGENT' => '座席', - 'EXTERNAL' => '外部号码', - 'SKILL_GROUP' => '技能组', - ], - 'example' => 'SKILL_GROUP', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103689****'], ], - [ - 'name' => 'RoutingType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '话务分配类型，可选参数为自动分配(Automatic)或者手动分配(Manual)。如果此参数为空，则默认为自动分配的方式，这也是当前系统的默认行为。选择手动分配方式时，需要您自己配合调用ClaimCall等接口把电话分给指定的座席。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Manual' => '手动分配', - 'Automatic' => '自动分配', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'FileUrl' => ['description' => '录音文件的OSS下载地址，注意下载地址的过期时间，下载地址的有效期为1天。', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2021/04/job-6538214103689****.mkv?Expires=1617435462&OSSAccessKeyId=****&Signature=****'], + 'FileName' => ['description' => '录音文件名称。', 'type' => 'string', 'example' => 'job-6538214103689****.mkv'], + ], + ], ], - 'example' => 'Automatic', + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '获取多轨录音', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMultiChannelRecording'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2021/04/job-6538214103689****.mkv?Expires=1617435462&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"job-6538214103689****.mkv\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-65382141036893491.mkv?Expires=1610910578&OSSAccessKeyId=XXXX&Signature=XXXX\\n job-65382141036893491.mkv\\n\\nOK","errorExample":""}]', + ], + 'GetNumberLocation' => [ + 'summary' => '调用接口GetNumberLocation获取号码归属地信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Tags', - 'in' => 'query', - 'schema' => [ - 'description' => '随路数据，主要用于扩展需求，普通用户无需关心。', - 'type' => 'string', - 'required' => false, - 'example' => 'a=b', - ], + 'AK' => [], ], [ - 'name' => 'QueuingTimeoutSeconds', + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '当转接目标是技能组队列时排队超时时间，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'QueuingOverflowThreshold', + 'name' => 'Number', 'in' => 'query', - 'schema' => [ - 'description' => '当转接目标是技能组队列时排队溢出阈值。默认值为0，表示不溢出。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '待查询的号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312121****'], ], ], 'responses' => [ @@ -13140,333 +8370,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '584AA2E3-9AC4-561B-BC8D-C74BA11B1387'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'ContextId' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '103655', - ], - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => '记录这个Channel在通话过程中创建的顺序。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'ANSWERED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => 'MONITORING', - ], - 'SkillGroupId' => [ - 'description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '通道ID。', - 'type' => 'string', - 'example' => 'ch:user:139xxxx0501->80326034:1609138902226:job-6538214103685****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - ], - ], - ], + 'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '1312121****'], + 'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '北京'], + 'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '北京'], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], ], 404 => [ - [ - 'errorCode' => 'NotExists.ChannelId', - 'errorMessage' => 'The specified channel %s does not exist in call %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ], + 'title' => '获取号码归属地信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNumberLocation'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103655,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:139xxxx0501->80326034:1609138902226:job-6538214103685****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 10\\n skg-default@ccc-test\\n 无\\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '发起咨询转接', - 'summary' => '咨询转接通话到其他坐席或某个技能组队列或外部号码，咨询转接也叫关注转或双步转。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"584AA2E3-9AC4-561B-BC8D-C74BA11B1387\\",\\n \\"Data\\": {\\n \\"Number\\": \\"1312121****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n }\\n}","type":"json"}]', ], - 'InterceptCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetRealtimeCampaignStats' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13475,76 +8419,108 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'."\n"], ], [ - 'name' => 'UserId', + 'name' => 'QueueId', 'in' => 'query', + 'schema' => ['title' => '活动ID', 'description' => '预测式外呼活动ID。'."\n" + ."\n", 'type' => 'string', 'required' => true, 'example' => 'skillgroup@ccc-test'."\n"], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '发起强拆的坐席。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '42970829-E2C8-515A-8F42-5A6B59F852A7'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'LoggedInAgents' => ['description' => '在线坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'ReadyAgents' => ['description' => '空闲坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'BreakingAgents' => ['description' => '小休坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TalkingAgents' => ['description' => '通话中坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'WorkingAgents' => ['description' => '话后处理坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'Caps' => ['description' => '每秒并发呼叫量，并发指同时呼叫。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'TotalAgents' => ['description' => '所有坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'OutboundScenarioReadyAgents' => ['description' => '处于仅外呼模式且在空闲状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'OutboundScenarioBreakingAgents' => ['description' => '处于仅外呼模式且在小休状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'OutboundScenarioTalkingAgents' => ['description' => '处于仅外呼模式且在通话中状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'OutboundScenarioWorkingAgents' => ['description' => '处于仅外呼模式且在话后处理状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + ], + ], ], ], - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + ], + 'title' => '获取预测式外呼活动实时坐席状态', + 'summary' => '调用GetRealtimeCampaignStats获取指定实例下指定ID对应的预测式外呼活动的实时坐席状态数据。', + 'changeSet' => [ + ['createdAt' => '2023-11-07T07:21:06.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealtimeCampaignStats'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"42970829-E2C8-515A-8F42-5A6B59F852A7\\",\\n \\"Data\\": {\\n \\"LoggedInAgents\\": 10,\\n \\"ReadyAgents\\": 3,\\n \\"BreakingAgents\\": 1,\\n \\"TalkingAgents\\": 4,\\n \\"WorkingAgents\\": 2,\\n \\"Caps\\": 5,\\n \\"TotalAgents\\": 10,\\n \\"OutboundScenarioReadyAgents\\": 1,\\n \\"OutboundScenarioBreakingAgents\\": 1,\\n \\"OutboundScenarioTalkingAgents\\": 1,\\n \\"OutboundScenarioWorkingAgents\\": 1\\n }\\n}","type":"json"}]', + ], + 'GetRealtimeInstanceStates' => [ + 'summary' => '调用GetRealtimeInstanceStates获取指定实例的实时状态。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6538214103685****', - ], + 'AK' => [], ], [ - 'name' => 'InterceptedUserId', + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTMAX45'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '被强拆的座席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent2@ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'TimeoutSeconds', + 'name' => 'MediaType', 'in' => 'query', 'schema' => [ - 'description' => '强拆超时时间，经过指定的时间强拆仍未成功，则取消强拆，正常情况下，强拆操作会马上成功，设置超时时间是为了防止异常发生，此字段选填，默认30，单位秒。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '媒体类型，默认是语音(AUDIO)。', + 'type' => 'string', 'required' => false, - 'maximum' => '3600', - 'minimum' => '0', - 'example' => '60', + 'enumValueTitles' => ['ALL' => '全部', 'VIDEO' => '视频', 'CHAT' => '聊天', 'AUDIO' => '语音'], + 'example' => 'AUDIO', ], ], ], @@ -13553,754 +8529,171 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'INTERCEPT', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'ANSWERED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => '无', - ], - 'SkillGroupId' => [ - 'description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'INTERCEPT', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], + 'WorkingAgents' => ['description' => '处于话后处理状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'LongestWaitingTime' => ['description' => '当前正在排队的来电的最大排队等待时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'LoggedInAgents' => ['description' => '在线坐席数量（包括就绪，小休，通话等非下线状态的坐席）。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalAgents' => ['description' => '总坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'WaitingCalls' => ['description' => '当前正在排队的来电的个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'BreakingAgents' => ['description' => '处于小休状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TalkingAgents' => ['description' => '处于通话状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'InteractiveCalls' => ['description' => '正在IVR中交互的电话的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ReadyAgents' => ['description' => '处于就绪状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'BreakCodeDetailList' => [ + 'description' => '各个小休码次数分布列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BreakCode' => ['description' => '小休码。', 'type' => 'string', 'example' => '默认'], + 'Count' => ['description' => '小休次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"INTERCEPT\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"无\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"INTERCEPT\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 10\\n skg-default@ccc-test\\n 无\\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '强拆通话', - 'summary' => '调用InterceptCall强行拆开指定实例下指定通话ID对应的通话，通话必须处于监听状态，且由监听者发起强拆，强拆成功后，原本与客户通话的坐席会被挂断，发起强拆的坐席代替原坐席继续与客户通话。', + 'title' => '获取实时实例状态', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'LaunchAuthentication' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-11-07T07:21:06.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealtimeInstanceStates'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": {\\n \\"WorkingAgents\\": 0,\\n \\"LongestWaitingTime\\": 0,\\n \\"LoggedInAgents\\": 0,\\n \\"TotalAgents\\": 0,\\n \\"WaitingCalls\\": 0,\\n \\"BreakingAgents\\": 0,\\n \\"TalkingAgents\\": 0,\\n \\"InteractiveCalls\\": 0,\\n \\"ReadyAgents\\": 0,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"默认\\",\\n \\"Count\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"943D8EF3-3321-471F-A104-51C96FCA94D6\\n无\\n200\\n\\n 0\\n 0\\n ccc-test\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n\\nOK","errorExample":""}]', + ], + 'GetSchema' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '发起核身的坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'name' => 'SchemaId', + 'in' => 'formData', + 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'], ], [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ACC-YUNBS-1.0.10-****', - ], + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], ], [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6538214103685****', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx'], ], - [ - 'name' => 'ContactFlowId', - 'in' => 'query', - 'schema' => [ - 'description' => 'IVR核身流程的联系流ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'af145gfc-1108-4d55-8fca-f719bd512ebb', - ], - ], - [ - 'name' => 'ContactFlowVariables', - 'in' => 'query', - 'schema' => [ - 'description' => '传递给联系流的变量，选填，这里配置的变量，可以在IVR流程中拿到并使用，格式为JSON字符串格式的键值对集合。', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "customerID": "208880281831****",'."\n" - .' "operateType": "cipherCode",'."\n" - .' "taskId": "1234567890",'."\n" - .' "crmOther": "123"'."\n" - .'}', - ], - ], - ], - 'responses' => [ - 200 => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'title' => 'GetSchemaResponse', + 'description' => 'GetSchemaResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '呼叫类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'ANSWERED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => 'MONITORING', - ], - 'SkillGroupId' => [ - 'description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => '5e0964fd-951c-4e45-b518-d09d4d2db8ca'], + 'Id' => ['description' => 'schema id', 'type' => 'string', 'example' => 'profile'], + 'Description' => ['description' => '描述', 'type' => 'string', 'example' => '客户profile'], + 'Properties' => [ + 'description' => '字段列表', 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['type' => 'string', 'description' => '显示名称', 'example' => '姓名'], + 'Description' => ['type' => 'string', 'description' => '描述', 'example' => 'name'], + 'Name' => ['type' => 'string', 'description' => '名称', 'example' => 'name'], + 'DataType' => ['type' => 'string', 'example' => 'string', 'description' => '数据类型'], + 'Pattern' => ['type' => 'string', 'example' => '^', 'description' => '正则表达式校验规则'], + 'PatternErrorMessage' => ['type' => 'string', 'example' => '不是有效的email地址', 'description' => '正则表达式校验错误提示信息'], + 'MinLength' => ['type' => 'integer', 'format' => 'int32', 'description' => '最小长度', 'example' => '1'], + 'MaxLength' => ['type' => 'integer', 'format' => 'int32', 'description' => '最大长度', 'example' => '10'], + 'Minimum' => ['type' => 'number', 'format' => 'double', 'description' => '数字最小值', 'example' => '1'], + 'Maximum' => ['type' => 'number', 'format' => 'double', 'example' => '10', 'description' => '数字最大值'], + 'Required' => ['type' => 'boolean', 'description' => '是否必填', 'example' => 'false'], + 'System' => ['type' => 'boolean', 'example' => 'false', 'description' => '是否是系统字段'], + 'Disabled' => ['type' => 'boolean', 'description' => '是否被禁用', 'example' => 'false'], + 'Array' => ['type' => 'boolean', 'description' => '是否是数组', 'example' => 'false'], + 'ReadOnly' => ['type' => 'boolean', 'description' => '是否只读', 'example' => 'false'], + 'EditorType' => ['type' => 'string', 'description' => '编辑器类型', 'example' => 'textbox'], + 'Attributes' => ['type' => 'string', 'description' => '扩展属性', 'example' => '{}'], + 'DisplayOrder' => ['type' => 'integer', 'format' => 'int32', 'description' => '列表展示顺序', 'example' => '1'], + 'CreatedTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '创建时间', 'example' => '2021-07-14 10:48:43.0'], + 'UpdatedTime' => ['type' => 'integer', 'format' => 'int64', 'example' => '2021-07-14 10:48:43.0', 'description' => '更新时间'], + 'Creator' => ['type' => 'string', 'description' => '创建者', 'example' => 'tom'], ], + 'description' => '字段', ], ], + 'CreatedTime' => ['description' => '创建时间。'."\n", 'type' => 'string', 'example' => '2021-07-14 10:48:43.0'], + 'UpdatedTime' => ['description' => '上次修改的时间。', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0'], + 'Deleted' => ['description' => '是否被删除', 'type' => 'boolean', 'example' => 'false'], ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '19D09CCC-F298-4124-849A-AFA217819011'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'Service abnormal, the instance 0418 is ceased.'], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.ChannelId', - 'errorMessage' => 'The specified channel %s does not exist in call %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 10\\n skg-default@ccc-test\\n 无\\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '发起IVR核身', - 'summary' => '调用LaunchAuthentication使通话临时转入指定的IVR流程，调用此接口后，会在通话过程中进入IVR交互环节，通用用于核身操作。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'LaunchSurvey' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"5e0964fd-951c-4e45-b518-d09d4d2db8ca\\",\\n \\"Id\\": \\"profile\\",\\n \\"Description\\": \\"客户profile\\",\\n \\"Properties\\": {\\n \\"key\\": {\\n \\"DisplayName\\": \\"姓名\\",\\n \\"Description\\": \\"name\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 10,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 0,\\n \\"UpdatedTime\\": 0,\\n \\"Creator\\": \\"tom\\"\\n }\\n },\\n \\"CreatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"UpdatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"Deleted\\": false\\n },\\n \\"RequestId\\": \\"19D09CCC-F298-4124-849A-AFA217819011\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Service abnormal, the instance 0418 is ceased.\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取Schema', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'GetSkillGroup' => [ + 'summary' => '调用GetSkillGroup获取指定实例下指定技能组ID对应的技能组的信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14309,464 +8702,279 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '发起满意度的坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '技能组ID，格式为：技能组名称@实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'], ], - [ - 'name' => 'DeviceId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '技能组展示名。', 'type' => 'string', 'example' => '测试技能组'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Name' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'], + 'Description' => ['description' => '技能组的描述。', 'type' => 'string', 'example' => '云联络中心的测试技能组。'], + 'SkillGroupId' => ['description' => '技能组ID，格式为：技能组名称@实例ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'MediaType' => ['description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', 'type' => 'string', 'example' => 'VIDEO'], + ], + ], + ], + 'description' => '', ], ], - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6580466654649****', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '获取技能组', + 'changeSet' => [ + ['createdAt' => '2023-11-06T05:44:50.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroup'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"CF1C21B9-2D49-4B54-880F-FBE248C16903\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n}","type":"json"}]', + ], + 'GetSummaryTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ContactFlowId', - 'in' => 'query', - 'schema' => [ - 'description' => 'IVR满意度流程的联系流ID，请确保填入的联系流ID是可用的满意度调查流程。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '4685b65a-eb8f-11ec-8ea0-0242ac120002', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'ContactFlowVariables', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '传递给联系流的变量，这里配置的变量，可以在IVR流程中拿到并使用，格式为JSON字符串格式的键值对集合，非必填，默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "customerID": "208880281831****",'."\n" - .' "operateType": "cipherCode",'."\n" - .' "taskId": "1234567890",'."\n" - .' "crmOther": "123"'."\n" - .'}', - ], + 'schema' => ['description' => '模板ID。', 'type' => 'string', 'required' => true, 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492'], ], [ - 'name' => 'SurveyChannel', + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '满意度采集渠道，非必填，默认为语音满意度。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'IVR' => '语音满意度', - 'SMS' => '短信满意度', + 'title' => 'GetSummaryTemplateResponse', + 'description' => 'GetSummaryTemplateResponse', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'TemplateId' => ['description' => '模板ID。', 'type' => 'string', 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492'."\n"], + 'CategoryId' => ['description' => '小结类目ID。', 'type' => 'string', 'example' => '8939-4223-86d0-6bd187905cc8'], + 'Name' => ['description' => '模板名称。', 'type' => 'string', 'example' => '测试模板'], + 'State' => ['description' => '状态码。'."\n" + ."\n" + .'- Enabled 启用中'."\n" + .'- Disabled 已禁用', 'type' => 'string', 'example' => 'Enabled'], + 'Editor' => ['description' => '模板编辑人。', 'type' => 'string', 'example' => 'editor-xxx@ccc-test'], + 'PropertyList' => [ + 'description' => '模板字段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字段定义。', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '显示名称。', 'type' => 'string', 'example' => 'DisplayName-A'], + 'Description' => ['description' => '字段描述。', 'type' => 'string', 'example' => 'Description-xxxx'], + 'Name' => ['description' => '字段名称。', 'type' => 'string', 'example' => 'Name-A'], + 'DataType' => ['description' => '数据类型'."\n" + .'。', 'type' => 'string', 'example' => 'string'."\n"], + 'Pattern' => ['description' => '正则表达式校验规则。', 'type' => 'string', 'example' => '^'], + 'PatternErrorMessage' => ['description' => '正则表达式校验错误提示信息。', 'type' => 'string', 'example' => '不是有效的email地址'."\n"], + 'MinLength' => ['description' => '最小长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'MaxLength' => ['description' => '最大长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'Minimum' => ['description' => '数字最小值。', 'type' => 'number', 'format' => 'double', 'example' => '1'], + 'Maximum' => ['description' => '数字最大值。', 'type' => 'number', 'format' => 'double', 'example' => '10'], + 'Required' => ['description' => '是否必填。', 'type' => 'boolean', 'example' => 'false'], + 'System' => ['description' => '是否是系统字段。', 'type' => 'boolean', 'example' => 'false'], + 'Disabled' => ['description' => '是否被禁用。', 'type' => 'boolean', 'example' => 'false'], + 'Array' => ['description' => '是否是数组。', 'type' => 'boolean', 'example' => 'false'], + 'ReadOnly' => ['description' => '是否只读。', 'type' => 'boolean', 'example' => 'false'], + 'EditorType' => ['description' => '编辑器类型。', 'type' => 'string', 'example' => 'textbox'], + 'Attributes' => ['description' => '扩展属性。', 'type' => 'string', 'example' => '{}'], + 'DisplayOrder' => ['description' => '列表展示顺序。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'CreatedTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000'], + 'UpdatedTime' => ['description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000'], + 'Creator' => ['description' => '创建者。', 'type' => 'string', 'example' => 'cretor-xxx@ccc-test'."\n"], + ], + ], + ], + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], + ], ], - 'example' => 'IVR', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TemplateId\\": \\"43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492\\\\n\\",\\n \\"CategoryId\\": \\"8939-4223-86d0-6bd187905cc8\\",\\n \\"Name\\": \\"测试模板\\",\\n \\"State\\": \\"Enabled\\",\\n \\"Editor\\": \\"editor-xxx@ccc-test\\",\\n \\"PropertyList\\": [\\n {\\n \\"DisplayName\\": \\"DisplayName-A\\",\\n \\"Description\\": \\"Description-xxxx\\",\\n \\"Name\\": \\"Name-A\\",\\n \\"DataType\\": \\"string\\\\n\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\\\n\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1717664210000,\\n \\"UpdatedTime\\": 1717664210000,\\n \\"Creator\\": \\"cretor-xxx@ccc-test\\\\n\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"30C7D235-DDCF-4C7F-A462-5E2598252C2B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取会话小结模板', + 'summary' => '使用GetSummaryTemplate获取会话小结模板内容。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + ], + 'GetTicket' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SmsMetadataId', - 'in' => 'query', - 'schema' => [ - 'description' => '短信满意度配置ID，只有收集渠道为SMS时才需要填写此参数，非必填，默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => '4685b65a-eb8f-11ec-8ea0-0242ac120002', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'SurveyTemplateId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '满意度调查模版ID', - 'type' => 'string', - 'required' => false, - 'example' => '19dc793c-9a01-4cb0-b7d5-fcb5431bab6b', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'SurveyTemplateVariables', + 'name' => 'TicketId', 'in' => 'query', - 'schema' => [ - 'description' => '满意度调查配置', - 'type' => 'string', - 'required' => false, - 'example' => '[]', - ], + 'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => true, 'example' => '3d26b90a-c5d2-4b09-8219-********'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'DescribeTicketResponse', + 'description' => 'DescribeTicketResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => 'AF1E5957-5276-48FF-A6E6-347166A4ADCD', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。'."\n", - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。'."\n", - 'type' => 'string', - 'example' => 'job-6580466654649****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '无', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'ANSWERED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1318888****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => 'MONITORING', - ], - 'SkillGroupId' => [ - 'description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609250655922', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '无', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6580466654649****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '1318888****', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。'."\n", - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609250656122', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609250655090', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1390000****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6580466654649****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - ], - ], - ], - 'ContextId' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '102323', - ], - ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'TicketId' => ['description' => '工单ID。', 'type' => 'string', 'example' => 'b3a6a131-359e-46bd-9bc5-1f5cb0ea093f'], + 'TemplateId' => ['description' => '工单模板ID。', 'type' => 'string', 'example' => 'ccc-test_43c2671b-8939-4223-86d0-6bd187905cc8_*****0666238'], + 'TemplateVersion' => ['description' => '工单模板版本。', 'type' => 'string', 'example' => '0'], + 'Title' => ['description' => '工单标题。', 'type' => 'string', 'example' => '售后工单'], + 'Context' => ['description' => '工单字段信息。', 'type' => 'string', 'example' => '{"productName":"商品A"}'], + 'Assignee' => ['description' => '处理人ID。', 'type' => 'string', 'example' => 'agent1@ccc-test'], + 'AssigneeName' => ['description' => '处理人名称。', 'type' => 'string', 'example' => '坐席A'], + 'Creator' => ['description' => '创建人ID。', 'type' => 'string', 'example' => 'creator@ccc-test'."\n"], + 'CreatorName' => ['description' => '创建者名称', 'type' => 'string', 'example' => '坐席B'], + 'CategoryId' => ['description' => '工单类目ID。', 'type' => 'string', 'example' => '8939-4223-86d0-6bd187905cc8'], + 'CategoryName' => ['description' => '工单类目名称。', 'type' => 'string', 'example' => '售后类目'], + 'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'job-399383842187575296'], + 'StartTime' => ['description' => '工单处理开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620259200000'], + 'EndTime' => ['description' => '工单处理完成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1687846259999'], + 'CreatedTime' => ['description' => '工单创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620259200000'], + 'UpdatedTime' => ['description' => '最近一次更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1693793208075'], + 'CurrentTaskId' => ['description' => '当前节点ID。', 'type' => 'string', 'example' => '912f0b78-6639-4a93-ae18-0d832885c27e'], + 'CurrentTaskName' => ['description' => '当前节点名称。', 'type' => 'string', 'example' => '节点1'], + 'CurrentTaskStartTime' => ['description' => '当前节点开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1693793208075'], + 'Source' => ['description' => '工单来源。'."\n" + .'- AUDIO： 语音业务。'."\n" + .'- CHAT: 网络业务。'."\n" + .'- Console：工单控制台创建。', 'type' => 'string', 'example' => 'Audio'], + 'CustomerId' => ['description' => '客户ID，云联络中心客户资料中的客户ID。', 'type' => 'string', 'example' => '4223-86d0-6bd187905-891798749'], + 'State' => ['description' => '工单状态。'."\n" + .'- Processing（处理中）'."\n" + .'- Withdrawal（已撤回）'."\n" + .'- Rejected（已退回）'."\n" + .'- Closed（已关单）', 'type' => 'string', 'example' => 'Processing'], + 'CloseCode' => ['description' => '关单原因。'."\n" + .'- Completed（处理完成）'."\n" + .'- Terminated（取消）', 'type' => 'string', 'example' => 'Completed'], + 'Comment' => ['description' => '处理意见。', 'type' => 'string', 'example' => '无'], + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.ChannelId', - 'errorMessage' => 'The specified channel %s does not exist in call %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"AF1E5957-5276-48FF-A6E6-347166A4ADCD\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6580466654649****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1318888****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609250655922,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6580466654649****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"Originator\\": \\"1318888****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609250656122,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609250655090,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6580466654649****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 102323\\n }\\n}","errorExample":""},{"type":"xml","example":"AF1E5957-5276-48FF-A6E6-347166A4ADCD\\n无\\n200\\n无\\n\\n 123456789\\n \\n ccc-test\\n OUTBOUND\\n job-65804666546491392\\n \\n 1318888****\\n ANSWERED\\n 无\\n OUTBOUND\\n 1\\n 无\\n skill-group@ccc-test\\n ch-user-1917047****-80154160-1655094662943-job-d4a3d2f1-7d8b-40a4-bd3d-3cc20842c620\\n 1609250655922\\n 无\\n 1318888****\\n []\\n user-test@ccc-test\\n 8001****\\n job-65804666546491392\\n \\n \\n \\n 8001****\\n TALKING\\n ccc-test\\n default\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bs3b5f22c6d78f000176aebe9471\\n 1609250656122\\n false\\n 1390000****\\n job-65804666546491392\\n ON_SITE\\n 1609250655090\\n [\\"skill-group@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', - 'title' => '发起满意度调查', - 'summary' => '调用LaunchSurvey发送满意度调查，该操作会导致挂机，如果是语音满意度，客户会在坐席挂机后进入IVR满意度调查流程，并在IVR流程中完成满意度采集。如果是短信满意度，则通话结束，客户收到满意度调查短信。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'MakeCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TicketId\\": \\"b3a6a131-359e-46bd-9bc5-1f5cb0ea093f\\",\\n \\"TemplateId\\": \\"ccc-test_43c2671b-8939-4223-86d0-6bd187905cc8_*****0666238\\",\\n \\"TemplateVersion\\": \\"0\\",\\n \\"Title\\": \\"售后工单\\",\\n \\"Context\\": \\"{\\\\\\"productName\\\\\\":\\\\\\"商品A\\\\\\"}\\",\\n \\"Assignee\\": \\"agent1@ccc-test\\",\\n \\"AssigneeName\\": \\"坐席A\\",\\n \\"Creator\\": \\"creator@ccc-test\\\\n\\",\\n \\"CreatorName\\": \\"坐席B\\",\\n \\"CategoryId\\": \\"8939-4223-86d0-6bd187905cc8\\",\\n \\"CategoryName\\": \\"售后类目\\",\\n \\"JobId\\": \\"job-399383842187575296\\",\\n \\"StartTime\\": 1620259200000,\\n \\"EndTime\\": 1687846259999,\\n \\"CreatedTime\\": 1620259200000,\\n \\"UpdatedTime\\": 1693793208075,\\n \\"CurrentTaskId\\": \\"912f0b78-6639-4a93-ae18-0d832885c27e\\",\\n \\"CurrentTaskName\\": \\"节点1\\",\\n \\"CurrentTaskStartTime\\": 1693793208075,\\n \\"Source\\": \\"Audio\\",\\n \\"CustomerId\\": \\"4223-86d0-6bd187905-891798749\\",\\n \\"State\\": \\"Processing\\",\\n \\"CloseCode\\": \\"Completed\\",\\n \\"Comment\\": \\"无\\"\\n },\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA633111\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取工单', + 'summary' => '使用GetTicket获取指定工单信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'GetTicketSummaryReport' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14775,123 +8983,69 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '50581', - 'abilityTreeNodes' => [ - 'FEATUREcccIPHVDY', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'State', 'in' => 'query', - 'schema' => [ - 'description' => '发起外呼的坐席ID，非必填，不填默认使用当前RAM账号映射的坐席。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '工单状态。'."\n" + .'- Processing（处理中）'."\n" + .'- Withdrawal（已撤回）'."\n" + .'- Rejected（已退回）'."\n" + .'- Closed（已关单）', 'type' => 'string', 'required' => false, 'example' => '无'], ], [ - 'name' => 'DeviceId', + 'name' => 'CategoryId', 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + 'schema' => ['description' => '工单类目ID。', 'type' => 'string', 'required' => false, 'example' => '43c2671b-***-***-86d0-6bd187905cc8'], ], [ - 'name' => 'Caller', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '主叫号码，如果是内部呼叫，这此参数无效，如果是外部呼叫，此参数为当前坐席可用的外呼号码，需要确保该号码可外呼且坐席对该号码有使用权，使用权通过两种途径获得，一是将号码绑定到当前坐席签入的技能组上，二是将号码设置为坐席的个人外呼号码。', - 'type' => 'string', - 'required' => false, - 'example' => '010989****', - ], + 'schema' => ['description' => '开始时间，基于工单创建时间过滤。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1716998400000'], ], [ - 'name' => 'Callee', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码，如果是内部呼叫，该字段填写目标坐席的分机号，如果是外呼呼叫，填写客户的电话号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1318888****', - ], + 'schema' => ['description' => '结束时间，基于工单创建时间过滤。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1719590399999'], ], [ - 'name' => 'TimeoutSeconds', + 'name' => 'Creator', 'in' => 'query', - 'schema' => [ - 'description' => '超时时间，呼叫在经过该参数指定的时间仍然未接通的情况下，则主动挂断，取值范围30-300，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '300', - 'minimum' => '30', - 'example' => '30', - ], + 'schema' => ['description' => '创建人ID。', 'type' => 'string', 'required' => false, 'example' => 'creator@ccc-test'], ], [ - 'name' => 'Tags', + 'name' => 'Assignee', 'in' => 'query', - 'schema' => [ - 'description' => '随路数据，客户无需关心。', - 'type' => 'string', - 'required' => false, - 'example' => 'tags', - ], + 'schema' => ['description' => '处理者ID（坐席ID或技能组ID）。', 'type' => 'string', 'required' => false, 'example' => 'assignee@ccc-test'."\n"], ], [ - 'name' => 'MaskedCallee', + 'name' => 'AssigneeType', 'in' => 'query', - 'schema' => [ - 'description' => '脱敏后的被叫号码，如果该字段不为空，表示需要对被叫号码脱敏，脱敏规则由客户自行定义，只需将脱敏后的被叫号码填入即可，使用脱敏被叫会导致某些场景下看到的是脱敏后的被叫号码，无法查看真实被叫号码。', - 'type' => 'string', - 'required' => false, - 'example' => '131****8888', - ], + 'schema' => ['description' => '处理者类型。'."\n" + .'- Agent（坐席）'."\n" + .'- SkillGroup（技能组）', 'type' => 'string', 'required' => false, 'example' => 'Agent'], ], [ - 'name' => 'MediaType', + 'name' => 'Participant', 'in' => 'query', - 'schema' => [ - 'description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括VIDEO。', - 'type' => 'string', - 'required' => false, - 'example' => 'AUDIO', - ], + 'schema' => ['description' => '参与人ID。', 'type' => 'string', 'required' => false, 'example' => 'participant@ccc-test'."\n"], ], [ - 'name' => 'FlashSmsVariables', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '闪信配置', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"applicationId\\":\\"6bd18325-ea7f-4881-8902-4d06283d3b3b\\",\\"templateId\\":\\"1722217249064\\"}', - ], + 'schema' => ['description' => '分页参数。默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], ], 'responses' => [ @@ -14899,738 +9053,153 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], 'Data' => [ - 'description' => '数据。'."\n", + 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'ContextId' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6570007401392****', - ], - 'CallVariables' => [ - 'description' => '随路数据。通过SIP信令传递的自定义数据。', - 'type' => 'string', - 'example' => 'a=b;c=d', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '无', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'NONE', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '8001****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => 'MONITORING', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609225718295', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '无', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6570007401392****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '1318888****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - 'MediaType' => [ - 'description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括VIDEO。', - 'type' => 'string', - 'example' => 'Audio', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6570007401392****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'READY', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - ], - ], - ], + 'TicketsCreated' => ['description' => '工单创建数量。', 'type' => 'string', 'example' => '10'], + 'TicketsParticipated' => ['description' => '工单已处理数量。', 'type' => 'string', 'example' => '5'], + 'TicketsAssigned' => ['description' => '工单待处理数量。', 'type' => 'string', 'example' => '3'], ], ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'UserBusy', - 'errorMessage' => 'The user %s you called was busy. Please try again later.', - ], - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.Extension', - 'errorMessage' => 'No available extension number exists.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EAF3C248-E123-441B-A545-B6CD02E98EED\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"TicketsCreated\\": \\"10\\",\\n \\"TicketsParticipated\\": \\"5\\",\\n \\"TicketsAssigned\\": \\"3\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '获取工单处理数据', + 'summary' => '使用GetTicketSummaryReport获取工单状态统计数据。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 123456,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"CallVariables\\": \\"a=b;c=d\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609225718295,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"MediaType\\": \\"Audio\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\n无\\n200\\n无\\n\\n 123456\\n \\n ccc-test\\n OUTBOUND\\n job-65700074013925376\\n \\n 8001****\\n NONE\\n 无\\n 1318888****\\n []\\n 无\\n user-test@ccc-test\\n 8001****\\n OUTBOUND\\n 无\\n ch:user:131888****->8001****:1609225718294:job-65700074013925376\\n 1609225718295\\n job-65700074013925376\\n \\n \\n \\n 8001****\\n READY\\n ccc-test\\n Warm-up\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c\\n false\\n job-65700074013925376\\n ON_SITE\\n [\\"skill-group@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', - 'title' => '发起呼叫', - 'summary' => '调用MakeCall发起呼叫，被叫可以是内部坐席，也可以是外部客户 。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], ], - 'MonitorCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetTicketTemplate' => [ + 'summary' => '使用GetTicketTemplate获取工单模板定义信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccFSWXV5'], + ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], - ], - [ - 'name' => 'DeviceId', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + 'schema' => ['description' => '模板ID。', 'type' => 'string', 'required' => false, 'example' => '4ca2e2-c8d19b82c-d7ce393ac8197d3ab'], ], [ - 'name' => 'MonitoredUserId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '被监听的座席的ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent2@ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'TimeoutSeconds', + 'name' => 'TemplateVersion', 'in' => 'query', - 'schema' => [ - 'description' => '监听超时时间，经过指定的时间监听仍未成功，则取消监听，正常情况下，监听操作会马上成功，设置超时时间是为了防止异常发生，此字段选填，默认30，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => '模板版本。', 'type' => 'string', 'required' => false, 'example' => '1703517780627'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'GetTicketTemplateResponse', + 'description' => 'GetTicketTemplateResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'CREATED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => 'MONITORING', - ], - 'SkillGroupId' => [ - 'description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => ' - OFFICE_PHONE(办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'BREAK', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - ], - ], - ], - ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'TemplateId' => ['description' => '模板ID。', 'type' => 'string', 'example' => '4ca2e2-c8d19b82c-d7ce393ac8197d3ab'."\n"], + 'Name' => ['description' => '模板名称。', 'type' => 'string', 'example' => '测试模板。'."\n" + ."\n"], + 'State' => ['description' => '状态码。', 'type' => 'string', 'example' => 'Enabled'], + 'Editor' => ['description' => '模板编辑人。', 'type' => 'string', 'example' => 'editor-xxx@ccc-test'], + 'CategoryId' => ['description' => '工单类目ID。', 'type' => 'string', 'example' => '43c2671b-****-4223-86d0-6bd187905cc8'], + 'TicketFields' => [ + 'description' => '模板字段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模板字段。', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '显示名称。', 'type' => 'string', 'example' => '姓名'], + 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => '姓名描述'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'name'], + 'DataType' => ['description' => '数据类型'."\n" + .'。', 'type' => 'string', 'example' => 'string'], + 'Pattern' => ['description' => '正则表达式校验规则。', 'type' => 'string', 'example' => '^'], + 'PatternErrorMessage' => ['description' => '正则表达式校验错误提示信息。', 'type' => 'string', 'example' => '不是有效的email地址'."\n"], + 'MinLength' => ['description' => '最小长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'MaxLength' => ['description' => '最大长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'Minimum' => ['description' => '数字最小值。', 'type' => 'number', 'format' => 'double', 'example' => '1'], + 'Maximum' => ['description' => '数字最大值。', 'type' => 'number', 'format' => 'double', 'example' => '10'], + 'Required' => ['description' => '是否必填。', 'type' => 'boolean', 'example' => 'false'], + 'System' => ['description' => '是否是系统字段。', 'type' => 'boolean', 'example' => 'false'], + 'Disabled' => ['description' => '是否被禁用。', 'type' => 'boolean', 'example' => 'false'], + 'Array' => ['description' => '是否是数组。', 'type' => 'boolean', 'example' => 'false'], + 'ReadOnly' => ['description' => '是否只读。', 'type' => 'boolean', 'example' => 'false'], + 'EditorType' => ['description' => '编辑器类型。', 'type' => 'string', 'example' => 'textbox'], + 'Attributes' => ['description' => '扩展属性。', 'type' => 'string', 'example' => '{}'], + 'DisplayOrder' => ['description' => '列表展示顺序。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'CreatedTime' => ['description' => '创建时间。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000'], + 'UpdatedTime' => ['description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000'], + 'Creator' => ['description' => '创建者。', 'type' => 'string', 'example' => 'creator@cccV2-kmz'], + ], + ], + ], + 'ProcessDefinition' => ['description' => '流程信息。', 'type' => 'string', 'example' => '[{\\"id\\":\\"TICKET_START\\",\\"name\\":\\"开始\\",\\"nodeIndex\\":0,\\"properties\\":{\\"position\\":{\\"x\\":250,\\"y\\":200}},\\"type\\":\\"TICKET_START\\",\\"events\\":[{\\"edgeId\\":\\"8bd07339\\",\\"sourceAnchor\\":0,\\"next\\":\\"APPROVAL__JNBSSREc\\",\\"targetAnchor\\":0}]},{\\"id\\":\\"TICKET_FINISH\\",\\"name\\":\\"结束\\",\\"nodeIndex\\":9999,\\"properties\\":{\\"position\\":{\\"x\\":767,\\"y\\":206}},\\"type\\":\\"TICKET_FINISH\\",\\"events\\":[]},{\\"id\\":\\"APPROVAL__JNBSSREc\\",\\"name\\":\\"流程节点\\",\\"nodeIndex\\":1,\\"properties\\":{\\"skillGroupId\\":\\"chat001@cccV2-kmz\\",\\"position\\":{\\"x\\":537,\\"y\\":164.5}},\\"type\\":\\"APPROVAL\\",\\"events\\":[{\\"edgeId\\":\\"74031613\\",\\"sourceAnchor\\":1,\\"next\\":\\"TICKET_FINISH\\",\\"targetAnchor\\":0}]}]'], + 'UpdatedTime' => ['description' => '上次修改的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000'], + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.ChannelId', - 'errorMessage' => 'The specified channel %s does not exist in call %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 1\\n skg-default@ccc-test\\n \\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '监听通话', - 'summary' => '调用MonitorCall监听指定实例下指定通话ID对应的通话。通话必须处于坐席和客户双方正常接通状态，且发起监听的坐席有权限对被监听坐席进行监听。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'MuteCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '获取工单模板', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TemplateId\\": \\"4ca2e2-c8d19b82c-d7ce393ac8197d3ab\\\\n\\",\\n \\"Name\\": \\"测试模板。\\\\n\\\\n\\",\\n \\"State\\": \\"Enabled\\",\\n \\"Editor\\": \\"editor-xxx@ccc-test\\",\\n \\"CategoryId\\": \\"43c2671b-****-4223-86d0-6bd187905cc8\\",\\n \\"TicketFields\\": [\\n {\\n \\"DisplayName\\": \\"姓名\\",\\n \\"Description\\": \\"姓名描述\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\\\n\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1717664210000,\\n \\"UpdatedTime\\": 1717664210000,\\n \\"Creator\\": \\"creator@cccV2-kmz\\"\\n }\\n ],\\n \\"ProcessDefinition\\": \\"[{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_START\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"开始\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nodeIndex\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"position\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":250,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":200}},\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_START\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"events\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"edgeId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8bd07339\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sourceAnchor\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"next\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APPROVAL__JNBSSREc\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"targetAnchor\\\\\\\\\\\\\\":0}]},{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_FINISH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"结束\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nodeIndex\\\\\\\\\\\\\\":9999,\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"position\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":767,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":206}},\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_FINISH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"events\\\\\\\\\\\\\\":[]},{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APPROVAL__JNBSSREc\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"流程节点\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nodeIndex\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"skillGroupId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"chat001@cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"position\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":537,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":164.5}},\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APPROVAL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"events\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"edgeId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"74031613\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sourceAnchor\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"next\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_FINISH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"targetAnchor\\\\\\\\\\\\\\":0}]}]\\",\\n \\"UpdatedTime\\": 1717664210000\\n },\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA633111\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + ], + 'GetTurnCredentials' => [ + 'summary' => '调用GetTurnCredentials获取云联络中心前置接入点的连接凭证信息，主要包括鉴权需要用到的用户名和密码，通过前置接入点接入云联络中心可以有效提高网络质量和稳定性。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15639,63 +9208,106 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTMAX45'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ 'name' => 'UserId', 'in' => 'query', + 'schema' => ['description' => '坐席ID，非必填，不填则默认使用当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '被静音的坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'UserName' => ['description' => '用户名。', 'type' => 'string', 'example' => '1602585817:****'], + 'Password' => ['description' => '密码。', 'type' => 'string', 'example' => 'M0NQNG/uRUrfIxW7er/S9gKX****'], + ], + ], + 'Params' => [ + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + 'description' => '', + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], + ], + ], + 'title' => '获取接入点凭证', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTurnCredentials'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"UserName\\": \\"1602585817:****\\",\\n \\"Password\\": \\"M0NQNG/uRUrfIxW7er/S9gKX****\\"\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n 1602585817:null\\n M0NQNG/uRUrfIxW7er/S9gKXsT0=\\n\\nOK","errorExample":""}]', + ], + 'GetTurnServerList' => [ + 'summary' => '调用GetTurnServerList获取云联络中心的前置接入点列表，通过前置接入点接入云联络中心可以有效提高网络质量和网络稳定性。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + 'AK' => [], ], [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6581536084722****', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTMAX45'], + ], + 'parameters' => [ [ - 'name' => 'ChannelId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待静音的话务通道ID，非必填，默认为空，为空表示静音UserId对应的坐席的话务通道。', - 'type' => 'string', - 'required' => false, - 'example' => 'ch:user:1318888****->8001****:1609253204816:job-6581536084722****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], ], 'responses' => [ @@ -15703,340 +9315,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => 'A275B008-A25B-494D-AB53-93CE253815B6', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string'], + 'Message' => ['description' => '响应信息。', 'type' => 'string'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string'], + 'Data' => ['description' => '数据，前置接入点服务器信息列表。', 'type' => 'string', 'example' => '['."\n" + .' {'."\n" + .' "region":"hangzhou",'."\n" + .' "name":"杭州",'."\n" + .' "domain":"turn-hz-ecs.ccc.aliyuncs.com",'."\n" + .' "cidr":"172.31.XX.XX/28"'."\n" + .' },'."\n" + .' {'."\n" + .' "region":"qingdao",'."\n" + .' "name":"青岛",'."\n" + .' "domain":"turn-qd-ecs.ccc.aliyuncs.com",'."\n" + .' "cidr":"172.31.XX.XX/28"'."\n" + .' },'."\n" + .' {'."\n" + .' "region":"shanghai",'."\n" + .' "name":"上海",'."\n" + .' "domain":"turn-sh-ecs.ccc.aliyuncs.com",'."\n" + .' "cidr":"172.31.XX.XX/28"'."\n" + .' },'."\n" + .' {'."\n" + .' "region":"chengdu",'."\n" + .' "name":"成都",'."\n" + .' "domain":"turn-cd-ecs.ccc.aliyuncs.com",'."\n" + .' "cidr":"172.31.XX.XX/28"'."\n" + .' },'."\n" + .' {'."\n" + .' "region":"beijing",'."\n" + .' "name":"北京",'."\n" + .' "domain":"turn-bj-ecs.ccc.aliyuncs.com",'."\n" + .' "cidr":"172.31.XX.XX/28"'."\n" + .' },'."\n" + .' {'."\n" + .' "region":"huanan",'."\n" + .' "name":"深圳",'."\n" + .' "domain":"turn-sz-ecs.ccc.aliyuncs.com",'."\n" + .' "cidr":"172.31.XX.XX/28"'."\n" + .' },'."\n" + .' {'."\n" + .' "region":"zhangbei",'."\n" + .' "name":"张北",'."\n" + .' "domain":"turn-zb-ecs.ccc.aliyuncs.com",'."\n" + .' "cidr":"172.31.XX.XX/28"'."\n" + .' }'."\n" + .']'], 'Params' => [ - 'description' => '响应参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - 'Data' => [ - 'description' => '数据。'."\n", - 'type' => 'object', - 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。'."\n", - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。'."\n", - 'type' => 'string', - 'example' => 'job-6581536084722****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '无', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'ANSWERED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '8001****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => '[MUTED]', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609253212511', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '无', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6581536084722****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。'."\n", - 'type' => 'string', - 'example' => 'ch:user:1318888****->8001****:1609253204816:job-6581536084722****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '1318888****', - ], - 'SkillGroupId' => [ - 'description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。'."\n", - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '座席分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609253205896', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609253204811', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1390000****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6581536084722****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - ], - ], - ], - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], ], 404 => [ - [ - 'errorCode' => 'NotExists.ChannelId', - 'errorMessage' => 'The specified channel %s does not exist in call %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"A275B008-A25B-494D-AB53-93CE253815B6\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6581536084722****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"[MUTED]\\",\\n \\"Timestamp\\": 1609253212511,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6581536084722****\\",\\n \\"ChannelId\\": \\"ch:user:1318888****->8001****:1609253204816:job-6581536084722****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609253205896,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609253204811,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6581536084722****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"A275B008-A25B-494D-AB53-93CE253815B6\\n无\\n200\\n无\\n\\n \\n ccc-test\\n OUTBOUND\\n job-65815360847228928\\n \\n 8001****\\n ANSWERED\\n 无\\n OUTBOUND\\n 1\\n 无\\n ch:user:1318888****-&gt;8001****:1609253204816:job-65815360847228928\\"\\n 1609253212511\\n 无\\n 1318888****\\n []\\n user-test@ccc-test\\n 8001****\\n job-65815360847228928\\n \\n \\n \\n 8001****\\n TALKING\\n ccc-test\\n Warm-up\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bs736efb521810000176aef6e955\\n 1609253205896\\n false\\n 1390000****\\n job-65815360847228928\\n ON_SITE\\n 1609253204811\\n [\\"skill-group@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', - 'title' => '静音通话', - 'summary' => '调用MuteCall静音指定实例下指定通话ID对应的通话，只能由正在通话状态的坐席调用，且只能静音调用者自己，坐席静音后，客户将无法听见坐席的声音。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'PickOutboundNumbers' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '获取接入点列表', + 'changeSet' => [ + ['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTurnServerList'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"[\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"杭州\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-hz-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"qingdao\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"青岛\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-qd-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"shanghai\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"上海\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-sh-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"chengdu\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"成都\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-cd-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"beijing\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"北京\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-bj-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"huanan\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"深圳\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-sz-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"zhangbei\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"张北\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-zb-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t}\\\\n]\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + ], + 'GetUploadAudioDataParams' => [ + 'summary' => '获取离线质检音频文件相关参数。一般情况下，如果客户在云联络中心中配置了质检功能，则需要离线质检的音频文件和相应的参数会自动传递给智能质检；只有当客户没有在云联络中心中配置质检功能，并且希望自己把云联络中心的录音推送给质检时才需要调用此接口获取推送质检录音的相关参数。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16047,54 +9409,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'CalledNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1388888****', - ], - ], - [ - 'name' => 'Count', - 'in' => 'query', - 'schema' => [ - 'description' => '希望返回的可选号码数量， 默认1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '3', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => '云联络中心实例ID', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test'], ], [ - 'name' => 'SkillGroupIdList', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID集合，格式为JSON数组的字符串，数组元素是技能组ID，号码与技能组是关联的，此参数用于指定从哪些技能组挑选号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["skillgroup@ccc-test"]', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'example' => 'job-38860977107324****'], ], ], 'responses' => [ @@ -16102,106 +9432,79 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID,可用于接口的日志查询', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], 'Data' => [ - 'description' => '数据。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Callee' => [ - 'description' => '被叫号码。', - 'type' => 'object', - 'properties' => [ - 'Number' => [ - 'description' => '号码', - 'type' => 'string', - 'example' => '1388888****', - ], - 'City' => [ - 'description' => '号码归属地市。', - 'type' => 'string', - 'example' => '北京', - ], - 'Province' => [ - 'description' => '号码归属地省。', - 'type' => 'string', - 'example' => '北京', - ], - ], - ], - 'Caller' => [ - 'description' => '主叫号码。', - 'type' => 'object', - 'properties' => [ - 'Number' => [ - 'description' => '号码', - 'type' => 'string', - 'example' => '0108989****', - ], - 'City' => [ - 'description' => '号码归属地市。', - 'type' => 'string', - 'example' => '北京', - ], - 'Province' => [ - 'description' => '号码归属地省。', - 'type' => 'string', - 'example' => '北京', - ], - ], - ], - ], - ], - ], - ], + 'description' => '数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'ParamsStr' => ['description' => '离线质检音频文件相关参数', 'type' => 'string', 'example' => '{'."\n" + .' "autoSplit": 1,'."\n" + .' "appKey": ****,'."\n" + .' "sampleRate": 8,'."\n" + .' "callList": ['."\n" + .' {'."\n" + .' "callId": "job-46686139435843****",'."\n" + .' "validTimes": ['."\n" + .' {'."\n" + .' "begin_time": 0,'."\n" + .' "end_time": 30720,'."\n" + .' "speaker_id": "张**"'."\n" + .' }'."\n" + .' ],'."\n" + .' "resolveType": "ali-ACC",'."\n" + .' "instance": "c****",'."\n" + .' "callee": "153****",'."\n" + .' "accUid": 105****967,'."\n" + .' "callStartTime": 1704870035381,'."\n" + .' "customerServiceName": "张**",'."\n" + .' "tid": "2ccd8732-62ed-****b9",'."\n" + .' "callType": 1,'."\n" + .' "skillGroupUUID": "skg-default@c****",'."\n" + .' "caller": "2023****",'."\n" + .' "customerServicePhone": "80****54",'."\n" + .' "channels": ['."\n" + .' {'."\n" + .' "speaker_id": "张**",'."\n" + .' "channel_key": "ch-user-153****-80****54-1704870030317-job-46686139435843****"'."\n" + .' }'."\n" + .' ],'."\n" + .' "sourceType": 1,'."\n" + .' "channelKey": "ch-user-153****-80****54-1704870030317-job-46686139435843****",'."\n" + .' "skillGroupName": "金****",'."\n" + .' "voiceFileUrl": "https://ccc-***.oss-cn-****.aliyuncs.com/ccc-****/c****/2024/01/job-46686139435843****.mkv?Expires=****&OSSAccessKeyId=****&Signature=****",'."\n" + .' "skillGroupId": 0,'."\n" + .' "customerServiceId": 203242802****'."\n" + .' }'."\n" + .' ]'."\n" + .'}'], + ], + ], + ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 'title' => '获取离线质检音频相关参数', + 'changeSet' => [ + ['createdAt' => '2022-08-24T07:34:47.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUploadAudioDataParams'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n {\\n \\"Callee\\": {\\n \\"Number\\": \\"1388888****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n },\\n \\"Caller\\": {\\n \\"Number\\": \\"0108989****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n \\n 1388888****\\n 北京\\n 北京\\n \\n \\n 0108989****\\n 北京\\n 北京\\n \\n\\nOK","errorExample":""}]', - 'title' => '选择外呼号码', - 'summary' => '调用PickOutboundNumbers根据传入的被叫号码选择适合的主叫号码，选号逻辑由智能算法控制。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Data\\": {\\n \\"ParamsStr\\": \\"{\\\\n \\\\\\"autoSplit\\\\\\": 1,\\\\n \\\\\\"appKey\\\\\\": ****,\\\\n \\\\\\"sampleRate\\\\\\": 8,\\\\n \\\\\\"callList\\\\\\": [\\\\n {\\\\n \\\\\\"callId\\\\\\": \\\\\\"job-46686139435843****\\\\\\",\\\\n \\\\\\"validTimes\\\\\\": [\\\\n {\\\\n \\\\\\"begin_time\\\\\\": 0,\\\\n \\\\\\"end_time\\\\\\": 30720,\\\\n \\\\\\"speaker_id\\\\\\": \\\\\\"张**\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"resolveType\\\\\\": \\\\\\"ali-ACC\\\\\\",\\\\n \\\\\\"instance\\\\\\": \\\\\\"c****\\\\\\",\\\\n \\\\\\"callee\\\\\\": \\\\\\"153****\\\\\\",\\\\n \\\\\\"accUid\\\\\\": 105****967,\\\\n \\\\\\"callStartTime\\\\\\": 1704870035381,\\\\n \\\\\\"customerServiceName\\\\\\": \\\\\\"张**\\\\\\",\\\\n \\\\\\"tid\\\\\\": \\\\\\"2ccd8732-62ed-****b9\\\\\\",\\\\n \\\\\\"callType\\\\\\": 1,\\\\n \\\\\\"skillGroupUUID\\\\\\": \\\\\\"skg-default@c****\\\\\\",\\\\n \\\\\\"caller\\\\\\": \\\\\\"2023****\\\\\\",\\\\n \\\\\\"customerServicePhone\\\\\\": \\\\\\"80****54\\\\\\",\\\\n \\\\\\"channels\\\\\\": [\\\\n {\\\\n \\\\\\"speaker_id\\\\\\": \\\\\\"张**\\\\\\",\\\\n \\\\\\"channel_key\\\\\\": \\\\\\"ch-user-153****-80****54-1704870030317-job-46686139435843****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"sourceType\\\\\\": 1,\\\\n \\\\\\"channelKey\\\\\\": \\\\\\"ch-user-153****-80****54-1704870030317-job-46686139435843****\\\\\\",\\\\n \\\\\\"skillGroupName\\\\\\": \\\\\\"金****\\\\\\",\\\\n \\\\\\"voiceFileUrl\\\\\\": \\\\\\"https://ccc-***.oss-cn-****.aliyuncs.com/ccc-****/c****/2024/01/job-46686139435843****.mkv?Expires=****&OSSAccessKeyId=****&Signature=****\\\\\\",\\\\n \\\\\\"skillGroupId\\\\\\": 0,\\\\n \\\\\\"customerServiceId\\\\\\": 203242802****\\\\n }\\\\n ]\\\\n}\\"\\n }\\n}","type":"json"}]', ], - 'PollUserStatus' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetUser' => [ + 'summary' => '调用GetUser获取指定实例下指定坐席ID对应的坐席信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16210,121 +9513,353 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '坐席ID，选填，UserId和Extension任选一个填写即可。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'DeviceId', + 'name' => 'Extension', 'in' => 'query', + 'schema' => ['description' => '坐席分机号，选填，UserId和Extension任选一个填写即可。', 'type' => 'string', 'required' => false, 'example' => '8003****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '坐席展示名。', 'type' => 'string', 'example' => '坐席小王'], + 'DisplayId' => ['description' => '坐席的工号。', 'type' => 'string', 'example' => '1001'], + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8003****'], + 'LoginName' => ['description' => '坐席登录名。', 'type' => 'string', 'example' => 'agent'], + 'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1391234****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'RoleName' => [ + 'description' => '角色名称。', + 'type' => 'string', + 'enumValueTitles' => ['Agent' => '坐席', 'Admin' => '管理员', 'Manager' => '技能组组长'], + 'example' => 'Admin', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'RoleId' => ['description' => '角色ID，格式为：角色@实例ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'DeviceExt' => ['description' => 'SIP话机分机号，如果座席注册了SIP话机，则此参数为SIP话机设备的分机号。', 'type' => 'string', 'example' => '8033****'], + 'DeviceState' => [ + 'description' => 'SIP话机设备的状态，如果未注册SIP话机，则状态为UNREGISTERED（未注册），如果SIP话机注册过但是不在线，则状态为OFFLINE（离线），如果SIP话机注册过并且在线则为ONLINE（在线）。', + 'type' => 'string', + 'enumValueTitles' => ['UNREGISTERED' => '未注册', 'OFFLINE' => '离线', 'ONLINE' => '在线'], + 'example' => 'OFFLINE', + ], + 'Nickname' => ['description' => '坐席昵称', 'type' => 'string', 'example' => '阿云'], + 'AvatarUrl' => ['description' => '坐席头像地址。', 'type' => 'string', 'example' => 'http://xxx.com/xxx.jpg'], + ], + ], + 'Params' => [ + 'description' => '扩展参数', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], + ], + 'description' => '', ], ], ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '获取坐席', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-07T07:21:06.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"DisplayId\\": \\"1001\\",\\n \\"Extension\\": \\"8003****\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1391234****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"DeviceExt\\": \\"8033****\\",\\n \\"DeviceState\\": \\"OFFLINE\\",\\n \\"Nickname\\": \\"阿云\\",\\n \\"AvatarUrl\\": \\"http://xxx.com/xxx.jpg\\"\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n 80xxxx91\\n user-test\\n OFFLINE\\n Admin\\n user-test@aliyun-cc.com\\n ccc-test\\n Yealink SIP-T23G 44.84.203.6\\n user-test@ccc-test\\n 测试用户\\n 80xxxx33\\n Admin@ccc-test\\n 139xxxx1234\\n ON_SITE\\n\\nOK","errorExample":""}]', + ], + 'GetVisitorLoginDetails' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'ccc-test'], + ], + [ + 'name' => 'VisitorId', + 'in' => 'query', + 'schema' => ['description' => '访客ID。', 'type' => 'string', 'required' => true, 'example' => 'fcd020fe-d8e4-40e5-8c77-1a272a174a7d'], + ], + [ + 'name' => 'ChatDeviceId', + 'in' => 'query', + 'schema' => ['description' => 'Chat设备ID。', 'type' => 'string', 'required' => true, 'example' => '4c51c9116c36537cb850dc1081d745df'], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => ['description' => '网络业务的渠道Token。', 'type' => 'string', 'required' => false, 'example' => '9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3b***YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jgxzO*****bHwej7WgWrmA'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '19D09CCC-F298-4124-849A-AFA217819011'], + 'Params' => [ + 'description' => '参数信息。', + 'type' => 'array', + 'items' => ['description' => '参数列表。', 'type' => 'string', 'example' => '无'], + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ChatLoginToken' => ['description' => 'Chat会话登录令牌。', 'type' => 'string', 'example' => '{"accessToken":"oauth_cloud_key:+4oJXUAFSWxGD2YuRW4V/oUN0/8qJGNc0I*********n1E3DOr3Q3lX00ZnTpyqRi8Y6hYoLYA7n2ZkWuv485hVtXeSgnIQkKxXPbMgwoLxWaK//lI5Dn/mb4YuDifigv+ZyFzc+07vxm9ZFu/NjA==","accessTokenExpiredTime":86400000,"refreshToken":"oauth_cloud_key:/U+8UueDmpeUszhXC+SWow4pNLZp2C***********U/377BNXF+Mjo1lFgDk6GtEjNNoJpapX2mHH8GcRke2+yKQs/w4gAN9xSMn543Ciung+93pXV6IpQGbEVlu"}'], + 'ChatUserId' => ['description' => '访客的身份ID。', 'type' => 'string', 'example' => 'dac9c001****a15684ea91a81317'], + 'ChatDeviceId' => ['description' => 'Chat设备ID。', 'type' => 'string', 'example' => '4c51c9116c36537cb850dc1081d745df'], + 'ChatServerUrl' => ['description' => 'Chat会话服务器地址。', 'type' => 'string', 'example' => 'wss://wss.im.dingtalk.cn'], + 'ChatAppKey' => ['description' => 'Chat会话应用密钥。', 'type' => 'string', 'example' => '955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0'], + 'ChatAppId' => ['description' => 'Chat会话应用ID。', 'type' => 'string', 'example' => '7pjxxx'], + ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"19D09CCC-F298-4124-849A-AFA217819011\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ChatLoginToken\\": \\"{\\\\\\"accessToken\\\\\\":\\\\\\"oauth_cloud_key:+4oJXUAFSWxGD2YuRW4V/oUN0/8qJGNc0I*********n1E3DOr3Q3lX00ZnTpyqRi8Y6hYoLYA7n2ZkWuv485hVtXeSgnIQkKxXPbMgwoLxWaK//lI5Dn/mb4YuDifigv+ZyFzc+07vxm9ZFu/NjA==\\\\\\",\\\\\\"accessTokenExpiredTime\\\\\\":86400000,\\\\\\"refreshToken\\\\\\":\\\\\\"oauth_cloud_key:/U+8UueDmpeUszhXC+SWow4pNLZp2C***********U/377BNXF+Mjo1lFgDk6GtEjNNoJpapX2mHH8GcRke2+yKQs/w4gAN9xSMn543Ciung+93pXV6IpQGbEVlu\\\\\\"}\\",\\n \\"ChatUserId\\": \\"dac9c001****a15684ea91a81317\\",\\n \\"ChatDeviceId\\": \\"4c51c9116c36537cb850dc1081d745df\\",\\n \\"ChatServerUrl\\": \\"wss://wss.im.dingtalk.cn\\",\\n \\"ChatAppKey\\": \\"955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0\\",\\n \\"ChatAppId\\": \\"7pjxxx\\"\\n }\\n}","type":"json"}]', + 'title' => '获取访客登录信息', + 'summary' => '调用GeVisitortLoginDetails获取网络业务访客的登录信息，服务器地址信息、鉴权信息等。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + ], + 'GetVoicemailRecording' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccKYIENB'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => ['description' => '通话ID，请确保该通话ID存在语音信箱留言，否则返回结果将没有数据。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-12515239414412****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'FileUrl' => ['description' => '录音文件的OSS下载地址，注意下载地址的过期时间，下载地址的有效期为1天。', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****'], + 'FileName' => ['description' => '录音文件名字。', 'type' => 'string', 'example' => 'voicemail.job-054ded02****.wav'], + ], ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '获取语音信箱录音', + 'summary' => '调用GetVoicemailRecording获取指定实例下指定通话的语音信箱留言的录音，录音为单轨录音，格式为WAV。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVoicemailRecording'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"voicemail.job-054ded02****.wav\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 200\\n 无\\n EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n \\n http://xxxx\\n abc\\n \\n","errorExample":""}]', + ], + 'HoldCall' => [ + 'summary' => '调用HoldCall保持指定实例下指定通话ID对应的通话，通话被保持后，将暂时被挂起，此时被保持方会听到保持音乐。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => '座席端提供的唯一ID，用来表示一个座席工作台，一个座席可以有多个不同类型的座席台，比如浏览器，iOS, Android等， 但是在同一时间，只能有一个生效。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ACC-YUNBS-1.0.10-****'], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => '话务ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6582589278232****'], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => ['description' => '待保持的通道ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ch:customer:010123****->1318888****:1609255715825:job-6582589278232****'], + ], + [ + 'name' => 'Music', + 'in' => 'query', + 'schema' => ['description' => '通话保持音乐的名称，非必填，默认为空。', 'type' => 'string', 'required' => false, 'example' => '无'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '174F7777-2F6C-4F10-B889-C698E26C1AE0'], 'Params' => [ 'description' => '响应参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'ContextId' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '103655', - ], 'CallContext' => [ - 'description' => '话务上下文环境。', + 'description' => '话务上下文环境。'."\n", 'type' => 'object', 'properties' => [ 'CallType' => [ - 'description' => '通话类型。', + 'description' => '通话类型。'."\n", 'type' => 'string', 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', 'COACH' => '辅导', ], 'example' => 'OUTBOUND', ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。'."\n", 'type' => 'string', 'example' => 'job-6582589278232****'], 'ChannelContexts' => [ 'description' => '话务通道列表。', 'type' => 'array', @@ -16332,373 +9867,116 @@ 'description' => '话务通道。', 'type' => 'object', 'properties' => [ - 'Index' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。'."\n", 'type' => 'string', 'example' => '1390501****'], 'ChannelState' => [ 'description' => '话务通道的状态。', 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'CREATED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => 'MONITORING', - ], - 'SkillGroupId' => [ - 'description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'ANSWERED', ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '8001****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'SkillGroupId' => ['description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609255716900'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], 'CallType' => [ - 'description' => '话务通道的通话类型。', + 'description' => '话务通道的通话类型。'."\n", 'type' => 'string', 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', 'COACH' => '辅导', ], 'example' => 'OUTBOUND', ], - 'ChannelVariables' => [ - 'description' => '随路数据。', - 'type' => 'string', - 'example' => '123', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', - ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6582589278232****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8001****'], ], ], ], - 'CallVariables' => [ - 'description' => '随路数据。通过SIP信令传递的自定义数据。', - 'type' => 'string', - 'example' => 'a=b;c=d', - ], ], ], 'UserContext' => [ - 'description' => '坐席上下文环境。', + 'description' => '坐席上下文环境。'."\n", 'type' => 'object', 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609255716908'], 'WorkMode' => [ - 'description' => '工作模式。', + 'description' => '工作模式。'."\n", 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], 'example' => 'ON_SITE', ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609255715822'], 'BreakCode' => [ 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '席上线后置闲前的临时小休状态'], 'example' => 'Warm-up', ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1390000****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6582589278232****'], 'UserState' => [ - 'description' => '座席状态。', + 'description' => '座席状态。'."\n", 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'BREAK', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', ], 'SignedSkillGroupIdList' => [ 'description' => '坐席签入的技能组ID列表。', 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - ], - 'ParallelJobList' => [ - 'description' => '坐席当前正在处理和已经处理完的Chat会话', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => '会话ID', - 'type' => 'string', - 'example' => 'job-6538214103685****'."\n", - ], - 'Status' => [ - 'description' => '客服在这个会话中的状态。'."\n" - .'### 枚举值：'."\n" - .'- RINGING'."\n" - .'- TALKING'."\n" - .'- RELEASED（结束）'."\n" - .'- MISSED（未接）', - 'type' => 'string', - 'example' => 'RINGING', - ], - 'Timestamp' => [ - 'description' => '状态变更的时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - ], - ], - ], - ], - ], - 'ChatContexts' => [ - 'description' => '会话上下文环境。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'example' => 'chat-65382141036853491'."\n", - ], - 'ChatType' => [ - 'description' => '会话类型。', - 'type' => 'string', - 'example' => 'INBOUND', - ], - 'CallVariables' => [ - 'description' => '随路数据。', - 'type' => 'string', - 'example' => '无', - ], - 'Members' => [ - 'description' => '参与这个 Chat会话的坐席和客户的信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test'."\n", - ], - 'UserType' => [ - 'description' => '用户类型。'."\n" - ."\n" - .'枚举值：'."\n" - .'- CUSTOMER：客户'."\n" - .'- AGENT：坐席', - 'type' => 'string', - 'example' => 'Manager', - ], - 'Status' => [ - 'description' => '客服在这个会话中的状态。'."\n" - ."\n" - .'枚举值：'."\n" - .'- RINGING'."\n" - .'- TALKING'."\n" - .'- RELEASED（结束）'."\n" - .'- MISSED（未接）', - 'type' => 'string', - 'example' => 'RINGING', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'a527a80a-75cf-448f-aba0-fca37c61946d', - ], - 'ReleaseInitiator' => [ - 'description' => '挂断方。', - 'type' => 'string', - 'example' => 'User', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '无', - ], - ], - ], - ], + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], ], ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103655,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"ChannelVariables\\": \\"123\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ],\\n \\"CallVariables\\": \\"a=b;c=d\\"\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ],\\n \\"ParallelJobList\\": [\\n {\\n \\"JobId\\": \\"job-6538214103685****\\\\n\\",\\n \\"Status\\": \\"RINGING\\",\\n \\"Timestamp\\": 1609136956378\\n }\\n ]\\n },\\n \\"ChatContexts\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"chat-65382141036853491\\\\n\\",\\n \\"ChatType\\": \\"INBOUND\\",\\n \\"CallVariables\\": \\"无\\",\\n \\"Members\\": [\\n {\\n \\"Index\\": 1,\\n \\"UserId\\": \\"agent@ccc-test\\\\n\\",\\n \\"UserType\\": \\"Manager\\",\\n \\"Status\\": \\"RINGING\\",\\n \\"SkillGroupId\\": \\"a527a80a-75cf-448f-aba0-fca37c61946d\\",\\n \\"ReleaseInitiator\\": \\"User\\",\\n \\"ReleaseReason\\": \\"无\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 1\\n 无\\n skg-default@ccc-test\\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 123\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n \\n 80326034\\n BREAK\\n ccc-test\\n Warm-up\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n 1609136956378\\n false\\n 86-132xxxx4730\\n job-65382141036853491\\n ON_SITE\\n 1609136956378\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', - 'title' => '轮询坐席状态', - 'summary' => '轮询指定实例下指定坐席的坐席状态，一般由前端坐席工作台调用，用于同步坐席状态。', + 'title' => '保持通话', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ReadyForService' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:47.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HoldCall'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"174F7777-2F6C-4F10-B889-C698E26C1AE0\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6582589278232****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609255716900,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6582589278232****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8001****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609255716908,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609255715822,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6582589278232****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"174F7777-2F6C-4F10-B889-C698E26C1AE0\\n无\\n200\\n无\\n\\n \\n 无\\n OUTBOUND\\n job-65825892782321664\\n \\n 8001****\\n ANSWERED\\n 无\\n 1318888****\\n 无\\n user-test@ccc-test\\n 8001****\\n OUTBOUND\\n 无\\n skill-group@ccc-test\\n ch:user:1318888****->8001****:1609255715825:job-65825892782321664\\n 1609255716900\\n job-65825892782321664\\n \\n \\n \\n 8001****\\n TALKING\\n ccc-test\\n Warm-up\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bs990cd82101cc000176af19ec8e\\n 1609255716908\\n false\\n 1390000****\\n job-65825892782321664\\n ON_SITE\\n 1609255715822\\n [\\"skill-group@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', + ], + 'ImportAdmins' => [ + 'summary' => '导入一个或多个管理员到指定实例下，调用者需要拥有AliyunCCCFullAccess的权限，可以在RAM控制台进行授权。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16707,166 +9985,49 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID，不填默认为当前RAM账户映射的坐席。', - 'type' => 'string', - 'required' => false, - 'example' => 'user-test@ccc-test', - ], - ], - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'OutboundScenario', + 'name' => 'RamIdList', 'in' => 'query', - 'schema' => [ - 'description' => '上线后是否进入仅外呼模式，选填，默认false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '阿里云RAM账户的UID列表，格式为JSON数组的字符串，数组元素最多20个。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["26972543893791****"]'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '响应数据', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => 'CC49060B-87ED-489A-AD3D-00E57775DBFF', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CDB5C94-ACFB-59B5-85FE-C1DAF8049C63'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Data' => [ 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up'."\n", - ], - 'InstanceId' => [ - 'description' => '实例ID。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'READY', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'RoleId' => ['description' => '角色ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'], + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8021****'], + 'RamId' => ['description' => '阿里云RAM账户的UID。', 'type' => 'string', 'example' => '26972543893791****'], ], + 'description' => '', ], ], ], @@ -16875,454 +10036,178 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"CC49060B-87ED-489A-AD3D-00E57775DBFF\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\\\n\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"CC49060B-87ED-489A-AD3D-00E57775DBFF\\n200\\n\\n 80011474\\n OFFLINE\\n ccc-test\\n user-test@ccc-test\\n false\\n ON_SITE\\n\\nOK","errorExample":""}]', - 'title' => '坐席就绪', - 'summary' => '调用ReadyForService使指定实例下的指定坐席就绪，就绪后坐席进入空闲状态。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RedialCall' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1CDB5C94-ACFB-59B5-85FE-C1DAF8049C63\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"Extension\\": \\"8021****\\",\\n \\"RamId\\": \\"26972543893791****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '导入多个管理员', + 'changeSet' => [ + ['createdAt' => '2022-04-19T12:16:06.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportAdmins'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ImportContactFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '251083', + 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], + ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abc', - ], + 'name' => 'FlowPackageData', + 'in' => 'formData', + 'schema' => ['description' => '数据', 'type' => 'string', 'required' => true, 'example' => '{}'], ], [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '座席用户ID信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'samzhang@abc', - ], + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '], ], [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '座席端提供的唯一ID，用来表示一个座席工作台。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'CCC-x.x.x.x-chrome102-bsdf911812c60f61e', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], - [ - 'name' => 'Caller', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'required' => false, - 'example' => '0109810****', + 'title' => 'ImportFlowResponse', + 'description' => 'ImportFlowResponse', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '27DD30C4-CAE2-481A-97CC-D3C54625341D'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '参数。', 'type' => 'string', 'example' => '无'], + ], + ], ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27DD30C4-CAE2-481A-97CC-D3C54625341D\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '导入IVR流程', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + ], + 'ImportCorpNumbers' => [ + 'summary' => '导入自有线路号码，首次导入前，需联系云联络中心-售后技术支持进行加白。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Callee', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], + 'parameters' => [ + [ + 'name' => 'NumberList', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1318888****', - ], + 'schema' => ['description' => '号码列表', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[\'029xxxxxx\']'], ], [ - 'name' => 'TimeoutSeconds', + 'name' => 'TagList', 'in' => 'query', - 'schema' => [ - 'description' => '超时时间，呼叫在经过该参数指定的时间仍然未接通的情况下，则主动挂断。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '300', - 'minimum' => '30', - 'example' => '30', - ], + 'schema' => ['description' => '业务标签', 'type' => 'string', 'required' => false, 'example' => '无'], ], [ - 'name' => 'Tags', + 'name' => 'Province', 'in' => 'query', - 'schema' => [ - 'description' => '随路数据，不能超过128字节，主要用于扩展需求，普通客户无需关心。', - 'type' => 'string', - 'required' => false, - 'example' => 'a=b', - ], + 'schema' => ['description' => '省份', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '陕西'], ], [ - 'name' => 'JobId', + 'name' => 'City', 'in' => 'query', - 'schema' => [ - 'description' => '话务ID。用来重拨的上一通电话的话务ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'job-6581536084722****', - ], + 'schema' => ['description' => '城市', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '西安'], + ], + [ + 'name' => 'Provider', + 'in' => 'query', + 'schema' => ['description' => '线路信息', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxx通信-陕西线路'], + ], + [ + 'name' => 'CorpName', + 'in' => 'query', + 'schema' => ['description' => '企业名称', 'type' => 'string', 'required' => false, 'example' => 'xxx公司'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '状态码。返回OK代表请求成功，其他错误码详见错误码列表。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA63****', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => 'skillGroupId', - ], - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'ContextId' => [ - 'description' => '上下文ID，严格有序递增。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789', - ], - 'CallContext' => [ - 'description' => '话务上下文环境。'."\n", - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '呼叫类型, 最初发起呼叫时的类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '云联络中心实例ID。', - 'type' => 'string', - 'example' => 'abc', - ], - 'JobId' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '139xxxx0501', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'CREATED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '8001****', - ], - 'UserId' => [ - 'description' => '座席用户ID信息。', - 'type' => 'string', - 'example' => 'samzhang@abc', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => 'COACHING', - ], - 'Timestamp' => [ - 'description' => '状态数据上次变更时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '486:USER_BUSY', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '话务ID。'."\n", - 'type' => 'string', - 'example' => 'job-6573574060089****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '1318888****', - ], - 'UserExtension' => [ - 'description' => '用户分机号。', - 'type' => 'string', - 'example' => '8000****'."\n", - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '用户分机号。', - 'type' => 'string', - 'example' => '8000****', - ], - 'WorkMode' => [ - 'description' => '工作模式。枚举值：'."\n" - .'- ON_SITE: 场内模式'."\n" - .'- OFF_SITE: 场外模式'."\n" - .'- OFFICE_PHONE: 办公电话模式', - 'type' => 'string', - 'example' => 'ON_SITE'."\n", - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'CCC-x.x.x.x-chrome102-bsdf911812c60f61e'."\n", - ], - 'JobId' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'example' => 'job-6573574060089****', - ], - 'UserId' => [ - 'description' => '座席用户ID信息。', - 'type' => 'string', - 'example' => 'samzhang@abc'."\n", - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义和客户定义两种。'."\n" - ."\n" - .'系统定义的小休码：'."\n" - .'- Warm-up：坐席上线后置闲前的临时小休状态'."\n" - .'- RingingTimeout： 坐席振铃超时导致的小休'."\n" - .'- RejectCall：坐席拒接导致的小休'."\n" - ."\n" - .'客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'abc', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'False', - ], - 'UserState' => [ - 'description' => '座席状态。枚举值：'."\n" - .'- READY: 空闲'."\n" - .'- WORKING: 话后处理中'."\n" - .'- DIALING: 拨号中'."\n" - .'- BREAK: 小休'."\n" - .'- OFFLINE: 离线'."\n" - .'- TALKING: 通话中'."\n" - .'- RINGING: 振铃中', - 'type' => 'string', - 'example' => 'READY', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '坐席签入的技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@abc', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => '错误码', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '错误信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'C42981C7-93D9-55CD-B078-784F8522E0E1'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'UserBusy', - 'errorMessage' => 'The user %s you called was busy. Please try again later.', - ], - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.Extension', - 'errorMessage' => 'No available extension number exists.', - ], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ], + 'title' => '导入自有线路号码', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportCorpNumbers'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA63****\\",\\n \\"Params\\": [\\n \\"skillGroupId\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 123456789,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"abc\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"139xxxx0501\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"samzhang@abc\\",\\n \\"ChannelFlags\\": \\"COACHING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"486:USER_BUSY\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8000****\\\\n\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8000****\\",\\n \\"WorkMode\\": \\"ON_SITE\\\\n\\",\\n \\"DeviceId\\": \\"CCC-x.x.x.x-chrome102-bsdf911812c60f61e\\\\n\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"UserId\\": \\"samzhang@abc\\\\n\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"abc\\",\\n \\"OutboundScenario\\": true,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@abc\\"\\n ]\\n }\\n }\\n}","type":"json"}]', - 'title' => '重拨', - 'summary' => '重拨脱敏后的话单中的号码', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C42981C7-93D9-55CD-B078-784F8522E0E1\\"\\n}","type":"json"}]', ], - 'ReleaseCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ImportCustomCallTagging' => [ + 'summary' => '调用ImportCustomCallTagging导入多个呼入号码标记到指定实例中。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17331,297 +10216,52 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID，不填默认使用当前RAM账号映射的坐席。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], - ], - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], - ], - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6538214103685****', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'ChannelId', + 'name' => 'FilePath', 'in' => 'query', - 'schema' => [ - 'description' => '待挂断的话务通道ID，非必填，不填默认为当前UserId对应坐席所在的话务通道。', - 'type' => 'string', - 'required' => false, - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****', - ], + 'schema' => ['description' => '呼入号码标记文件的OSS对象的ObjectKey。OSS配置的是云呼的客户公共存储空间，您可以通过云呼叫中心的呼入控制页面上传呼入号码标记文件到客户公共存储空间，上传成功后，调用该接口就会从OSS中读取文件内容，然后批量导入。该接口不建议直接调用，建议通过云呼叫中心提供的公有云默认CRM系统操作。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'temp/ImportCustomCallTagging.xlsx'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'description' => '响应参数列表。', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'Data' => [ + 'description' => '创建失败的呼入号码标记列表。', 'type' => 'array', 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'CREATED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'ChannelVariables' => [ - 'description' => '随路数据', - 'type' => 'string', - 'example' => 'a=b;c=d;', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'BREAK', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - ], + 'description' => '创建失败的呼入号码标记信息。', + 'type' => 'object', + 'properties' => [ + 'Item' => ['description' => '创建失败的呼入号码标记的号码。', 'type' => 'string', 'example' => '1312121****'], + 'Reason' => [ + 'description' => '呼入号码标记创建失败原因。', + 'type' => 'string', + 'enumValueTitles' => ['CUSTOM_NUMBER_ILLEGAL' => '传入的列表中存在格式不合法的号码', 'CUSTOM_NUMBER_DUPLICATED' => '传入的列表中存在重复的号码', 'CUSTOM_NUMBER_ALREADY_EXISTS' => '传入的列表中存在已创建的号码标记', 'CUSTOM_NUMBER_TAG_NOT_EXIST' => '传入的列表中存在未创建的号码标签', 'CUSTOM_NUMBER_INSERT_DUPLICATED' => '后台写入呼入号码标记时存在重复项', 'CUSTOM_NUMBER_TOO_MANY_TAGS' => '传入的列表中存在超出号码标签个数上限的号码'], + 'example' => 'CUSTOM_NUMBER_DUPLICATED', ], ], - 'ContextId' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], ], ], ], @@ -17629,417 +10269,190 @@ ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'Parameter.InvalidFileContent', 'errorMessage' => 'The content or format of the file (%s) is invalid.', 'description' => '参数错误，传入的文件内容无效。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.RamId', 'errorMessage' => 'RAM user %s does not exist.', 'description' => '指定的RAM用户不存在。'], + ['errorCode' => 'NotExists.UserResourceFileKey', 'errorMessage' => 'User resource file key %s does not exist.', 'description' => 'OSS用户资源文件的Key不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.OSS', 'errorMessage' => 'An internal OSS service error occurred. %s', 'description' => '内部OSS服务错误。'], + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"ChannelVariables\\": \\"a=b;c=d;\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 123456\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n 80326034\\n BREAK\\n ccc-test\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n ON_SITE\\n job-65382141036853491\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n \\n \\n ccc-test\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n \\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '挂断通话', - 'summary' => '调用ReleaseCall挂断指定实例下指定通话ID对应的通话，调用者必须是坐席，且正处于通话状态。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RetrieveCall' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => [ + 'substitutions' => ['CCC::2020-07-01::ImportCustomCallTaggings'], + ], + 'title' => '导入呼入号码标记', + 'changeSet' => [ + ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportCustomCallTagging'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"Item\\": \\"1312121****\\",\\n \\"Reason\\": \\"CUSTOM_NUMBER_DUPLICATED\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"无\\nBA03159C-E808-4FF1-B27E-A61B6E888D7F\\n200\\n\\n TagA\\n CUSTOM_NUMBER_DUPLICATED\\n\\nOK","errorExample":""}]', + ], + 'ImportDoNotCallNumbers' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'NumberList', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '禁止外呼号码列表，格式为JSON数组的字符串，数组元素是禁呼号码。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["1900000****","1312121****"]'], ], [ - 'name' => 'DeviceId', + 'name' => 'Remark', 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + 'schema' => ['description' => '禁呼号码的备注信息。', 'type' => 'string', 'required' => false, 'example' => '测试'], ], [ - 'name' => 'JobId', + 'name' => 'FilePath', 'in' => 'query', + 'schema' => ['description' => 'OSS文件的Key，可从GetDoNotCallFileUploadParameters接口返回值中获取，仅在文件上传方式导入时需要填写此参数。', 'type' => 'string', 'required' => false, 'example' => 'temp/blacklist/import/15772471154xxxx/ccc-test/20220315100340/blacklist.xlsx'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6538214103685****', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'Params' => [ + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + 'description' => '', + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '导入禁止外呼号码', + 'summary' => '调用ImportDoNotCallNumbers向指定实例下导入一个或多个禁止外呼号码，导入方式包括手动录入和文件上传两种方式。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportDoNotCallNumbers'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n无\\nOK","errorExample":""}]', + ], + 'ImportDocuments' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ChannelId', - 'in' => 'query', - 'schema' => [ - 'description' => '待取回的话务通道ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****', - ], + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'SchemaId', + 'in' => 'formData', + 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'], + ], + [ + 'name' => 'OssFileKey', + 'in' => 'formData', + 'schema' => ['description' => 'OSS文件的Key', 'type' => 'string', 'required' => true, 'example' => 'ccc-test/test-file.wav'], + ], + [ + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'ImportDocumentsResponse', + 'description' => 'ImportDocumentsResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Params' => [ - 'description' => '响应参数列表。', + 'description' => '响应参数。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'CREATED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'SkillGroupId' => [ - 'description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'BREAK', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - ], - ], - ], - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.ChannelId', - 'errorMessage' => 'The specified channel %s does not exist in call %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n skg-test1@ccc-test\\n \\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '取回通话', - 'summary' => '调用RetrieveCall取回指定实例下指定通话ID对应的通话，通话必须处于保持状态才可操作取回。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SaveRTCStatsV2' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '导入文档', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ImportRamUsers' => [ + 'summary' => '将RAM中已存在的子账号导入为联络中心坐席。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18048,81 +10461,39 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '50605', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'CallId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '257e73de-1ee8-123b-0b9a-00163e0a****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'GeneralInfo', + 'name' => 'RoleId', 'in' => 'query', - 'schema' => [ - 'description' => '通用信息。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[null,"","","1647337928819","1647337888816","agent",null,"上海","10.10.XX.XX","11.1.XX.XX","2002"]', - ], + 'schema' => ['description' => '角色ID，坐席导入成功后在实例中的角色，包括管理员、技能组组长和坐席三种角色。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Agent@ccc-test'."\n"], ], [ - 'name' => 'SenderReport', + 'name' => 'SkillLevelList', 'in' => 'query', - 'schema' => [ - 'description' => '发送报告内容。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["11090","2055127460","0","2236","384592","ssrc_2055127460_send","2022-03-15T09:52:08.820Z","1"]', - ], + 'schema' => ['description' => '技能组的技能等级列表，格式为JSON数组的字符串，数组元素是一个对象，包含两个字段：skillGroupId和skillLevel，skillGroupId填写坐席想要关联的技能组ID，skillLevel填写坐席在该技能组的技能等级，取值范围1-10，值越小，业务能力越强，单位时间内能处理更多的通话。', 'type' => 'string', 'required' => false, 'example' => '[{"skillGroupId":"skillgroup@ccc-test","skillLevel":5}]'."\n"], ], [ - 'name' => 'ReceiverReport', + 'name' => 'RamIdList', 'in' => 'query', - 'schema' => [ - 'description' => '收到报告内容。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["1","1649328987","40","PCMU","383560","89","49","ssrc_1649328987_recv","2022-03-15T09:52:08.820Z","","0","20000"]', - ], + 'schema' => ['description' => '待添加的RAM用户ID列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["28036411123456****","29234301123456****"]'."\n"], ], [ - 'name' => 'GoogAddress', + 'name' => 'WorkMode', 'in' => 'query', - 'schema' => [ - 'description' => '接入点地址。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["47.101.XX.XX","44368","47.104.XX.XX","37947"]', - ], + 'schema' => ['description' => '工作模式。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ON_SITE'], ], ], 'responses' => [ @@ -18130,84 +10501,41 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'TimeStamp' => [ - 'description' => '生成记录时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1647309061000', - ], - 'RowCount' => [ - 'description' => '行数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => '数据，导入执行ID。', 'type' => 'string', 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832'."\n"], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Permission.User', - 'errorMessage' => 'You have no permission to access user(s) %s.', - ], - ], - [ - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + 400 => [ + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], ], - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1647309061000,\\n \\"RowCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n1\\nOK\\n1647309061000\\ntrue","errorExample":""}]', - 'title' => '上报坐席端WebRTC统计信息', - 'summary' => '调用SaveRTCStatsV2上报坐席端WebRTC语音传输统计信息，普通客户无需关心该接口。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SaveTerminalLog' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '从RAM中导入坐席', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\\\n\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', + ], + 'InitiateAttendedTransfer' => [ + 'summary' => '咨询转接通话到其他坐席或某个技能组队列或外部号码，咨询转接也叫关注转或双步转。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18219,264 +10547,102 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '50606', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'CallId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '话务通道的CallId，有SIP协议生成，每个SIP通话都有一个CallId。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'e13c9740-1e37-123b-21b6-00163e352f9', - ], + 'schema' => ['description' => '发起咨询转接的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'JobId', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-b8b0ca63-330c-4e65-8ae3-9de2c7ce7683', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ACC-YUNBS-1.0.10-****'], ], [ - 'name' => 'AppName', + 'name' => 'Transferor', 'in' => 'query', - 'schema' => [ - 'description' => 'APP名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CCCClient', - ], + 'schema' => ['description' => '转接发起方，当场景是咨询转接到外部号码时，用此参数指定的号码作为主叫，转内部坐席或技能组时，此参数无效，发起方由UserId指定。', 'type' => 'string', 'required' => false, 'example' => '无'], ], [ - 'name' => 'DataType', + 'name' => 'Transferee', 'in' => 'query', - 'schema' => [ - 'description' => '数据类型，默认是1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => '被转接方，可以是坐席ID或技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent2@ccc-test'], ], [ - 'name' => 'Content', + 'name' => 'TimeoutSeconds', 'in' => 'query', - 'schema' => [ - 'description' => '内容信息。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'none', - ], + 'schema' => ['description' => '咨询转接超时时间，超过指定时间被转接方没有接起通话，则挂断通话，此字段选填，默认30，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'], ], [ - 'name' => 'Status', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '状态信息，true或false。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'], ], [ - 'name' => 'UniqueRequestId', + 'name' => 'CallPriority', 'in' => 'query', - 'schema' => [ - 'description' => '方法请求ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'none', - ], + 'schema' => ['description' => '转接到技能组队列时的排队优先级，取值范围0-9，0优先级最高，9最低。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], ], [ - 'name' => 'MethodName', + 'name' => 'StrategyName', 'in' => 'query', - 'schema' => [ - 'description' => '方法名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'TurnServerTest', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'TimeStamp' => [ - 'description' => '生成日志时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1647309061000', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid. %s', - ], - ], - 403 => [ - [ - 'errorCode' => 'Permission.Unauthorized', - 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1647309061000\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\nOK\\n1647309061000\\ntrue","errorExample":""}]', - 'title' => '保存坐席端日志信息', - 'summary' => '调用SaveTerminalLog上报坐席端日志信息，普通客户无需关心该接口。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SaveWebRtcInfo' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'schema' => ['description' => '转接到技能组队列时的座席分配策略名称。', 'type' => 'string', 'required' => false, 'example' => 'MOST_IDLE，MOST_SKILLED，MOST_ACQUAINTED，CUSTOMIZED等'], ], [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '50607', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', + 'name' => 'StrategyParams', + 'in' => 'query', + 'schema' => ['description' => '转接到技能组队列时的座席分配策略参数。', 'type' => 'string', 'required' => false, 'example' => '当分配策略为CUSTOMIZED时，本参数的内容为如下格式：'."\n" + .' {'."\n" + .' "functionId": "512fed64-e379-400f-a1a5-14d5730xxxxx",'."\n" + .' "functionName": "routing-strategy-test-2"'."\n" + .'}'], ], - ], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'TransfereeType', 'in' => 'query', 'schema' => [ - 'description' => '实例ID。', + 'description' => '转接目的类型，可选值为AGENT，SKILL_GROUP和EXTERNAL。如果此参数不传，则系统会根据转接的目标号码的格式进行判断，如果发现有判不准确的情况，则需要指定此参数。', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', + 'required' => false, + 'enumValueTitles' => ['AGENT' => '座席', 'EXTERNAL' => '外部号码', 'SKILL_GROUP' => '技能组'], + 'example' => 'SKILL_GROUP', ], ], [ - 'name' => 'CallId', + 'name' => 'RoutingType', 'in' => 'query', 'schema' => [ - 'description' => '话务通道的CallId，有SIP协议生成，每个SIP通话都有一个CallId。', + 'description' => '话务分配类型，可选参数为自动分配(Automatic)或者手动分配(Manual)。如果此参数为空，则默认为自动分配的方式，这也是当前系统的默认行为。选择手动分配方式时，需要您自己配合调用ClaimCall等接口把电话分给指定的座席。', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'e13c9740-1e37-123b-21b6-00163e352f9', + 'required' => false, + 'enumValueTitles' => ['Manual' => '手动分配', 'Automatic' => '自动分配'], + 'example' => 'Automatic', ], ], [ - 'name' => 'JobId', + 'name' => 'Tags', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-b8b0ca63-330c-4e65-8ae3-9de2c7ce7683', - ], + 'schema' => ['description' => '随路数据，主要用于扩展需求，普通用户无需关心。', 'type' => 'string', 'required' => false, 'example' => 'a=b'], ], [ - 'name' => 'ContentType', + 'name' => 'QueuingTimeoutSeconds', 'in' => 'query', - 'schema' => [ - 'description' => '上报内容，值来自前端WebRTC中rtcPeerConnection.getStats(selector)获取的语音传输质量数据，只在云联络中心的公有云平台中使用，集成客户无需关心。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '4', - ], + 'schema' => ['description' => '当转接目标是技能组队列时排队超时时间，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], [ - 'name' => 'Content', + 'name' => 'QueuingOverflowThreshold', 'in' => 'query', - 'schema' => [ - 'description' => '上报内容信息，只在云联络中心的公有云平台中使用，集成客户无需关心。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"media_source":{},"remote_inbound_rtp":{},"outbound_rtp":{},"inbound_rtp":{},"remote_outbound_rtp":{},"candidate":{},"basic":{"callId":"e13c9740-1e37-123b-21b6-00163e352f9","timestamp":"1647262108395","callStartTime":"1647262108393","uid":"user-test","access_point":"shanghai","browser":"90","ip":"127.0.0.1"}}', - ], + 'schema' => ['description' => '当转接目标是技能组队列时排队溢出阈值。默认值为0，表示不溢出。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], ], 'responses' => [ @@ -18484,164 +10650,200 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'TimeStamp' => [ - 'description' => '信息入库时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1647262108395', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], - 'RowCount' => [ - 'description' => '信息入库返回的行数，表示成功写入多少条记录，如果不为1，可能有异常，需要关注。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'ContextId' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '103655'], + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => '记录这个Channel在通话过程中创建的顺序。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'ANSWERED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'MONITORING', + ], + 'SkillGroupId' => ['description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => ['description' => '话务通道的通话类型。', 'type' => 'string', 'example' => 'OUTBOUND'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '通道ID。', 'type' => 'string', 'example' => 'ch:user:139xxxx0501->80326034:1609138902226:job-6538214103685****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], + ], + ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Permission.User', - 'errorMessage' => 'You have no permission to access user(s) %s.', - ], + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], ], - [ - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + 404 => [ + ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], ], 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"CF1C21B9-2D49-4B54-880F-FBE248C16903\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1647262108395,\\n \\"RowCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"CF1C21B9-2D49-4B54-880F-FBE248C16903\\n无\\n200\\n1\\nOK\\n1647262108395\\ntrue","errorExample":""}]', - 'title' => '上报WebRTC状态信息', - 'summary' => '调用SaveWebRtcInfo上报座席端WebRTC的通话状态信息，包括通话质量监控数据等，用于后台统计和监控，客户无需关心该接口。', + 'title' => '发起咨询转接', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SaveWebRTCStats' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-04-01T09:23:01.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-10-26T08:13:47.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-04-25T07:33:48.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-04-12T02:15:28.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitiateAttendedTransfer'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103655,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:139xxxx0501->80326034:1609138902226:job-6538214103685****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 10\\n skg-default@ccc-test\\n 无\\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'InterceptCall' => [ + 'summary' => '调用InterceptCall强行拆开指定实例下指定通话ID对应的通话，通话必须处于监听状态，且由监听者发起强拆，强拆成功后，原本与客户通话的坐席会被挂断，发起强拆的坐席代替原坐席继续与客户通话。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '50608', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'CallId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '257e73de-1ee8-123b-0b9a-00163e0a****', - ], + 'schema' => ['description' => '发起强拆的坐席。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'GeneralInfo', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '通用信息。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[null,"","","1647337928819","1647337888816","agent",null,"上海","10.10.XX.XX","11.1.XX.XX","2002"]', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], ], [ - 'name' => 'SenderReport', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '发送报告内容。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["11090","2055127460","0","2236","384592","ssrc_2055127460_send","2022-03-15T09:52:08.820Z","1"]', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'], ], [ - 'name' => 'ReceiverReport', + 'name' => 'InterceptedUserId', 'in' => 'query', - 'schema' => [ - 'description' => '收到报告内容。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["1","1649328987","40","PCMU","383560","89","49","ssrc_1649328987_recv","2022-03-15T09:52:08.820Z","","0","20000"]', - ], + 'schema' => ['description' => '被强拆的座席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent2@ccc-test'], ], [ - 'name' => 'GoogAddress', + 'name' => 'TimeoutSeconds', 'in' => 'query', - 'schema' => [ - 'description' => '接入点地址。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["47.101.XX.XX","44368","47.104.XX.XX","37947"]', - ], + 'schema' => ['description' => '强拆超时时间，经过指定的时间强拆仍未成功，则取消强拆，正常情况下，强拆操作会马上成功，设置超时时间是为了防止异常发生，此字段选填，默认30，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '60'], ], ], 'responses' => [ @@ -18649,81 +10851,157 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'TimeStamp' => [ - 'description' => '生成记录时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1555492246000', - ], - 'RowCount' => [ - 'description' => '行数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Permission.User', - 'errorMessage' => 'You have no permission to access user(s) %s.', - ], - ], - [ - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'INTERCEPT', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'ANSWERED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => '无', + ], + 'SkillGroupId' => ['description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'INTERCEPT', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], + ], + ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], + ], + ], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], + ], 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"CF1C21B9-2D49-4B54-880F-FBE248C16903\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1555492246000,\\n \\"RowCount\\": 1\\n}","type":"json"}]', - 'title' => '上报坐席端WebRTC统计信息', - 'summary' => '调用SaveWebRTCStats上报坐席端WebRTC语音传输统计信息，普通客户无需关心该接口。', - ], - 'SendDtmfSignaling' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '强拆通话', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InterceptCall'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"INTERCEPT\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"无\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"INTERCEPT\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 10\\n skg-default@ccc-test\\n 无\\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'LaunchAuthentication' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18734,75 +11012,47 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '发送DTMF的坐席ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '发起核身的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ACC-YUNBS-1.0.10-****'], ], [ 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6573574060089****', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'], ], [ - 'name' => 'ChannelId', + 'name' => 'ContactFlowId', 'in' => 'query', - 'schema' => [ - 'description' => '待发送DTMF的话务通道ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ch:customer:0108989****->1318888****:1609234221870:job-6573574060089****', - ], + 'schema' => ['description' => 'IVR核身流程的联系流ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af145gfc-1108-4d55-8fca-f719bd512ebb'], ], [ - 'name' => 'Dtmf', + 'name' => 'ContactFlowVariables', 'in' => 'query', - 'schema' => [ - 'description' => 'DTMF按键信息，即拨号盘上的按键，包括0-9、*、#。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5', - 'maxLength' => 1000000, - 'minLength' => 0, - ], + 'schema' => ['description' => '传递给联系流的变量，选填，这里配置的变量，可以在IVR流程中拿到并使用，格式为JSON字符串格式的键值对集合。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "customerID": "208880281831****",'."\n" + .' "operateType": "cipherCode",'."\n" + .' "taskId": "1234567890",'."\n" + .' "crmOther": "123"'."\n" + .'}'], ], ], 'responses' => [ @@ -18810,336 +11060,156 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => '842399EC-7D32-4472-AD08-9504C3F141FF', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Params' => [ 'description' => '响应参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], 'Data' => [ - 'description' => '数据。'."\n", + 'description' => '数据。', 'type' => 'object', 'properties' => [ 'CallContext' => [ - 'description' => '话务上下文环境。'."\n", + 'description' => '话务上下文环境。', 'type' => 'object', 'properties' => [ 'CallType' => [ - 'description' => '通话类型。', + 'description' => '呼叫类型。', 'type' => 'string', 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', 'COACH' => '辅导', ], 'example' => 'OUTBOUND', ], - 'InstanceId' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。'."\n", - 'type' => 'string', - 'example' => 'job-6573574060089****', - ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], 'ChannelContexts' => [ - 'description' => '话务通道列表。'."\n", + 'description' => '话务通道列表。', 'type' => 'array', 'items' => [ 'description' => '话务通道。', 'type' => 'object', 'properties' => [ - 'Index' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。'."\n", - 'type' => 'string', - 'example' => '无', - ], + 'Index' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], 'ChannelState' => [ 'description' => '话务通道的状态。', 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], 'example' => 'ANSWERED', ], - 'Destination' => [ - 'description' => '话务通道的被叫方。'."\n", - 'type' => 'string', - 'example' => '8001****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], 'ChannelFlags' => [ 'description' => '话务通道标志。', 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], 'example' => 'MONITORING', ], - 'SkillGroupId' => [ - 'description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609234222367', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '无', - ], + 'SkillGroupId' => ['description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], 'CallType' => [ 'description' => '话务通道的通话类型。', 'type' => 'string', 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', 'COACH' => '辅导', ], 'example' => 'OUTBOUND', ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6573574060089****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:131888****->8001****:1609234221870:job-6573574060089****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0101234****', - ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], ], ], ], ], ], 'UserContext' => [ - 'description' => '坐席上下文环境。'."\n", + 'description' => '坐席上下文环境。', 'type' => 'object', 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609234222375', - ], + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], 'WorkMode' => [ 'description' => '工作模式。', 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], 'example' => 'ON_SITE', ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609234221864', - ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], 'BreakCode' => [ 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], 'example' => 'Warm-up', ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1390000****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6573574060089****', - ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], 'UserState' => [ 'description' => '座席状态。', 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], 'example' => 'TALKING', ], 'SignedSkillGroupIdList' => [ 'description' => '坐席签入的技能组ID列表。', 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], ], ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.ChannelId', - 'errorMessage' => 'The specified channel %s does not exist in call %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], + ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], ], 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"842399EC-7D32-4472-AD08-9504C3F141FF\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609234222367,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609234221870:job-6573574060089****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"Originator\\": \\"0101234****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609234222375,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609234221864,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"842399EC-7D32-4472-AD08-9504C3F141FF\\n无\\n200\\n无\\n\\n \\n ccc-test\\n OUTBOUND\\n job-65735740600893440\\n \\n 8001****\\n ANSWERED\\n 无\\n OUTBOUND\\n 1\\n 无\\n skill-group@ccc-test\\n ch:user:131888****->8001****:1609234221870:job-65735740600893440\\"\\n 1609234222367\\n 无\\n 0101234****\\n []\\n user-test@ccc-test\\n 8001****\\n job-65735740600893440\\n \\n \\n \\n 8001****\\n TALKING\\n ccc-test\\n Warm-up\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bse05179638553000176add4046f\\n 1609234222375\\n false\\n 1390000****\\n job-65735740600893440\\n ON_SITE\\n 1609234221864\\n [\\"skill-group@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', - 'title' => '发送按键信息', - 'summary' => '调用SendDtmfSignaling在通话过程中发送DTMF按键信息。', + 'title' => '发起IVR核身', + 'summary' => '调用LaunchAuthentication使通话临时转入指定的IVR流程，调用此接口后，会在通话过程中进入IVR交互环节，通用用于核身操作。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SignInGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:47.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LaunchAuthentication'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 10\\n skg-default@ccc-test\\n 无\\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'LaunchSurvey' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19150,222 +11220,235 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc3I1HSP'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID，不填默认使用当前RAM账号映射的坐席。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '发起满意度的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '语音设备ID。当有多个语音设备可用时，通过此参数指定其中一个语音设备，比如浏览器WebRTC或者SIP话机等。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CCC-xx.xx.xx.xx-chrome119-bse1b618bff3xxxxd', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], ], [ - 'name' => 'SignedSkillGroupIdList', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '想要签入的技能组ID列表，格式为JSON数组字符串，数组元素是技能组ID。', - 'type' => 'string', - 'required' => true, - 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6580466654649****'], ], [ - 'name' => 'ChatDeviceId', + 'name' => 'ContactFlowId', 'in' => 'query', - 'schema' => [ - 'description' => 'Chat设备ID。', - 'type' => 'string', - 'required' => false, - 'example' => '4c51c9116c36537cb850dc1081d745df', - ], + 'schema' => ['description' => 'IVR满意度流程的联系流ID，请确保填入的联系流ID是可用的满意度调查流程。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '4685b65a-eb8f-11ec-8ea0-0242ac120002'], ], [ - 'name' => 'Additivity', + 'name' => 'ContactFlowVariables', + 'in' => 'query', + 'schema' => ['description' => '传递给联系流的变量，这里配置的变量，可以在IVR流程中拿到并使用，格式为JSON字符串格式的键值对集合，非必填，默认为空。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "customerID": "208880281831****",'."\n" + .' "operateType": "cipherCode",'."\n" + .' "taskId": "1234567890",'."\n" + .' "crmOther": "123"'."\n" + .'}'], + ], + [ + 'name' => 'SurveyChannel', 'in' => 'query', 'schema' => [ - 'description' => '座席已经签入一些技能组后，如果指定此参数为True, 则可以签入更多新技能组。', - 'type' => 'boolean', + 'description' => '满意度采集渠道，非必填，默认为语音满意度。', + 'type' => 'string', 'required' => false, - 'example' => 'false', + 'enumValueTitles' => ['IVR' => '语音满意度', 'SMS' => '短信满意度'], + 'example' => 'IVR', ], ], + [ + 'name' => 'SmsMetadataId', + 'in' => 'query', + 'schema' => ['description' => '短信满意度配置ID，只有收集渠道为SMS时才需要填写此参数，非必填，默认为空。', 'type' => 'string', 'required' => false, 'example' => '4685b65a-eb8f-11ec-8ea0-0242ac120002'], + ], + [ + 'name' => 'SurveyTemplateId', + 'in' => 'query', + 'schema' => ['description' => '满意度调查模版ID', 'type' => 'string', 'required' => false, 'example' => '19dc793c-9a01-4cb0-b7d5-fcb5431bab6b'], + ], + [ + 'name' => 'SurveyTemplateVariables', + 'in' => 'query', + 'schema' => ['description' => '满意度调查配置', 'type' => 'string', 'required' => false, 'example' => '[]'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'AF1E5957-5276-48FF-A6E6-347166A4ADCD'], 'Params' => [ 'description' => '响应参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****'."\n", - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => '无', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', + 'CallContext' => [ + 'description' => '话务上下文环境。'."\n", + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。'."\n", 'type' => 'string', 'example' => 'job-6580466654649****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '无'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'ANSWERED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1318888****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'MONITORING', + ], + 'SkillGroupId' => ['description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609250655922'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6580466654649****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8001****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'], + ], + ], + ], ], - 'example' => 'READY', ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', + 'UserContext' => [ + 'description' => '坐席上下文环境。'."\n", + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609250656122'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609250655090'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1390000****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6580466654649****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], ], ], - 'ChatDeviceId' => [ - 'description' => 'Chat设备ID。', - 'type' => 'string', - 'example' => '4c51c9116c36537cb850dc1081d745df', - ], + 'ContextId' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '102323'], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\\\n\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ],\\n \\"ChatDeviceId\\": \\"4c51c9116c36537cb850dc1081d745df\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n 80326034\\n BREAK\\n ccc-test\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n ON_SITE\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n\\nOK","errorExample":""}]', - 'title' => '签入技能组', - 'summary' => '调用SignInGroup使坐席签入指定实例下的指定技能组，即坐席上线操作。', + 'title' => '发起满意度调查', + 'summary' => '调用LaunchSurvey发送满意度调查，该操作会导致挂机，如果是语音满意度，客户会在坐席挂机后进入IVR满意度调查流程，并在IVR流程中完成满意度采集。如果是短信满意度，则通话结束，客户收到满意度调查短信。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SignOutGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-08-13T06:54:43.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-06-21T06:40:16.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-10-26T08:13:47.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-12-22T03:36:07.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LaunchSurvey'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"AF1E5957-5276-48FF-A6E6-347166A4ADCD\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6580466654649****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1318888****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609250655922,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6580466654649****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"Originator\\": \\"1318888****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609250656122,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609250655090,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6580466654649****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 102323\\n }\\n}","errorExample":""},{"type":"xml","example":"AF1E5957-5276-48FF-A6E6-347166A4ADCD\\n无\\n200\\n无\\n\\n 123456789\\n \\n ccc-test\\n OUTBOUND\\n job-65804666546491392\\n \\n 1318888****\\n ANSWERED\\n 无\\n OUTBOUND\\n 1\\n 无\\n skill-group@ccc-test\\n ch-user-1917047****-80154160-1655094662943-job-d4a3d2f1-7d8b-40a4-bd3d-3cc20842c620\\n 1609250655922\\n 无\\n 1318888****\\n []\\n user-test@ccc-test\\n 8001****\\n job-65804666546491392\\n \\n \\n \\n 8001****\\n TALKING\\n ccc-test\\n default\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bs3b5f22c6d78f000176aebe9471\\n 1609250656122\\n false\\n 1390000****\\n job-65804666546491392\\n ON_SITE\\n 1609250655090\\n [\\"skill-group@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', + ], + 'ListAgentStateLogs' => [ + 'summary' => '调用ListAgentStateLogs获取指定实例下指定坐席的状态日志列表。注意本接口即将过期，请使用替代接口ListRealtimeAgentStates。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19374,42 +11457,34 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccSART34'], + ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '开始时间戳，默认是当天开始时间，最早为当前日期之前的180天，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620230400000'], ], [ - 'name' => 'UserId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID，不填默认使用当前RAM账号映射的坐席。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '截止时间戳，默认是当前时间，EndTime和StartTime的时间差不能超过7天，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620273600000'], ], [ - 'name' => 'DeviceId', + 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], ], 'responses' => [ @@ -19417,178 +11492,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => '200', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'], 'Data' => [ 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', + 'type' => 'array', + 'items' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => '状态开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620259200000'], + 'StateCode' => [ + 'description' => '子状态，状态码的补充说明，某些坐席状态由State和StateCode共同标识，例如：监听场景，状态为Talking，子状态为Monitoring。', + 'type' => 'string', + 'enumValueTitles' => ['Monitored' => '被监听', 'Consulted' => '被咨询', 'Consulting' => '咨询中', 'Conference' => '会议', 'Monitoring' => '监听中'], + 'example' => 'CHECK_IN_BREAK', ], - 'example' => 'BREAK', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', + 'Duration' => ['description' => '状态持续时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '32'], + 'State' => [ + 'description' => '状态码。', 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', + 'enumValueTitles' => ['Ready' => '空闲', 'Talking' => '通话', 'ACW' => '话后处理', 'Ringing' => '振铃', 'Break' => '小休', 'Offline' => '下线', 'Dialing' => '拨号'], + 'example' => 'Break', ], + 'OutboundScenario' => ['description' => '坐席是否为仅外呼状态。', 'type' => 'boolean', 'example' => 'false'], + 'BreakCode' => ['description' => '小休码。', 'type' => 'string', 'example' => '会议'], + 'WorkMode' => ['description' => '工作模式。', 'type' => 'string', 'example' => 'ON_SITE'], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n\\n200","errorExample":""}]', - 'title' => '签出技能组', - 'summary' => '调用SignOutGroup使坐席签出当前签入的技能组，即坐席下线操作。', + 'title' => '获取坐席状态日志列表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'StartBack2BackCall' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-05-10T07:29:41.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentStateLogs'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StartTime\\": 1620259200000,\\n \\"StateCode\\": \\"CHECK_IN_BREAK\\",\\n \\"Duration\\": 32,\\n \\"State\\": \\"Break\\",\\n \\"OutboundScenario\\": false,\\n \\"BreakCode\\": \\"会议\\",\\n \\"WorkMode\\": \\"ON_SITE\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"943D8EF3-3321-471F-A104-51C96FCA94D6\\n无\\n200\\n\\n Break\\n CHECK_IN_BREAK\\n 1620259200000\\n false\\n 5903871\\n\\nOK","errorExample":""}]', + ], + 'ListAgentStates' => [ + 'summary' => '调用ListAgentStates获取指定实例下按指定条件过滤后的坐席状态列表，该接口仅对特定用户开放，其他客户不建议调用。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19597,86 +11561,56 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccSART34'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Caller', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1391814****', - ], + 'schema' => ['description' => '按技能组ID过滤。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test'], ], [ - 'name' => 'Callee', + 'name' => 'AgentIds', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1372168****', - ], + 'schema' => ['description' => '按坐席ID列表过滤。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'TimeoutSeconds', + 'name' => 'State', 'in' => 'query', 'schema' => [ - 'description' => '双呼超时时间，呼叫在经过该参数指定的时间仍然未接通的情况下，则主动挂断，非必填，默认30，单位秒。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '按坐席状态过滤，只能按单个状态过滤。', + 'type' => 'string', 'required' => false, - 'maximum' => '3600', - 'minimum' => '0', - 'example' => '30', + 'enumValueTitles' => ['Ready' => '空闲', 'Talking' => '通话', 'ACW' => '话后处理', 'Break' => '小休', 'Ringing' => '振铃', 'Offline' => '下线', 'Dialing' => '拨号'], + 'example' => 'Ready', ], ], [ - 'name' => 'Broker', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '中间号码，需要是实例下可用的外呼号码，双呼时会使用该号码先后呼叫主叫和被叫。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0102157****', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'AdditionalBroker', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '附加中间号码，如果该参数存在，则呼叫主叫时使用中间号码，呼叫被叫时使用该参数指定的号码，非必填， 默认空。', - 'type' => 'string', - 'required' => false, - 'example' => '0102156****', - ], + 'schema' => ['description' => '分页大小，范围1-300。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], [ - 'name' => 'Tags', + 'name' => 'ExcludeOfflineUsers', 'in' => 'query', - 'schema' => [ - 'description' => '随路数据，不能超过128字节，主要用于扩展需求，普通客户无需关心。', - 'type' => 'string', - 'required' => false, - 'example' => '无', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '过滤掉离线坐席，固定为true，暂不支持false。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'], ], ], 'responses' => [ @@ -19684,394 +11618,115 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'BACK2BACK', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-1034159089076****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '无', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'NONE', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1372168****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => '无', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => 'COACHING', - 'MONITORING' => 'MONITORING', - 'MONITORED' => 'MONITORED', - 'COACHED' => 'COACHED', - 'HOLD' => 'HOLD', - 'MUTED' => 'MUTED', - ], - 'example' => 'MONITORING', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1618217874062', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '无', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => 'INBOUND', - 'BARGE' => 'BARGE', - 'CONSULTANT' => 'CONSULTANT', - 'CONFERENCE' => 'CONFERENCE', - 'MONITOR' => 'MONITOR', - 'INTERNAL' => 'INTERNAL', - 'OUTBOUND' => 'OUTBOUND', - 'INTERCEPT' => 'INTERCEPT', - 'BACK2BACK' => 'BACK2BACK', - 'PREDICTIVE' => 'PREDICTIVE', - 'COACH' => 'COACH', - ], - 'example' => 'BACK2BACK', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-1034159089076****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方', - 'type' => 'string', - 'example' => '0102157****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8020****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1618217872911', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1618217794599', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DeviceState' => [ - 'description' => '设备状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'UNREGISTERED' => '未注册', - 'ONLINE' => '在线', - 'OFFLINE' => '离线', - ], - 'example' => '无', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-1034159089076****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-300。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'], + 'List' => [ + 'description' => '列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LoginName' => ['description' => '座席登录名。', 'type' => 'string', 'example' => 'agent'], + 'Dn' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8030****'], + 'StateDuration' => ['description' => '坐席状态持续时长。', 'type' => 'string', 'example' => '10'], + 'State' => [ + 'description' => '坐席状态。', + 'type' => 'string', + 'enumValueTitles' => ['Ready' => '空闲', 'Talking' => '通话', 'ACW' => '话后处理', 'Ringing' => '振铃', 'Break' => '小休', 'Offline' => '下线', 'Dialing' => '拨号'], + 'example' => 'Ready', ], - 'example' => 'OFFLINE', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', + 'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'AgentName' => ['description' => '座席名称。', 'type' => 'string', 'example' => '坐席小王'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'BreakCode' => [ + 'description' => '小休码。', 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', ], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.Number', - 'errorMessage' => 'The specified number %s does not exist in instance %s.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], - ], + 'staticInfo' => [ + 'substitutions' => ['CCC::2020-07-01::ListRealtimeAgentStates'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"BACK2BACK\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-1034159089076****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"1372168****\\",\\n \\"UserId\\": \\"无\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1618217874062,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"BACK2BACK\\",\\n \\"JobId\\": \\"job-1034159089076****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0102157****\\",\\n \\"UserExtension\\": \\"8001****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8020****\\",\\n \\"Heartbeat\\": 1618217872911,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1618217794599,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"无\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-1034159089076****\\",\\n \\"UserState\\": \\"OFFLINE\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\n无\\n200\\n无\\n\\n \\n ccc-test\\n BACK2BACK\\n job-103415908907622400\\n \\n 1014\\n NONE\\n 无\\n 无\\n 010xxxx2157\\n []\\n 无\\n 80011474\\n BACK2BACK\\n 无\\n ch:user:1318888888->80011474:1609225718294:job-65700074013925376\\n 1618217874062\\n job-103415908907622400\\n \\n \\n \\n OFFLINE\\n ccc-test\\n ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c\\n Warm-up\\n false\\n 无\\n 86-132xxxx4730\\n 80202301\\n 无\\n user-test@ccc-test\\n 1618217872911\\n ON_SITE\\n job-103415908907622400\\n 1618217794599\\n [\\"skg-default@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', - 'title' => '发起双呼', - 'summary' => '调用StartBack2BackCall发起双呼。', - 'description' => '双呼和传统的双方通话不同，主叫并不直接呼叫对方，而是通过一个背靠背代理（Back to Back Agent），背靠背代理首先呼叫主叫方，接通后，再呼叫被叫方，然后把二者拉进一个会场。在这种方式下，由于每个呼叫的所有消息流经背靠背代理，因此服务提供商可以据此提供增值服务，比如计时、录音、隐藏真实号码等等。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'StartConference' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '获取坐席状态列表', + 'changeSet' => [ + ['createdAt' => '2022-07-01T13:16:03.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-29T14:26:34.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentStates'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"LoginName\\": \\"agent\\",\\n \\"Dn\\": \\"8030****\\",\\n \\"StateDuration\\": \\"10\\",\\n \\"State\\": \\"Ready\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"OutboundScenario\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListAgentSummaryReportsSinceMidnight' => [ + 'summary' => '调用ListAgentSummaryReportsSinceMidnight获取指定实例下按指定条件过滤后的坐席历史数据报表，统计的是从当天0时开始，到当前时间为止的数据。该接口仅对特定用户开放，其他客户不建议调用。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '发起会议的坐席ID，非必填，不填则默认使用当前RAM账户映射的坐席。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '按技能组ID过滤。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test'], ], [ - 'name' => 'ParticipantListJson', + 'name' => 'AgentIds', 'in' => 'query', - 'schema' => [ - 'description' => '参会方列表，格式为JSON数组的字符串，数组元素是参会方，如果是内呼坐席，参会方是目标的坐席分机号，如果是外呼客户，参会方是客户号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["8045****","1317511****"]', - ], + 'schema' => ['description' => '按坐席ID列表过滤，范围0-100 。'."\n" + ."\n" + .'> 如果坐席ID列表不为空，则直接按照坐席ID列表进行查询，此时pageSize和pageNumber参数无效，数据直接返回，如：请求参数：pageNumber = 3 则响应参数中pageNumber = 3 。', 'type' => 'string', 'required' => false, 'example' => '["agent1@ccc-test", "agent2@ccc-test"]'], ], [ - 'name' => 'TimeoutSeconds', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '超时时间，呼叫在经过该参数指定的时间仍然未接通的情况下，则主动挂断，非必填，默认30，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '3600', - 'minimum' => '0', - 'example' => '30', - ], + 'schema' => ['description' => '分页序号，范围1-100，非必填，默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Tags', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '随路数据，不能超过128字节，主要用于扩展需求，普通客户无需关心。', - 'type' => 'string', - 'required' => false, - 'example' => '无', - ], + 'schema' => ['description' => '分页大小，范围1-100，非必填，默认10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ @@ -20079,278 +11734,97 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FDD327D1-AB8A-596B-883F-F63582A73F1D', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - 'Data' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '27DD30C4-CAE2-481A-97CC-D3C54625341D'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'PagedAgentSummaryReport' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。'."\n", - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。'."\n", - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'List' => [ + 'description' => '坐席概览数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '坐席概览数据。', + 'type' => 'object', + 'properties' => [ + 'LoginName' => ['description' => '座席登录名。', 'type' => 'string', 'example' => 'agent'], + 'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'AgentName' => ['description' => '坐席名称。', 'type' => 'string', 'example' => '坐席小王。'], + 'SkillGroupNames' => ['description' => '座席所属技能组名称列表，格式为JSON数组的字符串，数组元素是技能组名称。', 'type' => 'string', 'example' => '["测试技能组1","测试技能组2"]'], + 'Timestamp' => ['description' => '统计打点时刻。', 'type' => 'string', 'example' => '2018-09-13 00:00:00'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'SkillGroupIds' => ['description' => '座席所属技能组ID列表，格式为JSON数组的字符串，数组元素为技能组ID。', 'type' => 'string', 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'."\n"], + 'Overall' => [ + 'description' => '整体指标。', 'type' => 'object', 'properties' => [ - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'ANSWERED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。'."\n" - ."\n", - 'type' => 'string', - 'example' => '8001****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test'."\n", - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => 'MONITORING', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6573574060089****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:131888****->8001****:1609225718294:job-65700074013925376', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '1318888****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****'."\n", - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalLoggedInTime' => ['description' => '总登录时长，不包含小休时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OccupancyRate' => ['description' => '座席利用率，计算公式为：（TotalworkTime+TotalTalkTime）/TotalLoggedInTime。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，计算公式为：TotalWorkTime/TotalCalls，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，计算公式为：TotalTalkTime/（CallsAnswered+CallsHandled），单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageReadyTime' => ['description' => '平均就绪时长，计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '37'], + 'OneTransferCalls' => ['description' => '直接转接的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalBreakTime' => ['description' => '总小休时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话量，计算公式为：CallsOffered+CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up'."\n", - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => '1609136956378'."\n", - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DeviceState' => [ - 'description' => '设备状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'UNREGISTERED' => '未注册', - 'ONLINE' => '在线', - 'OFFLINE' => '离线', - ], - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', + 'Inbound' => [ + 'description' => '呼入指标。', + 'type' => 'object', + 'properties' => [ + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '分配量，即分配给此坐席的电话次数，包括其他坐席盲转和咨询转给此坐席的电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageRingTime' => ['description' => '平均振铃时长，计算公式为：TotalRingTime/CallsRinged，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '应答量，即坐席应答的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ServiceLevel20' => ['description' => '20秒应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], ], - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', + 'Outbound' => [ + 'description' => '呼出指标。', + 'type' => 'object', + 'properties' => [ + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsDialed' => ['description' => '电话拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'string', 'example' => '0'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], ], ], ], @@ -20358,50 +11832,29 @@ ], ], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.Number', - 'errorMessage' => 'The specified number %s does not exist in instance %s.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], - ], + 'staticInfo' => [ + 'substitutions' => ['CCC::2020-07-01::ListHistoricalAgentReport'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"FDD327D1-AB8A-596B-883F-F63582A73F1D\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\\\n\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-65700074013925376\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8032****\\\\n\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\\\n\\",\\n \\"InstanceId\\": \\"1609136956378\\\\n\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"false\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', - 'title' => '发起会议', - 'summary' => '调用StartConference发起一个会议。', - ], - 'StartPredictiveCall' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '获取坐席概览数据列表', + 'changeSet' => [ + ['createdAt' => '2022-02-28T02:23:24.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentSummaryReportsSinceMidnight'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"27DD30C4-CAE2-481A-97CC-D3C54625341D\\",\\n \\"Success\\": true,\\n \\"PagedAgentSummaryReport\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"LoginName\\": \\"agent\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王。\\",\\n \\"SkillGroupNames\\": \\"[\\\\\\"测试技能组1\\\\\\",\\\\\\"测试技能组2\\\\\\"]\\",\\n \\"Timestamp\\": \\"2018-09-13 00:00:00\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SkillGroupIds\\": \\"[\\\\\\"skillgroup1@ccc-test\\\\\\",\\\\\\"skillgroup2@ccc-test\\\\\\"]\\\\n\\",\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"MaxReadyTime\\": 37,\\n \\"OneTransferCalls\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"TotalCalls\\": 0\\n },\\n \\"Inbound\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0\\n },\\n \\"Outbound\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": \\"0\\",\\n \\"TotalDialingTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListAttempts' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20410,385 +11863,131 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Caller', + 'name' => 'CampaignId', 'in' => 'query', - 'schema' => [ - 'description' => '主叫号码，需要是实例下可用的外呼号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0109810****', - ], + 'schema' => ['title' => '活动ID', 'description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'], ], [ - 'name' => 'Callee', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1312353****', - ], + 'schema' => ['title' => '开始时间', 'description' => '开始时间，非必填，不填默认为预测式外呼活动的开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1634115688291'], ], [ - 'name' => 'TimeoutSeconds', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '超时时间，呼叫在经过该参数指定的时间仍然未接通的情况下，则主动挂断，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '3600', - 'minimum' => '0', - 'example' => '10', - ], + 'schema' => ['title' => '结束时间', 'description' => '结束时间，非必填，不填默认为预测式外呼活动的结束时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1634115698291'], ], [ - 'name' => 'ContactFlowId', + 'name' => 'QueueId', 'in' => 'query', - 'schema' => [ - 'description' => 'IVR联系流ID，被叫接通后，通话将自动转入此IVR流程。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9774c36c-12fe-4e37-adce-89bc77ce****', - ], + 'schema' => ['title' => '队列ID', 'description' => '按技能组ID过滤，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test'], ], [ - 'name' => 'Tags', + 'name' => 'CaseId', 'in' => 'query', - 'schema' => [ - 'description' => '随路数据，主要用于扩展需求，普通用户无需关心。', - 'type' => 'string', - 'required' => false, - 'example' => '无', - ], + 'schema' => ['title' => 'CaseID', 'description' => '系统生成的联系人ID，客户无需关心。', 'type' => 'string', 'required' => true, 'example' => '60ecb1a2-4480-4d01-bede-c5b7655bfadf'], ], [ - 'name' => 'ContactFlowVariables', + 'name' => 'AttemptId', 'in' => 'query', - 'schema' => [ - 'description' => '传入的联系流变量，格式为JSON数组的字符串，数组元素是一个键值对，Key为变量名，Value为变量值。在联系流ID对应的IVR的开始节点中新建同名的自定义参数，即可在IVR流程中使用该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '{"name":"王先生","time":"19点20分","address":"某某中心"}', - ], + 'schema' => ['title' => '记录ID', 'description' => '呼叫记录ID，和通话ID取值一样。', 'type' => 'string', 'required' => false, 'example' => 'job-16976964500325****'], ], [ - 'name' => 'MaskedCallee', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '脱敏后的被叫号码，如果该字段不为空，表示需要对被叫号码脱敏，脱敏规则由客户自行定义，只需将脱敏后的被叫号码填入即可，使用脱敏被叫会导致某些场景下看到的是脱敏后的被叫号码，无法查看真实被叫号码。', - 'type' => 'string', - 'required' => false, - 'example' => '1312353****', - ], + 'schema' => ['title' => '话务ID', 'description' => '按通话ID过滤，非必填，默认为空。', 'type' => 'string', 'required' => false, 'example' => 'job-16976964500325****'], ], [ - 'name' => 'SkillGroupId', + 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID，非必填，如果该参数有值，则外呼号码仅从该参数指定的技能组的关联号码中选取。', - 'type' => 'string', - 'required' => false, - 'example' => 'skillgroup@ccc-test', - ], + 'schema' => ['title' => '坐席ID', 'description' => '按坐席ID过滤，非必填，默认为空。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Caller', + 'in' => 'query', + 'schema' => ['title' => '主叫', 'description' => '按主叫号码过滤，非必填，默认为空。', 'type' => 'string', 'required' => false, 'example' => '05711234****'], + ], + [ + 'name' => 'Callee', + 'in' => 'query', + 'schema' => ['title' => '被叫', 'description' => '按被叫号码过滤，非必填，默认为空。', 'type' => 'string', 'required' => false, 'example' => '1888888****'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '页码', 'description' => '分页页码，大小取决于PageNumber和PageSize的乘积，两个参数相乘不能大于10000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '页大小', 'description' => '分页大小，大小取决于PageNumber和PageSize的乘积，两个参数相乘不能大于10000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100'], + ], + [ + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => ['description' => '扩展查询条件。JSON格式，目前支持caseIds，支持caseIds批量查询。', 'type' => 'string', 'required' => false, 'example' => '{"caseIds":["964f05a7-fc15-4a05-93a6-cd7421c4459e","5e2d508b-0df6-4077-8099-d3fff51ea6d0","da037029-8c83-4270-a90e-e7734be76af6"]}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6570007401392****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '无', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'NONE', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '8001****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => '[]', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609225718295', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '无', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6570007401392****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:131888****->8001****:1609225718294:job-6570007401392****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '1318888****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DeviceState' => [ - 'description' => '设备状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'UNREGISTERED' => '未注册', - 'ONLINE' => '在线', - 'OFFLINE' => '离线', - ], - 'example' => 'ONLINE', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6570007401392****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'READY', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '分页页码，大小取决于PageNumber和PageSize的乘积，两个参数相乘不能大于10000。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，大小取决于PageNumber和PageSize的乘积，两个参数相乘不能大于10000。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'List' => [ + 'description' => '联系人拨打记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '联系人拨打记录。', + 'type' => 'object', + 'properties' => [ + 'AttemptId' => ['description' => '呼叫ID。', 'type' => 'string', 'example' => 'job-1704342174816****'], + 'ContactId' => ['description' => '通话ID', 'type' => 'string', 'example' => 'job-1704342174816****'], + 'CaseId' => ['description' => '系统生成的联系人ID，客户无需关心。', 'type' => 'string', 'example' => '21d194a7-60b7-4824-932b-48ed03a83704'], + 'CampaignId' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'example' => '083046e3-5822-4cda-9b84-04f2a02eb605'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'QueueId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Caller' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '05711234****'], + 'Callee' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1888888****'], + 'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'DialTime' => ['description' => '发起拨号的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196283974'], + 'DialDuration' => ['description' => '拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2734'], + 'CustomerEstablishedTime' => ['description' => '客户接通的时刻，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196286708'], + 'CustomerReleasedTime' => ['description' => '客户挂机时刻，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196317888'], + 'EnterIvrTime' => ['description' => '转接进入IVR时刻，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196286740'], + 'IvrDuration' => ['description' => 'IVR中时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1049'], + 'EnqueueTime' => ['description' => '进入队列时刻，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196287789'], + 'QueueDuration' => ['description' => '排队时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '80'], + 'AssignAgentTime' => ['description' => '分配坐席时刻，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196287869'], + 'AgentRingDuration' => ['description' => '坐席振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '23'], + 'AgentEstablishedTime' => ['description' => '坐席接听时刻，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1632883592732'], ], ], ], @@ -20798,44 +11997,21 @@ ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.Number', - 'errorMessage' => 'The specified number %s does not exist in instance %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 'title' => '获取联系人拨打记录列表', + 'summary' => '调用ListAttempts获取指定实例下指定预测式外呼活动的联系人拨打记录列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAttempts'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"[]\\",\\n \\"Timestamp\\": 1609225718295,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-6570007401392****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8001****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"ONLINE\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\n无\\n200\\n无\\n\\n \\n ccc-test\\n OUTBOUND\\n job-65700074013925376\\n \\n 8001****\\n NONE\\n 无\\n 1318888****\\n []\\n 无\\n user-test@ccc-test\\n 8001****\\n OUTBOUND\\n 无\\n ch:user:131888****->8001****:1609225718294:job-65700074013925376\\n 1609225718295\\n job-65700074013925376\\n \\n \\n \\n 8001****\\n 无\\n READY\\n ccc-test\\n Warm-up\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c\\n 1609136956378\\n false\\n 86-1324730****\\n job-65700074013925376\\n ON_SITE\\n 1609136956378\\n [\\"skill-group@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', - 'title' => '发起预测式外呼', - 'summary' => '调用StartPredictiveCall发起预测式外呼。', - 'description' => '云呼叫中心除了支持客服从坐席工作台发起外呼外，还支持从自有业务系统后台发起外呼，待接通后转给坐席。以支持把云呼叫中心功能无缝嵌入您的业务流程。'."\n" - .'比如，您的客户可以在您的微信公众号上，输入自己的号码，并点击咨询产品的按钮，由您的后台系统调用本接口，实现呼叫客户手机，接通后播放“我们收到您在公众号上对我们产品的咨询，现在给您转接顾问，请稍等”，并转给合适的客服接听通话。'."\n" - .'相较于1.0的DialEX接口，用户使用该接口可以更加灵活的进行配置。除了可以自定义外呼转入的IVR外，还可以传入自定义的参数，在IVR中对参数进行语音播报，实现通知的场景。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"List\\": [\\n {\\n \\"AttemptId\\": \\"job-1704342174816****\\",\\n \\"ContactId\\": \\"job-1704342174816****\\",\\n \\"CaseId\\": \\"21d194a7-60b7-4824-932b-48ed03a83704\\",\\n \\"CampaignId\\": \\"083046e3-5822-4cda-9b84-04f2a02eb605\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"Caller\\": \\"05711234****\\",\\n \\"Callee\\": \\"1888888****\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"DialTime\\": 1634196283974,\\n \\"DialDuration\\": 2734,\\n \\"CustomerEstablishedTime\\": 1634196286708,\\n \\"CustomerReleasedTime\\": 1634196317888,\\n \\"EnterIvrTime\\": 1634196286740,\\n \\"IvrDuration\\": 1049,\\n \\"EnqueueTime\\": 1634196287789,\\n \\"QueueDuration\\": 80,\\n \\"AssignAgentTime\\": 1634196287869,\\n \\"AgentRingDuration\\": 23,\\n \\"AgentEstablishedTime\\": 1632883592732\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'StartPrivacyCall' => [ - 'summary' => '发起隐私呼叫。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListAudioFiles' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20844,52 +12020,42 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccKYIENB'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'AppId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '应用ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ALIPUBB7A727C170949', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'Caller', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0109810****', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'Callee', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1888888****', - ], + 'schema' => ['description' => 'Converting（转换中） '."\n" + .'Completed（转换完成） '."\n" + .'Failed（转换失败） '."\n" + .'参数不传，查询所有状态。', 'type' => 'string', 'required' => false, 'example' => 'Completed'], + ], + [ + 'name' => 'Usage', + 'in' => 'query', + 'schema' => ['description' => '音频文件用途，默认为General（用于IVR等场景）， 其他可选值为HoldMusic（通话保持等待音）。', 'type' => 'string', 'required' => false, 'example' => 'General'], ], ], 'responses' => [ @@ -20897,83 +12063,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3', - ], - 'Params' => [ - 'description' => '参数信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '53223330-EBF1-586B-A2CB-93C3B711FDA0'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Data' => [ - 'description' => '返回结果，通话ID。', - 'type' => 'string', - 'example' => 'job-xxx', + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'List' => [ + 'description' => '音频文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '音频文件信息。', + 'type' => 'object', + 'properties' => [ + 'AudioFileName' => ['description' => '音频文件名称。', 'type' => 'string', 'example' => 'test-file.wav'], + 'OssFileKey' => ['description' => '音频资源文件在OSS中的Key。', 'type' => 'string', 'example' => 'ccc-test/test-file.wav'], + 'UpdatedTime' => ['description' => '音频资源的最后修改时间。', 'type' => 'string', 'example' => '2021-03-08 15:34:49.0'], + 'AudioResourceId' => ['description' => '音频资源ID，音频文件的唯一标识。', 'type' => 'string', 'example' => 'd5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Name' => ['description' => '音频资源的展示名。', 'type' => 'string', 'example' => '欢迎语'], + 'CreatedTime' => ['description' => '音频资源的创建时间。', 'type' => 'string', 'example' => '2021-03-05 17:35:45.0'], + 'Status' => ['description' => '音频文件状态。', 'type' => 'string', 'example' => 'Completed'], + 'Usage' => ['description' => '音频文件用途，默认为General（用于IVR等场景）， 其他可选值为HoldMusic（通话保持等待音）。', 'type' => 'string', 'example' => 'General'], + 'AuditResult' => ['description' => '音频内容风险审核结果。', 'type' => 'string', 'example' => '无'], + ], + ], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.Number', - 'errorMessage' => 'The specified number %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred.', - ], + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0630E5DF-CEB0-445B-8626-D5C7481181C3\\",\\n \\"Params\\": [\\n \\"\\"\\n ],\\n \\"Data\\": \\"job-xxx\\"\\n}","type":"json"}]', - 'title' => '发起隐私呼叫', - ], - 'SwitchToConference' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '获取音频文件列表', + 'summary' => '调用ListAudioFiles获取指定实例下的音频文件列表。', + 'changeSet' => [ + ['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-06-30T02:20:46.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAudioFiles'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"53223330-EBF1-586B-A2CB-93C3B711FDA0\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"AudioFileName\\": \\"test-file.wav\\",\\n \\"OssFileKey\\": \\"ccc-test/test-file.wav\\",\\n \\"UpdatedTime\\": \\"2021-03-08 15:34:49.0\\",\\n \\"AudioResourceId\\": \\"d5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"欢迎语\\",\\n \\"CreatedTime\\": \\"2021-03-05 17:35:45.0\\",\\n \\"Status\\": \\"Completed\\",\\n \\"Usage\\": \\"General\\",\\n \\"AuditResult\\": \\"无\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListBlacklistCallTaggings' => [ + 'summary' => '批量查询指定号码黑名单打标状态。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20982,339 +12140,47 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID，不填默认使用当前RAM账号映射的坐席。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], - ], - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '无效字段，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + 'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'JobId', + 'name' => 'NumberList', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-24114064019637****', - ], + 'schema' => ['description' => '待查询黑名单打标状态的号码列表，号码为加密号码（带有***），需要带jobId字段，反之不需要。', 'type' => 'string', 'required' => true, 'example' => '[{"number":"1521083xxxx","jobId":"job-481841171213393920"}]'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9C96A73-09C9-5E2A-8CDB-85EC0BC246DA', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '032C73C4-3A6F-4502-872B-4F5B41161C6E'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Data' => [ 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'NONE', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '8001****', - ], - 'SkillGroupId' => [ - 'description' => '该通话相关技能组。呼入场景下，技能组由IVR中路由的排队队列指定。在呼出场景下，技能组是座席签入的第一个技能组。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => 'MONITORING', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609255716900', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:131888****->8001****:1609225718294:job-6538214103685****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '1318888****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'agent@ccc-test', - ], - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => '1609136956378', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DeviceState' => [ - 'description' => '设备状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'UNREGISTERED' => '未注册', - 'ONLINE' => '在线', - 'OFFLINE' => '离线', - ], - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test'."\n", - ], - ], - ], + 'type' => 'array', + 'items' => [ + 'description' => '号码黑名单打标信息。', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-481841171213393920'], + 'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '1521083xxxx'], + 'Blacklisted' => ['description' => '是否有黑名单打标。', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -21324,53 +12190,30 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'LimitExceed.CallTagsPerNumber', 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', 'description' => '号码标签数量超出单个呼入号码标记的上线阈值。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.ChannelId', - 'errorMessage' => 'The specified channel %s does not exist in call %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.CustomCallTagging', 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', 'description' => '呼入号码标记不存在。'], ], 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"D9C96A73-09C9-5E2A-8CDB-85EC0BC246DA\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609255716900,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-6538214103685****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Heartbeat\\": 0,\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"1609136956378\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"false\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\\\n\\"\\n ]\\n }\\n }\\n}","type":"json"}]', - 'title' => '转会议', - 'summary' => '调用SwitchToConference将指定实例下的指定通话的状态切换至三方会议，通常用于咨询转会议的场景。', - ], - 'TakeBreak' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '获取号码黑名单打标状态', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"032C73C4-3A6F-4502-872B-4F5B41161C6E\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"JobId\\": \\"job-481841171213393920\\",\\n \\"Number\\": \\"1521083xxxx\\",\\n \\"Blacklisted\\": true\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListBriefSkillGroups' => [ + 'summary' => '调用ListBriefSkillGroups获取指定实例下的技能组概要信息列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -21379,53 +12222,39 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserId', + 'name' => 'SearchPattern', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID，不填默认使用当前RAM账户映射的坐席。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '根据技能组名称或技能组展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'skillgroup'], ], [ - 'name' => 'DeviceId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'device', - ], + 'schema' => ['description' => '分页序号，范围1-100。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'Code', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '小休状态码，客户可以自定义任何小休状态。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'lunchtime', - ], + 'schema' => ['description' => '分页大小，范围1-100。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括CHAT和 VIDEO。', 'type' => 'string', 'required' => false, 'example' => 'CHAT'], ], ], 'responses' => [ @@ -21433,174 +12262,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => 'B59382D2-5755-4C6D-861F-FA2AAD8F89F7', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => '3969FC68-CEC2-4398-B76A-60D2F7EDEBAF'], 'Data' => [ - 'description' => '数据。'."\n", + 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609249563836', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609234221864', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '席上线后置闲前的临时小休状态', - ], - 'example' => 'lunchtime', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1390000****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => '无', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'BREAK', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'List' => [ + 'description' => '技能组概要信息列表。'."\n", 'type' => 'array', 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', + 'description' => '技能组', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '技能组展示名。', 'type' => 'string', 'example' => '测试技能组'], + 'Description' => ['description' => '技能组的描述。', 'type' => 'string', 'example' => '云联络中心的测试技能组。'], + 'PhoneNumberCount' => ['description' => '技能组关联的号码数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'], + 'UserCount' => ['description' => '技能组关联的坐席数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'MediaType' => ['description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', 'type' => 'string', 'example' => 'VIDEO'], + ], ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B59382D2-5755-4C6D-861F-FA2AAD8F89F7\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609249563836,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609234221864,\\n \\"BreakCode\\": \\"lunchtime\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"B59382D2-5755-4C6D-861F-FA2AAD8F89F7\\n无\\n200\\n无\\n\\n 8001****\\n BREAK\\n ccc-test\\n default\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bs3b5f22c6d78f000176aebe9471\\n 1609249563836\\n false\\n 1390000****\\n 无\\n ON_SITE\\n 1609234221864\\n [\\"skill-group@ccc-test\\"]\\n\\nOK","errorExample":""}]', - 'title' => '小休', - 'summary' => '调用TakeBreak将指定实例下的指定坐席设置为小休状态。', + 'title' => '获取技能组概要列表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UnmuteCall' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBriefSkillGroups'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"3969FC68-CEC2-4398-B76A-60D2F7EDEBAF\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"UserCount\\": 10,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"3969FC68-CEC2-4398-B76A-60D2F7EDEBAF\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n 测试技能组\\n 测试技能组\\n 1\\n ccc-test\\n 1\\n 测试技能组\\n test@ccc-test\\n \\n\\nOK","errorExample":""}]', + ], + 'ListCallDetailRecords' => [ + 'summary' => '调用ListCallDetailRecords获取指定实例下指定搜索条件过滤后的通话详情列表。接口不再迭代更新，建议优先使用ListCallDetailRecordsV2接口。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -21609,61 +12336,172 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], + ], 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '获取的历史数据的起始时间，默认为当天的0时，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '获取的历史数据的终止时间，默认为当前时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000'], + ], + [ + 'name' => 'ContactType', + 'in' => 'query', + 'schema' => [ + 'description' => '按通话类型过滤。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Outbound' => '呼出', 'Back2Back' => '双呼', 'PrivacyDial' => '加密通话', 'Internal' => '内部呼叫', 'Predictive' => '预测式外呼', 'Inbound' => '呼入', 'Conference' => '会议'], + 'example' => 'Outbound', + ], + ], + [ + 'name' => 'ContactDisposition', + 'in' => 'query', + 'schema' => [ + 'description' => '按挂断类型过滤，注意：语音邮箱、转人工失败、排队超时、排队溢出、IVR异常的挂断原因需要客户配置挂断原因节点才能体现出来，如果没有配置且IVR中无转人工模块，这时候的挂断原因默认为IVR放弃。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AbandonedInQueue' => '排队放弃', 'NoAnswer' => '客户未接', 'QueuingTimeout' => '排队超时', 'Voicemail' => '转语音邮箱', 'QueuingFailed' => '转人工失败', 'QueuingOverflow' => '排队溢出', 'AbandonedInVoiceNavigator' => '智能导航中放弃', 'Success' => '正常结束', 'IVRException' => 'IVR异常', 'AbandonedInRing' => '振铃放弃', + 'AbandonedInIVR' => 'IVR放弃', 'Reject' => '客户拒接', 'ForwardToOutsideNumber' => '转外线', + ], + 'example' => 'Success', + ], + ], + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => ['description' => '通过指定的contactId来查询某一通电话的记录，contactId可以通过软电话SDK发生通话时获取到。如果传入该参数，则自动忽略其他查询参数。', 'type' => 'string', 'required' => false, 'example' => 'job-12515239414412****'], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => ['description' => '按坐席ID过滤。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'query', + 'schema' => ['description' => '按技能组ID过滤。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test'], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方式，非必填，默认为降序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['ASC' => '升序', 'DESC' => '降序'], + 'example' => 'DESC', + ], + ], [ 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'OrderByField', + 'in' => 'query', 'schema' => [ - 'description' => '实例ID。', + 'description' => '排序字段，非必填，默认为startTime（通话开始时间）。'."\n", 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', + 'required' => false, + 'enumValueTitles' => ['callDuration' => '通话时长', 'ringTime' => '响铃时长', 'talkTime' => '通话时长', 'dialingTime' => '拨号时长', 'startTime' => '通话开始时间', 'ivrTime' => 'IVR时长', 'queueTime' => '排队时长'], + 'example' => 'startTime', ], ], [ - 'name' => 'UserId', + 'name' => 'Criteria', + 'in' => 'query', + 'schema' => ['description' => '根据主叫或被叫号码模糊查询，格式为JSON字符串，仅包含一个字段phoneNumber，填主叫或被叫号码的全部或者一部分。', 'type' => 'string', 'required' => false, 'example' => '{"phoneNumber":"0735"}'], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'schema' => ['description' => '按主叫号码过滤。', 'type' => 'string', 'required' => false, 'example' => '07353988****'], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => '按被叫号码过滤。', 'type' => 'string', 'required' => false, 'example' => '1320523****'], + ], + [ + 'name' => 'SatisfactionList', + 'in' => 'query', + 'schema' => ['description' => '按满意度列表过滤，多个满意度结果使用英文逗号隔开。', 'type' => 'string', 'required' => false, 'example' => '["1","3"]'], + ], + [ + 'name' => 'SatisfactionSurveyChannel', 'in' => 'query', 'schema' => [ - 'description' => '需要取消静音的坐席ID，不填默认使用当前RAM账户映射的坐席。', + 'description' => '按满意度调查渠道过滤。', 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'agent@ccc-test', + 'enumValueTitles' => ['IVR' => '语音满意度', 'SMS' => '短信满意度'], + 'example' => 'IVR', ], ], [ - 'name' => 'DeviceId', + 'name' => 'SatisfactionDescriptionList', + 'in' => 'query', + 'schema' => ['description' => '按满意度描述列表过滤，描述内容由客户自定义。', 'type' => 'string', 'required' => false, 'example' => '["满意","一般"]'], + ], + [ + 'name' => 'EarlyMediaStateList', 'in' => 'query', 'schema' => [ - 'description' => '设备ID，无意义，可以随便填写。', + 'description' => '按未接通原因列表过滤。', 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'device', + 'enumValueTitles' => ['NoAnswer' => '无人接听', 'OutOfService' => '停机', 'NotExist' => '空号', 'Restricted' => '呼叫受限', 'Busy' => '占线', 'NotConnected' => '无法接通', 'PowerOff' => '关机'], + 'example' => '["NotConnected","NoAnswer"]', ], ], [ - 'name' => 'JobId', + 'name' => 'ContactDispositionList', 'in' => 'query', 'schema' => [ - 'description' => '通话ID。', + 'description' => '按挂断原因列表过滤。', 'type' => 'string', 'required' => false, - 'example' => 'job-6538214103685****'."\n", + 'enumValueTitles' => [ + 'AbandonedInQueue' => '排队放弃', 'NoAnswer' => '客户未接', 'QueuingTimeout' => '排队超时', 'Voicemail' => '转语音邮箱', 'QueuingFailed' => '转人工失败', 'QueuingOverflow' => '排队溢出', 'AbandonedInVoiceNavigator' => '智能导航中放弃', 'Success' => '正常结束', 'IVRException' => 'IVR异常', 'AbandonedInRing' => '振铃放弃', + 'AbandonedInIVR' => 'IVR放弃', 'Reject' => '客户拒接', 'ForwardToOutsideNumber' => '转外线', + ], + 'example' => '["Success","NoAnswer"]', ], ], [ - 'name' => 'ChannelId', + 'name' => 'ContactTypeList', 'in' => 'query', 'schema' => [ - 'description' => '待取消静音的话务通道ID，非必填，默认为空，为空表示取消静音UserId对应的坐席的话务通道。', + 'description' => '按通话类型列表过滤。', 'type' => 'string', 'required' => false, - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****', + 'enumValueTitles' => ['Outbound' => '呼出', 'Back2Back' => '双呼', 'PrivacyDial' => '加密通话', 'Internal' => '内部呼叫', 'Predictive' => '预测式外呼', 'Inbound' => '呼入', 'Conference' => '会议'], + 'example' => '["Internal","Inbound"]', ], ], ], @@ -21672,840 +12510,731 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'CallContext' => [ - 'description' => '话务上下文环境。', - 'type' => 'object', - 'properties' => [ - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelContexts' => [ - 'description' => '话务通道列表。', - 'type' => 'array', - 'items' => [ - 'description' => '话务通道。', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ReleaseInitiator' => [ - 'description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'ChannelState' => [ - 'description' => '话务通道的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CREATED' => '已创建', - 'ANSWERED' => '已接通', - 'RELEASED' => '已挂断', - 'RETIRED' => '已失效', - 'EARLY_MEDIA' => '早媒体阶段', - 'NONE' => '初始状态', - 'RINGING' => '振铃中', - ], - 'example' => 'CREATED', - ], - 'Destination' => [ - 'description' => '话务通道的被叫方。', - 'type' => 'string', - 'example' => '1390501****', - ], - 'UserId' => [ - 'description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ChannelFlags' => [ - 'description' => '话务通道标志。', - 'type' => 'string', - 'enumValueTitles' => [ - 'COACHING' => '辅导中', - 'MONITORING' => '监听中', - 'MONITORED' => '被监听', - 'COACHED' => '被辅导', - 'HOLD' => '保持', - 'MUTED' => '静音', - ], - 'example' => 'MONITORING', - ], - 'SkillGroupId' => [ - 'description' => '该通话相关技能组。呼入场景下，技能组由IVR中路由的排队队列指定。在呼出场景下，技能组是座席签入的第一个技能组。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Timestamp' => [ - 'description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609138903315', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '404 - No destination', - ], - 'CallType' => [ - 'description' => '话务通道的通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'BARGE' => '强插', - 'CONSULTANT' => '咨询', - 'CONFERENCE' => '会议', - 'MONITOR' => '监听', - 'INTERNAL' => '内部通话', - 'OUTBOUND' => '呼出', - 'INTERCEPT' => '强拆', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - 'COACH' => '辅导', - ], - 'example' => 'OUTBOUND', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****', - ], - 'UserExtension' => [ - 'description' => '话务通道关联的坐席的分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'Originator' => [ - 'description' => '话务通道的主叫方。', - 'type' => 'string', - 'example' => '0830019****', - ], - ], - ], - ], - ], - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'Extension' => [ - 'description' => '座席分机号。', - 'type' => 'string', - 'example' => '8032****', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1324730****', - ], - 'DeviceId' => [ - 'description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', - 'type' => 'string', - 'example' => 'ACC-YUNBS-1.0.10-****', - ], - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-6538214103685****', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'BreakCode' => [ - 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'UserState' => [ - 'description' => '座席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'READY' => '空闲', - 'WORKING' => '话后处理中', - 'DIALING' => '拨号中', - 'BREAK' => '小休', - 'OFFLINE' => '离线', - 'TALKING' => '通话中', - 'RINGING' => '振铃中', - ], - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数，只有PageNumber为1才会返回真实数值，其他都是0。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'], + 'List' => [ + 'description' => '通话记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通话记录。', + 'type' => 'object', + 'properties' => [ + 'ContactDisposition' => [ + 'description' => '通话结束原因。', + 'type' => 'string', + 'enumValueTitles' => [ + 'AbandonedInQueue' => '排队放弃', 'NoAnswer' => '客户未接', 'QueuingTimeout' => '排队超时', 'Voicemail' => '转语音邮箱', 'QueuingFailed' => '转人工失败', 'QueuingOverflow' => '排队溢出', 'AbandonedInVoiceNavigator' => '智能导航中放弃', 'Success' => '正常结束', 'IVRException' => 'IVR异常', 'AbandonedInRing' => '振铃放弃', + 'AbandonedInIVR' => 'IVR放弃', 'Reject' => '客户拒接', 'ForwardToOutsideNumber' => '转外线', + ], + 'example' => 'Success', ], + 'ContactType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => ['Outbound' => '呼出', 'Back2Back' => '双呼', 'PrivacyDial' => '加密通话', 'Internal' => '内部呼叫', 'Predictive' => '预测式外呼', 'Inbound' => '呼入', 'Conference' => '会议'], + 'example' => 'Outbound', + ], + 'EstablishedTime' => ['description' => '通话建立的时间，如果通话没有建立，此值为空，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000'], + 'CalledNumber' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1332315****'], + 'AdditionalBroker' => ['description' => '附加中间号码，双呼场景下可能用到。', 'type' => 'string', 'example' => '0533128****'], + 'SatisfactionIndex' => ['description' => '满意度，即满意度按键数字（1位数字）的值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'SatisfactionSurveyChannel' => [ + 'description' => '满意度调查渠道。', + 'type' => 'string', + 'enumValueTitles' => ['IVR' => '语音满意度', 'SMS' => '短信满意度'], + 'example' => 'IVR', + ], + 'ReleaseTime' => ['description' => '通话结束时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532707199000'], + 'WaitTime' => ['description' => '客户等待时长，即QueueTime+RingTime，若客户等待期间放弃，则为0，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'SkillGroupNames' => ['description' => '参与通话的座席所属的技能组名称，多个技能组以英文逗号分隔。', 'type' => 'string', 'example' => '测试技能组'], + 'IvrTime' => ['description' => 'IVR时长，即从开始进入IVR到开始进入转人工队列（或客户放弃）之间的时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], + 'SatisfactionDescription' => ['description' => '满意度描述，对应于满意度IVR中满意度模块的配置，客户自行定义。', 'type' => 'string', 'example' => '满意'], + 'ReleaseInitiator' => [ + 'description' => '挂断方。', + 'type' => 'string', + 'enumValueTitles' => ['agent' => '坐席', 'customer' => '客户'], + 'example' => 'customer', + ], + 'AgentIds' => ['description' => '坐席ID列表，多个值用逗号分隔。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'CallDuration' => ['description' => '通话时长，呼入从通话进入IVR开始计时，呼出从接通开始计时，单位秒。', 'type' => 'string', 'example' => '30'], + 'RecordingReady' => ['description' => '录音是否已经生成，若通话没有建立，则返回false。', 'type' => 'boolean', 'example' => 'true'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'RingTime' => ['description' => '振铃时长，即从坐席振铃到坐席接起（或客户放弃）之间的时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'SatisfactionSurveyOffered' => ['description' => '是否发起了满意度调查。', 'type' => 'boolean', 'example' => 'true'], + 'AgentNames' => ['description' => '通话涉及到的坐席名称列表，多个坐席之间使用英文逗号隔开。', 'type' => 'string', 'example' => '坐席小王'], + 'StartTime' => ['description' => '通话开始时间，内呼从进入IVR开始，外呼从拨号开始计算，格式为Unix字符串，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000'], + 'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-12515239414412****'], + 'RecordingDuration' => ['description' => '录音时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'CallingNumber' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '0533128****'], + 'QueueTime' => ['description' => '排队时长，即从开始进入转人工队列到坐席开始振铃（或客户放弃，队列超时，队列溢出）之间的时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Broker' => ['description' => '中间号码。', 'type' => 'string', 'example' => '0533127****'], + 'SkillGroupIds' => ['description' => '参与通话的座席所属的技能组ID，多个技能组以逗号分隔。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'CallerLocation' => ['description' => '主叫归属地。', 'type' => 'string', 'example' => '北京市-北京'], + 'CalleeLocation' => ['description' => '被叫归属地。', 'type' => 'string', 'example' => '山东省-济南'], + 'EarlyMediaState' => [ + 'description' => '未接通原因。', + 'type' => 'string', + 'enumValueTitles' => ['NoAnswer' => '无人接听', 'OutOfService' => '停机', 'NotExist' => '空号', 'Restricted' => '呼叫受限', 'Busy' => '占线', 'NotConnected' => '无法接通', 'PowerOff' => '关机'], + 'example' => 'NotConnected', + ], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '486:USER_BUSY'], + 'DialingTime' => ['description' => '拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TalkTime' => ['description' => '通话时间，单位为秒', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HeldTime' => ['description' => '保持时间，单位为秒', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'CallIds' => ['description' => '通信底层SIP协议中Call-Id字段，如果需要获取号码提供商侧的通话ID可以从这个字段获取。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'."\n"], ], ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'InvalidOperation.ChannelState', - 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', - ], - [ - 'errorCode' => 'InvalidOperation.UserState', - 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.ChannelId', - 'errorMessage' => 'The specified channel %s does not exist in call %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'], ], 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred. %s', - ], + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-6538214103685****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Heartbeat\\": 1609136956378,\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n 80326034\\n BREAK\\n ccc-test\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n 1609136956378\\n false\\n 86-132xxxx4730\\n ON_SITE\\n job-65382141036853491\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 1\\n skg-default@ccc-test\\n \\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '取消通话静音', - 'summary' => '调用UnmuteCall取消通话静音。', + 'title' => '获取通话详情列表', + 'description' => '为了保证查询效率，返回数据中的TotalCount字段，只会在查询第一页时赋值，查询其他页时返回0。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyCampaignNumbers' => [ - 'summary' => '修改批量预测式外呼活动的主叫号码。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-07-29T10:25:36.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-10-09T15:22:40.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-03-20T06:35:11.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-12-07T10:56:27.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-10-14T06:47:33.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-09-08T02:42:38.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallDetailRecords'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"Outbound\\",\\n \\"EstablishedTime\\": 1532448000000,\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"AdditionalBroker\\": \\"0533128****\\",\\n \\"SatisfactionIndex\\": 1,\\n \\"SatisfactionSurveyChannel\\": \\"IVR\\",\\n \\"ReleaseTime\\": 1532707199000,\\n \\"WaitTime\\": 5,\\n \\"SkillGroupNames\\": \\"测试技能组\\",\\n \\"IvrTime\\": 8,\\n \\"SatisfactionDescription\\": \\"满意\\",\\n \\"ReleaseInitiator\\": \\"customer\\",\\n \\"AgentIds\\": \\"agent@ccc-test\\",\\n \\"CallDuration\\": \\"30\\",\\n \\"RecordingReady\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RingTime\\": 5,\\n \\"SatisfactionSurveyOffered\\": true,\\n \\"AgentNames\\": \\"坐席小王\\",\\n \\"StartTime\\": 1532448000000,\\n \\"ContactId\\": \\"job-12515239414412****\\",\\n \\"RecordingDuration\\": 10,\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"QueueTime\\": 0,\\n \\"Broker\\": \\"0533127****\\",\\n \\"SkillGroupIds\\": \\"skillgroup@ccc-test\\",\\n \\"CallerLocation\\": \\"北京市-北京\\",\\n \\"CalleeLocation\\": \\"山东省-济南\\",\\n \\"EarlyMediaState\\": \\"NotConnected\\",\\n \\"ReleaseReason\\": \\"486:USER_BUSY\\",\\n \\"DialingTime\\": 0,\\n \\"TalkTime\\": 0,\\n \\"HeldTime\\": 12,\\n \\"CallIds\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\\\n\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 11\\n 10\\n 1\\n \\n 8\\n 133xxxx2315\\n Outbound\\n Success\\n 1\\n job-125152394144124921\\n 053xxxx3128\\n true\\n 默认技能组\\n true\\n 0\\n 1532448000000\\n skg-default@ccc-test\\n 053xxxx3127\\n ccc-test\\n agent\\n NotConnected\\n 1532448000000\\n 5\\n 30\\n 北京\\n 1532707199000\\n IVR\\n user-test@ccc-test\\n 满意\\n 053xxxx3128\\n 北京\\n 5\\n 云呼测试坐席\\n 10\\n \\n\\nOK","errorExample":""}]', + ], + 'ListCallDetailRecordsV2' => [ + 'summary' => '获取指定实例下指定搜索条件过滤后的通话详情列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccQFUGXR', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], ], 'parameters' => [ [ - 'name' => 'CampaignId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '活动ID', - 'description' => '活动ID。', - 'type' => 'string', - 'required' => true, - 'example' => '6badb397-****-****-21019d382a09', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'InstGroupId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '号码集合ID', - 'description' => '号码集合ID。', - 'type' => 'string', - 'required' => false, - 'example' => '3971876649-****-****-098763a382a09'."\n", - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100'], ], [ - 'name' => 'NumberList', + 'name' => 'StartTime', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表。', - 'type' => 'array', - 'items' => [ - 'description' => '号码。', - 'type' => 'string', - 'required' => false, - 'example' => '["0830011xxxx", "0830312xxxx"]', - ], - 'required' => false, - ], + 'schema' => ['description' => '获取的历史数据的起始时间，默认为当天的 0 时，格式为 Unix 时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1657853640015'], ], [ - 'name' => 'InstanceId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ModifyCampaignNumbersResponse', - 'description' => 'ModifyCampaignNumbersResponse', - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'any', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '修改预测式外呼活动主叫号码', - ], - 'AbortCampaign' => [ - 'summary' => '调用AbortCampaign终止指定实例下指定活动ID对应的预测式外呼活动。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'schema' => ['description' => '获取的历史数据的终止时间，默认为当前时间，格式为 Unix 时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1657879880010'], ], [ - 'BearerToken' => [], + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => ['description' => '排序方式，默认为降序。'."\n" + ."\n" + .'枚举值：'."\n" + ."\n" + .'ASC：升序。'."\n" + ."\n" + .'DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], ], - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'CampaignId', + 'name' => 'OrderByField', 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'required' => true, - 'example' => '6badb397-a8b5-40b6-21019d382a09', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '响应参数。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315', - ], - 'Code' => [ - 'title' => 'code', - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'message', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'HttpStatusCode' => [ - 'title' => 'httpStatusCode', - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], - ], - ], + 'schema' => ['description' => '排序字段，非必填，默认为 startTime（通话开始时间）。'."\n" + ."\n" + .'枚举值：'."\n" + ."\n" + .'startTime：通话开始时间。', 'type' => 'string', 'required' => false, 'example' => 'startTime'], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\n OK\\n 无\\n 200\\n","errorExample":""}]', - 'title' => '终止预测式外呼活动', - ], - 'AddCases' => [ - 'summary' => '调用AddCases添加外呼名单到指定实例下指定ID对应的预测式外呼活动。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'SearchPattern', + 'in' => 'query', + 'schema' => ['description' => '自定义查询文本，遵循Lucene查询语法。'."\n" + ."\n" + .'支持查询字段和查询类型列表：'."\n" + ."\n" + .'accessChannelUserId: 访客ID，支持精准查询和模糊查询。'."\n" + ."\n" + .'accessChannelName: 渠道名称，支持精准查询和模糊查询。'."\n" + ."\n" + .'text: 会话文本，支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'text:请稍后 AND accessChannelUserId:af1a0-afaa-5086e2946e0b* AND accessChannelName:专属开发渠道*'], ], [ - 'BearerToken' => [], + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => '媒体类型。'."\n" + ."\n" + .'枚举值：'."\n" + ."\n" + .'AUDIO：语音。'."\n" + ."\n" + .'VIDEO：视频。'."\n" + ."\n" + .'CHAT: 消息。'."\n" + ."\n" + .'ALL: 所有。', 'type' => 'string', 'required' => false, 'example' => 'AUDIO'], ], - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ContactIdList', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '通话ID列表。', 'type' => 'string', 'required' => false, 'example' => '["job-123456789","job-234567891"]'], ], [ - 'name' => 'CampaignId', + 'name' => 'ContactTypeList', 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'c58b9719-3bc3-441d-a4d3-fc0309ef7066'."\n", - ], + 'schema' => ['description' => '按通话类型列表过滤。'."\n" + ."\n" + .'枚举值：'."\n" + ."\n" + .'OUTBOUND：呼出。'."\n" + ."\n" + .'BACK2BACK：双呼。'."\n" + ."\n" + .'PRIVACY_DIAL：加密通话。'."\n" + ."\n" + .'INTERNAL：内部呼叫。'."\n" + ."\n" + .'PREDICTIVE：预测式外呼。'."\n" + ."\n" + .'INBOUND：呼入。'."\n" + ."\n" + .'CONFERENCE：会议。', 'type' => 'string', 'required' => false, 'example' => '["INBOUND","OUTBOUND"]'], ], [ - 'name' => 'CaseList', + 'name' => 'ContactDispositionList', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '外呼名单列表。', - 'type' => 'array', - 'items' => [ - 'description' => '外呼名单。', - 'type' => 'object', - 'properties' => [ - 'ReferenceId' => [ - 'description' => '业务ID，客户业务系统标识，用于集成场景。'."\n" - ."\n", - 'type' => 'string', - 'required' => false, - 'example' => '01', - ], - 'PhoneNumber' => [ - 'description' => '联系人电话号码。', - 'type' => 'string', - 'required' => false, - 'example' => '188888****', - ], - 'CustomVariables' => [ - 'description' => '客户自定义变量，格式为JSON对象，对象最多包含10个属性，每个属性的名称和值均由客户自定义。', - 'type' => 'string', - 'required' => false, - 'example' => '{"name":"customer","客户标签":"tag"}'."\n", - ], - 'MaskedCallee' => [ - 'description' => '脱敏后的被叫号码，如果该字段不为空，表示需要对被叫号码脱敏，脱敏规则由客户自行定义，只需将脱敏后的被叫号码填入即可，使用脱敏被叫会导致某些场景下看到的是脱敏后的被叫号码，无法查看真实被叫号码。', - 'type' => 'string', - 'required' => false, - 'example' => '166******66', - ], - 'Caller' => [ - 'description' => '主叫号码，该字段指定号码后，对应联系人将会使用对应的号码进行外呼，不再随机选择号码。', - 'type' => 'string', - 'required' => false, - 'example' => '185022xxxx', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => '按挂断原因列表过滤。'."\n" + ."\n" + .'枚举值：'."\n" + ."\n" + .'AbandonedInQueue：排队放弃。'."\n" + ."\n" + .'NoAnswer：客户未接。'."\n" + ."\n" + .'QueuingTimeout：排队超时。'."\n" + ."\n" + .'Voicemail：转语音邮箱。'."\n" + ."\n" + .'QueuingFailed：转人工失败。'."\n" + ."\n" + .'QueuingOverflow：排队溢出。'."\n" + ."\n" + .'AbandonedInVoiceNavigator：智能导航中放弃。'."\n" + ."\n" + .'Success：正常结束。'."\n" + ."\n" + .'IVRException：IVR异常。'."\n" + ."\n" + .'AbandonedInRing：振铃放弃。'."\n" + ."\n" + .'AbandonedInIVR：IVR放弃。'."\n" + ."\n" + .'Reject：客户拒接。'."\n" + ."\n" + .'ForwardToOutsideNumber：转外线。', 'type' => 'string', 'required' => false, 'example' => '["Success","NoAnswer"]'], + ], + [ + 'name' => 'EarlyMediaStateList', + 'in' => 'query', + 'schema' => ['description' => '按未接通原因列表过滤。'."\n" + ."\n" + .'枚举值：'."\n" + ."\n" + .'NoAnswer：无人接听。'."\n" + ."\n" + .'OutOfService：停机。'."\n" + ."\n" + .'NotExist：空号。'."\n" + ."\n" + .'Restricted：呼叫受限。'."\n" + ."\n" + .'Busy：占线。'."\n" + ."\n" + .'NotConnected：无法接通。'."\n" + ."\n" + .'PowerOff：关机。', 'type' => 'string', 'required' => false, 'example' => '["NotConnected","NoAnswer"]'], + ], + [ + 'name' => 'SatisfactionSurveyChannel', + 'in' => 'query', + 'schema' => ['description' => '满意度调查渠道。'."\n" + ."\n" + .'枚举值：'."\n" + ."\n" + .'IVR：语音满意度。'."\n" + ."\n" + .'SMS：短信满意度。'."\n" + ."\n" + .'CHAT: 消息满意度。', 'type' => 'string', 'required' => false, 'example' => 'IVR'], + ], + [ + 'name' => 'SatisfactionRateList', + 'in' => 'query', + 'schema' => ['description' => '按满意度列表过滤，多个满意度结果使用英文逗号隔开。'."\n" + ."\n" + .'枚举值：'."\n" + ."\n" + .'-2：未发送。'."\n" + ."\n" + .'-1：未评价。'."\n" + ."\n" + .'其他正数：自定义满意度评价数值。', 'type' => 'string', 'required' => false, 'example' => '["-1","3"]'."\n" + .'[">2"]'."\n" + .'["<3"]'], + ], + [ + 'name' => 'SatisfactionDescriptionList', + 'in' => 'query', + 'schema' => ['description' => '按满意度描述列表过滤，描述内容由客户自定义。', 'type' => 'string', 'required' => false, 'example' => '["满意","一般"]'], + ], + [ + 'name' => 'SkillGroupIdList', + 'in' => 'query', + 'schema' => ['description' => '坐席所属技能组ID列表。', 'type' => 'string', 'required' => false, 'example' => '['."\n" + .' "skg1@ccc-test",'."\n" + .' "skg2@ccc-test"'."\n" + .']'], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], + ], + [ + 'name' => 'FirstAgentId', + 'in' => 'query', + 'schema' => ['description' => '首个参与通话的坐席ID。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'schema' => ['description' => '主叫号码。', 'type' => 'string', 'required' => false, 'example' => '191***9993'], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => false, 'example' => '191***9993'], + ], + [ + 'name' => 'Number', + 'in' => 'query', + 'schema' => ['description' => '电话号码。', 'type' => 'string', 'required' => false, 'example' => '191***9993'], + ], + [ + 'name' => 'Broker', + 'in' => 'query', + 'schema' => ['description' => '中间号码，需要是实例下可用的外呼号码，双呼时会使用该号码先后呼叫主叫和被叫。', 'type' => 'string', 'required' => false, 'example' => '021****4972'], + ], + [ + 'name' => 'AccessChannelTypeList', + 'in' => 'query', + 'schema' => ['description' => '访客渠道类型列表。'."\n" + ."\n" + .'枚举列表：'."\n" + ."\n" + .'Web: 网页。'."\n" + ."\n" + .'DingTalkServiceWindow：钉钉服务窗。'."\n" + ."\n" + .'AliMe：对话机器人。'."\n" + ."\n" + .'DingTalkRobot：钉钉机器人。', 'type' => 'string', 'required' => false, 'example' => '["Web","AliMe"]'], + ], + [ + 'name' => 'ReleaseInitiatorList', + 'in' => 'query', + 'schema' => ['description' => '挂断方', 'type' => 'string', 'required' => false, 'example' => '[\\"AGENT\\"]'], + ], + [ + 'name' => 'ReleaseReasonList', + 'in' => 'query', + 'schema' => ['description' => '挂断原因', 'type' => 'string', 'required' => false, 'example' => '[\\"VisitorInitiatedClosure\\",\\"AgentInitiatedClosure\\"]'], + ], + [ + 'name' => 'AnalyticsReportReady', + 'in' => 'query', + 'schema' => ['description' => 'AI话后分析报告是否已完成', 'type' => 'boolean', 'required' => false, 'example' => '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' => '41298961-CAD7-5270-9378-FFD69F153144', - ], - 'Code' => [ - 'title' => 'code', - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'message', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'HttpStatusCode' => [ - 'title' => 'httpStatusCode', - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'List' => [ + 'description' => '通话记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通话记录。', + 'type' => 'object', + 'properties' => [ + 'ContactDisposition' => ['description' => '通话结束原因，枚举列表见ContactDispositionList查询参数。', 'type' => 'string', 'example' => 'Success'], + 'ContactType' => ['description' => '通话类型，枚举列表见ContactTypeList查询参数。', 'type' => 'string', 'example' => 'OUTBOUND'], + 'EstablishedTime' => ['description' => '通话建立的时间，如果通话没有建立，此值为空，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000'], + 'CalledNumber' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1332315****'], + 'AdditionalBroker' => ['description' => '附加中间号码，双呼场景下可能用到。', 'type' => 'string', 'example' => '0533128****'], + 'SatisfactionIndex' => ['description' => '满意度，即满意度按键数字（1位数字）的值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'SatisfactionSurveyChannel' => ['description' => '满意度调查渠道。', 'type' => 'string', 'example' => 'IVR'], + 'ReleaseTime' => ['description' => '通话结束时间，格式为 Unix 时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532707199000'], + 'WaitTime' => ['description' => '客户等待时长，即 QueueTime+RingTime，若客户等待期间放弃，则为 0，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'SkillGroupNames' => ['description' => '参与通话的座席所属的技能组名称，多个技能组以英文逗号分隔。', 'type' => 'string', 'example' => '测试技能组1,测试技能组2'], + 'IvrTime' => ['description' => 'IVR时长，即从开始进入IVR到开始进入转人工队列（或客户放弃）之间的时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], + 'SatisfactionDescription' => ['description' => '满意度描述，对应于满意度IVR中满意度模块的配置，客户自行定义。', 'type' => 'string', 'example' => '满意'], + 'ReleaseInitiator' => ['description' => '挂断方。'."\n" + ."\n" + .'枚举值：'."\n" + ."\n" + .'agent：坐席。'."\n" + ."\n" + .'customer：客户。', 'type' => 'string', 'example' => 'customer'], + 'AgentIds' => ['description' => '坐席ID列表，多个值用逗号分隔。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'CallDuration' => ['description' => '通话时长，呼入从通话进入IVR开始计时，呼出从接通开始计时，单位秒。', 'type' => 'string', 'example' => '16'], + 'RecordingReady' => ['description' => '录音是否已经生成。若通话没有建立，则返回false。', 'type' => 'boolean', 'example' => 'true'], + 'InstanceId' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'RingTime' => ['description' => '振铃时长，即从坐席振铃到坐席接起（或客户放弃）之间的时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'SatisfactionSurveyOffered' => ['description' => '是否发送了满意度。', 'type' => 'boolean', 'example' => 'true'], + 'AgentNames' => ['description' => '通话涉及到的坐席名称列表，多个坐席之间使用英文逗号隔开。', 'type' => 'string', 'example' => '云呼测试坐席'], + 'StartTime' => ['description' => '通话开始时间，内呼从进入 IVR 开始，外呼从拨号开始计算，格式为 Unix 字符串，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000'], + 'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-2255019651513856'], + 'RecordingDuration' => ['description' => '录音时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'CallingNumber' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '0533128****'], + 'QueueTime' => ['description' => '排队时长，即从开始进入转人工队列到坐席开始振铃（或客户放弃，队列超时，队列溢出）之间的时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Broker' => ['description' => '中间号码。', 'type' => 'string', 'example' => '053xxxx3127'], + 'SkillGroupIds' => ['description' => '参与通话的座席所属的技能组ID，多个技能组以逗号分隔。', 'type' => 'string', 'example' => 'skg-default@ccc-test'], + 'CallerLocation' => ['description' => '主叫归属地。', 'type' => 'string', 'example' => '北京市-北京'], + 'CalleeLocation' => ['description' => '被叫归属地。', 'type' => 'string', 'example' => '山东省-济南'], + 'EarlyMediaState' => ['description' => '早媒体状态。', 'type' => 'string', 'example' => 'NotConnected'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '486:USER_BUSY'], + 'DialingTime' => ['description' => '拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TalkTime' => ['description' => '通话时间，单位为秒', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HeldTime' => ['description' => '保持时间，单位为秒', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'EarlyMediaText' => ['description' => '早媒体文本。', 'type' => 'string', 'example' => '正在通话中'], + 'OffSiteAgentIds' => ['description' => '参与通话的场外坐席ID列表，多个坐席之间使用英文逗号隔开。', 'type' => 'string', 'example' => 'skg-default@ccc-test'], + 'OffsiteAgentDestinationNumbers' => ['description' => '分配的坐席是场外坐席时，呼叫的场外坐席号码。', 'type' => 'string', 'example' => '80312348'], + 'MessagesSent' => ['description' => '消息总量，MediaType为CHAT时有值。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'MessagesSentByCustomer' => ['description' => '客户发送消息总数，MediaType为CHAT时有值。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'MessagesSentByAgent' => ['description' => '坐席发送消息总数，MediaType为CHAT时有值。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'FirstResponseTime' => ['description' => '坐席首次回复客户消息花费的时长，MediaType为CHAT时有值。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'MediaType' => ['description' => '媒体类型。'."\n" + ."\n" + .'枚举列表：'."\n" + ."\n" + .'AUDIO：语音。'."\n" + ."\n" + .'CHAT：消息。'."\n" + ."\n" + .'VIDEO：视频。', 'type' => 'string', 'example' => 'CHAT'], + 'TransferCount' => ['description' => '转接次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AccessChannelType' => ['description' => '渠道类型，MediaType为CHAT时有值。', 'type' => 'string', 'example' => 'Web'], + 'AccessChannelName' => ['description' => '渠道名称，MediaType为CHAT时有值。', 'type' => 'string', 'example' => '测试渠道'], + 'AccessChannelUserId' => ['description' => '访客ID，MediaType为CHAT时有值。', 'type' => 'string', 'example' => 'test-user-id'], + 'AccessChannelUserName' => ['description' => '访客名称，MediaType为CHAT时有值。', 'type' => 'string', 'example' => '测试访客'], + 'ClientIpAddress' => ['description' => '访客客户端地址，MediaType为CHAT时有值。', 'type' => 'string', 'example' => '10.100.2.1'], + 'ClientLocation' => ['description' => '访客客户端归属地，MediaType为CHAT时有值。', 'type' => 'string', 'example' => '---'], + 'ClientUserAgent' => ['description' => '访客客户端信息，MediaType为CHAT时有值。', 'type' => 'string', 'example' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36'], + 'ClientAppName' => ['description' => '访客客户端名称，MediaType为CHAT时有值。', 'type' => 'string', 'example' => '未知'], + 'OffsiteAgentOriginatorNumbers' => ['description' => '分配的坐席是场外坐席时，发起呼叫场外坐席的号码。', 'type' => 'string', 'example' => '0101257****'], + 'CallIds' => ['description' => 'SIP协议的CallId列表。', 'type' => 'string', 'example' => 'dxxx1sdf,xkkwwwa'], + 'AnalyticsReportReady' => ['description' => 'AI话后分析报告是否完工。', 'type' => 'boolean', 'example' => 'true'], + 'AnalyticsReport' => [ + 'description' => '话后分析报告。', + 'type' => 'object', + 'properties' => [ + 'ProblemSolving' => [ + 'description' => '问题完结情况', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => '任务Id。', 'type' => 'string', 'example' => '8bf18b7a10064b29a75946a8d5b8469a'], + 'Success' => ['description' => '是否调用成功。'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'false'], + 'Solved' => ['description' => '是否解决。', 'type' => 'boolean', 'example' => 'true'], + 'Problem' => ['description' => '问题描述。', 'type' => 'string', 'example' => '告警问题'], + 'Solution' => ['description' => '解决方案。', 'type' => 'string', 'example' => '富化服务自动关闭原始告警'], + ], + ], + 'Emotion' => [ + 'description' => '情绪分析。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '0ff07fe35670423089dbdf12766d962f'], + 'Success' => ['description' => '是否调用成功。'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'], + 'Type' => ['description' => '情绪类型。', 'type' => 'string', 'example' => '中性'], + 'Confidence' => ['description' => '置信度。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], + 'Remark' => ['description' => '情绪详细分析备注。', 'type' => 'string', 'example' => '客户没情绪变化'], + ], + ], + 'Satisfaction' => [ + 'description' => '满意度分析。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'cb67479ce28243b28ff39948feaa0806'], + 'Success' => ['description' => '是否调用成功。'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'], + 'SatisfactionDescription' => ['description' => '满意度描述。', 'type' => 'string', 'example' => '满意'], + 'Remark' => ['description' => '满意度分析详情备注。', 'type' => 'string', 'example' => '客户表示满意'], + ], + ], + 'TodoList' => [ + 'description' => '待办事情。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => '任务ID。'."\n", 'type' => 'string', 'example' => 'cb67479ce28243b28ff39948feaa0806'], + 'Success' => ['description' => '是否调用成功。'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'], + 'Tasks' => [ + 'description' => '待办事项。', + 'type' => 'array', + 'items' => ['description' => '待办事项描述。', 'type' => 'string', 'example' => '回访'], + ], + ], + ], + ], + ], + 'OutsideNumberReleaseReason' => ['description' => '转外线时挂断原因', 'type' => 'string', 'example' => 'NoAnswer'], + 'SummaryIndex' => [ + 'description' => '小结索引', + 'type' => 'object', + 'properties' => [ + 'Keywords' => ['description' => '关键词', 'type' => 'string', 'example' => '客服'], + ], + ], + 'VoicebotOriginatorNumber' => ['description' => '从智能外呼转接过来时携带的外呼主叫号码', 'type' => 'string', 'example' => '021xxxxxxx'], + 'VoicebotDestinationNumber' => ['description' => '从智能外呼转接过来时携带的外呼被叫号码', 'type' => 'string', 'example' => '134xxxxxx'], + 'OffsiteAgentReleaseReason' => ['description' => '分配的最后一个场外坐席挂断原因', 'type' => 'string', 'example' => 'IVRException'], + 'OutsideNumberDestinationNumber' => ['description' => '转外线的被叫号码', 'type' => 'string', 'example' => '134xxxxxx'], + ], + ], + ], + ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"41298961-CAD7-5270-9378-FFD69F153144\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', - 'title' => '添加预测式外呼名单', - ], - 'AppendCases' => [ - 'summary' => '添加外呼名单到指定实例下指定ID对应的预测式外呼活动。', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'], + ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"OUTBOUND\\",\\n \\"EstablishedTime\\": 1532448000000,\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"AdditionalBroker\\": \\"0533128****\\",\\n \\"SatisfactionIndex\\": 1,\\n \\"SatisfactionSurveyChannel\\": \\"IVR\\",\\n \\"ReleaseTime\\": 1532707199000,\\n \\"WaitTime\\": 5,\\n \\"SkillGroupNames\\": \\"测试技能组1,测试技能组2\\",\\n \\"IvrTime\\": 8,\\n \\"SatisfactionDescription\\": \\"满意\\",\\n \\"ReleaseInitiator\\": \\"customer\\",\\n \\"AgentIds\\": \\"agent@ccc-test\\",\\n \\"CallDuration\\": \\"16\\",\\n \\"RecordingReady\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RingTime\\": 5,\\n \\"SatisfactionSurveyOffered\\": true,\\n \\"AgentNames\\": \\"云呼测试坐席\\",\\n \\"StartTime\\": 1631440860000,\\n \\"ContactId\\": \\"job-2255019651513856\\",\\n \\"RecordingDuration\\": 10,\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"QueueTime\\": 0,\\n \\"Broker\\": \\"053xxxx3127\\",\\n \\"SkillGroupIds\\": \\"skg-default@ccc-test\\",\\n \\"CallerLocation\\": \\"北京市-北京\\",\\n \\"CalleeLocation\\": \\"山东省-济南\\",\\n \\"EarlyMediaState\\": \\"NotConnected\\",\\n \\"ReleaseReason\\": \\"486:USER_BUSY\\",\\n \\"DialingTime\\": 0,\\n \\"TalkTime\\": 0,\\n \\"HeldTime\\": 12,\\n \\"EarlyMediaText\\": \\"正在通话中\\",\\n \\"OffSiteAgentIds\\": \\"skg-default@ccc-test\\",\\n \\"OffsiteAgentDestinationNumbers\\": \\"80312348\\",\\n \\"MessagesSent\\": 10,\\n \\"MessagesSentByCustomer\\": 5,\\n \\"MessagesSentByAgent\\": 5,\\n \\"FirstResponseTime\\": 10,\\n \\"MediaType\\": \\"CHAT\\",\\n \\"TransferCount\\": 1,\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"AccessChannelName\\": \\"测试渠道\\",\\n \\"AccessChannelUserId\\": \\"test-user-id\\",\\n \\"AccessChannelUserName\\": \\"测试访客\\",\\n \\"ClientIpAddress\\": \\"10.100.2.1\\",\\n \\"ClientLocation\\": \\"---\\",\\n \\"ClientUserAgent\\": \\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36\\",\\n \\"ClientAppName\\": \\"未知\\",\\n \\"OffsiteAgentOriginatorNumbers\\": \\"0101257****\\",\\n \\"CallIds\\": \\"dxxx1sdf,xkkwwwa\\",\\n \\"AnalyticsReportReady\\": true,\\n \\"AnalyticsReport\\": {\\n \\"ProblemSolving\\": {\\n \\"TaskId\\": \\"8bf18b7a10064b29a75946a8d5b8469a\\",\\n \\"Success\\": false,\\n \\"Solved\\": true,\\n \\"Problem\\": \\"告警问题\\",\\n \\"Solution\\": \\"富化服务自动关闭原始告警\\"\\n },\\n \\"Emotion\\": {\\n \\"TaskId\\": \\"0ff07fe35670423089dbdf12766d962f\\",\\n \\"Success\\": true,\\n \\"Type\\": \\"中性\\",\\n \\"Confidence\\": 50,\\n \\"Remark\\": \\"客户没情绪变化\\"\\n },\\n \\"Satisfaction\\": {\\n \\"TaskId\\": \\"cb67479ce28243b28ff39948feaa0806\\",\\n \\"Success\\": true,\\n \\"SatisfactionDescription\\": \\"满意\\",\\n \\"Remark\\": \\"客户表示满意\\"\\n },\\n \\"TodoList\\": {\\n \\"TaskId\\": \\"cb67479ce28243b28ff39948feaa0806\\",\\n \\"Success\\": true,\\n \\"Tasks\\": [\\n \\"回访\\"\\n ]\\n }\\n },\\n \\"OutsideNumberReleaseReason\\": \\"NoAnswer\\",\\n \\"SummaryIndex\\": {\\n \\"Keywords\\": \\"客服\\"\\n },\\n \\"VoicebotOriginatorNumber\\": \\"021xxxxxxx\\",\\n \\"VoicebotDestinationNumber\\": \\"134xxxxxx\\",\\n \\"OffsiteAgentReleaseReason\\": \\"IVRException\\",\\n \\"OutsideNumberDestinationNumber\\": \\"134xxxxxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取通话详情列表', + 'description' => 'ListCallDetailRecordsV2用来替代ListCallDetailRecords接口，后续新增字段和查询条件会在ListCallDetailRecordsV2持续优化。另外为了保证查询效率，返回数据中的 TotalCount 字段，只会在查询第一页时赋值，查询其他页时返回 0。', + 'changeSet' => [ + ['createdAt' => '2025-07-15T12:01:46.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-06-12T11:54:29.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-09-06T02:26:17.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ListCallSummaries' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccQFUGXR', - ], - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'CampaignId', + 'name' => 'ContactIdList', 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'required' => true, - 'example' => '78cf6864-9a22-4ea8-a59d-5adc2d747b0e', - ], - ], - [ - 'name' => 'body', - 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '外呼名单列表，Body参数。', + 'title' => '通话ID列表', + 'description' => '通话ID列表。', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ReferenceId' => [ - 'description' => '业务ID，客户业务系统标识，用于集成场景。'."\n" - ."\n", - 'type' => 'string', - 'required' => false, - 'example' => '01', - ], - 'PhoneNumber' => [ - 'description' => '联系人电话号码。', - 'type' => 'string', - 'required' => false, - 'example' => '188888****', - ], - 'CustomVariables' => [ - 'description' => '客户自定义变量，格式为JSON对象，对象最多包含10个属性，每个属性的名称和值均由客户自定义。', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "name": "customer",'."\n" - .' "客户标签": "tag"'."\n" - .'}', - ], - 'MaskedCallee' => [ - 'description' => '脱敏后的被叫号码，如果该字段不为空，表示需要对被叫号码脱敏，脱敏规则由客户自行定义，只需将脱敏后的被叫号码填入即可，使用脱敏被叫会导致某些场景下看到的是脱敏后的被叫号码，无法查看真实被叫号码。', - 'type' => 'string', - 'required' => false, - 'example' => '071*****801', - ], - 'Caller' => [ - 'description' => '主叫号码，该字段若不为空，外呼式会优先使用传入的号码作为主叫发起呼叫；该字段若为空，系统会自动选取主叫发起呼叫。', - 'type' => 'string', - 'required' => false, - 'example' => '01012345678', - ], - 'AgentId' => [ - 'description' => '坐席ID，指定的转接坐席，该字段不为空，系统会将该电话转至对应坐席；该字段若为空，系统会分配给技能组中的空闲坐席。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], - ], - 'required' => false, - ], + 'items' => ['description' => '通话ID。', 'type' => 'string', 'required' => false, 'example' => 'job-544789******759424'], 'required' => false, ], ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'ListCallSummariesResponse', + 'description' => 'ListCallSummariesResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E', - ], - 'Code' => [ - 'title' => 'code', - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'message', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'HttpStatusCode' => [ - 'title' => 'httpStatusCode', - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', - ], 'Data' => [ + 'description' => '数据。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ReferenceId' => [ - 'type' => 'string', - ], - 'PhoneNumber' => [ - 'type' => 'string', - ], - 'CustomVariables' => [ - 'type' => 'string', - ], - ], - ], + 'TicketId' => ['title' => '小结ID', 'description' => '小结ID。', 'type' => 'string', 'example' => 'ac0dd304-****-****-****-4a90010f0d38'], + 'ContactId' => ['title' => '通话ID', 'description' => '通话ID。', 'type' => 'string', 'example' => 'job-544789******759424'], + 'Context' => ['title' => 'summary信息', 'description' => '小结信息。', 'type' => 'string', 'example' => '{'."\n" + .' "_sys_field_config": ['."\n" + .' {'."\n" + .' "Array": false,'."\n" + .' "Required": true,'."\n" + .' "DisplayName": "主题",'."\n" + .' "Attributes": "{}",'."\n" + .' "DataType": "TEXT",'."\n" + .' "EditorType": "TEXT",'."\n" + .' "MaxLength": 30,'."\n" + .' "System": true,'."\n" + .' "Name": "summaryTitle"'."\n" + .' },'."\n" + .' {'."\n" + .' "Array": false,'."\n" + .' "DisplayName": "小结",'."\n" + .' "Attributes": "{}",'."\n" + .' "DataType": "TEXT",'."\n" + .' "EditorType": "TEXTAREA",'."\n" + .' "MaxLength": 1000,'."\n" + .' "System": true,'."\n" + .' "Name": "summaryContent"'."\n" + .' },'."\n" + .' {'."\n" + .' "Array": true,'."\n" + .' "DisplayName": "标签",'."\n" + .' "Attributes": "{}",'."\n" + .' "DataType": "TEXT",'."\n" + .' "EditorType": "SELECT",'."\n" + .' "System": true,'."\n" + .' "Name": "keywords"'."\n" + .' }'."\n" + .' ],'."\n" + .' "summaryContent": "小结内容",'."\n" + .' "creator": "creator@ccc-test",'."\n" + .' "bizType": "Summary",'."\n" + .' "keywords": ['."\n" + .' "标签1"'."\n" + .' ],'."\n" + .' "source": "Console",'."\n" + .' "summaryTitle": "测试会话小结",'."\n" + .' "instanceId": "ccc-test",'."\n" + .' "externalInput": "{\\"summaryTitle\\":\\"测试会话小结\\",\\"summaryContent\\":\\"小结内容\\",\\"keywords\\":[\\"标签1\\"],\\"_sys_field_config\\":[{\\"DisplayName\\":\\"主题\\",\\"Name\\":\\"summaryTitle\\",\\"Required\\":true,\\"EditorType\\":\\"TEXT\\",\\"Array\\":false,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"MaxLength\\":30,\\"Attributes\\":\\"{}\\"},{\\"DisplayName\\":\\"小结\\",\\"Name\\":\\"summaryContent\\",\\"EditorType\\":\\"TEXTAREA\\",\\"Array\\":false,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"MaxLength\\":1000,\\"Attributes\\":\\"{}\\"},{\\"DisplayName\\":\\"标签\\",\\"Name\\":\\"keywords\\",\\"EditorType\\":\\"SELECT\\",\\"Array\\":true,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"Attributes\\":\\"{}\\"}]}",'."\n" + .' "templateName": "Summary-Ticket",'."\n" + .' "bizId": "job-544789******759424",'."\n" + .' "ticketStartTime": 1723449513735,'."\n" + .' "ticketId": "ac0dd304-****-****-****-4a90010f0d38",'."\n" + .' "definitionId": "Summary-Ticket:2:6881f43a-****-11ee-*****-6eb35a90a7a6"'."\n" + .'}'], + 'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1723449513735'], + 'Creator' => ['title' => '创建人', 'description' => '创建人。', 'type' => 'string', 'example' => 'creator@ccc-test'], + 'Editor' => ['description' => '编辑人。', 'type' => 'string', 'example' => 'editor@ccc-test'], + ], + 'description' => '', + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '932579BC-811A-503D-B322-4C2E57087CAA'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"ReferenceId\\": \\"\\",\\n \\"PhoneNumber\\": \\"\\",\\n \\"CustomVariables\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '追加预测式外呼名单', - ], - 'CreateCampaign' => [ - 'summary' => '调用CreateCampaign在指定实例下创建预测式外呼活动。', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TicketId\\": \\"ac0dd304-****-****-****-4a90010f0d38\\",\\n \\"ContactId\\": \\"job-544789******759424\\",\\n \\"Context\\": \\"{\\\\n \\\\\\"_sys_field_config\\\\\\": [\\\\n {\\\\n \\\\\\"Array\\\\\\": false,\\\\n \\\\\\"Required\\\\\\": true,\\\\n \\\\\\"DisplayName\\\\\\": \\\\\\"主题\\\\\\",\\\\n \\\\\\"Attributes\\\\\\": \\\\\\"{}\\\\\\",\\\\n \\\\\\"DataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"EditorType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"MaxLength\\\\\\": 30,\\\\n \\\\\\"System\\\\\\": true,\\\\n \\\\\\"Name\\\\\\": \\\\\\"summaryTitle\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"Array\\\\\\": false,\\\\n \\\\\\"DisplayName\\\\\\": \\\\\\"小结\\\\\\",\\\\n \\\\\\"Attributes\\\\\\": \\\\\\"{}\\\\\\",\\\\n \\\\\\"DataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"EditorType\\\\\\": \\\\\\"TEXTAREA\\\\\\",\\\\n \\\\\\"MaxLength\\\\\\": 1000,\\\\n \\\\\\"System\\\\\\": true,\\\\n \\\\\\"Name\\\\\\": \\\\\\"summaryContent\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"Array\\\\\\": true,\\\\n \\\\\\"DisplayName\\\\\\": \\\\\\"标签\\\\\\",\\\\n \\\\\\"Attributes\\\\\\": \\\\\\"{}\\\\\\",\\\\n \\\\\\"DataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"EditorType\\\\\\": \\\\\\"SELECT\\\\\\",\\\\n \\\\\\"System\\\\\\": true,\\\\n \\\\\\"Name\\\\\\": \\\\\\"keywords\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"summaryContent\\\\\\": \\\\\\"小结内容\\\\\\",\\\\n \\\\\\"creator\\\\\\": \\\\\\"creator@ccc-test\\\\\\",\\\\n \\\\\\"bizType\\\\\\": \\\\\\"Summary\\\\\\",\\\\n \\\\\\"keywords\\\\\\": [\\\\n \\\\\\"标签1\\\\\\"\\\\n ],\\\\n \\\\\\"source\\\\\\": \\\\\\"Console\\\\\\",\\\\n \\\\\\"summaryTitle\\\\\\": \\\\\\"测试会话小结\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"ccc-test\\\\\\",\\\\n \\\\\\"externalInput\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"summaryTitle\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"测试会话小结\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"summaryContent\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"小结内容\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"keywords\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"标签1\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"_sys_field_config\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"DisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"主题\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"summaryTitle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Required\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"EditorType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Array\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"DataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"System\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"MaxLength\\\\\\\\\\\\\\":30,\\\\\\\\\\\\\\"Attributes\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{}\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"DisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"小结\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"summaryContent\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EditorType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXTAREA\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Array\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"DataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"System\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"MaxLength\\\\\\\\\\\\\\":1000,\\\\\\\\\\\\\\"Attributes\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{}\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"DisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"标签\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"keywords\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EditorType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SELECT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Array\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"DataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"System\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"Attributes\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{}\\\\\\\\\\\\\\"}]}\\\\\\",\\\\n \\\\\\"templateName\\\\\\": \\\\\\"Summary-Ticket\\\\\\",\\\\n \\\\\\"bizId\\\\\\": \\\\\\"job-544789******759424\\\\\\",\\\\n \\\\\\"ticketStartTime\\\\\\": 1723449513735,\\\\n \\\\\\"ticketId\\\\\\": \\\\\\"ac0dd304-****-****-****-4a90010f0d38\\\\\\",\\\\n \\\\\\"definitionId\\\\\\": \\\\\\"Summary-Ticket:2:6881f43a-****-11ee-*****-6eb35a90a7a6\\\\\\"\\\\n}\\",\\n \\"CreatedTime\\": 1723449513735,\\n \\"Creator\\": \\"creator@ccc-test\\",\\n \\"Editor\\": \\"editor@ccc-test\\"\\n }\\n ],\\n \\"RequestId\\": \\"932579BC-811A-503D-B322-4C2E57087CAA\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取会话小结', + 'summary' => '使用ListCallSummaries接口获取会话小结。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ListCallTags' => [ + 'summary' => '调用ListCallTags获取指定实例下的所有号码标签。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22514,255 +13243,269 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccQFUGXR', - ], + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'CaseList', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '预测式外呼名单列表，不能与CaseFileKey（从文件导入）同时使用，文件导入和列表导入只能选择一种。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '预测式外呼名单。', - 'type' => 'object', - 'properties' => [ - 'ReferenceId' => [ - 'description' => '业务ID，客户业务系统标识，用于集成场景。', - 'type' => 'string', - 'required' => false, - 'example' => '01', - ], - 'PhoneNumber' => [ - 'description' => '联系人电话号码。', - 'type' => 'string', - 'required' => false, - 'example' => '1888888888', - ], - 'CustomVariables' => [ - 'description' => '客户自定义变量，格式为JSON对象，对象最多包含10个属性，每个属性的名称和值均由客户自定义。', - 'type' => 'string', - 'required' => false, - 'example' => '{"name":"customer","客户标签":"tag"}', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n" + ."\n", 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'List' => [ + 'description' => '号码标签列表。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '号码标签。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'TagName' => ['description' => '号码标签名称。', 'type' => 'string', 'example' => 'TagA'], + ], + ], + ], ], ], - 'required' => false, ], - 'required' => false, ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], + ], + ], + 'title' => '获取号码标签列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallTags'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TagName\\": \\"TagA\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nBA03159C-E808-4FF1-B27E-A61B6E888D7F\\n200\\n\\n 1\\n 10\\n 1\\n \\n TagA\\n ccc-test\\n \\n\\nOK","errorExample":""}]', + ], + 'ListCampaignTrendingReport' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'QueueId', - 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动关联的技能组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'skillgroup@ccc-test', - ], + 'AK' => [], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-campaign', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], + ], + 'parameters' => [ [ - 'name' => 'CaseFileKey', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼名单文件，是一个OSS对象的Key，通过GetCaseFileUploadUrl接口获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'ccc-test/namelist.csv', - ], + 'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'ContactFlowId', + 'name' => 'CampaignId', 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动关联的联系流ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'c1f2bc75-422e-43c7-9c9d9d95633a', - ], + 'schema' => ['title' => '活动ID', 'description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'string', - 'required' => true, - 'example' => '1634140800000', - ], + 'schema' => ['title' => '开始时间', 'description' => '开始时间，非必填，默认为预测式外呼活动的开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2021-10-14 00:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', + 'schema' => ['title' => '结束时间', 'description' => '结束时间，非必填，默认为预测式外呼活动的结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2021-10-14 20:59:59'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '预测式外呼活动结束时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'string', - 'required' => true, - 'example' => '1634313600000', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0'], + 'Data' => [ + 'description' => '统计打点数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '统计打点数据。', + 'type' => 'object', + 'properties' => [ + 'Datetime' => ['description' => '分段统计的打点时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634037840000'], + 'Concurrency' => ['description' => '呼叫并发量，即同时在外呼的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TalkAgents' => ['description' => '已废弃，请参考TalkAgents。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ReadyAgents' => ['description' => '空闲坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'WorkAgents' => ['description' => '已废弃，请参考WorkingAgents。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'LoggedInAgents' => ['description' => '上线的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'BreakAgents' => ['description' => '小休坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'StatsTime' => ['description' => '统计打点时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'], + 'TalkingAgents' => ['description' => '处于通话状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'WorkingAgents' => ['description' => '处于话后处理状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'BreakingAgents' => ['description' => '处于小休状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'OutboundScenarioReadyAgents' => ['description' => '处于仅外呼模式且在空闲状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'OutboundScenarioBreakingAgents' => ['description' => '处于仅外呼模式且在小休状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'OutboundScenarioTalkingAgents' => ['description' => '处于仅外呼模式且在通话中状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'OutboundScenarioWorkingAgents' => ['description' => '处于仅外呼模式且在话后处理状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + ], + ], + ], + ], ], ], + ], + 'title' => '获取预测式外呼活动趋势报表', + 'summary' => '获取指定实例下指定ID对应的预测式外呼活动的趋势报表。', + 'changeSet' => [ + ['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaignTrendingReport'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\",\\n \\"Data\\": [\\n {\\n \\"Datetime\\": 1634037840000,\\n \\"Concurrency\\": 1,\\n \\"TalkAgents\\": 0,\\n \\"ReadyAgents\\": 2,\\n \\"WorkAgents\\": 0,\\n \\"LoggedInAgents\\": 2,\\n \\"BreakAgents\\": 0,\\n \\"StatsTime\\": 1604639129000,\\n \\"TalkingAgents\\": 4,\\n \\"WorkingAgents\\": 0,\\n \\"BreakingAgents\\": 1,\\n \\"OutboundScenarioReadyAgents\\": 1,\\n \\"OutboundScenarioBreakingAgents\\": 2,\\n \\"OutboundScenarioTalkingAgents\\": 1,\\n \\"OutboundScenarioWorkingAgents\\": 2\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 200\\n 无\\n 6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\n \\n 1634037840000\\n 1\\n 0\\n 2\\n 0\\n 2\\n 0\\n \\n","errorExample":""}]', + ], + 'ListCampaigns' => [ + 'summary' => '调用ListCampaigns获取指定实例下的预测式外呼活动列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CallableTime', - 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动的可外呼时段，格式为JSON对象，对象包含两个属性，beginTime和EndTime，例如：[{"beginTime":"00:00:00","endTime":"23:00:00" }]。', - 'type' => 'string', - 'required' => true, - 'example' => '[{"beginTime":"00:00:00","endTime":"23:00:00" }]', - ], + 'AK' => [], ], [ - 'name' => 'StrategyType', + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动的策略模式。'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'PACING' => '固定比例外呼，外呼数量=空闲坐席*比例。', - 'PID' => '系统基于PID控制策略，自动调整外呼电话数量。', - ], - 'example' => 'PACING', - 'enum' => [ - 'SP', - 'PID', - 'PACING', - 'ASAP', - 'CUSTOMIZED', - ], - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'StrategyParameters', + 'name' => 'State', 'in' => 'query', 'schema' => [ - 'description' => '预测式外呼活动的策略参数，PID策略下的格式参数示例：{"abandonRate":"5","historicalConnectedRate":"35"}，PACING策略下的格式参数示例：{"ratio":1}。abandonRate表示期望呼损率，historicalConnectedRate表示历史参考接通率，ratio表示固定外呼比例。', + 'description' => '按预测式外呼活动状态过滤，非必填，默认为空。'."\n", 'type' => 'string', - 'required' => true, - 'example' => '{"ratio":1}', + 'required' => false, + 'enumValueTitles' => ['Draft' => '草稿', 'Completed' => '已完成', 'Executing' => '执行中', 'Pending' => '待执行', 'Aborted' => '已终止', 'Paused' => 'Paused'], + 'example' => 'Draft', ], ], [ - 'name' => 'MaxAttemptCount', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动的最大尝试次数，表示当活动的号码呼叫失败时，最多重呼几次。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '按预测式外呼活动名称过滤，不支持模糊匹配，非必填，默认为空，表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'test-campaign'], ], [ - 'name' => 'MinAttemptInterval', + 'name' => 'PlanedStartTimeFrom', 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动的最小重呼间隔，表示失败重呼时的最小间隔，单位分钟。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '外呼活动计划开始时间，非必填，默认查询所有时间范围。', 'type' => 'string', 'required' => false, 'example' => '1780243200000'], ], [ - 'name' => 'Simulation', + 'name' => 'PlanedStartTimeTo', 'in' => 'query', - 'schema' => [ - 'description' => '是否是模拟活动，用于测试，普通客户无需关心。', - 'type' => 'boolean', - 'required' => false, - 'example' => '无', - 'default' => 'false', - ], + 'schema' => ['description' => '外呼活动计划结束时间，非必填，默认查询所有时间范围。', 'type' => 'string', 'required' => false, 'example' => '1781798399000'], ], [ - 'name' => 'SimulationParameters', + 'name' => 'ActualStartTimeFrom', 'in' => 'query', - 'schema' => [ - 'description' => '模拟参数，用于测试，普通客户无需关心。', - 'type' => 'string', - 'required' => false, - 'example' => '无', - ], + 'schema' => ['description' => '外呼活动实际开始时间，非必填，默认查询所有时间范围。', 'type' => 'string', 'required' => false, 'example' => '1780329600000'], ], [ - 'name' => 'ExecutingUntilTimeout', + 'name' => 'ActualStartTimeTo', 'in' => 'query', - 'schema' => [ - 'description' => '是否在活动到期前保持执行状态。默认值fasle，当活动的所有联系人都呼叫完成后，活动会自动变为已完成状态；如果为True，当活动的所有联系人都呼叫完成后，活动不会自动变成已完成状态，仍是执行中状态，可以继续像活动中追加联系人，进而继续进行拨打，直到任务到期或手动终止。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '外呼活动实际结束时间，非必填，默认查询所有时间范围。', 'type' => 'string', 'required' => false, 'example' => '1781625600000'], ], [ - 'name' => 'FlashSmsParameters', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '闪信参数', - 'description' => '闪信参数', - 'type' => 'string', - 'required' => false, - 'example' => '{"applicationId":"08e6b63a-****-****-****-689a288cdbb5","templateId":"325"}', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ - 'name' => 'NumberList', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '主叫号码列表', - 'description' => '主叫号码列表', - 'type' => 'array', - 'items' => [ - 'title' => '号码', - 'description' => '号码', - 'type' => 'string', - 'required' => false, - 'example' => '01012345678', - ], - 'required' => false, - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'], ], [ - 'name' => 'InstGroupId', + 'name' => 'QueueId', 'in' => 'query', - 'schema' => [ - 'title' => '号码集合ID', - 'description' => '号码集合ID', - 'type' => 'string', - 'required' => false, - 'example' => '0d368091-2c70-4d26-979a-6997ddc9c34f', - ], + 'schema' => ['description' => '按技能组ID过滤，非必填，默认为空，表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test'], ], ], 'responses' => [ @@ -22772,53 +13515,83 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], 'Data' => [ - 'title' => 'campaign id', - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'example' => 'c58b9719-3bc3-441d-a4d3-fc0309ef7066', - ], - 'Code' => [ - 'title' => 'code', - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'message', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '预测式外呼活动列表。', + 'type' => 'array', + 'items' => [ + 'description' => '预测式外呼活动信息。', + 'type' => 'object', + 'properties' => [ + 'ActualEndTime' => ['description' => '预测式外呼活动实际结束时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634008800000'], + 'ActualStartTime' => ['description' => '预测式外呼活动实际开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634000460000'], + 'CasesAborted' => ['description' => '预测式外呼活动的止呼数量，止呼指取消呼叫联系人。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CasesUncompleted' => ['description' => '预测式外呼活动的未完成数量，未完成指未接通且未达到最大重试次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CasesConnected' => ['description' => '预测式外呼活动的接通数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '40'], + 'MaxAttemptCount' => ['description' => '预测式外呼活动的最大尝试次数，表示当活动的号码呼叫失败时，最多重呼几次。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MinAttemptInterval' => ['description' => '预测式外呼活动的最小重呼间隔，表示失败重呼时的最小间隔，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['description' => '预测式外呼活动名称。', 'type' => 'string', 'example' => 'test-campaign'], + 'PlanedEndTime' => ['description' => '预测式外呼活动计划结束时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1634054400000'], + 'PlanedStartTime' => ['description' => '预测式外呼活动计划开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1633968000000'], + 'QueueName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '测试技能组'], + 'TotalCases' => ['description' => '号码总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'State' => [ + 'title' => 'state', + 'description' => '预测式外呼活动状态。', + 'type' => 'string', + 'enumValueTitles' => ['Draft' => '草稿', 'Completed' => '已完成', 'Executing' => '执行中', 'Pending' => '待执行', 'Aborted' => '已终止', 'Paused' => '已暂停'], + 'example' => 'Completed', + ], + 'CampaignId' => ['title' => 'id', 'description' => '预测式外呼活动ID。', 'type' => 'string', 'example' => '6badb397-a8b5-40b6-21019d382a09'], + 'StrategyType' => [ + 'description' => '预测式外呼活动的策略模式。', + 'type' => 'string', + 'enumValueTitles' => ['PACING' => '固定比例外呼，外呼数量=空闲坐席*比例。', 'PID' => '系统基于PID控制策略，自动调整外呼电话数量。'], + 'example' => 'PACING', + ], + 'StrategyParameters' => ['description' => '预测式外呼活动的策略参数，PID策略下的格式参数示例：{"abandonRate":"5","historicalConnectedRate":"35"}，PACING策略下的格式参数示例：{"ratio":1}。abandonRate表示期望呼损率，historicalConnectedRate表示历史参考接通率，ratio表示固定外呼比例。', 'type' => 'string', 'example' => '{"ratio":1}'], + 'QueueId' => ['description' => '关联的技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Simulation' => ['description' => '是否为模拟活动。', 'type' => 'boolean', 'example' => 'false'], + 'CompletionRate' => ['description' => '完成率，参数已废弃，可以使用(TotalCases-CasesUnCompleted) / TotalCases计算得出', 'type' => 'number', 'format' => 'float', 'example' => '无'], + 'ContactFlowId' => ['description' => '号码关联的IVR联系流ID。', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek'], + ], + ], + ], + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Data\\": \\"c58b9719-3bc3-441d-a4d3-fc0309ef7066\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n 7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\n 6badb397-a8b5-40b6-21019d382a09\\n OK\\n 无\\n 200\\n","errorExample":""}]', - 'title' => '创建预测式外呼活动', - ], - 'GetCampaign' => [ - 'summary' => '调用GetCampaign获取指定实例下指定ID对应的预测式外呼活动。', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"ActualEndTime\\": 1634008800000,\\n \\"ActualStartTime\\": 1634000460000,\\n \\"CasesAborted\\": 0,\\n \\"CasesUncompleted\\": 0,\\n \\"CasesConnected\\": 40,\\n \\"MaxAttemptCount\\": 1,\\n \\"MinAttemptInterval\\": 1,\\n \\"Name\\": \\"test-campaign\\",\\n \\"PlanedEndTime\\": 1634054400000,\\n \\"PlanedStartTime\\": 1633968000000,\\n \\"QueueName\\": \\"测试技能组\\",\\n \\"TotalCases\\": 100,\\n \\"State\\": \\"Completed\\",\\n \\"CampaignId\\": \\"6badb397-a8b5-40b6-21019d382a09\\",\\n \\"StrategyType\\": \\"PACING\\",\\n \\"StrategyParameters\\": \\"{\\\\\\"ratio\\\\\\":1}\\",\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"Simulation\\": false,\\n \\"CompletionRate\\": 0,\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\n 无\\n 200\\n \\n \\n 1634008800000\\n 1634000460000\\n 0\\n 0\\n 40\\n 100\\n 1\\n 1\\n test-campalgn\\n 1634054400000\\n 1633968000000\\n 默认技能组\\n 100\\n Completed\\n 6badb397-a8b5-40b6-21019d382a09\\n PACING\\n {\\"ratio\\":1}\\n skg-default@report-test-2\\n false\\n \\n 1\\n 10\\n 1\\n \\n OK\\n true\\n","errorExample":""}]', + 'title' => '获取预测式外呼活动列表', + 'changeSet' => [ + ['createdAt' => '2024-06-06T11:38:12.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-11-17T01:12:02.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaigns'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ListCases' => [ + 'summary' => '调用ListCases获取指定实例下指定ID对应的预测式外呼活动的外呼名单执行详情列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22827,30 +13600,49 @@ 'BearerToken' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ 'name' => 'CampaignId', 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'required' => true, - 'example' => '6badb397-a8b5-40b6-21019d382a09', - ], + 'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => ['description' => '按电话号码过滤，不支持模糊匹配，非必填，默认为空。', 'type' => 'string', 'required' => false, 'example' => '无'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => ['description' => 'Pending（待拨打） '."\n" + .'Executing（拨打中） '."\n" + .'Connected（联系成功） '."\n" + .'Failed（联系失败） '."\n" + .'Aborted（止呼, 取消呼叫） '."\n" + .'Forbidden（规则禁止呼叫，比如黑名单）', 'type' => 'string', 'required' => false, 'example' => 'Pending'], ], ], 'responses' => [ @@ -22858,251 +13650,126 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE316'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '数据', + 'title' => 'data', + 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'ActualEndTime' => [ - 'description' => '预测式外呼活动实际结束时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1634008800000', - ], - 'ActualStartTime' => [ - 'description' => '预测式外呼活动实际开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1634000460000', - ], - 'CasesAborted' => [ - 'description' => '取消呼叫的联系人数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CasesUncompleted' => [ - 'description' => '未完呼叫的联系人数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CasesConnected' => [ - 'description' => '已接通的联系人数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '40', - ], - 'MaxAttemptCount' => [ - 'description' => '预测式外呼活动的最大尝试次数，表示当活动的号码呼叫失败时，最多重呼几次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MinAttemptInterval' => [ - 'description' => '预测式外呼活动的最小重呼间隔，表示失败重呼时的最小间隔，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'description' => '预测式外呼活动名称。', - 'type' => 'string', - 'example' => 'test-campaign', - ], - 'PlanedEndTime' => [ - 'description' => '预测式外呼活动计划结束时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1634054400000', - ], - 'PlanedStartTime' => [ - 'description' => '预测式外呼活动计划开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1633968000000', - ], - 'QueueName' => [ - 'description' => '关联的技能组名称。', - 'type' => 'string', - 'example' => '测试技能组', - ], - 'TotalCases' => [ - 'description' => '联系人总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'State' => [ - 'description' => '预测式外呼活动状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Draft' => '草稿', - 'Completed' => '已完成', - 'Executing' => '执行中', - 'Pending' => '待执行', - 'Aborted' => '已取消', - 'Paused' => '已暂停', - ], - 'example' => 'Completed', - ], - 'CampaignId' => [ - 'title' => 'id', - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'example' => '6badb397-a8b5-40b6-21019d382a09', - ], - 'StrategyType' => [ - 'description' => '预测式外呼活动的策略模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'PACING' => '固定比例外呼，外呼数量 = 空闲坐席 * 比例', - 'PID' => '系统基于PID控制策略，自动调整外呼电话数量', + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'List' => [ + 'description' => '联系人名单执行详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '联系人名单执行详情。', + 'type' => 'object', + 'properties' => [ + 'AbandonType' => [ + 'description' => '通话被放弃的类型，即未成功接通的原因。', + 'type' => 'string', + 'enumValueTitles' => ['NA' => '未放弃', 'IVR' => 'IVR交互阶段', 'Ringing' => '坐席振铃阶段', 'Queuing' => '排队阶段'], + 'example' => 'NA', + ], + 'AttemptCount' => ['description' => '已尝试次数，对该联系人的总呼叫次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'FailureReason' => [ + 'description' => '外呼失败原因。', + 'type' => 'string', + 'enumValueTitles' => [ + 'AbandonedInQueue' => '排队放弃', 'AbandonedInRing' => '振铃放弃', 'AbandonedInIVR' => 'IVR放弃', 'NoAnswer' => '客户未接', 'QueuingTimeout' => '排队超时', 'Reject' => '客户拒接', 'Voicemail' => '转语音邮箱', 'QueuingFailed' => '转人工失败', 'QueuingOverflow' => '排队溢出', 'AbandonedInVoiceNavigator' => '智能导航中放弃', + 'IVRException' => 'IVR异常', 'ForwardToOutsideNumber' => '转外线', + ], + 'example' => '无', + ], + 'PhoneNumber' => ['description' => '电话号码。', 'type' => 'string', 'example' => '1888888****'], + 'State' => [ + 'description' => '状态。', + 'type' => 'string', + 'enumValueTitles' => ['Connected' => '联系成功', 'Failed' => '联系失败', 'Executing' => '拨打中', 'Pending' => '待拨打', 'Aborted' => '已止呼'], + 'example' => 'Connected', + ], + 'CaseId' => ['description' => '系统生成的联系人ID，客户无需关心。', 'type' => 'string', 'example' => '60ecb1a2-4480-4d01-bede-c5b7655bfadf'], + 'CustomVariables' => ['description' => '客户自定义变量，格式为JSON对象，对象最多包含10个属性，每个属性的名称和值均由客户自定义，客户在创建预测式外呼活动时可以设置。', 'type' => 'string', 'example' => '{"name":"yy","客戶标签":"tag-yy"}'], + 'AbandonPhase' => ['description' => '通话被放弃的阶段。 '."\n" + .' - IVR（IVR交互阶段） '."\n" + .' - Queuing（排队阶段） '."\n" + .' - Ringing（坐席振铃阶段）', 'type' => 'string', 'example' => 'Ringing'], + ], ], - 'example' => 'PACING', - ], - 'StrategyParameters' => [ - 'description' => '预测式外呼活动的策略参数，PID策略下的格式参数示例：{"abandonRate":"5","historicalConnectedRate":"35"}，PACING策略下的格式参数示例：{"ratio":1}。abandonRate表示期望呼损率，historicalConnectedRate表示历史参考接通率，ratio表示固定外呼比例。', - 'type' => 'string', - 'example' => '{"ratio":1}', - ], - 'QueueId' => [ - 'description' => '关联的技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Simulation' => [ - 'description' => '是否为模拟活动，用于测试，普通客户无需关心。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'SimulationParameters' => [ - 'description' => '模拟活动参数，用于测试，普通客户无需关心。', - 'type' => 'string', - 'example' => '无', - ], - 'CasesUncompletedAfterAttempted' => [ - 'description' => '尝试呼叫过但未接通，且未达到最大尝试次数的联系人数量。即经过重试后呼叫成功的联系人。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CasesUncompletedAfterAttempt' => [ - 'type' => 'string', - ], - 'CompletionRate' => [ - 'type' => 'number', - 'format' => 'float', - ], - 'ContactFlowId' => [ - 'type' => 'string', ], ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"ActualEndTime\\": 1634008800000,\\n \\"ActualStartTime\\": 1634000460000,\\n \\"CasesAborted\\": 0,\\n \\"CasesUncompleted\\": 0,\\n \\"CasesConnected\\": 40,\\n \\"MaxAttemptCount\\": 1,\\n \\"MinAttemptInterval\\": 1,\\n \\"Name\\": \\"test-campaign\\",\\n \\"PlanedEndTime\\": 1634054400000,\\n \\"PlanedStartTime\\": 1633968000000,\\n \\"QueueName\\": \\"测试技能组\\",\\n \\"TotalCases\\": 100,\\n \\"State\\": \\"Completed\\",\\n \\"CampaignId\\": \\"6badb397-a8b5-40b6-21019d382a09\\",\\n \\"StrategyType\\": \\"PACING\\",\\n \\"StrategyParameters\\": \\"{\\\\\\"ratio\\\\\\":1}\\",\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"Simulation\\": false,\\n \\"SimulationParameters\\": \\"无\\",\\n \\"CasesUncompletedAfterAttempted\\": 1,\\n \\"CasesUncompletedAfterAttempt\\": \\"\\",\\n \\"CompletionRate\\": 0,\\n \\"ContactFlowId\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => '获取预测式外呼活动', - ], - 'GetCaseFileUploadUrl' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '获取预测式外呼名单列表', + 'changeSet' => [ + ['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCases'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE316\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"AbandonType\\": \\"NA\\",\\n \\"AttemptCount\\": 1,\\n \\"FailureReason\\": \\"无\\",\\n \\"PhoneNumber\\": \\"1888888****\\",\\n \\"State\\": \\"Connected\\",\\n \\"CaseId\\": \\"60ecb1a2-4480-4d01-bede-c5b7655bfadf\\",\\n \\"CustomVariables\\": \\"{\\\\\\"name\\\\\\":\\\\\\"yy\\\\\\",\\\\\\"客戶标签\\\\\\":\\\\\\"tag-yy\\\\\\"}\\",\\n \\"AbandonPhase\\": \\"Ringing\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 7CC6523B-0E51-1B62-8DA5-6A9831CAE316\\n 无\\n 200\\n \\n \\n NA\\n 1\\n 待删除\\n 无\\n 18888888888\\n Connected\\n 60ecb1a2-4480-4d01-bede-c5b7655bfadf\\n {\\"name\\":\\"yy\\",\\"客戶标签\\":\\"tag-yy\\"}\\n \\n 1\\n 100\\n 1\\n \\n OK\\n true\\n","errorExample":""}]', + ], + 'ListCategories' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'FileName', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => '预测式外呼活动名单文件名称，名称的格式要求为英文大小写字母，文件格式要求csv格式。', + 'description' => '类目类别。', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'case.csv', + 'required' => false, + 'enumValueTitles' => ['Ticket' => 'Ticket'], + 'example' => 'Ticket', ], ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => ['description' => '工单类目ID。指定类目ID，返回对应ID的子类目信息，不指定返回实例下类目的信息。', 'type' => 'string', 'required' => false, 'example' => '43c2671b-***-***-86d0-6bd187905cc8'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'ListCategoriesResponse', + 'description' => 'ListCategoriesResponse', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'Url' => [ - 'description' => '用于上传文件的预签名的OSS文件上传链接，有效期为一小时。', - 'type' => 'string', - 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****', - ], - 'CaseFileKey' => [ - 'description' => 'OSS文件的Key。', - 'type' => 'string', - 'example' => 'ccc-test/namelist.csv', - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', + 'Data' => ['description' => '数据。类目节点信息，JSON字符传形式。', 'type' => 'string', 'example' => '[{\\"categoryId\\":\\"43c2671b-8939-4223-****-6bd187905cc8\\",\\"childCategoryList\\":[{\\"categoryId\\":\\"120816ad-4392-4edf-****-6d053d5cfa5a\\",\\"childCategoryList\\":[],\\"deleted\\":0,\\"editor\\":\\"283277706217028904\\",\\"editorName\\":\\"283277706217028904\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":0,\\"level\\":2,\\"name\\":\\"客户反馈\\",\\"parentCategoryId\\":\\"43c2671b-8939-****-86d0-6bd187905cc8\\",\\"type\\":\\"Ticket\\"}],\\"deleted\\":0,\\"editor\\":\\"283277706217028904\\",\\"editorName\\":\\"283277706217028904\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":10,\\"level\\":1,\\"name\\":\\"测试一01类目\\",\\"type\\":\\"Ticket\\"},{\\"categoryId\\":\\"4948fcd0-2972-****-81c6-1a00927e1802\\",\\"childCategoryList\\":[],\\"deleted\\":0,\\"editor\\":\\"283277706217028904\\",\\"editorName\\":\\"283277706217028904\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":0,\\"level\\":1,\\"name\\":\\"生产环境验证\\",\\"type\\":\\"Ticket\\"},{\\"categoryId\\":\\"c426bd7f-9661-47c3-****-2508f1a32f66\\",\\"childCategoryList\\":[],\\"deleted\\":0,\\"editor\\":\\"269801834095770945\\",\\"editorName\\":\\"269801834095770945\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":4,\\"level\\":1,\\"name\\":\\"测试环境测试\\",\\"type\\":\\"Ticket\\"}]'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -23110,158 +13777,116 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"Url\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****\\",\\n \\"CaseFileKey\\": \\"ccc-test/namelist.csv\\"\\n },\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","type":"json"}]', - 'title' => '获取预测式外呼名单上传参数', - 'summary' => '调用GetCaseFileUploadUrl获取指定实例下预测式外呼名单文件的OSS上传参数，当使用文件导入的方式创建预测式外呼活动时，需要先调用此接口拿到文件上传参数，然后再调用CreateCampaign接口。', - ], - 'GetHistoricalCampaignReport' => [ - 'summary' => '调用GetHistoricalCampaignReport接口获取指定实例下指定ID对应的预测式外呼活动的历史数据报表。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"43c2671b-8939-4223-****-6bd187905cc8\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120816ad-4392-4edf-****-6d053d5cfa5a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"客户反馈\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parentCategoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"43c2671b-8939-****-86d0-6bd187905cc8\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"测试一01类目\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4948fcd0-2972-****-81c6-1a00927e1802\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"生产环境验证\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"c426bd7f-9661-47c3-****-2508f1a32f66\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"269801834095770945\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"269801834095770945\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":4,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"测试环境测试\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"}]\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取类目', + 'summary' => '使用ListCategories获取类目信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ListCommonTicketFields' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'CampaignId', - 'in' => 'query', - 'schema' => [ - 'title' => '活动ID', - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'required' => true, - 'example' => '4fc85829-f6fc-476e-9c0d-c350184e36f1', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'GetSchemaResponse', + 'description' => 'GetSchemaResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E3A847C1-9800-57DF-9172-2CDDC026388D', - ], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'CallsConnected' => [ - 'description' => '已接通数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'CallsDialed' => [ - 'description' => '已呼叫次数，包括重呼次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAbandoned' => [ - 'description' => '已呼损数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'ConnectedRate' => [ - 'description' => '已废弃，请参考AnswerRate。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.50', - ], - 'AnswerRate' => [ - 'description' => '接通率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.50', - ], - 'AbandonedRate' => [ - 'description' => '已废弃，请参考AbandonRate。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.10', - ], - 'AbandonRate' => [ - 'description' => '呼损率，计算方式为：已呼损数量/总数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.10', - ], - 'OccupancyRate' => [ - 'description' => '坐席利用率，计算方式为：（总通话时长+总话后处理时长）/总坐席在线时长，总坐席在线时长表示该活动关联的技能组下的所有坐席的在线时长。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.50', + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Id' => ['description' => 'Schema ID。', 'type' => 'string', 'example' => 'ticketing'], + 'Properties' => [ + 'description' => '字段列表。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['type' => 'string', 'description' => '显示名称。', 'example' => '姓名'], + 'Description' => ['type' => 'string', 'description' => '描述。', 'example' => 'name'], + 'Name' => ['type' => 'string', 'description' => '名称。', 'example' => 'name'], + 'DataType' => ['type' => 'string', 'example' => 'string', 'description' => '数据类型。'], + 'Pattern' => ['type' => 'string', 'example' => '^', 'description' => '正则表达式校验规则。'], + 'PatternErrorMessage' => ['type' => 'string', 'example' => '不是有效的email地址', 'description' => '正则表达式校验错误提示信息。'], + 'MinLength' => ['type' => 'integer', 'format' => 'int32', 'description' => '最小长度。', 'example' => '1'], + 'MaxLength' => ['type' => 'integer', 'format' => 'int32', 'description' => '最大长度。', 'example' => '10'], + 'Minimum' => ['type' => 'number', 'format' => 'double', 'description' => '数字最小值。', 'example' => '1'], + 'Maximum' => ['type' => 'number', 'format' => 'double', 'example' => '10', 'description' => '数字最大值。'], + 'Required' => ['type' => 'boolean', 'description' => '是否必填。', 'example' => 'false'], + 'System' => ['type' => 'boolean', 'example' => 'false', 'description' => '是否是系统字段。'], + 'Disabled' => ['type' => 'boolean', 'description' => '是否被禁用。', 'example' => 'false'], + 'Array' => ['type' => 'boolean', 'description' => '是否是数组。', 'example' => 'false'], + 'ReadOnly' => ['type' => 'boolean', 'description' => '是否只读。', 'example' => 'false'], + 'EditorType' => ['type' => 'string', 'description' => '编辑器类型。', 'example' => 'textbox'], + 'Attributes' => ['type' => 'string', 'description' => '扩展属性。', 'example' => '{}'."\n"], + 'DisplayOrder' => ['type' => 'integer', 'format' => 'int32', 'description' => '列表展示顺序。', 'example' => '1'], + 'CreatedTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '创建时间。', 'example' => '1703517780627'], + 'UpdatedTime' => ['type' => 'integer', 'format' => 'int64', 'example' => '1716211430928', 'description' => '更新时间。'], + 'Creator' => ['type' => 'string', 'description' => '创建者。', 'example' => 'creator@ccc-test'], + ], + 'description' => '字段。', + ], ], + 'CreatedTime' => ['description' => '创建时间。'."\n", 'type' => 'string', 'example' => '1703517780627'], + 'UpdatedTime' => ['description' => '上次修改的时间。', 'type' => 'string', 'example' => '1716211430928'], ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], + ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E3A847C1-9800-57DF-9172-2CDDC026388D\\",\\n \\"Data\\": {\\n \\"CallsConnected\\": 50,\\n \\"CallsDialed\\": 100,\\n \\"CallsAbandoned\\": 5,\\n \\"ConnectedRate\\": 0.5,\\n \\"AnswerRate\\": 0.5,\\n \\"AbandonedRate\\": 0.1,\\n \\"AbandonRate\\": 0.1,\\n \\"OccupancyRate\\": 0.5\\n }\\n}","type":"json"}]', - 'title' => '获取预测式外呼活动历史数据报表', - ], - 'GetRealtimeCampaignStats' => [ - 'summary' => '调用GetRealtimeCampaignStats获取指定实例下指定ID对应的预测式外呼活动的实时坐席状态数据。', - 'methods' => [ - 'get', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Id\\": \\"ticketing\\",\\n \\"Properties\\": {\\n \\"key\\": {\\n \\"DisplayName\\": \\"姓名\\",\\n \\"Description\\": \\"name\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 10,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\\\n\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1703517780627,\\n \\"UpdatedTime\\": 1716211430928,\\n \\"Creator\\": \\"creator@ccc-test\\"\\n }\\n },\\n \\"CreatedTime\\": \\"1703517780627\\",\\n \\"UpdatedTime\\": \\"1716211430928\\"\\n },\\n \\"RequestId\\": \\"30C7D235-DDCF-4C7F-A462-5E2598252C2B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取工单字段定义', + 'summary' => '使用ListCommonTicketFields获取实例下定义的工单字段类型。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ListConfigItems' => [ + 'summary' => '调用ListConfigItems获取指定实例下的配置信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23270,149 +13895,108 @@ 'BearerToken' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTMAX45'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test'."\n", - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'QueueId', + 'name' => 'ObjectId', + 'in' => 'query', + 'schema' => ['description' => '配置信息所属的对象的ID，可以是阿里云主账号ID、实例ID、技能组ID、坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'ObjectType', 'in' => 'query', 'schema' => [ - 'title' => '活动ID', - 'description' => '预测式外呼活动ID。'."\n" - ."\n", + 'description' => ' 配置信息所属对象的类型。', 'type' => 'string', 'required' => true, - 'example' => 'skillgroup@ccc-test'."\n", + 'docRequired' => true, + 'enumValueTitles' => ['INSTANCE' => '实例级别的配置', 'USER' => '座席自身的配置', 'SKILL_GROUP' => '技能组级别的配置', 'ALIYUN_UID' => '主账号级别的配置'], + 'example' => 'INSTANCE', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '42970829-E2C8-515A-8F42-5A6B59F852A7', + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + 'description' => '', ], 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'LoggedInAgents' => [ - 'description' => '在线坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'ReadyAgents' => [ - 'description' => '空闲坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'BreakingAgents' => [ - 'description' => '小休坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TalkingAgents' => [ - 'description' => '通话中坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'WorkingAgents' => [ - 'description' => '话后处理坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Caps' => [ - 'description' => '每秒并发呼叫量，并发指同时呼叫。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'TotalAgents' => [ - 'description' => '所有坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'OutboundScenarioReadyAgents' => [ - 'description' => '处于仅外呼模式且在空闲状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OutboundScenarioBreakingAgents' => [ - 'description' => '处于仅外呼模式且在小休状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OutboundScenarioTalkingAgents' => [ - 'description' => '处于仅外呼模式且在通话中状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OutboundScenarioWorkingAgents' => [ - 'description' => '处于仅外呼模式且在话后处理状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'description' => '配置项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配置项。', + 'type' => 'object', + 'properties' => [ + 'ObjectId' => ['description' => '配置信息所属的对象的ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Value' => ['description' => '配置项的值。', 'type' => 'string', 'example' => '100'], + 'ObjectType' => ['description' => '配置信息所属对象的类型。', 'type' => 'string', 'example' => 'INSTANCE'], + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'ccc-test'], + 'Name' => [ + 'description' => '配置项名称，配置项名称包含系统定义和客户自定义两种，系统定义包括是否允许坐席挂机、是否自动接听、久振未接时长等，这部分配置项名称是固定的，值可以由客户自定义，除此之外，配置项名称也支持客户自定义，客户可以根据需要添加配置项。', + 'type' => 'string', + 'enumValueTitles' => ['AllowAudioDownload' => '是否允许坐席下载录音，取值：0（不允许）、1（允许）。', 'RecordingStorageSetting' => '实例录音存储配置。', 'AllowChooseSignedSkillGroup' => '坐席上线前是否手动选择签入的技能组，取值：0（自动签入所属的全部技能组）、1（手动选择签入的技能组）。', 'AgentRingingTimeoutSeconds' => '坐席久振未接超时时长配置，取值范围为5-90，单位秒。', 'ShowCalledID' => '坐席来电显示，取值：-1（隐藏全部来电号码）、0（隐藏部分来电号码）、1（显示完整来电号码）。', 'ShowCalleeID' => '坐席外呼显示，取值：-1（隐藏全部外呼号码）、0（隐藏部分外呼号码）、1（显示完整外呼号码）。', 'AllowHangup' => '坐席呼入挂机方式，取值：0（不允许坐席挂机）、1（允许坐席挂机）。', 'AutoAnswerCall' => '坐席接听来电方式，取值：-1（手动接听）、n（振铃n秒后接听）。'], + 'example' => 'config-item', + ], ], ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"42970829-E2C8-515A-8F42-5A6B59F852A7\\",\\n \\"Data\\": {\\n \\"LoggedInAgents\\": 10,\\n \\"ReadyAgents\\": 3,\\n \\"BreakingAgents\\": 1,\\n \\"TalkingAgents\\": 4,\\n \\"WorkingAgents\\": 2,\\n \\"Caps\\": 5,\\n \\"TotalAgents\\": 10,\\n \\"OutboundScenarioReadyAgents\\": 1,\\n \\"OutboundScenarioBreakingAgents\\": 1,\\n \\"OutboundScenarioTalkingAgents\\": 1,\\n \\"OutboundScenarioWorkingAgents\\": 1\\n }\\n}","type":"json"}]', - 'title' => '获取预测式外呼活动实时坐席状态', - ], - 'ListAttempts' => [ - 'summary' => '调用ListAttempts获取指定实例下指定预测式外呼活动的联系人拨打记录列表。', - 'methods' => [ - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], + 403 => [ + ['errorCode' => 'Permission.Unauthorized', 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', 'description' => '您无权执行此操作。 必须具有指定权限。'], + ], + [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '获取配置项列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConfigItems'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": [\\n {\\n \\"ObjectId\\": \\"ccc-test\\",\\n \\"Value\\": \\"100\\",\\n \\"ObjectType\\": \\"INSTANCE\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"config-item\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n 1\\n INSTANCE\\n ccc-test\\n ccc-test\\n test-item\\n\\nOK","errorExample":""}]', + ], + 'ListContactFlows' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23423,356 +14007,139 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'CampaignId', - 'in' => 'query', - 'schema' => [ - 'title' => '活动ID', - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'required' => true, - 'example' => '6badb397-a8b5-40b6-21019d382a09', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '开始时间', - 'description' => '开始时间，非必填，不填默认为预测式外呼活动的开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1634115688291', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'title' => '结束时间', - 'description' => '结束时间，非必填，不填默认为预测式外呼活动的结束时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1634115698291', - ], - ], - [ - 'name' => 'QueueId', - 'in' => 'query', - 'schema' => [ - 'title' => '队列ID', - 'description' => '按技能组ID过滤，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'skillgroup@ccc-test', - ], - ], - [ - 'name' => 'CaseId', - 'in' => 'query', - 'schema' => [ - 'title' => 'CaseID', - 'description' => '系统生成的联系人ID，客户无需关心。', - 'type' => 'string', - 'required' => true, - 'example' => '60ecb1a2-4480-4d01-bede-c5b7655bfadf', - ], - ], - [ - 'name' => 'AttemptId', - 'in' => 'query', - 'schema' => [ - 'title' => '记录ID', - 'description' => '呼叫记录ID，和通话ID取值一样。', - 'type' => 'string', - 'required' => false, - 'example' => 'job-16976964500325****', - ], - ], - [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'title' => '话务ID', - 'description' => '按通话ID过滤，非必填，默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => 'job-16976964500325****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'AgentId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID', - 'description' => '按坐席ID过滤，非必填，默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'Caller', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '主叫', - 'description' => '按主叫号码过滤，非必填，默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => '05711234****', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'Callee', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'title' => '被叫', - 'description' => '按被叫号码过滤，非必填，默认为空。', + 'description' => '按IVR流程类型过滤，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, - 'example' => '1888888****', + 'enumValueTitles' => ['SURVEY_FLOW' => '满意度流程', 'SUB_FLOW' => '子流程', 'MAIN_FLOW' => '主流程'], + 'example' => 'MAIN_FLOW', ], ], [ - 'name' => 'PageNumber', + 'name' => 'SortOrder', 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'description' => '分页页码，大小取决于PageNumber和PageSize的乘积，两个参数相乘不能大于10000。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '排序方向。取值范围：'."\n" + .'- **ASC**：升序'."\n" + .'- **DESC**（默认值）：降序', 'type' => 'string', 'required' => false, 'example' => 'DESC'], ], [ - 'name' => 'PageSize', + 'name' => 'OrderByField', 'in' => 'query', - 'schema' => [ - 'title' => '页大小', - 'description' => '分页大小，大小取决于PageNumber和PageSize的乘积，两个参数相乘不能大于10000。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '100', - ], + 'schema' => ['description' => '排序字段。', 'type' => 'string', 'required' => false, 'example' => 'updatedTime'], ], [ - 'name' => 'Criteria', + 'name' => 'SearchPattern', 'in' => 'query', - 'schema' => [ - 'description' => '扩展查询条件。JSON格式，目前支持caseIds，支持caseIds批量查询。', - 'type' => 'string', - 'required' => false, - 'example' => '{"caseIds":["964f05a7-fc15-4a05-93a6-cd7421c4459e","5e2d508b-0df6-4077-8099-d3fff51ea6d0","da037029-8c83-4270-a90e-e7734be76af6"]}', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '分页页码，大小取决于PageNumber和PageSize的乘积，两个参数相乘不能大于10000。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，大小取决于PageNumber和PageSize的乘积，两个参数相乘不能大于10000。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + 'PageNumber' => ['description' => '分页序号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'List' => [ - 'description' => '联系人拨打记录列表。', + 'description' => '联系流列表。'."\n" + ."\n", 'type' => 'array', 'items' => [ - 'description' => '联系人拨打记录。', 'type' => 'object', 'properties' => [ - 'AttemptId' => [ - 'description' => '呼叫ID。', - 'type' => 'string', - 'example' => 'job-1704342174816****', - ], - 'ContactId' => [ - 'description' => '通话ID', - 'type' => 'string', - 'example' => 'job-1704342174816****', - ], - 'CaseId' => [ - 'description' => '系统生成的联系人ID，客户无需关心。', - 'type' => 'string', - 'example' => '21d194a7-60b7-4824-932b-48ed03a83704', - ], - 'CampaignId' => [ - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'example' => '083046e3-5822-4cda-9b84-04f2a02eb605', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'QueueId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Caller' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'example' => '05711234****', - ], - 'Callee' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'example' => '1888888****', - ], - 'AgentId' => [ - 'description' => '坐席ID。', + 'Type' => [ + 'description' => 'IVR联系流类型。', 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'DialTime' => [ - 'description' => '发起拨号的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1634196283974', - ], - 'DialDuration' => [ - 'description' => '拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2734', - ], - 'CustomerEstablishedTime' => [ - 'description' => '客户接通的时刻，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1634196286708', - ], - 'CustomerReleasedTime' => [ - 'description' => '客户挂机时刻，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1634196317888', - ], - 'EnterIvrTime' => [ - 'description' => '转接进入IVR时刻，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1634196286740', - ], - 'IvrDuration' => [ - 'description' => 'IVR中时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1049', - ], - 'EnqueueTime' => [ - 'description' => '进入队列时刻，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1634196287789', - ], - 'QueueDuration' => [ - 'description' => '排队时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80', - ], - 'AssignAgentTime' => [ - 'description' => '分配坐席时刻，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1634196287869', - ], - 'AgentRingDuration' => [ - 'description' => '坐席振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23', + 'enumValueTitles' => ['SURVEY_FLOW' => '满意度流程', 'SUB_FLOW' => '子流程', 'MAIN_FLOW' => '主流程'], + 'example' => 'MAIN_FLOW', ], - 'AgentEstablishedTime' => [ - 'description' => '坐席接听时刻，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1632883592732', + 'Definition' => ['description' => 'IVR的内容，由后台解析，客户无需关心。', 'type' => 'string', 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好，欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}'], + 'DraftId' => ['description' => '草稿ID，当IVR流程处于未发布状态时返回此字段。', 'type' => 'string', 'example' => 'db07c0bb-6b1f-47d2-b37e-2451c617562d'], + 'Description' => ['description' => '版本描述。', 'type' => 'string', 'example' => '1.0'], + 'UpdatedTime' => ['description' => '上次修改的时间。', 'type' => 'string', 'example' => '2021-03-08 15:34:49.0'], + 'Editor' => ['description' => '此草稿的当前编辑者的坐席登录名。', 'type' => 'string', 'example' => 'ccc-test'], + 'Published' => ['description' => '是否发布过。', 'type' => 'boolean', 'example' => 'true'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Name' => ['description' => 'IVR联系流名称。', 'type' => 'string', 'example' => '默认流程'], + 'ContactFlowId' => ['description' => 'IVR联系流ID。', 'type' => 'string', 'example' => '78128960-bb00-4ddc-8e82-923a8c5bd22d'], + 'CreatedTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-03-05 17:35:45.0'], + 'NumberList' => [ + 'description' => 'IVR联系流绑定的号码列表。', + 'type' => 'array', + 'items' => ['description' => '号码', 'type' => 'string', 'example' => '400289****'], ], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"List\\": [\\n {\\n \\"AttemptId\\": \\"job-1704342174816****\\",\\n \\"ContactId\\": \\"job-1704342174816****\\",\\n \\"CaseId\\": \\"21d194a7-60b7-4824-932b-48ed03a83704\\",\\n \\"CampaignId\\": \\"083046e3-5822-4cda-9b84-04f2a02eb605\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"Caller\\": \\"05711234****\\",\\n \\"Callee\\": \\"1888888****\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"DialTime\\": 1634196283974,\\n \\"DialDuration\\": 2734,\\n \\"CustomerEstablishedTime\\": 1634196286708,\\n \\"CustomerReleasedTime\\": 1634196317888,\\n \\"EnterIvrTime\\": 1634196286740,\\n \\"IvrDuration\\": 1049,\\n \\"EnqueueTime\\": 1634196287789,\\n \\"QueueDuration\\": 80,\\n \\"AssignAgentTime\\": 1634196287869,\\n \\"AgentRingDuration\\": 23,\\n \\"AgentEstablishedTime\\": 1632883592732\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取联系人拨打记录列表', - ], - 'ListCampaigns' => [ - 'summary' => '调用ListCampaigns获取指定实例下的预测式外呼活动列表。', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '获取联系流列表', + 'summary' => '调用ListContactFlows获取指定实例下的IVR联系流列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-06-18T03:18:59.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListContactFlows'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Type\\": \\"MAIN_FLOW\\",\\n \\"Definition\\": \\"{\\\\\\"activities\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"INCOMING_CALL\\\\\\",\\\\\\"id\\\\\\":\\\\\\"e98f0d47\\\\\\",\\\\\\"name\\\\\\":\\\\\\"开始\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":263,\\\\\\"y\\\\\\":164}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"41f7dbd0\\\\\\"}],\\\\\\"nodeIndex\\\\\\":0},{\\\\\\"type\\\\\\":\\\\\\"HANGUP\\\\\\",\\\\\\"id\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"挂机\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":765,\\\\\\"y\\\\\\":185}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":null}],\\\\\\"nodeIndex\\\\\\":999},{\\\\\\"type\\\\\\":\\\\\\"PLAY_SAY\\\\\\",\\\\\\"id\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"放音\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"say\\\\\\":\\\\\\"您好，欢迎来到云联络中心。\\\\\\",\\\\\\"audioResourceId\\\\\\":\\\\\\"\\\\\\",\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":485.5,\\\\\\"y\\\\\\":153.5},\\\\\\"audioType\\\\\\":\\\\\\"tts\\\\\\",\\\\\\"audioInterrupt\\\\\\":false},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"e1af4f1f\\\\\\"}],\\\\\\"nodeIndex\\\\\\":1}],\\\\\\"description\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"DraftId\\": \\"db07c0bb-6b1f-47d2-b37e-2451c617562d\\",\\n \\"Description\\": \\"1.0\\",\\n \\"UpdatedTime\\": \\"2021-03-08 15:34:49.0\\",\\n \\"Editor\\": \\"ccc-test\\",\\n \\"Published\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"默认流程\\",\\n \\"ContactFlowId\\": \\"78128960-bb00-4ddc-8e82-923a8c5bd22d\\",\\n \\"CreatedTime\\": \\"2021-03-05 17:35:45.0\\",\\n \\"NumberList\\": [\\n \\"400289****\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n MAIN_FLOW\\n 1.0\\n 2021-03-05 17:35:45.0\\n ccc-test\\n 78128960-bb00-4ddc-8e82-923a8c5bd22d\\n {\\"activities\\":[{\\"type\\":\\"INCOMING_CALL\\",\\"id\\":\\"e98f0d47\\",\\"name\\":\\"开始\\",\\"properties\\":{\\"position\\":{\\"x\\":263,\\"y\\":164}},\\"events\\":[{\\"event\\":\\"complete\\",\\"next\\":\\"2d3ad2c2\\",\\"edgeId\\":\\"41f7dbd0\\"}],\\"nodeIndex\\":0},{\\"type\\":\\"HANGUP\\",\\"id\\":\\"bd4f37e2\\",\\"name\\":\\"挂机\\",\\"properties\\":{\\"position\\":{\\"x\\":765,\\"y\\":185}},\\"events\\":[{\\"event\\":\\"complete\\",\\"next\\":null}],\\"nodeIndex\\":999},{\\"type\\":\\"PLAY_SAY\\",\\"id\\":\\"2d3ad2c2\\",\\"name\\":\\"放音\\",\\"properties\\":{\\"say\\":\\"您好，欢迎来到阿里云呼叫中心。\\",\\"audioResourceId\\":\\"\\",\\"position\\":{\\"x\\":485.5,\\"y\\":153.5},\\"audioType\\":\\"tts\\",\\"audioInterrupt\\":false},\\"events\\":[{\\"event\\":\\"complete\\",\\"next\\":\\"bd4f37e2\\",\\"edgeId\\":\\"e1af4f1f\\"}],\\"nodeIndex\\":1}],\\"description\\":\\"\\"}\\n true\\n 2021-03-08 15:34:49.0\\n db07c0bb-6b1f-47d2-b37e-2451c617562d\\n ccc-test\\n 测试IVR\\n [\\"400xxxx289\\"]\\n \\n\\nOK","errorExample":""}]', + ], + 'ListCustomCallTagging' => [ + 'summary' => '调用ListCustomCallTagging获取指定实例下的呼入号码标记列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23782,328 +14149,126 @@ ], ], 'operationType' => 'read', - 'deprecated' => false, + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'State', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '按预测式外呼活动状态过滤，非必填，默认为空。'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Draft' => '草稿', - 'Completed' => '已完成', - 'Executing' => '执行中', - 'Pending' => '待执行', - 'Aborted' => '已终止', - 'Paused' => 'Paused', - ], - 'example' => 'Draft', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'Name', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '按预测式外呼活动名称过滤，不支持模糊匹配，非必填，默认为空，表示不过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-campaign', - ], + 'schema' => ['description' => '分页大小，范围1-100。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'PlanedStartTimeFrom', + 'name' => 'SearchPattern', 'in' => 'query', - 'schema' => [ - 'description' => '外呼活动计划开始时间，非必填，默认查询所有时间范围。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-14 00:00:00', - ], + 'schema' => ['description' => '根据号码或描述进行模糊匹配，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1312121****'], ], [ - 'name' => 'PlanedStartTimeTo', + 'name' => 'CallTagNameList', 'in' => 'query', - 'schema' => [ - 'description' => '外呼活动计划结束时间，非必填，默认查询所有时间范围。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-14 20:59:59', - ], + 'schema' => ['description' => '按号码标签名称列表过滤，非必填，默认为空，表示不过滤。格式为JSON数组的字符串，数组元素是号码标签名称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["TagA"]'], ], - [ - 'name' => 'ActualStartTimeFrom', - 'in' => 'query', - 'schema' => [ - 'description' => '外呼活动实际开始时间，非必填，默认查询所有时间范围。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-14 20:59:59', - ], - ], - [ - 'name' => 'ActualStartTimeTo', - 'in' => 'query', - 'schema' => [ - 'description' => '外呼活动实际结束时间，非必填，默认查询所有时间范围。', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-14 20:59:59', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'QueueId', - 'in' => 'query', - 'schema' => [ - 'description' => '按技能组ID过滤，非必填，默认为空，表示不过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'skillgroup@ccc-test', - ], - ], - ], - 'responses' => [ - 200 => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], 'Data' => [ - 'description' => '数据。', + 'description' => '数据。'."\n", 'type' => 'object', 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'List' => [ - 'description' => '预测式外呼活动列表。', + 'description' => '呼入号码标记列表。', 'type' => 'array', 'items' => [ - 'description' => '预测式外呼活动信息。', + 'description' => '呼入号码标记信息。', 'type' => 'object', 'properties' => [ - 'ActualEndTime' => [ - 'description' => '预测式外呼活动实际结束时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1634008800000', - ], - 'ActualStartTime' => [ - 'description' => '预测式外呼活动实际开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1634000460000', - ], - 'CasesAborted' => [ - 'description' => '预测式外呼活动的止呼数量，止呼指取消呼叫联系人。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CasesUncompleted' => [ - 'description' => '预测式外呼活动的未完成数量，未完成指未接通且未达到最大重试次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CasesConnected' => [ - 'description' => '预测式外呼活动的接通数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '40', - ], - 'MaxAttemptCount' => [ - 'description' => '预测式外呼活动的最大尝试次数，表示当活动的号码呼叫失败时，最多重呼几次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MinAttemptInterval' => [ - 'description' => '预测式外呼活动的最小重呼间隔，表示失败重呼时的最小间隔，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'description' => '预测式外呼活动名称。', - 'type' => 'string', - 'example' => 'test-campaign', - ], - 'PlanedEndTime' => [ - 'description' => '预测式外呼活动计划结束时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1634054400000', - ], - 'PlanedStartTime' => [ - 'description' => '预测式外呼活动计划开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1633968000000', - ], - 'QueueName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => '测试技能组', - ], - 'TotalCases' => [ - 'description' => '号码总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'State' => [ - 'title' => 'state', - 'description' => '预测式外呼活动状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Draft' => '草稿', - 'Completed' => '已完成', - 'Executing' => '执行中', - 'Pending' => '待执行', - 'Aborted' => '已终止', - 'Paused' => '已暂停', - ], - 'example' => 'Completed', - ], - 'CampaignId' => [ - 'title' => 'id', - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'example' => '6badb397-a8b5-40b6-21019d382a09', - ], - 'StrategyType' => [ - 'description' => '预测式外呼活动的策略模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'PACING' => '固定比例外呼，外呼数量=空闲坐席*比例。', - 'PID' => '系统基于PID控制策略，自动调整外呼电话数量。', + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Number' => ['description' => '呼入号码标记的号码。', 'type' => 'string', 'example' => '1312121****'], + 'Description' => ['description' => '呼入号码标记的描述。', 'type' => 'string', 'example' => '王先生'], + 'Creator' => ['description' => '创建者。', 'type' => 'string', 'example' => 'agent'], + 'UpdateTime' => ['description' => '最后一次更新时间。', 'type' => 'string', 'example' => '2020-07-05 00:00:00.0'], + 'CallTagList' => [ + 'description' => '号码标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '号码标签信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'TagName' => ['description' => '号码标签名称。', 'type' => 'string', 'example' => 'TagA'], + ], ], - 'example' => 'PACING', - ], - 'StrategyParameters' => [ - 'description' => '预测式外呼活动的策略参数，PID策略下的格式参数示例：{"abandonRate":"5","historicalConnectedRate":"35"}，PACING策略下的格式参数示例：{"ratio":1}。abandonRate表示期望呼损率，historicalConnectedRate表示历史参考接通率，ratio表示固定外呼比例。', - 'type' => 'string', - 'example' => '{"ratio":1}', - ], - 'QueueId' => [ - 'description' => '关联的技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Simulation' => [ - 'description' => '是否为模拟活动。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CompletionRate' => [ - 'description' => '完成率，参数已废弃，可以使用(TotalCases-CasesUnCompleted) / TotalCases计算得出', - 'type' => 'number', - 'format' => 'float', - 'example' => '无', - ], - 'ContactFlowId' => [ - 'type' => 'string', ], ], ], ], - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], ], ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"ActualEndTime\\": 1634008800000,\\n \\"ActualStartTime\\": 1634000460000,\\n \\"CasesAborted\\": 0,\\n \\"CasesUncompleted\\": 0,\\n \\"CasesConnected\\": 40,\\n \\"MaxAttemptCount\\": 1,\\n \\"MinAttemptInterval\\": 1,\\n \\"Name\\": \\"test-campaign\\",\\n \\"PlanedEndTime\\": 1634054400000,\\n \\"PlanedStartTime\\": 1633968000000,\\n \\"QueueName\\": \\"测试技能组\\",\\n \\"TotalCases\\": 100,\\n \\"State\\": \\"Completed\\",\\n \\"CampaignId\\": \\"6badb397-a8b5-40b6-21019d382a09\\",\\n \\"StrategyType\\": \\"PACING\\",\\n \\"StrategyParameters\\": \\"{\\\\\\"ratio\\\\\\":1}\\",\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"Simulation\\": false,\\n \\"CompletionRate\\": 0,\\n \\"ContactFlowId\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\n 无\\n 200\\n \\n \\n 1634008800000\\n 1634000460000\\n 0\\n 0\\n 40\\n 100\\n 1\\n 1\\n test-campalgn\\n 1634054400000\\n 1633968000000\\n 默认技能组\\n 100\\n Completed\\n 6badb397-a8b5-40b6-21019d382a09\\n PACING\\n {\\"ratio\\":1}\\n skg-default@report-test-2\\n false\\n \\n 1\\n 10\\n 1\\n \\n OK\\n true\\n","errorExample":""}]', - 'title' => '获取预测式外呼活动列表', - ], - 'ListCampaignTrendingReport' => [ - 'summary' => '获取指定实例下指定ID对应的预测式外呼活动的趋势报表。', - 'methods' => [ - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['CCC::2020-07-01::ListCustomCallTaggings'], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '获取呼入号码标记列表', + 'changeSet' => [ + ['createdAt' => '2024-01-29T09:14:13.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-02-24T14:31:19.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomCallTagging'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Number\\": \\"1312121****\\",\\n \\"Description\\": \\"王先生\\",\\n \\"Creator\\": \\"agent\\",\\n \\"UpdateTime\\": \\"2020-07-05 00:00:00.0\\",\\n \\"CallTagList\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TagName\\": \\"TagA\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nBA03159C-E808-4FF1-B27E-A61B6E888D7F\\n200\\n\\n 1\\n 10\\n 1\\n \\n TagA\\n 083xxxx0011\\n ccc-test\\n 2020-07-05 00:00:00.0\\n user-test\\n \\n TagA\\n ccc-test\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'ListDevices' => [ + 'summary' => '获取指定实例下指定坐席的设备列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -24114,276 +14279,130 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'CampaignId', - 'in' => 'query', - 'schema' => [ - 'title' => '活动ID', - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'required' => true, - 'example' => '6badb397-a8b5-40b6-21019d382a09', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '开始时间', - 'description' => '开始时间，非必填，默认为预测式外呼活动的开始时间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2021-10-14 00:00:00', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'EndTime', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'title' => '结束时间', - 'description' => '结束时间，非必填，默认为预测式外呼活动的结束时间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2021-10-14 20:59:59', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], 'Data' => [ - 'description' => '统计打点数据列表。', + 'description' => '设备列表。', 'type' => 'array', 'items' => [ - 'description' => '统计打点数据。', + 'description' => '设备信息。', 'type' => 'object', 'properties' => [ - 'Datetime' => [ - 'description' => '分段统计的打点时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1634037840000', - ], - 'Concurrency' => [ - 'description' => '呼叫并发量，即同时在外呼的通话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TalkAgents' => [ - 'description' => '已废弃，请参考TalkAgents。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ReadyAgents' => [ - 'description' => '空闲坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'WorkAgents' => [ - 'description' => '已废弃，请参考WorkingAgents。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LoggedInAgents' => [ - 'description' => '上线的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'BreakAgents' => [ - 'description' => '小休坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'StatsTime' => [ - 'description' => '统计打点时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1604639129000', - ], - 'TalkingAgents' => [ - 'description' => '处于通话状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'WorkingAgents' => [ - 'description' => '处于话后处理状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'BreakingAgents' => [ - 'description' => '处于小休状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OutboundScenarioReadyAgents' => [ - 'description' => '处于仅外呼模式且在空闲状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OutboundScenarioBreakingAgents' => [ - 'description' => '处于仅外呼模式且在小休状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'OutboundScenarioTalkingAgents' => [ - 'description' => '处于仅外呼模式且在通话中状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OutboundScenarioWorkingAgents' => [ - 'description' => '处于仅外呼模式且在话后处理状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Expires' => ['description' => '设备注册过期时间，格式为Unix时间戳，单位毫秒，如果设备过期未重新注册，则会导致设备离线。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609118499750'], + 'Contact' => ['description' => '设备地址信息。', 'type' => 'string', 'example' => 'sip:8032****@33.89.XX.XX:64189;transport=tcp;registering_acc=18_134_23_4'], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'CallId' => ['description' => '设备发起的注册信令中的Call ID。', 'type' => 'string', 'example' => 'd7b818c3-8d3a-732f-bc9e-1782wa16****'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'DeviceType' => ['description' => '设备类型', 'type' => 'string', 'example' => 'CHAT'], ], ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\",\\n \\"Data\\": [\\n {\\n \\"Datetime\\": 1634037840000,\\n \\"Concurrency\\": 1,\\n \\"TalkAgents\\": 0,\\n \\"ReadyAgents\\": 2,\\n \\"WorkAgents\\": 0,\\n \\"LoggedInAgents\\": 2,\\n \\"BreakAgents\\": 0,\\n \\"StatsTime\\": 1604639129000,\\n \\"TalkingAgents\\": 4,\\n \\"WorkingAgents\\": 0,\\n \\"BreakingAgents\\": 1,\\n \\"OutboundScenarioReadyAgents\\": 1,\\n \\"OutboundScenarioBreakingAgents\\": 2,\\n \\"OutboundScenarioTalkingAgents\\": 1,\\n \\"OutboundScenarioWorkingAgents\\": 2\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 200\\n 无\\n 6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\n \\n 1634037840000\\n 1\\n 0\\n 2\\n 0\\n 2\\n 0\\n \\n","errorExample":""}]', - 'title' => '获取预测式外呼活动趋势报表', - ], - 'ListCases' => [ - 'summary' => '调用ListCases获取指定实例下指定ID对应的预测式外呼活动的外呼名单执行详情列表。', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], + 403 => [ + ['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => '您无权访问这些用户。'], + ], + [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '获取设备列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDevices'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": [\\n {\\n \\"Extension\\": \\"8032****\\",\\n \\"Expires\\": 1609118499750,\\n \\"Contact\\": \\"sip:8032****@33.89.XX.XX:64189;transport=tcp;registering_acc=18_134_23_4\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"CallId\\": \\"d7b818c3-8d3a-732f-bc9e-1782wa16****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"DeviceType\\": \\"CHAT\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n 80326034\\n ccc-test\\n user-test@ccc-test\\n BS-2020-09-01-11:11:11.888-192_168_12_123\\n 561d53be3fa11c4700a40ce8592ef880@0:0:0:0:0:0:0:0\\n 1609118499750\\n sip:80326034@33.89.9.338:64189;transport=tcp;registering_acc=18_134_23_4\\n\\nOK","errorExample":""}]', + ], + 'ListDoNotCallNumbers' => [ + 'summary' => '获取指定实例下指定搜索条件过滤后的禁止外呼号码列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'CampaignId', - 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'required' => true, - 'example' => '6badb397-a8b5-40b6-21019d382a09', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PhoneNumber', + 'name' => 'SearchPattern', 'in' => 'query', - 'schema' => [ - 'description' => '按电话号码过滤，不支持模糊匹配，非必填，默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => '无', - ], + 'schema' => ['description' => '根据电话号码或备注进行模糊匹配，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RemarkA'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'State', + 'name' => 'Scope', 'in' => 'query', 'schema' => [ - 'description' => 'Pending（待拨打） '."\n" - .'Executing（拨打中） '."\n" - .'Connected（联系成功） '."\n" - .'Failed（联系失败） '."\n" - .'Aborted（止呼, 取消呼叫） '."\n" - .'Forbidden（规则禁止呼叫，比如黑名单）', + 'description' => '应用范围，包括SYSTEM和INSTANCE，分别对应系统级禁止外呼和客户自定义禁止外呼，SYSTEM是关联实例所属的阿里云主账号的，INSTANCE只和当前实例关联，非必填，默认值INSTANCE。', 'type' => 'string', 'required' => false, - 'example' => 'Pending', + 'enumValueTitles' => ['SYSTEM' => '系统级禁止外呼配置', 'INSTANCE' => '实例级禁止外呼配置'], + 'example' => 'INSTANCE', ], ], ], @@ -24392,262 +14411,243 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE316', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], 'Data' => [ - 'title' => 'data', 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'List' => [ - 'description' => '联系人名单执行详情列表。', + 'description' => '禁止外呼号码列表。', 'type' => 'array', 'items' => [ - 'description' => '联系人名单执行详情。', + 'description' => '禁止外呼号码信息。', 'type' => 'object', 'properties' => [ - 'AbandonType' => [ - 'description' => '通话被放弃的类型，即未成功接通的原因。', - 'type' => 'string', - 'enumValueTitles' => [ - 'NA' => '未放弃', - 'IVR' => 'IVR交互阶段', - 'Ringing' => '坐席振铃阶段', - 'Queuing' => '排队阶段', - ], - 'example' => 'NA', - ], - 'AttemptCount' => [ - 'description' => '已尝试次数，对该联系人的总呼叫次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'FailureReason' => [ - 'description' => '外呼失败原因。', - 'type' => 'string', - 'enumValueTitles' => [ - 'AbandonedInQueue' => '排队放弃', - 'AbandonedInRing' => '振铃放弃', - 'AbandonedInIVR' => 'IVR放弃', - 'NoAnswer' => '客户未接', - 'QueuingTimeout' => '排队超时', - 'Reject' => '客户拒接', - 'Voicemail' => '转语音邮箱', - 'QueuingFailed' => '转人工失败', - 'QueuingOverflow' => '排队溢出', - 'AbandonedInVoiceNavigator' => '智能导航中放弃', - 'IVRException' => 'IVR异常', - 'ForwardToOutsideNumber' => '转外线', - ], - 'example' => '无', - ], - 'PhoneNumber' => [ - 'description' => '电话号码。', - 'type' => 'string', - 'example' => '1888888****', - ], - 'State' => [ - 'description' => '状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Connected' => '联系成功', - 'Failed' => '联系失败', - 'Executing' => '拨打中', - 'Pending' => '待拨打', - 'Aborted' => '已止呼', - ], - 'example' => 'Connected', - ], - 'CaseId' => [ - 'description' => '系统生成的联系人ID，客户无需关心。', - 'type' => 'string', - 'example' => '60ecb1a2-4480-4d01-bede-c5b7655bfadf', - ], - 'CustomVariables' => [ - 'description' => '客户自定义变量，格式为JSON对象，对象最多包含10个属性，每个属性的名称和值均由客户自定义，客户在创建预测式外呼活动时可以设置。', - 'type' => 'string', - 'example' => '{"name":"yy","客戶标签":"tag-yy"}', - ], - 'AbandonPhase' => [ - 'description' => '通话被放弃的阶段。 '."\n" - .' - IVR（IVR交互阶段） '."\n" - .' - Queuing（排队阶段） '."\n" - .' - Ringing（坐席振铃阶段）', + 'Number' => ['description' => '电话号码。', 'type' => 'string', 'example' => '1900000****'], + 'Scope' => [ + 'description' => '应用范围。', 'type' => 'string', - 'example' => 'Ringing', + 'enumValueTitles' => ['SYSTEM' => '系统级禁止外呼配置', 'INSTANCE' => '实例级禁止外呼配置'], + 'example' => 'INSTANCE', ], + 'Remark' => ['description' => '备注。', 'type' => 'string', 'example' => '测试'], + 'CreateTime' => ['description' => '禁止外呼号码配置的创建时间，格式为Unix时间戳，单位毫秒。（废弃）', 'type' => 'integer', 'format' => 'int64', 'example' => '1626962425000'], + 'Creator' => ['description' => '创建人，创建该记录的坐席的坐席登录名。', 'type' => 'string', 'example' => 'agent'], + 'CreatedTime' => ['description' => '禁止外呼号码配置的创建时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000'], ], ], ], ], ], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE316\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"AbandonType\\": \\"NA\\",\\n \\"AttemptCount\\": 1,\\n \\"FailureReason\\": \\"无\\",\\n \\"PhoneNumber\\": \\"1888888****\\",\\n \\"State\\": \\"Connected\\",\\n \\"CaseId\\": \\"60ecb1a2-4480-4d01-bede-c5b7655bfadf\\",\\n \\"CustomVariables\\": \\"{\\\\\\"name\\\\\\":\\\\\\"yy\\\\\\",\\\\\\"客戶标签\\\\\\":\\\\\\"tag-yy\\\\\\"}\\",\\n \\"AbandonPhase\\": \\"Ringing\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 7CC6523B-0E51-1B62-8DA5-6A9831CAE316\\n 无\\n 200\\n \\n \\n NA\\n 1\\n 待删除\\n 无\\n 18888888888\\n Connected\\n 60ecb1a2-4480-4d01-bede-c5b7655bfadf\\n {\\"name\\":\\"yy\\",\\"客戶标签\\":\\"tag-yy\\"}\\n \\n 1\\n 100\\n 1\\n \\n OK\\n true\\n","errorExample":""}]', - 'title' => '获取预测式外呼名单列表', - ], - 'PauseCampaign' => [ - 'summary' => '调用PauseCampaign暂停指定实例下指定ID对应的预测式外呼活动。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"1900000****\\",\\n \\"Scope\\": \\"INSTANCE\\",\\n \\"Remark\\": \\"测试\\",\\n \\"CreateTime\\": 1626962425000,\\n \\"Creator\\": \\"agent\\",\\n \\"CreatedTime\\": 1631440860000\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n无\\n\\n 1\\n 10\\n 1\\n \\n INSTANCE\\n 190xxxx0000\\n 1626962425000\\n user-test\\n RemarkA\\n \\n\\nOK","errorExample":""}]', + 'title' => '获取禁止外呼号码列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'ramActions' => [], + ], + 'ListDocuments' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'name' => 'SchemaId', + 'in' => 'formData', + 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'], ], [ - 'name' => 'CampaignId', - 'in' => 'query', + 'name' => 'SearchPattern', + 'in' => 'formData', + 'schema' => ['description' => '搜索条件表达式', 'type' => 'string', 'required' => false, 'example' => '支持Lucene搜索语法'], + ], + [ + 'name' => 'Sorts', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'required' => true, - 'example' => '6badb397-a8b5-40b6-21019d382a09', + 'description' => '自定义排序值', + 'type' => 'array', + 'items' => [ + 'description' => '自定义排序值', + 'type' => 'object', + 'properties' => [ + 'PropertyName' => ['description' => '字段名', 'type' => 'string', 'required' => false, 'example' => 'name'], + 'Order' => ['description' => '排序顺序。取值：'."\n" + ."\n" + .'- ASC（默认值）：升序。'."\n" + .'- DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'desc'], + ], + 'required' => false, + ], + 'required' => false, ], ], + [ + 'name' => 'NextPageToken', + 'in' => 'formData', + 'schema' => ['description' => '下一个分页token', 'type' => 'string', 'required' => false, 'example' => 'eyJ0YWJsZUlkIjoiY2Y2MTQxYjA5NDY0NDUxMzk5YjFjMTA5YTMxZWNkMzEiLCJ0b2tlbiI6IjAwMDAwMDAwMDAwNzAzNzcifQ=='], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => '分页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'ListDocumentsResponse', + 'description' => 'ListDocumentsResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4A68E287-6888-5ADB-8048-DB488B4DEF35', - ], - 'Code' => [ - 'title' => 'code', - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'message', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'Schema' => [ + 'description' => 'scheme', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => '87b12784-8ce2-40b6-b21f-c49cb3b5501e'], + 'Id' => ['description' => 'schame id', 'type' => 'string', 'example' => 'profile'], + 'Description' => ['description' => '描述信息', 'type' => 'string', 'example' => '-'], + 'Properties' => [ + 'description' => '字段列表', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['type' => 'string', 'description' => '字段名称', 'example' => 'name'], + 'Description' => ['type' => 'string', 'example' => '-', 'description' => '描述'], + 'Name' => ['type' => 'string', 'description' => '名称', 'example' => 'name'], + 'DataType' => ['type' => 'string', 'example' => 'string', 'description' => '数据类型'], + 'Pattern' => ['type' => 'string', 'example' => '*', 'description' => '正则表达式'], + 'PatternErrorMessage' => ['type' => 'string', 'example' => '格式错误', 'description' => '正则表达式错误提示'], + 'MinLength' => ['type' => 'integer', 'format' => 'int32', 'description' => '最小长度', 'example' => '1'], + 'MaxLength' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '最大长度'], + 'Minimum' => ['type' => 'number', 'format' => 'double', 'description' => '最小值', 'example' => '1'], + 'Maximum' => ['type' => 'number', 'format' => 'double', 'description' => '最大值', 'example' => '1'], + 'Required' => ['type' => 'boolean', 'description' => '是否必填', 'example' => 'false'], + 'System' => ['type' => 'boolean', 'example' => 'false', 'description' => '是否系统字段'], + 'Disabled' => ['type' => 'boolean', 'example' => 'false', 'description' => '是否禁用'], + 'Array' => ['type' => 'boolean', 'description' => '是否是数组', 'example' => 'false'], + 'ReadOnly' => ['type' => 'boolean', 'description' => '是否只读', 'example' => 'false'], + 'EditorType' => ['type' => 'string', 'example' => 'textbox', 'description' => '编辑器类型'], + 'Attributes' => ['type' => 'string', 'description' => '扩展属性', 'example' => '{}'], + 'DisplayOrder' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '显示顺序'], + 'CreatedTime' => ['type' => 'integer', 'format' => 'int64', 'example' => '2020-10-14T09:53:53Z', 'description' => '创建时间'], + 'UpdatedTime' => ['type' => 'integer', 'format' => 'int64', 'example' => '2020-10-14T09:53:53Z', 'description' => '更新时间'], + 'Creator' => ['type' => 'string', 'description' => '创建者', 'example' => 'tom'], + ], + 'description' => '字段', + ], + ], + 'CreatedTime' => ['description' => '创建时间', 'type' => 'string', 'example' => '2020-10-14T09:53:53Z'], + 'UpdatedTime' => ['description' => '更新时间', 'type' => 'string', 'example' => '2020-10-14T09:53:53Z'."\n"], + 'Deleted' => ['description' => '是否被删除', 'type' => 'boolean', 'example' => 'false'], + ], + ], + 'Documents' => [ + 'description' => '文档列表', + 'type' => 'array', + 'items' => ['description' => '文档内容', 'type' => 'object', 'example' => '{}'], + ], + 'TotalCount' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'NextPageToken' => ['description' => '下一页标识。', 'type' => 'string', 'example' => '54d1a616d95a4a01ba58967a9115b649'], + ], ], - 'HttpStatusCode' => [ - 'title' => 'httpStatusCode', - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4A68E287-6888-5ADB-8048-DB488B4DEF35\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', - 'title' => '暂停预测式外呼活动', - ], - 'ResumeCampaign' => [ - 'summary' => '调用ResumeCampaign恢复指定实例下指定ID对应的预测式外呼活动。', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Schema\\": {\\n \\"InstanceId\\": \\"87b12784-8ce2-40b6-b21f-c49cb3b5501e\\",\\n \\"Id\\": \\"profile\\",\\n \\"Description\\": \\"-\\",\\n \\"Properties\\": {\\n \\"key\\": {\\n \\"DisplayName\\": \\"name\\",\\n \\"Description\\": \\"-\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"*\\",\\n \\"PatternErrorMessage\\": \\"格式错误\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 1,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 1,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 0,\\n \\"UpdatedTime\\": 0,\\n \\"Creator\\": \\"tom\\"\\n }\\n },\\n \\"CreatedTime\\": \\"2020-10-14T09:53:53Z\\",\\n \\"UpdatedTime\\": \\"2020-10-14T09:53:53Z\\\\n\\",\\n \\"Deleted\\": false\\n },\\n \\"Documents\\": [\\n {}\\n ],\\n \\"TotalCount\\": 1,\\n \\"NextPageToken\\": \\"54d1a616d95a4a01ba58967a9115b649\\"\\n },\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取文档列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ListFeedbacks' => [ + 'summary' => '查询反馈记录。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => false, 'example' => 'ccc-test'."\n"], ], [ - 'name' => 'CampaignId', + 'name' => 'TaskIdList', 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'required' => true, - 'example' => '6badb397-a8b5-40b6-21019d382a09', - ], + 'schema' => ['description' => '任务ID列表', 'type' => 'string', 'required' => false, 'example' => '["20251216-8B9B7B02-16FE-54BE-942A-F59DE0656032"]'], ], ], 'responses' => [ @@ -24657,47 +14657,52 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F505C4C8-1E12-573A-9BA7-4BEAAD129553', - ], - 'Code' => [ - 'title' => 'code', - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'message', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'HttpStatusCode' => [ - 'title' => 'httpStatusCode', - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => '26E54929-CA86-1035-9B42-0C8F291BB027'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => [ + 'description' => '返回的数据集合', + 'type' => 'array', + 'items' => [ + 'description' => '返回的数据元素', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '20251216-8B9B7B02-16FE-54BE-942A-F59DE0656032'], + 'TaskName' => ['description' => '任务名称。', 'type' => 'string', 'example' => 'PostCallAnalyzer:solution'], + 'UserResponse' => ['description' => '用户反馈的数据', 'type' => 'string', 'example' => 'xxxxxxx'], + 'UserRating' => ['description' => '用户对此任务的评分', 'type' => 'integer', 'format' => 'int32', 'example' => '-1'], + 'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-25920271311543****'], + ], + ], ], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F505C4C8-1E12-573A-9BA7-4BEAAD129553\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F505C4C8-1E12-573A-9BA7-4BEAAD129553\\n OK\\n 无\\n 200\\n","errorExample":""}]', - 'title' => '恢复预测式外呼活动', - ], - 'UpdateCampaign' => [ - 'summary' => '修改外呼活动参数。', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExist.Instance', 'errorMessage' => 'Call center instance %s does not exist.', 'description' => '云联络中心实例%s不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"26E54929-CA86-1035-9B42-0C8F291BB027\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TaskId\\": \\"20251216-8B9B7B02-16FE-54BE-942A-F59DE0656032\\",\\n \\"TaskName\\": \\"PostCallAnalyzer:solution\\",\\n \\"UserResponse\\": \\"xxxxxxx\\",\\n \\"UserRating\\": -1,\\n \\"ContactId\\": \\"job-25920271311543****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询反馈记录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ListFlashSmsApplications' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -24707,151 +14712,100 @@ ], ], 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'CampaignId', - 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ab11908b-6ebc-4b0c-b51e-3e17c7060', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'string', - 'required' => false, - 'example' => '1689901200000', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'ProviderId', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'string', - 'required' => false, - 'example' => '1689933600000', - ], + 'schema' => ['description' => '闪信供应商ID。', 'type' => 'string', 'required' => false, 'example' => 'Uincall'], ], [ - 'name' => 'CallableTime', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '可执行时间，支持多个时间段。', - 'type' => 'string', - 'required' => false, - 'example' => '['."\n" - .' {'."\n" - .' "beginTime": "09:00:00",'."\n" - .' "endTime": "12:00:00"'."\n" - .' }'."\n" - .']', - ], + 'schema' => ['description' => '闪信配置名称。', 'type' => 'string', 'required' => false, 'example' => '闪信'], ], [ - 'name' => 'StrategyParameters', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '策略参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'PACING策略，参考参数'."\n" - .'{'."\n" - .' "ratio": 2'."\n" - .'}'."\n" - ."\n" - .'PID策略，参考参数'."\n" - .'{'."\n" - .' "abandonRate":5,'."\n" - .' "historicalConnectedRate":45'."\n" - .'}', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Name', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '预测式外呼活动名称。', - 'type' => 'string', - 'required' => false, - 'example' => '云联络中心测试', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], [ - 'name' => 'ContactFlowId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '联系流ID。', - 'type' => 'string', - 'required' => false, - 'example' => '3a310f56-4d30-4081-ba24-5d87a3b7262e', - ], + 'schema' => ['description' => '云联络中心实例ID', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'ListFlashSmsMetadataResponse', + 'description' => 'ListFlashSmsApplicationResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E', - ], - 'Code' => [ - 'title' => 'code', - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'message', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'List' => [ + 'description' => '闪信配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '闪信配置。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'ProviderId' => ['description' => '闪信供应商ID。', 'type' => 'string', 'example' => 'Uincall'], + 'ApplicationId' => ['description' => '注册ID。', 'type' => 'string', 'example' => '71b396fa-***********-bd80e070b7c0'], + 'Name' => ['description' => '配置名称。', 'type' => 'string', 'example' => '闪信配置'], + 'Value' => ['description' => '配置内容。', 'type' => 'string', 'example' => '{"user":"600******_dev","pwd":"85abf3**********f494e","account":"6004******"}'], + ], + ], + ], + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => '修改外呼活动', - ], - 'SubmitCampaign' => [ - 'summary' => '调用SubmitCampaign启动指定实例下指定ID对应的预测式外呼活动。', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ProviderId\\": \\"Uincall\\",\\n \\"ApplicationId\\": \\"71b396fa-***********-bd80e070b7c0\\",\\n \\"Name\\": \\"闪信配置\\",\\n \\"Value\\": \\"{\\\\\\"user\\\\\\":\\\\\\"600******_dev\\\\\\",\\\\\\"pwd\\\\\\":\\\\\\"85abf3**********f494e\\\\\\",\\\\\\"account\\\\\\":\\\\\\"6004******\\\\\\"}\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取闪信配置信息', + 'summary' => '使用ListFlashSmsApplication获取第三方闪信配置信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ListFlashSmsSettings' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24860,77 +14814,115 @@ 'BearerToken' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'SkillGroupName', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '技能组名称。', 'type' => 'string', 'required' => false, 'example' => '闪信测试技能组'], ], [ - 'name' => 'CampaignId', + 'name' => 'SkillGroupIdList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '预测式外呼活动ID。', - 'type' => 'string', - 'required' => true, - 'example' => '6badb397-a8b5-40b6-21019d382a09', + 'description' => '坐席所属技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID列表。', 'type' => 'string', 'required' => false, 'example' => '["skillgroup1@ccc-test"]'], + 'required' => false, ], ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '呼叫中心实例ID', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'ListFlashSmsSettingsResponse', + 'description' => 'ListFlashSmsSettingsResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315', - ], - 'Code' => [ - 'title' => 'code', - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'title' => 'message', - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => '总数。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '分页序号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'List' => [ + 'description' => '配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配置。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + 'Enabled' => ['description' => '该技能组闪信是否处于启用状态。'."\n" + ."\n" + .'- **true**：启用状态。'."\n" + ."\n" + .'- **false**：停用状态。', 'type' => 'boolean', 'example' => 'true'], + 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '闪信测试技能组'], + ], + ], + ], + ], ], - 'HttpStatusCode' => [ - 'title' => 'httpStatusCode', - 'description' => 'HTTP状态码。', - 'type' => 'string', - 'example' => '200', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\n OK\\n 无\\n 200\\n","errorExample":""}]', - 'title' => '启动预测式外呼活动', - ], - 'GetIvrTrackingSummary' => [ - 'summary' => '获取IVR轨迹小结', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup1@ccc-test\\",\\n \\"Enabled\\": true,\\n \\"SkillGroupName\\": \\"闪信测试技能组\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取闪信坐技能组配置', + 'summary' => '使用ListFlashSmsSettings接口获取指定技能组闪信相关配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ListFlashSmsTemplates' => [ + 'summary' => '使用ListFlashSmsTemplates获取闪信模板信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -24942,983 +14934,165 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccKJSOHN', - ], + 'abilityTreeNodes' => ['FEATUREcccIPHVDY'], ], 'parameters' => [ [ - 'name' => 'ContactId', + 'name' => 'ProviderId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'job-489361145506897920', - ], + 'schema' => ['description' => '闪信供应商ID。', 'type' => 'string', 'required' => false, 'example' => 'Uincall'], + ], + [ + 'name' => 'ApplicationId', + 'in' => 'query', + 'schema' => ['description' => '闪信配置ID。', 'type' => 'string', 'required' => false, 'example' => '71b396fa-1*********-70b7c0'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0f7ad007-ab50-4b3d-a87a-56864eb40dab', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'ListFlashSmsTemplatesResponse', + 'description' => 'ListFlashSmsTemplatesResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => 'Unknown error code \'NoPermission.Recording\'. Reason: null', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', - ], 'Data' => [ - 'description' => '返回数据结果。', - 'type' => 'string', - 'example' => '无', + 'description' => '数据。', + 'type' => 'array', + 'items' => [ + 'description' => '闪信模板', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['description' => '模板ID。', 'type' => 'string', 'example' => '1715*****38'], + 'TemplateName' => ['description' => '模板名称。', 'type' => 'string', 'example' => '测试模板'], + 'TemplateDetails' => ['type' => 'string', 'description' => ''], + ], + ], + ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid. %s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Unknown error code \'NoPermission.Recording\'. Reason: null\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"Data\\": \\"无\\"\\n}","type":"json"}]', - 'title' => '获取IVR轨迹总结', - ], - 'ListIntervalAgentSkillGroupReport' => [ - 'summary' => '获取指定实例下指定坐席的分段统计报表。', - 'methods' => [ - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TemplateId\\": \\"1715*****38\\",\\n \\"TemplateName\\": \\"测试模板\\",\\n \\"TemplateDetails\\": \\"\\"\\n }\\n ],\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取闪信模板信息', + 'changeSet' => [ + ['createdAt' => '2025-07-02T08:46:22.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ListGroupChatMessages' => [ + 'summary' => '查询Chat消息记录。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'AgentId', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], - ], - [ - 'name' => 'StartTime', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间戳，默认为当天的0时。统计的时间精度为小时，向前取整，闭区间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1532448000000', - ], + 'schema' => ['description' => '话务ID。', 'type' => 'string', 'required' => false, 'example' => 'chat-65382141036853491'], ], [ - 'name' => 'EndTime', + 'name' => 'SortOrder', 'in' => 'query', - 'schema' => [ - 'description' => '截止时间，格式为Unix时间戳，单位毫秒，非必填，默认是当前时间，如果Interval为Daily，StartTime和EndTime最大间隔是180天。如果Interval为Hourly，最大间隔时间为10天。统计的时间精度为小时，向后取整，开区间。例如：开始时间为11:12:20，结束时间为11:45:50，则对齐后的入参时间范围为[11:00:00,12:00:00)，即大于等于11点，小于12点。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1558443508000', - ], + 'schema' => ['description' => '排序方式，默认为降序。'."\n" + ."\n" + .'枚举值：'."\n" + ."\n" + .'ASC：升序。'."\n" + ."\n" + .'DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例 ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '云联络中心实例。', 'type' => 'string', 'required' => false, 'example' => 'ccc-test'], ], [ - 'name' => 'Interval', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分段统计类型，非必填，默认为Daily（按天汇总）。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Hourly' => '按小时统计。', - 'Daily' => '按天统计。', - ], - 'example' => 'Daily', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'SkillGroupId', + 'name' => 'NextPageToken', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'required' => true, - 'example' => ' '."\n" - .'skg-default@ccc-test'."\n", - ], + 'schema' => ['description' => '下一页标识，32位UUID。请求第一页时，NextPageToken为空；请求后续文件时需传入前一页查询结果中的NextPageToken值。', 'type' => 'string', 'required' => false, 'example' => 'b2ad450b116e4f8396e58108acf5c020'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780'], + 'HttpStatusCode' => ['description' => 'HTTP请求返回的响应状态码，200表示请求成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '坐席在对应技能组中的分段统计数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '坐席在对应技能组中的分段统计数据。', - 'type' => 'object', - 'properties' => [ - 'StatsTime' => [ - 'description' => '时间段的开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1620291600000', - ], - 'Inbound' => [ - 'description' => '呼入指标。', + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'Messages' => [ + 'description' => '消息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '消息体。', 'type' => 'object', 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '11', - ], - 'CallsHandled' => [ - 'description' => '应答量，即坐席应答的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '85', - ], - 'CallsAttendedTransferOut' => [ - 'description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为： TotalWorkTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsBlindTransferIn' => [ - 'description' => '直接转入量。若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsRinged' => [ - 'description' => '坐席振铃的电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAttendedTransferIn' => [ - 'description' => '咨询转入量。若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsBlindTransferOut' => [ - 'description' => '直接转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsOffered' => [ - 'description' => '分配量，即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'HandleRate' => [ - 'description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'AverageFirstResponseTime' => [ - 'description' => 'Chat会话平均首次响应时长，单位为秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '6', - ], - 'AverageResponseTime' => [ - 'description' => 'Chat会话平均响应时长。', - 'type' => 'number', - 'format' => 'float', - 'example' => '18', - ], - 'TotalMessagesSent' => [ - 'description' => 'Chat会话中总消息发送量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'TotalMessagesSentByAgent' => [ - 'description' => 'Chat会话中坐席发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'TotalMessagesSentByCustomer' => [ - 'description' => 'Chat会话中客户发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - ], - ], - 'Outbound' => [ - 'description' => '呼出指标。', - 'type' => 'object', - 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAttendedTransferOut' => [ - 'description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsDialed。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsBlindTransferIn' => [ - 'description' => '直接转入量。若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsRinged' => [ - 'description' => '坐席振铃的电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAttendedTransferIn' => [ - 'description' => '咨询转入量。若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsBlindTransferOut' => [ - 'description' => '直接转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsAnswered。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。计算公式为：TotalDialingTime/CallsDialed。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - ], - ], - 'Overall' => [ - 'description' => '整体指标。', - 'type' => 'object', - 'properties' => [ - 'OccupancyRate' => [ - 'description' => '座席利用率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.4', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalHoldTime' => [ - 'description' => '总保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/TotalCalls。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'MaxBreakTime' => [ - 'description' => '最大小休时长，单位秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1.4', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'LastCheckOutTime' => [ - 'description' => '最后签出时间，格式是unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1712548421000', - ], - 'TotalCalls' => [ - 'description' => '总电话量。计算公式为：CallsOffered + CallsDialed。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。_注意：不包含离线和小休时长_。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageBreakTime' => [ - 'description' => '平均小休时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/(CallsAnswered+CallsHandled)。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'FirstCheckInTime' => [ - 'description' => '入参Interval为Daily才有值，当天的首次上线时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/(Inbound.CallsHold+Outbound.CallsHold)。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位秒。计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'BreakCodeDetailList' => [ - 'description' => '小休详情列表。', - 'type' => 'array', - 'items' => [ - 'description' => '小休详情。', - 'type' => 'object', - 'properties' => [ - 'BreakCode' => [ - 'description' => '小休码。', - 'type' => 'string', - 'example' => '开会', - ], - 'Count' => [ - 'description' => '次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Duration' => [ - 'description' => '时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - ], - ], - 'TotalOutboundScenarioTime' => [ - 'description' => '总仅外呼时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalOutboundScenarioReadyTime' => [ - 'description' => '总仅外呼空闲时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalOutboundScenarioLoggedInTime' => [ - 'description' => '总仅外呼在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalOffSiteLoggedInTime' => [ - 'description' => '总场外在线时长，单位秒。', - 'type' => 'string', - 'example' => '100', - ], - 'TotalOfficePhoneLoggedInTime' => [ - 'description' => '办公电话在线时长，单位秒', - 'type' => 'string', - 'example' => '100', - ], - 'TotalOnSiteLoggedInTime' => [ - 'description' => '总场内在线时长，单位秒。', - 'type' => 'string', - 'example' => '100', - ], - 'LastCheckoutTime' => [ - 'description' => '入参Interval为Daily才有值，当天的最后下线时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - ], - 'Internal' => [ - 'description' => '内部呼叫指标。', - 'type' => 'object', - 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsOffered' => [ - 'description' => '分配量，即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsHandled' => [ - 'description' => '应答量，即坐席应答的次数。一通电话每次进入队列后，若被多个坐席应答，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsTalk' => [ - 'description' => '已废弃，该字段参考CallsTalked。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsTalked' => [ - 'description' => '参与通话次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - ], - 'Back2Back' => [ - 'description' => '双呼指标。', - 'type' => 'object', - 'properties' => [ - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AgentAnswerRate' => [ - 'description' => '坐席测应答率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsCustomerHandled' => [ - 'description' => '客户测接起次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CustomerHandleRate' => [ - 'description' => '客户测接起率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'TotalCustomerRingTime' => [ - 'description' => '总客户测振岭时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxCustomerRingTime' => [ - 'description' => '最大客户测振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageCustomerRingTime' => [ - 'description' => '平均客户测振铃时长，单位秒', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'AgentHandleRate' => [ - 'description' => '坐席应答率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'CallsCustomerAnswered' => [ - 'description' => '客户接听电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'CustomerAnswerRate' => [ - 'description' => '客户接通率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.6', - ], - 'CallsAgentHandled' => [ - 'description' => '坐席接听电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], + 'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'chat-65382141036853491'], + 'SenderId' => ['description' => '消息发送者用户ID。', 'type' => 'string', 'example' => '64bb4ececc34fc5ec1ca1153'], + 'SenderType' => ['description' => '发送方类型。'."\n" + ."\n" + .'枚举值'."\n" + .'- **ADMIN**：系统'."\n" + .'- **CUSTOMER**：访客'."\n" + .'- **AGENT**：坐席', 'type' => 'string', 'example' => 'CUSTOMER'], + 'Timestamp' => ['description' => '消息时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1696126980371'], + 'Content' => ['description' => '内容信息。', 'type' => 'string', 'example' => '{"variables":{},"text":"

好的，不客气

","contentType":"Text","subContentType":"richtext"}'], + 'SenderName' => ['description' => '发送者名称。', 'type' => 'string', 'example' => 'test-agent@test-instanceId'], + 'SenderAvatarUrl' => ['description' => '发送者头像地址。', 'type' => 'string', 'example' => 'http://xxxxx.com'], + 'Recalled' => ['description' => '是否被撤回。', 'type' => 'boolean', 'example' => 'false'], ], ], ], + 'NextPageToken' => ['description' => '下一页标识。', 'type' => 'string', 'example' => '54d1a616d95a4a01ba58967a9115b649'], ], ], ], @@ -25926,145 +15100,81 @@ ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid. %s', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], + 403 => [ + ['errorCode' => 'Permission.Unauthorized', 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', 'description' => '您无权执行此操作。 必须具有指定权限。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Messages\\": [\\n {\\n \\"JobId\\": \\"chat-65382141036853491\\",\\n \\"SenderId\\": \\"64bb4ececc34fc5ec1ca1153\\",\\n \\"SenderType\\": \\"CUSTOMER\\",\\n \\"Timestamp\\": 1696126980371,\\n \\"Content\\": \\"{\\\\\\"variables\\\\\\":{},\\\\\\"text\\\\\\":\\\\\\"

好的，不客气

\\\\\\",\\\\\\"contentType\\\\\\":\\\\\\"Text\\\\\\",\\\\\\"subContentType\\\\\\":\\\\\\"richtext\\\\\\"}\\",\\n \\"SenderName\\": \\"test-agent@test-instanceId\\",\\n \\"SenderAvatarUrl\\": \\"http://xxxxx.com\\",\\n \\"Recalled\\": false\\n }\\n ],\\n \\"NextPageToken\\": \\"54d1a616d95a4a01ba58967a9115b649\\"\\n }\\n}","type":"json"}]', + 'title' => '查询消息列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1620291600000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 11,\\n \\"CallsHandled\\": 7,\\n \\"TotalWorkTime\\": 85,\\n \\"CallsAttendedTransferOut\\": 10,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 100,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"HandleRate\\": 0.5,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 18,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 8,\\n \\"TotalMessagesSentByCustomer\\": 5\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"TotalWorkTime\\": 100,\\n \\"CallsAttendedTransferOut\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalDialingTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 100,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxDialingTime\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 100,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageDialingTime\\": 100\\n },\\n \\"Overall\\": {\\n \\"OccupancyRate\\": 0.4,\\n \\"TotalWorkTime\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"MaxBreakTime\\": 100,\\n \\"SatisfactionIndex\\": 1.4,\\n \\"MaxReadyTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"TotalReadyTime\\": 100,\\n \\"LastCheckOutTime\\": 1712548421000,\\n \\"TotalCalls\\": 100,\\n \\"TotalLoggedInTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageBreakTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"FirstCheckInTime\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageReadyTime\\": 100,\\n \\"TotalBreakTime\\": 100,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"开会\\",\\n \\"Count\\": 1,\\n \\"Duration\\": 100\\n }\\n ],\\n \\"TotalOutboundScenarioTime\\": 100,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 100,\\n \\"TotalOffSiteLoggedInTime\\": \\"100\\",\\n \\"TotalOfficePhoneLoggedInTime\\": \\"100\\",\\n \\"TotalOnSiteLoggedInTime\\": \\"100\\",\\n \\"LastCheckoutTime\\": 100\\n },\\n \\"Internal\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsTalk\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"CallsTalked\\": 100\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"CallsAnswered\\": 100,\\n \\"AgentAnswerRate\\": 100,\\n \\"CallsCustomerHandled\\": 100,\\n \\"CustomerHandleRate\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 1,\\n \\"CallsCustomerAnswered\\": 12,\\n \\"CustomerAnswerRate\\": 0.6,\\n \\"CallsAgentHandled\\": 5\\n }\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取分组坐席分段统计报表', + 'ramActions' => [], ], - 'ListHistoricalAgentSkillGroupReport' => [ - 'summary' => '调用ListHistoricalAgentSkillGroupReport获取指定实例下的一个或多个坐席的历史分组数据报表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListHistoricalAgentReport' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100'], ], [ 'name' => 'AgentIdList', 'in' => 'formData', - 'schema' => [ - 'description' => '坐席ID列表，列表大小0-100。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '["agent1@ccc-test", "agent2@ccc-test"]', - ], + 'schema' => ['description' => '坐席ID列表，范围0-100 。'."\n" + ."\n" + .'> 如果坐席ID列表不为空，则直接按照坐席ID列表进行查询，此时pageSize和pageNumber参数无效，数据直接返回，如：请求参数：pageNumber = 3 则响应参数中pageNumber = 3 。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["agent1@ccc-test", "agent2@ccc-test"]'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间戳，默认为当天的0时。统计的时间精度为小时，向前取整，闭区间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1634140800000', - ], + 'schema' => ['description' => '获取的历史数据的起始时间，默认为当天的0时，最早为当前时间往前180天。统计的时间精度为小时，向前取整，闭区间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000'], ], [ - 'name' => 'EndTime', + 'name' => 'StopTime', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的终止时间，格式为Unix时间戳，单位毫秒，非必填，默认为当前时间，统计的时间精度为小时，向后取整，开区间。例如：开始时间为11:12:20，结束时间为11:45:50，则对齐后的入参时间范围为[11:00:00,12:00:00) ，即大于等于11点，小于12点。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1620273600000', - ], + 'schema' => ['description' => '获取的历史数据的终止时间，默认为当前时间。统计的时间精度为小时，向后取整，开区间。例如：开始时间为 11:12:20，结束时间为 11:45:50，则对齐后的入参时间范围为 [11:00:00, 12:00:00) ，即大于等于11点，小于12点，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test'."\n", - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'SkillGroupIdList', + 'name' => 'MediaType', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID列表，列表大小0-100。', - 'type' => 'string', - 'required' => false, - 'example' => '['."\n" - .' "skg1@ccc-test",'."\n" - .' "skg2@ccc-test"'."\n" - .']', - ], + 'schema' => ['description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO'], ], [ - 'name' => 'MediaType', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', - 'type' => 'string', - 'required' => false, - 'example' => 'VIDEO', - ], + 'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => false, 'example' => 'wwtest@test_yunhu'], ], ], 'responses' => [ @@ -26072,832 +15182,198 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Data' => [ - 'description' => '分组坐席历史数据列表。', + 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数，只有PageNumber为1时才有数据，其他情况都是0。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'List' => [ - 'description' => '分组坐席历史数据列表。', + 'description' => '坐席历史数据列表。', 'type' => 'array', 'items' => [ - 'description' => '分组坐席历史数据。', + 'description' => '坐席历史数据。', 'type' => 'object', 'properties' => [ - 'AgentName' => [ - 'description' => '坐席姓名。', - 'type' => 'string', - 'example' => '云呼测试坐席', - ], - 'AgentId' => [ - 'description' => '座席ID。', - 'type' => 'string', - 'example' => 'agent1@ccc-test', - ], - 'DisplayId' => [ - 'description' => '坐席的工号。', - 'type' => 'string', - 'example' => '1001', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => 'Default', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], + 'AgentName' => ['description' => '坐席姓名。', 'type' => 'string', 'example' => '坐席小王'], + 'AgentId' => ['description' => '座席ID。', 'type' => 'string', 'example' => 'agent1@ccc-test'], + 'DisplayId' => ['description' => '坐席工号。', 'type' => 'string', 'example' => '001'], 'Inbound' => [ - 'description' => '呼入指标。', + 'description' => '呼入数据。', 'type' => 'object', 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsHandled' => [ - 'description' => '应答量，即坐席应答的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAttendedTransferOut' => [ - 'description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为： TotalWorkTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsBlindTransferIn' => [ - 'description' => '直接转入量。若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsRinged' => [ - 'description' => '坐席振铃的电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAttendedTransferIn' => [ - 'description' => '咨询转入量。若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsBlindTransferOut' => [ - 'description' => '直接转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsOffered' => [ - 'description' => '分配量，即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'HandleRate' => [ - 'description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'TotalMessagesSent' => [ - 'description' => 'Chat会话中总消息发送量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'TotalMessagesSentByAgent' => [ - 'description' => 'Chat会话中坐席发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'TotalMessagesSentByCustomer' => [ - 'description' => 'Chat会话中客户发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'AverageFirstResponseTime' => [ - 'description' => 'Chat会话平均首次响应时长，单位为秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '8', - ], - 'AverageResponseTime' => [ - 'description' => 'Chat会话平均响应时长。', - 'type' => 'number', - 'format' => 'float', - 'example' => '9', + 'AverageRingTime' => ['description' => '平均振铃时长，计算公式为：TotalRingTime/CallsRinged，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsHandled' => ['description' => '应答量，即坐席应答的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，计算公式为：TotalWorkTime/CallsHandled，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsBlindTransferIn' => ['description' => '直接转入量，若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAttendedTransferIn' => ['description' => '咨询转入量，若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsBlindTransferOut' => ['description' => '直接转出量，若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '分配量，即分配给此坐席的电话次数，包括其他坐席盲转和咨询转给此坐席的电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，计算公式为：TotalTalkTime/CallsHandled，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，计算公式为：TotalHoldTime/CallsHold，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AccessChannelTypeDetails' => [ + 'description' => '各渠道的统计数据。', + 'type' => 'array', + 'items' => [ + 'description' => '渠道的统计数据。', + 'type' => 'object', + 'properties' => [ + 'AccessChannelType' => ['description' => '渠道类型。', 'type' => 'string', 'example' => 'Web'], + 'CallsOffered' => ['description' => '分配的会话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + ], + ], ], + 'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长，单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '10'], + 'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '12'], + 'ServiceLevel15' => ['description' => '15秒服务水平。', 'type' => 'number', 'format' => 'float', 'example' => '0.85'], + 'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], + 'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'string', 'example' => '9'], ], ], 'Outbound' => [ - 'description' => '呼出指标。', + 'description' => '呼出数据。', 'type' => 'object', 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAttendedTransferOut' => [ - 'description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsDialed', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsBlindTransferIn' => [ - 'description' => '直接转入量。若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1.4', - ], - 'CallsRinged' => [ - 'description' => '坐席振铃的电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAttendedTransferIn' => [ - 'description' => '咨询转入量。若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsBlindTransferOut' => [ - 'description' => '直接转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsAnswered。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。计算公式为：TotalDialingTime/CallsDialed。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], + 'AverageRingTime' => ['description' => '平均振铃时长，计算公式为： TotalRingTime/CallsRinged，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAttendedTransferOut' => ['description' => '咨询转出量，若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，计算公式为：TotalWorkTime/CallsDialed，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsBlindTransferIn' => ['description' => '直接转入量，若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAttendedTransferIn' => ['description' => '咨询转入量，若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsBlindTransferOut' => ['description' => '直接转出量，若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，计算公式为：TotalTalkTime/CallsAnswered，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，计算公式为：TotalHoldTime/CallsHold，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，计算公式为：TotalDialingTime/CallsDialed，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'], ], ], 'Overall' => [ - 'description' => '整体指标。', + 'description' => '整体数据。', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。'."\n" - .'_注意：不含离线和小休时长_', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageBreakTime' => [ - 'description' => '平均小休时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'TotalHoldTime' => [ - 'description' => '总保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'MaxBreakTime' => [ - 'description' => '最大小休时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/TotalCalls。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/(CallsAnswered+CallsHandled)。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1.4', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位秒。计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/（呼入CallsHold+呼出CallsHold）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalCalls' => [ - 'description' => '总电话量。计算公式为：CallsOffered + CallsDialed。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalLoggedInTime' => ['description' => '总登录时长，不包含小休时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OccupancyRate' => ['description' => '座席利用率，计算公式为：（TotalworkTime+TotalTalkTime）/TotalLoggedInTime。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageBreakTime' => ['description' => '平均小休时长，计算公式为：TotalBreakTime/小休次数，小休次数为非接口统计字段，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxBreakTime' => ['description' => '最大小休时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，计算公式为：TotalWorkTime/TotalCalls，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，计算公式为：TotalTalkTime/（CallsAnswered+CallsHandled），单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageReadyTime' => ['description' => '平均就绪时长，计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/（呼入CallsHold+呼出CallsHold）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalBreakTime' => ['description' => '总小休时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话量，计算公式为：CallsOffered+CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalOnSiteOnlineTime' => ['description' => '总场内在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOnSiteLoggedInTime代替此参数'], + 'TotalOffSiteOnlineTime' => ['description' => '总场外在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOffSiteLoggedInTime代替此参数'], + 'TotalOfficePhoneOnlineTime' => ['description' => '总办公电话模式在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOfficePhoneLoggedInTime代替此参数'], 'BreakCodeDetailList' => [ - 'description' => '小休详情列表。', + 'description' => '各类型小休统计数据。', 'type' => 'array', 'items' => [ - 'description' => '小休详情。', + 'description' => '小休统计数据', 'type' => 'object', 'properties' => [ - 'BreakCode' => [ - 'description' => '小休码。', - 'type' => 'string', - 'example' => '开会', - ], - 'Count' => [ - 'description' => '次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Duration' => [ - 'description' => '时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'BreakCode' => ['description' => '小休类型代码。', 'type' => 'string', 'example' => '会议'], + 'Count' => ['description' => '此类型小休的发生次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'Duration' => ['description' => '此类型小休的总计发生时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'], ], ], ], - 'FirstCheckInTime' => [ - 'description' => '最早签入时间，格式是unix时间戳，单位到毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1686030515000', - ], - 'LastCheckOutTime' => [ - 'description' => '最后签出时间，格式是unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1686030515000', - ], - 'TotalOutboundScenarioTime' => [ - 'description' => '总仅外呼在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalOutboundScenarioReadyTime' => [ - 'description' => '总仅外呼空闲时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalOutboundScenarioLoggedInTime' => [ - 'description' => '总仅外呼在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'TotalOfficePhoneLoggedInTime' => [ - 'description' => '总办公电话在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'TotalOffSiteLggedInTime' => [ - 'description' => '总场外在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'TotalOnSiteLoggedInTime' => [ - 'description' => '总场内在线时长，单位秒。', - 'type' => 'string', - 'example' => '120', - ], + 'FirstCheckInTime' => ['description' => '最早签入时间，格式是unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1686030515000'], + 'LastCheckOutTime' => ['description' => '最后签出时间，格式是unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1686030515000'], + 'TotalOutboundScenarioTime' => ['description' => '总仅外呼在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOutboundScenarioLoggedInTime代替此参数'], + 'TotalOutboundScenarioReadyTime' => ['description' => '总仅外呼空闲时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalOfficePhoneLoggedInTime' => ['description' => '总办公电话模式在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3600'], + 'TotalOffSiteLoggedInTime' => ['description' => '总场外在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalOnSiteLoggedInTime' => ['description' => '总场内在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalOutboundScenarioLoggedInTime' => ['description' => '总仅外呼在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], ], ], - 'Internal' => [ - 'description' => '内部呼叫指标。', + 'SkillGroupIds' => ['description' => '座席所属技能组ID列表，格式为JSON数组的字符串，数组元素为技能组ID。', 'type' => 'string', 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'], + 'SkillGroupNames' => ['description' => '座席所属技能组名称列表，格式为JSON数组的字符串，数组元素是技能组名称。', 'type' => 'string', 'example' => '["测试技能组1","测试技能组2"]'], + 'Back2Back' => [ + 'description' => '双呼指标。', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsOffered' => [ - 'description' => '电话呼入数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsHandled' => [ - 'description' => '电话应答数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsTalk' => [ - 'description' => '坐席参与的通话次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsTalked' => [ - 'description' => '参与通话次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'string', 'example' => '100'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'string', 'example' => '0.6'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'string', 'example' => '100'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'string', 'example' => '100'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'string', 'example' => '100'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'string', 'example' => '100'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'string', 'example' => '100'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'string', 'example' => '100'], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'string', 'example' => '100'], + 'TotalCustomerRingTime' => ['description' => '总客户侧振岭时长，单位秒。', 'type' => 'string', 'example' => '100'], + 'MaxCustomerRingTime' => ['description' => '最大客户侧振铃时长，单位秒。', 'type' => 'string', 'example' => '100'], + 'AverageCustomerRingTime' => ['description' => '平均客户侧振铃时长，单位秒', 'type' => 'string', 'example' => '100'], + 'CallsAgentHandled' => ['description' => '坐席接听电话数量。', 'type' => 'string', 'example' => '10'], + 'AgentHandleRate' => ['description' => '坐席应答率。', 'type' => 'string', 'example' => '1'], + 'CallsCustomerAnswered' => ['description' => '客户接听电话数量。', 'type' => 'string', 'example' => '7'], + 'CustomerAnswerRate' => ['description' => '客户接通率。', 'type' => 'string', 'example' => '0.7'], ], ], - 'Back2Back' => [ - 'description' => '双呼指标。', + 'Internal' => [ + 'description' => '内部呼叫指标。', 'type' => 'object', 'properties' => [ - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.6', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AgentAnswerRate' => [ - 'description' => '坐席侧应答率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '已弃用，请使用AgentHandleRate代替此参数', - ], - 'CallsCustomerHandled' => [ - 'description' => '客户侧接起次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '已弃用，请使用CallsCustomerAnswered代替此参数', - ], - 'CustomerHandleRate' => [ - 'description' => '客户侧接起率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '已弃用，请使用CustomerAnswerRate代替此参数', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'TotalCustomerRingTime' => [ - 'description' => '总客户侧振岭时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxCustomerRingTime' => [ - 'description' => '最大客户侧振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageCustomerRingTime' => [ - 'description' => '平均客户侧振铃时长，单位秒', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'AgentHandleRate' => [ - 'description' => '坐席应答率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'CallsCustomerAnswered' => [ - 'description' => '客户接听电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CustomerAnswerRate' => [ - 'description' => '客户接通率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'CallsAgentHandled' => [ - 'description' => '坐席接听电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsOffered' => ['description' => '电话呼入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsTalked' => ['description' => '参与通话次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], ], ], ], @@ -26906,40 +15382,42 @@ ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"AgentName\\": \\"云呼测试坐席\\",\\n \\"AgentId\\": \\"agent1@ccc-test\\",\\n \\"DisplayId\\": \\"1001\\",\\n \\"SkillGroupName\\": \\"Default\\",\\n \\"SkillGroupId\\": \\"skillgroup1@ccc-test\\",\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"TotalWorkTime\\": 100,\\n \\"CallsAttendedTransferOut\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 100,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"HandleRate\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 6,\\n \\"TotalMessagesSentByCustomer\\": 6,\\n \\"AverageFirstResponseTime\\": 8,\\n \\"AverageResponseTime\\": 9\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"TotalWorkTime\\": 100,\\n \\"CallsAttendedTransferOut\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalDialingTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 1.4,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxDialingTime\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageDialingTime\\": 100\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"TotalLoggedInTime\\": 100,\\n \\"OccupancyRate\\": 0.5,\\n \\"TotalWorkTime\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"AverageBreakTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"MaxBreakTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionIndex\\": 1.4,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"MaxReadyTime\\": 100,\\n \\"AverageReadyTime\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"TotalReadyTime\\": 100,\\n \\"TotalBreakTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"TotalCalls\\": 100,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"开会\\",\\n \\"Count\\": 1,\\n \\"Duration\\": 100\\n }\\n ],\\n \\"FirstCheckInTime\\": 1686030515000,\\n \\"LastCheckOutTime\\": 1686030515000,\\n \\"TotalOutboundScenarioTime\\": 100,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 120,\\n \\"TotalOfficePhoneLoggedInTime\\": 120,\\n \\"TotalOffSiteLggedInTime\\": 120,\\n \\"TotalOnSiteLoggedInTime\\": \\"120\\"\\n },\\n \\"Internal\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsTalk\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"CallsTalked\\": 5\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.6,\\n \\"CallsAnswered\\": 100,\\n \\"AgentAnswerRate\\": 0,\\n \\"CallsCustomerHandled\\": 0,\\n \\"CustomerHandleRate\\": 0,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 0.5,\\n \\"CallsCustomerAnswered\\": 100,\\n \\"CustomerAnswerRate\\": 0.5,\\n \\"CallsAgentHandled\\": 100\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取分组坐席历史数据报表', - ], - 'GetCallDetailRecord' => [ - 'summary' => '调用GetCallDetailRecord获取指定实例下指定通话ID对应的通话的详情。', - 'methods' => [ - 'post', - 'get', + 'title' => '获取坐席历史数据报表', + 'summary' => '调用ListHistoricalAgentReport获取指定实例下的一个或多个坐席的历史数据报表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-22T01:05:25.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-05-23T11:59:01.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-07-04T11:50:02.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalAgentReport'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"AgentId\\": \\"agent1@ccc-test\\",\\n \\"DisplayId\\": \\"001\\",\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AccessChannelTypeDetails\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 3\\n }\\n ],\\n \\"AverageFirstResponseTime\\": 10,\\n \\"AverageResponseTime\\": 12,\\n \\"ServiceLevel15\\": 0.85,\\n \\"TotalMessagesSent\\": 16,\\n \\"TotalMessagesSentByAgent\\": 7,\\n \\"TotalMessagesSentByCustomer\\": \\"9\\"\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0,\\n \\"TotalOnSiteOnlineTime\\": 0,\\n \\"TotalOffSiteOnlineTime\\": 0,\\n \\"TotalOfficePhoneOnlineTime\\": 0,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 3,\\n \\"Duration\\": 120\\n }\\n ],\\n \\"FirstCheckInTime\\": 1686030515000,\\n \\"LastCheckOutTime\\": 1686030515000,\\n \\"TotalOutboundScenarioTime\\": 0,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"TotalOfficePhoneLoggedInTime\\": 3600,\\n \\"TotalOffSiteLoggedInTime\\": 100,\\n \\"TotalOnSiteLoggedInTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 100\\n },\\n \\"SkillGroupIds\\": \\"[\\\\\\"skillgroup1@ccc-test\\\\\\",\\\\\\"skillgroup2@ccc-test\\\\\\"]\\",\\n \\"SkillGroupNames\\": \\"[\\\\\\"测试技能组1\\\\\\",\\\\\\"测试技能组2\\\\\\"]\\",\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": \\"100\\",\\n \\"AnswerRate\\": \\"0.6\\",\\n \\"CallsAnswered\\": \\"100\\",\\n \\"TotalTalkTime\\": \\"100\\",\\n \\"MaxTalkTime\\": \\"100\\",\\n \\"AverageTalkTime\\": \\"100\\",\\n \\"TotalRingTime\\": \\"100\\",\\n \\"MaxRingTime\\": \\"100\\",\\n \\"AverageRingTime\\": \\"100\\",\\n \\"TotalCustomerRingTime\\": \\"100\\",\\n \\"MaxCustomerRingTime\\": \\"100\\",\\n \\"AverageCustomerRingTime\\": \\"100\\",\\n \\"CallsAgentHandled\\": \\"10\\",\\n \\"AgentHandleRate\\": \\"1\\",\\n \\"CallsCustomerAnswered\\": \\"7\\",\\n \\"CustomerAnswerRate\\": \\"0.7\\"\\n },\\n \\"Internal\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsTalked\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 10\\n 100\\n 1\\n \\n 8001xxxx\\n user-test@ccc-test\\n 云呼测试坐席\\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'ListHistoricalAgentSkillGroupReport' => [ + 'summary' => '调用ListHistoricalAgentSkillGroupReport获取指定实例下的一个或多个坐席的历史分组数据报表。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, @@ -26947,32 +15425,51 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREccc5HY0NN', - ], + 'abilityTreeNodes' => ['FEATUREcccSI864G'], ], 'parameters' => [ [ - 'name' => 'ContactId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-10963442671187****', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], + [ + 'name' => 'AgentIdList', + 'in' => 'formData', + 'schema' => ['description' => '坐席ID列表，列表大小0-100。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["agent1@ccc-test", "agent2@ccc-test"]'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '开始时间戳，默认为当天的0时。统计的时间精度为小时，向前取整，闭区间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1634140800000'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '获取的历史数据的终止时间，格式为Unix时间戳，单位毫秒，非必填，默认为当前时间，统计的时间精度为小时，向后取整，开区间。例如：开始时间为11:12:20，结束时间为11:45:50，则对齐后的入参时间范围为[11:00:00,12:00:00) ，即大于等于11点，小于12点。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620273600000'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'."\n"], + ], + [ + 'name' => 'SkillGroupIdList', + 'in' => 'query', + 'schema' => ['description' => '技能组ID列表，列表大小0-100。', 'type' => 'string', 'required' => false, 'example' => '['."\n" + .' "skg1@ccc-test",'."\n" + .' "skg2@ccc-test"'."\n" + .']'], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO'], ], ], 'responses' => [ @@ -26980,527 +15477,509 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], 'Data' => [ - 'description' => '数据。', + 'description' => '分组坐席历史数据列表。', 'type' => 'object', 'properties' => [ - 'ReleaseInitiator' => [ - 'description' => '挂断方。', - 'type' => 'string', - 'enumValueTitles' => [ - 'agent ' => '坐席', - 'customer ' => '客户', - ], - 'example' => 'customer', - ], - 'ContactDisposition' => [ - 'description' => '电话结束原因，注意：语音邮箱、转人工失败、排队超时、排队溢出、IVR异常的挂断原因需要客户配置挂断原因节点才能体现出来，如果没有配置且IVR中无转人工模块，这时候的挂断原因默认为IVR放弃。', - 'type' => 'string', - 'enumValueTitles' => [ - 'AbandonedInQueue' => '排队放弃', - 'NoAnswer' => '客户未接', - 'QueuingTimeout' => '排队超时', - 'Voicemail' => '转语音邮箱', - 'QueuingFailed' => '转人工失败', - 'QueuingOverflow' => '排队溢出', - 'AbandonedInVoiceNavigator' => '智能导航中放弃', - 'Success' => '正常结束', - 'IVRException' => 'IVR系统异常', - 'AbandonedInRing' => '振铃放弃', - 'AbandonedInIVR' => 'IVR放弃', - 'Reject' => '客户拒接', - 'ForwardToOutsideNumber' => '转外线', - ], - 'example' => 'Success', - ], - 'ContactType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INBOUND' => '呼入', - 'CONFERENCE' => '会议', - 'INTERNAL' => '内部呼叫', - 'PRIVACY_DIAL' => '加密通话', - 'OUTBOUND' => '呼出', - 'BACK2BACK' => '双呼', - 'PREDICTIVE' => '预测式外呼', - ], - 'example' => 'OUTBOUND', - ], - 'AgentIds' => [ - 'description' => '坐席ID列表，表示通话流经的坐席，多个值用逗号分隔。', - 'type' => 'string', - 'example' => 'agent1@ccc-test,agent2@ccc-test', - ], - 'CallDuration' => [ - 'description' => '通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'RecordingReady' => [ - 'description' => '录音是否已经生成，若通话还没有建立，返回false。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'EstablishedTime' => [ - 'description' => '通话建立的时间，如果通话没有建立，此值为空，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1532458000000', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'SatisfactionSurveyOffered' => [ - 'description' => '是否发送了满意度调查。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'CalledNumber' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'example' => '1332315****', - ], - 'AgentNames' => [ - 'description' => '坐席名称列表，表示通话流经的坐席，多个值用逗号隔开。', - 'type' => 'string', - 'example' => 'agent1,agent2', - ], - 'Satisfaction' => [ - 'description' => '满意度结果，满意度的取值及含义由客户自定义。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'StartTime' => [ - 'description' => '通话开始时间，呼入从进入IVR开始，呼出从开始接通计算，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1532458000000', - ], - 'ContactId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-10963442671187****', - ], - 'SatisfactionSurveyChannel' => [ - 'description' => '发起满意度调查的渠道。', - 'type' => 'string', - 'enumValueTitles' => [ - 'IVR' => '语音满意度', - 'SMS' => '短信满意度', - ], - 'example' => 'IVR', - ], - 'ReleaseTime' => [ - 'description' => '通话结束时间，以参与通话的所有对象中最后一个挂断的时间为准，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1532458000000', - ], - 'CallingNumber' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'example' => '0533128****', - ], - 'SkillGroupNames' => [ - 'description' => '参与通话的座席所属的技能组名称，多个技能组以逗号分隔。', - 'type' => 'string', - 'example' => '测试技能组', - ], - 'SkillGroupIds' => [ - 'description' => '参与通话的座席所属的技能组ID，多个技能组以逗号分隔。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'AgentEvents' => [ - 'description' => '坐席事件列表。', + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数，只有PageNumber为1时才有数据，其他情况都是0。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'], + 'List' => [ + 'description' => '分组坐席历史数据列表。', 'type' => 'array', 'items' => [ - 'description' => '坐席事件。', + 'description' => '分组坐席历史数据。', 'type' => 'object', 'properties' => [ - 'AgentName' => [ - 'description' => '坐席名称。', - 'type' => 'string', - 'example' => '坐席小王', - ], - 'AgentId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', + 'AgentName' => ['description' => '坐席姓名。', 'type' => 'string', 'example' => '云呼测试坐席'], + 'AgentId' => ['description' => '座席ID。', 'type' => 'string', 'example' => 'agent1@ccc-test'], + 'DisplayId' => ['description' => '坐席的工号。', 'type' => 'string', 'example' => '1001'], + 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'Default'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + 'Inbound' => [ + 'description' => '呼入指标。', + 'type' => 'object', + 'properties' => [ + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsHandled' => ['description' => '应答量，即坐席应答的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为： TotalWorkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsBlindTransferIn' => ['description' => '直接转入量。若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAttendedTransferIn' => ['description' => '咨询转入量。若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsBlindTransferOut' => ['description' => '直接转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsOffered' => ['description' => '分配量，即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'HandleRate' => ['description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长，单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '8'], + 'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '9'], + ], ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', + 'Outbound' => [ + 'description' => '呼出指标。', + 'type' => 'object', + 'properties' => [ + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsDialed', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsBlindTransferIn' => ['description' => '直接转入量。若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '1.4'], + 'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAttendedTransferIn' => ['description' => '咨询转入量。若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsBlindTransferOut' => ['description' => '直接转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsAnswered。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。计算公式为：TotalDialingTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + ], ], - 'EventSequence' => [ - 'description' => '事件序列。', - 'type' => 'array', - 'items' => [ - 'description' => '事件。', - 'type' => 'object', - 'properties' => [ - 'Event' => [ - 'description' => '事件类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Released' => '挂机', - 'BlindTransfer' => '直接转接', - 'Coaching' => '辅导', - 'Barging' => '强插', - 'Consulting' => '咨询转接', - 'Ringing' => '振铃', - 'StartConference' => '开始会议', - 'Established' => '通话建立', - 'Dialing' => '拨号', - 'Intercepting' => '强拆', - 'Monitoring' => '监控', + 'Overall' => [ + 'description' => '整体指标。', + 'type' => 'object', + 'properties' => [ + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。'."\n" + .'_注意：不含离线和小休时长_', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'OccupancyRate' => ['description' => '座席利用率。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageBreakTime' => ['description' => '平均小休时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'TotalHoldTime' => ['description' => '总保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'MaxBreakTime' => ['description' => '最大小休时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/TotalCalls。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/(CallsAnswered+CallsHandled)。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '1.4'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位秒。计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/（呼入CallsHold+呼出CallsHold）。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalBreakTime' => ['description' => '总小休时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalCalls' => ['description' => '总电话量。计算公式为：CallsOffered + CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'BreakCodeDetailList' => [ + 'description' => '小休详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '小休详情。', + 'type' => 'object', + 'properties' => [ + 'BreakCode' => ['description' => '小休码。', 'type' => 'string', 'example' => '开会'], + 'Count' => ['description' => '次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Duration' => ['description' => '时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], ], - 'example' => 'Dialing', - ], - 'EventTime' => [ - 'description' => '事件发生时间戳，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1604639129000', - ], - 'Duration' => [ - 'description' => '时间的持续时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', ], ], + 'FirstCheckInTime' => ['description' => '最早签入时间，格式是unix时间戳，单位到毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1686030515000'], + 'LastCheckOutTime' => ['description' => '最后签出时间，格式是unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1686030515000'], + 'TotalOutboundScenarioTime' => ['description' => '总仅外呼在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalOutboundScenarioReadyTime' => ['description' => '总仅外呼空闲时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalOutboundScenarioLoggedInTime' => ['description' => '总仅外呼在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'], + 'TotalOfficePhoneLoggedInTime' => ['description' => '总办公电话在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'], + 'TotalOffSiteLggedInTime' => ['description' => '总场外在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'], + 'TotalOnSiteLoggedInTime' => ['description' => '总场内在线时长，单位秒。', 'type' => 'string', 'example' => '120'], + ], + ], + 'Internal' => [ + 'description' => '内部呼叫指标。', + 'type' => 'object', + 'properties' => [ + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsOffered' => ['description' => '电话呼入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsHandled' => ['description' => '电话应答数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsTalk' => ['description' => '坐席参与的通话次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsTalked' => ['description' => '参与通话次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + ], + ], + 'Back2Back' => [ + 'description' => '双呼指标。', + 'type' => 'object', + 'properties' => [ + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0.6'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AgentAnswerRate' => ['description' => '坐席侧应答率。', 'type' => 'number', 'format' => 'float', 'example' => '已弃用，请使用AgentHandleRate代替此参数'], + 'CallsCustomerHandled' => ['description' => '客户侧接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用CallsCustomerAnswered代替此参数'], + 'CustomerHandleRate' => ['description' => '客户侧接起率。', 'type' => 'number', 'format' => 'float', 'example' => '已弃用，请使用CustomerAnswerRate代替此参数'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'TotalCustomerRingTime' => ['description' => '总客户侧振岭时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxCustomerRingTime' => ['description' => '最大客户侧振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageCustomerRingTime' => ['description' => '平均客户侧振铃时长，单位秒', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'AgentHandleRate' => ['description' => '坐席应答率。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'CallsCustomerAnswered' => ['description' => '客户接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CustomerAnswerRate' => ['description' => '客户接通率。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'CallsAgentHandled' => ['description' => '坐席接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], ], ], ], ], ], - 'IvrEvents' => [ - 'description' => 'IVR事件列表。', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取分组坐席历史数据报表', + 'changeSet' => [ + ['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalAgentSkillGroupReport'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"AgentName\\": \\"云呼测试坐席\\",\\n \\"AgentId\\": \\"agent1@ccc-test\\",\\n \\"DisplayId\\": \\"1001\\",\\n \\"SkillGroupName\\": \\"Default\\",\\n \\"SkillGroupId\\": \\"skillgroup1@ccc-test\\",\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"TotalWorkTime\\": 100,\\n \\"CallsAttendedTransferOut\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 100,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"HandleRate\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 6,\\n \\"TotalMessagesSentByCustomer\\": 6,\\n \\"AverageFirstResponseTime\\": 8,\\n \\"AverageResponseTime\\": 9\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"TotalWorkTime\\": 100,\\n \\"CallsAttendedTransferOut\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalDialingTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 1.4,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxDialingTime\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageDialingTime\\": 100\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"TotalLoggedInTime\\": 100,\\n \\"OccupancyRate\\": 0.5,\\n \\"TotalWorkTime\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"AverageBreakTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"MaxBreakTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionIndex\\": 1.4,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"MaxReadyTime\\": 100,\\n \\"AverageReadyTime\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"TotalReadyTime\\": 100,\\n \\"TotalBreakTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"TotalCalls\\": 100,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"开会\\",\\n \\"Count\\": 1,\\n \\"Duration\\": 100\\n }\\n ],\\n \\"FirstCheckInTime\\": 1686030515000,\\n \\"LastCheckOutTime\\": 1686030515000,\\n \\"TotalOutboundScenarioTime\\": 100,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 120,\\n \\"TotalOfficePhoneLoggedInTime\\": 120,\\n \\"TotalOffSiteLggedInTime\\": 120,\\n \\"TotalOnSiteLoggedInTime\\": \\"120\\"\\n },\\n \\"Internal\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsTalk\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"CallsTalked\\": 5\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.6,\\n \\"CallsAnswered\\": 100,\\n \\"AgentAnswerRate\\": 0,\\n \\"CallsCustomerHandled\\": 0,\\n \\"CustomerHandleRate\\": 0,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 0.5,\\n \\"CallsCustomerAnswered\\": 100,\\n \\"CustomerAnswerRate\\": 0.5,\\n \\"CallsAgentHandled\\": 100\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListHistoricalSkillGroupReport' => [ + 'summary' => '调用ListHistoricalSkillGroupReport获取指定实例下的一个或多个技能组的历史数据报表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccOQKOLI'], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '100'], + ], + [ + 'name' => 'SkillGroupIdList', + 'in' => 'formData', + 'schema' => ['description' => '待查询的技能组ID列表，格式为JSON数组的字符串，数组元素为技能组ID，非必填，默认为空，表示查询当前分页下的所有技能组。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test2"]'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '获取的历史数据的起始时间，格式为Unix时间戳，单位毫秒，非必填，默认为当天的0时，最早为当前时间往前180天，统计的时间精度为小时，向前取整，闭区间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '获取的历史数据的终止时间，格式为Unix时间戳，单位毫秒，非必填，默认为当前时间，统计的时间精度为小时，向后取整，开区间。例如：开始时间为11:12:20，结束时间为11:45:50，则对齐后的入参时间范围为[11:00:00, 12:00:00) ，即大于等于11点，小于12点。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'List' => [ + 'description' => '技能组历史数据列表。', 'type' => 'array', 'items' => [ - 'description' => 'IVR事件。', + 'description' => '技能组历史数据。', 'type' => 'object', 'properties' => [ - 'FlowId' => [ - 'description' => 'IVR联系流ID。', - 'type' => 'string', - 'example' => 'edaf2eaa-8f88-44ca-812e-41b3cd2b7a90', - ], - 'EventSequence' => [ - 'description' => '事件序列。', - 'type' => 'array', - 'items' => [ - 'description' => '事件。', - 'type' => 'object', - 'properties' => [ - 'Event' => [ - 'description' => '事件类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Route2IVR' => '进入IVR', - 'Abandoned' => 'IVR中放弃', + 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Inbound' => [ + 'description' => '呼入指标。', + 'type' => 'object', + 'properties' => [ + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '5'], + 'CallsOverflow' => ['description' => '溢出量，即发生队列（技能组）溢出的电话数量。若一通电话多次进入同一队列，每次溢出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInRing' => ['description' => '振铃放弃量，即坐席振铃中客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '应答量，即坐席应答的次数。一通电话每次进入队列后，若被多个坐席应答，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '85'], + 'TotalAbandonedInRingTime' => ['description' => '总振铃放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'CallsAttendedTransferOut' => ['description' => '咨询转出量，即由该技能组发起的咨询转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWaitTime' => ['description' => '平均等待时长，平均每通电话的坐席接起前等待时长。计算公式为：TotalWaitTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '5'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxAbandonTime' => ['description' => '最大放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为： TotalWorkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '13'], + 'CallsQueued' => ['description' => '呼入场景进入队列（技能组）的电话数量，若一通电话多次进入同一队列，每次进入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], + 'CallsBlindTransferIn' => ['description' => '直接转入量，即由其他技能组发起的直接转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时签入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageAbandonedInRingTime' => ['description' => '平均振铃放弃时长，单位秒。计算公式为： TotalAbandonedInRingTime/CallsAbandonedInRing。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageAbandonTime' => ['description' => '平均放弃时长，单位秒。计算公式为：TotalAbandonTime/CallsAbandoned。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsRinged' => ['description' => '坐席振铃的电话数量，一通电话每次进入队列后，若分配给多个座席并产生了振铃，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], + 'CallsBlindTransferOut' => ['description' => '直接转出量，即由该技能组发起的直接转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAttendedTransferIn' => ['description' => '咨询转入量，即由其他技能组发起的咨询转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时迁入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandoned' => ['description' => '放弃量。计算公式为：CallsAbandonedInQueue+CallsAbandonedInRing。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxAbandonedInQueueTime' => ['description' => '最大排队放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWaitTime' => ['description' => '总等待时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '34'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '32'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'AbandonRate' => ['description' => '放弃率。计算公式为：CallsAbandoned/CallsOffered（由于放弃事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '447'], + 'TotalAbandonTime' => ['description' => '总放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '分配量，即分配给该技能组的电话数量，包括通过队列分配的电话数量和通过转接（咨询转接和直接转接）分配的电话数量。计算公式为：CallsQueued+CallsBlindTransferIn+CallsAttentandedTransferIn。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], + 'MaxAbandonedInRingTime' => ['description' => '最大振铃放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWaitTime' => ['description' => '最大等待时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '13'], + 'AverageAbandonedInQueueTime' => ['description' => '平均排队放弃时长，单位秒。计算公式为： TotalAbandonedInQueueTime/CallsAbandonedInQueue。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'ServiceLevel20' => ['description' => '20秒服务水平，等待时长小于等于20秒的电话数量/CallsQueued。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '64'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的次数。一通电话每次进入队列后，若发生多次通话保持，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'CallsTimeout' => ['description' => '超时量，即发生队列（技能组）超时的电话数量。若一通电话多次进入同一队列，每次超时算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalAbandonedInQueueTime' => ['description' => '总排队放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInQueue' => ['description' => '队列放弃量，即电话进入队列之后在排队环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsQueuingTimeout' => ['description' => '在排队阶段超时的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsQueuingOverflow' => ['description' => '队列溢出的通话数量，队列溢出指通话在IVR排队时队列溢出。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AccessChannelTypeDetails' => [ + 'description' => '各渠道的统计数据。', + 'type' => 'array', + 'items' => [ + 'description' => '各渠道的统计数据。', + 'type' => 'object', + 'properties' => [ + 'AccessChannelType' => ['description' => '渠道类型。', 'type' => 'string', 'example' => 'Web'], + 'CallsOffered' => ['description' => '分配的会话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], ], - 'example' => 'Route2IVR', ], - 'EventTime' => [ - 'description' => '事件发生时间戳，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1604639129000', + ], + 'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长，单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '6'], + 'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '8'], + 'CallsQueuingFailed' => ['description' => '队列失败量，即电话进入队列之后在排队环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ServiceLevel15' => ['description' => '15秒服务水平。', 'type' => 'number', 'format' => 'float', 'example' => '0.7'], + 'ServiceLevel30' => ['description' => '30秒服务水平。', 'type' => 'number', 'format' => 'float', 'example' => '0.9'], + 'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + ], + ], + 'Outbound' => [ + 'description' => '呼出指标。', + 'type' => 'object', + 'properties' => [ + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'CallsAttendedTransferOut' => ['description' => '咨询转出量，即由该技能组发起的咨询转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '218'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsDialed', 'type' => 'number', 'format' => 'float', 'example' => '2'], + 'CallsBlindTransferIn' => ['description' => '直接转入量，即由其他技能组发起的直接转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时签入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsRinged' => ['description' => '坐席振铃的电话数量，一通电话每次进入队列后，若分配给多个座席并产生了振铃，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAttendedTransferIn' => ['description' => '咨询转入量，即由其他技能组发起的咨询转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时迁入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsBlindTransferOut' => ['description' => '直接转出量，即由该技能组发起的直接转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsAnswered。', 'type' => 'number', 'format' => 'float', 'example' => '3'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的电话数量。一通电话在转出当前技能组之前，若发生多次通话保持，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。计算公式为：TotalDialingTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '37'], + ], + ], + 'Overall' => [ + 'description' => '整体指标。', + 'type' => 'object', + 'properties' => [ + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '449'], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。'."\n" + .'_注意：不含离线和小休时长_', 'type' => 'integer', 'format' => 'int64', 'example' => '23218'], + 'OccupancyRate' => ['description' => '座席利用率，计算公式为： (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', 'type' => 'number', 'format' => 'float', 'example' => '0.02332222293912065'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '94'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'AverageBreakTime' => ['description' => '平均小休时长，单位秒。计算公式为：TotalBreakTime/小休次数。小休次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxBreakTime' => ['description' => '最大小休时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/TotalCalls。', 'type' => 'number', 'format' => 'float', 'example' => '8'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/(CallsAnswered+CallsHandled)。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '19328'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位秒。计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '22428'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话量。计算公式为：CallsOffered + CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '13'], + 'BreakCodeDetailList' => [ + 'description' => '小休详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '小休详情。', + 'type' => 'object', + 'properties' => [ + 'BreakCode' => ['description' => '小休类型代码。', 'type' => 'string', 'example' => '会议'], + 'Count' => ['description' => '此类型小休的发生次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'Duration' => ['description' => '此类型小休的总计发生时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3600'], + ], ], ], ], ], - 'FlowType' => [ - 'description' => '联系流类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'SURVEY_FLOW' => '满意度流程', - 'MAIN_FLOW' => '主流程', + 'Back2Back' => [ + 'description' => '双呼指标。', + 'type' => 'object', + 'properties' => [ + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0.6'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'TotalCustomerRingTime' => ['description' => '总客户侧振岭时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxCustomerRingTime' => ['description' => '最大客户侧振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageCustomerRingTime' => ['description' => '平均客户侧振铃时长，单位秒', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'AgentHandleRate' => ['description' => '坐席应答率。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'CallsCustomerAnswered' => ['description' => '客户接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], + 'CustomerAnswerRate' => ['description' => '客户接通率。', 'type' => 'number', 'format' => 'float', 'example' => '0.8'], ], - 'example' => 'MAIN_FLOW', ], ], ], ], - 'QueueEvents' => [ - 'description' => '队列事件列表。', - 'type' => 'array', - 'items' => [ - 'description' => '队列事件。', - 'type' => 'object', - 'properties' => [ - 'QueueId' => [ - 'description' => '队列ID，如果是技能组队列，则为技能组ID，如果是坐席个人队列，则为坐席ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'QueueName' => [ - 'description' => '队列名称。', - 'type' => 'string', - 'example' => '测试技能组', - ], - 'FlowId' => [ - 'description' => '联系流ID。', - 'type' => 'string', - 'example' => 'edaf2eaa-8f88-44ca-812e-41b3cd2b7a90', - ], - 'QueueType' => [ - 'description' => '队列类型。', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - 1 => '技能组', - '坐席', - ], - 'example' => '1', - ], - 'EventSequence' => [ - 'description' => '事件序列。', - 'type' => 'array', - 'items' => [ - 'description' => '事件。', - 'type' => 'object', - 'properties' => [ - 'Event' => [ - 'description' => '事件类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'AssignAgent' => '分配坐席', - 'GiveUp' => '振铃放弃', - 'Enqueue' => '进队列', - 'QueueingOverflow' => '排队溢出', - 'Abandoned' => '队列放弃', - 'QueueingTimeout' => '排队超时', - ], - 'example' => 'Enqueue', - ], - 'EventTime' => [ - 'description' => '事件发生时间戳，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1604639129000', - ], - ], - ], - ], - ], - ], - ], - 'CustomerEvents' => [ - 'description' => '客户事件列表。', - 'type' => 'array', - 'items' => [ - 'description' => '客户事件。', - 'type' => 'object', - 'properties' => [ - 'CustomerId' => [ - 'description' => '客户ID，通常为客户号码。', - 'type' => 'string', - 'example' => '1332315****', - ], - 'EventSequence' => [ - 'description' => '事件序列。', - 'type' => 'array', - 'items' => [ - 'description' => '事件。', - 'type' => 'object', - 'properties' => [ - 'Event' => [ - 'description' => '事件类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'established' => '通话建立', - 'ringing' => '振铃', - 'released' => '挂机', - ], - 'example' => 'Released', - ], - 'EventTime' => [ - 'description' => '事件发生时间戳，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1532458000000', - ], - ], - ], - ], - ], - ], - ], - 'CallerLocation' => [ - 'description' => '主叫号码的归属地信息。', - 'type' => 'string', - 'example' => ' 山东省-淄博', - ], - 'CalleeLocation' => [ - 'description' => '被叫号码的归属地信息。', - 'type' => 'string', - 'example' => '河北省-唐山', - ], - 'EarlyMediaState' => [ - 'description' => '早媒体状态，指通话在早媒体阶段发生异常，此时通常是呼叫客户的阶段，发生异常会导致呼叫客户失败，因此该状态是根据早媒体的状态分析出来的可能的未接通原因。', - 'type' => 'string', - 'enumValueTitles' => [ - 'NoAnswer' => '无人接听', - 'OutOfService' => '停机', - 'NotExist' => '空号', - 'Restricted' => '呼叫受限', - 'Busy' => '占线', - 'NotConnected' => '无法接通', - 'PowerOff' => '关机', - ], - 'example' => 'NotConnected', - ], - 'ReleaseReason' => [ - 'description' => '通话结束原因，一般是 SipCode加文字描述格式.', - 'type' => 'string', - 'example' => '200 - OK', - ], - 'AnalyticsReportReady' => [ - 'type' => 'boolean', - ], - 'AnalyticsReport' => [ - 'type' => 'object', - 'properties' => [ - 'ProblemSolving' => [ - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - 'Solved' => [ - 'type' => 'boolean', - ], - 'Problem' => [ - 'type' => 'string', - ], - 'Solution' => [ - 'type' => 'string', - ], - ], - ], - 'Emotion' => [ - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - 'Type' => [ - 'type' => 'string', - ], - 'Confidence' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Remark' => [ - 'type' => 'string', - ], - ], - ], - 'Satisfaction' => [ - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - 'SatisfactionDescription' => [ - 'type' => 'string', - ], - 'Remark' => [ - 'type' => 'string', - ], - ], - ], - 'TodoList' => [ - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - 'Tasks' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'OutsideNumberReleaseReason' => [ - 'type' => 'string', - ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"Data\\": {\\n \\"ReleaseInitiator\\": \\"customer\\",\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"OUTBOUND\\",\\n \\"AgentIds\\": \\"agent1@ccc-test,agent2@ccc-test\\",\\n \\"CallDuration\\": 50,\\n \\"RecordingReady\\": true,\\n \\"EstablishedTime\\": 1532458000000,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SatisfactionSurveyOffered\\": true,\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"AgentNames\\": \\"agent1,agent2\\",\\n \\"Satisfaction\\": 1,\\n \\"StartTime\\": 1532458000000,\\n \\"ContactId\\": \\"job-10963442671187****\\",\\n \\"SatisfactionSurveyChannel\\": \\"IVR\\",\\n \\"ReleaseTime\\": 1532458000000,\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"SkillGroupNames\\": \\"测试技能组\\",\\n \\"SkillGroupIds\\": \\"skillgroup@ccc-test\\",\\n \\"AgentEvents\\": [\\n {\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Dialing\\",\\n \\"EventTime\\": 1604639129000,\\n \\"Duration\\": 3\\n }\\n ]\\n }\\n ],\\n \\"IvrEvents\\": [\\n {\\n \\"FlowId\\": \\"edaf2eaa-8f88-44ca-812e-41b3cd2b7a90\\",\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Route2IVR\\",\\n \\"EventTime\\": 1604639129000\\n }\\n ],\\n \\"FlowType\\": \\"MAIN_FLOW\\"\\n }\\n ],\\n \\"QueueEvents\\": [\\n {\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"QueueName\\": \\"测试技能组\\",\\n \\"FlowId\\": \\"edaf2eaa-8f88-44ca-812e-41b3cd2b7a90\\",\\n \\"QueueType\\": 1,\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Enqueue\\",\\n \\"EventTime\\": 1604639129000\\n }\\n ]\\n }\\n ],\\n \\"CustomerEvents\\": [\\n {\\n \\"CustomerId\\": \\"1332315****\\",\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Released\\",\\n \\"EventTime\\": 1532458000000\\n }\\n ]\\n }\\n ],\\n \\"CallerLocation\\": \\" 山东省-淄博\\",\\n \\"CalleeLocation\\": \\"河北省-唐山\\",\\n \\"EarlyMediaState\\": \\"NotConnected\\",\\n \\"ReleaseReason\\": \\"200 - OK\\",\\n \\"AnalyticsReportReady\\": true,\\n \\"AnalyticsReport\\": {\\n \\"ProblemSolving\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": true,\\n \\"Solved\\": true,\\n \\"Problem\\": \\"\\",\\n \\"Solution\\": \\"\\"\\n },\\n \\"Emotion\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": true,\\n \\"Type\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Remark\\": \\"\\"\\n },\\n \\"Satisfaction\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": true,\\n \\"SatisfactionDescription\\": \\"\\",\\n \\"Remark\\": \\"\\"\\n },\\n \\"TodoList\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": true,\\n \\"Tasks\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"OutsideNumberReleaseReason\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\n无\\n200\\n\\n skg-default@ccc-test\\n 133xxxx2315\\n Outbound\\n ccc-test\\n Success\\n customer\\n 1\\n NotConnected\\n 1532458000000\\n job-109634426711871319\\n 50\\n 053xxxx3128\\n 北京\\n 1532458000000\\n true\\n 默认技能组\\n 语音\\n true\\n user-test@ccc-test\\t\\n 1532458000000\\n 北京\\n 云呼测试坐席\\n \\n skg-default@ccc-test\\n user-test@ccc-test\\n 测试坐席\\t\\n \\n 1604639129000\\n Dialing\\n \\n \\n \\n edaf2eaa-8f88-44ca-812e-41b3cd2b7a90\\n skg-default@ccc-test\\n Defalut\\n 1\\n \\n 1604639129000\\n Enqueue\\n \\n \\n \\n 133xxxx2315\\n \\n 1532458000000\\n Released\\n \\n \\n \\n edaf2eaa-8f88-44ca-812e-41b3cd2b7a90\\n MAIN_FLOW\\n \\n 1604639129000\\n Route2IVR\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '获取通话详情', + 'title' => '获取技能组历史数据报表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetConversationDetail' => [ - 'summary' => '调用GetConversationDetail获取指定实例下指定通话ID对应的通话的对话详情，注意，实例及技能组需要开通质检推送才能获取到对话详情。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalSkillGroupReport'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 4,\\n \\"List\\": [\\n {\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 5,\\n \\"CallsOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"CallsHandled\\": 7,\\n \\"TotalWorkTime\\": 85,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"MaxWorkTime\\": 12,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"AverageWaitTime\\": 5,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageWorkTime\\": 13,\\n \\"CallsQueued\\": 7,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"CallsRinged\\": 7,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"TotalWaitTime\\": 34,\\n \\"TotalRingTime\\": 32,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 12,\\n \\"AbandonRate\\": 0,\\n \\"TotalTalkTime\\": 447,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 7,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"MaxWaitTime\\": 13,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"AverageTalkTime\\": 64,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 1,\\n \\"CallsTimeout\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"AccessChannelTypeDetails\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 2\\n }\\n ],\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 8,\\n \\"CallsQueuingFailed\\": 0,\\n \\"ServiceLevel15\\": 0.7,\\n \\"ServiceLevel30\\": 0.9,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 9,\\n \\"TotalMessagesSentByCustomer\\": 3\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 6,\\n \\"CallsAnswered\\": 1,\\n \\"TotalWorkTime\\": 9,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 218,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 2,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 3,\\n \\"MaxDialingTime\\": 12,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 3,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 37\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 449,\\n \\"TotalLoggedInTime\\": 23218,\\n \\"OccupancyRate\\": 0.02332222293912065,\\n \\"TotalWorkTime\\": 94,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 12,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 1,\\n \\"AverageWorkTime\\": 8,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 19328,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 22428,\\n \\"TotalBreakTime\\": 3,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 13,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 2,\\n \\"Duration\\": 3600\\n }\\n ]\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.6,\\n \\"CallsAnswered\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 1,\\n \\"CallsCustomerAnswered\\": 8,\\n \\"CustomerAnswerRate\\": 0.8\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\n无\\n200\\n\\n 4\\n 100\\n 1\\n \\n test1\\n skg-test1@ccc-test\\n \\n 0\\n 0\\n 85\\n 0\\n 7\\n 0\\n 12\\n 7\\n 0\\n 0\\n 0\\n 0\\n 32\\n 1\\n 0\\n 447\\n 5\\n 0\\n 7\\n 0\\n 0\\n 0\\n 0\\n 0\\n 64\\n 0\\n 0\\n 0\\n 0\\n 0\\n 7\\n 13\\n 0\\n 0\\n 0\\n 5\\n 34\\n 0\\n 0\\n 0\\n 0\\n 13\\n 12\\n 0\\n 0\\n \\n \\n 218\\n 9\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 37\\n 1\\n 3\\n 6\\n 12\\n 0\\n 0\\n 0\\n 0\\n 3\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 2\\n 0\\n 0\\n \\n \\n 22428\\n 13\\n 3\\n 94\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 449\\n 0\\n 23218\\n 0\\n 0\\n 19328\\n 8\\n 12\\n 1\\n 0.02332222293912065\\n 0\\n 0\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'ListInstances' => [ + 'summary' => '调用ListInstances获取当前阿里云账号下的云联络中心实例列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -27512,33 +15991,21 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '136495', - 'abilityTreeNodes' => [ - 'FEATUREccc5HY0NN', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'ContactId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'job-25884193037652****', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], ], 'responses' => [ @@ -27546,97 +16013,112 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7E407F9B-A278-52A0-B193-3EE5471D7A87', - ], - 'Phrases' => [ - 'description' => '对话列表。', - 'type' => 'array', - 'items' => [ - 'description' => '对话信息。', - 'type' => 'object', - 'properties' => [ - 'Identity' => [ - 'description' => '角色标识，系统内部使用，主要用于判断角色，客户无需关心。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Role' => [ - 'description' => '角色。', - 'type' => 'string', - 'enumValueTitles' => [ - '客服' => '客服', - '客户' => '客户', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'List' => [ + 'description' => '列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '实例状态。', + 'type' => 'string', + 'enumValueTitles' => ['RELEASED' => '已释放', 'RUNNING' => '正常运行中', 'STOPPED' => '已停服', 'CREATING' => '创建中'], + 'example' => 'RUNNING', + ], + 'ConsoleUrl' => ['description' => '云联络中心实例的网址，用于访问云呼叫中心实例的主页面，由云呼叫中心的特定网址加上实例ID组成。', 'type' => 'string', 'example' => 'https://ccc-v2.aliyun.com/#/workbench/ccc-test'], + 'Description' => ['description' => '实例的描述。', 'type' => 'string', 'example' => '云联络中心的测试实例。'], + 'CreateTime' => ['description' => '实例的创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1624679747000'], + 'AliyunUid' => ['description' => '实例所属的阿里云账户ID。', 'type' => 'string', 'example' => '157123456789****'], + 'Name' => ['description' => '实例名称。', 'type' => 'string', 'example' => '测试实例'], + 'DomainName' => ['description' => '实例的域名，全局唯一。', 'type' => 'string', 'example' => 'ccc-test'], + 'Id' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'AdminList' => [ + 'description' => '管理员列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '管理员的姓名。', 'type' => 'string', 'example' => '测试坐席'], + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'."\n"], + 'LoginName' => ['description' => '坐席登录名。', 'type' => 'string', 'example' => 'agent'], + 'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1382114****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'RoleName' => [ + 'description' => '角色名称。', + 'type' => 'string', + 'enumValueTitles' => ['Mannager' => '技能组组长', 'Agent' => '坐席', 'Admin' => '管理员'], + 'example' => 'Admin', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'RoleId' => ['description' => '角色ID，格式为：角色@实例ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'], + ], + 'description' => '', + ], + ], + 'NumberList' => [ + 'description' => '号码列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '0830011****'], + ], + 'description' => '', + ], + ], ], - 'example' => '客服', - ], - 'Begin' => [ - 'description' => '句子开始时间相对会话开始时间的偏移量，单位毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '240', - ], - 'End' => [ - 'description' => '句子结束时间相对会话开始时间的偏移量，单位毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1280', - ], - 'Words' => [ - 'description' => '对话文本内容。', - 'type' => 'string', - 'example' => '欢迎致电云联络中心', - ], - 'Finished' => [ - 'description' => '是否完结', - 'type' => 'boolean', - 'example' => 'false', + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7E407F9B-A278-52A0-B193-3EE5471D7A87\\",\\n \\"Phrases\\": [\\n {\\n \\"Identity\\": \\"agent@ccc-test\\",\\n \\"Role\\": \\"客服\\",\\n \\"Begin\\": 240,\\n \\"End\\": 1280,\\n \\"Words\\": \\"欢迎致电云联络中心\\",\\n \\"Finished\\": false\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取对话详情', - ], - 'GetHistoricalCallerReport' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '获取实例列表', + 'description' => '若RAM子账号需要调用该接口，则需具有“管理云呼叫中心(CCC)的权限”（AliyunCCCFullAccess）。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ConsoleUrl\\": \\"https://ccc-v2.aliyun.com/#/workbench/ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试实例。\\",\\n \\"CreateTime\\": 1624679747000,\\n \\"AliyunUid\\": \\"157123456789****\\",\\n \\"Name\\": \\"测试实例\\",\\n \\"DomainName\\": \\"ccc-test\\",\\n \\"Id\\": \\"ccc-test\\",\\n \\"AdminList\\": [\\n {\\n \\"DisplayName\\": \\"测试坐席\\",\\n \\"Extension\\": \\"8032****\\\\n\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ],\\n \\"NumberList\\": [\\n {\\n \\"Number\\": \\"0830011****\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'ListInstancesOfUser' => [ + 'summary' => '调用ListInstancesOfUser获取用户所属的云联络中心实例列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -27647,141 +16129,442 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTMAX45'], + ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'CallingNumber', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '来电号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1900000****', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3969FC68-CEC2-4398-B76A-60D2F7EDEBAF'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'List' => [ + 'description' => '列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '实例状态。', + 'type' => 'string', + 'enumValueTitles' => ['RELEASED（已注销）' => 'RELEASED（已注销）', 'CREATING（创建中）' => 'CREATING（创建中）', 'RUNNING（正常运行中）' => 'RUNNING（正常运行中）', 'STOPPED（已停服）' => 'STOPPED（已停服）'], + 'example' => 'RUNNING', + ], + 'ConsoleUrl' => ['description' => '云联络中心实例的网址，用于访问云联络中心实例的主页面，由云联络中心的特定网址加上实例ID组成。', 'type' => 'string', 'example' => 'https://ccc-v2.aliyun.com/#/workbench/ccc-test'], + 'Description' => ['description' => '实例的描述。', 'type' => 'string', 'example' => '云联络中心的测试实例。'], + 'AliyunUid' => ['description' => '实例所属的阿里云账户ID。', 'type' => 'string', 'example' => '157123456789****'], + 'Name' => ['description' => '实例名称。', 'type' => 'string', 'example' => '测试实例'], + 'DomainName' => ['description' => '实例的域名，全局唯一。', 'type' => 'string', 'example' => 'ccc-test'], + 'Id' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'AdminList' => [ + 'description' => '管理员列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '管理员的姓名。', 'type' => 'string', 'example' => '测试坐席'], + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'LoginName' => ['description' => '坐席登录名。', 'type' => 'string', 'example' => 'agent'], + 'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['OFF_SITE（场外模式）' => 'OFF_SITE（场外模式）', 'ON_SITE（场内模式）' => 'ON_SITE（场内模式）', 'OFFICE_PHONE（办公电话模式）' => 'OFFICE_PHONE（办公电话模式）'], + 'example' => 'ON_SITE', + ], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1382114****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'RoleName' => [ + 'description' => '角色名称。', + 'type' => 'string', + 'enumValueTitles' => ['Agent' => '坐席', 'Manager（技能组组长）' => 'Manager（技能组组长）', 'Admin（管理员）' => 'Admin（管理员）'], + 'example' => 'Admin', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'RoleId' => ['description' => '角色ID，格式为：角色@实例ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'], + ], + 'description' => '', + ], + ], + 'NumberList' => [ + 'description' => '号码列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Active' => ['description' => '是否可用。', 'type' => 'boolean', 'example' => 'true'], + 'UserId' => ['description' => '坐席ID，如果此参数不为空，说明该号码是座席个人外呼号码。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '0830011****'], + 'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '乐山'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Usage' => [ + 'description' => '号码用途。', + 'type' => 'string', + 'enumValueTitles' => ['Bidirection（呼入及呼出）' => 'Bidirection（呼入及呼出）', 'Inbound（呼入）' => 'Inbound（呼入）', 'Outbound（呼出）' => 'Outbound（呼出）'], + 'example' => 'Bidirection', + ], + 'ContactFlowId' => ['description' => '该电话号码所关联的联系流ID（IVR）。', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek'], + 'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '四川'], + 'SkillGroups' => [ + 'description' => '号码所关联的技能组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '技能组展示名。', 'type' => 'string', 'example' => '测试技能组'], + 'Description' => ['description' => '技能组描述。', 'type' => 'string', 'example' => '云联络中心的测试技能组。'], + 'PhoneNumberCount' => ['description' => '技能组关联的号码数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'UserCount' => ['description' => '技能组关联的坐席数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Name' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ], + ], + 'title' => '获取用户所属的实例列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstancesOfUser'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"3969FC68-CEC2-4398-B76A-60D2F7EDEBAF\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ConsoleUrl\\": \\"https://ccc-v2.aliyun.com/#/workbench/ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试实例。\\",\\n \\"AliyunUid\\": \\"157123456789****\\",\\n \\"Name\\": \\"测试实例\\",\\n \\"DomainName\\": \\"ccc-test\\",\\n \\"Id\\": \\"ccc-test\\",\\n \\"AdminList\\": [\\n {\\n \\"DisplayName\\": \\"测试坐席\\",\\n \\"Extension\\": \\"8032****\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ],\\n \\"NumberList\\": [\\n {\\n \\"Active\\": true,\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Number\\": \\"0830011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\",\\n \\"SkillGroups\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"UserCount\\": 2,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"3969FC68-CEC2-4398-B76A-60D2F7EDEBAF\\n无\\n200\\n无\\n\\n 1\\n 10\\n 1\\n \\n RUNNING\\n 测试实例\\n ccc-test\\n https://ccc-v2.aliyun.com/#/workbench/ccc-test\\n 157123456789****\\n ccc-test\\n 云呼测试实例\\n \\n 8032****\\n user-test\\n Admin\\n 1886666****@163.com\\n ccc-test\\n user-test@ccc-test\\n 云呼测试1\\n Admin@ccc-test\\n 1382114****\\n ON_SITE\\n \\n \\n Bidirection\\n true\\n 0830011****\\n ccc-test\\n a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\n user-test@ccc-test\\n 乐山\\n 四川\\n \\n 测试\\n 1\\n ccc-test\\n 2\\n 测试技能组\\n test@ccc-test\\n test\\n \\n \\n \\n\\nOK","errorExample":""}]', + ], + 'ListIntervalAgentReport' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], [ - 'name' => 'StopTime', + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], + 'parameters' => [ + [ + 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '查询的结束时间戳，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '4102416000000', - 'minimum' => '0', - 'example' => '1646928000000', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ 'name' => 'StartTime', 'in' => 'query', + 'schema' => ['description' => '开始时间，格式为Unix时间戳，单位毫秒，非必填，默认为当天的0时，统计的时间精度为小时，向前取整，闭区间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '截止时间，格式为Unix时间戳，单位毫秒，非必填，默认是当前时间，如果Interval为Daily，StartTime和EndTime最大间隔是180天。如果Interval为Hourly，最大间隔时间为10天。统计的时间精度为小时，向后取整，开区间。例如：开始时间为11:12:20，结束时间为11:45:50，则对齐后的入参时间范围为[11:00:00,12:00:00)，即大于等于11点，小于12点。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'Interval', + 'in' => 'query', 'schema' => [ - 'description' => '查询的开始时间戳，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '4102416000000', - 'minimum' => '0', - 'example' => '1646841600000', + 'description' => '分段统计类型，非必填，默认为Daily（按天汇总）。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Hourly' => '按小时统计', 'Daily' => '按天统计'], + 'example' => 'Hourly', ], ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'], 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'LastCallingTime' => [ - 'description' => '最近一次来电时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1646917200000', - ], - 'TotalCalls' => [ - 'description' => '该号码在查询时间段的总来电次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'description' => '坐席分段统计数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '坐席分段统计数据。', + 'type' => 'object', + 'properties' => [ + 'StatsTime' => ['description' => '时间段的开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620291600000'], + 'Inbound' => [ + 'description' => '呼入指标。', + 'type' => 'object', + 'properties' => [ + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsHandled' => ['description' => '应答量，即坐席应答的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsBlindTransferIn' => ['description' => '直接转入量。若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAttendedTransferIn' => ['description' => '咨询转入量。若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsBlindTransferOut' => ['description' => '直接转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '分配量，即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率。计算公式为：CallsHandled / CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AccessChannelTypeDetails' => [ + 'description' => '各渠道的统计数据。', + 'type' => 'array', + 'items' => [ + 'description' => '各渠道的统计数据。', + 'type' => 'object', + 'properties' => [ + 'AccessChannelType' => ['description' => '渠道类型。', 'type' => 'string', 'example' => 'Web'], + 'CallsOffered' => ['description' => '分配的会话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + ], + ], + ], + 'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长，单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '8'], + 'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '10'], + 'ServiceLevel15' => ['description' => '15秒服务水平。', 'type' => 'number', 'format' => 'float', 'example' => '0.6'], + 'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + ], + ], + 'Outbound' => [ + 'description' => '呼出指标。', + 'type' => 'object', + 'properties' => [ + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '148'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'CallsBlindTransferIn' => ['description' => '直接转入量。若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAttendedTransferIn' => ['description' => '咨询转入量。若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsBlindTransferOut' => ['description' => '直接转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsAnswered。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。计算公式为：TotalDialingTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '30'], + ], + ], + 'Overall' => [ + 'description' => '整体指标。', + 'type' => 'object', + 'properties' => [ + 'OccupancyRate' => ['description' => '座席利用率，计算公式为： (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'TotalHoldTime' => ['description' => '总保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/TotalCalls。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'MaxBreakTime' => ['description' => '最大小休时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '435'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '763'], + 'LastCheckoutTime' => ['description' => '入参Interval为Daily才有值，当天的最后下线时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用LastCheckOutTime代替此参数。'], + 'LastCheckOutTime' => ['description' => '入参Interval为Daily才有值，当天的最后下线时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话量。计算公式为：CallsOffered+CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。_注意：不包含离线和小休时长_。', 'type' => 'integer', 'format' => 'int64', 'example' => '914'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageBreakTime' => ['description' => '平均小休时长，单位秒。计算公式为：TotalBreakTime/小休次数。小休次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/(CallsAnswered+CallsHandled)。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位秒。计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalOnSiteOnlineTime' => ['description' => '总场内在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOnSiteLoggedInTime代替此参数'], + 'TotalOffSiteOnlineTime' => ['description' => '总场外在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOffSiteLoggedInTime代替此参数'], + 'TotalOfficePhoneOnlineTime' => ['description' => '总办公电话在线时长，单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOfficePhoneLoggedInTime代替此参数'], + 'BreakCodeDetailList' => [ + 'description' => '小休详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '小休详情。', + 'type' => 'object', + 'properties' => [ + 'BreakCode' => ['description' => '小休码。', 'type' => 'string', 'example' => '会议'], + 'Count' => ['description' => '数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Duration' => ['description' => '持续时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + ], + ], + ], + 'TotalOutboundScenarioTime' => ['description' => '总仅外呼时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOutboundScenarioLoggedInTime代替此参数'], + 'TotalOutboundScenarioReadyTime' => ['description' => '总仅外呼空闲时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'FirstCheckInTime' => ['description' => '入参Interval为Daily才有值，当天的首次上线时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalOfficePhoneLoggedInTime' => ['description' => '总办公电话在线时长，单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalOffSiteLoggedInTime' => ['description' => '总场外在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalOnSiteLoggedInTime' => ['description' => '总场内在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalOutboundScenarioLoggedInTime' => ['description' => '总仅外呼在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + ], + ], + 'Back2Back' => [ + 'description' => '双呼指标。', + 'type' => 'object', + 'properties' => [ + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'TotalCustomerRingTime' => ['description' => '总客户侧振岭时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxCustomerRingTime' => ['description' => '最大客户侧振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageCustomerRingTime' => ['description' => '平均客户侧振铃时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsAgentHandled' => ['description' => '坐席接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'AgentHandleRate' => ['description' => '坐席应答率。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'CallsCustomerAnswered' => ['description' => '客户接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'CustomerAnswerRate' => ['description' => '客户接通率。', 'type' => 'number', 'format' => 'float', 'example' => '0.75'], + ], + ], + 'Internal' => [ + 'description' => '内部呼叫指标。', + 'type' => 'object', + 'properties' => [ + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsHandled' => ['description' => '应答量，即坐席应答的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsOffered' => ['description' => '分配量，即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsTalked' => ['description' => '参与通话次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '80'], + ], + ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid. %s', - ], - [ - 'errorCode' => 'Parameter.Invalid', - 'errorMessage' => 'The parameter %s is invalid. %s.', - ], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], ], 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"LastCallingTime\\": 1646917200000,\\n \\"TotalCalls\\": 10\\n }\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n\\n 1646917200000\\n 10\\n\\nOK","errorExample":""}]', - 'title' => '获取历史来电报表', - 'summary' => '调用GetHistoricalCallerReport获取指定实例下指定来电号码的历史呼入报表。', + 'title' => '获取坐席分段统计报表', + 'summary' => '调用ListIntervalAgentReport获取指定实例下指定坐席的分段统计报表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetHistoricalInstanceReport' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-05-23T11:59:01.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalAgentReport'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1620291600000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AccessChannelTypeDetails\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 2\\n }\\n ],\\n \\"AverageFirstResponseTime\\": 8,\\n \\"AverageResponseTime\\": 10,\\n \\"ServiceLevel15\\": 0.6,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 10,\\n \\"TotalMessagesSentByCustomer\\": 2\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 5,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 4,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 2,\\n \\"TotalDialingTime\\": 148,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 1,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 60,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 30\\n },\\n \\"Overall\\": {\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 4,\\n \\"MaxWorkTime\\": 2,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 1,\\n \\"MaxBreakTime\\": 1,\\n \\"SatisfactionIndex\\": 0,\\n \\"MaxReadyTime\\": 435,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalReadyTime\\": 763,\\n \\"LastCheckoutTime\\": 0,\\n \\"LastCheckOutTime\\": 0,\\n \\"TotalCalls\\": 5,\\n \\"TotalLoggedInTime\\": 914,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"TotalBreakTime\\": 1,\\n \\"TotalOnSiteOnlineTime\\": 0,\\n \\"TotalOffSiteOnlineTime\\": 0,\\n \\"TotalOfficePhoneOnlineTime\\": 0,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 10,\\n \\"Duration\\": 100\\n }\\n ],\\n \\"TotalOutboundScenarioTime\\": 0,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"FirstCheckInTime\\": 0,\\n \\"TotalOfficePhoneLoggedInTime\\": 100,\\n \\"TotalOffSiteLoggedInTime\\": 100,\\n \\"TotalOnSiteLoggedInTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 100\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"CallsAnswered\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"CallsAgentHandled\\": 12,\\n \\"AgentHandleRate\\": 1,\\n \\"CallsCustomerAnswered\\": 9,\\n \\"CustomerAnswerRate\\": 0.75\\n },\\n \\"Internal\\": {\\n \\"AverageTalkTime\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsTalked\\": 80\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"943D8EF3-3321-471F-A104-51C96FCA94D6\\n无\\n200\\n\\n 1620291600000\\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 148\\n 4\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 30\\n 0\\n 0\\n 5\\n 60\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 1\\n 2\\n 0\\n \\n \\n 763\\n 5\\n 1\\n 0\\n 4\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 914\\n 0\\n 0\\n 435\\n 1\\n 2\\n 1\\n 0\\n 0\\n 0\\n \\n\\nOK","errorExample":""}]', + ], + 'ListIntervalAgentSkillGroupReport' => [ + 'summary' => '获取指定实例下指定坐席的分段统计报表。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -27792,833 +16575,263 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccOQKOLI'], + ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的起始时间，格式为Unix时间戳，单位毫秒，非必填，默认为当天的0时，最早为当前时间往前180天，统计的时间精度为小时，向前取整，闭区间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1532448000000', - ], + 'schema' => ['description' => '开始时间戳，默认为当天的0时。统计的时间精度为小时，向前取整，闭区间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的终止时间，格式为Unix时间戳，单位毫秒，非必填，默认为当前时间，统计的时间精度为小时，向后取整，开区间。例如：开始时间为11:12:20，结束时间为11:45:50，则对齐后的入参时间范围为[11:00:00,12:00:00) ，即大于等于11点，小于12点。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1532707199000', - ], + 'schema' => ['description' => '截止时间，格式为Unix时间戳，单位毫秒，非必填，默认是当前时间，如果Interval为Daily，StartTime和EndTime最大间隔是180天。如果Interval为Hourly，最大间隔时间为10天。统计的时间精度为小时，向后取整，开区间。例如：开始时间为11:12:20，结束时间为11:45:50，则对齐后的入参时间范围为[11:00:00,12:00:00)，即大于等于11点，小于12点。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1558443508000'], ], [ - 'name' => 'MediaType', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'Interval', 'in' => 'query', 'schema' => [ - 'description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', + 'description' => '分段统计类型，非必填，默认为Daily（按天汇总）。', 'type' => 'string', 'required' => false, - 'example' => 'VIDEO', + 'enumValueTitles' => ['Hourly' => '按小时统计。', 'Daily' => '按天统计。'], + 'example' => 'Daily', ], ], + [ + 'name' => 'SkillGroupId', + 'in' => 'query', + 'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'example' => ' '."\n" + .'skg-default@ccc-test'."\n"], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'], 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'Inbound' => [ - 'description' => '呼入数据。', - 'type' => 'object', - 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsVoicemail' => [ - 'description' => '转语音信箱的通话数量，当通话进入了IVR中配置的语音信箱模块，计数加1。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxAbandonedInIVRTime' => [ - 'description' => '最大IVR放弃时长，单位秒。IVR放弃的定义是客户在IVR交互过程中挂机，不包括排队状态下客户挂机，不包括通话分配坐席后坐席振铃过程中客户挂机。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsHandled' => [ - 'description' => '应答量，即被坐席应答的通话数量，若一通电话被多个坐席应答，只算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsIVRException' => [ - 'description' => '发生IVR异常的通话数量，判定条件是IVR进入了挂机原因节点且挂机原因节点设置的挂机原因为转人工失败，此时计数加1。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInIVR' => [ - 'description' => 'IVR放弃量，即电话进入IVR流程之后在IVR环节客户挂机的数量，判断依据为通话详情的挂断原因为IVR放弃。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxAbandonTime' => [ - 'description' => '最大放弃时长，单位秒。放弃的定义是通话进入IVR后，坐席接起前，客户发起挂机。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageAbandonTime' => [ - 'description' => '平均放弃时长，单位秒。计算公式为：TotalAbandonTime/CallsAbandoned。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsRinged' => [ - 'description' => '座席振铃的电话数量，若一通电话分配给多个座席并产生了振铃，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsQueuingFailed' => [ - 'description' => '队列失败量，即电话进入队列之后在排队环节客户挂机的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AbandonRate' => [ - 'description' => '放弃率。计算公式为：CallsAbandoned/CallsOffered（由于放弃事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxAbandonedInRingTime' => [ - 'description' => '最大振铃放弃时长，单位秒。振铃放弃的定义是通话分配到坐席后，坐席正在振铃，此时客户挂机。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsBlindTransferred' => [ - 'description' => '直接转接量，即发生直接转接的电话数量。若一通电话发起多次转接，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageAbandonedInIVRTime' => [ - 'description' => '平均IVR放弃时长，单位秒。计算公式为：TotalAbandonedInIVRTime/CallsAbandonedInIVR。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageAbandonedInQueueTime' => [ - 'description' => '平均排队放弃时长，单位秒。计算公式为：TotalAbandonedInQueueTime/CallsAbandonedInQueue。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxWaitTime' => [ - 'description' => '最大等待时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsAttendedTransferred' => [ - 'description' => '咨询转接量，即发生咨询转接的电话数量。若一通电话发起多次转接，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalAbandonedInIVRTime' => [ - 'description' => '总IVR放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsQueuingOverflow' => [ - 'description' => '队列溢出的通话数量，队列溢出指通话在IVR排队时队列溢出。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInRing' => [ - 'description' => '振铃放弃量，即坐席振铃过程中发生客户挂机的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalAbandonedInRingTime' => [ - 'description' => '总振铃放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWaitTime' => [ - 'description' => '平均等待时长，平均每通电话的坐席接起前等待时长。计算公式为： TotalWaitTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为： TotalWorkTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsQueued' => [ - 'description' => '进入队列的电话数量，若一通电话多次进入队列，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageAbandonedInRingTime' => [ - 'description' => '平均振铃放弃时长，单位秒。计算公式为：TotalAbandonedInRingTime/CallsAbandonedInRing。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsAbandoned' => [ - 'description' => '放弃量。计算公式为：CallsAbandonedInIVR+CallsAbandonedInQueue+CallsAbandonedInRing。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxAbandonedInQueueTime' => [ - 'description' => '最大排队放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInVoiceNavigator' => [ - 'description' => '通话在智能导航模块放弃的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWaitTime' => [ - 'description' => '总等待时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalAbandonTime' => [ - 'description' => '总放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '呼入到云联络中心的电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsQueuingTimeout' => [ - 'description' => '在排队阶段超时的通话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '20S服务水平，等待时长小于等于20秒的电话数量/CallsQueued。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsForwardToOutsideNumber' => [ - 'description' => '发生转外线的通话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的电话数量。若一通电话保持多次，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsAbandonedInQueue' => [ - 'description' => '队列放弃量，即电话进入队列之后在排队环节客户挂机的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalAbandonedInQueueTime' => [ - 'description' => '总排队放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsCausedIVRException' => [ - 'description' => '导致IVR异常的电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsToVoicemail' => [ - 'description' => '进入语音信箱的电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'ServiceLevel15' => [ - 'description' => '15秒服务水平。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.78', - ], - 'ServiceLevel30' => [ - 'description' => '30秒服务水平。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.9', - ], - 'TotalMessagesSent' => [ - 'description' => 'Chat会话中总消息发送量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'TotalMessagesSentByAgent' => [ - 'description' => 'Chat会话中坐席发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'TotalMessagesSentByCustomer' => [ - 'description' => 'Chat会话中客户发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', + 'description' => '坐席在对应技能组中的分段统计数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '坐席在对应技能组中的分段统计数据。', + 'type' => 'object', + 'properties' => [ + 'StatsTime' => ['description' => '时间段的开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620291600000'], + 'Inbound' => [ + 'description' => '呼入指标。', + 'type' => 'object', + 'properties' => [ + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '11'], + 'CallsHandled' => ['description' => '应答量，即坐席应答的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '85'], + 'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为： TotalWorkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsBlindTransferIn' => ['description' => '直接转入量。若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAttendedTransferIn' => ['description' => '咨询转入量。若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsBlindTransferOut' => ['description' => '直接转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsOffered' => ['description' => '分配量，即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'HandleRate' => ['description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长，单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '6'], + 'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '18'], + 'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], + 'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], ], - 'AverageFirstResponseTime' => [ - 'description' => 'Chat会话平均首次响应时长，单位为秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '12', + ], + 'Outbound' => [ + 'description' => '呼出指标。', + 'type' => 'object', + 'properties' => [ + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsBlindTransferIn' => ['description' => '直接转入量。若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsRinged' => ['description' => '坐席振铃的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAttendedTransferIn' => ['description' => '咨询转入量。若一通电话多次转入给该坐席，每次转入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsBlindTransferOut' => ['description' => '直接转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsAnswered。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。计算公式为：TotalDialingTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '100'], ], - 'AccessChannelTypeDetailList' => [ - 'description' => '各渠道的统计数据。', - 'type' => 'array', - 'items' => [ - 'description' => '渠道的统计数据。', - 'type' => 'object', - 'properties' => [ - 'AccessChannelType' => [ - 'description' => '渠道类型。', - 'type' => 'string', - 'example' => 'Web', - ], - 'CallsOffered' => [ - 'description' => '分配的会话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', + ], + 'Overall' => [ + 'description' => '整体指标。', + 'type' => 'object', + 'properties' => [ + 'OccupancyRate' => ['description' => '座席利用率。', 'type' => 'number', 'format' => 'float', 'example' => '0.4'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalHoldTime' => ['description' => '总保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/TotalCalls。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'MaxBreakTime' => ['description' => '最大小休时长，单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '1.4'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'LastCheckOutTime' => ['description' => '最后签出时间，格式是unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1712548421000'], + 'TotalCalls' => ['description' => '总电话量。计算公式为：CallsOffered + CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。_注意：不包含离线和小休时长_。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageBreakTime' => ['description' => '平均小休时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/(CallsAnswered+CallsHandled)。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'FirstCheckInTime' => ['description' => '入参Interval为Daily才有值，当天的首次上线时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/(Inbound.CallsHold+Outbound.CallsHold)。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位秒。计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'TotalBreakTime' => ['description' => '总小休时长，单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'BreakCodeDetailList' => [ + 'description' => '小休详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '小休详情。', + 'type' => 'object', + 'properties' => [ + 'BreakCode' => ['description' => '小休码。', 'type' => 'string', 'example' => '开会'], + 'Count' => ['description' => '次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Duration' => ['description' => '时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], ], ], ], - ], - 'AverageResponseTime' => [ - 'description' => 'Chat会话平均响应时长。', - 'type' => 'number', - 'format' => 'float', - 'example' => '15', - ], - ], - ], - 'Outbound' => [ - 'description' => '呼出指标。', - 'type' => 'object', - 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsDialed。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsRinged' => [ - 'description' => '坐席振铃的电话数量，若一通电话分配给多个坐席并产生了振铃，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsBlindTransferred' => [ - 'description' => '直接转接量，即发生直接转接的电话数量。若一通电话发起多次转接，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsAnswered。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsAttendedTransferred' => [ - 'description' => '咨询转接量，即发生咨询转接的电话数量。若一通电话发起多次转接，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的电话数量。若一通电话保持多次，算一次。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。计算公式为：TotalDialingTime/CallsDialed。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', + 'TotalOutboundScenarioTime' => ['description' => '总仅外呼时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalOutboundScenarioReadyTime' => ['description' => '总仅外呼空闲时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalOutboundScenarioLoggedInTime' => ['description' => '总仅外呼在线时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalOffSiteLoggedInTime' => ['description' => '总场外在线时长，单位秒。', 'type' => 'string', 'example' => '100'], + 'TotalOfficePhoneLoggedInTime' => ['description' => '办公电话在线时长，单位秒', 'type' => 'string', 'example' => '100'], + 'TotalOnSiteLoggedInTime' => ['description' => '总场内在线时长，单位秒。', 'type' => 'string', 'example' => '100'], + 'LastCheckoutTime' => ['description' => '入参Interval为Daily才有值，当天的最后下线时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], ], ], - ], - 'Overall' => [ - 'description' => '整体指标。', - 'type' => 'object', - 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。不包含小休时长。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，计算公式为： (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageBreakTime' => [ - 'description' => '平均小休时长，单位秒。计算公式为：TotalBreakTime/小休次数。小休次数为非接口统计字段。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxBreakTime' => [ - 'description' => '最大小休时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/TotalCalls。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/(CallsAnswered+CallsHandled)。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位秒。计算公式为：TotalReadyTime/就绪次数，就绪次数暂不对外暴露。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话量。计算公式为：CallsOffered + CallsDialed。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxLoggedInAgents' => [ - 'description' => '此时间范围内最多同时登录的座席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '102', + 'Internal' => [ + 'description' => '内部呼叫指标。', + 'type' => 'object', + 'properties' => [ + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsOffered' => ['description' => '分配量，即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsHandled' => ['description' => '应答量，即坐席应答的次数。一通电话每次进入队列后，若被多个坐席应答，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsTalk' => ['description' => '已废弃，该字段参考CallsTalked。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsTalked' => ['description' => '参与通话次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], ], ], - ], - 'Internal' => [ - 'description' => '内部呼叫指标。', - 'type' => 'object', - 'properties' => [ - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'Back2Back' => [ + 'description' => '双呼指标。', + 'type' => 'object', + 'properties' => [ + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AgentAnswerRate' => ['description' => '坐席测应答率。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsCustomerHandled' => ['description' => '客户测接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CustomerHandleRate' => ['description' => '客户测接起率。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'TotalCustomerRingTime' => ['description' => '总客户测振岭时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'MaxCustomerRingTime' => ['description' => '最大客户测振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageCustomerRingTime' => ['description' => '平均客户测振铃时长，单位秒', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'AgentHandleRate' => ['description' => '坐席应答率。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'CallsCustomerAnswered' => ['description' => '客户接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'CustomerAnswerRate' => ['description' => '客户接通率。', 'type' => 'number', 'format' => 'float', 'example' => '0.6'], + 'CallsAgentHandled' => ['description' => '坐席接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], ], ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": {\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsVoicemail\\": 0,\\n \\"MaxAbandonedInIVRTime\\": 100,\\n \\"CallsHandled\\": 0,\\n \\"CallsIVRException\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsQueuingFailed\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"AbandonRate\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AverageAbandonedInIVRTime\\": 0,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"MaxWaitTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"TotalAbandonedInIVRTime\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"AverageWaitTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsQueued\\": 0,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInVoiceNavigator\\": 0,\\n \\"TotalWaitTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"CallsForwardToOutsideNumber\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"CallsCausedIVRException\\": 0,\\n \\"CallsToVoicemail\\": 3,\\n \\"ServiceLevel15\\": 0.78,\\n \\"ServiceLevel30\\": 0.9,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 8,\\n \\"TotalMessagesSentByCustomer\\": 4,\\n \\"AverageFirstResponseTime\\": 12,\\n \\"AccessChannelTypeDetailList\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 5\\n }\\n ],\\n \\"AverageResponseTime\\": 15\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0,\\n \\"MaxLoggedInAgents\\": 102\\n },\\n \\"Internal\\": {\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"943D8EF3-3321-471F-A104-51C96FCA94D6\\n无\\n200\\n\\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取历史实例数据报表', - 'summary' => '调用GetHistoricalInstanceReport获取指定实例的历史数据报表。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetInstanceTrendingReport' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取分组坐席分段统计报表', + 'changeSet' => [ + ['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalAgentSkillGroupReport'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1620291600000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 11,\\n \\"CallsHandled\\": 7,\\n \\"TotalWorkTime\\": 85,\\n \\"CallsAttendedTransferOut\\": 10,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 100,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"HandleRate\\": 0.5,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 18,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 8,\\n \\"TotalMessagesSentByCustomer\\": 5\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"TotalWorkTime\\": 100,\\n \\"CallsAttendedTransferOut\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalDialingTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 100,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxDialingTime\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 100,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageDialingTime\\": 100\\n },\\n \\"Overall\\": {\\n \\"OccupancyRate\\": 0.4,\\n \\"TotalWorkTime\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"MaxBreakTime\\": 100,\\n \\"SatisfactionIndex\\": 1.4,\\n \\"MaxReadyTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"TotalReadyTime\\": 100,\\n \\"LastCheckOutTime\\": 1712548421000,\\n \\"TotalCalls\\": 100,\\n \\"TotalLoggedInTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageBreakTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"FirstCheckInTime\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageReadyTime\\": 100,\\n \\"TotalBreakTime\\": 100,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"开会\\",\\n \\"Count\\": 1,\\n \\"Duration\\": 100\\n }\\n ],\\n \\"TotalOutboundScenarioTime\\": 100,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 100,\\n \\"TotalOffSiteLoggedInTime\\": \\"100\\",\\n \\"TotalOfficePhoneLoggedInTime\\": \\"100\\",\\n \\"TotalOnSiteLoggedInTime\\": \\"100\\",\\n \\"LastCheckoutTime\\": 100\\n },\\n \\"Internal\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsTalk\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"CallsTalked\\": 100\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"CallsAnswered\\": 100,\\n \\"AgentAnswerRate\\": 100,\\n \\"CallsCustomerHandled\\": 100,\\n \\"CustomerHandleRate\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 1,\\n \\"CallsCustomerAnswered\\": 12,\\n \\"CustomerAnswerRate\\": 0.6,\\n \\"CallsAgentHandled\\": 5\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListIntervalInstanceReport' => [ + 'summary' => '调用ListIntervalInstanceReport获取指定实例的分段统计报表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -28629,53 +16842,37 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间戳，默认是当天开始时间，最早为当前时间往前180天，开始和截止时间间隔不能超过7天，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1604639129000', - ], + 'schema' => ['description' => '开始时间，格式为Unix时间戳，单位毫秒，非必填，默认为当天的0时，统计的时间精度为小时，向前取整，闭区间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620230400000'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '截止时间戳，默认是当前时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1604725528000', - ], + 'schema' => ['description' => '截止时间，格式为Unix时间戳，单位毫秒，非必填，默认是当前时间，如果Interval为Daily，StartTime和EndTime最大间隔是180天。如果Interval为Hourly，最大间隔时间为10天。统计的时间精度为小时，向后取整，开区间。例如：开始时间为11:12:20，结束时间为11:45:50，则对齐后的入参时间范围为[11:00:00,12:00:00) ，即大于等于11点，小于12点。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620316799000'], ], [ - 'name' => 'MediaType', + 'name' => 'Interval', 'in' => 'query', 'schema' => [ - 'description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', + 'description' => '分段统计类型，非必填，默认为Daily（按天汇总）。', 'type' => 'string', 'required' => false, - 'example' => 'Audio', + 'enumValueTitles' => ['Hourly' => '按小时统计', 'Daily' => '按天统计'], + 'example' => 'Hourly', ], ], ], @@ -28684,162 +16881,177 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'], 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'Inbound' => [ - 'description' => '呼入指标。', - 'type' => 'array', - 'items' => [ - 'description' => '呼入指标分段统计数据。', + 'description' => '实例分段统计数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例分段统计数据。', + 'type' => 'object', + 'properties' => [ + 'StatsTime' => ['description' => '开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620230400000'], + 'Inbound' => [ + 'description' => '呼入指标。', 'type' => 'object', 'properties' => [ - 'StatsTime' => [ - 'description' => '分段统计的开始时间点，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1604639129000', - ], - 'CallsQueued' => [ - 'description' => '进入队列的电话数，如果一个电话多次进队列，算一通。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInRing' => [ - 'description' => '振铃放弃量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '座席应答电话数。一通电话分给多个座席，算一通。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总进线量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInIVR' => [ - 'description' => 'IVR放弃量，即电话进入IVR流程之后在IVR环节放弃。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInQueue' => [ - 'description' => '队列放弃量，即电话进入技能组之后在排队环节放弃。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '5'], + 'CallsVoicemail' => ['description' => '通话进入语音留言信箱的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxAbandonedInIVRTime' => ['description' => '最大IVR放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '应答量，即坐席应答的电话数量。若一通电话被多个坐席应答，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], + 'CallsIVRException' => ['description' => '发生IVR异常的通话数量，判定条件是IVR进入了挂机原因节点且挂机原因节点设置的挂机原因为转人工失败，此时计数加1。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInIVR' => ['description' => 'IVR放弃量，即电话进入IVR流程之后在IVR环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '17'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxAbandonTime' => ['description' => '最大放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageAbandonTime' => ['description' => '平均放弃时长，单位秒。计算公式为：TotalAbandonTime/CallsAbandoned。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AbandonedRate' => ['description' => '已废弃，该字段可以参考AbandonRate', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsRinged' => ['description' => '座席振铃的电话数量，若一通电话分配给多个座席并产生了振铃，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], + 'CallsQueuingFailed' => ['description' => '队列失败量，即电话进入队列之后在排队环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '32'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '447'], + 'MaxAbandonedInRingTime' => ['description' => '最大振铃放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsBlindTransferred' => ['description' => '直接转接量，即发生直接转接的电话数量。若一通电话发起多次转接，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageAbandonedInIVRTime' => ['description' => '平均IVR放弃时长，单位秒。计算公式为：TotalAbandonedInIVRTime/CallsAbandonedInIVR。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageAbandonedInQueueTime' => ['description' => '平均排队放弃时长，单位秒。计算公式为：TotalAbandonedInQueueTime/CallsAbandonedInQueue。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxWaitTime' => ['description' => '最大等待时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '13'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '64'], + 'CallsAttendedTransferred' => ['description' => '咨询转接量，即发生咨询转接的电话数量。若一通电话发起多次转接，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalAbandonedInIVRTime' => ['description' => '总IVR放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsQueuingOverflow' => ['description' => '队列溢出的通话数量，即通话在IVR排队时队列溢出。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInRing' => ['description' => '振铃放弃量，即坐席振铃中客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalAbandonedInRingTime' => ['description' => '总振铃放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '85'], + 'AverageWaitTime' => ['description' => '平均等待时长，平均每通电话的坐席接起前等待时长。计算公式为： TotalWaitTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '5'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为： TotalWorkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '13'], + 'CallsQueued' => ['description' => '进入队列的电话数量，若一通电话多次进入队列，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], + 'AverageAbandonedInRingTime' => ['description' => '平均振铃放弃时长，单位秒。计算公式为：TotalAbandonedInRingTime/CallsAbandonedInRing。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsAbandoned' => ['description' => '放弃量。计算公式为：CallsAbandonedInIVR+CallsAbandonedInQueue+CallsAbandonedInRing。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxAbandonedInQueueTime' => ['description' => '最大排队放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInVoiceNavigator' => ['description' => '通话在智能导航模块放弃的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWaitTime' => ['description' => '总等待时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '34'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '219'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'TotalAbandonTime' => ['description' => '总放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '呼入到云联络中心的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], + 'CallsQueuingTimeout' => ['description' => '在排队阶段超时的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ServiceLevel20' => ['description' => '20秒服务水平，等待时长小于等于20秒的电话数量/CallsQueued。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsForwardToOutsideNumber' => ['description' => '发生转外线的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的电话数量。若一通电话保持多次，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsAbandonedInQueue' => ['description' => '队列放弃量，即电话进入队列之后在排队环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalAbandonedInQueueTime' => ['description' => '总排队放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AbandonRate' => ['description' => '放弃率。计算公式为：CallsAbandoned/CallsOffered（由于放弃事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsCausedIVRException' => ['description' => '导致IVR异常的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsToVoicemail' => ['description' => '转入语音信箱的电话数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长，单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '6'], + 'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '15'], + 'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'], + 'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], ], ], - ], - 'Outbound' => [ - 'description' => '呼出指标。', - 'type' => 'array', - 'items' => [ - 'description' => '呼出指标分段统计数据。', + 'Outbound' => [ + 'description' => '呼出指标。', 'type' => 'object', 'properties' => [ - 'StatsTime' => [ - 'description' => '分段统计的开始时间点，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1604639129000', - ], - 'CallsAnswered' => [ - 'description' => '外呼接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总外呼量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsRinged' => ['description' => '坐席振铃的电话数量，若一通电话分配给多个座席并产生了振铃，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsBlindTransferred' => ['description' => '直接转接量，即发生直接转接的电话数量。若一通电话发起多次转接，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsAnswered。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsAttendedTransferred' => ['description' => '咨询转接量，即发生咨询转接的电话数量。若一通电话发起多次转接，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的电话数量。若一通电话保持多次，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。计算公式为：TotalDialingTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '0'], ], ], - ], - 'Overall' => [ - 'description' => '整体指标。', - 'type' => 'array', - 'items' => [ + 'Overall' => [ + 'description' => '整体指标。', 'type' => 'object', 'properties' => [ - 'StatsTime' => [ - 'description' => '分段统计的开始时间点，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1604639129000', - ], - 'MaxLoggedInAgents' => [ - 'description' => '此时间范围内最多同时登录的座席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '102', - ], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。不包含小休时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OccupancyRate' => ['description' => '座席利用率，计算公式为： (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageBreakTime' => ['description' => '平均小休时长，单位秒。计算公式为：TotalBreakTime/小休次数。小休次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxBreakTime' => ['description' => '最大小休时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/TotalCalls。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/(CallsAnswered+CallsHandled)。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位秒。计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话量。计算公式为：CallsOffered + CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": {\\n \\"Inbound\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"CallsQueued\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalCalls\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"CallsAbandonedInQueue\\": 0\\n }\\n ],\\n \\"Outbound\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"CallsAnswered\\": 0,\\n \\"TotalCalls\\": 0\\n }\\n ],\\n \\"Overall\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"MaxLoggedInAgents\\": 102\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"943D8EF3-3321-471F-A104-51C96FCA94D6\\n无\\n200\\n\\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 1604639129000\\n 0\\n \\n \\n 0\\n 0\\n 1604639129000\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取实例趋势报表', - 'summary' => '调用GetInstanceTrendingReport获取指定实例的变化趋势报表。', + 'title' => '获取实例分段统计报表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetRealtimeInstanceStates' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalInstanceReport'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1620230400000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 5,\\n \\"CallsVoicemail\\": 0,\\n \\"MaxAbandonedInIVRTime\\": 0,\\n \\"CallsHandled\\": 7,\\n \\"CallsIVRException\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"MaxWorkTime\\": 17,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"AbandonedRate\\": 0,\\n \\"CallsRinged\\": 7,\\n \\"CallsQueuingFailed\\": 0,\\n \\"TotalRingTime\\": 32,\\n \\"TotalTalkTime\\": 447,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AverageAbandonedInIVRTime\\": 0,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"MaxWaitTime\\": 13,\\n \\"AverageTalkTime\\": 64,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"TotalAbandonedInIVRTime\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"TotalWorkTime\\": 85,\\n \\"AverageWaitTime\\": 5,\\n \\"AverageWorkTime\\": 13,\\n \\"CallsQueued\\": 7,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInVoiceNavigator\\": 0,\\n \\"TotalWaitTime\\": 34,\\n \\"MaxTalkTime\\": 219,\\n \\"MaxRingTime\\": 12,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 7,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"ServiceLevel20\\": 1,\\n \\"MaxHoldTime\\": 0,\\n \\"CallsForwardToOutsideNumber\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 1,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"AbandonRate\\": 0,\\n \\"CallsCausedIVRException\\": 0,\\n \\"CallsToVoicemail\\": 1,\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 15,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 8,\\n \\"TotalMessagesSentByCustomer\\": 4\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"943D8EF3-3321-471F-A104-51C96FCA94D6\\n无\\n200\\n\\n 1620291600000\\n \\n 1\\n 0\\n 85\\n 0\\n 7\\n 0\\n 0\\n 12\\n 7\\n 0\\n 0\\n 0\\n 0\\n 32\\n 1\\n 0\\n 0\\n 447\\n 5\\n 0\\n 7\\n 219\\n 0\\n 0\\n 0\\n 0\\n 64\\n 0\\n 0\\n 0\\n 0\\n 0\\n 7\\n 13\\n 0\\n 0\\n 0\\n 5\\n 34\\n 0\\n 0\\n 0\\n 13\\n 0\\n 17\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n\\nOK","errorExample":""}]', + ], + 'ListIntervalSkillGroupReport' => [ + 'summary' => '调用ListIntervalSkillGroupReport获取指定实例下指定技能组的分段统计报表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -28850,175 +17062,255 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccOQKOLI'], + ], 'parameters' => [ + [ + 'name' => 'SkillGroupId', + 'in' => 'query', + 'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skg-default@ccc-test'], + ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'MediaType', + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '开始时间，格式为Unix时间戳，单位毫秒，非必填，默认为当天的0时，统计的时间精度为小时，向前取整，闭区间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604639129000'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '截止时间，格式为Unix时间戳，单位毫秒，非必填，默认是当前时间，如果Interval为Daily，StartTime和EndTime最大间隔是180天。如果Interval为Hourly，最大间隔时间为10天。统计的时间精度为小时，向后取整，开区间。例如：开始时间为11:12:20，结束时间为11:45:50，则对齐后的入参时间范围为[11:00:00,12:00:00) ，即大于等于11点，小于12点。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604725528000'], + ], + [ + 'name' => 'Interval', 'in' => 'query', 'schema' => [ - 'description' => '媒体类型，默认是语音(AUDIO)。', + 'description' => '分段统计类型，默认为Daily（按天汇总）。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'ALL' => '全部', - 'VIDEO' => '视频', - 'CHAT' => '聊天', - 'AUDIO' => '语音', - ], - 'example' => 'AUDIO', + 'enumValueTitles' => ['Hourly' => '按小时统计', 'Daily' => '按天统计'], + 'example' => 'Hourly', ], ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6'], 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'WorkingAgents' => [ - 'description' => '处于话后处理状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LongestWaitingTime' => [ - 'description' => '当前正在排队的来电的最大排队等待时长。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LoggedInAgents' => [ - 'description' => '在线坐席数量（包括就绪，小休，通话等非下线状态的坐席）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalAgents' => [ - 'description' => '总坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'WaitingCalls' => [ - 'description' => '当前正在排队的来电的个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'BreakingAgents' => [ - 'description' => '处于小休状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TalkingAgents' => [ - 'description' => '处于通话状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'InteractiveCalls' => [ - 'description' => '正在IVR中交互的电话的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ReadyAgents' => [ - 'description' => '处于就绪状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'BreakCodeDetailList' => [ - 'description' => '各个小休码次数分布列表。', - 'type' => 'array', - 'items' => [ + 'description' => '技能组分段统计数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '技能组分段统计数据。', + 'type' => 'object', + 'properties' => [ + 'StatsTime' => ['description' => '时间段的开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000'], + 'Inbound' => [ + 'description' => '呼入指标。', 'type' => 'object', 'properties' => [ - 'BreakCode' => [ - 'description' => '小休码。', - 'type' => 'string', - 'example' => '默认', - ], - 'Count' => [ - 'description' => '小休次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '11'], + 'CallsOverflow' => ['description' => '溢出量，即发生队列（技能组）溢出的电话数量。若一通电话多次进入同一队列，每次溢出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInRing' => ['description' => '振铃放弃量，即坐席振铃中客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '应答量，即坐席应答的次数。一通电话每次进入队列后，若被多个坐席应答，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '23'], + 'TotalAbandonedInRingTime' => ['description' => '总振铃放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '19'], + 'CallsAttendedTransferOut' => ['description' => '咨询转出量，即由该技能组发起的咨询转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWaitTime' => ['description' => '平均等待时长，平均每通电话的坐席接起前等待时长。计算公式为：TotalWaitTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '11'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxAbandonTime' => ['description' => '最大放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为： TotalWorkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '8'], + 'CallsQueued' => ['description' => '呼入场景进入队列（技能组）的电话数量，若一通电话多次进入同一队列，每次进入算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'CallsBlindTransferIn' => ['description' => '直接转入量，即由其他技能组发起的直接转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时签入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageAbandonedInRingTime' => ['description' => '平均振铃放弃时长，单位秒。计算公式为： TotalAbandonedInRingTime/CallsAbandonedInRing。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageAbandonTime' => ['description' => '平均放弃时长，单位秒。计算公式为：TotalAbandonTime/CallsAbandoned。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsRinged' => ['description' => '坐席振铃的电话数量，一通电话每次进入队列后，若分配给多个座席并产生了振铃，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'CallsBlindTransferOut' => ['description' => '直接转出量，即由该技能组发起的直接转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAttendedTransferIn' => ['description' => '咨询转入量，即由其他技能组发起的咨询转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时迁入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandoned' => ['description' => '放弃量。计算公式为：CallsAbandonedInQueue+CallsAbandonedInRing。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxAbandonedInQueueTime' => ['description' => '最大排队放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWaitTime' => ['description' => '总等待时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '33'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '33'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '18'], + 'AbandonRate' => ['description' => '放弃率。计算公式为：CallsAbandoned/CallsOffered（由于放弃事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'TotalAbandonTime' => ['description' => '总放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '分配量，即分配给该技能组的电话数量，包括通过队列分配的电话数量和通过转接（咨询转接和直接转接）分配的电话数量。计算公式为：CallsQueued+CallsBlindTransferIn+CallsAttentandedTransferIn。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'MaxAbandonedInRingTime' => ['description' => '最大振铃放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWaitTime' => ['description' => '最大等待时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '18'], + 'AverageAbandonedInQueueTime' => ['description' => '平均排队放弃时长，单位秒。计算公式为： TotalAbandonedInQueueTime/CallsAbandonedInQueue。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'ServiceLevel20' => ['description' => '20秒服务水平，等待时长小于等于20秒的电话数量/CallsQueued。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/CallsHandled。', 'type' => 'number', 'format' => 'float', 'example' => '5'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的次数。一通电话每次进入队列后，若发生多次通话保持，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0.6666666666666666'], + 'CallsTimeout' => ['description' => '超时量，即发生队列（技能组）超时的电话数量。若一通电话多次进入同一队列，每次超时算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalAbandonedInQueueTime' => ['description' => '总排队放弃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAbandonedInQueue' => ['description' => '队列放弃量，即电话进入队列之后在排队环节客户挂机的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsQueuingOverflow' => ['description' => '队列溢出的通话数量，即通话在IVR排队时队列溢出。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsQueuingTimeout' => ['description' => '在排队阶段超时的通话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalMessagesSent' => ['description' => 'Chat会话中总消息发送量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'TotalMessagesSentByAgent' => ['description' => 'Chat会话中坐席发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], + 'TotalMessagesSentByCustomer' => ['description' => 'Chat会话中客户发送的总消息量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'AverageFirstResponseTime' => ['description' => 'Chat会话平均首次响应时长，单位为秒。', 'type' => 'number', 'format' => 'float', 'example' => '6'], + 'AverageResponseTime' => ['description' => 'Chat会话平均响应时长。', 'type' => 'number', 'format' => 'float', 'example' => '18'], + ], + ], + 'Outbound' => [ + 'description' => '呼出指标。', + 'type' => 'object', + 'properties' => [ + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'CallsAttendedTransferOut' => ['description' => '咨询转出量，即由该技能组发起的咨询转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], + 'TotalHoldTime' => ['description' => '总通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '3'], + 'CallsBlindTransferIn' => ['description' => '直接转入量，即由其他技能组发起的直接转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时签入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsRinged' => ['description' => '坐席振铃的电话数量，一通电话每次进入队列后，若分配给多个座席并产生了振铃，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAttendedTransferIn' => ['description' => '咨询转入量，即由其他技能组发起的咨询转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时迁入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsBlindTransferOut' => ['description' => '直接转出量，即由该技能组发起的直接转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '49'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsAnswered。', 'type' => 'number', 'format' => 'float', 'example' => '5'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'CallsHold' => ['description' => '保持量，即发生通话保持的电话数量。一通电话在转出当前技能组之前，若发生多次通话保持，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。计算公式为：TotalDialingTime/CallsDialed。', 'type' => 'number', 'format' => 'float', 'example' => '30'], + ], + ], + 'Overall' => [ + 'description' => '整体指标。', + 'type' => 'object', + 'properties' => [ + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '13'], + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '9236'], + 'OccupancyRate' => ['description' => '座席利用率，计算公式为： (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', 'type' => 'number', 'format' => 'float', 'example' => '0.00422315148470254'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '27'], + 'MaxHoldTime' => ['description' => '最大通话保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '19'], + 'AverageBreakTime' => ['description' => '平均小休时长，单位秒。计算公式为：TotalBreakTime/小休次数。小休次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalHoldTime' => ['description' => '总保持时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionRate' => ['description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'MaxBreakTime' => ['description' => '最大小休时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/TotalCalls。', 'type' => 'number', 'format' => 'float', 'example' => '6'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/(CallsAnswered+CallsHandled)。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大就绪时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '4927'], + 'AverageReadyTime' => ['description' => '平均就绪时长，单位秒。计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageHoldTime' => ['description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总就绪时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '9106'], + 'TotalBreakTime' => ['description' => '总小休时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'TotalCalls' => ['description' => '总电话量。计算公式为：CallsOffered + CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'BreakCodeDetailList' => [ + 'description' => '各类型小休统计数据。', + 'type' => 'array', + 'items' => [ + 'description' => '小休统计数据。', + 'type' => 'object', + 'properties' => [ + 'BreakCode' => ['description' => '小休类型代码。', 'type' => 'string', 'example' => '会议'], + 'Count' => ['description' => '此类型小休的发生次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Duration' => ['description' => '此类型小休的总计发生时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'], + ], + ], ], ], ], + 'Back2Back' => [ + 'description' => '双呼指标。', + 'type' => 'object', + 'properties' => [ + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageCustomerRingTime' => ['description' => '平均客户侧振铃时长，单位秒', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'CallsCustomerAnswered' => ['description' => '客户接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'CustomerAnswerRate' => ['description' => '客户接通率。', 'type' => 'number', 'format' => 'float', 'example' => '0.6'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'CallsAnswered' => ['description' => '接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'number', 'format' => 'float', 'example' => '100'], + 'MaxCustomerRingTime' => ['description' => '最大客户侧振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'TotalCustomerRingTime' => ['description' => '总客户侧振岭时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'AgentHandleRate' => ['description' => '坐席应答率。', 'type' => 'number', 'format' => 'float', 'example' => '1'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'string', 'example' => '100'], + 'AnswerRate' => ['description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'string', 'example' => '0.5'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'string', 'example' => '100'], + 'CallsAgentHandled' => ['description' => '坐席接听电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + ], + ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": {\\n \\"WorkingAgents\\": 0,\\n \\"LongestWaitingTime\\": 0,\\n \\"LoggedInAgents\\": 0,\\n \\"TotalAgents\\": 0,\\n \\"WaitingCalls\\": 0,\\n \\"BreakingAgents\\": 0,\\n \\"TalkingAgents\\": 0,\\n \\"InteractiveCalls\\": 0,\\n \\"ReadyAgents\\": 0,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"默认\\",\\n \\"Count\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"943D8EF3-3321-471F-A104-51C96FCA94D6\\n无\\n200\\n\\n 0\\n 0\\n ccc-test\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n\\nOK","errorExample":""}]', - 'title' => '获取实时实例状态', - 'summary' => '调用GetRealtimeInstanceStates获取指定实例的实时状态。', + 'title' => '获取技能组分段统计报表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListAgentStateLogs' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalSkillGroupReport'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 11,\\n \\"CallsOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"CallsHandled\\": 2,\\n \\"TotalWorkTime\\": 23,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"MaxWorkTime\\": 19,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"AverageWaitTime\\": 11,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageWorkTime\\": 8,\\n \\"CallsQueued\\": 3,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"CallsRinged\\": 3,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"TotalWaitTime\\": 33,\\n \\"TotalRingTime\\": 33,\\n \\"MaxTalkTime\\": 6,\\n \\"MaxRingTime\\": 18,\\n \\"AbandonRate\\": 0,\\n \\"TotalTalkTime\\": 9,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 3,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"MaxWaitTime\\": 18,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"AverageTalkTime\\": 5,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0.6666666666666666,\\n \\"CallsTimeout\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 7,\\n \\"TotalMessagesSentByCustomer\\": 5,\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 18\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 2,\\n \\"CallsAnswered\\": 1,\\n \\"TotalWorkTime\\": 5,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 4,\\n \\"TotalDialingTime\\": 60,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 3,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 5,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 5,\\n \\"MaxDialingTime\\": 49,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 5,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 30\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 13,\\n \\"TotalLoggedInTime\\": 9236,\\n \\"OccupancyRate\\": 0.00422315148470254,\\n \\"TotalWorkTime\\": 27,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 19,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 1,\\n \\"AverageWorkTime\\": 6,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 4927,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 9106,\\n \\"TotalBreakTime\\": 5,\\n \\"MaxTalkTime\\": 6,\\n \\"TotalCalls\\": 5,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 1,\\n \\"Duration\\": 120\\n }\\n ]\\n },\\n \\"Back2Back\\": {\\n \\"MaxRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"CallsCustomerAnswered\\": 12,\\n \\"CustomerAnswerRate\\": 0.6,\\n \\"TotalRingTime\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 1,\\n \\"MaxTalkTime\\": \\"100\\",\\n \\"AnswerRate\\": \\"0.5\\",\\n \\"AverageTalkTime\\": \\"100\\",\\n \\"CallsAgentHandled\\": 5\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"943D8EF3-3321-471F-A104-51C96FCA94D6\\n无\\n200\\n\\n 1604639129000\\n \\n 0\\n 0\\n 23\\n 0\\n 3\\n 0\\n 18\\n 3\\n 0\\n 0\\n 0\\n 0\\n 33\\n 0.6666666666666666\\n 0\\n 9\\n 11\\n 0\\n 3\\n 6\\n 0\\n 0\\n 0\\n 0\\n 5\\n 0\\n 0\\n 0\\n 0\\n 0\\n 2\\n 18\\n 0\\n 0\\n 0\\n 11\\n 33\\n 0\\n 0\\n 0\\n 0\\n 8\\n 19\\n 0\\n 0\\n \\n \\n 60\\n 5\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 30\\n 1\\n 5\\n 2\\n 49\\n 5\\n 0\\n 3\\n 4\\n 0\\n 5\\n 0\\n \\n \\n 9106\\n 5\\n 5\\n 27\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 13\\n 0\\n 9236\\n 6\\n 0\\n 4927\\n 6\\n 19\\n 1\\n 0.00422315148470254\\n 0\\n 0\\n \\n\\nOK","errorExample":""}]', + ], + 'ListIvrTrackingDetails' => [ + 'summary' => '调用ListIvrTrackingDetails获取指定实例下指定通话的IVR轨迹详情。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -29029,55 +17321,32 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], + ], 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间戳，默认是当天开始时间，最早为当前日期之前的180天，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1620230400000', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'EndTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '截止时间戳，默认是当前时间，EndTime和StartTime的时间差不能超过7天，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1620273600000', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10'], ], [ - 'name' => 'AgentId', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-10963442671187****'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], ], 'responses' => [ @@ -29085,118 +17354,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D2RB671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Data' => [ 'description' => '数据。', - 'type' => 'array', - 'items' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => '状态开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1620259200000', - ], - 'StateCode' => [ - 'description' => '子状态，状态码的补充说明，某些坐席状态由State和StateCode共同标识，例如：监听场景，状态为Talking，子状态为Monitoring。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Monitored' => '被监听', - 'Consulted' => '被咨询', - 'Consulting' => '咨询中', - 'Conference' => '会议', - 'Monitoring' => '监听中', - ], - 'example' => 'CHECK_IN_BREAK', - ], - 'Duration' => [ - 'description' => '状态持续时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32', - ], - 'State' => [ - 'description' => '状态码。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Ready' => '空闲', - 'Talking' => '通话', - 'ACW' => '话后处理', - 'Ringing' => '振铃', - 'Break' => '小休', - 'Offline' => '下线', - 'Dialing' => '拨号', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'List' => [ + 'description' => 'IVR轨迹详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IVR轨迹详情。', + 'type' => 'object', + 'properties' => [ + 'Instance' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Callee' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '0533128****'], + 'EnterTime' => ['description' => '进入该IVR节点的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1621910542876'], + 'NodeVariables' => ['description' => '节点变量。', 'type' => 'object', 'example' => '{"digits":"2"}'], + 'NodeExitCode' => [ + 'description' => '节点的状态码。', + 'type' => 'string', + 'enumValueTitles' => ['Timeout' => '队列/函数/收号等超时', 'Hangup' => '客户挂机', 'Default' => '逻辑判断缺省出口', 'Branch-A/B/C' => '各个逻辑判断出口', 'Success' => '成功', 'Failure' => '失败', 'Overflow' => '队列溢出'], + 'example' => 'Success', + ], + 'FlowName' => ['description' => '联系流名称。', 'type' => 'string', 'example' => '测试IVR'], + 'FlowId' => ['description' => '联系流ID。', 'type' => 'string', 'example' => 'abc99462-1058-47d0-a114-f145ea7444ff'], + 'NodeProperties' => ['description' => '节点的属性集合。', 'type' => 'object', 'example' => '{"say":"您好。"}'], + 'NodeType' => [ + 'description' => '节点类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'ASR' => '语音识别', 'SUB' => '子流程', 'INCOMING_CALL' => '开始', 'GATHER_INPUT' => '收号', 'SUB_END' => '子流程结束', 'BLIND_TRANSFER' => '直接转接', 'JSON_PARSER' => 'JSON解析', 'SUB_START' => '子流程开始', 'SATISFACTION_RATING' => '满意度收集', 'TRANSFER_TO_AGENT' => '转人工', + 'SPLIT' => '分支', 'SET_VARIABLES' => '设置变量', 'VOICE_NAVIGATOR' => '智能导航', 'PLAY_SAY' => '放音', 'HANGUP_REASON' => '挂机原因', 'HANGUP' => '结束', 'SMS' => '发短信', 'VOICE_MAIL' => '语音信箱', 'RUN_FUNCTION' => '函数计算', 'HTTP_REQUEST' => 'HTTP请求', + 'FORWARD_TO_OUTSIDE_NUMBER' => '转外线', + ], + 'example' => 'PLAY_SAY', + ], + 'Caller' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '1332315****'], + 'NodeName' => ['description' => '节点名称。', 'type' => 'string', 'example' => '放音'], + 'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-10963442671187****'], + 'LeaveTime' => ['description' => '离开该IVR节点的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1621910545105'], + 'ChannelVariables' => ['description' => '随路数据。', 'type' => 'string', 'example' => 'A=B;C=D'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => '65cp2c15-92ac-4e67-98b2-073a3c541c5d'], + 'NodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'e0bc19a3'], ], - 'example' => 'Break', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否为仅外呼状态。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'BreakCode' => [ - 'description' => '小休码。', - 'type' => 'string', - 'example' => '会议', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'example' => 'ON_SITE', ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'], + ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StartTime\\": 1620259200000,\\n \\"StateCode\\": \\"CHECK_IN_BREAK\\",\\n \\"Duration\\": 32,\\n \\"State\\": \\"Break\\",\\n \\"OutboundScenario\\": false,\\n \\"BreakCode\\": \\"会议\\",\\n \\"WorkMode\\": \\"ON_SITE\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"943D8EF3-3321-471F-A104-51C96FCA94D6\\n无\\n200\\n\\n Break\\n CHECK_IN_BREAK\\n 1620259200000\\n false\\n 5903871\\n\\nOK","errorExample":""}]', - 'title' => '获取坐席状态日志列表', - 'summary' => '调用ListAgentStateLogs获取指定实例下指定坐席的状态日志列表。注意本接口即将过期，请使用替代接口ListRealtimeAgentStates。', + 'title' => '获取IVR轨迹详情列表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListCallDetailRecords' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIvrTrackingDetails'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"D2RB671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"List\\": [\\n {\\n \\"Instance\\": \\"ccc-test\\",\\n \\"Callee\\": \\"0533128****\\",\\n \\"EnterTime\\": 1621910542876,\\n \\"NodeVariables\\": {\\n \\"digits\\": \\"2\\"\\n },\\n \\"NodeExitCode\\": \\"Success\\",\\n \\"FlowName\\": \\"测试IVR\\",\\n \\"FlowId\\": \\"abc99462-1058-47d0-a114-f145ea7444ff\\",\\n \\"NodeProperties\\": {\\n \\"say\\": \\"您好。\\"\\n },\\n \\"NodeType\\": \\"PLAY_SAY\\",\\n \\"Caller\\": \\"1332315****\\",\\n \\"NodeName\\": \\"放音\\",\\n \\"ContactId\\": \\"job-10963442671187****\\",\\n \\"LeaveTime\\": 1621910545105,\\n \\"ChannelVariables\\": \\"A=B;C=D\\",\\n \\"ChannelId\\": \\"65cp2c15-92ac-4e67-98b2-073a3c541c5d\\",\\n \\"NodeId\\": \\"e0bc19a3\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"D2RB671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 4\\n 10\\n 1\\n \\n 053xxxx3128\\n 放音\\n ccc-test\\n 1621910542876\\n Success\\n job-109634426711871319\\n 65cp2c15-92ac-4e67-98b2-073a3c541c5d\\n A=B;C=D\\n abc99462-1058-47d0-a114-f145ea7444ff\\n 1621910545105\\n {\\"say\\":\\"您好。\\"}\\n 133xxxx2315\\n 测试IVR\\n PLAY_OR_SAY\\n e0bc19a3\\n {\\"digits\\":\\"2\\"}\\n \\n\\nOK","errorExample":""}]', + ], + 'ListLegacyAgentEventLogs' => [ + 'summary' => '调用ListLegacyAgentEventLogs获取1.0遗留坐席事件日志列表，该接口仅对特定用户开放，其他客户不建议调用。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -29206,1046 +17447,868 @@ ], ], 'operationType' => 'read', - 'deprecated' => false, + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '分页序号，范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '100', - ], + 'schema' => ['description' => '分页大小，范围1-1000。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的起始时间，默认为当天的0时，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1532448000000', - ], + 'schema' => ['description' => '开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657853640015'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的终止时间，默认为当前时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1532707199000', - ], + 'schema' => ['description' => '结束时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1658026440011'], ], [ - 'name' => 'ContactType', + 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '按通话类型过滤。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Outbound' => '呼出', - 'Back2Back' => '双呼', - 'PrivacyDial' => '加密通话', - 'Internal' => '内部呼叫', - 'Predictive' => '预测式外呼', - 'Inbound' => '呼入', - 'Conference' => '会议', - ], - 'example' => 'Outbound', - ], + 'schema' => ['description' => '按坐席ID过滤，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], ], - [ - 'name' => 'ContactDisposition', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '按挂断类型过滤，注意：语音邮箱、转人工失败、排队超时、排队溢出、IVR异常的挂断原因需要客户配置挂断原因节点才能体现出来，如果没有配置且IVR中无转人工模块，这时候的挂断原因默认为IVR放弃。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'AbandonedInQueue' => '排队放弃', - 'NoAnswer' => '客户未接', - 'QueuingTimeout' => '排队超时', - 'Voicemail' => '转语音邮箱', - 'QueuingFailed' => '转人工失败', - 'QueuingOverflow' => '排队溢出', - 'AbandonedInVoiceNavigator' => '智能导航中放弃', - 'Success' => '正常结束', - 'IVRException' => 'IVR异常', - 'AbandonedInRing' => '振铃放弃', - 'AbandonedInIVR' => 'IVR放弃', - 'Reject' => '客户拒接', - 'ForwardToOutsideNumber' => '转外线', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2802EE59-3B53-513A-A130-85E480AF689D'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'List' => [ + 'description' => '坐席事件日志列表', + 'type' => 'array', + 'items' => [ + 'description' => '坐席事件日志。', + 'type' => 'object', + 'properties' => [ + 'TargetSelect' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'TargetRequest' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'StatisticDate' => ['description' => '统计时刻。', 'type' => 'string', 'example' => '2021-12-03T10:15:30'], + 'PhoneNo' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8012****'], + 'GroupNo' => ['description' => '坐席签入的技能组ID列表，多个技能组ID用逗号分割。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test,skillgroup2@ccc-test'], + 'Event' => [ + 'description' => '事件类型。', + 'type' => 'string', + 'enumValueTitles' => ['拨号' => '拨号', '振铃' => '振铃', '处理' => '处理'], + 'example' => '拨号', + ], + 'ConnId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => '345467****'], + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => ['呼入' => '呼入', '呼出' => '呼出'], + 'example' => '呼入', + ], + 'CallId' => ['description' => '通话ID。', 'type' => 'string', 'example' => '378654****'], + 'CallerId' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '08331111****'], + 'CalleeId' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1312343****'], + 'AgentNo' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'AgentDropCall' => ['description' => '是否为坐席挂机。', 'type' => 'string', 'example' => 'false'], + 'TransferNumber' => ['description' => '转接号码。', 'type' => 'string', 'example' => '07518888****'], + 'CallDir' => [ + 'description' => '呼叫方向。', + 'type' => 'string', + 'enumValueTitles' => ['内部' => '内部', '外部' => '外部'], + 'example' => '内部', + ], + 'CallMode' => [ + 'description' => '通话模式。', + 'type' => 'string', + 'enumValueTitles' => ['呼入' => '呼入', '呼出' => '呼出'], + 'example' => '呼入', + ], + 'TenantId' => ['description' => '租户ID。', 'type' => 'string', 'example' => 'acc101'], + 'OutboundScenario' => ['description' => '坐席是否为仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + ], + ], + ], + ], + ], ], - 'example' => 'Success', + 'description' => '', ], ], + ], + 'staticInfo' => [ + 'substitutions' => ['CCC::2020-07-01::ListAgentStateLogs'], + ], + 'title' => '获取遗留坐席事件日志列表', + 'changeSet' => [ + ['createdAt' => '2022-07-05T09:31:24.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyAgentEventLogs'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2802EE59-3B53-513A-A130-85E480AF689D\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"TargetSelect\\": \\"skillgroup@ccc-test\\",\\n \\"TargetRequest\\": \\"skillgroup@ccc-test\\",\\n \\"StatisticDate\\": \\"2021-12-03T10:15:30\\",\\n \\"PhoneNo\\": \\"8012****\\",\\n \\"GroupNo\\": \\"skillgroup1@ccc-test,skillgroup2@ccc-test\\",\\n \\"Event\\": \\"拨号\\",\\n \\"ConnId\\": \\"345467****\\",\\n \\"CallType\\": \\"呼入\\",\\n \\"CallId\\": \\"378654****\\",\\n \\"CallerId\\": \\"08331111****\\",\\n \\"CalleeId\\": \\"1312343****\\",\\n \\"AgentNo\\": \\"agent@ccc-test\\",\\n \\"AgentDropCall\\": \\"false\\",\\n \\"TransferNumber\\": \\"07518888****\\",\\n \\"CallDir\\": \\"内部\\",\\n \\"CallMode\\": \\"呼入\\",\\n \\"TenantId\\": \\"acc101\\",\\n \\"OutboundScenario\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListLegacyAgentStatusLogs' => [ + 'summary' => '调用ListLegacyAgentStatusLogs获取1.0遗留坐席状态日志列表，该接口仅对特定用户开放，其他客户不建议调用。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'description' => '通过指定的contactId来查询某一通电话的记录，contactId可以通过软电话SDK发生通话时获取到。如果传入该参数，则自动忽略其他查询参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'job-12515239414412****', - ], + 'AK' => [], ], [ - 'name' => 'AgentId', - 'in' => 'query', - 'schema' => [ - 'description' => '按坐席ID过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], + 'parameters' => [ [ - 'name' => 'SkillGroupId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '按技能组ID过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'skillgroup@ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'SortOrder', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '排序方式，非必填，默认为降序。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ASC' => '升序', - 'DESC' => '降序', - ], - 'example' => 'DESC', - ], + 'schema' => ['description' => '分页序号，范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ - 'name' => 'InstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '分页大小，范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100'], ], [ - 'name' => 'OrderByField', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '排序字段，非必填，默认为startTime（通话开始时间）。'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'callDuration' => '通话时长', - 'ringTime' => '响铃时长', - 'talkTime' => '通话时长', - 'dialingTime' => '拨号时长', - 'startTime' => '通话开始时间', - 'ivrTime' => 'IVR时长', - 'queueTime' => '排队时长', - ], - 'example' => 'startTime', - ], + 'schema' => ['description' => '开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657778840011'], ], [ - 'name' => 'Criteria', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '根据主叫或被叫号码模糊查询，格式为JSON字符串，仅包含一个字段phoneNumber，填主叫或被叫号码的全部或者一部分。', - 'type' => 'string', - 'required' => false, - 'example' => '{"phoneNumber":"0735"}', - ], + 'schema' => ['description' => '结束时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657879880010'], ], [ - 'name' => 'CallingNumber', + 'name' => 'AgentId', 'in' => 'query', + 'schema' => ['description' => '按坐席ID过滤，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '按主叫号码过滤。', - 'type' => 'string', - 'required' => false, - 'example' => '07353988****', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4C9A5D93-33A6-57F3-A423-4C83BD0A8455'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'List' => [ + 'description' => '坐席状态数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '坐席状态数据。', + 'type' => 'object', + 'properties' => [ + 'TransferNo' => ['description' => '转接号码。', 'type' => 'string', 'example' => '07551231****'], + 'TargetSelect' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'TargetRequest' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Status' => [ + 'description' => '坐席状态。', + 'type' => 'string', + 'enumValueTitles' => ['拨号' => '拨号', '振铃' => '振铃', '处理' => '处理', '小休' => '小休'], + 'example' => '振铃', + ], + 'StatisticDate' => ['description' => '统计时刻。', 'type' => 'string', 'example' => '2021-12-03T10:15:30'], + 'StatisticTime' => ['description' => '状态持续时间，单位秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'PhoneNo' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8012****'], + 'MonitedAgentPhoneNo' => ['description' => '被监听号码。', 'type' => 'string', 'example' => '8012****'], + 'MonitedAgentNo' => ['description' => '监听号码。', 'type' => 'string', 'example' => '8032****'], + 'GroupNo' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'ConnId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => '487326****'], + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => ['呼入' => '呼入', '呼出' => '呼出'], + 'example' => '呼入', + ], + 'CallId' => ['description' => '通话ID。', 'type' => 'string', 'example' => '454326****'], + 'CallerId' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '08337676****'], + 'CalleeId' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1312121****'], + 'CallDir' => [ + 'description' => '呼叫方向。', + 'type' => 'string', + 'enumValueTitles' => ['内部' => '内部', '外部' => '外部'], + 'example' => '内部', + ], + 'AgentNo' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'AgentDropCall' => ['description' => '是否为坐席挂机。', 'type' => 'string', 'example' => 'false'], + 'AliHangupCause' => ['description' => '挂断原因。', 'type' => 'string', 'example' => '无'], + 'TransferNumber' => ['description' => '转接号码。', 'type' => 'string', 'example' => '05711231****'], + 'Extend1' => ['description' => '自定义扩展字段。', 'type' => 'string', 'example' => '无'], + 'Extend2' => ['description' => '自定义扩展字段。', 'type' => 'string', 'example' => '无'], + 'Extend3' => ['description' => '自定义扩展字段。', 'type' => 'string', 'example' => '无'], + 'Extend4' => ['description' => '自定义扩展字段。', 'type' => 'string', 'example' => '无'], + 'TenantId' => ['description' => '租户ID。', 'type' => 'string', 'example' => 'acc6736'], + 'OutboundScenario' => ['description' => '坐席是否为仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + ], + ], + ], + ], + ], + ], + 'description' => '', ], ], + ], + 'staticInfo' => [ + 'substitutions' => ['CCC::2020-07-01::ListAgentStateLogs'], + ], + 'title' => '获取遗留坐席状态日志列表', + 'changeSet' => [ + ['createdAt' => '2022-07-05T09:31:24.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyAgentStatusLogs'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"4C9A5D93-33A6-57F3-A423-4C83BD0A8455\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"TransferNo\\": \\"07551231****\\",\\n \\"TargetSelect\\": \\"skillgroup@ccc-test\\",\\n \\"TargetRequest\\": \\"skillgroup@ccc-test\\",\\n \\"Status\\": \\"振铃\\",\\n \\"StatisticDate\\": \\"2021-12-03T10:15:30\\",\\n \\"StatisticTime\\": 3,\\n \\"PhoneNo\\": \\"8012****\\",\\n \\"MonitedAgentPhoneNo\\": \\"8012****\\",\\n \\"MonitedAgentNo\\": \\"8032****\\",\\n \\"GroupNo\\": \\"skillgroup@ccc-test\\",\\n \\"ConnId\\": \\"487326****\\",\\n \\"CallType\\": \\"呼入\\",\\n \\"CallId\\": \\"454326****\\",\\n \\"CallerId\\": \\"08337676****\\",\\n \\"CalleeId\\": \\"1312121****\\",\\n \\"CallDir\\": \\"内部\\",\\n \\"AgentNo\\": \\"agent@ccc-test\\",\\n \\"AgentDropCall\\": \\"false\\",\\n \\"AliHangupCause\\": \\"无\\",\\n \\"TransferNumber\\": \\"05711231****\\",\\n \\"Extend1\\": \\"无\\",\\n \\"Extend2\\": \\"无\\",\\n \\"Extend3\\": \\"无\\",\\n \\"Extend4\\": \\"无\\",\\n \\"TenantId\\": \\"acc6736\\",\\n \\"OutboundScenario\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListLegacyQueueEventLogs' => [ + 'summary' => '调用ListLegacyQueueEventLogs获取1.0遗留队列事件日志列表，该接口仅对特定用户开放，其他客户不建议调用。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CalledNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '按被叫号码过滤。', - 'type' => 'string', - 'required' => false, - 'example' => '1320523****', - ], + 'AK' => [], ], [ - 'name' => 'SatisfactionList', + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '按满意度列表过滤，多个满意度结果使用英文逗号隔开。', - 'type' => 'string', - 'required' => false, - 'example' => '["1","3"]', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'SatisfactionSurveyChannel', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '按满意度调查渠道过滤。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'IVR' => '语音满意度', - 'SMS' => '短信满意度', - ], - 'example' => 'IVR', - ], + 'schema' => ['description' => '分页序号，范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ - 'name' => 'SatisfactionDescriptionList', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '按满意度描述列表过滤，描述内容由客户自定义。', - 'type' => 'string', - 'required' => false, - 'example' => '["满意","一般"]', - ], + 'schema' => ['description' => '分页大小，范围1-1000。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100'], ], [ - 'name' => 'EarlyMediaStateList', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '按未接通原因列表过滤。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'NoAnswer' => '无人接听', - 'OutOfService' => '停机', - 'NotExist' => '空号', - 'Restricted' => '呼叫受限', - 'Busy' => '占线', - 'NotConnected' => '无法接通', - 'PowerOff' => '关机', - ], - 'example' => '["NotConnected","NoAnswer"]', - ], + 'schema' => ['description' => '开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657939540015'], ], [ - 'name' => 'ContactDispositionList', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '按挂断原因列表过滤。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'AbandonedInQueue' => '排队放弃', - 'NoAnswer' => '客户未接', - 'QueuingTimeout' => '排队超时', - 'Voicemail' => '转语音邮箱', - 'QueuingFailed' => '转人工失败', - 'QueuingOverflow' => '排队溢出', - 'AbandonedInVoiceNavigator' => '智能导航中放弃', - 'Success' => '正常结束', - 'IVRException' => 'IVR异常', - 'AbandonedInRing' => '振铃放弃', - 'AbandonedInIVR' => 'IVR放弃', - 'Reject' => '客户拒接', - 'ForwardToOutsideNumber' => '转外线', - ], - 'example' => '["Success","NoAnswer"]', - ], + 'schema' => ['description' => '结束时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1658026180018'], ], [ - 'name' => 'ContactTypeList', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '按通话类型列表过滤。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Outbound' => '呼出', - 'Back2Back' => '双呼', - 'PrivacyDial' => '加密通话', - 'Internal' => '内部呼叫', - 'Predictive' => '预测式外呼', - 'Inbound' => '呼入', - 'Conference' => '会议', - ], - 'example' => '["Internal","Inbound"]', - ], + 'schema' => ['description' => '按技能组ID过滤，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1A5A8998-41F9-5F85-BFCF-EB2B6E376812'], + 'Success' => ['description' => '是否调用成功。', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数，只有PageNumber为1才会返回真实数值，其他都是0。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], + 'PageNumber' => ['description' => '分页序号，范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-1000。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'List' => [ - 'description' => '通话记录列表。', + 'description' => '队列事件日志列表。', 'type' => 'array', 'items' => [ - 'description' => '通话记录。', + 'description' => '队列事件日志。', 'type' => 'object', 'properties' => [ - 'ContactDisposition' => [ - 'description' => '通话结束原因。', - 'type' => 'string', - 'enumValueTitles' => [ - 'AbandonedInQueue' => '排队放弃', - 'NoAnswer' => '客户未接', - 'QueuingTimeout' => '排队超时', - 'Voicemail' => '转语音邮箱', - 'QueuingFailed' => '转人工失败', - 'QueuingOverflow' => '排队溢出', - 'AbandonedInVoiceNavigator' => '智能导航中放弃', - 'Success' => '正常结束', - 'IVRException' => 'IVR异常', - 'AbandonedInRing' => '振铃放弃', - 'AbandonedInIVR' => 'IVR放弃', - 'Reject' => '客户拒接', - 'ForwardToOutsideNumber' => '转外线', - ], - 'example' => 'Success', - ], - 'ContactType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Outbound' => '呼出', - 'Back2Back' => '双呼', - 'PrivacyDial' => '加密通话', - 'Internal' => '内部呼叫', - 'Predictive' => '预测式外呼', - 'Inbound' => '呼入', - 'Conference' => '会议', - ], - 'example' => 'Outbound', - ], - 'EstablishedTime' => [ - 'description' => '通话建立的时间，如果通话没有建立，此值为空，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1532448000000', - ], - 'CalledNumber' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'example' => '1332315****', - ], - 'AdditionalBroker' => [ - 'description' => '附加中间号码，双呼场景下可能用到。', - 'type' => 'string', - 'example' => '0533128****', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度，即满意度按键数字（1位数字）的值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SatisfactionSurveyChannel' => [ - 'description' => '满意度调查渠道。', - 'type' => 'string', - 'enumValueTitles' => [ - 'IVR' => '语音满意度', - 'SMS' => '短信满意度', - ], - 'example' => 'IVR', - ], - 'ReleaseTime' => [ - 'description' => '通话结束时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1532707199000', - ], - 'WaitTime' => [ - 'description' => '客户等待时长，即QueueTime+RingTime，若客户等待期间放弃，则为0，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'SkillGroupNames' => [ - 'description' => '参与通话的座席所属的技能组名称，多个技能组以英文逗号分隔。', - 'type' => 'string', - 'example' => '测试技能组', - ], - 'IvrTime' => [ - 'description' => 'IVR时长，即从开始进入IVR到开始进入转人工队列（或客户放弃）之间的时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'SatisfactionDescription' => [ - 'description' => '满意度描述，对应于满意度IVR中满意度模块的配置，客户自行定义。', - 'type' => 'string', - 'example' => '满意', - ], - 'ReleaseInitiator' => [ - 'description' => '挂断方。', - 'type' => 'string', - 'enumValueTitles' => [ - 'agent' => '坐席', - 'customer' => '客户', - ], - 'example' => 'customer', - ], - 'AgentIds' => [ - 'description' => '坐席ID列表，多个值用逗号分隔。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'CallDuration' => [ - 'description' => '通话时长，呼入从通话进入IVR开始计时，呼出从接通开始计时，单位秒。', - 'type' => 'string', - 'example' => '30', - ], - 'RecordingReady' => [ - 'description' => '录音是否已经生成，若通话没有建立，则返回false。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'RingTime' => [ - 'description' => '振铃时长，即从坐席振铃到坐席接起（或客户放弃）之间的时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'SatisfactionSurveyOffered' => [ - 'description' => '是否发起了满意度调查。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AgentNames' => [ - 'description' => '通话涉及到的坐席名称列表，多个坐席之间使用英文逗号隔开。', - 'type' => 'string', - 'example' => '坐席小王', - ], - 'StartTime' => [ - 'description' => '通话开始时间，内呼从进入IVR开始，外呼从拨号开始计算，格式为Unix字符串，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1532448000000', - ], - 'ContactId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-12515239414412****', - ], - 'RecordingDuration' => [ - 'description' => '录音时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'CallingNumber' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'example' => '0533128****', - ], - 'QueueTime' => [ - 'description' => '排队时长，即从开始进入转人工队列到坐席开始振铃（或客户放弃，队列超时，队列溢出）之间的时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Broker' => [ - 'description' => '中间号码。', - 'type' => 'string', - 'example' => '0533127****', - ], - 'SkillGroupIds' => [ - 'description' => '参与通话的座席所属的技能组ID，多个技能组以逗号分隔。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'CallerLocation' => [ - 'description' => '主叫归属地。', - 'type' => 'string', - 'example' => '北京市-北京', - ], - 'CalleeLocation' => [ - 'description' => '被叫归属地。', - 'type' => 'string', - 'example' => '山东省-济南', - ], - 'EarlyMediaState' => [ - 'description' => '未接通原因。', - 'type' => 'string', - 'enumValueTitles' => [ - 'NoAnswer' => '无人接听', - 'OutOfService' => '停机', - 'NotExist' => '空号', - 'Restricted' => '呼叫受限', - 'Busy' => '占线', - 'NotConnected' => '无法接通', - 'PowerOff' => '关机', - ], - 'example' => 'NotConnected', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '486:USER_BUSY', - ], - 'DialingTime' => [ - 'description' => '拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TalkTime' => [ - 'description' => '通话时间，单位为秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HeldTime' => [ - 'description' => '保持时间，单位为秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'CallIds' => [ - 'description' => '通信底层SIP协议中Call-Id字段，如果需要获取号码提供商侧的通话ID可以从这个字段获取。', + 'Vq' => ['description' => '队列名称。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'StatisticDate' => ['description' => '统计日期。', 'type' => 'string', 'example' => '2021-12-03T10:15:30'], + 'QueueTime' => ['description' => '队列时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Ani' => ['description' => '主叫', 'type' => 'string', 'example' => '8012****'], + 'Dnis' => ['description' => '被叫。', 'type' => 'string', 'example' => '1312211****'], + 'Cause' => [ + 'description' => '挂机原因。', 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'."\n", + 'enumValueTitles' => ['队列呼损' => '队列呼损', '正常' => '正常', '久振呼损' => '久振呼损'], + 'example' => '正常', ], + 'AnswerTime' => ['description' => '应答时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'], + 'AnswerPhone' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Acid' => ['description' => '通话ID。', 'type' => 'string', 'example' => '456328****'], + 'TenantId' => ['description' => '租户ID。', 'type' => 'string', 'example' => 'acc3733'], + 'Id' => ['description' => '主键', 'type' => 'integer', 'format' => 'int64', 'example' => '109160'], ], ], ], ], ], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid. %s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], + 'title' => '获取遗留队列事件日志列表', + 'changeSet' => [ + ['createdAt' => '2022-07-05T09:31:24.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyQueueEventLogs'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"Outbound\\",\\n \\"EstablishedTime\\": 1532448000000,\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"AdditionalBroker\\": \\"0533128****\\",\\n \\"SatisfactionIndex\\": 1,\\n \\"SatisfactionSurveyChannel\\": \\"IVR\\",\\n \\"ReleaseTime\\": 1532707199000,\\n \\"WaitTime\\": 5,\\n \\"SkillGroupNames\\": \\"测试技能组\\",\\n \\"IvrTime\\": 8,\\n \\"SatisfactionDescription\\": \\"满意\\",\\n \\"ReleaseInitiator\\": \\"customer\\",\\n \\"AgentIds\\": \\"agent@ccc-test\\",\\n \\"CallDuration\\": \\"30\\",\\n \\"RecordingReady\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RingTime\\": 5,\\n \\"SatisfactionSurveyOffered\\": true,\\n \\"AgentNames\\": \\"坐席小王\\",\\n \\"StartTime\\": 1532448000000,\\n \\"ContactId\\": \\"job-12515239414412****\\",\\n \\"RecordingDuration\\": 10,\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"QueueTime\\": 0,\\n \\"Broker\\": \\"0533127****\\",\\n \\"SkillGroupIds\\": \\"skillgroup@ccc-test\\",\\n \\"CallerLocation\\": \\"北京市-北京\\",\\n \\"CalleeLocation\\": \\"山东省-济南\\",\\n \\"EarlyMediaState\\": \\"NotConnected\\",\\n \\"ReleaseReason\\": \\"486:USER_BUSY\\",\\n \\"DialingTime\\": 0,\\n \\"TalkTime\\": 0,\\n \\"HeldTime\\": 12,\\n \\"CallIds\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\\\n\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 11\\n 10\\n 1\\n \\n 8\\n 133xxxx2315\\n Outbound\\n Success\\n 1\\n job-125152394144124921\\n 053xxxx3128\\n true\\n 默认技能组\\n true\\n 0\\n 1532448000000\\n skg-default@ccc-test\\n 053xxxx3127\\n ccc-test\\n agent\\n NotConnected\\n 1532448000000\\n 5\\n 30\\n 北京\\n 1532707199000\\n IVR\\n user-test@ccc-test\\n 满意\\n 053xxxx3128\\n 北京\\n 5\\n 云呼测试坐席\\n 10\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取通话详情列表', - 'summary' => '调用ListCallDetailRecords获取指定实例下指定搜索条件过滤后的通话详情列表。接口不再迭代更新，建议优先使用ListCallDetailRecordsV2接口。', - 'description' => '为了保证查询效率，返回数据中的TotalCount字段，只会在查询第一页时赋值，查询其他页时返回0。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"1A5A8998-41F9-5F85-BFCF-EB2B6E376812\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Vq\\": \\"skillgroup@ccc-test\\",\\n \\"StatisticDate\\": \\"2021-12-03T10:15:30\\",\\n \\"QueueTime\\": 10,\\n \\"Ani\\": \\"8012****\\",\\n \\"Dnis\\": \\"1312211****\\",\\n \\"Cause\\": \\"正常\\",\\n \\"AnswerTime\\": 15,\\n \\"AnswerPhone\\": \\"agent@ccc-test\\",\\n \\"Acid\\": \\"456328****\\",\\n \\"TenantId\\": \\"acc3733\\",\\n \\"Id\\": 109160\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'ListCallDetailRecordsV2' => [ - 'summary' => '获取指定实例下指定搜索条件过滤后的通话详情列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListMonoRecordings' => [ + 'summary' => '调用ListMonoRecordings获取指定实例下指定通话的各通话方的单轨录音，通话中每一方都有一个话务通道，每个话务通道对应生成一个合轨录音，格式为WAV。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREccc5HY0NN', - ], + 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PageSize', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '100', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-25697383427137****'], ], [ - 'name' => 'StartTime', + 'name' => 'AgentChannelId', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的起始时间，默认为当天的 0 时，格式为 Unix 时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1657853640015', - ], + 'schema' => ['title' => '坐席对话channelId', 'description' => '坐席对话channelId', 'type' => 'string', 'required' => false, 'example' => 'ch-user-****-****-1772180844645-job-*****'], ], [ - 'name' => 'EndTime', + 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的终止时间，默认为当前时间，格式为 Unix 时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1657879880010', - ], + 'schema' => ['title' => '坐席ID', 'description' => '坐席ID', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], ], - [ - 'name' => 'SortOrder', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '排序方式，默认为降序。'."\n" - ."\n" - .'枚举值：'."\n" - ."\n" - .'ASC：升序。'."\n" - ."\n" - .'DESC：降序。', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E836EF2A-EDAE-5310-8921-F983C967D42D'], + 'Data' => [ + 'description' => '录音信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '录音信息。', + 'type' => 'object', + 'properties' => [ + 'FileName' => ['description' => '录音文件名称。', 'type' => 'string', 'example' => 'job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav'], + 'FileUrl' => ['description' => '录音文件的OSS下载地址，注意下载地址的过期时间，下载地址的有效期为1天。', 'type' => 'string', 'example' => 'https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav?Expires=1657014031&OSSAccessKeyId=****&Signature=****'], + 'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'AgentName' => ['description' => '坐席名称。', 'type' => 'string', 'example' => '坐席小王'], + 'StartTime' => ['description' => '录音开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'string', 'example' => '1620259200000'], + 'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-25920271311543****'], + 'Duration' => ['description' => '录音时长，单位毫秒。', 'type' => 'string', 'example' => '5903871'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'RamId' => ['description' => '坐席对应的RAM账号ID。', 'type' => 'string', 'example' => '26972543893791****'], + ], + ], + ], + ], + 'description' => '', ], ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], ], - [ - 'name' => 'OrderByField', - 'in' => 'query', - 'schema' => [ - 'description' => '排序字段，非必填，默认为 startTime（通话开始时间）。'."\n" - ."\n" - .'枚举值：'."\n" - ."\n" - .'startTime：通话开始时间。', - 'type' => 'string', - 'required' => false, - 'example' => 'startTime', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], - [ - 'name' => 'SearchPattern', - 'in' => 'query', - 'schema' => [ - 'description' => '自定义查询文本，遵循Lucene查询语法。'."\n" - ."\n" - .'支持查询字段和查询类型列表：'."\n" - ."\n" - .'accessChannelUserId: 访客ID，支持精准查询和模糊查询。'."\n" - ."\n" - .'accessChannelName: 渠道名称，支持精准查询和模糊查询。'."\n" - ."\n" - .'text: 会话文本，支持模糊查询。', - 'type' => 'string', - 'required' => false, - 'example' => 'text:请稍后 AND accessChannelUserId:af1a0-afaa-5086e2946e0b* AND accessChannelName:专属开发渠道*', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E836EF2A-EDAE-5310-8921-F983C967D42D\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav\\",\\n \\"FileUrl\\": \\"https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav?Expires=1657014031&OSSAccessKeyId=****&Signature=****\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"StartTime\\": \\"1620259200000\\",\\n \\"ContactId\\": \\"job-25920271311543****\\",\\n \\"Duration\\": \\"5903871\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"RamId\\": \\"26972543893791****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取单轨录音列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMonoRecordings'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + ], + 'ListMultiChannelRecordings' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MediaType', - 'in' => 'query', - 'schema' => [ - 'description' => '媒体类型。'."\n" - ."\n" - .'枚举值：'."\n" - ."\n" - .'AUDIO：语音。'."\n" - ."\n" - .'VIDEO：视频。'."\n" - ."\n" - .'CHAT: 消息。'."\n" - ."\n" - .'ALL: 所有。', - 'type' => 'string', - 'required' => false, - 'example' => 'AUDIO', - ], + 'AK' => [], ], [ - 'name' => 'ContactIdList', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID列表。', - 'type' => 'string', - 'required' => false, - 'example' => '["job-123456789","job-234567891"]', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], + ], + 'parameters' => [ [ - 'name' => 'ContactTypeList', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '按通话类型列表过滤。'."\n" - ."\n" - .'枚举值：'."\n" - ."\n" - .'OUTBOUND：呼出。'."\n" - ."\n" - .'BACK2BACK：双呼。'."\n" - ."\n" - .'PRIVACY_DIAL：加密通话。'."\n" - ."\n" - .'INTERNAL：内部呼叫。'."\n" - ."\n" - .'PREDICTIVE：预测式外呼。'."\n" - ."\n" - .'INBOUND：呼入。'."\n" - ."\n" - .'CONFERENCE：会议。', - 'type' => 'string', - 'required' => false, - 'example' => '["INBOUND","OUTBOUND"]', - ], + 'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'ContactDispositionList', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '按挂断原因列表过滤。'."\n" - ."\n" - .'枚举值：'."\n" - ."\n" - .'AbandonedInQueue：排队放弃。'."\n" - ."\n" - .'NoAnswer：客户未接。'."\n" - ."\n" - .'QueuingTimeout：排队超时。'."\n" - ."\n" - .'Voicemail：转语音邮箱。'."\n" - ."\n" - .'QueuingFailed：转人工失败。'."\n" - ."\n" - .'QueuingOverflow：排队溢出。'."\n" - ."\n" - .'AbandonedInVoiceNavigator：智能导航中放弃。'."\n" - ."\n" - .'Success：正常结束。'."\n" - ."\n" - .'IVRException：IVR异常。'."\n" - ."\n" - .'AbandonedInRing：振铃放弃。'."\n" - ."\n" - .'AbandonedInIVR：IVR放弃。'."\n" - ."\n" - .'Reject：客户拒接。'."\n" - ."\n" - .'ForwardToOutsideNumber：转外线。', - 'type' => 'string', - 'required' => false, - 'example' => '["Success","NoAnswer"]', - ], + 'schema' => ['title' => '通话ID', 'description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-25920271311543****'], ], [ - 'name' => 'EarlyMediaStateList', + 'name' => 'AgentChannelId', 'in' => 'query', - 'schema' => [ - 'description' => '按未接通原因列表过滤。'."\n" - ."\n" - .'枚举值：'."\n" - ."\n" - .'NoAnswer：无人接听。'."\n" - ."\n" - .'OutOfService：停机。'."\n" - ."\n" - .'NotExist：空号。'."\n" - ."\n" - .'Restricted：呼叫受限。'."\n" - ."\n" - .'Busy：占线。'."\n" - ."\n" - .'NotConnected：无法接通。'."\n" - ."\n" - .'PowerOff：关机。', - 'type' => 'string', - 'required' => false, - 'example' => '["NotConnected","NoAnswer"]', - ], + 'schema' => ['title' => '坐席通话ChannelId', 'description' => '坐席通话ChannelId', 'type' => 'string', 'required' => false, 'example' => 'ch-user-****-****-1772180844645-job-******'], ], [ - 'name' => 'SatisfactionSurveyChannel', + 'name' => 'AgentId', 'in' => 'query', + 'schema' => ['title' => '坐席ID', 'description' => '坐席ID', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '满意度调查渠道。'."\n" - ."\n" - .'枚举值：'."\n" - ."\n" - .'IVR：语音满意度。'."\n" - ."\n" - .'SMS：短信满意度。'."\n" - ."\n" - .'CHAT: 消息满意度。', - 'type' => 'string', - 'required' => false, - 'example' => 'IVR', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B19CD719-9F65-56A6-8B79-DA4282EA4797'], + 'Data' => [ + 'description' => '录音列表。', + 'type' => 'array', + 'items' => [ + 'description' => '录音。', + 'type' => 'object', + 'properties' => [ + 'FileName' => ['description' => '录音文件名称。', 'type' => 'string', 'example' => 'job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv'], + 'FileUrl' => ['description' => '录音文件的OSS下载地址，注意下载地址的过期时间，下载地址的有效期为1天。', 'type' => 'string', 'example' => 'https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv?Expires=1657014031&OSSAccessKeyId=****&Signature=****'], + 'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'AgentName' => ['description' => '坐席名称。', 'type' => 'string', 'example' => '坐席小王'], + 'StartTime' => ['description' => '录音开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1656926518491'], + 'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-25920271311543****'], + 'Duration' => ['description' => '录音时长，单位毫秒。', 'type' => 'string', 'example' => '56321'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'RamId' => ['description' => '坐席对应的RAM账号ID。', 'type' => 'string', 'example' => '22807673106369****'], + 'AgentChannelId' => ['description' => '坐席话务通道ID。', 'type' => 'string', 'example' => 'ch-user-8526899****-8602****-1656926504363-job-25920271311543****'], + 'HoldTimeSegments' => [ + 'description' => '通话保持的时间片段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通话保持的时间片段。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => '通话保持的开始时间，单位是毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1673255098049'], + 'EndTime' => ['description' => '通话保持的结束时间，单位是毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1687860143925'], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '获取多通道录音列表', + 'summary' => '调用ListMultiChannelRecordings获取指定实例下指定通话的各通话方的多轨录音，通话中每一方都有一个话务通道，每个话务通道对应一个多轨录音，格式为MKV。', + 'changeSet' => [ + ['createdAt' => '2023-05-08T07:40:07.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMultiChannelRecordings'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B19CD719-9F65-56A6-8B79-DA4282EA4797\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv\\",\\n \\"FileUrl\\": \\"https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv?Expires=1657014031&OSSAccessKeyId=****&Signature=****\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"StartTime\\": 1656926518491,\\n \\"ContactId\\": \\"job-25920271311543****\\",\\n \\"Duration\\": \\"56321\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"RamId\\": \\"22807673106369****\\",\\n \\"AgentChannelId\\": \\"ch-user-8526899****-8602****-1656926504363-job-25920271311543****\\",\\n \\"HoldTimeSegments\\": [\\n {\\n \\"StartTime\\": 1673255098049,\\n \\"EndTime\\": 1687860143925\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListNotificationRecords' => [ + 'summary' => '查询非MQ方式消息推送记录。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SatisfactionRateList', + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccUU766R'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '按满意度列表过滤，多个满意度结果使用英文逗号隔开。'."\n" - ."\n" - .'枚举值：'."\n" - ."\n" - .'-2：未发送。'."\n" - ."\n" - .'-1：未评价。'."\n" - ."\n" - .'其他正数：自定义满意度评价数值。', - 'type' => 'string', - 'required' => false, - 'example' => '["-1","3"]'."\n" - .'[">2"]'."\n" - .'["<3"]', - ], + 'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'SatisfactionDescriptionList', + 'name' => 'NotificationKeys', 'in' => 'query', + 'schema' => ['description' => '待查询消息Key列表。比如，通话ID, 可以查询出对应通话ID的所有消息。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '["job-468a63a2-****-****-****-b1ecf726d4be","job-532a63a2-****-****-****-bcccc26d4cc"]'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '按满意度描述列表过滤，描述内容由客户自定义。', - 'type' => 'string', - 'required' => false, - 'example' => '["满意","一般"]', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'array', + 'items' => [ + 'description' => '消息列表。', + 'type' => 'object', + 'properties' => [ + 'NotificationType' => ['description' => '消息类型。', 'type' => 'string', 'example' => 'Dialing'], + 'NotificationKey' => ['description' => '消息Key', 'type' => 'string', 'example' => 'job-468a63a2-****-****-****-b1ecf726d4be'], + 'Content' => ['description' => '消息内容。', 'type' => 'string', 'example' => '{'."\n" + .' "agentId": "agent@ccc-test",'."\n" + .' "callType": "OUTBOUND",'."\n" + .' "callee": "13****00",'."\n" + .' "caller": "05****81",'."\n" + .' "channelId": "ch-user-13****00-05****81-1772619731285-job-*****",'."\n" + .' "contactId": "job-*****",'."\n" + .' "eventTime": "2026-03-04T10:22:11.309Z",'."\n" + .' "eventType": "Dialing",'."\n" + .' "instanceId": "ccc-test",'."\n" + .' "mediaType": "AUDIO",'."\n" + .' "skillGroupId": "skill@ccc-test"'."\n" + .'}'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + ], + ], + ], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '查询非MQ方式消息推送记录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0630E5DF-CEB0-445B-8626-D5C7481181C3\\",\\n \\"Data\\": [\\n {\\n \\"NotificationType\\": \\"Dialing\\",\\n \\"NotificationKey\\": \\"job-468a63a2-****-****-****-b1ecf726d4be\\",\\n \\"Content\\": \\"{\\\\n\\\\t\\\\\\"agentId\\\\\\": \\\\\\"agent@ccc-test\\\\\\",\\\\n\\\\t\\\\\\"callType\\\\\\": \\\\\\"OUTBOUND\\\\\\",\\\\n\\\\t\\\\\\"callee\\\\\\": \\\\\\"13****00\\\\\\",\\\\n\\\\t\\\\\\"caller\\\\\\": \\\\\\"05****81\\\\\\",\\\\n\\\\t\\\\\\"channelId\\\\\\": \\\\\\"ch-user-13****00-05****81-1772619731285-job-*****\\\\\\",\\\\n\\\\t\\\\\\"contactId\\\\\\": \\\\\\"job-*****\\\\\\",\\\\n\\\\t\\\\\\"eventTime\\\\\\": \\\\\\"2026-03-04T10:22:11.309Z\\\\\\",\\\\n\\\\t\\\\\\"eventType\\\\\\": \\\\\\"Dialing\\\\\\",\\\\n\\\\t\\\\\\"instanceId\\\\\\": \\\\\\"ccc-test\\\\\\",\\\\n\\\\t\\\\\\"mediaType\\\\\\": \\\\\\"AUDIO\\\\\\",\\\\n\\\\t\\\\\\"skillGroupId\\\\\\": \\\\\\"skill@ccc-test\\\\\\"\\\\n}\\",\\n \\"InstanceId\\": \\"ccc-test\\"\\n }\\n ],\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + ], + 'ListOutboundNumbersOfUser' => [ + 'summary' => '调用ListOutboundNumbersOfUser获取指定实例下指定坐席的可外呼号码。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], [ - 'name' => 'SkillGroupIdList', + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席所属技能组ID列表。', - 'type' => 'string', - 'required' => false, - 'example' => '['."\n" - .' "skg1@ccc-test",'."\n" - .' "skg2@ccc-test"'."\n" - .']', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'AgentId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'FirstAgentId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '首个参与通话的坐席ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'CallingNumber', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'required' => false, - 'example' => '191***9993', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'CalledNumber', + 'name' => 'SkillGroupIdList', 'in' => 'query', + 'schema' => ['description' => '签入技能组ID列表，非必填，默认为空，表示查询UserId归属的所有技能组的外呼号码，如果有值，则查询该值指定的技能组下的外呼号码。注意，此处传入的技能组ID必须是UserId所在的技能组的ID。', 'type' => 'string', 'required' => false, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'required' => false, - 'example' => '191***9993', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'List' => [ + 'description' => '号码列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '0830019****'], + 'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '乐山'], + 'Province' => ['description' => '号码归属地省。'."\n" + ."\n", 'type' => 'string', 'example' => '四川'], + 'Provider' => ['type' => 'string', 'description' => ''], + 'ProviderCode' => ['type' => 'string', 'deprecated' => true, 'description' => ''], + 'ProviderDisplayName' => ['type' => 'string', 'deprecated' => true, 'description' => ''], + 'ProviderShortName' => ['type' => 'string', 'description' => ''], + 'ProviderType' => [ + 'type' => 'string', + 'enum' => ['THIRD_PARTY', 'SELF_HOSTED'], + 'description' => '', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], + ], + ], + 'title' => '获取坐席的外呼号码列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-07-15T12:01:46.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-06-12T11:54:29.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOutboundNumbersOfUser'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"0830019****\\",\\n \\"City\\": \\"乐山\\",\\n \\"Province\\": \\"四川\\",\\n \\"Provider\\": \\"\\",\\n \\"ProviderCode\\": \\"\\",\\n \\"ProviderDisplayName\\": \\"\\",\\n \\"ProviderShortName\\": \\"\\",\\n \\"ProviderType\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"1\\nEEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n10\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n 乐山\\n 083xxxx0019\\n 四川\\n \\n\\nOK","errorExample":""}]', + ], + 'ListPersonalNumbersOfUser' => [ + 'summary' => '调用ListPersonalNumbersOfUser获取指定实例下指定坐席的个人外呼号码列表，也可通过该接口反查可添加为坐席个人外呼号码的号码列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], [ - 'name' => 'Number', + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '电话号码。', - 'type' => 'string', - 'required' => false, - 'example' => '191***9993', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Broker', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '中间号码，需要是实例下可用的外呼号码，双呼时会使用该号码先后呼叫主叫和被叫。', - 'type' => 'string', - 'required' => false, - 'example' => '021****4972', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'user-test@ccc-test'], ], [ - 'name' => 'AccessChannelTypeList', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '访客渠道类型列表。'."\n" - ."\n" - .'枚举列表：'."\n" - ."\n" - .'Web: 网页。'."\n" - ."\n" - .'DingTalkServiceWindow：钉钉服务窗。'."\n" - ."\n" - .'AliMe：对话机器人。'."\n" - ."\n" - .'DingTalkRobot：钉钉机器人。', - 'type' => 'string', - 'required' => false, - 'example' => '["Web","AliMe"]', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'ReleaseInitiatorList', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '挂断方', - 'type' => 'string', - 'required' => false, - 'example' => '[\\"AGENT\\"]', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'ReleaseReasonList', + 'name' => 'IsMember', 'in' => 'query', - 'schema' => [ - 'description' => '挂断原因', - 'type' => 'string', - 'required' => false, - 'example' => '[\\"VisitorInitiatedClosure\\",\\"AgentInitiatedClosure\\"]', - ], + 'schema' => ['description' => '是否关联坐席，若为true，则查询UserId关联的个人外呼号码列表，若为false，则查询UserId可关联但未关联的个人外呼号码列表。通常和AddPersonalNumbersToUser接口一起使用。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'], ], [ - 'name' => 'AnalyticsReportReady', + 'name' => 'SearchPattern', 'in' => 'query', - 'schema' => [ - 'description' => 'AI话后分析报告是否已完成', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '根据号码进行模糊匹配，非必填，不填默认为空。', 'type' => 'string', 'required' => false, 'example' => '0833'], ], ], 'responses' => [ @@ -30253,559 +18316,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'List' => [ - 'description' => '通话记录列表。', + 'description' => '号码列表。', 'type' => 'array', 'items' => [ - 'description' => '通话记录。', 'type' => 'object', 'properties' => [ - 'ContactDisposition' => [ - 'description' => '通话结束原因，枚举列表见ContactDispositionList查询参数。', - 'type' => 'string', - 'example' => 'Success', - ], - 'ContactType' => [ - 'description' => '通话类型，枚举列表见ContactTypeList查询参数。', - 'type' => 'string', - 'example' => 'OUTBOUND', - ], - 'EstablishedTime' => [ - 'description' => '通话建立的时间，如果通话没有建立，此值为空，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1532448000000', - ], - 'CalledNumber' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'example' => '1332315****', - ], - 'AdditionalBroker' => [ - 'description' => '附加中间号码，双呼场景下可能用到。', - 'type' => 'string', - 'example' => '0533128****', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度，即满意度按键数字（1位数字）的值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SatisfactionSurveyChannel' => [ - 'description' => '满意度调查渠道。', - 'type' => 'string', - 'example' => 'IVR', - ], - 'ReleaseTime' => [ - 'description' => '通话结束时间，格式为 Unix 时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1532707199000', - ], - 'WaitTime' => [ - 'description' => '客户等待时长，即 QueueTime+RingTime，若客户等待期间放弃，则为 0，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'SkillGroupNames' => [ - 'description' => '参与通话的座席所属的技能组名称，多个技能组以英文逗号分隔。', - 'type' => 'string', - 'example' => '测试技能组1,测试技能组2', - ], - 'IvrTime' => [ - 'description' => 'IVR时长，即从开始进入IVR到开始进入转人工队列（或客户放弃）之间的时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'SatisfactionDescription' => [ - 'description' => '满意度描述，对应于满意度IVR中满意度模块的配置，客户自行定义。', - 'type' => 'string', - 'example' => '满意', - ], - 'ReleaseInitiator' => [ - 'description' => '挂断方。'."\n" - ."\n" - .'枚举值：'."\n" - ."\n" - .'agent：坐席。'."\n" - ."\n" - .'customer：客户。', - 'type' => 'string', - 'example' => 'customer', - ], - 'AgentIds' => [ - 'description' => '坐席ID列表，多个值用逗号分隔。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'CallDuration' => [ - 'description' => '通话时长，呼入从通话进入IVR开始计时，呼出从接通开始计时，单位秒。', - 'type' => 'string', - 'example' => '16', - ], - 'RecordingReady' => [ - 'description' => '录音是否已经生成。若通话没有建立，则返回false。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'InstanceId' => [ - 'description' => '呼叫中心实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'RingTime' => [ - 'description' => '振铃时长，即从坐席振铃到坐席接起（或客户放弃）之间的时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'SatisfactionSurveyOffered' => [ - 'description' => '是否发送了满意度。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AgentNames' => [ - 'description' => '通话涉及到的坐席名称列表，多个坐席之间使用英文逗号隔开。', - 'type' => 'string', - 'example' => '云呼测试坐席', - ], - 'StartTime' => [ - 'description' => '通话开始时间，内呼从进入 IVR 开始，外呼从拨号开始计算，格式为 Unix 字符串，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1631440860000', - ], - 'ContactId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-2255019651513856', - ], - 'RecordingDuration' => [ - 'description' => '录音时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'CallingNumber' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'example' => '0533128****', - ], - 'QueueTime' => [ - 'description' => '排队时长，即从开始进入转人工队列到坐席开始振铃（或客户放弃，队列超时，队列溢出）之间的时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Broker' => [ - 'description' => '中间号码。', - 'type' => 'string', - 'example' => '053xxxx3127', - ], - 'SkillGroupIds' => [ - 'description' => '参与通话的座席所属的技能组ID，多个技能组以逗号分隔。', - 'type' => 'string', - 'example' => 'skg-default@ccc-test', - ], - 'CallerLocation' => [ - 'description' => '主叫归属地。', - 'type' => 'string', - 'example' => '北京市-北京', - ], - 'CalleeLocation' => [ - 'description' => '被叫归属地。', - 'type' => 'string', - 'example' => '山东省-济南', - ], - 'EarlyMediaState' => [ - 'description' => '早媒体状态。', - 'type' => 'string', - 'example' => 'NotConnected', - ], - 'ReleaseReason' => [ - 'description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', - 'type' => 'string', - 'example' => '486:USER_BUSY', - ], - 'DialingTime' => [ - 'description' => '拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TalkTime' => [ - 'description' => '通话时间，单位为秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HeldTime' => [ - 'description' => '保持时间，单位为秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'EarlyMediaText' => [ - 'description' => '早媒体文本。', - 'type' => 'string', - 'example' => '正在通话中', - ], - 'OffSiteAgentIds' => [ - 'description' => '参与通话的场外坐席ID列表，多个坐席之间使用英文逗号隔开。', - 'type' => 'string', - 'example' => 'skg-default@ccc-test', - ], - 'OffsiteAgentDestinationNumbers' => [ - 'description' => '分配的坐席是场外坐席时，呼叫的场外坐席号码。', - 'type' => 'string', - 'example' => '80312348', - ], - 'MessagesSent' => [ - 'description' => '消息总量，MediaType为CHAT时有值。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'MessagesSentByCustomer' => [ - 'description' => '客户发送消息总数，MediaType为CHAT时有值。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'MessagesSentByAgent' => [ - 'description' => '坐席发送消息总数，MediaType为CHAT时有值。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'FirstResponseTime' => [ - 'description' => '坐席首次回复客户消息花费的时长，MediaType为CHAT时有值。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'MediaType' => [ - 'description' => '媒体类型。'."\n" - ."\n" - .'枚举列表：'."\n" - ."\n" - .'AUDIO：语音。'."\n" - ."\n" - .'CHAT：消息。'."\n" - ."\n" - .'VIDEO：视频。', - 'type' => 'string', - 'example' => 'CHAT', - ], - 'TransferCount' => [ - 'description' => '转接次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AccessChannelType' => [ - 'description' => '渠道类型，MediaType为CHAT时有值。', - 'type' => 'string', - 'example' => 'Web', - ], - 'AccessChannelName' => [ - 'description' => '渠道名称，MediaType为CHAT时有值。', - 'type' => 'string', - 'example' => '测试渠道', - ], - 'AccessChannelUserId' => [ - 'description' => '访客ID，MediaType为CHAT时有值。', - 'type' => 'string', - 'example' => 'test-user-id', - ], - 'AccessChannelUserName' => [ - 'description' => '访客名称，MediaType为CHAT时有值。', - 'type' => 'string', - 'example' => '测试访客', - ], - 'ClientIpAddress' => [ - 'description' => '访客客户端地址，MediaType为CHAT时有值。', - 'type' => 'string', - 'example' => '10.100.2.1', - ], - 'ClientLocation' => [ - 'description' => '访客客户端归属地，MediaType为CHAT时有值。', - 'type' => 'string', - 'example' => '---', - ], - 'ClientUserAgent' => [ - 'description' => '访客客户端信息，MediaType为CHAT时有值。', - 'type' => 'string', - 'example' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36', - ], - 'ClientAppName' => [ - 'description' => '访客客户端名称，MediaType为CHAT时有值。', - 'type' => 'string', - 'example' => '未知', - ], - 'OffsiteAgentOriginatorNumbers' => [ - 'description' => '分配的坐席是场外坐席时，发起呼叫场外坐席的号码。', - 'type' => 'string', - 'example' => '0101257****', - ], - 'CallIds' => [ - 'description' => 'SIP协议的CallId列表。', - 'type' => 'string', - 'example' => 'dxxx1sdf,xkkwwwa', - ], - 'AnalyticsReportReady' => [ - 'description' => 'AI话后分析报告是否完工。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'AnalyticsReport' => [ - 'description' => '话后分析报告。', - 'type' => 'object', - 'properties' => [ - 'ProblemSolving' => [ - 'description' => '问题完结情况', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '任务Id。', - 'type' => 'string', - 'example' => '8bf18b7a10064b29a75946a8d5b8469a', - ], - 'Success' => [ - 'description' => '是否调用成功。'."\n" - ."\n" - .'- **true**：调用成功。'."\n" - .'- **false**：调用失败。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Solved' => [ - 'description' => '是否解决。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Problem' => [ - 'description' => '问题描述。', - 'type' => 'string', - 'example' => '告警问题', - ], - 'Solution' => [ - 'description' => '解决方案。', - 'type' => 'string', - 'example' => '富化服务自动关闭原始告警', - ], - ], - ], - 'Emotion' => [ - 'description' => '情绪分析。', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '0ff07fe35670423089dbdf12766d962f', - ], - 'Success' => [ - 'description' => '是否调用成功。'."\n" - ."\n" - .'- **true**：调用成功。'."\n" - .'- **false**：调用失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Type' => [ - 'description' => '情绪类型。', - 'type' => 'string', - 'example' => '中性', - ], - 'Confidence' => [ - 'description' => '置信度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'Remark' => [ - 'description' => '情绪详细分析备注。', - 'type' => 'string', - 'example' => '客户没情绪变化', - ], - ], - ], - 'Satisfaction' => [ - 'description' => '满意度分析。', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '任务ID', - 'type' => 'string', - 'example' => 'cb67479ce28243b28ff39948feaa0806', - ], - 'Success' => [ - 'description' => '是否调用成功。'."\n" - ."\n" - .'- **true**：调用成功。'."\n" - .'- **false**：调用失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'SatisfactionDescription' => [ - 'description' => '满意度描述。', - 'type' => 'string', - 'example' => '满意', - ], - 'Remark' => [ - 'description' => '满意度分析详情备注。', - 'type' => 'string', - 'example' => '客户表示满意', - ], - ], - ], - 'TodoList' => [ - 'description' => '待办事情。', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '任务ID。'."\n", - 'type' => 'string', - 'example' => 'cb67479ce28243b28ff39948feaa0806', - ], - 'Success' => [ - 'description' => '是否调用成功。'."\n" - ."\n" - .'- **true**：调用成功。'."\n" - .'- **false**：调用失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Tasks' => [ - 'description' => '待办事项。', - 'type' => 'array', - 'items' => [ - 'description' => '待办事项描述。', - 'type' => 'string', - 'example' => '回访', - ], - ], - ], - ], - ], - ], - 'OutsideNumberReleaseReason' => [ - 'description' => '转外线时挂断原因', - 'type' => 'string', - 'example' => 'NoAnswer', - ], - 'SummaryIndex' => [ - 'description' => '小结索引', - 'type' => 'object', - 'properties' => [ - 'Keywords' => [ - 'description' => '关键词', - 'type' => 'string', - 'example' => '客服', - ], - ], - ], - 'VoicebotOriginatorNumber' => [ - 'description' => '从智能外呼转接过来时携带的外呼主叫号码', - 'type' => 'string', - 'example' => '021xxxxxxx', - ], - 'VoicebotDestinationNumber' => [ - 'description' => '从智能外呼转接过来时携带的外呼被叫号码', - 'type' => 'string', - 'example' => '134xxxxxx', - ], - 'OffsiteAgentReleaseReason' => [ - 'description' => '分配的最后一个场外坐席挂断原因', - 'type' => 'string', - 'example' => 'IVRException', - ], + 'Active' => ['description' => '号码是否可用。', 'type' => 'boolean', 'example' => 'true'], + 'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '08330011****'], + 'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '乐山'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'ContactFlowId' => ['description' => '该号码关联的IVR联系流ID。', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek'], + 'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '四川'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid. %s', - ], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], ], - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '获取坐席的个人号码列表', + 'description' => '注意：如果号码已绑定了技能组，则不会出现在可作为个人外呼号码的号码列表中。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPersonalNumbersOfUser'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"OUTBOUND\\",\\n \\"EstablishedTime\\": 1532448000000,\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"AdditionalBroker\\": \\"0533128****\\",\\n \\"SatisfactionIndex\\": 1,\\n \\"SatisfactionSurveyChannel\\": \\"IVR\\",\\n \\"ReleaseTime\\": 1532707199000,\\n \\"WaitTime\\": 5,\\n \\"SkillGroupNames\\": \\"测试技能组1,测试技能组2\\",\\n \\"IvrTime\\": 8,\\n \\"SatisfactionDescription\\": \\"满意\\",\\n \\"ReleaseInitiator\\": \\"customer\\",\\n \\"AgentIds\\": \\"agent@ccc-test\\",\\n \\"CallDuration\\": \\"16\\",\\n \\"RecordingReady\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RingTime\\": 5,\\n \\"SatisfactionSurveyOffered\\": true,\\n \\"AgentNames\\": \\"云呼测试坐席\\",\\n \\"StartTime\\": 1631440860000,\\n \\"ContactId\\": \\"job-2255019651513856\\",\\n \\"RecordingDuration\\": 10,\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"QueueTime\\": 0,\\n \\"Broker\\": \\"053xxxx3127\\",\\n \\"SkillGroupIds\\": \\"skg-default@ccc-test\\",\\n \\"CallerLocation\\": \\"北京市-北京\\",\\n \\"CalleeLocation\\": \\"山东省-济南\\",\\n \\"EarlyMediaState\\": \\"NotConnected\\",\\n \\"ReleaseReason\\": \\"486:USER_BUSY\\",\\n \\"DialingTime\\": 0,\\n \\"TalkTime\\": 0,\\n \\"HeldTime\\": 12,\\n \\"EarlyMediaText\\": \\"正在通话中\\",\\n \\"OffSiteAgentIds\\": \\"skg-default@ccc-test\\",\\n \\"OffsiteAgentDestinationNumbers\\": \\"80312348\\",\\n \\"MessagesSent\\": 10,\\n \\"MessagesSentByCustomer\\": 5,\\n \\"MessagesSentByAgent\\": 5,\\n \\"FirstResponseTime\\": 10,\\n \\"MediaType\\": \\"CHAT\\",\\n \\"TransferCount\\": 1,\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"AccessChannelName\\": \\"测试渠道\\",\\n \\"AccessChannelUserId\\": \\"test-user-id\\",\\n \\"AccessChannelUserName\\": \\"测试访客\\",\\n \\"ClientIpAddress\\": \\"10.100.2.1\\",\\n \\"ClientLocation\\": \\"---\\",\\n \\"ClientUserAgent\\": \\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36\\",\\n \\"ClientAppName\\": \\"未知\\",\\n \\"OffsiteAgentOriginatorNumbers\\": \\"0101257****\\",\\n \\"CallIds\\": \\"dxxx1sdf,xkkwwwa\\",\\n \\"AnalyticsReportReady\\": true,\\n \\"AnalyticsReport\\": {\\n \\"ProblemSolving\\": {\\n \\"TaskId\\": \\"8bf18b7a10064b29a75946a8d5b8469a\\",\\n \\"Success\\": false,\\n \\"Solved\\": true,\\n \\"Problem\\": \\"告警问题\\",\\n \\"Solution\\": \\"富化服务自动关闭原始告警\\"\\n },\\n \\"Emotion\\": {\\n \\"TaskId\\": \\"0ff07fe35670423089dbdf12766d962f\\",\\n \\"Success\\": true,\\n \\"Type\\": \\"中性\\",\\n \\"Confidence\\": 50,\\n \\"Remark\\": \\"客户没情绪变化\\"\\n },\\n \\"Satisfaction\\": {\\n \\"TaskId\\": \\"cb67479ce28243b28ff39948feaa0806\\",\\n \\"Success\\": true,\\n \\"SatisfactionDescription\\": \\"满意\\",\\n \\"Remark\\": \\"客户表示满意\\"\\n },\\n \\"TodoList\\": {\\n \\"TaskId\\": \\"cb67479ce28243b28ff39948feaa0806\\",\\n \\"Success\\": true,\\n \\"Tasks\\": [\\n \\"回访\\"\\n ]\\n }\\n },\\n \\"OutsideNumberReleaseReason\\": \\"NoAnswer\\",\\n \\"SummaryIndex\\": {\\n \\"Keywords\\": \\"客服\\"\\n },\\n \\"VoicebotOriginatorNumber\\": \\"021xxxxxxx\\",\\n \\"VoicebotDestinationNumber\\": \\"134xxxxxx\\",\\n \\"OffsiteAgentReleaseReason\\": \\"IVRException\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取通话详情列表', - 'description' => 'ListCallDetailRecordsV2用来替代ListCallDetailRecords接口，后续新增字段和查询条件会在ListCallDetailRecordsV2持续优化。另外为了保证查询效率，返回数据中的 TotalCount 字段，只会在查询第一页时赋值，查询其他页时返回 0。', + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Active\\": true,\\n \\"Number\\": \\"08330011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n true\\n 083xxxx0011\\n ccc-test\\n a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\n 乐山\\n 四川\\n \\n\\nOK","errorExample":""}]', ], - 'ListHistoricalAgentReport' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListPhoneNumbers' => [ + 'summary' => '调用ListPhoneNumbers获取指定实例下的号码列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -30816,102 +18390,51 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PageSize', + 'name' => 'SearchPattern', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '100', - ], + 'schema' => ['description' => '根据号码进行模糊匹配，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0833'], ], [ - 'name' => 'AgentIdList', - 'in' => 'formData', + 'name' => 'Usage', + 'in' => 'query', 'schema' => [ - 'description' => '坐席ID列表，范围0-100 。'."\n" - ."\n" - .'> 如果坐席ID列表不为空，则直接按照坐席ID列表进行查询，此时pageSize和pageNumber参数无效，数据直接返回，如：请求参数：pageNumber = 3 则响应参数中pageNumber = 3 。', + 'description' => '号码的用途，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => false, - 'example' => '["agent1@ccc-test", "agent2@ccc-test"]', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的起始时间，默认为当天的0时，最早为当前时间往前180天。统计的时间精度为小时，向前取整，闭区间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1532448000000', - ], - ], - [ - 'name' => 'StopTime', - 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的终止时间，默认为当前时间。统计的时间精度为小时，向后取整，开区间。例如：开始时间为 11:12:20，结束时间为 11:45:50，则对齐后的入参时间范围为 [11:00:00, 12:00:00) ，即大于等于11点，小于12点，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1532707199000', + 'enumValueTitles' => ['Outbound' => '呼出', 'Inbound' => '呼入', 'Bidirection' => '呼入和呼出'], + 'example' => 'Bidirection', + 'maxLength' => 200, + 'minLength' => 1, ], ], [ - 'name' => 'InstanceId', + 'name' => 'Active', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '号码是否可用，非必填，默认为空，为空表示不过滤。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'], ], [ - 'name' => 'MediaType', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', - 'type' => 'string', - 'required' => false, - 'example' => 'VIDEO', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'SkillGroupId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'wwtest@test_yunhu', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '20'], ], ], 'responses' => [ @@ -30919,872 +18442,96 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'PageNumber' => ['description' => '分页序号，范围1-100', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页序号，范围1-100', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'List' => [ - 'description' => '坐席历史数据列表。', + 'description' => '号码列表。', 'type' => 'array', 'items' => [ - 'description' => '坐席历史数据。', 'type' => 'object', 'properties' => [ - 'AgentName' => [ - 'description' => '坐席姓名。', - 'type' => 'string', - 'example' => '坐席小王', - ], - 'AgentId' => [ - 'description' => '座席ID。', - 'type' => 'string', - 'example' => 'agent1@ccc-test', - ], - 'DisplayId' => [ - 'description' => '坐席工号。', - 'type' => 'string', - 'example' => '001', - ], - 'Inbound' => [ - 'description' => '呼入数据。', - 'type' => 'object', - 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，计算公式为：TotalRingTime/CallsRinged，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '应答量，即坐席应答的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAttendedTransferOut' => [ - 'description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，计算公式为：TotalWorkTime/CallsHandled，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsBlindTransferIn' => [ - 'description' => '直接转入量，若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsRinged' => [ - 'description' => '坐席振铃的电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAttendedTransferIn' => [ - 'description' => '咨询转入量，若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsBlindTransferOut' => [ - 'description' => '直接转出量，若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '分配量，即分配给此坐席的电话次数，包括其他坐席盲转和咨询转给此坐席的电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，计算公式为：TotalTalkTime/CallsHandled，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，计算公式为：TotalHoldTime/CallsHold，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AccessChannelTypeDetails' => [ - 'description' => '各渠道的统计数据。', - 'type' => 'array', - 'items' => [ - 'description' => '渠道的统计数据。', - 'type' => 'object', - 'properties' => [ - 'AccessChannelType' => [ - 'description' => '渠道类型。', - 'type' => 'string', - 'example' => 'Web', - ], - 'CallsOffered' => [ - 'description' => '分配的会话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - ], - ], - ], - 'AverageFirstResponseTime' => [ - 'description' => 'Chat会话平均首次响应时长，单位为秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - 'AverageResponseTime' => [ - 'description' => 'Chat会话平均响应时长。', - 'type' => 'number', - 'format' => 'float', - 'example' => '12', - ], - 'ServiceLevel15' => [ - 'description' => '15秒服务水平。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.85', - ], - 'TotalMessagesSent' => [ - 'description' => 'Chat会话中总消息发送量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'TotalMessagesSentByAgent' => [ - 'description' => 'Chat会话中坐席发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'TotalMessagesSentByCustomer' => [ - 'description' => 'Chat会话中客户发送的总消息量。', - 'type' => 'string', - 'example' => '9', - ], - ], - ], - 'Outbound' => [ - 'description' => '呼出数据。', - 'type' => 'object', - 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，计算公式为： TotalRingTime/CallsRinged，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAttendedTransferOut' => [ - 'description' => '咨询转出量，若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，计算公式为：TotalWorkTime/CallsDialed，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsBlindTransferIn' => [ - 'description' => '直接转入量，若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsRinged' => [ - 'description' => '坐席振铃的电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAttendedTransferIn' => [ - 'description' => '咨询转入量，若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsBlindTransferOut' => [ - 'description' => '直接转出量，若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，计算公式为：TotalTalkTime/CallsAnswered，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，计算公式为：TotalHoldTime/CallsHold，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，计算公式为：TotalDialingTime/CallsDialed，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - ], - ], - 'Overall' => [ - 'description' => '整体数据。', - 'type' => 'object', - 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，不包含小休时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，计算公式为：（TotalworkTime+TotalTalkTime）/TotalLoggedInTime。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageBreakTime' => [ - 'description' => '平均小休时长，计算公式为：TotalBreakTime/小休次数，小休次数为非接口统计字段，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxBreakTime' => [ - 'description' => '最大小休时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，计算公式为：TotalWorkTime/TotalCalls，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，计算公式为：TotalTalkTime/（CallsAnswered+CallsHandled），单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/（呼入CallsHold+呼出CallsHold）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话量，计算公式为：CallsOffered+CallsDialed。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalOnSiteOnlineTime' => [ - 'description' => '总场内在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '已弃用，请使用TotalOnSiteLoggedInTime代替此参数', - ], - 'TotalOffSiteOnlineTime' => [ - 'description' => '总场外在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '已弃用，请使用TotalOffSiteLoggedInTime代替此参数', - ], - 'TotalOfficePhoneOnlineTime' => [ - 'description' => '总办公电话模式在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '已弃用，请使用TotalOfficePhoneLoggedInTime代替此参数', - ], - 'BreakCodeDetailList' => [ - 'description' => '各类型小休统计数据。', - 'type' => 'array', - 'items' => [ - 'description' => '小休统计数据', - 'type' => 'object', - 'properties' => [ - 'BreakCode' => [ - 'description' => '小休类型代码。', - 'type' => 'string', - 'example' => '会议', - ], - 'Count' => [ - 'description' => '此类型小休的发生次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Duration' => [ - 'description' => '此类型小休的总计发生时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - ], - ], - ], - 'FirstCheckInTime' => [ - 'description' => '最早签入时间，格式是unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1686030515000', - ], - 'LastCheckOutTime' => [ - 'description' => '最后签出时间，格式是unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1686030515000', - ], - 'TotalOutboundScenarioTime' => [ - 'description' => '总仅外呼在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '已弃用，请使用TotalOutboundScenarioLoggedInTime代替此参数', - ], - 'TotalOutboundScenarioReadyTime' => [ - 'description' => '总仅外呼空闲时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalOfficePhoneLoggedInTime' => [ - 'description' => '总办公电话模式在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3600', - ], - 'TotalOffSiteLoggedInTime' => [ - 'description' => '总场外在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalOnSiteLoggedInTime' => [ - 'description' => '总场内在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalOutboundScenarioLoggedInTime' => [ - 'description' => '总仅外呼在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - ], - 'SkillGroupIds' => [ - 'description' => '座席所属技能组ID列表，格式为JSON数组的字符串，数组元素为技能组ID。', - 'type' => 'string', - 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]', - ], - 'SkillGroupNames' => [ - 'description' => '座席所属技能组名称列表，格式为JSON数组的字符串，数组元素是技能组名称。', + 'Active' => ['description' => '号码是否可用。', 'type' => 'boolean', 'example' => 'true'], + 'CreateTime' => ['description' => '号码创建时间，即关联到实例的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'string', 'example' => '1617958538000'], + 'UserId' => ['description' => '坐席ID，如果此参数不为空，说明该号码是座席专属号码。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Tags' => ['description' => '号码业务标签，主要用于给号码打标，做一些扩展业务，普通客户无需关心。', 'type' => 'string', 'example' => 'M1'], + 'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '乐山'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Usage' => [ + 'description' => '号码用途。', 'type' => 'string', - 'example' => '["测试技能组1","测试技能组2"]', - ], - 'Back2Back' => [ - 'description' => '双呼指标。', - 'type' => 'object', - 'properties' => [ - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'string', - 'example' => '100', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'string', - 'example' => '0.6', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'string', - 'example' => '100', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'string', - 'example' => '100', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'string', - 'example' => '100', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'string', - 'example' => '100', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'string', - 'example' => '100', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'string', - 'example' => '100', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'string', - 'example' => '100', - ], - 'TotalCustomerRingTime' => [ - 'description' => '总客户侧振岭时长，单位秒。', - 'type' => 'string', - 'example' => '100', - ], - 'MaxCustomerRingTime' => [ - 'description' => '最大客户侧振铃时长，单位秒。', - 'type' => 'string', - 'example' => '100', - ], - 'AverageCustomerRingTime' => [ - 'description' => '平均客户侧振铃时长，单位秒', - 'type' => 'string', - 'example' => '100', - ], - 'CallsAgentHandled' => [ - 'description' => '坐席接听电话数量。', - 'type' => 'string', - 'example' => '10', - ], - 'AgentHandleRate' => [ - 'description' => '坐席应答率。', - 'type' => 'string', - 'example' => '1', - ], - 'CallsCustomerAnswered' => [ - 'description' => '客户接听电话数量。', - 'type' => 'string', - 'example' => '7', - ], - 'CustomerAnswerRate' => [ - 'description' => '客户接通率。', - 'type' => 'string', - 'example' => '0.7', - ], - ], + 'enumValueTitles' => ['Outbound' => '呼出', 'Inbound' => '呼入', 'Bidirection' => '呼入和呼出'], + 'example' => 'Bidirection', ], - 'Internal' => [ - 'description' => '内部呼叫指标。', - 'type' => 'object', - 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsOffered' => [ - 'description' => '电话呼入数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsHandled' => [ - 'description' => '电话应答数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsTalked' => [ - 'description' => '参与通话次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'ContactFlowName' => ['description' => '号码关联的IVR联系流名称。', 'type' => 'string', 'example' => '默认联系流'], + 'Provider' => ['description' => '号码供应商名称。', 'type' => 'string', 'example' => 'alicom'], + 'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '08330011****'], + 'ContactFlowId' => ['description' => '号码关联的IVR联系流ID。', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek'], + 'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '四川'], + 'SkillGroups' => [ + 'description' => '号码关联的技能组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '技能组展示名。', 'type' => 'string', 'example' => '测试技能组'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Name' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"AgentId\\": \\"agent1@ccc-test\\",\\n \\"DisplayId\\": \\"001\\",\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AccessChannelTypeDetails\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 3\\n }\\n ],\\n \\"AverageFirstResponseTime\\": 10,\\n \\"AverageResponseTime\\": 12,\\n \\"ServiceLevel15\\": 0.85,\\n \\"TotalMessagesSent\\": 16,\\n \\"TotalMessagesSentByAgent\\": 7,\\n \\"TotalMessagesSentByCustomer\\": \\"9\\"\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0,\\n \\"TotalOnSiteOnlineTime\\": 0,\\n \\"TotalOffSiteOnlineTime\\": 0,\\n \\"TotalOfficePhoneOnlineTime\\": 0,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 3,\\n \\"Duration\\": 120\\n }\\n ],\\n \\"FirstCheckInTime\\": 1686030515000,\\n \\"LastCheckOutTime\\": 1686030515000,\\n \\"TotalOutboundScenarioTime\\": 0,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"TotalOfficePhoneLoggedInTime\\": 3600,\\n \\"TotalOffSiteLoggedInTime\\": 100,\\n \\"TotalOnSiteLoggedInTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 100\\n },\\n \\"SkillGroupIds\\": \\"[\\\\\\"skillgroup1@ccc-test\\\\\\",\\\\\\"skillgroup2@ccc-test\\\\\\"]\\",\\n \\"SkillGroupNames\\": \\"[\\\\\\"测试技能组1\\\\\\",\\\\\\"测试技能组2\\\\\\"]\\",\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": \\"100\\",\\n \\"AnswerRate\\": \\"0.6\\",\\n \\"CallsAnswered\\": \\"100\\",\\n \\"TotalTalkTime\\": \\"100\\",\\n \\"MaxTalkTime\\": \\"100\\",\\n \\"AverageTalkTime\\": \\"100\\",\\n \\"TotalRingTime\\": \\"100\\",\\n \\"MaxRingTime\\": \\"100\\",\\n \\"AverageRingTime\\": \\"100\\",\\n \\"TotalCustomerRingTime\\": \\"100\\",\\n \\"MaxCustomerRingTime\\": \\"100\\",\\n \\"AverageCustomerRingTime\\": \\"100\\",\\n \\"CallsAgentHandled\\": \\"10\\",\\n \\"AgentHandleRate\\": \\"1\\",\\n \\"CallsCustomerAnswered\\": \\"7\\",\\n \\"CustomerAnswerRate\\": \\"0.7\\"\\n },\\n \\"Internal\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsTalked\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 10\\n 100\\n 1\\n \\n 8001xxxx\\n user-test@ccc-test\\n 云呼测试坐席\\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '获取坐席历史数据报表', - 'summary' => '调用ListHistoricalAgentReport获取指定实例下的一个或多个坐席的历史数据报表。', + 'title' => '获取号码列表', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListHistoricalSkillGroupReport' => [ - 'summary' => '调用ListHistoricalSkillGroupReport获取指定实例下的一个或多个技能组的历史数据报表。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-06-30T08:58:18.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPhoneNumbers'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Active\\": true,\\n \\"CreateTime\\": \\"1617958538000\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Tags\\": \\"M1\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowName\\": \\"默认联系流\\",\\n \\"Provider\\": \\"alicom\\",\\n \\"Number\\": \\"08330011****\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\",\\n \\"SkillGroups\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n20\\n无\\n1\\n200\\n\\n 1\\n 20\\n 1\\n \\n Bidirection\\n true\\n 083xxxx0011\\n ccc-test\\n a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\n user-test@ccc-test\\n 1617958538000\\n 测试IVR\\n 乐山\\n M1\\n 四川\\n ali\\n \\n ccc-test\\n 测试技能组\\n test@ccc-test\\n test\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'ListPhoneNumbersOfSkillGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31796,99 +18543,46 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccOQKOLI', - ], + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PageSize', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '100', - ], + 'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'], ], [ - 'name' => 'SkillGroupIdList', - 'in' => 'formData', - 'schema' => [ - 'description' => '待查询的技能组ID列表，格式为JSON数组的字符串，数组元素为技能组ID，非必填，默认为空，表示查询当前分页下的所有技能组。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test2"]', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'StartTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的起始时间，格式为Unix时间戳，单位毫秒，非必填，默认为当天的0时，最早为当前时间往前180天，统计的时间精度为小时，向前取整，闭区间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1532448000000', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'EndTime', + 'name' => 'IsMember', 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的终止时间，格式为Unix时间戳，单位毫秒，非必填，默认为当前时间，统计的时间精度为小时，向后取整，开区间。例如：开始时间为11:12:20，结束时间为11:45:50，则对齐后的入参时间范围为[11:00:00, 12:00:00) ，即大于等于11点，小于12点。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1532707199000', - ], + 'schema' => ['description' => '是否关联技能组，若为true，则查询SkillgroupId关联的号码列表，若为false，则查询SkillgroupId可关联但未关联的号码列表。通常和AddNumbersToSkillGroup接口一起使用。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'], ], [ - 'name' => 'InstanceId', + 'name' => 'SearchPattern', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '根据号码进行模糊匹配，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'example' => '0833'], ], [ - 'name' => 'MediaType', + 'name' => 'Active', 'in' => 'query', - 'schema' => [ - 'description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', - 'type' => 'string', - 'required' => false, - 'example' => 'VIDEO', - ], + 'schema' => ['description' => '号码是否可用，非必填，默认为空，为空表示不过滤。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -31896,901 +18590,78 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'List' => [ - 'description' => '技能组历史数据列表。', + 'description' => '号码列表。', 'type' => 'array', 'items' => [ - 'description' => '技能组历史数据。', 'type' => 'object', 'properties' => [ - 'SkillGroupName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => 'skillgroup', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', + 'Active' => ['description' => '号码是否可用。', 'type' => 'boolean', 'example' => 'true'], + 'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '08330011****'], + 'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '乐山'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Usage' => [ + 'description' => '号码用途。', 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Inbound' => [ - 'description' => '呼入指标。', - 'type' => 'object', - 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', - 'type' => 'number', - 'format' => 'float', - 'example' => '5', - ], - 'CallsOverflow' => [ - 'description' => '溢出量，即发生队列（技能组）溢出的电话数量。若一通电话多次进入同一队列，每次溢出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInRing' => [ - 'description' => '振铃放弃量，即坐席振铃中客户挂机的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '应答量，即坐席应答的次数。一通电话每次进入队列后，若被多个坐席应答，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '85', - ], - 'TotalAbandonedInRingTime' => [ - 'description' => '总振铃放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'CallsAttendedTransferOut' => [ - 'description' => '咨询转出量，即由该技能组发起的咨询转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWaitTime' => [ - 'description' => '平均等待时长，平均每通电话的坐席接起前等待时长。计算公式为：TotalWaitTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '5', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxAbandonTime' => [ - 'description' => '最大放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为： TotalWorkTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '13', - ], - 'CallsQueued' => [ - 'description' => '呼入场景进入队列（技能组）的电话数量，若一通电话多次进入同一队列，每次进入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'CallsBlindTransferIn' => [ - 'description' => '直接转入量，即由其他技能组发起的直接转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时签入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageAbandonedInRingTime' => [ - 'description' => '平均振铃放弃时长，单位秒。计算公式为： TotalAbandonedInRingTime/CallsAbandonedInRing。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageAbandonTime' => [ - 'description' => '平均放弃时长，单位秒。计算公式为：TotalAbandonTime/CallsAbandoned。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsRinged' => [ - 'description' => '坐席振铃的电话数量，一通电话每次进入队列后，若分配给多个座席并产生了振铃，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'CallsBlindTransferOut' => [ - 'description' => '直接转出量，即由该技能组发起的直接转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAttendedTransferIn' => [ - 'description' => '咨询转入量，即由其他技能组发起的咨询转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时迁入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandoned' => [ - 'description' => '放弃量。计算公式为：CallsAbandonedInQueue+CallsAbandonedInRing。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxAbandonedInQueueTime' => [ - 'description' => '最大排队放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWaitTime' => [ - 'description' => '总等待时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'AbandonRate' => [ - 'description' => '放弃率。计算公式为：CallsAbandoned/CallsOffered（由于放弃事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '447', - ], - 'TotalAbandonTime' => [ - 'description' => '总放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '分配量，即分配给该技能组的电话数量，包括通过队列分配的电话数量和通过转接（咨询转接和直接转接）分配的电话数量。计算公式为：CallsQueued+CallsBlindTransferIn+CallsAttentandedTransferIn。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'MaxAbandonedInRingTime' => [ - 'description' => '最大振铃放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWaitTime' => [ - 'description' => '最大等待时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13', - ], - 'AverageAbandonedInQueueTime' => [ - 'description' => '平均排队放弃时长，单位秒。计算公式为： TotalAbandonedInQueueTime/CallsAbandonedInQueue。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '20秒服务水平，等待时长小于等于20秒的电话数量/CallsQueued。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '64', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的次数。一通电话每次进入队列后，若发生多次通话保持，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'CallsTimeout' => [ - 'description' => '超时量，即发生队列（技能组）超时的电话数量。若一通电话多次进入同一队列，每次超时算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalAbandonedInQueueTime' => [ - 'description' => '总排队放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInQueue' => [ - 'description' => '队列放弃量，即电话进入队列之后在排队环节客户挂机的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsQueuingTimeout' => [ - 'description' => '在排队阶段超时的通话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsQueuingOverflow' => [ - 'description' => '队列溢出的通话数量，队列溢出指通话在IVR排队时队列溢出。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AccessChannelTypeDetails' => [ - 'description' => '各渠道的统计数据。', - 'type' => 'array', - 'items' => [ - 'description' => '各渠道的统计数据。', - 'type' => 'object', - 'properties' => [ - 'AccessChannelType' => [ - 'description' => '渠道类型。', - 'type' => 'string', - 'example' => 'Web', - ], - 'CallsOffered' => [ - 'description' => '分配的会话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - ], - ], - ], - 'AverageFirstResponseTime' => [ - 'description' => 'Chat会话平均首次响应时长，单位为秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '6', - ], - 'AverageResponseTime' => [ - 'description' => 'Chat会话平均响应时长。', - 'type' => 'number', - 'format' => 'float', - 'example' => '8', - ], - 'CallsQueuingFailed' => [ - 'description' => '队列失败量，即电话进入队列之后在排队环节客户挂机的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ServiceLevel15' => [ - 'description' => '15秒服务水平。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.7', - ], - 'ServiceLevel30' => [ - 'description' => '30秒服务水平。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.9', - ], - 'TotalMessagesSent' => [ - 'description' => 'Chat会话中总消息发送量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'TotalMessagesSentByAgent' => [ - 'description' => 'Chat会话中坐席发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'TotalMessagesSentByCustomer' => [ - 'description' => 'Chat会话中客户发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - ], - ], - 'Outbound' => [ - 'description' => '呼出指标。', - 'type' => 'object', - 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'CallsAttendedTransferOut' => [ - 'description' => '咨询转出量，即由该技能组发起的咨询转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '218', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsDialed', - 'type' => 'number', - 'format' => 'float', - 'example' => '2', - ], - 'CallsBlindTransferIn' => [ - 'description' => '直接转入量，即由其他技能组发起的直接转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时签入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsRinged' => [ - 'description' => '坐席振铃的电话数量，一通电话每次进入队列后，若分配给多个座席并产生了振铃，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAttendedTransferIn' => [ - 'description' => '咨询转入量，即由其他技能组发起的咨询转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时迁入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsBlindTransferOut' => [ - 'description' => '直接转出量，即由该技能组发起的直接转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsAnswered。', - 'type' => 'number', - 'format' => 'float', - 'example' => '3', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的电话数量。一通电话在转出当前技能组之前，若发生多次通话保持，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。计算公式为：TotalDialingTime/CallsDialed。', - 'type' => 'number', - 'format' => 'float', - 'example' => '37', - ], - ], - ], - 'Overall' => [ - 'description' => '整体指标。', - 'type' => 'object', - 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '449', - ], - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。'."\n" - .'_注意：不含离线和小休时长_', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23218', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，计算公式为： (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.02332222293912065', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '94', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'AverageBreakTime' => [ - 'description' => '平均小休时长，单位秒。计算公式为：TotalBreakTime/小休次数。小休次数为非接口统计字段。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxBreakTime' => [ - 'description' => '最大小休时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/TotalCalls。', - 'type' => 'number', - 'format' => 'float', - 'example' => '8', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/(CallsAnswered+CallsHandled)。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19328', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位秒。计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22428', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话量。计算公式为：CallsOffered + CallsDialed。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13', - ], - 'BreakCodeDetailList' => [ - 'description' => '小休详情列表。', - 'type' => 'array', - 'items' => [ - 'description' => '小休详情。', - 'type' => 'object', - 'properties' => [ - 'BreakCode' => [ - 'description' => '小休类型代码。', - 'type' => 'string', - 'example' => '会议', - ], - 'Count' => [ - 'description' => '此类型小休的发生次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'Duration' => [ - 'description' => '此类型小休的总计发生时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3600', - ], - ], - ], - ], - ], - ], - 'Back2Back' => [ - 'description' => '双呼指标。', - 'type' => 'object', - 'properties' => [ - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.6', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'TotalCustomerRingTime' => [ - 'description' => '总客户侧振岭时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxCustomerRingTime' => [ - 'description' => '最大客户侧振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageCustomerRingTime' => [ - 'description' => '平均客户侧振铃时长，单位秒', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'AgentHandleRate' => [ - 'description' => '坐席应答率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'CallsCustomerAnswered' => [ - 'description' => '客户接听电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'CustomerAnswerRate' => [ - 'description' => '客户接通率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.8', - ], - ], + 'enumValueTitles' => ['Outbound' => '呼出', 'Inbound' => '呼入', 'Bidirection' => '呼入和呼出'], + 'example' => 'Bidirection', ], + 'ContactFlowId' => ['description' => '号码关联的IVR联系流ID。', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek'], + 'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '四川'], ], + 'description' => '', ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid. %s', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], ], - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 4,\\n \\"List\\": [\\n {\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 5,\\n \\"CallsOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"CallsHandled\\": 7,\\n \\"TotalWorkTime\\": 85,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"MaxWorkTime\\": 12,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"AverageWaitTime\\": 5,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageWorkTime\\": 13,\\n \\"CallsQueued\\": 7,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"CallsRinged\\": 7,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"TotalWaitTime\\": 34,\\n \\"TotalRingTime\\": 32,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 12,\\n \\"AbandonRate\\": 0,\\n \\"TotalTalkTime\\": 447,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 7,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"MaxWaitTime\\": 13,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"AverageTalkTime\\": 64,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 1,\\n \\"CallsTimeout\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"AccessChannelTypeDetails\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 2\\n }\\n ],\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 8,\\n \\"CallsQueuingFailed\\": 0,\\n \\"ServiceLevel15\\": 0.7,\\n \\"ServiceLevel30\\": 0.9,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 9,\\n \\"TotalMessagesSentByCustomer\\": 3\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 6,\\n \\"CallsAnswered\\": 1,\\n \\"TotalWorkTime\\": 9,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 218,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 2,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 3,\\n \\"MaxDialingTime\\": 12,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 3,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 37\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 449,\\n \\"TotalLoggedInTime\\": 23218,\\n \\"OccupancyRate\\": 0.02332222293912065,\\n \\"TotalWorkTime\\": 94,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 12,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 1,\\n \\"AverageWorkTime\\": 8,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 19328,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 22428,\\n \\"TotalBreakTime\\": 3,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 13,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 2,\\n \\"Duration\\": 3600\\n }\\n ]\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.6,\\n \\"CallsAnswered\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 1,\\n \\"CallsCustomerAnswered\\": 8,\\n \\"CustomerAnswerRate\\": 0.8\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\n无\\n200\\n\\n 4\\n 100\\n 1\\n \\n test1\\n skg-test1@ccc-test\\n \\n 0\\n 0\\n 85\\n 0\\n 7\\n 0\\n 12\\n 7\\n 0\\n 0\\n 0\\n 0\\n 32\\n 1\\n 0\\n 447\\n 5\\n 0\\n 7\\n 0\\n 0\\n 0\\n 0\\n 0\\n 64\\n 0\\n 0\\n 0\\n 0\\n 0\\n 7\\n 13\\n 0\\n 0\\n 0\\n 5\\n 34\\n 0\\n 0\\n 0\\n 0\\n 13\\n 12\\n 0\\n 0\\n \\n \\n 218\\n 9\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 37\\n 1\\n 3\\n 6\\n 12\\n 0\\n 0\\n 0\\n 0\\n 3\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 2\\n 0\\n 0\\n \\n \\n 22428\\n 13\\n 3\\n 94\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 449\\n 0\\n 23218\\n 0\\n 0\\n 19328\\n 8\\n 12\\n 1\\n 0.02332222293912065\\n 0\\n 0\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '获取技能组历史数据报表', + 'title' => '获取技能组的号码列表', + 'summary' => '调用ListPhoneNumbersOfSkillGroup获取指定实例下指定技能组关联的号码列表，也可以通过该接口反查未关联但可关联到该技能组的号码。', + 'description' => '注意：如果号码已作为个人外呼号码使用，则不会出现在可添加到技能组的号码列表中。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListIntervalAgentReport' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPhoneNumbersOfSkillGroup'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Active\\": true,\\n \\"Number\\": \\"08330011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n Bidirection\\n true\\n 083xxxx0011\\n ccc-test\\n a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\n 乐山\\n 四川\\n \\n\\nOK","errorExample":""}]', + ], + 'ListPrivilegesOfUser' => [ + 'summary' => '调用ListPrivilegesOfUser获取当前用户拥有的权限。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -32801,929 +18672,411 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], 'parameters' => [ [ - 'name' => 'AgentId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agent@ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], - [ - 'name' => 'StartTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '开始时间，格式为Unix时间戳，单位毫秒，非必填，默认为当天的0时，统计的时间精度为小时，向前取整，闭区间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1532448000000', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Scope' => [ + 'description' => '权限范围。', + 'type' => 'string', + 'enumValueTitles' => ['SELF_ONLY' => '仅可访问自己的所有数据', 'INSTANCE' => '整个实例下的数据皆可访问', 'SKILL_GROUP' => '可以访问自己所在技能组的所有数据'], + 'example' => 'SELF_ONLY', + ], + 'Name' => ['description' => '权限名称，普通客户无需了解具体的权限名称，该接口主要由坐席工作台调用。', 'type' => 'string', 'example' => 'Workbench:Call'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '获取坐席的权限列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrivilegesOfUser'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Scope\\": \\"SELF_ONLY\\",\\n \\"Name\\": \\"Workbench:Call\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n200\\n\\n SELF_ONLY\\n ccc-test\\n Workbench:Call\\n\\nOK","errorExample":""}]', + ], + 'ListRamUsers' => [ + 'summary' => '调用ListRamUsers获取未导入指定实例下的RAM用户列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。'."\n" + ."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test '], + ], + [ + 'name' => 'SearchPattern', + 'in' => 'query', + 'schema' => ['description' => '根据坐席登录名或坐席展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'agent'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页序号，范围1-1000。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100000', 'minimum' => '1', 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '截止时间，格式为Unix时间戳，单位毫秒，非必填，默认是当前时间，如果Interval为Daily，StartTime和EndTime最大间隔是180天。如果Interval为Hourly，最大间隔时间为10天。统计的时间精度为小时，向后取整，开区间。例如：开始时间为11:12:20，结束时间为11:45:50，则对齐后的入参时间范围为[11:00:00,12:00:00)，即大于等于11点，小于12点。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1532707199000', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。'."\n" + ."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。'."\n" + ."\n", 'type' => 'string', 'example' => '24753D71-C91D-1A38-A8AD-372BF12453F6'], + 'Data' => [ + 'description' => '数据。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-1000。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'List' => [ + 'description' => 'RAM用户列表。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'RAM用户', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => 'RAM账户姓名。', 'type' => 'string', 'example' => '测试账号'], + 'Email' => ['description' => '邮箱。'."\n" + ."\n", 'type' => 'string', 'example' => 'username@example.com'], + 'LoginName' => ['description' => 'RAM用户名。'."\n" + ."\n", 'type' => 'string', 'example' => 'agent'], + 'Mobile' => ['description' => 'RAM账户预留的个人电话号码。', 'type' => 'string', 'example' => '1382114****'], + 'AliyunUid' => ['description' => 'RAM账户所属的阿里云主账号UID。', 'type' => 'integer', 'format' => 'int64', 'example' => '15772400000****'], + 'Primary' => ['description' => 'RAM账号是否为主账号。', 'type' => 'boolean', 'example' => 'false'], + 'RamId' => ['description' => 'RAM用户的UID。', 'type' => 'string', 'example' => '28036411123456****'], + ], + ], + ], + ], + ], + 'Params' => [ + 'type' => 'array', + 'items' => ['description' => '响应参数。'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'description' => '', + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '获取RAM用户列表', + 'description' => '一个RAM用户可以作为坐席导入到多个实例下，但是一个坐席只能指向一个RAM账户，如果我们在实例下创建坐席，实际上是创建了一个RAM账户的，此时如果想创建一个新的实例又不想创建多余的RAM账户，就可以调用ListRamUsers接口获取未导入实例下的RAM用户列表，然后再调用导入RAM用户的接口将RAM用户导入到实例下。这样可以避免过多的创建RAM账户，造成资源浪费。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRamUsers'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"24753D71-C91D-1A38-A8AD-372BF12453F6\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"测试账号\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"AliyunUid\\": 0,\\n \\"Primary\\": false,\\n \\"RamId\\": \\"28036411123456****\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"24753D71-C91D-1A38-A8AD-372BF12453F6\\n无\\n200\\n无\\n\\n 1\\n 10\\n 1\\n \\n user-test\\n 1886666****@163.com\\t\\n false\\n 157724000000000\\n 28036411123456xxxx\\n 测试用户\\t\\n 1382114****\\n \\n\\nOK","errorExample":""}]', + ], + 'ListRealtimeAgentStates' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '50572', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], + 'parameters' => [ + [ + 'name' => 'SkillGroupId', + 'in' => 'query', + 'schema' => ['description' => '按技能组ID过滤，非必填，默认为空，表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'skillgroup@ccc-test'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], [ 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'AgentIdList', + 'in' => 'formData', + 'schema' => ['description' => '坐席ID列表，格式为JSON数组的字符串，数组元素最多20个，非必填，默认为空，表示匹配当前实例下的所有坐席。', 'type' => 'string', 'required' => false, 'example' => '["agent1@ccc-test", "agent2@ccc-test"]'], + ], + [ + 'name' => 'StateList', + 'in' => 'formData', 'schema' => [ - 'description' => '实例ID。', + 'description' => '按状态列表过滤，非必填，默认为空，表示匹配所有状态。', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', + 'required' => false, + 'enumValueTitles' => ['Ready' => '空闲', 'Talking' => '通话', 'ACW' => '话后处理', 'Break' => '小休', 'Ringing' => '振铃', 'Offline' => '离线', 'Dialing' => '拨号'], + 'example' => '["ACW", "Dialing"]', ], ], [ - 'name' => 'Interval', + 'name' => 'AgentName', + 'in' => 'query', + 'schema' => ['description' => '按坐席名称进行模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'agent'], + ], + [ + 'name' => 'WorkModeList', 'in' => 'query', 'schema' => [ - 'description' => '分段统计类型，非必填，默认为Daily（按天汇总）。', + 'description' => '按工作模式列表过滤，非必填，默认为空，表示匹配所有工作模式。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Hourly' => '按小时统计', - 'Daily' => '按天统计', - ], - 'example' => 'Hourly', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => '["OFFICE_PHONE","ON_SITE"]', ], ], [ - 'name' => 'MediaType', + 'name' => 'OutboundScenario', + 'in' => 'query', + 'schema' => ['description' => '过滤仅外呼模式下的坐席，非必填，默认为空，表示不按仅外呼模式过滤。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => ['description' => '模糊过滤，可以是坐席展示名、坐席工号或坐席分机号的全部或者一部分，非必填，默认为空，表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'agent'], + ], + [ + 'name' => 'CallTypeList', 'in' => 'query', 'schema' => [ - 'description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', + 'description' => '按通话类型列表过滤，格式为JSON数组的字符串，数组元素为通话类型，非必填，默认为空，表示匹配所有的通话类型。', 'type' => 'string', 'required' => false, - 'example' => 'VIDEO', + 'enumValueTitles' => ['Outbound' => '呼出', 'Back2Back' => '双呼', 'PrivacyDial' => '加密通话', 'Internal' => '内部呼叫', 'Predictive' => '预测式外呼', 'Inbound' => '呼入', 'Conference' => '会议'], + 'example' => '["Inbound", "Outbound"]', ], ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => '媒体类型，默认是语音（Audio）, 其他可选参数包括Chat（文本）、Video（视频）、ALL（全选）.', 'type' => 'string', 'required' => false, 'example' => 'AUDIO'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Data' => [ - 'description' => '坐席分段统计数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '坐席分段统计数据。', - 'type' => 'object', - 'properties' => [ - 'StatsTime' => [ - 'description' => '时间段的开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1620291600000', - ], - 'Inbound' => [ - 'description' => '呼入指标。', + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'List' => [ + 'description' => '实时坐席状态数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实时坐席状态数据。', 'type' => 'object', 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '应答量，即坐席应答的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAttendedTransferOut' => [ - 'description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsBlindTransferIn' => [ - 'description' => '直接转入量。若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsRinged' => [ - 'description' => '坐席振铃的电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAttendedTransferIn' => [ - 'description' => '咨询转入量。若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsBlindTransferOut' => [ - 'description' => '直接转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '分配量，即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '80317391'], + 'StateCode' => [ + 'description' => '子状态，部分场景下，仅用State字段无法完整表示坐席状态，因此需要子状态辅助，比如监听状态下，State=Talking，StateCode=Monitoring。', + 'type' => 'string', + 'enumValueTitles' => ['Monitored' => '被监听', 'Consulted' => '被咨询', 'Coaching' => '辅导中', 'Consulting' => '咨询中', 'Coached' => '被辅导', 'Conference' => '会议', 'Monitoring' => '监听中'], + 'example' => 'Monitored', ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + 'State' => [ + 'description' => '坐席状态。', + 'type' => 'string', + 'enumValueTitles' => ['Ready' => '空闲', 'Talking' => '通话', 'ACW' => '话后处理', 'Ringing' => '振铃', 'Break' => '小休', 'Offline' => '下线', 'Dialing' => '拨号'], + 'example' => 'ACW', ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + 'BreakCode' => ['description' => '小休码。'."\n" + ."\n" + .'**枚举值：**'."\n" + ."\n" + .'- RingingTimeout：坐席振铃超时导致的小休。'."\n" + ."\n" + .'- RejectCall：坐席拒接导致的小休。'."\n" + ."\n" + .'- Warm-up：坐席上线后置闲前的临时小休状态。', 'type' => 'string', 'example' => 'Warm-up'], + 'AgentId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent1@ccc-test'], + 'StateTime' => ['description' => '状态开始的时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1696670640774'], + 'AgentName' => ['description' => '坐席姓名。', 'type' => 'string', 'example' => '坐席小王'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'CounterParty' => ['description' => '用于一些特定的三方场景，主要是监听，辅导，咨询，在三方场景时表示第三方，比如在监听或辅导场景，用于表示被监听或被辅导的坐席，在咨询场景下，表示被转接的坐席或外呼号码。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'SkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], ], - 'HandleRate' => [ - 'description' => '应答率。计算公式为：CallsHandled / CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', + 'SkillGroupNameList' => [ + 'description' => '坐席签入的技能组名称列表。', + 'type' => 'array', + 'items' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '测试技能组'], ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AccessChannelTypeDetails' => [ - 'description' => '各渠道的统计数据。', - 'type' => 'array', - 'items' => [ - 'description' => '各渠道的统计数据。', - 'type' => 'object', - 'properties' => [ - 'AccessChannelType' => [ - 'description' => '渠道类型。', - 'type' => 'string', - 'example' => 'Web', - ], - 'CallsOffered' => [ - 'description' => '分配的会话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - ], - ], - ], - 'AverageFirstResponseTime' => [ - 'description' => 'Chat会话平均首次响应时长，单位为秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '8', - ], - 'AverageResponseTime' => [ - 'description' => 'Chat会话平均响应时长。', - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - 'ServiceLevel15' => [ - 'description' => '15秒服务水平。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.6', - ], - 'TotalMessagesSent' => [ - 'description' => 'Chat会话中总消息发送量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'TotalMessagesSentByAgent' => [ - 'description' => 'Chat会话中坐席发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalMessagesSentByCustomer' => [ - 'description' => 'Chat会话中客户发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - ], - ], - 'Outbound' => [ - 'description' => '呼出指标。', - 'type' => 'object', - 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'CallsAttendedTransferOut' => [ - 'description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '148', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsDialed。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'CallsBlindTransferIn' => [ - 'description' => '直接转入量。若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsRinged' => [ - 'description' => '坐席振铃的电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAttendedTransferIn' => [ - 'description' => '咨询转入量。若一通电话多次转入给该坐席，每次转入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsBlindTransferOut' => [ - 'description' => '直接转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsAnswered。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。计算公式为：TotalDialingTime/CallsDialed。', - 'type' => 'number', - 'format' => 'float', - 'example' => '30', - ], - ], - ], - 'Overall' => [ - 'description' => '整体指标。', - 'type' => 'object', - 'properties' => [ - 'OccupancyRate' => [ - 'description' => '座席利用率，计算公式为： (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'TotalHoldTime' => [ - 'description' => '总保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/TotalCalls。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'MaxBreakTime' => [ - 'description' => '最大小休时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '435', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '763', - ], - 'LastCheckoutTime' => [ - 'description' => '入参Interval为Daily才有值，当天的最后下线时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '已弃用，请使用LastCheckOutTime代替此参数。', - ], - 'LastCheckOutTime' => [ - 'description' => '入参Interval为Daily才有值，当天的最后下线时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话量。计算公式为：CallsOffered+CallsDialed。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。_注意：不包含离线和小休时长_。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '914', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageBreakTime' => [ - 'description' => '平均小休时长，单位秒。计算公式为：TotalBreakTime/小休次数。小休次数为非接口统计字段。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/(CallsAnswered+CallsHandled)。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位秒。计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalOnSiteOnlineTime' => [ - 'description' => '总场内在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '已弃用，请使用TotalOnSiteLoggedInTime代替此参数', - ], - 'TotalOffSiteOnlineTime' => [ - 'description' => '总场外在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '已弃用，请使用TotalOffSiteLoggedInTime代替此参数', - ], - 'TotalOfficePhoneOnlineTime' => [ - 'description' => '总办公电话在线时长，单位秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '已弃用，请使用TotalOfficePhoneLoggedInTime代替此参数', - ], - 'BreakCodeDetailList' => [ - 'description' => '小休详情列表。', - 'type' => 'array', - 'items' => [ - 'description' => '小休详情。', - 'type' => 'object', - 'properties' => [ - 'BreakCode' => [ - 'description' => '小休码。', - 'type' => 'string', - 'example' => '会议', - ], - 'Count' => [ - 'description' => '数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Duration' => [ - 'description' => '持续时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - ], - ], - 'TotalOutboundScenarioTime' => [ - 'description' => '总仅外呼时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '已弃用，请使用TotalOutboundScenarioLoggedInTime代替此参数', - ], - 'TotalOutboundScenarioReadyTime' => [ - 'description' => '总仅外呼空闲时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'FirstCheckInTime' => [ - 'description' => '入参Interval为Daily才有值，当天的首次上线时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalOfficePhoneLoggedInTime' => [ - 'description' => '总办公电话在线时长，单位秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalOffSiteLoggedInTime' => [ - 'description' => '总场外在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalOnSiteLoggedInTime' => [ - 'description' => '总场内在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalOutboundScenarioLoggedInTime' => [ - 'description' => '总仅外呼在线时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - ], - 'Back2Back' => [ - 'description' => '双呼指标。', - 'type' => 'object', - 'properties' => [ - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'TotalCustomerRingTime' => [ - 'description' => '总客户侧振岭时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'MaxCustomerRingTime' => [ - 'description' => '最大客户侧振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageCustomerRingTime' => [ - 'description' => '平均客户侧振铃时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsAgentHandled' => [ - 'description' => '坐席接听电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'AgentHandleRate' => [ - 'description' => '坐席应答率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'CallsCustomerAnswered' => [ - 'description' => '客户接听电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'CustomerAnswerRate' => [ - 'description' => '客户接通率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.75', - ], - ], - ], - 'Internal' => [ - 'description' => '内部呼叫指标。', - 'type' => 'object', - 'properties' => [ - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsHandled' => [ - 'description' => '应答量，即坐席应答的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsOffered' => [ - 'description' => '分配量，即分配给此坐席的电话次数, 包括其他坐席盲转和咨询转给此坐席的电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsTalked' => [ - 'description' => '参与通话次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80', + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1382114****'], + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => ['Outbound' => '呼出', 'Back2Back' => '双呼', 'PrivacyDial' => '加密通话', 'Internal' => '内部呼叫', 'Predictive' => '预测式外呼', 'Inbound' => '呼入', 'Conference' => '会议'], + 'example' => 'Outbound', ], + 'Duration' => ['description' => '当前状态的持续时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], ], ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid. %s', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1620291600000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AccessChannelTypeDetails\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 2\\n }\\n ],\\n \\"AverageFirstResponseTime\\": 8,\\n \\"AverageResponseTime\\": 10,\\n \\"ServiceLevel15\\": 0.6,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 10,\\n \\"TotalMessagesSentByCustomer\\": 2\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 5,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 4,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 2,\\n \\"TotalDialingTime\\": 148,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 1,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 60,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 30\\n },\\n \\"Overall\\": {\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 4,\\n \\"MaxWorkTime\\": 2,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 1,\\n \\"MaxBreakTime\\": 1,\\n \\"SatisfactionIndex\\": 0,\\n \\"MaxReadyTime\\": 435,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalReadyTime\\": 763,\\n \\"LastCheckoutTime\\": 0,\\n \\"LastCheckOutTime\\": 0,\\n \\"TotalCalls\\": 5,\\n \\"TotalLoggedInTime\\": 914,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"TotalBreakTime\\": 1,\\n \\"TotalOnSiteOnlineTime\\": 0,\\n \\"TotalOffSiteOnlineTime\\": 0,\\n \\"TotalOfficePhoneOnlineTime\\": 0,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 10,\\n \\"Duration\\": 100\\n }\\n ],\\n \\"TotalOutboundScenarioTime\\": 0,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"FirstCheckInTime\\": 0,\\n \\"TotalOfficePhoneLoggedInTime\\": 100,\\n \\"TotalOffSiteLoggedInTime\\": 100,\\n \\"TotalOnSiteLoggedInTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 100\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"CallsAnswered\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"CallsAgentHandled\\": 12,\\n \\"AgentHandleRate\\": 1,\\n \\"CallsCustomerAnswered\\": 9,\\n \\"CustomerAnswerRate\\": 0.75\\n },\\n \\"Internal\\": {\\n \\"AverageTalkTime\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsTalked\\": 80\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"943D8EF3-3321-471F-A104-51C96FCA94D6\\n无\\n200\\n\\n 1620291600000\\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 148\\n 4\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 30\\n 0\\n 0\\n 5\\n 60\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 1\\n 2\\n 0\\n \\n \\n 763\\n 5\\n 1\\n 0\\n 4\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 914\\n 0\\n 0\\n 435\\n 1\\n 2\\n 1\\n 0\\n 0\\n 0\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取坐席分段统计报表', - 'summary' => '调用ListIntervalAgentReport获取指定实例下指定坐席的分段统计报表。', + 'title' => '获取实时坐席状态报表', + 'summary' => '调用ListRealtimeAgentStates获取指定实例下一个或多个指定坐席的实时状态数据报表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListIntervalInstanceReport' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-02-13T02:21:10.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-06-21T06:52:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-07-12T04:33:02.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-06-24T03:34:23.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2021-12-21T12:54:51.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRealtimeAgentStates'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Extension\\": \\"80317391\\",\\n \\"StateCode\\": \\"Monitored\\",\\n \\"State\\": \\"ACW\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"AgentId\\": \\"agent1@ccc-test\\",\\n \\"StateTime\\": 1696670640774,\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"CounterParty\\": \\"agent@ccc-test\\",\\n \\"SkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ],\\n \\"SkillGroupNameList\\": [\\n \\"测试技能组\\"\\n ],\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1382114****\\",\\n \\"CallType\\": \\"Outbound\\",\\n \\"Duration\\": 16\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n 80317391\\n user-admin@ccc-test\\n 8\\n ccc-test\\n ACW\\n Monitored\\n 云呼测试坐席\\n user-test@ccc-test\\n \\n \\n [\\"skg-default@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', + ], + 'ListRealtimeSkillGroupStates' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -33734,762 +19087,95 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccOQKOLI'], + ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'SkillGroupIdList', + 'in' => 'formData', + 'schema' => ['description' => '待查询数据的技能组ID列表。如果不传，查询当前实例下的所有技能组，格式为JSON数组的字符串，数组元素为技能组ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test"]'], + ], + [ + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'StartTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间，格式为Unix时间戳，单位毫秒，非必填，默认为当天的0时，统计的时间精度为小时，向前取整，闭区间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1620230400000', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ - 'name' => 'EndTime', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '截止时间，格式为Unix时间戳，单位毫秒，非必填，默认是当前时间，如果Interval为Daily，StartTime和EndTime最大间隔是180天。如果Interval为Hourly，最大间隔时间为10天。统计的时间精度为小时，向后取整，开区间。例如：开始时间为11:12:20，结束时间为11:45:50，则对齐后的入参时间范围为[11:00:00,12:00:00) ，即大于等于11点，小于12点。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1620316799000', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Interval', + 'name' => 'MediaType', 'in' => 'query', - 'schema' => [ - 'description' => '分段统计类型，非必填，默认为Daily（按天汇总）。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Hourly' => '按小时统计', - 'Daily' => '按天统计', - ], - 'example' => 'Hourly', - ], - ], - ], - 'responses' => [ - 200 => [ + 'schema' => ['description' => '媒体类型。'."\n" + ."\n" + .'枚举值：'."\n" + ."\n" + .'AUDIO：语音。'."\n" + ."\n" + .'VIDEO：视频。'."\n" + ."\n" + .'CHAT: 消息。'."\n" + ."\n" + .'ALL: 所有。', 'type' => 'string', 'required' => false, 'example' => 'AUDIO'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94'], 'Data' => [ - 'description' => '实例分段统计数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '实例分段统计数据。', - 'type' => 'object', - 'properties' => [ - 'StatsTime' => [ - 'description' => '开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1620230400000', - ], - 'Inbound' => [ - 'description' => '呼入指标。', - 'type' => 'object', - 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', - 'type' => 'number', - 'format' => 'float', - 'example' => '5', - ], - 'CallsVoicemail' => [ - 'description' => '通话进入语音留言信箱的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxAbandonedInIVRTime' => [ - 'description' => '最大IVR放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '应答量，即坐席应答的电话数量。若一通电话被多个坐席应答，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'CallsIVRException' => [ - 'description' => '发生IVR异常的通话数量，判定条件是IVR进入了挂机原因节点且挂机原因节点设置的挂机原因为转人工失败，此时计数加1。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInIVR' => [ - 'description' => 'IVR放弃量，即电话进入IVR流程之后在IVR环节客户挂机的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '17', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxAbandonTime' => [ - 'description' => '最大放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageAbandonTime' => [ - 'description' => '平均放弃时长，单位秒。计算公式为：TotalAbandonTime/CallsAbandoned。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AbandonedRate' => [ - 'description' => '已废弃，该字段可以参考AbandonRate', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsRinged' => [ - 'description' => '座席振铃的电话数量，若一通电话分配给多个座席并产生了振铃，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'CallsQueuingFailed' => [ - 'description' => '队列失败量，即电话进入队列之后在排队环节客户挂机的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '447', - ], - 'MaxAbandonedInRingTime' => [ - 'description' => '最大振铃放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsBlindTransferred' => [ - 'description' => '直接转接量，即发生直接转接的电话数量。若一通电话发起多次转接，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageAbandonedInIVRTime' => [ - 'description' => '平均IVR放弃时长，单位秒。计算公式为：TotalAbandonedInIVRTime/CallsAbandonedInIVR。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageAbandonedInQueueTime' => [ - 'description' => '平均排队放弃时长，单位秒。计算公式为：TotalAbandonedInQueueTime/CallsAbandonedInQueue。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxWaitTime' => [ - 'description' => '最大等待时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '64', - ], - 'CallsAttendedTransferred' => [ - 'description' => '咨询转接量，即发生咨询转接的电话数量。若一通电话发起多次转接，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalAbandonedInIVRTime' => [ - 'description' => '总IVR放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsQueuingOverflow' => [ - 'description' => '队列溢出的通话数量，即通话在IVR排队时队列溢出。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInRing' => [ - 'description' => '振铃放弃量，即坐席振铃中客户挂机的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalAbandonedInRingTime' => [ - 'description' => '总振铃放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '85', - ], - 'AverageWaitTime' => [ - 'description' => '平均等待时长，平均每通电话的坐席接起前等待时长。计算公式为： TotalWaitTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '5', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为： TotalWorkTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '13', - ], - 'CallsQueued' => [ - 'description' => '进入队列的电话数量，若一通电话多次进入队列，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'AverageAbandonedInRingTime' => [ - 'description' => '平均振铃放弃时长，单位秒。计算公式为：TotalAbandonedInRingTime/CallsAbandonedInRing。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsAbandoned' => [ - 'description' => '放弃量。计算公式为：CallsAbandonedInIVR+CallsAbandonedInQueue+CallsAbandonedInRing。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxAbandonedInQueueTime' => [ - 'description' => '最大排队放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInVoiceNavigator' => [ - 'description' => '通话在智能导航模块放弃的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWaitTime' => [ - 'description' => '总等待时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '219', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'TotalAbandonTime' => [ - 'description' => '总放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '呼入到云联络中心的电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'CallsQueuingTimeout' => [ - 'description' => '在排队阶段超时的通话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '20秒服务水平，等待时长小于等于20秒的电话数量/CallsQueued。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsForwardToOutsideNumber' => [ - 'description' => '发生转外线的通话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的电话数量。若一通电话保持多次，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsAbandonedInQueue' => [ - 'description' => '队列放弃量，即电话进入队列之后在排队环节客户挂机的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalAbandonedInQueueTime' => [ - 'description' => '总排队放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AbandonRate' => [ - 'description' => '放弃率。计算公式为：CallsAbandoned/CallsOffered（由于放弃事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsCausedIVRException' => [ - 'description' => '导致IVR异常的电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsToVoicemail' => [ - 'description' => '转入语音信箱的电话数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AverageFirstResponseTime' => [ - 'description' => 'Chat会话平均首次响应时长，单位为秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '6', - ], - 'AverageResponseTime' => [ - 'description' => 'Chat会话平均响应时长。', - 'type' => 'number', - 'format' => 'float', - 'example' => '15', - ], - 'TotalMessagesSent' => [ - 'description' => 'Chat会话中总消息发送量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'TotalMessagesSentByAgent' => [ - 'description' => 'Chat会话中坐席发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'TotalMessagesSentByCustomer' => [ - 'description' => 'Chat会话中客户发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - ], - ], - 'Outbound' => [ - 'description' => '呼出指标。', - 'type' => 'object', - 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsDialed。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsRinged' => [ - 'description' => '坐席振铃的电话数量，若一通电话分配给多个座席并产生了振铃，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsBlindTransferred' => [ - 'description' => '直接转接量，即发生直接转接的电话数量。若一通电话发起多次转接，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsAnswered。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsAttendedTransferred' => [ - 'description' => '咨询转接量，即发生咨询转接的电话数量。若一通电话发起多次转接，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的电话数量。若一通电话保持多次，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。计算公式为：TotalDialingTime/CallsDialed。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - ], - ], - 'Overall' => [ - 'description' => '整体指标。', + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'List' => [ + 'description' => '实时技能组状态数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实时技能组状态数据。', 'type' => 'object', 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。不包含小休时长。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，计算公式为： (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageBreakTime' => [ - 'description' => '平均小休时长，单位秒。计算公式为：TotalBreakTime/小休次数。小休次数为非接口统计字段。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxBreakTime' => [ - 'description' => '最大小休时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/TotalCalls。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/(CallsAnswered+CallsHandled)。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位秒。计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话量。计算公式为：CallsOffered + CallsDialed。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + 'WorkingAgents' => ['description' => '当前话后处理中的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'LongestWaitingTime' => ['description' => '当前最大排队等待时长，单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'LoggedInAgents' => ['description' => '当前在线坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'WaitingCalls' => ['description' => '当前排队电话个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'BreakingAgents' => ['description' => '当前小休坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TalkingAgents' => ['description' => '当前正在通话坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'ReadyAgents' => ['description' => '当前空闲坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenarioReadyAgents' => ['description' => '处于仅外呼模式且在空闲状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalAgents' => ['description' => '总坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], + 'BreakCodeDetailList' => [ + 'description' => '小休统计数据', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BreakCode' => ['description' => '小休状态代码', 'type' => 'string', 'example' => '客户自定义参数，比如午餐、会议等'], + 'Count' => ['description' => '指定小休状态发生的次数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'description' => '', + ], ], ], ], @@ -34497,33 +19183,36 @@ ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1620230400000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 5,\\n \\"CallsVoicemail\\": 0,\\n \\"MaxAbandonedInIVRTime\\": 0,\\n \\"CallsHandled\\": 7,\\n \\"CallsIVRException\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"MaxWorkTime\\": 17,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"AbandonedRate\\": 0,\\n \\"CallsRinged\\": 7,\\n \\"CallsQueuingFailed\\": 0,\\n \\"TotalRingTime\\": 32,\\n \\"TotalTalkTime\\": 447,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AverageAbandonedInIVRTime\\": 0,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"MaxWaitTime\\": 13,\\n \\"AverageTalkTime\\": 64,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"TotalAbandonedInIVRTime\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"TotalWorkTime\\": 85,\\n \\"AverageWaitTime\\": 5,\\n \\"AverageWorkTime\\": 13,\\n \\"CallsQueued\\": 7,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInVoiceNavigator\\": 0,\\n \\"TotalWaitTime\\": 34,\\n \\"MaxTalkTime\\": 219,\\n \\"MaxRingTime\\": 12,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 7,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"ServiceLevel20\\": 1,\\n \\"MaxHoldTime\\": 0,\\n \\"CallsForwardToOutsideNumber\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 1,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"AbandonRate\\": 0,\\n \\"CallsCausedIVRException\\": 0,\\n \\"CallsToVoicemail\\": 1,\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 15,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 8,\\n \\"TotalMessagesSentByCustomer\\": 4\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"943D8EF3-3321-471F-A104-51C96FCA94D6\\n无\\n200\\n\\n 1620291600000\\n \\n 1\\n 0\\n 85\\n 0\\n 7\\n 0\\n 0\\n 12\\n 7\\n 0\\n 0\\n 0\\n 0\\n 32\\n 1\\n 0\\n 0\\n 447\\n 5\\n 0\\n 7\\n 219\\n 0\\n 0\\n 0\\n 0\\n 64\\n 0\\n 0\\n 0\\n 0\\n 0\\n 7\\n 13\\n 0\\n 0\\n 0\\n 5\\n 34\\n 0\\n 0\\n 0\\n 13\\n 0\\n 17\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取实例分段统计报表', - 'summary' => '调用ListIntervalInstanceReport获取指定实例的分段统计报表。', + 'title' => '获取实时技能组状态报表', + 'summary' => '调用ListRealtimeSkillGroupStates获取指定实例下实时技能组状态报表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListIntervalSkillGroupReport' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-21T06:52:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-11-22T01:05:25.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRealtimeSkillGroupStates'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"WorkingAgents\\": 0,\\n \\"LongestWaitingTime\\": 0,\\n \\"LoggedInAgents\\": 2,\\n \\"WaitingCalls\\": 0,\\n \\"BreakingAgents\\": 0,\\n \\"TalkingAgents\\": 0,\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"ReadyAgents\\": 2,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenarioReadyAgents\\": 0,\\n \\"TotalAgents\\": 12,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"客户自定义参数，比如午餐、会议等\\",\\n \\"Count\\": 1\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\n无\\n200\\n\\n 2\\n 10\\n 1\\n \\n 0\\n 0\\n test1\\n ccc-test\\n 2\\n 2\\n 0\\n skg-test1@ccc-test\\n 0\\n 0\\n \\n\\nOK","errorExample":""}]', + ], + 'ListRecentCallDetailRecords' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -34534,79 +19223,146 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], + ], 'parameters' => [ [ - 'name' => 'SkillGroupId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'skg-default@ccc-test', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'InstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '开始时间，格式为Unix时间戳，单位毫秒，非必填，默认为当天的0时，统计的时间精度为小时，向前取整，闭区间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1604639129000', - ], + 'in' => 'formData', + 'schema' => ['description' => '开始时间戳，默认是当天开始时间，最早为当前时间往前180天。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604638129000'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '截止时间，格式为Unix时间戳，单位毫秒，非必填，默认是当前时间，如果Interval为Daily，StartTime和EndTime最大间隔是180天。如果Interval为Hourly，最大间隔时间为10天。统计的时间精度为小时，向后取整，开区间。例如：开始时间为11:12:20，结束时间为11:45:50，则对齐后的入参时间范围为[11:00:00,12:00:00) ，即大于等于11点，小于12点。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1604725528000', - ], + 'schema' => ['description' => '截止时间戳，默认是当前时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604639129000'], ], [ - 'name' => 'Interval', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'Criteria', 'in' => 'query', + 'schema' => ['description' => '模糊搜索条件，格式为JSON对象，对象包含三个属性，可以随机组合，三个属性分别为phoneNumber（按主叫或被叫号码模糊搜索）、callingNumber（按主叫号码模糊搜索）和calledNumber（按被叫号码模糊搜索）。', 'type' => 'string', 'required' => false, 'example' => '{"phoneNumber":"1312121****","callingNumber":"1312121****","calledNumber":"1312121****"}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '分段统计类型，默认为Daily（按天汇总）。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Hourly' => '按小时统计', - 'Daily' => '按天统计', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数，只有PageNumber为1才会返回真实大小，其他都是0。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'], + 'List' => [ + 'description' => '通话记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通话记录。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => '通话开始时间，内呼从进入IVR开始，外呼从开始接通计算，格式为Unix字符串，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000'], + 'ContactDisposition' => [ + 'description' => '电话结束原因。', + 'type' => 'string', + 'enumValueTitles' => [ + 'AbandonedInQueue' => '排队放弃', 'NoAnswer' => '客户未接', 'QueuingTimeout' => '排队超时', 'Voicemail' => '转语音邮箱', 'QueuingFailed' => '转人工失败', 'QueuingOverflow' => '排队溢出', 'AbandonedInVoiceNavigator' => '智能导航中放弃', 'Success' => '正常结束', 'IVRException' => 'IVR异常', 'AbandonedInRing' => '振铃放弃', + 'AbandonedInIVR' => 'IVR放弃', 'Reject' => '客户拒接', 'ForwardToOutsideNumber' => '转外线', + ], + 'example' => 'Success', + ], + 'ContactType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => ['Outbound' => '呼出', 'Back2Back' => '双呼', 'PrivacyDial' => '加密通话', 'Internal' => '内部呼叫', 'Predictive' => '预测式外呼', 'Inbound' => '呼入', 'Conference' => '会议'], + 'example' => 'Outbound', + ], + 'AgentIds' => ['description' => '坐席ID列表，多个值用逗号分隔。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-7660472242845****'], + 'CallDuration' => ['description' => '通话时长，单位秒。', 'type' => 'string', 'example' => '16'], + 'CallingNumber' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '0533128****'], + 'Duration' => ['description' => '通话持续时间，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'CalledNumber' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1332315****'], + 'SkillGroupIds' => ['description' => '参与通话的座席所属的技能组，多个技能组以逗号分隔。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + ], + ], + ], + ], + ], ], - 'example' => 'Hourly', + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], + ], + 'title' => '获取坐席最近通话记录列表', + 'summary' => '调用ListRecentCallDetailRecords获取指定实例下当前RAM账号映射的坐席的最近通话记录列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRecentCallDetailRecords'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"StartTime\\": 1532448000000,\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"Outbound\\",\\n \\"AgentIds\\": \\"agent@ccc-test\\",\\n \\"ContactId\\": \\"job-7660472242845****\\",\\n \\"CallDuration\\": \\"16\\",\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"Duration\\": 16,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"SkillGroupIds\\": \\"skillgroup@ccc-test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 11\\n 10\\n 1\\n \\n skg-default@ccc-test\\n 133xxxx2315\\n Outbound\\n ccc-test\\n Success\\n 1532448000000\\n user-test@ccc-test\\n 16\\n job-76604722428454704\\n 16\\n 053xxxx3128\\n \\n\\nOK","errorExample":""}]', + ], + 'ListRoles' => [ + 'summary' => '调用ListRoles获取指定实例下的所有角色。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], [ - 'name' => 'MediaType', + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', - 'type' => 'string', - 'required' => false, - 'example' => 'VIDEO', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], ], 'responses' => [ @@ -34614,9087 +19370,369 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '711D948F-C616-4E23-8573-0F260513CE09'], 'Data' => [ - 'description' => '技能组分段统计数据列表。', + 'description' => '角色列表。'."\n" + ."\n", 'type' => 'array', 'items' => [ - 'description' => '技能组分段统计数据。', 'type' => 'object', 'properties' => [ - 'StatsTime' => [ - 'description' => '时间段的开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1604639129000', + 'Name' => [ + 'description' => '角色名称。', + 'type' => 'string', + 'enumValueTitles' => ['Agent' => '坐席', 'Admin' => '管理员', 'Manager' => '技能组组长'], + 'example' => 'Admin', ], - 'Inbound' => [ - 'description' => '呼入指标。', + 'RoleId' => ['description' => '角色ID，格式为：角色@实例ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => '该参数无效。'], + ], + ], + 'title' => '获取角色列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoles'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"711D948F-C616-4E23-8573-0F260513CE09\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"Admin\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListSkillGroupStates' => [ + 'summary' => '调用ListSkillgroupStates获取指定实例下指定技能组的状态列表，该接口仅对特定用户开放，其他客户不建议调用。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccOQKOLI'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'SkillGroupIds', + 'in' => 'query', + 'schema' => ['description' => '技能组ID列表。'."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1F69EBB0-63E9-5DDE-887F-9FC040ADF309'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'TotalCount' => ['description' => '总数。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'List' => [ + 'description' => '技能组状态数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '技能组状态数据。', 'type' => 'object', 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', - 'type' => 'number', - 'format' => 'float', - 'example' => '11', - ], - 'CallsOverflow' => [ - 'description' => '溢出量，即发生队列（技能组）溢出的电话数量。若一通电话多次进入同一队列，每次溢出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + 'WorkingAgents' => ['description' => '话后处理坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'LoggedInAgents' => ['description' => '在线坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'BreakingAgents' => ['description' => '处于小休状态的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'LongestCall' => ['description' => '最大等待时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'WaitingCalls' => ['description' => '当前排队电话个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TalkingAgents' => ['description' => '正在通话坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '测试技能组'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + 'ReadyAgents' => ['description' => '空闲坐席数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'AverageWaitingTime' => ['description' => '平均等待时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'WaitingCallsLevel10' => ['description' => '等待时长小于10秒的通话的个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'WaitingCallsLevel20' => ['description' => '等待时长小于20秒的通话的个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'WaitingCallsLevel30' => ['description' => '等待时长小于30秒的通话的个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OutboundScenarioReadyAgents' => ['description' => '处于仅外呼状态并且空闲的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'InboundTalkingAgents' => ['description' => '呼入场景下通话的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OutboundTalkingAgents' => ['description' => '外呼场景下通话的坐席数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['CCC::2020-07-01::ListRealtimeSkillGroupStates'], + ], + 'title' => '获取技能组状态列表', + 'changeSet' => [ + ['createdAt' => '2022-11-25T02:02:44.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-07-04T11:51:59.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-15T03:10:11.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-06T09:08:50.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-02-28T02:23:24.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroupStates'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"1F69EBB0-63E9-5DDE-887F-9FC040ADF309\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"WorkingAgents\\": 0,\\n \\"LoggedInAgents\\": 0,\\n \\"BreakingAgents\\": 0,\\n \\"LongestCall\\": 0,\\n \\"WaitingCalls\\": 0,\\n \\"TalkingAgents\\": 0,\\n \\"SkillGroupName\\": \\"测试技能组\\",\\n \\"SkillGroupId\\": \\"skillgroup1@ccc-test\\",\\n \\"ReadyAgents\\": 1,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"AverageWaitingTime\\": 3,\\n \\"WaitingCallsLevel10\\": 0,\\n \\"WaitingCallsLevel20\\": 0,\\n \\"WaitingCallsLevel30\\": 0,\\n \\"OutboundScenarioReadyAgents\\": 0,\\n \\"InboundTalkingAgents\\": 0,\\n \\"OutboundTalkingAgents\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListSkillGroupSummaryReportsSinceMidnight' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccOQKOLI'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'SkillGroups', + 'in' => 'query', + 'schema' => ['description' => '待查询的技能组ID列表，格式为JSON数组的字符串，数组元素为技能组ID，非必填，默认为空，表示查询当前分页下的所有技能组。', 'type' => 'string', 'required' => false, 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test2"]'."\n"], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2B36CEBC-6D11-5451-9E6B-C6D1927841C5'], + 'Success' => ['description' => '是否调用成功。', 'type' => 'boolean', 'example' => 'true'], + 'PagedSkillGroupSummaryReport' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'List' => [ + 'description' => '技能组概览数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '技能组概览数据。', + 'type' => 'object', + 'properties' => [ + 'Timestamp' => ['description' => '统计打点时刻。', 'type' => 'string', 'example' => '2018-09-13 00:00:00'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => '测试技能组'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Overall' => [ + 'description' => '整体指标。', + 'type' => 'object', + 'properties' => [ + 'TotalLoggedInTime' => ['description' => '总登录时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OccupancyRate' => ['description' => '座席利用率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxReadyTime' => ['description' => '最大空闲时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageReadyTime' => ['description' => '平均空闲时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalBreakTime' => ['description' => '总小休时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalReadyTime' => ['description' => '总空闲时长，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalCalls' => ['description' => '总电话量。计算公式为：CallsOffered + CallsDialed。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], ], - 'CallsAbandonedInRing' => [ - 'description' => '振铃放弃量，即坐席振铃中客户挂机的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '应答量，即坐席应答的次数。一通电话每次进入队列后，若被多个坐席应答，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23', - ], - 'TotalAbandonedInRingTime' => [ - 'description' => '总振铃放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19', - ], - 'CallsAttendedTransferOut' => [ - 'description' => '咨询转出量，即由该技能组发起的咨询转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWaitTime' => [ - 'description' => '平均等待时长，平均每通电话的坐席接起前等待时长。计算公式为：TotalWaitTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '11', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxAbandonTime' => [ - 'description' => '最大放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为： TotalWorkTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '8', - ], - 'CallsQueued' => [ - 'description' => '呼入场景进入队列（技能组）的电话数量，若一通电话多次进入同一队列，每次进入算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'CallsBlindTransferIn' => [ - 'description' => '直接转入量，即由其他技能组发起的直接转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时签入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageAbandonedInRingTime' => [ - 'description' => '平均振铃放弃时长，单位秒。计算公式为： TotalAbandonedInRingTime/CallsAbandonedInRing。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageAbandonTime' => [ - 'description' => '平均放弃时长，单位秒。计算公式为：TotalAbandonTime/CallsAbandoned。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsRinged' => [ - 'description' => '坐席振铃的电话数量，一通电话每次进入队列后，若分配给多个座席并产生了振铃，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'CallsBlindTransferOut' => [ - 'description' => '直接转出量，即由该技能组发起的直接转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAttendedTransferIn' => [ - 'description' => '咨询转入量，即由其他技能组发起的咨询转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时迁入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandoned' => [ - 'description' => '放弃量。计算公式为：CallsAbandonedInQueue+CallsAbandonedInRing。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxAbandonedInQueueTime' => [ - 'description' => '最大排队放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWaitTime' => [ - 'description' => '总等待时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18', - ], - 'AbandonRate' => [ - 'description' => '放弃率。计算公式为：CallsAbandoned/CallsOffered（由于放弃事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'TotalAbandonTime' => [ - 'description' => '总放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '分配量，即分配给该技能组的电话数量，包括通过队列分配的电话数量和通过转接（咨询转接和直接转接）分配的电话数量。计算公式为：CallsQueued+CallsBlindTransferIn+CallsAttentandedTransferIn。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'MaxAbandonedInRingTime' => [ - 'description' => '最大振铃放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWaitTime' => [ - 'description' => '最大等待时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18', - ], - 'AverageAbandonedInQueueTime' => [ - 'description' => '平均排队放弃时长，单位秒。计算公式为： TotalAbandonedInQueueTime/CallsAbandonedInQueue。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '20秒服务水平，等待时长小于等于20秒的电话数量/CallsQueued。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/CallsHandled。', - 'type' => 'number', - 'format' => 'float', - 'example' => '5', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的次数。一通电话每次进入队列后，若发生多次通话保持，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.6666666666666666', - ], - 'CallsTimeout' => [ - 'description' => '超时量，即发生队列（技能组）超时的电话数量。若一通电话多次进入同一队列，每次超时算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalAbandonedInQueueTime' => [ - 'description' => '总排队放弃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAbandonedInQueue' => [ - 'description' => '队列放弃量，即电话进入队列之后在排队环节客户挂机的数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsQueuingOverflow' => [ - 'description' => '队列溢出的通话数量，即通话在IVR排队时队列溢出。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsQueuingTimeout' => [ - 'description' => '在排队阶段超时的通话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalMessagesSent' => [ - 'description' => 'Chat会话中总消息发送量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'TotalMessagesSentByAgent' => [ - 'description' => 'Chat会话中坐席发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'TotalMessagesSentByCustomer' => [ - 'description' => 'Chat会话中客户发送的总消息量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'AverageFirstResponseTime' => [ - 'description' => 'Chat会话平均首次响应时长，单位为秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '6', - ], - 'AverageResponseTime' => [ - 'description' => 'Chat会话平均响应时长。', - 'type' => 'number', - 'format' => 'float', - 'example' => '18', - ], - ], - ], - 'Outbound' => [ - 'description' => '呼出指标。', - 'type' => 'object', - 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。计算公式为： TotalRingTime/CallsRinged。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'CallsAttendedTransferOut' => [ - 'description' => '咨询转出量，即由该技能组发起的咨询转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'TotalHoldTime' => [ - 'description' => '总通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/CallsDialed。', - 'type' => 'number', - 'format' => 'float', - 'example' => '3', - ], - 'CallsBlindTransferIn' => [ - 'description' => '直接转入量，即由其他技能组发起的直接转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时签入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsRinged' => [ - 'description' => '坐席振铃的电话数量，一通电话每次进入队列后，若分配给多个座席并产生了振铃，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAttendedTransferIn' => [ - 'description' => '咨询转入量，即由其他技能组发起的咨询转接到该技能组的电话数量，同一技能组内坐席间的转接不计数。若一个坐席同时迁入多个技能组，则该电话的统计归属于签入的第一个技能组。若一通电话由其他技能组多次转接到该技能组，每次转接算一次。下同。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsBlindTransferOut' => [ - 'description' => '直接转出量，即由该技能组发起的直接转接到其他技能组的电话数量，同一技能组内坐席间的转接不计数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '49', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为：TotalTalkTime/CallsAnswered。', - 'type' => 'number', - 'format' => 'float', - 'example' => '5', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'CallsHold' => [ - 'description' => '保持量，即发生通话保持的电话数量。一通电话在转出当前技能组之前，若发生多次通话保持，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/CallsHold。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。计算公式为：TotalDialingTime/CallsDialed。', - 'type' => 'number', - 'format' => 'float', - 'example' => '30', - ], - ], - ], - 'Overall' => [ - 'description' => '整体指标。', - 'type' => 'object', - 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13', - ], - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9236', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，计算公式为： (TotalworkTime + TotalTalkTime ) / TotalLoggedInTime。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.00422315148470254', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '27', - ], - 'MaxHoldTime' => [ - 'description' => '最大通话保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19', - ], - 'AverageBreakTime' => [ - 'description' => '平均小休时长，单位秒。计算公式为：TotalBreakTime/小休次数。小休次数为非接口统计字段。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalHoldTime' => [ - 'description' => '总保持时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionRate' => [ - 'description' => '满意率，计算公式为：标记为满意的评价数/满意度调查响应次数。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'MaxBreakTime' => [ - 'description' => '最大小休时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为：TotalWorkTime/TotalCalls。', - 'type' => 'number', - 'format' => 'float', - 'example' => '6', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。计算公式为： TotalTalkTime/(CallsAnswered+CallsHandled)。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4927', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，单位秒。计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageHoldTime' => [ - 'description' => '平均通话保持时长，单位秒。计算公式为：TotalHoldTime/(呼入CallsHold+呼出CallsHold)。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9106', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'TotalCalls' => [ - 'description' => '总电话量。计算公式为：CallsOffered + CallsDialed。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'BreakCodeDetailList' => [ - 'description' => '各类型小休统计数据。', - 'type' => 'array', - 'items' => [ - 'description' => '小休统计数据。', - 'type' => 'object', - 'properties' => [ - 'BreakCode' => [ - 'description' => '小休类型代码。', - 'type' => 'string', - 'example' => '会议', - ], - 'Count' => [ - 'description' => '此类型小休的发生次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Duration' => [ - 'description' => '此类型小休的总计发生时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - ], + 'Inbound' => [ + 'description' => '呼入指标。', + 'type' => 'object', + 'properties' => [ + 'AverageRingTime' => ['description' => '平均振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsHandled' => ['description' => '应答量，即坐席应答的次数。一通电话每次进入队列后，若被多个坐席应答，算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'QueueMaxWaitTimeDuration' => ['description' => '队列最大等待时间，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。计算公式为： TotalWorkTime/CallsHandled。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AnsweredByAgentOfQueueWaitTimeDuration' => ['description' => '坐席接起时队列等待时间，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalRingTime' => ['description' => '总振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'InComingQueueOfQueueCount' => ['description' => '技能组呼入次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'string', 'example' => '0'], + 'MaxRingTime' => ['description' => '最大振铃时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsOffered' => ['description' => '分配量，即分配给该技能组的电话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AbandonedInQueueOfQueueCount' => ['description' => '技能组排队放弃次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'OverFlowInQueueOfQueueCount' => ['description' => '技能组排队超时次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnsweredByAgentOfQueueMaxWaitTimeDuration' => ['description' => '坐席接起时队列最大等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ServiceLevel20' => ['description' => '20秒应答率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnsweredByAgentOfQueueCount' => ['description' => '技能组转人工接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'HandleRate' => ['description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'GiveUpByAgentOfQueueCount' => ['description' => '技能组振铃放弃次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'QueueWaitTimeDuration' => ['description' => '队列等待时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsServiceLevel20' => ['description' => '等待20s内坐席接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsServiceLevel30' => ['description' => '等待30s内坐席接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsServiceLevel10' => ['description' => '等待10s内坐席接起次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAttendedTransferOut' => ['description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsBlindTransferOut' => ['description' => '直接转出量。若一通电话多次转出给其他坐席，每次转出算一次。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsQueuingTimeout' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'CallsTimeout' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'CallsQueuingCanceled' => ['type' => 'string', 'description' => ''], + 'CallsQueuingFailure' => ['type' => 'string', 'description' => ''], + 'CallsQueuingRerouted' => ['type' => 'string', 'description' => ''], + 'CallsAbandoned' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'CallsOverflow' => ['type' => 'string', 'description' => ''], ], ], - ], - ], - 'Back2Back' => [ - 'description' => '双呼指标。', - 'type' => 'object', - 'properties' => [ - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageCustomerRingTime' => [ - 'description' => '平均客户侧振铃时长，单位秒', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'CallsCustomerAnswered' => [ - 'description' => '客户接听电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'CustomerAnswerRate' => [ - 'description' => '客户接通率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.6', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CallsAnswered' => [ - 'description' => '接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'number', - 'format' => 'float', - 'example' => '100', - ], - 'MaxCustomerRingTime' => [ - 'description' => '最大客户侧振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalCustomerRingTime' => [ - 'description' => '总客户侧振岭时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'AgentHandleRate' => [ - 'description' => '坐席应答率。', - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'string', - 'example' => '100', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'string', - 'example' => '0.5', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'string', - 'example' => '100', - ], - 'CallsAgentHandled' => [ - 'description' => '坐席接听电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 11,\\n \\"CallsOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"CallsHandled\\": 2,\\n \\"TotalWorkTime\\": 23,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"MaxWorkTime\\": 19,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"AverageWaitTime\\": 11,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageWorkTime\\": 8,\\n \\"CallsQueued\\": 3,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"CallsRinged\\": 3,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"TotalWaitTime\\": 33,\\n \\"TotalRingTime\\": 33,\\n \\"MaxTalkTime\\": 6,\\n \\"MaxRingTime\\": 18,\\n \\"AbandonRate\\": 0,\\n \\"TotalTalkTime\\": 9,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 3,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"MaxWaitTime\\": 18,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"AverageTalkTime\\": 5,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0.6666666666666666,\\n \\"CallsTimeout\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 7,\\n \\"TotalMessagesSentByCustomer\\": 5,\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 18\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 2,\\n \\"CallsAnswered\\": 1,\\n \\"TotalWorkTime\\": 5,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 4,\\n \\"TotalDialingTime\\": 60,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 3,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 5,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 5,\\n \\"MaxDialingTime\\": 49,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 5,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 30\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 13,\\n \\"TotalLoggedInTime\\": 9236,\\n \\"OccupancyRate\\": 0.00422315148470254,\\n \\"TotalWorkTime\\": 27,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 19,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 1,\\n \\"AverageWorkTime\\": 6,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 4927,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 9106,\\n \\"TotalBreakTime\\": 5,\\n \\"MaxTalkTime\\": 6,\\n \\"TotalCalls\\": 5,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 1,\\n \\"Duration\\": 120\\n }\\n ]\\n },\\n \\"Back2Back\\": {\\n \\"MaxRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"CallsCustomerAnswered\\": 12,\\n \\"CustomerAnswerRate\\": 0.6,\\n \\"TotalRingTime\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 1,\\n \\"MaxTalkTime\\": \\"100\\",\\n \\"AnswerRate\\": \\"0.5\\",\\n \\"AverageTalkTime\\": \\"100\\",\\n \\"CallsAgentHandled\\": 5\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"943D8EF3-3321-471F-A104-51C96FCA94D6\\n无\\n200\\n\\n 1604639129000\\n \\n 0\\n 0\\n 23\\n 0\\n 3\\n 0\\n 18\\n 3\\n 0\\n 0\\n 0\\n 0\\n 33\\n 0.6666666666666666\\n 0\\n 9\\n 11\\n 0\\n 3\\n 6\\n 0\\n 0\\n 0\\n 0\\n 5\\n 0\\n 0\\n 0\\n 0\\n 0\\n 2\\n 18\\n 0\\n 0\\n 0\\n 11\\n 33\\n 0\\n 0\\n 0\\n 0\\n 8\\n 19\\n 0\\n 0\\n \\n \\n 60\\n 5\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 30\\n 1\\n 5\\n 2\\n 49\\n 5\\n 0\\n 3\\n 4\\n 0\\n 5\\n 0\\n \\n \\n 9106\\n 5\\n 5\\n 27\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 13\\n 0\\n 9236\\n 6\\n 0\\n 4927\\n 6\\n 19\\n 1\\n 0.00422315148470254\\n 0\\n 0\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取技能组分段统计报表', - 'summary' => '调用ListIntervalSkillGroupReport获取指定实例下指定技能组的分段统计报表。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListIvrTrackingDetails' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - ], - ], - [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-10963442671187****', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D2RB671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'List' => [ - 'description' => 'IVR轨迹详情列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'IVR轨迹详情。', - 'type' => 'object', - 'properties' => [ - 'Instance' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Callee' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'example' => '0533128****', - ], - 'EnterTime' => [ - 'description' => '进入该IVR节点的时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1621910542876', - ], - 'NodeVariables' => [ - 'description' => '节点变量。', - 'type' => 'object', - 'example' => '{"digits":"2"}', - ], - 'NodeExitCode' => [ - 'description' => '节点的状态码。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Timeout' => '队列/函数/收号等超时', - 'Hangup' => '客户挂机', - 'Default' => '逻辑判断缺省出口', - 'Branch-A/B/C' => '各个逻辑判断出口', - 'Success' => '成功', - 'Failure' => '失败', - 'Overflow' => '队列溢出', - ], - 'example' => 'Success', - ], - 'FlowName' => [ - 'description' => '联系流名称。', - 'type' => 'string', - 'example' => '测试IVR', - ], - 'FlowId' => [ - 'description' => '联系流ID。', - 'type' => 'string', - 'example' => 'abc99462-1058-47d0-a114-f145ea7444ff', - ], - 'NodeProperties' => [ - 'description' => '节点的属性集合。', + 'Outbound' => [ + 'description' => '呼出指标。', 'type' => 'object', - 'example' => '{"say":"您好。"}', - ], - 'NodeType' => [ - 'description' => '节点类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ASR' => '语音识别', - 'SUB' => '子流程', - 'INCOMING_CALL' => '开始', - 'GATHER_INPUT' => '收号', - 'SUB_END' => '子流程结束', - 'BLIND_TRANSFER' => '直接转接', - 'JSON_PARSER' => 'JSON解析', - 'SUB_START' => '子流程开始', - 'SATISFACTION_RATING' => '满意度收集', - 'TRANSFER_TO_AGENT' => '转人工', - 'SPLIT' => '分支', - 'SET_VARIABLES' => '设置变量', - 'VOICE_NAVIGATOR' => '智能导航', - 'PLAY_SAY' => '放音', - 'HANGUP_REASON' => '挂机原因', - 'HANGUP' => '结束', - 'SMS' => '发短信', - 'VOICE_MAIL' => '语音信箱', - 'RUN_FUNCTION' => '函数计算', - 'HTTP_REQUEST' => 'HTTP请求', - 'FORWARD_TO_OUTSIDE_NUMBER' => '转外线', + 'properties' => [ + 'TotalTalkTime' => ['description' => '总通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxDialingTime' => ['description' => '最大拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsDialed' => ['description' => '拨号量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsAnswered' => ['description' => '电话接通量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnswerRate' => ['description' => '接通率，单位%。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'TotalWorkTime' => ['description' => '总话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxWorkTime' => ['description' => '最大话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TotalDialingTime' => ['description' => '总拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageTalkTime' => ['description' => '平均通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageWorkTime' => ['description' => '平均话后处理时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionIndex' => ['description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', 'type' => 'number', 'format' => 'float', 'example' => '0'], + 'SatisfactionSurveysOffered' => ['description' => '满意度调查发送次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SatisfactionSurveysResponded' => ['description' => '满意度调查响应次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MaxTalkTime' => ['description' => '最大通话时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AverageDialingTime' => ['description' => '平均拨号时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallsServiceLevel30' => ['description' => '等待30s内坐席接起次数。', 'type' => 'string', 'example' => '0'], + 'CallsOffered' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'CallsAbandoned' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'CallsQueuingTimeout' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'CallsQueuingOverflow' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'CallsQueuingFailed' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'CallsQueuingRerouted' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'CallsQueuingCancelled' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'CallsQueuingFailure' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'TotalWaitTime' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'CallsAgentHandled' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], + 'CallsServiceLevel30V2' => ['type' => 'integer', 'format' => 'int64', 'description' => ''], ], - 'example' => 'PLAY_SAY', - ], - 'Caller' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'example' => '1332315****', - ], - 'NodeName' => [ - 'description' => '节点名称。', - 'type' => 'string', - 'example' => '放音', - ], - 'ContactId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-10963442671187****', - ], - 'LeaveTime' => [ - 'description' => '离开该IVR节点的时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1621910545105', - ], - 'ChannelVariables' => [ - 'description' => '随路数据。', - 'type' => 'string', - 'example' => 'A=B;C=D', - ], - 'ChannelId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => '65cp2c15-92ac-4e67-98b2-073a3c541c5d', - ], - 'NodeId' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'example' => 'e0bc19a3', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid. %s', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"D2RB671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"List\\": [\\n {\\n \\"Instance\\": \\"ccc-test\\",\\n \\"Callee\\": \\"0533128****\\",\\n \\"EnterTime\\": 1621910542876,\\n \\"NodeVariables\\": {\\n \\"digits\\": \\"2\\"\\n },\\n \\"NodeExitCode\\": \\"Success\\",\\n \\"FlowName\\": \\"测试IVR\\",\\n \\"FlowId\\": \\"abc99462-1058-47d0-a114-f145ea7444ff\\",\\n \\"NodeProperties\\": {\\n \\"say\\": \\"您好。\\"\\n },\\n \\"NodeType\\": \\"PLAY_SAY\\",\\n \\"Caller\\": \\"1332315****\\",\\n \\"NodeName\\": \\"放音\\",\\n \\"ContactId\\": \\"job-10963442671187****\\",\\n \\"LeaveTime\\": 1621910545105,\\n \\"ChannelVariables\\": \\"A=B;C=D\\",\\n \\"ChannelId\\": \\"65cp2c15-92ac-4e67-98b2-073a3c541c5d\\",\\n \\"NodeId\\": \\"e0bc19a3\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"D2RB671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 4\\n 10\\n 1\\n \\n 053xxxx3128\\n 放音\\n ccc-test\\n 1621910542876\\n Success\\n job-109634426711871319\\n 65cp2c15-92ac-4e67-98b2-073a3c541c5d\\n A=B;C=D\\n abc99462-1058-47d0-a114-f145ea7444ff\\n 1621910545105\\n {\\"say\\":\\"您好。\\"}\\n 133xxxx2315\\n 测试IVR\\n PLAY_OR_SAY\\n e0bc19a3\\n {\\"digits\\":\\"2\\"}\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取IVR轨迹详情列表', - 'summary' => '调用ListIvrTrackingDetails获取指定实例下指定通话的IVR轨迹详情。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListRealtimeAgentStates' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '50572', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], - ], - 'parameters' => [ - [ - 'name' => 'SkillGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '按技能组ID过滤，非必填，默认为空，表示不过滤。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'skillgroup@ccc-test', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'AgentIdList', - 'in' => 'formData', - 'schema' => [ - 'description' => '坐席ID列表，格式为JSON数组的字符串，数组元素最多20个，非必填，默认为空，表示匹配当前实例下的所有坐席。', - 'type' => 'string', - 'required' => false, - 'example' => '["agent1@ccc-test", "agent2@ccc-test"]', - ], - ], - [ - 'name' => 'StateList', - 'in' => 'formData', - 'schema' => [ - 'description' => '按状态列表过滤，非必填，默认为空，表示匹配所有状态。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Ready' => '空闲', - 'Talking' => '通话', - 'ACW' => '话后处理', - 'Break' => '小休', - 'Ringing' => '振铃', - 'Offline' => '离线', - 'Dialing' => '拨号', - ], - 'example' => '["ACW", "Dialing"]', - ], - ], - [ - 'name' => 'AgentName', - 'in' => 'query', - 'schema' => [ - 'description' => '按坐席名称进行模糊匹配。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent', - ], - ], - [ - 'name' => 'WorkModeList', - 'in' => 'query', - 'schema' => [ - 'description' => '按工作模式列表过滤，非必填，默认为空，表示匹配所有工作模式。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => '["OFFICE_PHONE","ON_SITE"]', - ], - ], - [ - 'name' => 'OutboundScenario', - 'in' => 'query', - 'schema' => [ - 'description' => '过滤仅外呼模式下的坐席，非必填，默认为空，表示不按仅外呼模式过滤。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'Query', - 'in' => 'query', - 'schema' => [ - 'description' => '模糊过滤，可以是坐席展示名、坐席工号或坐席分机号的全部或者一部分，非必填，默认为空，表示不过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent', - ], - ], - [ - 'name' => 'CallTypeList', - 'in' => 'query', - 'schema' => [ - 'description' => '按通话类型列表过滤，格式为JSON数组的字符串，数组元素为通话类型，非必填，默认为空，表示匹配所有的通话类型。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Outbound' => '呼出', - 'Back2Back' => '双呼', - 'PrivacyDial' => '加密通话', - 'Internal' => '内部呼叫', - 'Predictive' => '预测式外呼', - 'Inbound' => '呼入', - 'Conference' => '会议', - ], - 'example' => '["Inbound", "Outbound"]', - ], - ], - [ - 'name' => 'MediaType', - 'in' => 'query', - 'schema' => [ - 'description' => '媒体类型，默认是语音（Audio）, 其他可选参数包括Chat（文本）、Video（视频）、ALL（全选）.', - 'type' => 'string', - 'required' => false, - 'example' => 'AUDIO', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'List' => [ - 'description' => '实时坐席状态数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '实时坐席状态数据。', - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '80317391', - ], - 'StateCode' => [ - 'description' => '子状态，部分场景下，仅用State字段无法完整表示坐席状态，因此需要子状态辅助，比如监听状态下，State=Talking，StateCode=Monitoring。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Monitored' => '被监听', - 'Consulted' => '被咨询', - 'Coaching' => '辅导中', - 'Consulting' => '咨询中', - 'Coached' => '被辅导', - 'Conference' => '会议', - 'Monitoring' => '监听中', - ], - 'example' => 'Monitored', - ], - 'State' => [ - 'description' => '坐席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Ready' => '空闲', - 'Talking' => '通话', - 'ACW' => '话后处理', - 'Ringing' => '振铃', - 'Break' => '小休', - 'Offline' => '下线', - 'Dialing' => '拨号', - ], - 'example' => 'ACW', - ], - 'BreakCode' => [ - 'description' => '小休码。'."\n" - ."\n" - .'**枚举值：**'."\n" - ."\n" - .'- RingingTimeout：坐席振铃超时导致的小休。'."\n" - ."\n" - .'- RejectCall：坐席拒接导致的小休。'."\n" - ."\n" - .'- Warm-up：坐席上线后置闲前的临时小休状态。', - 'type' => 'string', - 'example' => 'Warm-up', - ], - 'AgentId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent1@ccc-test', - ], - 'StateTime' => [ - 'description' => '状态开始的时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1696670640774', - ], - 'AgentName' => [ - 'description' => '坐席姓名。', - 'type' => 'string', - 'example' => '坐席小王', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'CounterParty' => [ - 'description' => '用于一些特定的三方场景，主要是监听，辅导，咨询，在三方场景时表示第三方，比如在监听或辅导场景，用于表示被监听或被辅导的坐席，在咨询场景下，表示被转接的坐席或外呼号码。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'SkillGroupIdList' => [ - 'description' => '坐席签入的技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - ], - 'SkillGroupNameList' => [ - 'description' => '坐席签入的技能组名称列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => '测试技能组', - ], - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。', - 'type' => 'string', - 'example' => '1382114****', - ], - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Outbound' => '呼出', - 'Back2Back' => '双呼', - 'PrivacyDial' => '加密通话', - 'Internal' => '内部呼叫', - 'Predictive' => '预测式外呼', - 'Inbound' => '呼入', - 'Conference' => '会议', - ], - 'example' => 'Outbound', - ], - 'Duration' => [ - 'description' => '当前状态的持续时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Extension\\": \\"80317391\\",\\n \\"StateCode\\": \\"Monitored\\",\\n \\"State\\": \\"ACW\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"AgentId\\": \\"agent1@ccc-test\\",\\n \\"StateTime\\": 1696670640774,\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"CounterParty\\": \\"agent@ccc-test\\",\\n \\"SkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ],\\n \\"SkillGroupNameList\\": [\\n \\"测试技能组\\"\\n ],\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1382114****\\",\\n \\"CallType\\": \\"Outbound\\",\\n \\"Duration\\": 16\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n 80317391\\n user-admin@ccc-test\\n 8\\n ccc-test\\n ACW\\n Monitored\\n 云呼测试坐席\\n user-test@ccc-test\\n \\n \\n [\\"skg-default@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取实时坐席状态报表', - 'summary' => '调用ListRealtimeAgentStates获取指定实例下一个或多个指定坐席的实时状态数据报表。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListRealtimeSkillGroupStates' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'SkillGroupIdList', - 'in' => 'formData', - 'schema' => [ - 'description' => '待查询数据的技能组ID列表。如果不传，查询当前实例下的所有技能组，格式为JSON数组的字符串，数组元素为技能组ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test"]', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'MediaType', - 'in' => 'query', - 'schema' => [ - 'description' => '媒体类型。'."\n" - ."\n" - .'枚举值：'."\n" - ."\n" - .'AUDIO：语音。'."\n" - ."\n" - .'VIDEO：视频。'."\n" - ."\n" - .'CHAT: 消息。'."\n" - ."\n" - .'ALL: 所有。', - 'type' => 'string', - 'required' => false, - 'example' => 'AUDIO', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'List' => [ - 'description' => '实时技能组状态数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '实时技能组状态数据。', - 'type' => 'object', - 'properties' => [ - 'WorkingAgents' => [ - 'description' => '当前话后处理中的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LongestWaitingTime' => [ - 'description' => '当前最大排队等待时长，单位秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LoggedInAgents' => [ - 'description' => '当前在线坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'WaitingCalls' => [ - 'description' => '当前排队电话个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'BreakingAgents' => [ - 'description' => '当前小休坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TalkingAgents' => [ - 'description' => '当前正在通话坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => 'skillgroup', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'ReadyAgents' => [ - 'description' => '当前空闲坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenarioReadyAgents' => [ - 'description' => '处于仅外呼模式且在空闲状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalAgents' => [ - 'description' => '总坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'BreakCodeDetailList' => [ - 'description' => '小休统计数据', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BreakCode' => [ - 'description' => '小休状态代码', - 'type' => 'string', - 'example' => '客户自定义参数，比如午餐、会议等', - ], - 'Count' => [ - 'description' => '指定小休状态发生的次数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"WorkingAgents\\": 0,\\n \\"LongestWaitingTime\\": 0,\\n \\"LoggedInAgents\\": 2,\\n \\"WaitingCalls\\": 0,\\n \\"BreakingAgents\\": 0,\\n \\"TalkingAgents\\": 0,\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"ReadyAgents\\": 2,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenarioReadyAgents\\": 0,\\n \\"TotalAgents\\": 12,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"客户自定义参数，比如午餐、会议等\\",\\n \\"Count\\": 1\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\n无\\n200\\n\\n 2\\n 10\\n 1\\n \\n 0\\n 0\\n test1\\n ccc-test\\n 2\\n 2\\n 0\\n skg-test1@ccc-test\\n 0\\n 0\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取实时技能组状态报表', - 'summary' => '调用ListRealtimeSkillGroupStates获取指定实例下实时技能组状态报表。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListRecentCallDetailRecords' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => '开始时间戳，默认是当天开始时间，最早为当前时间往前180天。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1604638129000', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '截止时间戳，默认是当前时间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '4133952000000', - 'minimum' => '0', - 'example' => '1604639129000', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'Criteria', - 'in' => 'query', - 'schema' => [ - 'description' => '模糊搜索条件，格式为JSON对象，对象包含三个属性，可以随机组合，三个属性分别为phoneNumber（按主叫或被叫号码模糊搜索）、callingNumber（按主叫号码模糊搜索）和calledNumber（按被叫号码模糊搜索）。', - 'type' => 'string', - 'required' => false, - 'example' => '{"phoneNumber":"1312121****","callingNumber":"1312121****","calledNumber":"1312121****"}', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数，只有PageNumber为1才会返回真实大小，其他都是0。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'List' => [ - 'description' => '通话记录列表。', - 'type' => 'array', - 'items' => [ - 'description' => '通话记录。', - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => '通话开始时间，内呼从进入IVR开始，外呼从开始接通计算，格式为Unix字符串，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1532448000000', - ], - 'ContactDisposition' => [ - 'description' => '电话结束原因。', - 'type' => 'string', - 'enumValueTitles' => [ - 'AbandonedInQueue' => '排队放弃', - 'NoAnswer' => '客户未接', - 'QueuingTimeout' => '排队超时', - 'Voicemail' => '转语音邮箱', - 'QueuingFailed' => '转人工失败', - 'QueuingOverflow' => '排队溢出', - 'AbandonedInVoiceNavigator' => '智能导航中放弃', - 'Success' => '正常结束', - 'IVRException' => 'IVR异常', - 'AbandonedInRing' => '振铃放弃', - 'AbandonedInIVR' => 'IVR放弃', - 'Reject' => '客户拒接', - 'ForwardToOutsideNumber' => '转外线', - ], - 'example' => 'Success', - ], - 'ContactType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Outbound' => '呼出', - 'Back2Back' => '双呼', - 'PrivacyDial' => '加密通话', - 'Internal' => '内部呼叫', - 'Predictive' => '预测式外呼', - 'Inbound' => '呼入', - 'Conference' => '会议', - ], - 'example' => 'Outbound', - ], - 'AgentIds' => [ - 'description' => '坐席ID列表，多个值用逗号分隔。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'ContactId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-7660472242845****', - ], - 'CallDuration' => [ - 'description' => '通话时长，单位秒。', - 'type' => 'string', - 'example' => '16', - ], - 'CallingNumber' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'example' => '0533128****', - ], - 'Duration' => [ - 'description' => '通话持续时间，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'CalledNumber' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'example' => '1332315****', - ], - 'SkillGroupIds' => [ - 'description' => '参与通话的座席所属的技能组，多个技能组以逗号分隔。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"StartTime\\": 1532448000000,\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"Outbound\\",\\n \\"AgentIds\\": \\"agent@ccc-test\\",\\n \\"ContactId\\": \\"job-7660472242845****\\",\\n \\"CallDuration\\": \\"16\\",\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"Duration\\": 16,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"SkillGroupIds\\": \\"skillgroup@ccc-test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 11\\n 10\\n 1\\n \\n skg-default@ccc-test\\n 133xxxx2315\\n Outbound\\n ccc-test\\n Success\\n 1532448000000\\n user-test@ccc-test\\n 16\\n job-76604722428454704\\n 16\\n 053xxxx3128\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取坐席最近通话记录列表', - 'summary' => '调用ListRecentCallDetailRecords获取指定实例下当前RAM账号映射的坐席的最近通话记录列表。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListAgentStates' => [ - 'summary' => '调用ListAgentStates获取指定实例下按指定条件过滤后的坐席状态列表，该接口仅对特定用户开放，其他客户不建议调用。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'SkillGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '按技能组ID过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'skillgroup@ccc-test', - ], - ], - [ - 'name' => 'AgentIds', - 'in' => 'query', - 'schema' => [ - 'description' => '按坐席ID列表过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], - ], - [ - 'name' => 'State', - 'in' => 'query', - 'schema' => [ - 'description' => '按坐席状态过滤，只能按单个状态过滤。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Ready' => '空闲', - 'Talking' => '通话', - 'ACW' => '话后处理', - 'Break' => '小休', - 'Ringing' => '振铃', - 'Offline' => '下线', - 'Dialing' => '拨号', - ], - 'example' => 'Ready', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-300。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'ExcludeOfflineUsers', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '过滤掉离线坐席，固定为true，暂不支持false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-300。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'List' => [ - 'description' => '列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'LoginName' => [ - 'description' => '座席登录名。', - 'type' => 'string', - 'example' => 'agent', - ], - 'Dn' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8030****', - ], - 'StateDuration' => [ - 'description' => '坐席状态持续时长。', - 'type' => 'string', - 'example' => '10', - ], - 'State' => [ - 'description' => '坐席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'Ready' => '空闲', - 'Talking' => '通话', - 'ACW' => '话后处理', - 'Ringing' => '振铃', - 'Break' => '小休', - 'Offline' => '下线', - 'Dialing' => '拨号', - ], - 'example' => 'Ready', - ], - 'AgentId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'AgentName' => [ - 'description' => '座席名称。', - 'type' => 'string', - 'example' => '坐席小王', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'BreakCode' => [ - 'description' => '小休码。', - 'type' => 'string', - 'enumValueTitles' => [ - 'RingingTimeout' => '坐席振铃超时导致的小休', - 'RejectCall' => '坐席拒接导致的小休', - 'Warm-up' => '坐席上线后置闲前的临时小休状态', - ], - 'example' => 'Warm-up', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否处于仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'substitutions' => [ - 'CCC::2020-07-01::ListRealtimeAgentStates', - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"LoginName\\": \\"agent\\",\\n \\"Dn\\": \\"8030****\\",\\n \\"StateDuration\\": \\"10\\",\\n \\"State\\": \\"Ready\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"OutboundScenario\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取坐席状态列表', - ], - 'ListAgentSummaryReportsSinceMidnight' => [ - 'summary' => '调用ListAgentSummaryReportsSinceMidnight获取指定实例下按指定条件过滤后的坐席历史数据报表，统计的是从当天0时开始，到当前时间为止的数据。该接口仅对特定用户开放，其他客户不建议调用。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => true, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'SkillGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '按技能组ID过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'skillgroup@ccc-test', - ], - ], - [ - 'name' => 'AgentIds', - 'in' => 'query', - 'schema' => [ - 'description' => '按坐席ID列表过滤，范围0-100 。'."\n" - ."\n" - .'> 如果坐席ID列表不为空，则直接按照坐席ID列表进行查询，此时pageSize和pageNumber参数无效，数据直接返回，如：请求参数：pageNumber = 3 则响应参数中pageNumber = 3 。', - 'type' => 'string', - 'required' => false, - 'example' => '["agent1@ccc-test", "agent2@ccc-test"]', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100，非必填，默认1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100，非必填，默认10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '27DD30C4-CAE2-481A-97CC-D3C54625341D', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PagedAgentSummaryReport' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'List' => [ - 'description' => '坐席概览数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '坐席概览数据。', - 'type' => 'object', - 'properties' => [ - 'LoginName' => [ - 'description' => '座席登录名。', - 'type' => 'string', - 'example' => 'agent', - ], - 'AgentId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'AgentName' => [ - 'description' => '坐席名称。', - 'type' => 'string', - 'example' => '坐席小王。', - ], - 'SkillGroupNames' => [ - 'description' => '座席所属技能组名称列表，格式为JSON数组的字符串，数组元素是技能组名称。', - 'type' => 'string', - 'example' => '["测试技能组1","测试技能组2"]', - ], - 'Timestamp' => [ - 'description' => '统计打点时刻。', - 'type' => 'string', - 'example' => '2018-09-13 00:00:00', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'SkillGroupIds' => [ - 'description' => '座席所属技能组ID列表，格式为JSON数组的字符串，数组元素为技能组ID。', - 'type' => 'string', - 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'."\n", - ], - 'Overall' => [ - 'description' => '整体指标。', - 'type' => 'object', - 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，不包含小休时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，计算公式为：（TotalworkTime+TotalTalkTime）/TotalLoggedInTime。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，计算公式为：TotalWorkTime/TotalCalls，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，计算公式为：TotalTalkTime/（CallsAnswered+CallsHandled），单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageReadyTime' => [ - 'description' => '平均就绪时长，计算公式为：TotalReadyTime/就绪次数。就绪次数为非接口统计字段，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大就绪时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '37', - ], - 'OneTransferCalls' => [ - 'description' => '直接转接的通话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总就绪时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话量，计算公式为：CallsOffered+CallsDialed。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - 'Inbound' => [ - 'description' => '呼入指标。', - 'type' => 'object', - 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '分配量，即分配给此坐席的电话次数，包括其他坐席盲转和咨询转给此坐席的电话。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageRingTime' => [ - 'description' => '平均振铃时长，计算公式为：TotalRingTime/CallsRinged，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '应答量，即坐席应答的次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '20秒应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - 'Outbound' => [ - 'description' => '呼出指标。', - 'type' => 'object', - 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '电话拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAnswered' => [ - 'description' => '电话接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnswerRate' => [ - 'description' => '接通率，计算公式为：CallsAnswered/CallsDialed（由于接听事件与应答事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'string', - 'example' => '0', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'substitutions' => [ - 'CCC::2020-07-01::ListHistoricalAgentReport', - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"27DD30C4-CAE2-481A-97CC-D3C54625341D\\",\\n \\"Success\\": true,\\n \\"PagedAgentSummaryReport\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"LoginName\\": \\"agent\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王。\\",\\n \\"SkillGroupNames\\": \\"[\\\\\\"测试技能组1\\\\\\",\\\\\\"测试技能组2\\\\\\"]\\",\\n \\"Timestamp\\": \\"2018-09-13 00:00:00\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SkillGroupIds\\": \\"[\\\\\\"skillgroup1@ccc-test\\\\\\",\\\\\\"skillgroup2@ccc-test\\\\\\"]\\\\n\\",\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"MaxReadyTime\\": 37,\\n \\"OneTransferCalls\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"TotalCalls\\": 0\\n },\\n \\"Inbound\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0\\n },\\n \\"Outbound\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": \\"0\\",\\n \\"TotalDialingTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取坐席概览数据列表', - ], - 'ListLegacyAgentEventLogs' => [ - 'summary' => '调用ListLegacyAgentEventLogs获取1.0遗留坐席事件日志列表，该接口仅对特定用户开放，其他客户不建议调用。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-1000。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-1000。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '100', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1657853640015', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '结束时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1658026440011', - ], - ], - [ - 'name' => 'AgentId', - 'in' => 'query', - 'schema' => [ - 'description' => '按坐席ID过滤，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2802EE59-3B53-513A-A130-85E480AF689D', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-1000。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-1000。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'List' => [ - 'description' => '坐席事件日志列表', - 'type' => 'array', - 'items' => [ - 'description' => '坐席事件日志。', - 'type' => 'object', - 'properties' => [ - 'TargetSelect' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'TargetRequest' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'StatisticDate' => [ - 'description' => '统计时刻。', - 'type' => 'string', - 'example' => '2021-12-03T10:15:30', - ], - 'PhoneNo' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8012****', - ], - 'GroupNo' => [ - 'description' => '坐席签入的技能组ID列表，多个技能组ID用逗号分割。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test,skillgroup2@ccc-test', - ], - 'Event' => [ - 'description' => '事件类型。', - 'type' => 'string', - 'enumValueTitles' => [ - '拨号' => '拨号', - '振铃' => '振铃', - '处理' => '处理', - ], - 'example' => '拨号', - ], - 'ConnId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => '345467****', - ], - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - '呼入' => '呼入', - '呼出' => '呼出', - ], - 'example' => '呼入', - ], - 'CallId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => '378654****', - ], - 'CallerId' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'example' => '08331111****', - ], - 'CalleeId' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'example' => '1312343****', - ], - 'AgentNo' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'AgentDropCall' => [ - 'description' => '是否为坐席挂机。', - 'type' => 'string', - 'example' => 'false', - ], - 'TransferNumber' => [ - 'description' => '转接号码。', - 'type' => 'string', - 'example' => '07518888****', - ], - 'CallDir' => [ - 'description' => '呼叫方向。', - 'type' => 'string', - 'enumValueTitles' => [ - '内部' => '内部', - '外部' => '外部', - ], - 'example' => '内部', - ], - 'CallMode' => [ - 'description' => '通话模式。', - 'type' => 'string', - 'enumValueTitles' => [ - '呼入' => '呼入', - '呼出' => '呼出', - ], - 'example' => '呼入', - ], - 'TenantId' => [ - 'description' => '租户ID。', - 'type' => 'string', - 'example' => 'acc101', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否为仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'substitutions' => [ - 'CCC::2020-07-01::ListAgentStateLogs', - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2802EE59-3B53-513A-A130-85E480AF689D\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"TargetSelect\\": \\"skillgroup@ccc-test\\",\\n \\"TargetRequest\\": \\"skillgroup@ccc-test\\",\\n \\"StatisticDate\\": \\"2021-12-03T10:15:30\\",\\n \\"PhoneNo\\": \\"8012****\\",\\n \\"GroupNo\\": \\"skillgroup1@ccc-test,skillgroup2@ccc-test\\",\\n \\"Event\\": \\"拨号\\",\\n \\"ConnId\\": \\"345467****\\",\\n \\"CallType\\": \\"呼入\\",\\n \\"CallId\\": \\"378654****\\",\\n \\"CallerId\\": \\"08331111****\\",\\n \\"CalleeId\\": \\"1312343****\\",\\n \\"AgentNo\\": \\"agent@ccc-test\\",\\n \\"AgentDropCall\\": \\"false\\",\\n \\"TransferNumber\\": \\"07518888****\\",\\n \\"CallDir\\": \\"内部\\",\\n \\"CallMode\\": \\"呼入\\",\\n \\"TenantId\\": \\"acc101\\",\\n \\"OutboundScenario\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取遗留坐席事件日志列表', - ], - 'ListLegacyAgentStatusLogs' => [ - 'summary' => '调用ListLegacyAgentStatusLogs获取1.0遗留坐席状态日志列表，该接口仅对特定用户开放，其他客户不建议调用。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-1000。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-1000。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '100', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1657778840011', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '结束时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1657879880010', - ], - ], - [ - 'name' => 'AgentId', - 'in' => 'query', - 'schema' => [ - 'description' => '按坐席ID过滤，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4C9A5D93-33A6-57F3-A423-4C83BD0A8455', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-1000。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-1000。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'List' => [ - 'description' => '坐席状态数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '坐席状态数据。', - 'type' => 'object', - 'properties' => [ - 'TransferNo' => [ - 'description' => '转接号码。', - 'type' => 'string', - 'example' => '07551231****', - ], - 'TargetSelect' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'TargetRequest' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Status' => [ - 'description' => '坐席状态。', - 'type' => 'string', - 'enumValueTitles' => [ - '拨号' => '拨号', - '振铃' => '振铃', - '处理' => '处理', - '小休' => '小休', - ], - 'example' => '振铃', - ], - 'StatisticDate' => [ - 'description' => '统计时刻。', - 'type' => 'string', - 'example' => '2021-12-03T10:15:30', - ], - 'StatisticTime' => [ - 'description' => '状态持续时间，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'PhoneNo' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8012****', - ], - 'MonitedAgentPhoneNo' => [ - 'description' => '被监听号码。', - 'type' => 'string', - 'example' => '8012****', - ], - 'MonitedAgentNo' => [ - 'description' => '监听号码。', - 'type' => 'string', - 'example' => '8032****', - ], - 'GroupNo' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'ConnId' => [ - 'description' => '话务通道ID。', - 'type' => 'string', - 'example' => '487326****', - ], - 'CallType' => [ - 'description' => '通话类型。', - 'type' => 'string', - 'enumValueTitles' => [ - '呼入' => '呼入', - '呼出' => '呼出', - ], - 'example' => '呼入', - ], - 'CallId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => '454326****', - ], - 'CallerId' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'example' => '08337676****', - ], - 'CalleeId' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'example' => '1312121****', - ], - 'CallDir' => [ - 'description' => '呼叫方向。', - 'type' => 'string', - 'enumValueTitles' => [ - '内部' => '内部', - '外部' => '外部', - ], - 'example' => '内部', - ], - 'AgentNo' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'AgentDropCall' => [ - 'description' => '是否为坐席挂机。', - 'type' => 'string', - 'example' => 'false', - ], - 'AliHangupCause' => [ - 'description' => '挂断原因。', - 'type' => 'string', - 'example' => '无', - ], - 'TransferNumber' => [ - 'description' => '转接号码。', - 'type' => 'string', - 'example' => '05711231****', - ], - 'Extend1' => [ - 'description' => '自定义扩展字段。', - 'type' => 'string', - 'example' => '无', - ], - 'Extend2' => [ - 'description' => '自定义扩展字段。', - 'type' => 'string', - 'example' => '无', - ], - 'Extend3' => [ - 'description' => '自定义扩展字段。', - 'type' => 'string', - 'example' => '无', - ], - 'Extend4' => [ - 'description' => '自定义扩展字段。', - 'type' => 'string', - 'example' => '无', - ], - 'TenantId' => [ - 'description' => '租户ID。', - 'type' => 'string', - 'example' => 'acc6736', - ], - 'OutboundScenario' => [ - 'description' => '坐席是否为仅外呼模式。', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'substitutions' => [ - 'CCC::2020-07-01::ListAgentStateLogs', - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"4C9A5D93-33A6-57F3-A423-4C83BD0A8455\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"TransferNo\\": \\"07551231****\\",\\n \\"TargetSelect\\": \\"skillgroup@ccc-test\\",\\n \\"TargetRequest\\": \\"skillgroup@ccc-test\\",\\n \\"Status\\": \\"振铃\\",\\n \\"StatisticDate\\": \\"2021-12-03T10:15:30\\",\\n \\"StatisticTime\\": 3,\\n \\"PhoneNo\\": \\"8012****\\",\\n \\"MonitedAgentPhoneNo\\": \\"8012****\\",\\n \\"MonitedAgentNo\\": \\"8032****\\",\\n \\"GroupNo\\": \\"skillgroup@ccc-test\\",\\n \\"ConnId\\": \\"487326****\\",\\n \\"CallType\\": \\"呼入\\",\\n \\"CallId\\": \\"454326****\\",\\n \\"CallerId\\": \\"08337676****\\",\\n \\"CalleeId\\": \\"1312121****\\",\\n \\"CallDir\\": \\"内部\\",\\n \\"AgentNo\\": \\"agent@ccc-test\\",\\n \\"AgentDropCall\\": \\"false\\",\\n \\"AliHangupCause\\": \\"无\\",\\n \\"TransferNumber\\": \\"05711231****\\",\\n \\"Extend1\\": \\"无\\",\\n \\"Extend2\\": \\"无\\",\\n \\"Extend3\\": \\"无\\",\\n \\"Extend4\\": \\"无\\",\\n \\"TenantId\\": \\"acc6736\\",\\n \\"OutboundScenario\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取遗留坐席状态日志列表', - ], - 'ListLegacyQueueEventLogs' => [ - 'summary' => '调用ListLegacyQueueEventLogs获取1.0遗留队列事件日志列表，该接口仅对特定用户开放，其他客户不建议调用。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-1000。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-1000。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '100', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1657939540015', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '结束时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1658026180018', - ], - ], - [ - 'name' => 'SkillGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '按技能组ID过滤，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'skillgroup@ccc-test', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1A5A8998-41F9-5F85-BFCF-EB2B6E376812', - ], - 'Success' => [ - 'description' => '是否调用成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-1000。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-1000。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'List' => [ - 'description' => '队列事件日志列表。', - 'type' => 'array', - 'items' => [ - 'description' => '队列事件日志。', - 'type' => 'object', - 'properties' => [ - 'Vq' => [ - 'description' => '队列名称。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'StatisticDate' => [ - 'description' => '统计日期。', - 'type' => 'string', - 'example' => '2021-12-03T10:15:30', - ], - 'QueueTime' => [ - 'description' => '队列时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Ani' => [ - 'description' => '主叫', - 'type' => 'string', - 'example' => '8012****', - ], - 'Dnis' => [ - 'description' => '被叫。', - 'type' => 'string', - 'example' => '1312211****', - ], - 'Cause' => [ - 'description' => '挂机原因。', - 'type' => 'string', - 'enumValueTitles' => [ - '队列呼损' => '队列呼损', - '正常' => '正常', - '久振呼损' => '久振呼损', - ], - 'example' => '正常', - ], - 'AnswerTime' => [ - 'description' => '应答时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'AnswerPhone' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'Acid' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => '456328****', - ], - 'TenantId' => [ - 'description' => '租户ID。', - 'type' => 'string', - 'example' => 'acc3733', - ], - 'Id' => [ - 'description' => '主键', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '109160', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"1A5A8998-41F9-5F85-BFCF-EB2B6E376812\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Vq\\": \\"skillgroup@ccc-test\\",\\n \\"StatisticDate\\": \\"2021-12-03T10:15:30\\",\\n \\"QueueTime\\": 10,\\n \\"Ani\\": \\"8012****\\",\\n \\"Dnis\\": \\"1312211****\\",\\n \\"Cause\\": \\"正常\\",\\n \\"AnswerTime\\": 15,\\n \\"AnswerPhone\\": \\"agent@ccc-test\\",\\n \\"Acid\\": \\"456328****\\",\\n \\"TenantId\\": \\"acc3733\\",\\n \\"Id\\": 109160\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取遗留队列事件日志列表', - ], - 'ListSkillGroupStates' => [ - 'summary' => '调用ListSkillgroupStates获取指定实例下指定技能组的状态列表，该接口仅对特定用户开放，其他客户不建议调用。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'SkillGroupIds', - 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID列表。'."\n" - ."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1F69EBB0-63E9-5DDE-887F-9FC040ADF309', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'TotalCount' => [ - 'description' => '总数。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'List' => [ - 'description' => '技能组状态数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组状态数据。', - 'type' => 'object', - 'properties' => [ - 'WorkingAgents' => [ - 'description' => '话后处理坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LoggedInAgents' => [ - 'description' => '在线坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'BreakingAgents' => [ - 'description' => '处于小休状态的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'LongestCall' => [ - 'description' => '最大等待时长。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'WaitingCalls' => [ - 'description' => '当前排队电话个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TalkingAgents' => [ - 'description' => '正在通话坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => '测试技能组', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - 'ReadyAgents' => [ - 'description' => '空闲坐席数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'AverageWaitingTime' => [ - 'description' => '平均等待时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'WaitingCallsLevel10' => [ - 'description' => '等待时长小于10秒的通话的个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'WaitingCallsLevel20' => [ - 'description' => '等待时长小于20秒的通话的个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'WaitingCallsLevel30' => [ - 'description' => '等待时长小于30秒的通话的个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OutboundScenarioReadyAgents' => [ - 'description' => '处于仅外呼状态并且空闲的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'InboundTalkingAgents' => [ - 'description' => '呼入场景下通话的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OutboundTalkingAgents' => [ - 'description' => '外呼场景下通话的坐席数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'substitutions' => [ - 'CCC::2020-07-01::ListRealtimeSkillGroupStates', - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"1F69EBB0-63E9-5DDE-887F-9FC040ADF309\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"WorkingAgents\\": 0,\\n \\"LoggedInAgents\\": 0,\\n \\"BreakingAgents\\": 0,\\n \\"LongestCall\\": 0,\\n \\"WaitingCalls\\": 0,\\n \\"TalkingAgents\\": 0,\\n \\"SkillGroupName\\": \\"测试技能组\\",\\n \\"SkillGroupId\\": \\"skillgroup1@ccc-test\\",\\n \\"ReadyAgents\\": 1,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"AverageWaitingTime\\": 3,\\n \\"WaitingCallsLevel10\\": 0,\\n \\"WaitingCallsLevel20\\": 0,\\n \\"WaitingCallsLevel30\\": 0,\\n \\"OutboundScenarioReadyAgents\\": 0,\\n \\"InboundTalkingAgents\\": 0,\\n \\"OutboundTalkingAgents\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取技能组状态列表', - ], - 'ListSkillGroupSummaryReportsSinceMidnight' => [ - 'summary' => '调用ListSkillgroupSummaryReportsSinceMidnight获取指定实例下按指定条件过滤后的技能组历史数据报表，统计的时间范围是从当天0时开始，到当前时间结束。该接口仅对特定用户开放，其他客户不建议调用。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'SkillGroups', - 'in' => 'query', - 'schema' => [ - 'description' => '待查询的技能组ID列表，格式为JSON数组的字符串，数组元素为技能组ID，非必填，默认为空，表示查询当前分页下的所有技能组。', - 'type' => 'string', - 'required' => false, - 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test2"]'."\n", - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2B36CEBC-6D11-5451-9E6B-C6D1927841C5', - ], - 'Success' => [ - 'description' => '是否调用成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'PagedSkillGroupSummaryReport' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'List' => [ - 'description' => '技能组概览数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组概览数据。', - 'type' => 'object', - 'properties' => [ - 'Timestamp' => [ - 'description' => '统计打点时刻。', - 'type' => 'string', - 'example' => '2018-09-13 00:00:00', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => '测试技能组', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'Overall' => [ - 'description' => '整体指标。', - 'type' => 'object', - 'properties' => [ - 'TotalLoggedInTime' => [ - 'description' => '总登录时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OccupancyRate' => [ - 'description' => '座席利用率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxReadyTime' => [ - 'description' => '最大空闲时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageReadyTime' => [ - 'description' => '平均空闲时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalBreakTime' => [ - 'description' => '总小休时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalReadyTime' => [ - 'description' => '总空闲时长，单位为秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalCalls' => [ - 'description' => '总电话量。计算公式为：CallsOffered + CallsDialed。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - 'Inbound' => [ - 'description' => '呼入指标。', - 'type' => 'object', - 'properties' => [ - 'AverageRingTime' => [ - 'description' => '平均振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsHandled' => [ - 'description' => '应答量，即坐席应答的次数。一通电话每次进入队列后，若被多个坐席应答，算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'QueueMaxWaitTimeDuration' => [ - 'description' => '队列最大等待时间，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。计算公式为： TotalWorkTime/CallsHandled。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AnsweredByAgentOfQueueWaitTimeDuration' => [ - 'description' => '坐席接起时队列等待时间，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalRingTime' => [ - 'description' => '总振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'InComingQueueOfQueueCount' => [ - 'description' => '技能组呼入次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'string', - 'example' => '0', - ], - 'MaxRingTime' => [ - 'description' => '最大振铃时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsOffered' => [ - 'description' => '分配量，即分配给该技能组的电话数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AbandonedInQueueOfQueueCount' => [ - 'description' => '技能组排队放弃次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OverFlowInQueueOfQueueCount' => [ - 'description' => '技能组排队超时次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnsweredByAgentOfQueueMaxWaitTimeDuration' => [ - 'description' => '坐席接起时队列最大等待时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ServiceLevel20' => [ - 'description' => '20秒应答率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnsweredByAgentOfQueueCount' => [ - 'description' => '技能组转人工接起次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'HandleRate' => [ - 'description' => '应答率。计算公式为：CallsHandled/CallsOffered（由于应答事件与分配事件可能落在不同的时间范围内，所以某些情况下结果可能大于100%）。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'GiveUpByAgentOfQueueCount' => [ - 'description' => '技能组振铃放弃次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'QueueWaitTimeDuration' => [ - 'description' => '队列等待时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsServiceLevel20' => [ - 'description' => '等待20s内坐席接起次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsServiceLevel30' => [ - 'description' => '等待30s内坐席接起次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsServiceLevel10' => [ - 'description' => '等待10s内坐席接起次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAttendedTransferOut' => [ - 'description' => '咨询转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsBlindTransferOut' => [ - 'description' => '直接转出量。若一通电话多次转出给其他坐席，每次转出算一次。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsQueuingTimeout' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'CallsTimeout' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'CallsQueuingCanceled' => [ - 'type' => 'string', - ], - 'CallsQueuingFailure' => [ - 'type' => 'string', - ], - 'CallsQueuingRerouted' => [ - 'type' => 'string', - ], - 'CallsAbandoned' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'CallsOverflow' => [ - 'type' => 'string', - ], - ], - ], - 'Outbound' => [ - 'description' => '呼出指标。', - 'type' => 'object', - 'properties' => [ - 'TotalTalkTime' => [ - 'description' => '总通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxDialingTime' => [ - 'description' => '最大拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsDialed' => [ - 'description' => '拨号量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsAnswered' => [ - 'description' => '电话接通量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AnswerRate' => [ - 'description' => '接通率，单位%。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'TotalWorkTime' => [ - 'description' => '总话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxWorkTime' => [ - 'description' => '最大话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalDialingTime' => [ - 'description' => '总拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageTalkTime' => [ - 'description' => '平均通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageWorkTime' => [ - 'description' => '平均话后处理时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionIndex' => [ - 'description' => '满意度指数，即满意度按键数字（1位数字）的平均值。', - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'SatisfactionSurveysOffered' => [ - 'description' => '满意度调查发送次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'SatisfactionSurveysResponded' => [ - 'description' => '满意度调查响应次数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MaxTalkTime' => [ - 'description' => '最大通话时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'AverageDialingTime' => [ - 'description' => '平均拨号时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'CallsServiceLevel30' => [ - 'description' => '等待30s内坐席接起次数。', - 'type' => 'string', - 'example' => '0', - ], - 'CallsOffered' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'CallsAbandoned' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'CallsQueuingTimeout' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'CallsQueuingOverflow' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'CallsQueuingFailed' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'CallsQueuingRerouted' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'CallsQueuingCancelled' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'CallsQueuingFailure' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'TotalWaitTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'CallsAgentHandled' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'CallsServiceLevel30V2' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'substitutions' => [ - 'CCC::2020-07-01::ListHistoricalSkillGroupReport', - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2B36CEBC-6D11-5451-9E6B-C6D1927841C5\\",\\n \\"Success\\": true,\\n \\"PagedSkillGroupSummaryReport\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"List\\": [\\n {\\n \\"Timestamp\\": \\"2018-09-13 00:00:00\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SkillGroupName\\": \\"测试技能组\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Overall\\": {\\n \\"TotalLoggedInTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0\\n },\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"QueueMaxWaitTimeDuration\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"AnsweredByAgentOfQueueWaitTimeDuration\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"InComingQueueOfQueueCount\\": 0,\\n \\"MaxTalkTime\\": \\"0\\",\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"AbandonedInQueueOfQueueCount\\": 0,\\n \\"OverFlowInQueueOfQueueCount\\": 0,\\n \\"AnsweredByAgentOfQueueMaxWaitTimeDuration\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"AnsweredByAgentOfQueueCount\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"GiveUpByAgentOfQueueCount\\": 0,\\n \\"QueueWaitTimeDuration\\": 0,\\n \\"CallsServiceLevel20\\": 0,\\n \\"CallsServiceLevel30\\": 0,\\n \\"CallsServiceLevel10\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"CallsTimeout\\": 0,\\n \\"CallsQueuingCanceled\\": \\"\\",\\n \\"CallsQueuingFailure\\": \\"\\",\\n \\"CallsQueuingRerouted\\": \\"\\",\\n \\"CallsAbandoned\\": 0,\\n \\"CallsOverflow\\": \\"\\"\\n },\\n \\"Outbound\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"AverageDialingTime\\": 0,\\n \\"CallsServiceLevel30\\": \\"0\\",\\n \\"CallsOffered\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsQueuingFailed\\": 0,\\n \\"CallsQueuingRerouted\\": 0,\\n \\"CallsQueuingCancelled\\": 0,\\n \\"CallsQueuingFailure\\": 0,\\n \\"TotalWaitTime\\": 0,\\n \\"CallsAgentHandled\\": 0,\\n \\"CallsServiceLevel30V2\\": 0\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取技能组概览数据列表', - ], - 'ListVoicemails' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的起始时间，默认为当天的0时，时间戳为毫秒级。（必填）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1532448000000', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '获取的历史数据的终止时间，默认为当前时间，时间戳为毫秒级。（必填）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1532707199000', - ], - ], - [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'description' => '通过指定的contactId来查询某一通电话的记录，contactId可以通过软电话SDK发生通话时获取到。如果传入该参数，则自动忽略其他查询参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'job-125152394144124921', - ], - ], - [ - 'name' => 'Caller', - 'in' => 'query', - 'schema' => [ - 'description' => '主叫号码。'."\n" - ."\n", - 'type' => 'string', - 'required' => false, - 'example' => '073xxxx7539', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '语音信箱名称。', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'voicemail-test', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总条目数，只有PageNumber为1才会返回，其他都是0。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - 'List' => [ - 'description' => '语音信箱记录列表。', - 'type' => 'array', - 'items' => [ - 'description' => '语音信箱记录。', - 'type' => 'object', - 'properties' => [ - 'CdrStartTime' => [ - 'description' => '话务开始时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1532448000000，已废弃，请使用StartTime。', - ], - 'Caller' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'example' => '073xxxx7539', - ], - 'ContactId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-125152394144124921', - ], - 'RecordingDuration' => [ - 'description' => '留言时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10，已废弃，请使用Duration', - ], - 'InstanceId' => [ - 'description' => '云联络中心实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Name' => [ - 'description' => '语音信箱名称。', - 'type' => 'string', - 'example' => 'voicemail-test', - ], - 'Callee' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'example' => '0533128****', - ], - 'StartTime' => [ - 'description' => '语音信箱开始时间。', - 'type' => 'string', - 'example' => '1631440860000', - ], - 'Duration' => [ - 'description' => '留言时长，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"CdrStartTime\\": 0,\\n \\"Caller\\": \\"073xxxx7539\\",\\n \\"ContactId\\": \\"job-125152394144124921\\",\\n \\"RecordingDuration\\": 0,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"voicemail-test\\",\\n \\"Callee\\": \\"0533128****\\",\\n \\"StartTime\\": \\"1631440860000\\",\\n \\"Duration\\": 16\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 200\\n 无\\n EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n \\n 1\\n 10\\n 11\\n \\n 1532448000000\\n 073xxxx7539\\n job-125152394144124921\\n 10\\n ccc-test\\n voicemail-test\\n \\n \\n","errorExample":""}]', - 'title' => '获取语音信箱列表', - 'summary' => '调用ListVoicemails获取指定实例下语音信箱列表。', - ], - 'ListGroupChatMessages' => [ - 'summary' => '查询Chat消息记录。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'chat-65382141036853491', - ], - ], - [ - 'name' => 'SortOrder', - 'in' => 'query', - 'schema' => [ - 'description' => '排序方式，默认为降序。'."\n" - ."\n" - .'枚举值：'."\n" - ."\n" - .'ASC：升序。'."\n" - ."\n" - .'DESC：降序。', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例。', - 'type' => 'string', - 'required' => false, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'NextPageToken', - 'in' => 'query', - 'schema' => [ - 'description' => '下一页标识，32位UUID。请求第一页时，NextPageToken为空；请求后续文件时需传入前一页查询结果中的NextPageToken值。', - 'type' => 'string', - 'required' => false, - 'example' => 'b2ad450b116e4f8396e58108acf5c020', - ], - ], - ], - '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' => '2263B273-AC1B-44EB-BA98-87F2322C6780', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP请求返回的响应状态码，200表示请求成功。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'Messages' => [ - 'description' => '消息列表。', - 'type' => 'array', - 'items' => [ - 'description' => '消息体。', - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'example' => 'chat-65382141036853491', - ], - 'SenderId' => [ - 'description' => '消息发送者用户ID。', - 'type' => 'string', - 'example' => '64bb4ececc34fc5ec1ca1153', - ], - 'SenderType' => [ - 'description' => '发送方类型。'."\n" - ."\n" - .'枚举值'."\n" - .'- **ADMIN**：系统'."\n" - .'- **CUSTOMER**：访客'."\n" - .'- **AGENT**：坐席', - 'type' => 'string', - 'example' => 'CUSTOMER', - ], - 'Timestamp' => [ - 'description' => '消息时间戳，格式是Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1696126980371', - ], - 'Content' => [ - 'description' => '内容信息。', - 'type' => 'string', - 'example' => '{"variables":{},"text":"

好的，不客气

","contentType":"Text","subContentType":"richtext"}', - ], - 'SenderName' => [ - 'description' => '发送者名称。', - 'type' => 'string', - 'example' => 'test-agent@test-instanceId', - ], - 'SenderAvatarUrl' => [ - 'description' => '发送者头像地址。', - 'type' => 'string', - 'example' => 'http://xxxxx.com', - ], - 'Recalled' => [ - 'description' => '是否被撤回。', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - 'NextPageToken' => [ - 'description' => '下一页标识。', - 'type' => 'string', - 'example' => '54d1a616d95a4a01ba58967a9115b649', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Permission.Unauthorized', - 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Messages\\": [\\n {\\n \\"JobId\\": \\"chat-65382141036853491\\",\\n \\"SenderId\\": \\"64bb4ececc34fc5ec1ca1153\\",\\n \\"SenderType\\": \\"CUSTOMER\\",\\n \\"Timestamp\\": 1696126980371,\\n \\"Content\\": \\"{\\\\\\"variables\\\\\\":{},\\\\\\"text\\\\\\":\\\\\\"

好的，不客气

\\\\\\",\\\\\\"contentType\\\\\\":\\\\\\"Text\\\\\\",\\\\\\"subContentType\\\\\\":\\\\\\"richtext\\\\\\"}\\",\\n \\"SenderName\\": \\"test-agent@test-instanceId\\",\\n \\"SenderAvatarUrl\\": \\"http://xxxxx.com\\",\\n \\"Recalled\\": false\\n }\\n ],\\n \\"NextPageToken\\": \\"54d1a616d95a4a01ba58967a9115b649\\"\\n }\\n}","type":"json"}]', - 'title' => '查询消息列表', - ], - 'RestoreArchivedRecordings' => [ - 'summary' => '解冻指定实例下的通话录音。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'ContactIds', - 'in' => 'query', - 'schema' => [ - 'description' => '话务ID列表，JSON格式。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '[\\"job-216750038017142784\\"]', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'Instance 0 does not exist.', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F8066648-5D95-55AB-ACD3-2F4AD3BEA715', - ], - 'Data' => [ - 'description' => '数据。'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '数据。'."\n", - 'type' => 'object', - 'properties' => [ - 'Exists' => [ - 'description' => '录音文件是否存在。', - 'type' => 'string', - 'example' => 'False', - ], - 'ContactId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-25920271311543****', - ], - 'Status' => [ - 'description' => '录音解冻状态，可选值为Completed或者Progressing。', - 'type' => 'string', - 'example' => 'Progressing', - ], - 'StorageType' => [ - 'description' => '录音文件的存储类型。', - 'type' => 'string', - 'example' => 'Standard', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance 0 does not exist.\\",\\n \\"RequestId\\": \\"F8066648-5D95-55AB-ACD3-2F4AD3BEA715\\",\\n \\"Data\\": [\\n {\\n \\"Exists\\": \\"False\\",\\n \\"ContactId\\": \\"job-25920271311543****\\",\\n \\"Status\\": \\"Progressing\\",\\n \\"StorageType\\": \\"Standard\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '解冻录音文件', - ], - 'GetMonoRecording' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6538214103689****', - ], - ], - [ - 'name' => 'ExpireSeconds', - 'in' => 'query', - 'schema' => [ - 'description' => '过期时间，单位秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'FileUrl' => [ - 'description' => '录音文件的OSS下载地址，注意下载地址的过期时间，下载地址的有效期为1天。', - 'type' => 'string', - 'example' => 'http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-6538214103689****.wav?Expires=1610910578&OSSAccessKeyId=****&Signature=****', - ], - 'FileName' => [ - 'description' => '录音文件名称。', - 'type' => 'string', - 'example' => 'job-6538214103689****.wav', - ], - 'Duration' => [ - 'description' => '录音时长，单位：毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-6538214103689****.wav?Expires=1610910578&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"job-6538214103689****.wav\\",\\n \\"Duration\\": 30000\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-65382141036893491.wav?Expires=1610910578&OSSAccessKeyId=XXXX&Signature=XXXX\\n job-65382141036893491.wav\\n\\nOK","errorExample":""}]', - 'title' => '获取单轨录音', - 'summary' => '调用GetMonoRecording获取指定实例下指定通话的单轨录音，单轨录音只有一个音轨，坐席侧和客户侧的录音合并到了同一个音轨上，格式为WAV。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetMultiChannelRecording' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6538214103689****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'FileUrl' => [ - 'description' => '录音文件的OSS下载地址，注意下载地址的过期时间，下载地址的有效期为1天。', - 'type' => 'string', - 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2021/04/job-6538214103689****.mkv?Expires=1617435462&OSSAccessKeyId=****&Signature=****', - ], - 'FileName' => [ - 'description' => '录音文件名称。', - 'type' => 'string', - 'example' => 'job-6538214103689****.mkv', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2021/04/job-6538214103689****.mkv?Expires=1617435462&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"job-6538214103689****.mkv\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-65382141036893491.mkv?Expires=1610910578&OSSAccessKeyId=XXXX&Signature=XXXX\\n job-65382141036893491.mkv\\n\\nOK","errorExample":""}]', - 'title' => '获取多轨录音', - 'summary' => '调用GetMultiChannelRecording获取指定实例下指定通话的多轨录音，多轨录音中坐席和客户的录音分布在不同的声道上，每次播放时只能单个声道播放，也就是只能听到其中一方的声音，格式为MKV。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetVoicemailRecording' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID，请确保该通话ID存在语音信箱留言，否则返回结果将没有数据。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-12515239414412****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'FileUrl' => [ - 'description' => '录音文件的OSS下载地址，注意下载地址的过期时间，下载地址的有效期为1天。', - 'type' => 'string', - 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****', - ], - 'FileName' => [ - 'description' => '录音文件名字。', - 'type' => 'string', - 'example' => 'voicemail.job-054ded02****.wav', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"voicemail.job-054ded02****.wav\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 200\\n 无\\n EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n \\n http://xxxx\\n abc\\n \\n","errorExample":""}]', - 'title' => '获取语音信箱录音', - 'summary' => '调用GetVoicemailRecording获取指定实例下指定通话的语音信箱留言的录音，录音为单轨录音，格式为WAV。', - ], - 'GetEarlyMediaRecording' => [ - 'summary' => '获取指定实例下的通话早媒体音频。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6538214103689****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'FileUrl' => [ - 'description' => '录音文件的OSS下载地址，注意下载地址的过期时间，下载地址的有效期为1天。', - 'type' => 'string', - 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****', - ], - 'FileName' => [ - 'description' => '录音文件名称。', - 'type' => 'string', - 'example' => 'job-6538214103689****-earlyMedia.wav', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s must not be null.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"job-6538214103689****-earlyMedia.wav\\"\\n }\\n}","type":"json"}]', - 'title' => '获取通话早媒体音频', - ], - 'ListMultiChannelRecordings' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-25920271311543****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B19CD719-9F65-56A6-8B79-DA4282EA4797', - ], - 'Data' => [ - 'description' => '录音列表。', - 'type' => 'array', - 'items' => [ - 'description' => '录音。', - 'type' => 'object', - 'properties' => [ - 'FileName' => [ - 'description' => '录音文件名称。', - 'type' => 'string', - 'example' => 'job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv', - ], - 'FileUrl' => [ - 'description' => '录音文件的OSS下载地址，注意下载地址的过期时间，下载地址的有效期为1天。', - 'type' => 'string', - 'example' => 'https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv?Expires=1657014031&OSSAccessKeyId=****&Signature=****', - ], - 'AgentId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'AgentName' => [ - 'description' => '坐席名称。', - 'type' => 'string', - 'example' => '坐席小王', - ], - 'StartTime' => [ - 'description' => '录音开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1656926518491', - ], - 'ContactId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-25920271311543****', - ], - 'Duration' => [ - 'description' => '录音时长，单位毫秒。', - 'type' => 'string', - 'example' => '56321', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'RamId' => [ - 'description' => '坐席对应的RAM账号ID。', - 'type' => 'string', - 'example' => '22807673106369****', - ], - 'AgentChannelId' => [ - 'description' => '坐席话务通道ID。', - 'type' => 'string', - 'example' => 'ch-user-8526899****-8602****-1656926504363-job-25920271311543****', - ], - 'HoldTimeSegments' => [ - 'description' => '通话保持的时间片段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '通话保持的时间片段。', - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => '通话保持的开始时间，单位是毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1673255098049', - ], - 'EndTime' => [ - 'description' => '通话保持的结束时间，单位是毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1687860143925', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B19CD719-9F65-56A6-8B79-DA4282EA4797\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv\\",\\n \\"FileUrl\\": \\"https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv?Expires=1657014031&OSSAccessKeyId=****&Signature=****\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"StartTime\\": 1656926518491,\\n \\"ContactId\\": \\"job-25920271311543****\\",\\n \\"Duration\\": \\"56321\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"RamId\\": \\"22807673106369****\\",\\n \\"AgentChannelId\\": \\"ch-user-8526899****-8602****-1656926504363-job-25920271311543****\\",\\n \\"HoldTimeSegments\\": [\\n {\\n \\"StartTime\\": 1673255098049,\\n \\"EndTime\\": 1687860143925\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取多通道录音列表', - 'summary' => '调用ListMultiChannelRecordings获取指定实例下指定通话的各通话方的多轨录音，通话中每一方都有一个话务通道，每个话务通道对应一个多轨录音，格式为MKV。', - ], - 'ListMonoRecordings' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-25697383427137****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E836EF2A-EDAE-5310-8921-F983C967D42D', - ], - 'Data' => [ - 'description' => '录音信息列表。', - 'type' => 'array', - 'items' => [ - 'description' => '录音信息。', - 'type' => 'object', - 'properties' => [ - 'FileName' => [ - 'description' => '录音文件名称。', - 'type' => 'string', - 'example' => 'job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav', - ], - 'FileUrl' => [ - 'description' => '录音文件的OSS下载地址，注意下载地址的过期时间，下载地址的有效期为1天。', - 'type' => 'string', - 'example' => 'https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav?Expires=1657014031&OSSAccessKeyId=****&Signature=****', - ], - 'AgentId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'AgentName' => [ - 'description' => '坐席名称。', - 'type' => 'string', - 'example' => '坐席小王', - ], - 'StartTime' => [ - 'description' => '录音开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'string', - 'example' => '1620259200000', - ], - 'ContactId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-25920271311543****', - ], - 'Duration' => [ - 'description' => '录音时长，单位毫秒。', - 'type' => 'string', - 'example' => '5903871', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup@ccc-test', - ], - 'RamId' => [ - 'description' => '坐席对应的RAM账号ID。', - 'type' => 'string', - 'example' => '26972543893791****', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E836EF2A-EDAE-5310-8921-F983C967D42D\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav\\",\\n \\"FileUrl\\": \\"https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav?Expires=1657014031&OSSAccessKeyId=****&Signature=****\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"StartTime\\": \\"1620259200000\\",\\n \\"ContactId\\": \\"job-25920271311543****\\",\\n \\"Duration\\": \\"5903871\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"RamId\\": \\"26972543893791****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取单轨录音列表', - 'summary' => '调用ListMonoRecordings获取指定实例下指定通话的各通话方的单轨录音，通话中每一方都有一个话务通道，每个话务通道对应生成一个合轨录音，格式为WAV。', - ], - 'CreateAudioFile' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '音频展示名，长度为1-32的字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '欢迎语', - ], - ], - [ - 'name' => 'AudioFileName', - 'in' => 'query', - 'schema' => [ - 'description' => '音频文件名称，长度为1-32个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-file.wav', - ], - ], - [ - 'name' => 'OssFileKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'OSS文件的Key，由GetAudioFileUploadParameters接口返回。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test/test-file.wav', - ], - ], - [ - 'name' => 'Usage', - 'in' => 'query', - 'schema' => [ - 'description' => '音频文件用途，默认为General（用于IVR等场景）, 其他可选值为HoldMusic（通话保持等待音）。', - 'type' => 'string', - 'required' => false, - 'example' => 'General', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据，音频资源的ID，唯一标识一个音频资源。', - 'type' => 'string', - 'example' => '2301b83f-1f9f-491e-9f97-2f832ed92f0b', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '94E29B9B-DBC6-5951-B3DD-C85C1BDF20ED', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"2301b83f-1f9f-491e-9f97-2f832ed92f0b\\",\\n \\"RequestId\\": \\"94E29B9B-DBC6-5951-B3DD-C85C1BDF20ED\\"\\n}","type":"json"}]', - 'title' => '创建音频文件', - 'summary' => '调用CreateAudioFile在指定实例下创建一个音频资源，创建好的音频资源可以在实例中应用，比如在IVR放音时可以选择创建好的音频文件。', - ], - 'DeleteAudioFile' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'AudioResourceId', - 'in' => 'query', - 'schema' => [ - 'description' => '音频资源ID，音频文件的唯一标识。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FB77821C-912F-57FF-8834-6336A6479093', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"FB77821C-912F-57FF-8834-6336A6479093\\"\\n}","type":"json"}]', - 'title' => '删除音频文件', - 'summary' => '调用DeleteAudioFile删除指定实例下指定音频资源ID对应的音频文件。', - ], - 'GetAudioFile' => [ - 'summary' => '调用GetAudioFile获取指定实例下指定音频资源ID对应的音频文件信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'AudioResourceId', - 'in' => 'query', - 'schema' => [ - 'description' => '音频资源ID，音频文件的唯一标识。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c1a06b46-302a-4c6e-928b-a43c0df485cf', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'EEE26562-D921-5CB2-AE49-E4C45A42D432', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '音频文件数据。', - 'type' => 'object', - 'properties' => [ - 'AudioFileName' => [ - 'description' => '音频文件名称。', - 'type' => 'string', - 'example' => 'test-file.wav', - ], - 'OssFileKey' => [ - 'description' => '音频资源文件在OSS中的Key。', - 'type' => 'string', - 'example' => 'ccc-test/test-file.wav', - ], - 'UpdatedTime' => [ - 'description' => '音频资源的最后修改时间。', - 'type' => 'string', - 'example' => '2021-07-14 10:48:43.0', - ], - 'AudioResourceId' => [ - 'description' => '音频资源ID，音频文件的唯一标识。', - 'type' => 'string', - 'example' => 'c1a06b46-302a-4c6e-928b-a43c0df485cf', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Name' => [ - 'description' => '音频展示名。', - 'type' => 'string', - 'example' => '欢迎语'."\n", - ], - 'CreatedTime' => [ - 'description' => '音频资源的创建时间。', - 'type' => 'string', - 'example' => '2021-07-14 10:48:43.0', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"EEE26562-D921-5CB2-AE49-E4C45A42D432\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"AudioFileName\\": \\"test-file.wav\\",\\n \\"OssFileKey\\": \\"ccc-test/test-file.wav\\",\\n \\"UpdatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"AudioResourceId\\": \\"c1a06b46-302a-4c6e-928b-a43c0df485cf\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"欢迎语\\\\n\\",\\n \\"CreatedTime\\": \\"2021-07-14 10:48:43.0\\"\\n }\\n}","type":"json"}]', - 'title' => '获取音频文件', - ], - 'GetAudioFileDownloadUrl' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'AudioResourceId', - 'in' => 'query', - 'schema' => [ - 'description' => '音频资源ID，唯一标识一个音频文件。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acc300c4-75c9-41ba-ba5e-2a365c96c248', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据，音频资源文件的OSS下载链接，请注意，下载链接的有效期为24小时，请勿长期存储该链接。', - 'type' => 'string', - 'example' => 'https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/****.wav?Expires=1656472158&OSSAccessKeyId=****&Signature=****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/****.wav?Expires=1656472158&OSSAccessKeyId=****&Signature=****\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\"\\n}","type":"json"}]', - 'title' => '获取音频文件下载链接', - 'summary' => '调用GetAudioFileDownloadUrl获取指定实例下指定音频资源的OSS下载链接。', - ], - 'GetAudioFileUploadParameters' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'AudioFileName', - 'in' => 'query', - 'schema' => [ - 'description' => '音频文件名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-file.wav', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C81FD1A5-4B99-470A-A527-D80150228784', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'FilePath' => [ - 'description' => 'OSS文件的Key。', - 'type' => 'string', - 'example' => 'ccc-test/test-file.wav', - ], - 'Signature' => [ - 'description' => '文件上传临时凭证的签名信息，用于上传时验证合法性。', - 'type' => 'string', - 'example' => 'HIyClras8IcVlbTV7RIJWJbU****', - ], - 'Host' => [ - 'description' => 'OSS的接入域名。', - 'type' => 'string', - 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com', - ], - 'Policy' => [ - 'description' => '签名策略。', - 'type' => 'string', - 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMi0wNi0yOVQwMDoyOTowMC42NTRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiYXVkaW8vMTU3NzI0NzExNTQ5MDQwMS9seS1vbmxpbmUvMjAyMjA2MjkwNzI5MDAvIl1d****', - ], - 'ExpireTime' => [ - 'description' => '过期时间。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1647313420', - ], - 'AccessKeyId' => [ - 'description' => '签名使用的AccessKeyId。', - 'type' => 'string', - 'example' => '****', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C81FD1A5-4B99-470A-A527-D80150228784\\",\\n \\"Data\\": {\\n \\"FilePath\\": \\"ccc-test/test-file.wav\\",\\n \\"Signature\\": \\"HIyClras8IcVlbTV7RIJWJbU****\\",\\n \\"Host\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyMi0wNi0yOVQwMDoyOTowMC42NTRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiYXVkaW8vMTU3NzI0NzExNTQ5MDQwMS9seS1vbmxpbmUvMjAyMjA2MjkwNzI5MDAvIl1d****\\",\\n \\"ExpireTime\\": 1647313420,\\n \\"AccessKeyId\\": \\"****\\"\\n }\\n}","type":"json"}]', - 'title' => '获取音频文件上传参数', - 'summary' => '调用GetAudioFileUploadParameters获取音频文件上传参数，创建音频文件时，需要先调用该接口拿到上传参数，然后再调用CreateAudioFile创建音频文件。该接口通常由云联络中心提供的公有云默认CRM系统调用，不建议集成客户调用该接口，因为需要在页面上操作上传文件，上传完成后，才能调用GetAudioFileUploadParameters接口。', - ], - 'ListAudioFiles' => [ - 'summary' => '调用ListAudioFiles获取指定实例下的音频文件列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'Converting（转换中） '."\n" - .'Completed（转换完成） '."\n" - .'Failed（转换失败） '."\n" - .'参数不传，查询所有状态。', - 'type' => 'string', - 'required' => false, - 'example' => 'Completed', - ], - ], - [ - 'name' => 'Usage', - 'in' => 'query', - 'schema' => [ - 'description' => '音频文件用途，默认为General（用于IVR等场景）， 其他可选值为HoldMusic（通话保持等待音）。', - 'type' => 'string', - 'required' => false, - 'example' => 'General', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '53223330-EBF1-586B-A2CB-93C3B711FDA0', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'List' => [ - 'description' => '音频文件列表。', - 'type' => 'array', - 'items' => [ - 'description' => '音频文件信息。', - 'type' => 'object', - 'properties' => [ - 'AudioFileName' => [ - 'description' => '音频文件名称。', - 'type' => 'string', - 'example' => 'test-file.wav', - ], - 'OssFileKey' => [ - 'description' => '音频资源文件在OSS中的Key。', - 'type' => 'string', - 'example' => 'ccc-test/test-file.wav', - ], - 'UpdatedTime' => [ - 'description' => '音频资源的最后修改时间。', - 'type' => 'string', - 'example' => '2021-03-08 15:34:49.0', - ], - 'AudioResourceId' => [ - 'description' => '音频资源ID，音频文件的唯一标识。', - 'type' => 'string', - 'example' => 'd5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Name' => [ - 'description' => '音频资源的展示名。', - 'type' => 'string', - 'example' => '欢迎语', - ], - 'CreatedTime' => [ - 'description' => '音频资源的创建时间。', - 'type' => 'string', - 'example' => '2021-03-05 17:35:45.0', - ], - 'Status' => [ - 'description' => '音频文件状态。', - 'type' => 'string', - 'example' => 'Completed', - ], - 'Usage' => [ - 'description' => '音频文件用途，默认为General（用于IVR等场景）， 其他可选值为HoldMusic（通话保持等待音）。', - 'type' => 'string', - 'example' => 'General', - ], - 'AuditResult' => [ - 'description' => '音频内容风险审核结果。', - 'type' => 'string', - 'example' => '无', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"53223330-EBF1-586B-A2CB-93C3B711FDA0\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"AudioFileName\\": \\"test-file.wav\\",\\n \\"OssFileKey\\": \\"ccc-test/test-file.wav\\",\\n \\"UpdatedTime\\": \\"2021-03-08 15:34:49.0\\",\\n \\"AudioResourceId\\": \\"d5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"欢迎语\\",\\n \\"CreatedTime\\": \\"2021-03-05 17:35:45.0\\",\\n \\"Status\\": \\"Completed\\",\\n \\"Usage\\": \\"General\\",\\n \\"AuditResult\\": \\"无\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取音频文件列表', - ], - 'ModifyAudioFile' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'AudioResourceId', - 'in' => 'query', - 'schema' => [ - 'description' => '音频资源ID，唯一标识一个音频文件。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'acc300c4-75c9-41ba-ba5e-2a365c96c248', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '音频文件的展示名，长度为1-32个字符，修改音频文件时无法修改展示名，因此此处需要填写音频文件原始的展示名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '欢迎语', - ], - ], - [ - 'name' => 'OssFileKey', - 'in' => 'query', - 'schema' => [ - 'description' => '待修改的音频文件在OSS中的Key。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test/new-test-file.wav', - ], - ], - [ - 'name' => 'AudioFileName', - 'in' => 'query', - 'schema' => [ - 'description' => '待修改的音频文件名称，可以填写新的音频文件内容。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'new-test-file.wav', - ], - ], - [ - 'name' => 'Usage', - 'in' => 'query', - 'schema' => [ - 'description' => '音频文件用途，默认为General（用于IVR等场景）， 其他可选值为HoldMusic（通话保持等待音）。', - 'type' => 'string', - 'required' => false, - 'example' => 'General', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D2F84AAC-7C79-547F-8EE9-7B735F42B93F', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D2F84AAC-7C79-547F-8EE9-7B735F42B93F\\"\\n}","type":"json"}]', - 'title' => '修改音频文件', - 'summary' => '调用ModifyAudioFile修改指定实例下指定音频资源ID对应的音频文件。可以修改音频文件名称、音频文件展示名和音频文件在OSS中的Key。', - ], - 'GetLoginDetails' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID，非必填，不填则默认使用当前RAM账户映射的坐席。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], - ], - [ - 'name' => 'ChatDeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Chat设备ID。', - 'type' => 'string', - 'required' => false, - 'example' => '4c51c9116c36537cb850dc1081d745df', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F1A4774A-F28B-5C40-AEF6-D88D2DD6C7E4', - ], - 'Params' => [ - 'description' => '响应参数', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - 'Data' => [ - 'description' => '登录信息数据。', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '坐席展示名。', - 'type' => 'string', - 'example' => '坐席小王', - ], - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8001****', - ], - 'Signature' => [ - 'description' => '签名信息，使用非对称加密算法生成，注册SIP服务器时需要使用该信息进行鉴权。', - 'type' => 'string', - 'example' => 'zi31STIMtIfa/UN2l+6lww****', - ], - 'SipServerUrl' => [ - 'description' => 'SIP注册服务器地址，坐席需要以SIP用户的身份注册到服务器上才能进行话务操作。', - 'type' => 'string', - 'example' => 'sh-sip-ccc.aliyuncs.com:443', - ], - 'DeviceId' => [ - 'description' => '如果座席注册了SIP话机，则此参数是SIP话机设备的设备ID，否则为空。', - 'type' => 'string', - 'example' => 'Yealink SIP-T23G 44.84.XX.XX', - ], - 'AgentServerUrl' => [ - 'description' => '坐席数据推送服务器地址，连接成功后，服务器会推送坐席状态数据到坐席工作台。', - 'type' => 'string', - 'example' => 'sh-wss-ccc.aliyuncs.com', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'agent@ccc-test', - ], - 'UserKey' => [ - 'description' => '签名数据，用于生成签名信息，由于该签名机制不支持中文，所以目前都使用UserKey2进行签名。', - 'type' => 'string', - 'example' => '坐席@aliyun:802001:1656406628862', - ], - 'WorkMode' => [ - 'description' => '工作模式。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ON_SITE' => '场内模式', - 'OFF_SITE' => '场外模式', - 'OFFICE_PHONE' => '办公电话模式', - ], - 'example' => 'ON_SITE', - ], - 'UserKey2' => [ - 'description' => '签名数据，用于生成签名信息，由于UserKey不支持中文签名，因此新增了UserKey2。', - 'type' => 'string', - 'example' => '802001:1656406628862"', - ], - 'Signature2' => [ - 'description' => '签名信息，使用非对称加密算法生成，注册SIP服务器时需要使用该信息进行鉴权。', - 'type' => 'string', - 'example' => 'zi31STIMtIfa/UN2l+6lww****', - ], - 'DeviceExt' => [ - 'description' => 'SIP设备分机号，使用SIP话机时需要用到该字段。', - 'type' => 'string', - 'example' => '8033****', - ], - 'DeviceState' => [ - 'description' => 'SIP设备状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'UNREGISTERED' => '未注册', - 'ONLINE' => '在线', - 'OFFLINE' => '离线', - ], - 'example' => 'OFFLINE', - ], - 'ChatUserId' => [ - 'description' => 'Chat会话设备ID。', - 'type' => 'string', - 'example' => 'A-8000100x', - ], - 'ChatDeviceId' => [ - 'description' => 'Chat设备ID。', - 'type' => 'string', - 'example' => '4c51c9116c36537cb850dc1081d745df', - ], - 'ChatLoginToken' => [ - 'description' => 'Chat会话登录令牌。', - 'type' => 'string', - 'example' => '{"accessToken":"oauth_cloud_key:4xxx0=","accessTokenExpiredTime":864xxxx,"refreshToken":"oauth_cloud_key:Paxxxx=="}', - ], - 'ChatAppId' => [ - 'description' => 'Chat会话应用ID。', - 'type' => 'string', - 'example' => '7pjxxx', - ], - 'ChatAppKey' => [ - 'description' => 'Chat会话应用密钥。', - 'type' => 'string', - 'example' => '955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0', - ], - 'ChatServerUrl' => [ - 'description' => 'Chat会话服务器地址。', - 'type' => 'string', - 'example' => 'wss://wss.im.dingtalk.cn', - ], - 'Nickname' => [ - 'description' => '坐席昵称', - 'type' => 'string', - 'example' => '老王', - ], - 'AvatarUrl' => [ - 'description' => '坐席头像地址。', - 'type' => 'string', - 'example' => 'http://abc.com/sam.jpb', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"F1A4774A-F28B-5C40-AEF6-D88D2DD6C7E4\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"Extension\\": \\"8001****\\",\\n \\"Signature\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"SipServerUrl\\": \\"sh-sip-ccc.aliyuncs.com:443\\",\\n \\"DeviceId\\": \\"Yealink SIP-T23G 44.84.XX.XX\\",\\n \\"AgentServerUrl\\": \\"sh-wss-ccc.aliyuncs.com\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"UserKey\\": \\"坐席@aliyun:802001:1656406628862\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"UserKey2\\": \\"802001:1656406628862\\\\\\"\\",\\n \\"Signature2\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"DeviceExt\\": \\"8033****\\",\\n \\"DeviceState\\": \\"OFFLINE\\",\\n \\"ChatUserId\\": \\"A-8000100x\\",\\n \\"ChatDeviceId\\": \\"4c51c9116c36537cb850dc1081d745df\\",\\n \\"ChatLoginToken\\": \\"{\\\\\\"accessToken\\\\\\":\\\\\\"oauth_cloud_key:4xxx0=\\\\\\",\\\\\\"accessTokenExpiredTime\\\\\\":864xxxx,\\\\\\"refreshToken\\\\\\":\\\\\\"oauth_cloud_key:Paxxxx==\\\\\\"}\\",\\n \\"ChatAppId\\": \\"7pjxxx\\",\\n \\"ChatAppKey\\": \\"955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0\\",\\n \\"ChatServerUrl\\": \\"wss://wss.im.dingtalk.cn\\",\\n \\"Nickname\\": \\"老王\\",\\n \\"AvatarUrl\\": \\"http://abc.com/sam.jpb\\"\\n }\\n}","type":"json"}]', - 'title' => '获取登录信息', - 'summary' => '调用GetLoginDetails获取坐席的登录信息，包括坐席基本信息、服务器地址信息、鉴权信息等，该接口只允许自己调用，管理员无权替他人调用。', - ], - 'GetTurnCredentials' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '坐席ID，非必填，不填则默认使用当前RAM账户映射的坐席。', - 'type' => 'string', - 'required' => false, - 'example' => 'agent@ccc-test', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'UserName' => [ - 'description' => '用户名。', - 'type' => 'string', - 'example' => '1602585817:****', - ], - 'Password' => [ - 'description' => '密码。', - 'type' => 'string', - 'example' => 'M0NQNG/uRUrfIxW7er/S9gKX****', - ], - ], - ], - 'Params' => [ - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"UserName\\": \\"1602585817:****\\",\\n \\"Password\\": \\"M0NQNG/uRUrfIxW7er/S9gKX****\\"\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n 1602585817:null\\n M0NQNG/uRUrfIxW7er/S9gKXsT0=\\n\\nOK","errorExample":""}]', - 'title' => '获取接入点凭证', - 'summary' => '调用GetTurnCredentials获取云联络中心前置接入点的连接凭证信息，主要包括鉴权需要用到的用户名和密码，通过前置接入点接入云联络中心可以有效提高网络质量和稳定性。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetTurnServerList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '数据，前置接入点服务器信息列表。', - 'type' => 'string', - 'example' => '['."\n" - .' {'."\n" - .' "region":"hangzhou",'."\n" - .' "name":"杭州",'."\n" - .' "domain":"turn-hz-ecs.ccc.aliyuncs.com",'."\n" - .' "cidr":"172.31.XX.XX/28"'."\n" - .' },'."\n" - .' {'."\n" - .' "region":"qingdao",'."\n" - .' "name":"青岛",'."\n" - .' "domain":"turn-qd-ecs.ccc.aliyuncs.com",'."\n" - .' "cidr":"172.31.XX.XX/28"'."\n" - .' },'."\n" - .' {'."\n" - .' "region":"shanghai",'."\n" - .' "name":"上海",'."\n" - .' "domain":"turn-sh-ecs.ccc.aliyuncs.com",'."\n" - .' "cidr":"172.31.XX.XX/28"'."\n" - .' },'."\n" - .' {'."\n" - .' "region":"chengdu",'."\n" - .' "name":"成都",'."\n" - .' "domain":"turn-cd-ecs.ccc.aliyuncs.com",'."\n" - .' "cidr":"172.31.XX.XX/28"'."\n" - .' },'."\n" - .' {'."\n" - .' "region":"beijing",'."\n" - .' "name":"北京",'."\n" - .' "domain":"turn-bj-ecs.ccc.aliyuncs.com",'."\n" - .' "cidr":"172.31.XX.XX/28"'."\n" - .' },'."\n" - .' {'."\n" - .' "region":"huanan",'."\n" - .' "name":"深圳",'."\n" - .' "domain":"turn-sz-ecs.ccc.aliyuncs.com",'."\n" - .' "cidr":"172.31.XX.XX/28"'."\n" - .' },'."\n" - .' {'."\n" - .' "region":"zhangbei",'."\n" - .' "name":"张北",'."\n" - .' "domain":"turn-zb-ecs.ccc.aliyuncs.com",'."\n" - .' "cidr":"172.31.XX.XX/28"'."\n" - .' }'."\n" - .']', - ], - 'Params' => [ - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"[\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"杭州\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-hz-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"qingdao\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"青岛\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-qd-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"shanghai\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"上海\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-sh-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"chengdu\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"成都\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-cd-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"beijing\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"北京\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-bj-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"huanan\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"深圳\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-sz-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"zhangbei\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"张北\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-zb-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t}\\\\n]\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取接入点列表', - 'summary' => '调用GetTurnServerList获取云联络中心的前置接入点列表，通过前置接入点接入云联络中心可以有效提高网络质量和网络稳定性。', - ], - 'ListConfigItems' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'ObjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '配置信息所属的对象的ID，可以是阿里云主账号ID、实例ID、技能组ID、坐席ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'ObjectType', - 'in' => 'query', - 'schema' => [ - 'description' => ' 配置信息所属对象的类型。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'INSTANCE' => '实例级别的配置', - 'USER' => '座席自身的配置', - 'SKILL_GROUP' => '技能组级别的配置', - 'ALIYUN_UID' => '主账号级别的配置', - ], - 'example' => 'INSTANCE', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - 'Data' => [ - 'description' => '配置项列表。', - 'type' => 'array', - 'items' => [ - 'description' => '配置项。', - 'type' => 'object', - 'properties' => [ - 'ObjectId' => [ - 'description' => '配置信息所属的对象的ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Value' => [ - 'description' => '配置项的值。', - 'type' => 'string', - 'example' => '100', - ], - 'ObjectType' => [ - 'description' => '配置信息所属对象的类型。', - 'type' => 'string', - 'example' => 'INSTANCE', - ], - 'InstanceId' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Name' => [ - 'description' => '配置项名称，配置项名称包含系统定义和客户自定义两种，系统定义包括是否允许坐席挂机、是否自动接听、久振未接时长等，这部分配置项名称是固定的，值可以由客户自定义，除此之外，配置项名称也支持客户自定义，客户可以根据需要添加配置项。', - 'type' => 'string', - 'enumValueTitles' => [ - 'AllowAudioDownload' => '是否允许坐席下载录音，取值：0（不允许）、1（允许）。', - 'RecordingStorageSetting' => '实例录音存储配置。', - 'AllowChooseSignedSkillGroup' => '坐席上线前是否手动选择签入的技能组，取值：0（自动签入所属的全部技能组）、1（手动选择签入的技能组）。', - 'AgentRingingTimeoutSeconds' => '坐席久振未接超时时长配置，取值范围为5-90，单位秒。', - 'ShowCalledID' => '坐席来电显示，取值：-1（隐藏全部来电号码）、0（隐藏部分来电号码）、1（显示完整来电号码）。', - 'ShowCalleeID' => '坐席外呼显示，取值：-1（隐藏全部外呼号码）、0（隐藏部分外呼号码）、1（显示完整外呼号码）。', - 'AllowHangup' => '坐席呼入挂机方式，取值：0（不允许坐席挂机）、1（允许坐席挂机）。', - 'AutoAnswerCall' => '坐席接听来电方式，取值：-1（手动接听）、n（振铃n秒后接听）。', - ], - 'example' => 'config-item', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Permission.Unauthorized', - 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', - ], - ], - [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": [\\n {\\n \\"ObjectId\\": \\"ccc-test\\",\\n \\"Value\\": \\"100\\",\\n \\"ObjectType\\": \\"INSTANCE\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"config-item\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n 1\\n INSTANCE\\n ccc-test\\n ccc-test\\n test-item\\n\\nOK","errorExample":""}]', - 'title' => '获取配置项列表', - 'summary' => '调用ListConfigItems获取指定实例下的配置信息。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateConfigItems' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'ObjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '配置信息所属的对象的ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'ObjectType', - 'in' => 'query', - 'schema' => [ - 'description' => '配置信息所属对象的类型。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'INSTANCE', - ], - ], - [ - 'name' => 'ConfigItems', - 'in' => 'query', - 'schema' => [ - 'description' => '配置项列表，格式为JSON数组的字符串，数组元素是一个对象，该对象包含两个字段，name，value，name是配置项的名称，value是配置项的值。配置项名称包含系统定义和客户自定义两种，系统定义包括是否允许坐席挂机、是否自动接听、久振未接时长等，这部分配置项名称是固定的，值可以由客户自定义，除此之外，配置项名称也支持客户自定义，客户可以根据需要添加配置项。'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'AllowAudioDownload' => '是否允许坐席下载录音，取值：0（不允许）、1（允许）。', - 'RecordingStorageSetting' => '实例录音存储配置。', - 'AllowChooseSignedSkillGroup' => '坐席上线前是否手动选择签入的技能组，取值：0（自动签入所属的全部技能组）、1（手动选择签入的技能组）。', - 'AgentRingingTimeoutSeconds' => '坐席久振未接超时时长，取值范围为5-90，单位秒。', - 'ShowCalledID' => '坐席来电显示，取值：-1（隐藏全部来电号码）、0（隐藏部分来电号码）、1（显示完整来电号码）。', - 'ShowCalleeID' => '坐席外呼显示，取值：-1（隐藏全部外呼号码）、0（隐藏部分外呼号码）、1（显示完整外呼号码）。', - 'AllowHangup' => '坐席呼入挂机方式，取值：0（不允许坐席挂机）、1（允许坐席挂机）。', - 'AutoAnswerCall' => '坐席接听来电方式，取值：-1（手动接听）、n（振铃n秒后接听）。', - ], - 'example' => '[{"name":"ShowCalledID","value":"-1"},{"name":"ShowCalleeID","value":"1"},{"name":"AllowHangup","value":"0"},{"name":"AutoAnswerCall","value":"-1"},{"name":"AllowAudioDownload","value":"1"},{"name":"AllowChooseSignedSkillGroup","value":"1"}]', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8E7Y5B39-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'Params' => [ - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"8E7Y5B39-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"8E7Y5B39-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\nOK","errorExample":""}]', - 'title' => '更新配置项', - 'summary' => '调用UpdateConfigItems添加或修改指定实例下的配置信息，例如：来电显示是否隐藏号码，呼入场景下是否允许坐席主动挂机等。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ProcessCustomIMCallback' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '263383', - 'abilityTreeNodes' => [ - 'FEATUREcccD72NOC', - ], - ], - 'parameters' => [ - [ - 'name' => 'AccessChannelId', - 'in' => 'formData', - 'schema' => [ - 'description' => '网络业务渠道ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cf584733-***-***-9699-cb77aa3b7aa6', - ], - ], - [ - 'name' => 'ConversationId', - 'in' => 'formData', - 'schema' => [ - 'description' => '会话id', - 'type' => 'string', - 'required' => true, - 'example' => 'd165de4f-9851-445e-9535-66ebfa72fa51', - ], - ], - [ - 'name' => 'SenderId', - 'in' => 'formData', - 'schema' => [ - 'description' => '消息发送者用户ID。', - 'type' => 'string', - 'required' => true, - 'example' => '63061274befd6b545aab4c83', - ], - ], - [ - 'name' => 'SenderName', - 'in' => 'formData', - 'schema' => [ - 'description' => '发送者名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'tom', - ], - ], - [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID', - 'type' => 'string', - 'required' => false, - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], - ], - [ - 'name' => 'SenderAvatarMediaId', - 'in' => 'formData', - 'schema' => [ - 'description' => '头像id', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxx', - ], - ], - [ - 'name' => 'MessageContent', - 'in' => 'formData', - 'schema' => [ - 'description' => '消息内容', - 'type' => 'string', - 'required' => true, - 'example' => '消息内容，格式如下：'."\n" - ."\n\n" - .'文本消息：'."\n" - .'{ "contentType":"Text", "text":"你好 " }'."\n" - ."\n" - .'图片消息：'."\n" - .'{ "contentType":"Image", "mediaId": "xxx-xxx-xxx", "fileType": "png", "fileSize": 1233 }'."\n" - ."\n" - .'视频消息：'."\n" - .'{ "contentType":"Video", "mediaId": "xxx-xxx-xxx" "duration": 12, "fileSize": 1233, }'."\n" - ."\n" - .'音频消息：'."\n" - .'{ "contentType":"Audio", "mediaId": "xxx-xxx-xxx" "duration": 12, "fileSize": 1233 }'."\n" - ."\n" - .'文件消息：'."\n" - .'{ "contentType":"File", "mediaId": "xxx-xxx-xxx", "fileSize": 223232, "filename": "xyz. zip" }', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ProcessDingTalkRobotCallbackResponse', - 'description' => 'ProcessDingTalkRobotCallbackResponse', - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'chat-65382141036853491', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '响应参数。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '[\'OFFLINE\', \'BREAK,READY,WORKING\']', - ], - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'string', - 'example' => '无', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": \\"chat-65382141036853491\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"[\'OFFLINE\', \'BREAK,READY,WORKING\']\\"\\n ],\\n \\"Data\\": \\"无\\"\\n}","type":"json"}]', - 'title' => '第三方IM消息回调', - ], - 'CreateChatMediaUrl' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '263385', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], - ], - 'parameters' => [ - [ - 'name' => 'MimeType', - 'in' => 'formData', - 'schema' => [ - 'title' => 'media id', - 'description' => 'media id', - 'type' => 'string', - 'required' => true, - 'example' => 'jpg', - ], - ], - [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'required' => false, - 'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '云联络中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'GetChatMediaUrlResponse', - 'description' => 'GetChatMediaUrlResponse', - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'MediaId' => [ - 'description' => '媒体ID。', - 'type' => 'string', - 'example' => '$iAHNCNQCo21wMwMGBAAFAAbaACOEAaQhIH6TAqogDGyb-qD2Hbj0A88AAAGRLKYVnwTOACwwYwcACM8AAAGRLRPynQ', - ], - 'Url' => [ - 'description' => '文件url', - 'type' => 'string', - 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****', - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '响应参数。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '[\'OFFLINE\', \'BREAK,READY,WORKING\']', - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"MediaId\\": \\"$iAHNCNQCo21wMwMGBAAFAAbaACOEAaQhIH6TAqogDGyb-qD2Hbj0A88AAAGRLKYVnwTOACwwYwcACM8AAAGRLRPynQ\\",\\n \\"Url\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****\\"\\n },\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"[\'OFFLINE\', \'BREAK,READY,WORKING\']\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取媒体文件上传地址', - ], - 'ListVisitorChatMessages' => [ - 'summary' => '使用ListVisitorChatMessages获取访客聊天记录。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'SortOrder', - 'in' => 'query', - 'schema' => [ - 'description' => '排序方式，默认为降序。'."\n" - ."\n" - .'枚举值：'."\n" - ."\n" - .'ASC：升序。'."\n" - ."\n" - .'DESC：降序。', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例。', - 'type' => 'string', - 'required' => false, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'VisitorId', - 'in' => 'query', - 'schema' => [ - 'description' => '访客ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'fcd020fe-****-1a272a174a7d', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '开始时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1647325450000', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '结束时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'string', - 'required' => false, - 'example' => '1650316799000', - ], - ], - [ - 'name' => 'NextPageToken', - 'in' => 'query', - 'schema' => [ - 'description' => '下一页标识。第一次请求无需传入，服务会返回，第二次请求传入即可。', - 'type' => 'string', - 'required' => false, - 'example' => '1737193352340::7463707254.EAUNIT', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页每页数据集大小。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'AccessToken', - 'in' => 'query', - 'schema' => [ - 'description' => '网络业务渠道Token。', - 'type' => 'string', - 'required' => false, - 'example' => '9XYGTGWtq2wXzVikKuip_zeVGl6O4VJ-l-*-*-JPofhap4P7fAevuE=', - ], - ], - [ - 'name' => 'AccessChannelId', - 'in' => 'query', - 'schema' => [ - 'description' => '网络业务渠道ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cf584733-***-***-9699-cb77aa3b7aa6', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '8707EB29-BAED-4302-B999-40BA61877437', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'NextPageToken' => [ - 'description' => '下一页标识。', - 'type' => 'string', - 'example' => '1737193352340::7463707254.EAUNIT'."\n", - ], - 'Messages' => [ - 'description' => '消息列表。', - 'type' => 'array', - 'items' => [ - 'description' => '消息。', - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'example' => 'chat-65382141036853491', - ], - 'SenderId' => [ - 'description' => '消息发送用户ID。', - 'type' => 'string', - 'example' => 'fcd020fe-****-1a272a174a7d'."\n", - ], - 'SenderType' => [ - 'description' => '发送方类型。'."\n" - ."\n" - .'枚举值'."\n" - .'- **ADMIN**：系统'."\n" - .'- **CUSTOMER**：访客'."\n" - .'- **AGENT**：坐席', - 'type' => 'string', - 'example' => 'CUSTOMER', - ], - 'Timestamp' => [ - 'description' => '时间戳。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1696126980371', - ], - 'Content' => [ - 'description' => '消息内容。', - 'type' => 'string', - 'example' => '{"variables":{},"text":"Hi，我是小云~ 很高兴遇见你！","contentType":"Text"}', - ], - 'SenderName' => [ - 'description' => '发送者名称。', - 'type' => 'string', - 'example' => '访客1', - ], - 'SenderAvatarUrl' => [ - 'description' => '发送者头像地址。', - 'type' => 'string', - 'example' => 'http://xxxxx.com/avatar.png', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Permission.Unauthorized', - 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"NextPageToken\\": \\"1737193352340::7463707254.EAUNIT\\\\n\\",\\n \\"Messages\\": [\\n {\\n \\"JobId\\": \\"chat-65382141036853491\\",\\n \\"SenderId\\": \\"fcd020fe-****-1a272a174a7d\\\\n\\",\\n \\"SenderType\\": \\"CUSTOMER\\",\\n \\"Timestamp\\": 1696126980371,\\n \\"Content\\": \\"{\\\\\\"variables\\\\\\":{},\\\\\\"text\\\\\\":\\\\\\"Hi，我是小云~ 很高兴遇见你！\\\\\\",\\\\\\"contentType\\\\\\":\\\\\\"Text\\\\\\"}\\",\\n \\"SenderName\\": \\"访客1\\",\\n \\"SenderAvatarUrl\\": \\"http://xxxxx.com/avatar.png\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取访客聊天记录', - ], - 'GetChatRoutingProfile' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'RoutingType' => [ - 'description' => '话务分配类型。'."\n" - .'- 自动分配(Automatic)。'."\n" - .'- 手动分配(Manual)。', - 'type' => 'string', - 'example' => 'Automatic', - ], - 'AgentConcurrencySettings' => [ - 'description' => '坐席会话并发配置。'."\n" - .'- AllowExceedingLimitWhenTransferring，转接时是否允许超出上限，向其他坐席转接会话时，允许超出对方上限数量，但最多不能超过30个。'."\n" - .'- AllowExceedingLimitWhenClaiming，认领时是否允许超出上限，坐席从队列中主动认领会话时，允许超出上限数量，但最多不能超过30个。'."\n" - .'- ConcurrencyLimit，允许坐席同时处理的网络业务会话数量。'."\n" - .'- Enabled，是否启用该配置。', - 'type' => 'string', - 'example' => '{'."\n" - .' "AllowExceedingLimitWhenTransferring": false,'."\n" - .' "ConcurrencyLimit": 4,'."\n" - .' "AllowExceedingLimitWhenClaiming": true,'."\n" - .' "Enabled": true'."\n" - .'}', - ], - 'DistributionSettings' => [ - 'description' => '坐席会话分配配置。'."\n" - .'- AgentRingTimeoutSeconds，坐席处理超时限制。'."\n" - .'- MaxNumberOfConversationsAgentCanMiss，允许坐席最多连续未响应的会话数量。'."\n" - .'- PostAgentMissingConversionsAction，坐席连续未响应超过设置的数量后，系统设置的作息状态，如小休Break, 隐身Invisible，保持不变Nothing;'."\n" - .'- Enabled，是否启用。', - 'type' => 'string', - 'example' => '{'."\n" - .' "AgentRingTimeoutSeconds": 30,'."\n" - .' "Enabled": true,'."\n" - .' "MaxNumberOfConversationsAgentCanMiss": 5,'."\n" - .' "PostAgentMissingConversionsAction": "Nothing"'."\n" - .'}', - ], - 'ChatSettings' => [ - 'description' => '会话配置。'."\n" - .'- IdleChatTimeoutSeconds，会话自动结束时间，特定时间内未收到客户响应，则系统结束会话，单位秒。', - 'type' => 'string', - 'example' => '{"IdleChatTimeoutSeconds":300}', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s must not be null.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"30C7D235-DDCF-4C7F-A462-5E2598252C2B\\",\\n \\"Data\\": {\\n \\"RoutingType\\": \\"Automatic\\",\\n \\"AgentConcurrencySettings\\": \\"{\\\\n \\\\\\"AllowExceedingLimitWhenTransferring\\\\\\": false,\\\\n \\\\\\"ConcurrencyLimit\\\\\\": 4,\\\\n \\\\\\"AllowExceedingLimitWhenClaiming\\\\\\": true,\\\\n \\\\\\"Enabled\\\\\\": true\\\\n}\\",\\n \\"DistributionSettings\\": \\"{\\\\n \\\\\\"AgentRingTimeoutSeconds\\\\\\": 30,\\\\n \\\\\\"Enabled\\\\\\": true,\\\\n \\\\\\"MaxNumberOfConversationsAgentCanMiss\\\\\\": 5,\\\\n \\\\\\"PostAgentMissingConversionsAction\\\\\\": \\\\\\"Nothing\\\\\\"\\\\n}\\",\\n \\"ChatSettings\\": \\"{\\\\\\"IdleChatTimeoutSeconds\\\\\\":300}\\"\\n }\\n}","type":"json"}]', - 'title' => '获取会话转接配置', - 'summary' => '使用GetChatRoutingProfile获取会话转接配置。', - ], - 'UpdateChatRoutingProfile' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], - ], - [ - 'name' => 'RoutingProfiles', - 'in' => 'query', - 'schema' => [ - 'description' => '会话分配/转接配置。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{'."\n" - .' "RoutingType": "Automatic",'."\n" - .' "AgentConcurrencySettings": {'."\n" - .' "AllowExceedingLimitWhenTransferring": false,'."\n" - .' "ConcurrencyLimit": 4,'."\n" - .' "AllowExceedingLimitWhenClaiming": true,'."\n" - .' "Enabled": true'."\n" - .' },'."\n" - .' "ChatSettings": {'."\n" - .' "IdleChatTimeoutSeconds": 300'."\n" - .' },'."\n" - .' "DistributionSettings": {'."\n" - .' "Enabled": true,'."\n" - .' "AgentRingTimeoutSeconds": 119,'."\n" - .' "MaxNumberOfConversationsAgentCanMiss": 5,'."\n" - .' "PostAgentMissingConversionsAction": "Nothing"'."\n" - .' }'."\n" - .'}', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s must not be null.', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'No permission', - ], - ], - [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], - ], - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '更新会话转接配置', - 'summary' => '使用UpdateChatRoutingProfile进行会话转接配置。', - ], - 'GetChatMediaUrl' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'MediaId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'media id', - 'description' => 'media id', - 'type' => 'string', - 'required' => true, - 'example' => '$iAHNCNQCo3dhdgMGBAAFAAbaACOEAaQhIEeoAqpjjBl42N6o_kg7A88AAAGRIRRuBgTOACrxHgcACM8AAAGRIYJLBQ', - ], - ], - [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID', - 'type' => 'string', - 'required' => false, - 'example' => '8707EB29-BAED-4302-B999-40BA61877437', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'GetChatMediaUrlResponse', - 'description' => 'GetChatMediaUrlResponse', - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => '返回数据结果。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息'."\n" - ."\n", - 'type' => 'string', - 'example' => 'Internal service issue. Detail:.', - ], - 'Params' => [ - 'description' => '响应参数。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '[\'OFFLINE\', \'READY,RINGING,TALKING\']', - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Internal service issue. Detail:.\\",\\n \\"Params\\": [\\n \\"[\'OFFLINE\', \'READY,RINGING,TALKING\']\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取聊天消息媒体文件访问URL', - ], - 'ListWaitingChats' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'SkillGroupIdList', - 'in' => 'query', - 'schema' => [ - 'description' => '技能组ID列表。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test"]', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], - 'Data' => [ - 'description' => '返回数据。', - 'type' => 'array', - 'items' => [ - 'description' => '会话信息。', - 'type' => 'object', - 'properties' => [ - 'ChatConversationId' => [ - 'description' => '聊天会话ID。', - 'type' => 'string', - 'example' => '$23086709$EAUNIT', - ], - 'BeingAssigned' => [ - 'description' => '会话是否已分配坐席。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'JobId' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'example' => 'chat-434537064047960064', - ], - 'EnqueueTime' => [ - 'description' => '进入队列时刻，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1718868572094', - ], - 'AccessChannelId' => [ - 'description' => '网络业务渠道ID。', - 'type' => 'string', - 'example' => '843073c2-*****-49fb-a616-738ddddfebdc', - ], - 'AccessChannelType' => [ - 'description' => '网络业务渠道类型。', - 'type' => 'string', - 'example' => 'Web', - ], - 'UserList' => [ - 'description' => '用户列表。', - 'type' => 'array', - 'items' => [ - 'description' => '用户。', - 'type' => 'object', - 'properties' => [ - 'UserName' => [ - 'description' => '用户姓名。', - 'type' => 'string', - 'example' => '访客-1c***', - ], - 'UserId' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => 'c361765f-******-4e07-b81c-4b5d9183fac6'."\n", - ], - 'UserType' => [ - 'description' => '用户类型。', - 'type' => 'string', - 'example' => 'CUSTOMER', - ], - 'AvatarUrl' => [ - 'description' => '头像链接。', - 'type' => 'string', - 'example' => '无', - ], - ], - ], - ], - 'Messages' => [ - 'description' => '消息列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SenderId' => [ - 'description' => '消息发送用户ID。', - 'type' => 'string', - 'example' => 'c361765f-******-4e07-b81c-4b5d9183fac6', - ], - 'Content' => [ - 'description' => '内容信息。', - 'type' => 'string', - 'example' => '测试消息', - ], - 'SenderType' => [ - 'description' => '发送方类型。取值：'."\n" - .'- **CUSTOMER**：访客'."\n" - .'- **AGENT**：坐席', - 'type' => 'string', - 'example' => '{"variables":{},"text":"

这种的名片选单面还是双面

"}', - ], - ], - ], - ], - 'SkillGroupId' => [ - 'description' => '技能组信息。', - 'type' => 'string', - 'example' => 'skill@ccc-test', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s may not be null.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Data\\": [\\n {\\n \\"ChatConversationId\\": \\"$23086709$EAUNIT\\",\\n \\"BeingAssigned\\": false,\\n \\"JobId\\": \\"chat-434537064047960064\\",\\n \\"EnqueueTime\\": 1718868572094,\\n \\"AccessChannelId\\": \\"843073c2-*****-49fb-a616-738ddddfebdc\\",\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"UserList\\": [\\n {\\n \\"UserName\\": \\"访客-1c***\\",\\n \\"UserId\\": \\"c361765f-******-4e07-b81c-4b5d9183fac6\\\\n\\",\\n \\"UserType\\": \\"CUSTOMER\\",\\n \\"AvatarUrl\\": \\"无\\"\\n }\\n ],\\n \\"Messages\\": [\\n {\\n \\"SenderId\\": \\"c361765f-******-4e07-b81c-4b5d9183fac6\\",\\n \\"Content\\": \\"测试消息\\",\\n \\"SenderType\\": \\"{\\\\\\"variables\\\\\\":{},\\\\\\"text\\\\\\":\\\\\\"

这种的名片选单面还是双面

\\\\\\"}\\"\\n }\\n ],\\n \\"SkillGroupId\\": \\"skill@ccc-test\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取队列中的聊天', - 'summary' => '坐席通过ListWaitingChats获取队列中等待分配或认领的聊天。', - ], - 'ClaimChat' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'SkillGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '按技能组ID过滤。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'skillgroup@ccc-test', - ], - ], - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'chat-65382141036853491', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E', - ], - 'Params' => [ - 'description' => '响应参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'ContextId' => [ - 'description' => '系统自增ID，客户无需关心。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789', - ], - 'UserContext' => [ - 'description' => '坐席上下文环境。', - 'type' => 'object', - 'properties' => [ - 'Heartbeat' => [ - 'description' => '上次收到坐席心跳的时间，格式为 Unix 时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1609136956378', - ], - 'Extension' => [ - 'description' => '坐席分机号。', - 'type' => 'string', - 'example' => '8032****'."\n", - ], - 'WorkMode' => [ - 'description' => '工作模式。Chat场景无需关心。'."\n" - ."\n" - .'枚举值：'."\n" - .'- ON_SITE：场内模式。'."\n" - .'- OFF_SITE：场外模式。'."\n" - .'- OFFICE_PHONE：办公电话模式。', - 'type' => 'string', - 'example' => 'ON_SITE', - ], - 'DeviceId' => [ - 'description' => '设备 ID。', - 'type' => 'string', - 'example' => 'CCC-169.254.165.2-browser125.0.0-bs48b41903450e6c8', - ], - 'UserId' => [ - 'description' => '坐席ID。', - 'type' => 'string', - 'example' => 'userId@ccc-test', - ], - 'Reserved' => [ - 'description' => '坐席最近一次被预定的时间，格式为 Unix 时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'false', - ], - 'BreakCode' => [ - 'description' => '小休状态码。', - 'type' => 'string', - 'example' => 'Warm-up', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'OutboundScenario' => [ - 'description' => '仅外呼场景。Chat业务无需关心。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DeviceState' => [ - 'description' => '设备状态。', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'Mobile' => [ - 'description' => '坐席的个人电话号码。Chat场景无需关心。', - 'type' => 'string', - 'example' => '18******102', - ], - 'JobId' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'example' => 'chat-65382141036853491'."\n", - ], - 'UserState' => [ - 'description' => '座席状态。'."\n" - ."\n" - .'枚举值：'."\n" - .'- READY：空闲。'."\n" - .'- WORKING：话后处理中。'."\n" - .'- BREAK：小休。'."\n" - .'- OFFLINE：离线。'."\n" - .'- TALKING：聊天中。'."\n" - .'- RINGING：聊天进线中。', - 'type' => 'string', - 'example' => 'TALKING', - ], - 'SignedSkillGroupIdList' => [ - 'description' => '坐席签入的技能组 ID 列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组 ID。', - 'type' => 'string', - 'example' => 'skg-default@ccc-test', - ], - ], - ], - ], - 'ChatContexts' => [ - 'description' => '会话上下文环境。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'JobId' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'example' => 'chat-65382141036853491'."\n", - ], - 'ChatType' => [ - 'description' => '会话类型。', - 'type' => 'string', - 'example' => 'INBOUND', - ], - 'CallVariables' => [ - 'description' => '随路数据。', - 'type' => 'string', - 'example' => '无', - ], - 'AccessChannelId' => [ - 'description' => '网络业务渠道ID。', - 'type' => 'string', - 'example' => '226****-cbb6-****-8fea-1e71baf7bfa7', - ], - 'AccessChannelType' => [ - 'description' => '网络业务渠道类型。', - 'type' => 'string', - 'example' => 'Web', - ], - 'AccessChannelName' => [ - 'description' => '网络业务渠道名字。', - 'type' => 'string', - 'example' => '测试渠道', - ], - 'BeingAssigned' => [ - 'description' => '会话是否已分配坐席。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.ChannelId', - 'errorMessage' => 'The specified channel %s does not exist in call %s.', - ], - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.JobId', - 'errorMessage' => 'The call %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.CTI', - 'errorMessage' => 'An internal CTI service error occurred.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 123456789,\\n \\"UserContext\\": {\\n \\"Heartbeat\\": 1609136956378,\\n \\"Extension\\": \\"8032****\\\\n\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"CCC-169.254.165.2-browser125.0.0-bs48b41903450e6c8\\",\\n \\"UserId\\": \\"userId@ccc-test\\",\\n \\"Reserved\\": 0,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"ONLINE\\",\\n \\"Mobile\\": \\"18******102\\",\\n \\"JobId\\": \\"chat-65382141036853491\\\\n\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skg-default@ccc-test\\"\\n ]\\n },\\n \\"ChatContexts\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"chat-65382141036853491\\\\n\\",\\n \\"ChatType\\": \\"INBOUND\\",\\n \\"CallVariables\\": \\"无\\",\\n \\"AccessChannelId\\": \\"226****-cbb6-****-8fea-1e71baf7bfa7\\",\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"AccessChannelName\\": \\"测试渠道\\",\\n \\"BeingAssigned\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '认领聊天', - 'summary' => '调用ClaimChat认领指定实例下指定话务ID对应的聊天。', - ], - 'ReleaseChat' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'chat-6538214103685****', - ], - ], - [ - 'name' => 'UserType', - 'in' => 'query', - 'schema' => [ - 'description' => '用户类型。'."\n" - .'- CUSTOMER : 访客'."\n" - .'- AGENT： 坐席', - 'type' => 'string', - 'required' => true, - 'example' => 'CUSTOMER', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '用户ID。访客ID或坐席ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'edbcf95a-ef9f-4296-a0a6-985ac9e36db3', - ], - ], - [ - 'name' => 'Token', - 'in' => 'query', - 'schema' => [ - 'description' => '网络业务的渠道Token。', - 'type' => 'string', - 'required' => false, - 'example' => '9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3bjEn0YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jg************Hwej7WgWrmA=', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B06B3244-1B44-481B-90C4-F2F92E59D6B5', + ], + ], + ], + ], + ], ], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s must not be null.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - 409 => [ - [ - 'errorCode' => 'AlreadyExists.SkillGroup', - 'errorMessage' => 'The skill group %s already exists in instance %s.', - ], - ], + 'staticInfo' => [ + 'substitutions' => ['CCC::2020-07-01::ListHistoricalSkillGroupReport'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B06B3244-1B44-481B-90C4-F2F92E59D6B5\\"\\n}","type":"json"}]', - 'title' => '结束聊天', - 'summary' => '通话ReleaseChat接口结束当前聊天。', + 'title' => '获取技能组概览数据列表', + 'summary' => '调用ListSkillgroupSummaryReportsSinceMidnight获取指定实例下按指定条件过滤后的技能组历史数据报表，统计的时间范围是从当天0时开始，到当前时间结束。该接口仅对特定用户开放，其他客户不建议调用。', + 'changeSet' => [ + ['createdAt' => '2024-06-06T07:19:09.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-05-28T06:54:07.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-05-17T08:45:04.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-05-15T02:47:00.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-04-24T12:54:21.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-15T03:10:11.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-06-06T09:08:50.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-03-09T09:23:25.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-02-28T02:23:24.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2B36CEBC-6D11-5451-9E6B-C6D1927841C5\\",\\n \\"Success\\": true,\\n \\"PagedSkillGroupSummaryReport\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"List\\": [\\n {\\n \\"Timestamp\\": \\"2018-09-13 00:00:00\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SkillGroupName\\": \\"测试技能组\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Overall\\": {\\n \\"TotalLoggedInTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0\\n },\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"QueueMaxWaitTimeDuration\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"AnsweredByAgentOfQueueWaitTimeDuration\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"InComingQueueOfQueueCount\\": 0,\\n \\"MaxTalkTime\\": \\"0\\",\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"AbandonedInQueueOfQueueCount\\": 0,\\n \\"OverFlowInQueueOfQueueCount\\": 0,\\n \\"AnsweredByAgentOfQueueMaxWaitTimeDuration\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"AnsweredByAgentOfQueueCount\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"GiveUpByAgentOfQueueCount\\": 0,\\n \\"QueueWaitTimeDuration\\": 0,\\n \\"CallsServiceLevel20\\": 0,\\n \\"CallsServiceLevel30\\": 0,\\n \\"CallsServiceLevel10\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"CallsTimeout\\": 0,\\n \\"CallsQueuingCanceled\\": \\"\\",\\n \\"CallsQueuingFailure\\": \\"\\",\\n \\"CallsQueuingRerouted\\": \\"\\",\\n \\"CallsAbandoned\\": 0,\\n \\"CallsOverflow\\": \\"\\"\\n },\\n \\"Outbound\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"AverageDialingTime\\": 0,\\n \\"CallsServiceLevel30\\": \\"0\\",\\n \\"CallsOffered\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsQueuingFailed\\": 0,\\n \\"CallsQueuingRerouted\\": 0,\\n \\"CallsQueuingCancelled\\": 0,\\n \\"CallsQueuingFailure\\": 0,\\n \\"TotalWaitTime\\": 0,\\n \\"CallsAgentHandled\\": 0,\\n \\"CallsServiceLevel30V2\\": 0\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'StartChat' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSkillGroups' => [ + 'summary' => '调用ListSkillGroups获取指定实例下的技能组列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -43703,85 +19741,39 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'UserList', + 'name' => 'SearchPattern', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '聊天成员信息。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'UserId' => [ - 'description' => '成员ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'fcd020fe-d8e4-40e5-8c77-1a272a174a7d', - ], - 'UserType' => [ - 'description' => '成员类型。'."\n" - .'- AGENT : 坐席'."\n" - .'- CUSTOMER : 访客', - 'type' => 'string', - 'required' => false, - 'example' => 'CUSTOMER', - ], - 'AvatarUrl' => [ - 'description' => '成员头像链接。', - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxx.com/image', - ], - 'Nickname' => [ - 'description' => '成员昵称。', - 'type' => 'string', - 'required' => false, - 'example' => '访客-1a272a174a7d', - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'schema' => ['description' => '根据技能组名称或技能组展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '测试技能组'], ], [ - 'name' => 'Token', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '网络业务的渠道Token。', - 'type' => 'string', - 'required' => false, - 'example' => '9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3bjEn0YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jg************Hwej7WgWrmA=', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'AccessChannelId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '网络业务渠道ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cf584733-***-***-9699-cb77aa3b7aa6', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => '媒体类型，默认是语音(Audio), 其他可选参数包括Chat和Video.', 'type' => 'string', 'required' => false, 'example' => 'Audio'], ], ], 'responses' => [ @@ -43789,92 +19781,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], 'Data' => [ - 'description' => '响应数据。', + 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'ChatConversationId' => [ - 'description' => '聊天会话ID。', - 'type' => 'string', - 'example' => '$23086709$EAUNIT', - ], - 'JobId' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'example' => 'chat-525523618219921408', + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'List' => [ + 'description' => '技能组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '技能组展示名。', 'type' => 'string', 'example' => '测试技能组'], + 'Description' => ['description' => '技能组的描述。', 'type' => 'string', 'example' => '云联络中心的测试技能组。'], + 'PhoneNumberCount' => ['description' => '技能组关联的号码数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'], + 'UserCount' => ['description' => '技能组关联的坐席数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'MediaType' => ['description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', 'type' => 'string', 'example' => 'CHAT'], + ], + 'description' => '', + ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s must not be null.', - ], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - 409 => [ - [ - 'errorCode' => 'AlreadyExists.SkillGroup', - 'errorMessage' => 'The skill group %s already exists in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"ChatConversationId\\": \\"$23086709$EAUNIT\\",\\n \\"JobId\\": \\"chat-525523618219921408\\"\\n }\\n}","type":"json"}]', - 'title' => '发起聊天', - 'summary' => '调用StartChat发起聊天。', - ], - 'RejectChat' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '获取技能组列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroups'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"UserCount\\": 2,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"MediaType\\": \\"CHAT\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n test\\n 测试\\n 1\\n ccc-test\\n 2\\n 测试技能组\\n test@ccc-test\\n \\n\\nOK","errorExample":""}]', + ], + 'ListSkillLevelsOfUser' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -43883,32 +19854,44 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'JobId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'chat-65382141036853491', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], + ], + [ + 'name' => 'IsMember', + 'in' => 'query', + 'schema' => ['description' => '是否与传入的坐席关联，如果值为true，表示获取传入的坐席关联的技能组的技能等级列表，如果值为false，表示获取坐席可关联但未关联的技能组列表。默认值为true。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], + [ + 'name' => 'SearchPattern', + 'in' => 'query', + 'schema' => ['description' => '根据技能组名称或技能组展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup'], ], ], 'responses' => [ @@ -43916,76 +19899,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B59382D2-5755-4C6D-861F-FA2AAD8F89F7', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'List' => [ + 'description' => '技能组等级列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillLevel' => ['description' => '技能等级，取值范围1-10，数值越小，业务能力越强，单位时间内能处理更多的通话。', 'type' => 'string', 'example' => '5'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'], + 'MediaType' => ['description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括CHAT和VIDEO。', 'type' => 'string', 'example' => 'VIDEO'], + ], + 'description' => '', + ], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s must not be null.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - 409 => [ - [ - 'errorCode' => 'AlreadyExists.SkillGroup', - 'errorMessage' => 'The skill group %s already exists in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B59382D2-5755-4C6D-861F-FA2AAD8F89F7\\"\\n}","type":"json"}]', - 'title' => '拒绝聊天', - 'summary' => '坐席通过RejectChat拒绝接受被分配的聊天。', - ], - 'GetVisitorLoginDetails' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '获取坐席的技能组等级列表', + 'summary' => '获取指定实例下指定坐席关联的技能组的技能等级列表，也可以使用该接口查询坐席可关联但未关联的技能组列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillLevelsOfUser'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"SkillLevel\\": \\"5\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n 5\\n 测试技能组\\n test@ccc-test\\n \\n\\nOK","errorExample":""}]', + ], + 'ListSmsMetadata' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -43997,48 +19972,36 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '251523', + 'abilityTreeNodes' => ['FEATUREcccBM6DRP'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'VisitorId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '访客ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'fcd020fe-d8e4-40e5-8c77-1a272a174a7d', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'ChatDeviceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'Chat设备ID。', - 'type' => 'string', - 'required' => true, - 'example' => '4c51c9116c36537cb850dc1081d745df', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100'], ], [ - 'name' => 'Token', + 'name' => 'ScenarioListJson', 'in' => 'query', - 'schema' => [ - 'description' => '网络业务的渠道Token。', - 'type' => 'string', - 'required' => false, - 'example' => '9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3b***YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jgxzO*****bHwej7WgWrmA', - ], + 'schema' => ['description' => '场景类型。'."\n" + .'- SATISFACTION_SURVEY（满意度调查）'."\n" + .'- CONTACT_FLOW_NODE（IVR流程节点）'."\n" + .'- MISSED_CALL_NOTIFICATION（漏话提醒）'."\n" + .'- FLASH_SMS（阿里通信闪信通知）', 'type' => 'string', 'required' => false, 'example' => '["SATISFACTION_SURVEY","CONTACT_FLOW_NODE"]'], ], ], 'responses' => [ @@ -44046,304 +20009,276 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '19D09CCC-F298-4124-849A-AFA217819011', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'], 'Params' => [ - 'description' => '参数信息。', + 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '参数列表。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], 'Data' => [ - 'description' => '返回数据。', + 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'ChatLoginToken' => [ - 'description' => 'Chat会话登录令牌。', - 'type' => 'string', - 'example' => '{"accessToken":"oauth_cloud_key:+4oJXUAFSWxGD2YuRW4V/oUN0/8qJGNc0I*********n1E3DOr3Q3lX00ZnTpyqRi8Y6hYoLYA7n2ZkWuv485hVtXeSgnIQkKxXPbMgwoLxWaK//lI5Dn/mb4YuDifigv+ZyFzc+07vxm9ZFu/NjA==","accessTokenExpiredTime":86400000,"refreshToken":"oauth_cloud_key:/U+8UueDmpeUszhXC+SWow4pNLZp2C***********U/377BNXF+Mjo1lFgDk6GtEjNNoJpapX2mHH8GcRke2+yKQs/w4gAN9xSMn543Ciung+93pXV6IpQGbEVlu"}', - ], - 'ChatUserId' => [ - 'description' => '访客的身份ID。', - 'type' => 'string', - 'example' => 'dac9c001****a15684ea91a81317', - ], - 'ChatDeviceId' => [ - 'description' => 'Chat设备ID。', - 'type' => 'string', - 'example' => '4c51c9116c36537cb850dc1081d745df', - ], - 'ChatServerUrl' => [ - 'description' => 'Chat会话服务器地址。', - 'type' => 'string', - 'example' => 'wss://wss.im.dingtalk.cn', - ], - 'ChatAppKey' => [ - 'description' => 'Chat会话应用密钥。', - 'type' => 'string', - 'example' => '955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0', - ], - 'ChatAppId' => [ - 'description' => 'Chat会话应用ID。', - 'type' => 'string', - 'example' => '7pjxxx', + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'List' => [ + 'description' => '短信配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '短信配置。', + 'type' => 'object', + 'properties' => [ + 'SmsMetadataId' => ['description' => '短信配置ID。', 'type' => 'string', 'example' => '5ffc1c9a-4d3d-4019-*****-73255fb01d1c'], + 'TemplateCode' => ['description' => '模板CODE。', 'type' => 'string', 'example' => 'SMS_468xxxx298'], + 'Description' => ['description' => '配置描述。', 'type' => 'string', 'example' => '漏话短信配置'], + 'Scenario' => ['description' => '场景类型。', 'type' => 'string', 'example' => 'MISSED_CALL_NOTIFICATION'], + 'AliyunUid' => ['description' => '阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '15772400000****'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Name' => ['description' => '配置名称。', 'type' => 'string', 'example' => '漏话短信提醒'], + 'SignName' => ['description' => '短信签名名称。', 'type' => 'string', 'example' => '云呼叫中心'], + ], + ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserId', - 'errorMessage' => 'The user %s does not exist in instance %s.', - ], + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"19D09CCC-F298-4124-849A-AFA217819011\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ChatLoginToken\\": \\"{\\\\\\"accessToken\\\\\\":\\\\\\"oauth_cloud_key:+4oJXUAFSWxGD2YuRW4V/oUN0/8qJGNc0I*********n1E3DOr3Q3lX00ZnTpyqRi8Y6hYoLYA7n2ZkWuv485hVtXeSgnIQkKxXPbMgwoLxWaK//lI5Dn/mb4YuDifigv+ZyFzc+07vxm9ZFu/NjA==\\\\\\",\\\\\\"accessTokenExpiredTime\\\\\\":86400000,\\\\\\"refreshToken\\\\\\":\\\\\\"oauth_cloud_key:/U+8UueDmpeUszhXC+SWow4pNLZp2C***********U/377BNXF+Mjo1lFgDk6GtEjNNoJpapX2mHH8GcRke2+yKQs/w4gAN9xSMn543Ciung+93pXV6IpQGbEVlu\\\\\\"}\\",\\n \\"ChatUserId\\": \\"dac9c001****a15684ea91a81317\\",\\n \\"ChatDeviceId\\": \\"4c51c9116c36537cb850dc1081d745df\\",\\n \\"ChatServerUrl\\": \\"wss://wss.im.dingtalk.cn\\",\\n \\"ChatAppKey\\": \\"955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0\\",\\n \\"ChatAppId\\": \\"7pjxxx\\"\\n }\\n}","type":"json"}]', - 'title' => '获取访客登录信息', - 'summary' => '调用GeVisitortLoginDetails获取网络业务访客的登录信息，服务器地址信息、鉴权信息等。', - ], - 'AcceptChat' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 200,\\n \\"List\\": [\\n {\\n \\"SmsMetadataId\\": \\"5ffc1c9a-4d3d-4019-*****-73255fb01d1c\\",\\n \\"TemplateCode\\": \\"SMS_468xxxx298\\",\\n \\"Description\\": \\"漏话短信配置\\",\\n \\"Scenario\\": \\"MISSED_CALL_NOTIFICATION\\",\\n \\"AliyunUid\\": 0,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"漏话短信提醒\\",\\n \\"SignName\\": \\"云呼叫中心\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取短信配置详情', + 'summary' => '使用ListSmsMetadata获取短信配置详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ListTicketTasks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'JobId', + 'name' => 'TicketId', 'in' => 'query', - 'schema' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'chat-65382141036853491', - ], + 'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => false, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'ListTicketTasksResponse', + 'description' => 'ListTicketTasksResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'Data' => [ + 'description' => '数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskName' => ['description' => '节点名称。', 'type' => 'string', 'example' => '节点1'], + 'Assignee' => ['description' => '处理人ID。', 'type' => 'string', 'example' => 'assignee@ccc-test'], + 'Comment' => ['description' => '处理意见。', 'type' => 'string', 'example' => '同意'], + 'StartTime' => ['description' => '开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620259200000'], + 'EndTime' => ['description' => '结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1620269200000'], + 'AssigneeName' => ['description' => '处理人姓名。', 'type' => 'string', 'example' => 'assignee'], + 'TaskId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'eb039a4a6a5742c6b44ccff0c1fca745'], + 'TicketId' => ['description' => '工单ID。', 'type' => 'string', 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'."\n"], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'FileKeys' => [ + 'description' => '文件列表。', + 'type' => 'array', + 'items' => ['description' => '文件。', 'type' => 'string', 'example' => '["ticket-file/xxx.png"]'], + ], + 'FileUrls' => [ + 'description' => '文件访问链接列表。', + 'type' => 'array', + 'items' => ['description' => '文件访问链接。', 'type' => 'string', 'example' => '["http://oss-cn-hangzhou.com/bucket/ticket-file/xxx.png"]'], + ], + 'TaskDefinitionNodeId' => ['description' => '工单节点流程定义ID。', 'type' => 'string', 'example' => 'APPROVAL__6zu2QjAz'], + 'TaskDefinitionNodeType' => ['description' => '工单节点流程定义类型。', 'type' => 'string', 'example' => 'APPROVAL'], + 'Action' => ['description' => '节点处理动作。', 'type' => 'string', 'example' => 'CounterSignTask'], + ], + 'description' => '', + ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE '], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s must not be null.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], - 409 => [ - [ - 'errorCode' => 'AlreadyExists.SkillGroup', - 'errorMessage' => 'The skill group %s already exists in instance %s.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\"\\n}","type":"json"}]', - 'title' => '接受聊天', - 'summary' => '调用AcceptChat接受指定实例下指定话务ID对应的聊天。', - ], - 'FinishTicketTask' => [ - 'methods' => [ - 'post', - 'get', ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TaskName\\": \\"节点1\\",\\n \\"Assignee\\": \\"assignee@ccc-test\\",\\n \\"Comment\\": \\"同意\\",\\n \\"StartTime\\": 1620259200000,\\n \\"EndTime\\": 1620269200000,\\n \\"AssigneeName\\": \\"assignee\\",\\n \\"TaskId\\": \\"eb039a4a6a5742c6b44ccff0c1fca745\\",\\n \\"TicketId\\": \\"5491d3b4-14ee-4341-b5f1-db2c78beddeb\\\\n\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"FileKeys\\": [\\n \\"[\\\\\\"ticket-file/xxx.png\\\\\\"]\\"\\n ],\\n \\"FileUrls\\": [\\n \\"[\\\\\\"http://oss-cn-hangzhou.com/bucket/ticket-file/xxx.png\\\\\\"]\\"\\n ],\\n \\"TaskDefinitionNodeId\\": \\"APPROVAL__6zu2QjAz\\",\\n \\"TaskDefinitionNodeType\\": \\"APPROVAL\\",\\n \\"Action\\": \\"CounterSignTask\\"\\n }\\n ],\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取工单节点信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ListTicketTemplates' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'TicketId', + 'name' => 'SearchPattern', 'in' => 'query', - 'schema' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5', - ], + 'schema' => ['description' => '模板名称，模糊搜索。', 'type' => 'string', 'required' => false, 'example' => '模板1'], ], [ - 'name' => 'TaskId', + 'name' => 'CategoryId', 'in' => 'query', - 'schema' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'b52a34dc-f514-4600-9c39-3cf657167c97', - ], + 'schema' => ['description' => '工单类目ID。', 'type' => 'string', 'required' => false, 'example' => '43c2671b-********86d0-6bd187905cc8'], ], [ - 'name' => 'Comment', + 'name' => 'State', 'in' => 'query', - 'schema' => [ - 'description' => '处理意见。', - 'type' => 'string', - 'required' => true, - 'example' => '同意', - ], + 'schema' => ['description' => '模板状态。'."\n" + .'- Enabled（已上线）'."\n" + .'- Disabled（已下线）', 'type' => 'string', 'required' => false, 'example' => 'Enabled'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'FinishTicketTaskResponse', - 'description' => 'FinishTicketTaskResponse', + 'title' => 'ListTicketTemplatesResponse', + 'description' => 'ListTicketTemplatesResponse', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '数据。', - 'type' => 'any', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '25'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'List' => [ + 'description' => '模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '模板。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'TemplateId' => ['description' => '模板ID。', 'type' => 'string', 'example' => 'b5c21219-3a1e-4bc0-92e7-da66e057d2f6'], + 'Name' => ['description' => '模板名称。', 'type' => 'string', 'example' => '测试模板'], + 'State' => ['description' => '状态。', 'type' => 'string', 'example' => 'Enabled'], + 'Editor' => ['description' => '编辑人。', 'type' => 'string', 'example' => 'creator@ccc-test'], + 'TicketFields' => [ + 'description' => '模板字段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '字段。', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '显示名称。', 'type' => 'string', 'example' => '姓名'."\n"], + 'Description' => ['description' => '描述。', 'type' => 'string', 'example' => '姓名字段'], + 'Name' => ['description' => '名称。', 'type' => 'string', 'example' => 'name'], + 'DataType' => ['description' => '数据类型'."\n" + .'。', 'type' => 'string', 'example' => 'String'], + 'Pattern' => ['description' => '正则表达式校验规则。', 'type' => 'string', 'example' => '^'], + 'PatternErrorMessage' => ['description' => '正则表达式校验错误提示信息', 'type' => 'string', 'example' => '不是有效的email地址'."\n"], + 'MinLength' => ['description' => '最小长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'MaxLength' => ['description' => '最大长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'Minimum' => ['description' => '数字最小值。', 'type' => 'number', 'format' => 'double', 'example' => '1'], + 'Maximum' => ['description' => '数字最大值。', 'type' => 'number', 'format' => 'double', 'example' => '10'], + 'Required' => ['description' => '是否必填。', 'type' => 'boolean', 'example' => 'false'], + 'System' => ['description' => '是否是系统字段。', 'type' => 'boolean', 'example' => 'false'], + 'Disabled' => ['description' => '是否被禁用。', 'type' => 'boolean', 'example' => 'false'], + 'Array' => ['description' => '是否是数组。', 'type' => 'boolean', 'example' => 'false'], + 'ReadOnly' => ['description' => '是否只读。', 'type' => 'boolean', 'example' => 'false'], + 'EditorType' => ['description' => '编辑器类型。', 'type' => 'string', 'example' => 'textbox'], + 'Attribute' => ['description' => '扩展属性。', 'type' => 'string', 'example' => '{}'], + 'DisplayOrder' => ['description' => '列表展示顺序。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'CreatedTime' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1715780670000'], + 'UpdatedTime' => ['description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1715780670000'], + 'Creator' => ['description' => '创建者。', 'type' => 'string', 'example' => 'creator'], + ], + ], + ], + 'ProcessDefinition' => ['description' => '流程信息（废弃）。', 'type' => 'string', 'example' => '无'], + 'UpdatedTime' => ['description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1715780670000'], + 'CategoryId' => ['description' => '类⽬ID。', 'type' => 'string', 'example' => '43c2671b-*****-4223-86d0-6bd187905cc8'], + 'AppliedVersion' => ['description' => '当前正在工作的版本。', 'type' => 'string', 'example' => '0'], + 'LatestVersion' => ['description' => '草稿版本。', 'type' => 'string', 'example' => '1715780670000'], + ], + ], + ], + ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Params' => [ 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '错误参数', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -44351,703 +20286,696 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '工单处理', - 'summary' => '使用FinishTicketTask对工单进行处理。', - ], - 'UpdateTicket' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 25,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TemplateId\\": \\"b5c21219-3a1e-4bc0-92e7-da66e057d2f6\\",\\n \\"Name\\": \\"测试模板\\",\\n \\"State\\": \\"Enabled\\",\\n \\"Editor\\": \\"creator@ccc-test\\",\\n \\"TicketFields\\": [\\n {\\n \\"DisplayName\\": \\"姓名\\\\n\\",\\n \\"Description\\": \\"姓名字段\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"String\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\\\n\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attribute\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1715780670000,\\n \\"UpdatedTime\\": 1715780670000,\\n \\"Creator\\": \\"creator\\"\\n }\\n ],\\n \\"ProcessDefinition\\": \\"无\\",\\n \\"UpdatedTime\\": 1715780670000,\\n \\"CategoryId\\": \\"43c2671b-*****-4223-86d0-6bd187905cc8\\",\\n \\"AppliedVersion\\": \\"0\\",\\n \\"LatestVersion\\": \\"1715780670000\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取工单模板列表', + 'summary' => '使用ListTickerTemplate获取工单模板列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ListTickets' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ 'name' => 'TicketId', 'in' => 'query', + 'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => false, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => ['description' => '工单标题。', 'type' => 'string', 'required' => false, 'example' => '标题'], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => ['description' => '工单状态。', 'type' => 'string', 'required' => false, 'example' => 'Processing'], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => ['description' => '工单类目ID。', 'type' => 'string', 'required' => false, 'example' => '43c2671b-****-4223-86d0-6bd187905cc8'], + ], + [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => ['description' => '创建者。', 'type' => 'string', 'required' => false, 'example' => 'creator@cccV2-kmz'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '开始时间，基于工单创建时间过滤。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1646841600000'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '结束时间，基于工单创建时间过滤。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1646928000000'], + ], + [ + 'name' => 'CustomerId', + 'in' => 'query', + 'schema' => ['description' => '客户ID，云联络中心客户资料ID。', 'type' => 'string', 'required' => false, 'example' => '51e155ce-3747-*****-b402-13c69597b920'], + ], + [ + 'name' => 'JobIdList', + 'in' => 'query', + 'schema' => ['description' => '话务ID列表。', 'type' => 'string', 'required' => false, 'example' => '["job-12******","job-23****"]'], + ], + [ + 'name' => 'Assignee', + 'in' => 'query', + 'schema' => ['description' => '处理者ID。', 'type' => 'string', 'required' => false, 'example' => 'assignee@cccV2-kmz'."\n"], + ], + [ + 'name' => 'AssigneeType', + 'in' => 'query', + 'schema' => ['description' => '处理者类型。', 'type' => 'string', 'required' => false, 'example' => 'Agent'], + ], + [ + 'name' => 'Participant', + 'in' => 'query', + 'schema' => ['description' => '参与人ID。', 'type' => 'string', 'required' => false, 'example' => 'participant@cccV2-kmz'."\n"], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'required' => true, - 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'List' => [ + 'description' => '工单列表。', + 'type' => 'array', + 'items' => [ + 'description' => '工单。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'TicketId' => ['description' => '工单ID。', 'type' => 'string', 'example' => 'feb83abd-9f08-49d2-9b56-41d1b66ca0ac'], + 'Title' => ['description' => '工单标题。', 'type' => 'string', 'example' => '标题'], + 'TemplateId' => ['description' => '模板ID。', 'type' => 'string', 'example' => 'c844a5f0-496c-4c5b-8a0c-dd27686e8ff6'], + 'TemplateVersion' => ['description' => '模板版本。', 'type' => 'string', 'example' => '0'], + 'CategoryId' => ['description' => '工单类目ID。', 'type' => 'string', 'example' => '43c2671b-*****-4223-86d0-6bd187905cc8'], + 'CategoryName' => ['description' => '工单类目名称。', 'type' => 'string', 'example' => '类目1'], + 'StartTime' => ['description' => '工单开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000'], + 'EndTime' => ['description' => '工单结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000'], + 'State' => ['description' => '状态。', 'type' => 'string', 'example' => 'Processing'], + 'CloseCode' => ['description' => '工单结束原因。', 'type' => 'string', 'example' => 'Completed'], + 'Assignee' => ['description' => '处理人ID。', 'type' => 'string', 'example' => 'assignee@ccc-test'], + 'Comment' => ['description' => '处理意见。', 'type' => 'string', 'example' => '无'], + 'AssigneeName' => ['description' => '处理人姓名。', 'type' => 'string', 'example' => 'Assignee'], + 'Creator' => ['description' => '创建人ID。', 'type' => 'string', 'example' => 'creator@ccc-test'."\n"], + 'CreatorName' => ['description' => '创建者名称。', 'type' => 'string', 'example' => 'Creator'], + 'Context' => ['description' => '工单表单信息。', 'type' => 'string', 'example' => '{"productName":"alynx"}'], + 'CreatedTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '1631440860000'], + 'UpdatedTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '1631440860000'], + 'CurrentTaskId' => ['description' => '当前节点ID。', 'type' => 'string', 'example' => '0707dab6-34a8-11ef-9823-161e3802b2d4'], + 'CurrentTaskName' => ['description' => '当前节点名称。', 'type' => 'string', 'example' => '节点1'], + 'CurrentTaskStartTime' => ['description' => '当前节点开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000'], + 'CustomerId' => ['description' => '客户ID。', 'type' => 'string', 'example' => '51e155ce-*****1-b402-13c69597b920'], + 'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'job-47150***150396416'], + 'Source' => ['description' => '工单来源。', 'type' => 'string', 'example' => 'CHAT'], + ], + ], + ], + ], + ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TicketId\\": \\"feb83abd-9f08-49d2-9b56-41d1b66ca0ac\\",\\n \\"Title\\": \\"标题\\",\\n \\"TemplateId\\": \\"c844a5f0-496c-4c5b-8a0c-dd27686e8ff6\\",\\n \\"TemplateVersion\\": \\"0\\",\\n \\"CategoryId\\": \\"43c2671b-*****-4223-86d0-6bd187905cc8\\",\\n \\"CategoryName\\": \\"类目1\\",\\n \\"StartTime\\": 1631440860000,\\n \\"EndTime\\": 1631440860000,\\n \\"State\\": \\"Processing\\",\\n \\"CloseCode\\": \\"Completed\\",\\n \\"Assignee\\": \\"assignee@ccc-test\\",\\n \\"Comment\\": \\"无\\",\\n \\"AssigneeName\\": \\"Assignee\\",\\n \\"Creator\\": \\"creator@ccc-test\\\\n\\",\\n \\"CreatorName\\": \\"Creator\\",\\n \\"Context\\": \\"{\\\\\\"productName\\\\\\":\\\\\\"alynx\\\\\\"}\\",\\n \\"CreatedTime\\": \\"1631440860000\\",\\n \\"UpdatedTime\\": \\"1631440860000\\",\\n \\"CurrentTaskId\\": \\"0707dab6-34a8-11ef-9823-161e3802b2d4\\",\\n \\"CurrentTaskName\\": \\"节点1\\",\\n \\"CurrentTaskStartTime\\": 1631440860000,\\n \\"CustomerId\\": \\"51e155ce-*****1-b402-13c69597b920\\",\\n \\"JobId\\": \\"job-47150***150396416\\",\\n \\"Source\\": \\"CHAT\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '获取工单列表', + 'summary' => '使用ListTickets获取实例下工单列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + ], + 'ListUnassignedNumbers' => [ + 'summary' => '调用ListUnassignedNumbers获取阿里云主账号下未分配到实例的号码列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], + 'parameters' => [ [ - 'name' => 'Title', + 'name' => 'SearchPattern', 'in' => 'query', - 'schema' => [ - 'description' => '工单标题。', - 'type' => 'string', - 'required' => false, - 'example' => '标题', - ], + 'schema' => ['description' => '根据号码进行模糊匹配，非必填，默认为空，为空表示不过滤。'."\n" + ."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0833'], ], [ - 'name' => 'CustomerId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'required' => false, - 'example' => '51e155ce-***-****-b402-13c69597b920', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'Context', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '工单表单信息。', - 'type' => 'string', - 'required' => false, - 'example' => '{"productName":"玩具1"}', - ], + 'schema' => ['description' => '分页大小，范围1-100。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'UpdateTicketResponse', - 'description' => 'UpdateTicketResponse', 'type' => 'object', 'properties' => [ + 'Code' => ['description' => '响应码。'."\n" + ."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。'."\n" + ."\n", 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F '], 'Data' => [ 'description' => '数据。', - 'type' => 'any', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'List' => [ + 'description' => '号码列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Number' => ['description' => '号码。'."\n" + ."\n", 'type' => 'string', 'example' => '08330011****'], + 'City' => ['description' => '号码归属地市。'."\n" + ."\n", 'type' => 'string', 'example' => '乐山'], + 'Province' => ['description' => '号码归属地省。'."\n" + ."\n", 'type' => 'string', 'example' => '四川'], + ], + 'description' => '', + ], + ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.ResourcePlatform', 'errorMessage' => 'An internal ResourcePlatform service error occurred. %s', 'description' => '内部ResourcePlatform服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '更新工单信息', - 'summary' => '使用UpdateTicket更新工单内容。', - ], - 'GetTicket' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '获取未分配号码列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-02-02T03:52:26.000Z', 'description' => '错误码发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUnassignedNumbers'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\\\t\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"08330011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\t\\n无\\n200\\n\\n 1\\n 20\\n 1\\n \\n true\\n true\\n 083xxxx0011\\t\\n 乐山\\n 四川\\n \\n\\nOK","errorExample":""}]', + ], + 'ListUserLevelsOfSkillGroup' => [ + 'summary' => '调用ListUserLevelsOfSkillGroup获取指定实例下指定技能组下属的坐席技能等级列表，也可以调用该接口反差可关联但未关联指定技能组的坐席列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'TicketId', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'required' => true, - 'example' => '3d26b90a-c5d2-4b09-8219-********', - ], + 'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'], + ], + [ + 'name' => 'IsMember', + 'in' => 'query', + 'schema' => ['description' => '是否与传入的技能组关联，如果值为true，表示获取SkillgroupId关联的坐席的技能等级列表，如果值为false，表示获取可关联但未关联SkillgroupId的坐席列表。默认值为true。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], + [ + 'name' => 'SearchPattern', + 'in' => 'query', + 'schema' => ['description' => '根据坐席登录名或坐席展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'example' => '测试坐席'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'DescribeTicketResponse', - 'description' => 'DescribeTicketResponse', 'type' => 'object', 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'TicketId' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'example' => 'b3a6a131-359e-46bd-9bc5-1f5cb0ea093f', - ], - 'TemplateId' => [ - 'description' => '工单模板ID。', - 'type' => 'string', - 'example' => 'ccc-test_43c2671b-8939-4223-86d0-6bd187905cc8_*****0666238', - ], - 'TemplateVersion' => [ - 'description' => '工单模板版本。', - 'type' => 'string', - 'example' => '0', - ], - 'Title' => [ - 'description' => '工单标题。', - 'type' => 'string', - 'example' => '售后工单', - ], - 'Context' => [ - 'description' => '工单字段信息。', - 'type' => 'string', - 'example' => '{"productName":"商品A"}', - ], - 'Assignee' => [ - 'description' => '处理人ID。', - 'type' => 'string', - 'example' => 'agent1@ccc-test', - ], - 'AssigneeName' => [ - 'description' => '处理人名称。', - 'type' => 'string', - 'example' => '坐席A', - ], - 'Creator' => [ - 'description' => '创建人ID。', - 'type' => 'string', - 'example' => 'creator@ccc-test'."\n", - ], - 'CreatorName' => [ - 'description' => '创建者名称', - 'type' => 'string', - 'example' => '坐席B', - ], - 'CategoryId' => [ - 'description' => '工单类目ID。', - 'type' => 'string', - 'example' => '8939-4223-86d0-6bd187905cc8', - ], - 'CategoryName' => [ - 'description' => '工单类目名称。', - 'type' => 'string', - 'example' => '售后类目', - ], - 'JobId' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'example' => 'job-399383842187575296', - ], - 'StartTime' => [ - 'description' => '工单处理开始时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1620259200000', - ], - 'EndTime' => [ - 'description' => '工单处理完成时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1687846259999', - ], - 'CreatedTime' => [ - 'description' => '工单创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1620259200000', - ], - 'UpdatedTime' => [ - 'description' => '最近一次更新时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1693793208075', - ], - 'CurrentTaskId' => [ - 'description' => '当前节点ID。', - 'type' => 'string', - 'example' => '912f0b78-6639-4a93-ae18-0d832885c27e', - ], - 'CurrentTaskName' => [ - 'description' => '当前节点名称。', - 'type' => 'string', - 'example' => '节点1', - ], - 'CurrentTaskStartTime' => [ - 'description' => '当前节点开始时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1693793208075', - ], - 'Source' => [ - 'description' => '工单来源。'."\n" - .'- AUDIO： 语音业务。'."\n" - .'- CHAT: 网络业务。'."\n" - .'- Console：工单控制台创建。', - 'type' => 'string', - 'example' => 'Audio', - ], - 'CustomerId' => [ - 'description' => '客户ID，云联络中心客户资料中的客户ID。', - 'type' => 'string', - 'example' => '4223-86d0-6bd187905-891798749', - ], - 'State' => [ - 'description' => '工单状态。'."\n" - .'- Processing（处理中）'."\n" - .'- Withdrawal（已撤回）'."\n" - .'- Rejected（已退回）'."\n" - .'- Closed（已关单）', - 'type' => 'string', - 'example' => 'Processing', - ], - 'CloseCode' => [ - 'description' => '关单原因。'."\n" - .'- Completed（处理完成）'."\n" - .'- Terminated（取消）', - 'type' => 'string', - 'example' => 'Completed', - ], - 'Comment' => [ - 'description' => '处理意见。', - 'type' => 'string', - 'example' => '无', + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'List' => [ + 'description' => '技能等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '技能等级信息。', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '坐席展示名。', 'type' => 'string', 'example' => '坐席小王'], + 'SkillLevel' => ['description' => '坐席技能等级。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'LoginName' => ['description' => '坐席登录名。', 'type' => 'string', 'example' => 'agent'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'], + 'RoleName' => [ + 'description' => '角色名称。', + 'type' => 'string', + 'enumValueTitles' => ['Agent' => '坐席', 'Admin' => '管理员', 'Manager' => '技能组组长'], + 'example' => 'Admin', + ], + 'RoleId' => ['description' => '角色ID，格式为：角色@实例ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'], + 'RamId' => ['description' => '用户的RAM账号。', 'type' => 'string', 'example' => '28036411123456****'], + ], + ], ], ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数', - 'type' => 'string', - 'example' => '无', - ], - ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TicketId\\": \\"b3a6a131-359e-46bd-9bc5-1f5cb0ea093f\\",\\n \\"TemplateId\\": \\"ccc-test_43c2671b-8939-4223-86d0-6bd187905cc8_*****0666238\\",\\n \\"TemplateVersion\\": \\"0\\",\\n \\"Title\\": \\"售后工单\\",\\n \\"Context\\": \\"{\\\\\\"productName\\\\\\":\\\\\\"商品A\\\\\\"}\\",\\n \\"Assignee\\": \\"agent1@ccc-test\\",\\n \\"AssigneeName\\": \\"坐席A\\",\\n \\"Creator\\": \\"creator@ccc-test\\\\n\\",\\n \\"CreatorName\\": \\"坐席B\\",\\n \\"CategoryId\\": \\"8939-4223-86d0-6bd187905cc8\\",\\n \\"CategoryName\\": \\"售后类目\\",\\n \\"JobId\\": \\"job-399383842187575296\\",\\n \\"StartTime\\": 1620259200000,\\n \\"EndTime\\": 1687846259999,\\n \\"CreatedTime\\": 1620259200000,\\n \\"UpdatedTime\\": 1693793208075,\\n \\"CurrentTaskId\\": \\"912f0b78-6639-4a93-ae18-0d832885c27e\\",\\n \\"CurrentTaskName\\": \\"节点1\\",\\n \\"CurrentTaskStartTime\\": 1693793208075,\\n \\"Source\\": \\"Audio\\",\\n \\"CustomerId\\": \\"4223-86d0-6bd187905-891798749\\",\\n \\"State\\": \\"Processing\\",\\n \\"CloseCode\\": \\"Completed\\",\\n \\"Comment\\": \\"无\\"\\n },\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA633111\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取工单', - 'summary' => '使用GetTicket获取指定工单信息。', - ], - 'ListCommonTicketFields' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '获取技能组的坐席等级列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserLevelsOfSkillGroup'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"SkillLevel\\": 5,\\n \\"LoginName\\": \\"agent\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"RamId\\": \\"28036411123456****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n user-test\\n Admin\\n 5\\n Default\\n user-test@ccc-test\\n 测试坐席\\n skg-default@ccc-test\\n Admin@ccc-test\\n \\n\\nOK","errorExample":""}]', + ], + 'ListUsers' => [ + 'summary' => '调用ListUsers获取指定实例下的坐席列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'GetSchemaResponse', - 'description' => 'GetSchemaResponse', - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Id' => [ - 'description' => 'Schema ID。', - 'type' => 'string', - 'example' => 'ticketing', - ], - 'Properties' => [ - 'description' => '字段列表。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'type' => 'string', - 'description' => '显示名称。', - 'example' => '姓名', - ], - 'Description' => [ - 'type' => 'string', - 'description' => '描述。', - 'example' => 'name', - ], - 'Name' => [ - 'type' => 'string', - 'description' => '名称。', - 'example' => 'name', - ], - 'DataType' => [ - 'type' => 'string', - 'example' => 'string', - 'description' => '数据类型。', - ], - 'Pattern' => [ - 'type' => 'string', - 'example' => '^', - 'description' => '正则表达式校验规则。', - ], - 'PatternErrorMessage' => [ - 'type' => 'string', - 'example' => '不是有效的email地址', - 'description' => '正则表达式校验错误提示信息。', - ], - 'MinLength' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '最小长度。', - 'example' => '1', - ], - 'MaxLength' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '最大长度。', - 'example' => '10', - ], - 'Minimum' => [ - 'type' => 'number', - 'format' => 'double', - 'description' => '数字最小值。', - 'example' => '1', - ], - 'Maximum' => [ - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - 'description' => '数字最大值。', - ], - 'Required' => [ - 'type' => 'boolean', - 'description' => '是否必填。', - 'example' => 'false', - ], - 'System' => [ - 'type' => 'boolean', - 'example' => 'false', - 'description' => '是否是系统字段。', - ], - 'Disabled' => [ - 'type' => 'boolean', - 'description' => '是否被禁用。', - 'example' => 'false', - ], - 'Array' => [ - 'type' => 'boolean', - 'description' => '是否是数组。', - 'example' => 'false', - ], - 'ReadOnly' => [ - 'type' => 'boolean', - 'description' => '是否只读。', - 'example' => 'false', - ], - 'EditorType' => [ + [ + 'name' => 'SearchPattern', + 'in' => 'query', + 'schema' => ['description' => '根据坐席登录名或坐席展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'agent'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'query', + 'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => false, 'example' => 'ankedayaopin@zcwlwhkf'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'List' => [ + 'description' => '坐席列表。', + 'type' => 'array', + 'items' => [ + 'description' => '坐席信息。', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '坐席展示名。', 'type' => 'string', 'example' => '坐席小王'], + 'LoginName' => ['description' => '坐席登录名。', 'type' => 'string', 'example' => 'agent'], + 'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'], + 'WorkMode' => [ + 'description' => '工作模式。', 'type' => 'string', - 'description' => '编辑器类型。', - 'example' => 'textbox', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', ], - 'Attributes' => [ + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1382114****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'DisplayId' => ['description' => '坐席的工号。', 'type' => 'string', 'example' => '1001'], + 'RoleName' => [ + 'description' => '角色名称。', 'type' => 'string', - 'description' => '扩展属性。', - 'example' => '{}'."\n", - ], - 'DisplayOrder' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '列表展示顺序。', - 'example' => '1', + 'enumValueTitles' => ['Mannager' => '技能组组长', 'Agent' => '坐席', 'Admin' => '管理员'], + 'example' => 'Admin', ], - 'CreatedTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '创建时间。', - 'example' => '1703517780627', + 'RoleId' => ['description' => '角色ID，格式为：角色@实例ID。', 'type' => 'string', 'example' => 'Admin@ccc-test'], + 'PrimaryAccount' => ['description' => '坐席映射的RAM账户是否为RAM主账号。', 'type' => 'boolean', 'example' => '已弃用，请使用Primary代替此参数。', 'default' => '已弃用，请使用Primary代替此参数'], + 'PersonalOutboundNumberList' => [ + 'description' => '坐席个人外呼号码列表。', + 'type' => 'array', + 'items' => [ + 'description' => '号码信息。', + 'type' => 'object', + 'properties' => [ + 'Number' => ['description' => '号码。', 'type' => 'string', 'example' => '0830011****'], + 'Active' => ['description' => '是否可用。', 'type' => 'boolean', 'example' => 'true'], + 'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '乐山'], + 'Usage' => [ + 'description' => '号码用途。', + 'type' => 'string', + 'enumValueTitles' => ['Outbound' => '呼出', 'Inbound' => '呼入', 'Bidirection' => '呼入及呼出'], + 'example' => 'Bidirection', + ], + 'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '四川'], + ], + ], ], - 'UpdatedTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1716211430928', - 'description' => '更新时间。', + 'SkillLevelList' => [ + 'description' => '坐席关联的技能组等级列表。', + 'type' => 'array', + 'items' => [ + 'description' => '技能组等级信息。', + 'type' => 'object', + 'properties' => [ + 'SkillLevel' => ['description' => '技能等级。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'SkillGroupName' => ['description' => '技能组名称。', 'type' => 'string', 'example' => 'skillgroup'], + ], + ], ], - 'Creator' => [ + 'RamId' => ['description' => '坐席关联的RAM账号的UID。', 'type' => 'integer', 'format' => 'int64', 'example' => '21234502254620****'], + 'Extension' => ['description' => '座机分机号。', 'type' => 'string', 'example' => '8031****'], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'DeviceExt' => ['description' => 'SIP话机分机号，如果座席注册了SIP话机，则此参数为SIP话机设备的分机号。', 'type' => 'string', 'example' => '8033****'], + 'DeviceState' => [ + 'description' => 'SIP话机设备的状态，如果未注册SIP话机，则状态为UNREGISTERED（未注册），如过SIP话机注册过但是不在线，则状态为OFFLINE（离线），如果SIP话机注册过并且在线则为ONLINE（在线）。', 'type' => 'string', - 'description' => '创建者。', - 'example' => 'creator@ccc-test', + 'enumValueTitles' => ['UNREGISTERED' => '未注册', 'OFFLINE' => '离线', 'ONLINE' => '在线'], + 'example' => 'OFFLINE', ], + 'Primary' => ['description' => '坐席映射的RAM账户是否为RAM主账号。', 'type' => 'boolean'], ], - 'description' => '字段。', ], ], - 'CreatedTime' => [ - 'description' => '创建时间。'."\n", - 'type' => 'string', - 'example' => '1703517780627', - ], - 'UpdatedTime' => [ - 'description' => '上次修改的时间。', - 'type' => 'string', - 'example' => '1716211430928', - ], ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], 'Params' => [ - 'description' => '错误参数列表。', + 'description' => '响应参数。', 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Id\\": \\"ticketing\\",\\n \\"Properties\\": {\\n \\"key\\": {\\n \\"DisplayName\\": \\"姓名\\",\\n \\"Description\\": \\"name\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 10,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\\\n\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1703517780627,\\n \\"UpdatedTime\\": 1716211430928,\\n \\"Creator\\": \\"creator@ccc-test\\"\\n }\\n },\\n \\"CreatedTime\\": \\"1703517780627\\",\\n \\"UpdatedTime\\": \\"1716211430928\\"\\n },\\n \\"RequestId\\": \\"30C7D235-DDCF-4C7F-A462-5E2598252C2B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取工单字段定义', - 'summary' => '使用ListCommonTicketFields获取实例下定义的工单字段类型。', - ], - 'TerminateTicket' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '获取坐席列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsers'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"DisplayId\\": \\"1001\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"PrimaryAccount\\": true,\\n \\"PersonalOutboundNumberList\\": [\\n {\\n \\"Number\\": \\"0830011****\\",\\n \\"Active\\": true,\\n \\"City\\": \\"乐山\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ],\\n \\"SkillLevelList\\": [\\n {\\n \\"SkillLevel\\": 5,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\"\\n }\\n ],\\n \\"RamId\\": 0,\\n \\"Extension\\": \\"8031****\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"DeviceExt\\": \\"8033****\\",\\n \\"DeviceState\\": \\"OFFLINE\\",\\n \\"Primary\\": true\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n 1\\n 10\\n 1\\n \\n user-test\\n 1886666****@163.com\\n Yealink SIP-T23G 44.84.203.6\\n false\\n 2022546208793\\n 1001\\n Admin@ccc-test\\n 1382114****\\n 80xxxx31\\n OFFLINE\\n Admin\\n user-test@ccc-test\\n 测试用户\\n 80xxxx33\\n ON_SITE\\n \\n Bidirection\\n true\\n 083xxxx0011\\n 乐山\\n 四川\\n \\n \\n skg-test\\n 5\\n skg-test@ccc-test\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'ListVisitorChatMessages' => [ + 'summary' => '使用ListVisitorChatMessages获取访客聊天记录。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => ['description' => '排序方式，默认为降序。'."\n" + ."\n" + .'枚举值：'."\n" + ."\n" + .'ASC：升序。'."\n" + ."\n" + .'DESC：降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'], + ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '云联络中心实例。', 'type' => 'string', 'required' => false, 'example' => 'ccc-test'], ], [ - 'name' => 'TicketId', + 'name' => 'VisitorId', 'in' => 'query', - 'schema' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'required' => false, - 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', - ], + 'schema' => ['description' => '访客ID。', 'type' => 'string', 'required' => false, 'example' => 'fcd020fe-****-1a272a174a7d'], ], [ - 'name' => 'Comment', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '处理意见。', - 'type' => 'string', - 'required' => false, - 'example' => '关单', - ], + 'schema' => ['description' => '开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1647325450000'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '结束时间，格式为Unix时间戳，单位毫秒。', 'type' => 'string', 'required' => false, 'example' => '1650316799000'], + ], + [ + 'name' => 'NextPageToken', + 'in' => 'query', + 'schema' => ['description' => '下一页标识。第一次请求无需传入，服务会返回，第二次请求传入即可。', 'type' => 'string', 'required' => false, 'example' => '1737193352340::7463707254.EAUNIT'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页每页数据集大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'AccessToken', + 'in' => 'query', + 'schema' => ['description' => '网络业务渠道Token。', 'type' => 'string', 'required' => false, 'example' => '9XYGTGWtq2wXzVikKuip_zeVGl6O4VJ-l-*-*-JPofhap4P7fAevuE='], + ], + [ + 'name' => 'AccessChannelId', + 'in' => 'query', + 'schema' => ['description' => '网络业务渠道ID。', 'type' => 'string', 'required' => false, 'example' => 'cf584733-***-***-9699-cb77aa3b7aa6'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'CloseTicketResponse', - 'description' => 'CloseTicketResponse', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ 'description' => '数据。', - 'type' => 'any', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', + 'type' => 'object', + 'properties' => [ + 'NextPageToken' => ['description' => '下一页标识。', 'type' => 'string', 'example' => '1737193352340::7463707254.EAUNIT'."\n"], + 'Messages' => [ + 'description' => '消息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '消息。', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'chat-65382141036853491'], + 'SenderId' => ['description' => '消息发送用户ID。', 'type' => 'string', 'example' => 'fcd020fe-****-1a272a174a7d'."\n"], + 'SenderType' => ['description' => '发送方类型。'."\n" + ."\n" + .'枚举值'."\n" + .'- **ADMIN**：系统'."\n" + .'- **CUSTOMER**：访客'."\n" + .'- **AGENT**：坐席', 'type' => 'string', 'example' => 'CUSTOMER'], + 'Timestamp' => ['description' => '时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1696126980371'], + 'Content' => ['description' => '消息内容。', 'type' => 'string', 'example' => '{"variables":{},"text":"Hi，我是小云~ 很高兴遇见你！","contentType":"Text"}'], + 'SenderName' => ['description' => '发送者名称。', 'type' => 'string', 'example' => '访客1'], + 'SenderAvatarUrl' => ['description' => '发送者头像地址。', 'type' => 'string', 'example' => 'http://xxxxx.com/avatar.png'], + ], + ], + ], ], ], ], @@ -45055,26 +20983,23 @@ ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 403 => [ + ['errorCode' => 'Permission.Unauthorized', 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', 'description' => '您无权执行此操作。 必须具有指定权限。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '关闭工单', - 'summary' => '使用TerminateTicket关闭工单。', - ], - 'GetTicketSummaryReport' => [ - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"NextPageToken\\": \\"1737193352340::7463707254.EAUNIT\\\\n\\",\\n \\"Messages\\": [\\n {\\n \\"JobId\\": \\"chat-65382141036853491\\",\\n \\"SenderId\\": \\"fcd020fe-****-1a272a174a7d\\\\n\\",\\n \\"SenderType\\": \\"CUSTOMER\\",\\n \\"Timestamp\\": 1696126980371,\\n \\"Content\\": \\"{\\\\\\"variables\\\\\\":{},\\\\\\"text\\\\\\":\\\\\\"Hi，我是小云~ 很高兴遇见你！\\\\\\",\\\\\\"contentType\\\\\\":\\\\\\"Text\\\\\\"}\\",\\n \\"SenderName\\": \\"访客1\\",\\n \\"SenderAvatarUrl\\": \\"http://xxxxx.com/avatar.png\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取访客聊天记录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ListVoicemails' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -45083,582 +21008,598 @@ 'BearerToken' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc0NRNJB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'State', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '工单状态。'."\n" - .'- Processing（处理中）'."\n" - .'- Withdrawal（已撤回）'."\n" - .'- Rejected（已退回）'."\n" - .'- Closed（已关单）', - 'type' => 'string', - 'required' => false, - 'example' => '无', - ], + 'schema' => ['description' => '分页序号，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'CategoryId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '工单类目ID。', - 'type' => 'string', - 'required' => false, - 'example' => '43c2671b-***-***-86d0-6bd187905cc8', - ], + 'schema' => ['description' => '分页大小，范围1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间，基于工单创建时间过滤。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1716998400000', - ], + 'schema' => ['description' => '获取的历史数据的起始时间，默认为当天的0时，时间戳为毫秒级。（必填）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1532448000000'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间，基于工单创建时间过滤。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1719590399999', - ], - ], - [ - 'name' => 'Creator', - 'in' => 'query', - 'schema' => [ - 'description' => '创建人ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'creator@ccc-test', - ], - ], - [ - 'name' => 'Assignee', - 'in' => 'query', - 'schema' => [ - 'description' => '处理者ID（坐席ID或技能组ID）。', - 'type' => 'string', - 'required' => false, - 'example' => 'assignee@ccc-test'."\n", - ], - ], - [ - 'name' => 'AssigneeType', - 'in' => 'query', - 'schema' => [ - 'description' => '处理者类型。'."\n" - .'- Agent（坐席）'."\n" - .'- SkillGroup（技能组）', - 'type' => 'string', - 'required' => false, - 'example' => 'Agent', - ], + 'schema' => ['description' => '获取的历史数据的终止时间，默认为当前时间，时间戳为毫秒级。（必填）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1532707199000'], ], [ - 'name' => 'Participant', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => '参与人ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'participant@ccc-test'."\n", - ], + 'schema' => ['description' => '通过指定的contactId来查询某一通电话的记录，contactId可以通过软电话SDK发生通话时获取到。如果传入该参数，则自动忽略其他查询参数。', 'type' => 'string', 'required' => false, 'example' => 'job-125152394144124921'], ], [ - 'name' => 'PageNumber', + 'name' => 'Caller', 'in' => 'query', - 'schema' => [ - 'description' => '分页参数。默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '主叫号码。'."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => '073xxxx7539'], ], [ - 'name' => 'PageSize', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => '语音信箱名称。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'voicemail-test'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'TicketsCreated' => [ - 'description' => '工单创建数量。', - 'type' => 'string', - 'example' => '10', - ], - 'TicketsParticipated' => [ - 'description' => '工单已处理数量。', - 'type' => 'string', - 'example' => '5', - ], - 'TicketsAssigned' => [ - 'description' => '工单待处理数量。', - 'type' => 'string', - 'example' => '3', + 'PageNumber' => ['description' => '分页序号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '总条目数，只有PageNumber为1才会返回，其他都是0。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'], + 'List' => [ + 'description' => '语音信箱记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '语音信箱记录。', + 'type' => 'object', + 'properties' => [ + 'CdrStartTime' => ['description' => '话务开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000，已废弃，请使用StartTime。'], + 'Caller' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '073xxxx7539'], + 'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-125152394144124921'], + 'RecordingDuration' => ['description' => '留言时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '10，已废弃，请使用Duration'], + 'InstanceId' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'Name' => ['description' => '语音信箱名称。', 'type' => 'string', 'example' => 'voicemail-test'], + 'Callee' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '0533128****'], + 'StartTime' => ['description' => '语音信箱开始时间。', 'type' => 'string', 'example' => '1631440860000'], + 'Duration' => ['description' => '留言时长，单位秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'], + ], + ], ], ], ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EAF3C248-E123-441B-A545-B6CD02E98EED\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"TicketsCreated\\": \\"10\\",\\n \\"TicketsParticipated\\": \\"5\\",\\n \\"TicketsAssigned\\": \\"3\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', - 'title' => '获取工单处理数据', - 'summary' => '使用GetTicketSummaryReport获取工单状态统计数据。', - ], - 'ResubmitTicket' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '获取语音信箱列表', + 'summary' => '调用ListVoicemails获取指定实例下语音信箱列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVoicemails'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"CdrStartTime\\": 0,\\n \\"Caller\\": \\"073xxxx7539\\",\\n \\"ContactId\\": \\"job-125152394144124921\\",\\n \\"RecordingDuration\\": 0,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"voicemail-test\\",\\n \\"Callee\\": \\"0533128****\\",\\n \\"StartTime\\": \\"1631440860000\\",\\n \\"Duration\\": 16\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 200\\n 无\\n EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n \\n 1\\n 10\\n 11\\n \\n 1532448000000\\n 073xxxx7539\\n job-125152394144124921\\n 10\\n ccc-test\\n voicemail-test\\n \\n \\n","errorExample":""}]', + ], + 'ListWaitingChats' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'TicketId', - 'in' => 'query', - 'schema' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Comment', + 'name' => 'SkillGroupIdList', 'in' => 'query', - 'schema' => [ - 'description' => '处理意见。', - 'type' => 'string', - 'required' => false, - 'example' => '信息已补充', - ], + 'schema' => ['description' => '技能组ID列表。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test"]'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'CloseTicketResponse', - 'description' => 'CloseTicketResponse', 'type' => 'object', 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], 'Data' => [ - 'description' => '数据。', - 'type' => 'any', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '错误参数列表。', + 'description' => '返回数据。', 'type' => 'array', 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', + 'description' => '会话信息。', + 'type' => 'object', + 'properties' => [ + 'ChatConversationId' => ['description' => '聊天会话ID。', 'type' => 'string', 'example' => '$23086709$EAUNIT'], + 'BeingAssigned' => ['description' => '会话是否已分配坐席。', 'type' => 'boolean', 'example' => 'false'], + 'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'chat-434537064047960064'], + 'EnqueueTime' => ['description' => '进入队列时刻，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1718868572094'], + 'AccessChannelId' => ['description' => '网络业务渠道ID。', 'type' => 'string', 'example' => '843073c2-*****-49fb-a616-738ddddfebdc'], + 'AccessChannelType' => ['description' => '网络业务渠道类型。', 'type' => 'string', 'example' => 'Web'], + 'UserList' => [ + 'description' => '用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户。', + 'type' => 'object', + 'properties' => [ + 'UserName' => ['description' => '用户姓名。', 'type' => 'string', 'example' => '访客-1c***'], + 'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => 'c361765f-******-4e07-b81c-4b5d9183fac6'."\n"], + 'UserType' => ['description' => '用户类型。', 'type' => 'string', 'example' => 'CUSTOMER'], + 'AvatarUrl' => ['description' => '头像链接。', 'type' => 'string', 'example' => '无'], + ], + ], + ], + 'Messages' => [ + 'description' => '消息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SenderId' => ['description' => '消息发送用户ID。', 'type' => 'string', 'example' => 'c361765f-******-4e07-b81c-4b5d9183fac6'], + 'Content' => ['description' => '内容信息。', 'type' => 'string', 'example' => '测试消息'], + 'SenderType' => ['description' => '发送方类型。取值：'."\n" + .'- **CUSTOMER**：访客'."\n" + .'- **AGENT**：坐席', 'type' => 'string', 'example' => '{"variables":{},"text":"

这种的名片选单面还是双面

"}'], + ], + 'description' => '', + ], + ], + 'SkillGroupId' => ['description' => '技能组信息。', 'type' => 'string', 'example' => 'skill@ccc-test'], + ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '重新提交工单', - 'summary' => '使用ResubmitTicket接口对驳回/退回的工单重新提交。', - ], - 'DeleteTicketTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Data\\": [\\n {\\n \\"ChatConversationId\\": \\"$23086709$EAUNIT\\",\\n \\"BeingAssigned\\": false,\\n \\"JobId\\": \\"chat-434537064047960064\\",\\n \\"EnqueueTime\\": 1718868572094,\\n \\"AccessChannelId\\": \\"843073c2-*****-49fb-a616-738ddddfebdc\\",\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"UserList\\": [\\n {\\n \\"UserName\\": \\"访客-1c***\\",\\n \\"UserId\\": \\"c361765f-******-4e07-b81c-4b5d9183fac6\\\\n\\",\\n \\"UserType\\": \\"CUSTOMER\\",\\n \\"AvatarUrl\\": \\"无\\"\\n }\\n ],\\n \\"Messages\\": [\\n {\\n \\"SenderId\\": \\"c361765f-******-4e07-b81c-4b5d9183fac6\\",\\n \\"Content\\": \\"测试消息\\",\\n \\"SenderType\\": \\"{\\\\\\"variables\\\\\\":{},\\\\\\"text\\\\\\":\\\\\\"

这种的名片选单面还是双面

\\\\\\"}\\"\\n }\\n ],\\n \\"SkillGroupId\\": \\"skill@ccc-test\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取队列中的聊天', + 'summary' => '坐席通过ListWaitingChats获取队列中等待分配或认领的聊天。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'MakeCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '50581', + 'abilityTreeNodes' => ['FEATUREcccIPHVDY'], ], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '工单模板ID。', - 'type' => 'string', - 'required' => false, - 'example' => '**43c2671b-8939-4223-***-6bd187905cc8_1717664210492', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'InstanceId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], + 'schema' => ['description' => '发起外呼的坐席ID，非必填，不填默认使用当前RAM账号映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], + ], + [ + 'name' => 'Caller', + 'in' => 'query', + 'schema' => ['description' => '主叫号码，如果是内部呼叫，这此参数无效，如果是外部呼叫，此参数为当前坐席可用的外呼号码，需要确保该号码可外呼且坐席对该号码有使用权，使用权通过两种途径获得，一是将号码绑定到当前坐席签入的技能组上，二是将号码设置为坐席的个人外呼号码。', 'type' => 'string', 'required' => false, 'example' => '010989****'], + ], + [ + 'name' => 'Callee', + 'in' => 'query', + 'schema' => ['description' => '被叫号码，如果是内部呼叫，该字段填写目标坐席的分机号，如果是外呼呼叫，填写客户的电话号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1318888****'], + ], + [ + 'name' => 'TimeoutSeconds', + 'in' => 'query', + 'schema' => ['description' => '超时时间，呼叫在经过该参数指定的时间仍然未接通的情况下，则主动挂断，取值范围30-300，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '300', 'minimum' => '30', 'example' => '30'], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => ['description' => '随路数据，客户无需关心。', 'type' => 'string', 'required' => false, 'example' => 'tags'], + ], + [ + 'name' => 'MaskedCallee', + 'in' => 'query', + 'schema' => ['description' => '脱敏后的被叫号码，如果该字段不为空，表示需要对被叫号码脱敏，脱敏规则由客户自行定义，只需将脱敏后的被叫号码填入即可，使用脱敏被叫会导致某些场景下看到的是脱敏后的被叫号码，无法查看真实被叫号码。', 'type' => 'string', 'required' => false, 'example' => '131****8888'], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括VIDEO。', 'type' => 'string', 'required' => false, 'example' => 'AUDIO'], + ], + [ + 'name' => 'FlashSmsVariables', + 'in' => 'query', + 'schema' => ['description' => '闪信配置', 'type' => 'string', 'required' => false, 'example' => '{\\"applicationId\\":\\"6bd18325-ea7f-4881-8902-4d06283d3b3b\\",\\"templateId\\":\\"1722217249064\\"}'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'DeleteTicketTemplateResponse', - 'description' => 'DeleteTicketTemplateResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'any', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94'], 'Params' => [ - 'description' => '错误参数列表。', + 'description' => '响应参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], + 'Data' => [ + 'description' => '数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'ContextId' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6570007401392****'], + 'CallVariables' => ['description' => '随路数据。通过SIP信令传递的自定义数据。', 'type' => 'string', 'example' => 'a=b;c=d'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '无'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'NONE', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '8001****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'MONITORING', + ], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609225718295'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6570007401392****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8001****'], + 'MediaType' => ['description' => '媒体类型，默认是语音(AUDIO), 其他可选参数包括VIDEO。', 'type' => 'string', 'example' => 'Audio'], + ], + ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6570007401392****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'READY', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], + ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'UserBusy', 'errorMessage' => 'The user %s you called was busy. Please try again later.', 'description' => '您呼叫的用户正忙，请稍后再试。'], + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.Extension', 'errorMessage' => 'No available extension number exists.', 'description' => '没有可分配的分机号。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '删除工单模板', - 'summary' => '使用DeleteTicketTemplate删除指定工单模板。', - ], - 'RejectTicket' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 123456,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"CallVariables\\": \\"a=b;c=d\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609225718295,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"MediaType\\": \\"Audio\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\n无\\n200\\n无\\n\\n 123456\\n \\n ccc-test\\n OUTBOUND\\n job-65700074013925376\\n \\n 8001****\\n NONE\\n 无\\n 1318888****\\n []\\n 无\\n user-test@ccc-test\\n 8001****\\n OUTBOUND\\n 无\\n ch:user:131888****->8001****:1609225718294:job-65700074013925376\\n 1609225718295\\n job-65700074013925376\\n \\n \\n \\n 8001****\\n READY\\n ccc-test\\n Warm-up\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c\\n false\\n job-65700074013925376\\n ON_SITE\\n [\\"skill-group@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', + 'title' => '发起呼叫', + 'summary' => '调用MakeCall发起呼叫，被叫可以是内部坐席，也可以是外部客户 。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-08T07:49:03.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-08-30T02:20:48.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-01-11T08:11:36.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-10-26T08:13:46.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-11-29T08:23:20.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-08-18T13:14:10.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MakeCall'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ModifyAudioFile' => [ + 'summary' => '调用ModifyAudioFile修改指定实例下指定音频资源ID对应的音频文件。可以修改音频文件名称、音频文件展示名和音频文件在OSS中的Key。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'TicketId', + 'name' => 'AudioResourceId', 'in' => 'query', - 'schema' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5', - ], + 'schema' => ['description' => '音频资源ID，唯一标识一个音频文件。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acc300c4-75c9-41ba-ba5e-2a365c96c248'], ], [ - 'name' => 'Comment', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '处理意见。', - 'type' => 'string', - 'required' => false, - 'example' => '请补充信息。', - ], + 'schema' => ['description' => '音频文件的展示名，长度为1-32个字符，修改音频文件时无法修改展示名，因此此处需要填写音频文件原始的展示名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '欢迎语'], + ], + [ + 'name' => 'OssFileKey', + 'in' => 'query', + 'schema' => ['description' => '待修改的音频文件在OSS中的Key。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test/new-test-file.wav'], + ], + [ + 'name' => 'AudioFileName', + 'in' => 'query', + 'schema' => ['description' => '待修改的音频文件名称，可以填写新的音频文件内容。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'new-test-file.wav'], + ], + [ + 'name' => 'Usage', + 'in' => 'query', + 'schema' => ['description' => '音频文件用途，默认为General（用于IVR等场景）， 其他可选值为HoldMusic（通话保持等待音）。', 'type' => 'string', 'required' => false, 'example' => 'General'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'TurnDownTicketResponse', - 'description' => 'TurnDownTicketResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据。'."\n", - 'type' => 'any', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D2F84AAC-7C79-547F-8EE9-7B735F42B93F'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"678F7002-CA01-4ABF-A112-585AFBDF3A3B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '退回工单', - 'summary' => '使用RejectTicket退回工单，退回的工单在创建人补充信息后可以重新提交。', - ], - 'DisableTicketTemplate' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '修改音频文件', + 'changeSet' => [ + ['createdAt' => '2023-11-17T01:12:04.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAudioFile'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D2F84AAC-7C79-547F-8EE9-7B735F42B93F\\"\\n}","type":"json"}]', + ], + 'ModifyCampaignNumbers' => [ + 'summary' => '修改批量预测式外呼活动的主叫号码。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'CampaignId', + 'in' => 'query', + 'schema' => ['title' => '活动ID', 'description' => '活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-****-****-21019d382a09'], + ], + [ + 'name' => 'InstGroupId', + 'in' => 'query', + 'schema' => ['title' => '号码集合ID', 'description' => '号码集合ID。', 'type' => 'string', 'required' => false, 'example' => '3971876649-****-****-098763a382a09'."\n"], + ], + [ + 'name' => 'NumberList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '工单模板ID。', - 'type' => 'string', + 'title' => '号码列表', + 'description' => '号码列表。', + 'type' => 'array', + 'items' => ['description' => '号码。', 'type' => 'string', 'required' => false, 'example' => '["0830011xxxx", "0830312xxxx"]'], 'required' => false, - 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492', ], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'DisableTicketTemplateResponse', - 'description' => 'DisableTicketTemplateResponse', + 'title' => 'ModifyCampaignNumbersResponse', + 'description' => 'ModifyCampaignNumbersResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'any', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + 'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'], 'Params' => [ 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -45666,314 +21607,175 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '下线工单模板', - 'summary' => '使用DisableTicketTemplate进行工单模板的下线操作，下线状态的模板在新建工单时不能被选中。', - ], - 'WithdrawTicket' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '修改预测式外呼活动主叫号码', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ModifyCustomCallTagging' => [ + 'summary' => '调用ModifyCustomCallTagging修改指定实例下指定号码对应的呼入号码标记的信息，可以修改呼入号码标记的描述和绑定的号码标签。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ - 'name' => 'TicketId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'required' => true, - 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Comment', + 'name' => 'Number', 'in' => 'query', - 'schema' => [ - 'description' => '处理意见。', - 'type' => 'string', - 'required' => true, - 'example' => '撤回，补充信息', - ], + 'schema' => ['description' => '呼入号码标记的号码，会根据号码匹配待修改的呼入号码标记。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312121****'], ], [ - 'name' => 'InstanceId', + 'name' => 'CallTagNameList', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '号码标签名称列表，请传入待修改的完整的号码标签列表，确保号码标签已创建。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["TagA","TagB"]'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '新的呼入号码标记描述，非必填，默认为空，为空表示不修改。', 'type' => 'string', 'required' => false, 'example' => '王先生'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'CancelTicketResponse', - 'description' => 'CancelTicketResponse', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'any', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], ], ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'LimitExceed.CallTagsPerNumber', 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', 'description' => '号码标签数量超出单个呼入号码标记的上线阈值。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.CustomCallTagging', 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', 'description' => '呼入号码标记不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '撤回工单', - 'summary' => '使用WithdrawTicket撤回工单。', - ], - 'ListTicketTasks' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '修改呼入号码标记', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-02-24T14:31:19.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustomCallTagging'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"无\\nBA03159C-E808-4FF1-B27E-A61B6E888D7F\\n200\\nOK","errorExample":""}]', + ], + 'ModifyInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'TicketId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'required' => false, - 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', - ], + 'schema' => ['description' => '实例的描述，长度不超过256个字符。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '新的实例描述。'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ListTicketTasksResponse', - 'description' => 'ListTicketTasksResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TaskName' => [ - 'description' => '节点名称。', - 'type' => 'string', - 'example' => '节点1', - ], - 'Assignee' => [ - 'description' => '处理人ID。', - 'type' => 'string', - 'example' => 'assignee@ccc-test', - ], - 'Comment' => [ - 'description' => '处理意见。', - 'type' => 'string', - 'example' => '同意', - ], - 'StartTime' => [ - 'description' => '开始时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1620259200000', - ], - 'EndTime' => [ - 'description' => '结束时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1620269200000', - ], - 'AssigneeName' => [ - 'description' => '处理人姓名。', - 'type' => 'string', - 'example' => 'assignee', - ], - 'TaskId' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'example' => 'eb039a4a6a5742c6b44ccff0c1fca745', - ], - 'TicketId' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'."\n", - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'FileKeys' => [ - 'description' => '文件列表。', - 'type' => 'array', - 'items' => [ - 'description' => '文件。', - 'type' => 'string', - 'example' => '["ticket-file/xxx.png"]', - ], - ], - 'FileUrls' => [ - 'description' => '文件访问链接列表。', - 'type' => 'array', - 'items' => [ - 'description' => '文件访问链接。', - 'type' => 'string', - 'example' => '["http://oss-cn-hangzhou.com/bucket/ticket-file/xxx.png"]', - ], - ], - 'TaskDefinitionNodeId' => [ - 'description' => '工单节点流程定义ID。', - 'type' => 'string', - 'example' => 'APPROVAL__6zu2QjAz', - ], - 'TaskDefinitionNodeType' => [ - 'description' => '工单节点流程定义类型。', - 'type' => 'string', - 'example' => 'APPROVAL', - ], - 'Action' => [ - 'description' => '节点处理动作。', - 'type' => 'string', - 'example' => 'CounterSignTask', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '83TKE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TaskName\\": \\"节点1\\",\\n \\"Assignee\\": \\"assignee@ccc-test\\",\\n \\"Comment\\": \\"同意\\",\\n \\"StartTime\\": 1620259200000,\\n \\"EndTime\\": 1620269200000,\\n \\"AssigneeName\\": \\"assignee\\",\\n \\"TaskId\\": \\"eb039a4a6a5742c6b44ccff0c1fca745\\",\\n \\"TicketId\\": \\"5491d3b4-14ee-4341-b5f1-db2c78beddeb\\\\n\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"FileKeys\\": [\\n \\"[\\\\\\"ticket-file/xxx.png\\\\\\"]\\"\\n ],\\n \\"FileUrls\\": [\\n \\"[\\\\\\"http://oss-cn-hangzhou.com/bucket/ticket-file/xxx.png\\\\\\"]\\"\\n ],\\n \\"TaskDefinitionNodeId\\": \\"APPROVAL__6zu2QjAz\\",\\n \\"TaskDefinitionNodeType\\": \\"APPROVAL\\",\\n \\"Action\\": \\"CounterSignTask\\"\\n }\\n ],\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取工单节点信息', - ], - 'ListTickets' => [ - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '修改实例', + 'summary' => '调用ModifyInstance修改云联络中心实例。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstance'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"83TKE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"83TKE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n无\\nOK","errorExample":""}]', + ], + 'ModifyPhoneNumber' => [ + 'summary' => '调用ModifyPhoneNumber修改指定实例下指定号码的信息，主要是修改号码用途和绑定的联系流ID。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -45982,164 +21784,121 @@ 'BearerToken' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PageNumber', + 'name' => 'Number', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0102134****'], ], [ - 'name' => 'InstanceId', + 'name' => 'Usage', 'in' => 'query', 'schema' => [ - 'description' => '实例ID。', + 'description' => '号码用途。', 'type' => 'string', 'required' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'TicketId', - 'in' => 'query', - 'schema' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'required' => false, - 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', + 'docRequired' => true, + 'enumValueTitles' => ['Outbound' => '呼出', 'Inbound' => '呼入', 'Bidirection' => '呼入和呼出'], + 'example' => 'Bidirection', + 'maxLength' => 200, + 'minLength' => 1, ], ], [ - 'name' => 'Title', + 'name' => 'ContactFlowId', 'in' => 'query', - 'schema' => [ - 'description' => '工单标题。', - 'type' => 'string', - 'required' => false, - 'example' => '标题', - ], + 'schema' => ['description' => '号码绑定的IVR联系流ID，仅在号码用途为Inbound或Bidirection时，该字段才有效。', 'type' => 'string', 'required' => false, 'example' => '78128960-bb00-4ddc-8a82-923a8c5bd22d'], ], - [ - 'name' => 'State', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '工单状态。', - 'type' => 'string', - 'required' => false, - 'example' => 'Processing', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + ], + 'description' => '', ], ], - [ - 'name' => 'CategoryId', - 'in' => 'query', - 'schema' => [ - 'description' => '工单类目ID。', - 'type' => 'string', - 'required' => false, - 'example' => '43c2671b-****-4223-86d0-6bd187905cc8', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], ], - [ - 'name' => 'Creator', - 'in' => 'query', - 'schema' => [ - 'description' => '创建者。', - 'type' => 'string', - 'required' => false, - 'example' => 'creator@cccV2-kmz', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的号码。'], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '开始时间，基于工单创建时间过滤。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1646841600000', - ], + ], + 'title' => '修改号码', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPhoneNumber'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', + ], + 'ModifySkillGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '结束时间，基于工单创建时间过滤。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1646928000000', - ], + 'AK' => [], ], [ - 'name' => 'CustomerId', - 'in' => 'query', - 'schema' => [ - 'description' => '客户ID，云联络中心客户资料ID。', - 'type' => 'string', - 'required' => false, - 'example' => '51e155ce-3747-*****-b402-13c69597b920', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], + ], + 'parameters' => [ [ - 'name' => 'JobIdList', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '话务ID列表。', - 'type' => 'string', - 'required' => false, - 'example' => '["job-12******","job-23****"]', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Assignee', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '处理者ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'assignee@cccV2-kmz'."\n", - ], + 'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'], ], [ - 'name' => 'AssigneeType', + 'name' => 'DisplayName', 'in' => 'query', - 'schema' => [ - 'description' => '处理者类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'Agent', - ], + 'schema' => ['description' => '技能组展示名，长度为1-64个字符。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '新测试技能组', 'maxLength' => 200, 'minLength' => 1], ], [ - 'name' => 'Participant', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '参与人ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'participant@cccV2-kmz'."\n", - ], + 'schema' => ['description' => '技能组的描述，非必填，默认为空。', 'type' => 'string', 'required' => false, 'example' => '云联络中心的新测试技能组。'], ], ], 'responses' => [ @@ -46147,1015 +21906,741 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'List' => [ - 'description' => '工单列表。', - 'type' => 'array', - 'items' => [ - 'description' => '工单。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'TicketId' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'example' => 'feb83abd-9f08-49d2-9b56-41d1b66ca0ac', - ], - 'Title' => [ - 'description' => '工单标题。', - 'type' => 'string', - 'example' => '标题', - ], - 'TemplateId' => [ - 'description' => '模板ID。', - 'type' => 'string', - 'example' => 'c844a5f0-496c-4c5b-8a0c-dd27686e8ff6', - ], - 'TemplateVersion' => [ - 'description' => '模板版本。', - 'type' => 'string', - 'example' => '0', - ], - 'CategoryId' => [ - 'description' => '工单类目ID。', - 'type' => 'string', - 'example' => '43c2671b-*****-4223-86d0-6bd187905cc8', - ], - 'CategoryName' => [ - 'description' => '工单类目名称。', - 'type' => 'string', - 'example' => '类目1', - ], - 'StartTime' => [ - 'description' => '工单开始时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1631440860000', - ], - 'EndTime' => [ - 'description' => '工单结束时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1631440860000', - ], - 'State' => [ - 'description' => '状态。', - 'type' => 'string', - 'example' => 'Processing', - ], - 'CloseCode' => [ - 'description' => '工单结束原因。', - 'type' => 'string', - 'example' => 'Completed', - ], - 'Assignee' => [ - 'description' => '处理人ID。', - 'type' => 'string', - 'example' => 'assignee@ccc-test', - ], - 'Comment' => [ - 'description' => '处理意见。', - 'type' => 'string', - 'example' => '无', - ], - 'AssigneeName' => [ - 'description' => '处理人姓名。', - 'type' => 'string', - 'example' => 'Assignee', - ], - 'Creator' => [ - 'description' => '创建人ID。', - 'type' => 'string', - 'example' => 'creator@ccc-test'."\n", - ], - 'CreatorName' => [ - 'description' => '创建者名称。', - 'type' => 'string', - 'example' => 'Creator', - ], - 'Context' => [ - 'description' => '工单表单信息。', - 'type' => 'string', - 'example' => '{"productName":"alynx"}', - ], - 'CreatedTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '1631440860000', - ], - 'UpdatedTime' => [ - 'description' => '更新时间。', - 'type' => 'string', - 'example' => '1631440860000', - ], - 'CurrentTaskId' => [ - 'description' => '当前节点ID。', - 'type' => 'string', - 'example' => '0707dab6-34a8-11ef-9823-161e3802b2d4', - ], - 'CurrentTaskName' => [ - 'description' => '当前节点名称。', - 'type' => 'string', - 'example' => '节点1', - ], - 'CurrentTaskStartTime' => [ - 'description' => '当前节点开始时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1631440860000', - ], - 'CustomerId' => [ - 'description' => '客户ID。', - 'type' => 'string', - 'example' => '51e155ce-*****1-b402-13c69597b920', - ], - 'JobId' => [ - 'description' => '话务ID。', - 'type' => 'string', - 'example' => 'job-47150***150396416', - ], - 'Source' => [ - 'description' => '工单来源。', - 'type' => 'string', - 'example' => 'CHAT', - ], - ], - ], - ], - ], - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TicketId\\": \\"feb83abd-9f08-49d2-9b56-41d1b66ca0ac\\",\\n \\"Title\\": \\"标题\\",\\n \\"TemplateId\\": \\"c844a5f0-496c-4c5b-8a0c-dd27686e8ff6\\",\\n \\"TemplateVersion\\": \\"0\\",\\n \\"CategoryId\\": \\"43c2671b-*****-4223-86d0-6bd187905cc8\\",\\n \\"CategoryName\\": \\"类目1\\",\\n \\"StartTime\\": 1631440860000,\\n \\"EndTime\\": 1631440860000,\\n \\"State\\": \\"Processing\\",\\n \\"CloseCode\\": \\"Completed\\",\\n \\"Assignee\\": \\"assignee@ccc-test\\",\\n \\"Comment\\": \\"无\\",\\n \\"AssigneeName\\": \\"Assignee\\",\\n \\"Creator\\": \\"creator@ccc-test\\\\n\\",\\n \\"CreatorName\\": \\"Creator\\",\\n \\"Context\\": \\"{\\\\\\"productName\\\\\\":\\\\\\"alynx\\\\\\"}\\",\\n \\"CreatedTime\\": \\"1631440860000\\",\\n \\"UpdatedTime\\": \\"1631440860000\\",\\n \\"CurrentTaskId\\": \\"0707dab6-34a8-11ef-9823-161e3802b2d4\\",\\n \\"CurrentTaskName\\": \\"节点1\\",\\n \\"CurrentTaskStartTime\\": 1631440860000,\\n \\"CustomerId\\": \\"51e155ce-*****1-b402-13c69597b920\\",\\n \\"JobId\\": \\"job-47150***150396416\\",\\n \\"Source\\": \\"CHAT\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', - 'title' => '获取工单列表', - 'summary' => '使用ListTickets获取实例下工单列表。', - ], - 'TransferTicketTask' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '修改技能组', + 'summary' => '调用ModifySkillGroup修改指定实例下指定技能组ID对应的技能组的信息，主要是修改技能组展示名和技能组的描述信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySkillGroup'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', + ], + 'ModifySkillLevelsOfUser' => [ + 'summary' => '修改指定实例下指定坐席的一个或多个技能组下的技能等级。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ - 'name' => 'TicketId', - 'in' => 'query', - 'schema' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'required' => false, - 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', - ], - ], - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '节点ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'f780ade8-3ca9-458b-b067-63077946a570', - ], - ], - [ - 'name' => 'Assignee', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '处理人ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'assignee@ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'InstanceId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'Comment', + 'name' => 'SkillLevelList', 'in' => 'query', - 'schema' => [ - 'description' => '处理意见。', - 'type' => 'string', - 'required' => false, - 'example' => '请assignee处理', - ], + 'schema' => ['description' => '技能组的技能等级列表，格式为JSON数组的字符串，数组元素是一个对象，包含两个字段：skillGroupId和skillLevel，skillGroupId填写想要修改的技能组ID，skillLevel填写想要修改的技能等级，取值范围1-10，值越小，业务能力越强，单位时间内能处理更多的通话。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"skillGroupId":"skillgroup1@ccc-test","skillLevel":1},{"skillGroupId":"skillgroup2@ccc-test","skillLevel":10}]'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'TransferTicketTaskResponse', - 'description' => 'TransferTicketTaskResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'any', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E49D8B83-A3EC-44D4-A920-578BC3C698AD'], + 'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], + 403 => [ + ['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => '您无权访问这些用户。'], + ['errorCode' => 'Permission.SkillGroup', 'errorMessage' => 'You have no permission to access skill group(s) %s.', 'description' => '您无权访问这些技能组。'], + ], + [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"678F7002-CA01-4ABF-A112-585AFBDF3A3B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '工单指派', - 'summary' => '使用TransferTicketTask指派工单给其他处理人处理。', - ], - 'DeleteTicket' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '修改坐席的多个技能等级', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-17T01:12:02.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySkillLevelsOfUser'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E49D8B83-A3EC-44D4-A920-578BC3C698AD\\",\\n \\"Data\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"E49D8B83-A3EC-44D4-A920-578BC3C698AD\\n无\\n200\\n无\\nOK","errorExample":""}]', + ], + 'ModifyUser' => [ + 'summary' => '调用ModifyUser修改指定实例下指定坐席的信息，可修改电话号码、工作模式、角色和工号。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ - 'name' => 'TicketId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'required' => false, - 'example' => '3d26b90a-c5d2-4b09-8219-********', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'InstanceId', + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'user-test@ccc-test'], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => ['description' => '坐席个人电话号码。', 'type' => 'string', 'required' => false, 'example' => '1382114****'], + ], + [ + 'name' => 'WorkMode', 'in' => 'query', 'schema' => [ - 'description' => '实例ID。', + 'description' => '工作模式。', 'type' => 'string', 'required' => true, - 'example' => 'ccc-test', + 'docRequired' => true, + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', ], ], + [ + 'name' => 'RoleId', + 'in' => 'query', + 'schema' => ['description' => '角色ID，格式为：角色@实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Admin@ccc-test'], + ], + [ + 'name' => 'DisplayId', + 'in' => 'query', + 'schema' => ['description' => '坐席的工号。', 'type' => 'string', 'required' => false, 'example' => '1001'], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => ['description' => '用户的全名', 'type' => 'string', 'required' => false, 'example' => '张三疯'], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => ['description' => '是否强制修改。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'Nickname', + 'in' => 'query', + 'schema' => ['description' => '坐席昵称', 'type' => 'string', 'required' => false, 'example' => '老王'], + ], + [ + 'name' => 'AvatarUrl', + 'in' => 'query', + 'schema' => ['description' => '坐席头像地址。', 'type' => 'string', 'required' => false, 'example' => 'http://abc.com/sam.jpb'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'DeleteTicketResponse', - 'description' => 'DeleteTicketResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '响应数据。', - 'type' => 'any', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'], 'Params' => [ - 'description' => '错误参数列表。', + 'description' => '响应参数。', 'type' => 'array', - 'items' => [ - 'description' => '错误参数', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 400 => [ + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], + 403 => [ + ['errorCode' => 'Permission.Common', 'errorMessage' => 'You have no permission to access. %s', 'description' => '您无权进行访问。'], + ['errorCode' => 'Permission.SkillGroup', 'errorMessage' => 'You have no permission to access skill group(s) %s.', 'description' => '您无权访问这些技能组。'], + ], + [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.RoleId', 'errorMessage' => 'Role %s does not exist.', 'description' => '指定的角色不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '删除工单', - 'summary' => '通过DeleteTicket删除指定工单。', - ], - 'EnableTicketTemplate' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '修改坐席', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-04-14T05:54:04.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2021-12-21T08:08:33.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUser'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n无\\nOK","errorExample":""}]', + ], + 'ModifyUserLevelsOfSkillGroup' => [ + 'summary' => '调用ModifyUserLevelsOfSkillGroup修改指定实例下指定技能组下属的一个或多个坐席的技能等级。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '工单模板ID。', - 'type' => 'string', - 'required' => false, - 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'InstanceId', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'], + ], + [ + 'name' => 'UserLevelList', + 'in' => 'query', + 'schema' => ['description' => '坐席技能等级列表，格式为JSON数组的字符串，数组元素是一个对象，包含两个字段：userId和skillLevel，userId填写想要修改的坐席ID，skillLevel填写想要修改的技能等级，取值范围1-10，值越小，业务能力越强，单位时间内能处理更多的通话。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"userId":"agent1@ccc-test","skillLevel":1},{"userId":"agent2@ccc-test","skillLevel":10}]'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'EnableTicketTemplateResponse', - 'description' => 'EnableTicketTemplateResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'any', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E49D8B83-A3EC-44D4-A920-578BC3C698AD'], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'], + ], + 500 => [ + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '上线工单模板', - 'summary' => '使用EnableTicketTemplate上线工单模板，上线中状态的工单模板，可以用于创建工单。', - ], - 'AddTicketTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '修改技能组的多个坐席等级', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUserLevelsOfSkillGroup'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"E49D8B83-A3EC-44D4-A920-578BC3C698AD\\"\\n}","errorExample":""},{"type":"xml","example":"E49D8B83-A3EC-44D4-A920-578BC3C698AD\\n无\\n200\\n无\\nOK","errorExample":""}]', + ], + 'MonitorCall' => [ + 'summary' => '调用MonitorCall监听指定实例下指定通话ID对应的通话。通话必须处于坐席和客户双方正常接通状态，且发起监听的坐席有权限对被监听坐席进行监听。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ - 'name' => 'TicketId', - 'in' => 'query', - 'schema' => [ - 'description' => '工单ID。', - 'type' => 'string', - 'required' => true, - 'example' => '3d26b90a-c5d2-4b09-8219-********', - ], - ], - [ - 'name' => 'TaskId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '工单流程节点ID。', - 'type' => 'string', - 'required' => true, - 'example' => '3b8c672f-48f6-45f5-bf41-9d4cb2b4a716', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Assignee', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '加签指派的处理人。', - 'type' => 'string', - 'required' => true, - 'example' => 'assignee@ccc-test', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'Comment', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '处理意见。', - 'type' => 'string', - 'required' => true, - 'example' => '请assignee处理。', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], ], [ - 'name' => 'InstanceId', + 'name' => 'MonitoredUserId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '被监听的座席的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent2@ccc-test'], ], [ - 'name' => 'Position', + 'name' => 'TimeoutSeconds', 'in' => 'query', - 'schema' => [ - 'description' => '加签位置。'."\n" - .'- Before： 在我之前'."\n" - .'- After: 在我之后', - 'type' => 'string', - 'required' => false, - 'example' => 'After', - ], + 'schema' => ['description' => '监听超时时间，经过指定的时间监听仍未成功，则取消监听，正常情况下，监听操作会马上成功，设置超时时间是为了防止异常发生，此字段选填，默认30，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AddAssigneeToTicketTaskResponse', - 'description' => 'AddAssigneeToTicketTaskResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'any', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'B06B3244-1B44-481B-90C4-F2F92E59D6B5', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Params' => [ - 'description' => '错误参数列表。', + 'description' => '响应参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'CREATED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'MONITORING', + ], + 'SkillGroupId' => ['description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], + ], + ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => ' - OFFICE_PHONE(办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'BREAK', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], + ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"B06B3244-1B44-481B-90C4-F2F92E59D6B5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '工单加签', - 'summary' => '使用AddTicketTask进行加签操作，添加处理人。', - ], - 'ListTicketTemplates' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '监听通话', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:46.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MonitorCall'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 1\\n skg-default@ccc-test\\n \\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'MuteCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ - 'name' => 'SearchPattern', - 'in' => 'query', - 'schema' => [ - 'description' => '模板名称，模糊搜索。', - 'type' => 'string', - 'required' => false, - 'example' => '模板1', - ], - ], - [ - 'name' => 'CategoryId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '工单类目ID。', - 'type' => 'string', - 'required' => false, - 'example' => '43c2671b-********86d0-6bd187905cc8', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'State', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '模板状态。'."\n" - .'- Enabled（已上线）'."\n" - .'- Disabled（已下线）', - 'type' => 'string', - 'required' => false, - 'example' => 'Enabled', - ], + 'schema' => ['description' => '被静音的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'PageNumber', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], ], [ - 'name' => 'PageSize', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6581536084722****'], ], [ - 'name' => 'InstanceId', + 'name' => 'ChannelId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '待静音的话务通道ID，非必填，默认为空，为空表示静音UserId对应的坐席的话务通道。', 'type' => 'string', 'required' => false, 'example' => 'ch:user:1318888****->8001****:1609253204816:job-6581536084722****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ListTicketTemplatesResponse', - 'description' => 'ListTicketTemplatesResponse', 'type' => 'object', 'properties' => [ + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'A275B008-A25B-494D-AB53-93CE253815B6'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], 'Data' => [ - 'description' => '数据。', + 'description' => '数据。'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '25', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'List' => [ - 'description' => '模板列表。', - 'type' => 'array', - 'items' => [ - 'description' => '模板。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'TemplateId' => [ - 'description' => '模板ID。', - 'type' => 'string', - 'example' => 'b5c21219-3a1e-4bc0-92e7-da66e057d2f6', - ], - 'Name' => [ - 'description' => '模板名称。', - 'type' => 'string', - 'example' => '测试模板', - ], - 'State' => [ - 'description' => '状态。', - 'type' => 'string', - 'example' => 'Enabled', - ], - 'Editor' => [ - 'description' => '编辑人。', - 'type' => 'string', - 'example' => 'creator@ccc-test', + 'CallContext' => [ + 'description' => '话务上下文环境。'."\n", + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', ], - 'TicketFields' => [ - 'description' => '模板字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '字段。', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '显示名称。', - 'type' => 'string', - 'example' => '姓名'."\n", - ], - 'Description' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => '姓名字段', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => 'name', - ], - 'DataType' => [ - 'description' => '数据类型'."\n" - .'。', - 'type' => 'string', - 'example' => 'String', - ], - 'Pattern' => [ - 'description' => '正则表达式校验规则。', - 'type' => 'string', - 'example' => '^', - ], - 'PatternErrorMessage' => [ - 'description' => '正则表达式校验错误提示信息', - 'type' => 'string', - 'example' => '不是有效的email地址'."\n", - ], - 'MinLength' => [ - 'description' => '最小长度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'MaxLength' => [ - 'description' => '最大长度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Minimum' => [ - 'description' => '数字最小值。', - 'type' => 'number', - 'format' => 'double', - 'example' => '1', - ], - 'Maximum' => [ - 'description' => '数字最大值。', - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - 'Required' => [ - 'description' => '是否必填。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'System' => [ - 'description' => '是否是系统字段。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Disabled' => [ - 'description' => '是否被禁用。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Array' => [ - 'description' => '是否是数组。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ReadOnly' => [ - 'description' => '是否只读。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'EditorType' => [ - 'description' => '编辑器类型。', - 'type' => 'string', - 'example' => 'textbox', - ], - 'Attribute' => [ - 'description' => '扩展属性。', - 'type' => 'string', - 'example' => '{}', - ], - 'DisplayOrder' => [ - 'description' => '列表展示顺序。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'CreatedTime' => [ - 'description' => '创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1715780670000', - ], - 'UpdatedTime' => [ - 'description' => '更新时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1715780670000', - ], - 'Creator' => [ - 'description' => '创建者。', - 'type' => 'string', - 'example' => 'creator', + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。'."\n", 'type' => 'string', 'example' => 'job-6581536084722****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '无'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'ANSWERED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '8001****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => '[MUTED]', + ], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609253212511'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', ], + 'example' => 'OUTBOUND', ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6581536084722****'], + 'ChannelId' => ['description' => '话务通道ID。'."\n", 'type' => 'string', 'example' => 'ch:user:1318888****->8001****:1609253204816:job-6581536084722****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8001****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'], + 'SkillGroupId' => ['description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], ], ], - 'ProcessDefinition' => [ - 'description' => '流程信息（废弃）。', - 'type' => 'string', - 'example' => '无', - ], - 'UpdatedTime' => [ - 'description' => '更新时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1715780670000', - ], - 'CategoryId' => [ - 'description' => '类⽬ID。', - 'type' => 'string', - 'example' => '43c2671b-*****-4223-86d0-6bd187905cc8', - ], - 'AppliedVersion' => [ - 'description' => '当前正在工作的版本。', - 'type' => 'string', - 'example' => '0', - ], - 'LatestVersion' => [ - 'description' => '草稿版本。', - 'type' => 'string', - 'example' => '1715780670000', - ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。'."\n", + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '座席分机号。', 'type' => 'string', 'example' => '8001****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609253205896'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609253204811'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1390000****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6581536084722****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], ], ], ], ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8707EB29-BAED-4302-B999-40BA61877437', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], - ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 25,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TemplateId\\": \\"b5c21219-3a1e-4bc0-92e7-da66e057d2f6\\",\\n \\"Name\\": \\"测试模板\\",\\n \\"State\\": \\"Enabled\\",\\n \\"Editor\\": \\"creator@ccc-test\\",\\n \\"TicketFields\\": [\\n {\\n \\"DisplayName\\": \\"姓名\\\\n\\",\\n \\"Description\\": \\"姓名字段\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"String\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\\\n\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attribute\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1715780670000,\\n \\"UpdatedTime\\": 1715780670000,\\n \\"Creator\\": \\"creator\\"\\n }\\n ],\\n \\"ProcessDefinition\\": \\"无\\",\\n \\"UpdatedTime\\": 1715780670000,\\n \\"CategoryId\\": \\"43c2671b-*****-4223-86d0-6bd187905cc8\\",\\n \\"AppliedVersion\\": \\"0\\",\\n \\"LatestVersion\\": \\"1715780670000\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取工单模板列表', - 'summary' => '使用ListTickerTemplate获取工单模板列表。', - ], - 'CreateTicket' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '静音通话', + 'summary' => '调用MuteCall静音指定实例下指定通话ID对应的通话，只能由正在通话状态的坐席调用，且只能静音调用者自己，坐席静音后，客户将无法听见坐席的声音。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-01-18T12:07:41.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MuteCall'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"A275B008-A25B-494D-AB53-93CE253815B6\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6581536084722****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"[MUTED]\\",\\n \\"Timestamp\\": 1609253212511,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6581536084722****\\",\\n \\"ChannelId\\": \\"ch:user:1318888****->8001****:1609253204816:job-6581536084722****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609253205896,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609253204811,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6581536084722****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"A275B008-A25B-494D-AB53-93CE253815B6\\n无\\n200\\n无\\n\\n \\n ccc-test\\n OUTBOUND\\n job-65815360847228928\\n \\n 8001****\\n ANSWERED\\n 无\\n OUTBOUND\\n 1\\n 无\\n ch:user:1318888****-&gt;8001****:1609253204816:job-65815360847228928\\"\\n 1609253212511\\n 无\\n 1318888****\\n []\\n user-test@ccc-test\\n 8001****\\n job-65815360847228928\\n \\n \\n \\n 8001****\\n TALKING\\n ccc-test\\n Warm-up\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bs736efb521810000176aef6e955\\n 1609253205896\\n false\\n 1390000****\\n job-65815360847228928\\n ON_SITE\\n 1609253204811\\n [\\"skill-group@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', + ], + 'PauseCampaign' => [ + 'summary' => '调用PauseCampaign暂停指定实例下指定ID对应的预测式外呼活动。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -47164,670 +22649,504 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => '工单模板ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'e9e4c76c-948d-4a6e-9ce2-9da0f5967a73', - ], - ], - [ - 'name' => 'CustomerId', - 'in' => 'query', - 'schema' => [ - 'description' => '客户ID，云联络中心客户资料中的客户ID。', - 'type' => 'string', - 'required' => false, - 'example' => '51e155ce-3747-4f21-b402-13c69597b920', - ], - ], - [ - 'name' => 'Title', - 'in' => 'query', - 'schema' => [ - 'description' => '工单标题。', - 'type' => 'string', - 'required' => false, - 'example' => '售后工单。', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => '工单来源。', - 'type' => 'string', - 'required' => false, - 'example' => 'CHAT', - ], - ], - [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'job-38860977107324****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Context', + 'name' => 'CampaignId', 'in' => 'query', - 'schema' => [ - 'description' => '工单字段信息。', - 'type' => 'string', - 'required' => false, - 'example' => '{"productName":"玩具1"}', - ], + 'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A450574A-337F-43E2-BC59-9C6594C994C6', - ], - 'Data' => [ - 'description' => '返回数据，工单ID。', - 'type' => 'string', - 'example' => '3d26b90a-c5d2-4b09-8219-60cda1******', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '4A68E287-6888-5ADB-8048-DB488B4DEF35'], + 'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Null', - 'errorMessage' => 'The parameter %s must not be null.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4A68E287-6888-5ADB-8048-DB488B4DEF35\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', + 'title' => '暂停预测式外呼活动', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseCampaign'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"A450574A-337F-43E2-BC59-9C6594C994C6\\",\\n \\"Data\\": \\"3d26b90a-c5d2-4b09-8219-60cda1******\\"\\n}","type":"json"}]', - 'title' => '创建工单', - 'summary' => '使用CreateTicket创建工单。', + 'ramActions' => [], ], - 'ListCategories' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PickOutboundNumbers' => [ + 'summary' => '调用PickOutboundNumbers根据传入的被叫号码选择适合的主叫号码，选号逻辑由智能算法控制。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Type', + 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '类目类别。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Ticket' => 'Ticket', - ], - 'example' => 'Ticket', - ], + 'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1388888****'], ], [ - 'name' => 'CategoryId', + 'name' => 'Count', 'in' => 'query', - 'schema' => [ - 'description' => '工单类目ID。指定类目ID，返回对应ID的子类目信息，不指定返回实例下类目的信息。', - 'type' => 'string', - 'required' => false, - 'example' => '43c2671b-***-***-86d0-6bd187905cc8', - ], + 'schema' => ['description' => '希望返回的可选号码数量， 默认1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '3', 'minimum' => '1', 'example' => '1'], + ], + [ + 'name' => 'SkillGroupIdList', + 'in' => 'query', + 'schema' => ['description' => '技能组ID集合，格式为JSON数组的字符串，数组元素是技能组ID，号码与技能组是关联的，此参数用于指定从哪些技能组挑选号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["skillgroup@ccc-test"]'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ListCategoriesResponse', - 'description' => 'ListCategoriesResponse', 'type' => 'object', 'properties' => [ + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Data' => [ - 'description' => '数据。类目节点信息，JSON字符传形式。', - 'type' => 'string', - 'example' => '[{\\"categoryId\\":\\"43c2671b-8939-4223-****-6bd187905cc8\\",\\"childCategoryList\\":[{\\"categoryId\\":\\"120816ad-4392-4edf-****-6d053d5cfa5a\\",\\"childCategoryList\\":[],\\"deleted\\":0,\\"editor\\":\\"283277706217028904\\",\\"editorName\\":\\"283277706217028904\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":0,\\"level\\":2,\\"name\\":\\"客户反馈\\",\\"parentCategoryId\\":\\"43c2671b-8939-****-86d0-6bd187905cc8\\",\\"type\\":\\"Ticket\\"}],\\"deleted\\":0,\\"editor\\":\\"283277706217028904\\",\\"editorName\\":\\"283277706217028904\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":10,\\"level\\":1,\\"name\\":\\"测试一01类目\\",\\"type\\":\\"Ticket\\"},{\\"categoryId\\":\\"4948fcd0-2972-****-81c6-1a00927e1802\\",\\"childCategoryList\\":[],\\"deleted\\":0,\\"editor\\":\\"283277706217028904\\",\\"editorName\\":\\"283277706217028904\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":0,\\"level\\":1,\\"name\\":\\"生产环境验证\\",\\"type\\":\\"Ticket\\"},{\\"categoryId\\":\\"c426bd7f-9661-47c3-****-2508f1a32f66\\",\\"childCategoryList\\":[],\\"deleted\\":0,\\"editor\\":\\"269801834095770945\\",\\"editorName\\":\\"269801834095770945\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":4,\\"level\\":1,\\"name\\":\\"测试环境测试\\",\\"type\\":\\"Ticket\\"}]', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '错误参数列表。', + 'description' => '数据。', 'type' => 'array', 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', + 'type' => 'object', + 'properties' => [ + 'Callee' => [ + 'description' => '被叫号码。', + 'type' => 'object', + 'properties' => [ + 'Number' => ['description' => '号码', 'type' => 'string', 'example' => '1388888****'], + 'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '北京'], + 'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '北京'], + ], + ], + 'Caller' => [ + 'description' => '主叫号码。', + 'type' => 'object', + 'properties' => [ + 'Number' => ['description' => '号码', 'type' => 'string', 'example' => '0108989****'], + 'City' => ['description' => '号码归属地市。', 'type' => 'string', 'example' => '北京'], + 'Province' => ['description' => '号码归属地省。', 'type' => 'string', 'example' => '北京'], + ], + ], + ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"43c2671b-8939-4223-****-6bd187905cc8\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120816ad-4392-4edf-****-6d053d5cfa5a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"客户反馈\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parentCategoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"43c2671b-8939-****-86d0-6bd187905cc8\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"测试一01类目\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4948fcd0-2972-****-81c6-1a00927e1802\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"生产环境验证\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"c426bd7f-9661-47c3-****-2508f1a32f66\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"269801834095770945\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"269801834095770945\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":4,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"测试环境测试\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"}]\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取类目', - 'summary' => '使用ListCategories获取类目信息。', - ], - 'GetTicketTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '选择外呼号码', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n {\\n \\"Callee\\": {\\n \\"Number\\": \\"1388888****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n },\\n \\"Caller\\": {\\n \\"Number\\": \\"0108989****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n \\n 1388888****\\n 北京\\n 北京\\n \\n \\n 0108989****\\n 北京\\n 北京\\n \\n\\nOK","errorExample":""}]', + ], + 'PollUserStatus' => [ + 'summary' => '轮询指定实例下指定坐席的坐席状态，一般由前端坐席工作台调用，用于同步坐席状态。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '模板ID。', - 'type' => 'string', - 'required' => false, - 'example' => '4ca2e2-c8d19b82c-d7ce393ac8197d3ab', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'InstanceId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'TemplateVersion', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '模板版本。', - 'type' => 'string', - 'required' => false, - 'example' => '1703517780627', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'GetTicketTemplateResponse', - 'description' => 'GetTicketTemplateResponse', 'type' => 'object', 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'TemplateId' => [ - 'description' => '模板ID。', - 'type' => 'string', - 'example' => '4ca2e2-c8d19b82c-d7ce393ac8197d3ab'."\n", - ], - 'Name' => [ - 'description' => '模板名称。', - 'type' => 'string', - 'example' => '测试模板。'."\n" - ."\n", - ], - 'State' => [ - 'description' => '状态码。', - 'type' => 'string', - 'example' => 'Enabled', - ], - 'Editor' => [ - 'description' => '模板编辑人。', - 'type' => 'string', - 'example' => 'editor-xxx@ccc-test', + 'ContextId' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '103655'], + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'CREATED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'MONITORING', + ], + 'SkillGroupId' => ['description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'ChannelVariables' => ['description' => '随路数据。', 'type' => 'string', 'example' => '123'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], + ], + ], + ], + 'CallVariables' => ['description' => '随路数据。通过SIP信令传递的自定义数据。', 'type' => 'string', 'example' => 'a=b;c=d'], + ], ], - 'CategoryId' => [ - 'description' => '工单类目ID。', - 'type' => 'string', - 'example' => '43c2671b-****-4223-86d0-6bd187905cc8', + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'BREAK', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + 'ParallelJobList' => [ + 'description' => '坐席当前正在处理和已经处理完的Chat会话', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => '会话ID', 'type' => 'string', 'example' => 'job-6538214103685****'."\n"], + 'Status' => ['description' => '客服在这个会话中的状态。'."\n" + .'### 枚举值：'."\n" + .'- RINGING'."\n" + .'- TALKING'."\n" + .'- RELEASED（结束）'."\n" + .'- MISSED（未接）', 'type' => 'string', 'example' => 'RINGING'], + 'Timestamp' => ['description' => '状态变更的时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + ], + 'description' => '', + ], + ], + ], ], - 'TicketFields' => [ - 'description' => '模板字段列表。', + 'ChatContexts' => [ + 'description' => '会话上下文环境。', 'type' => 'array', 'items' => [ - 'description' => '模板字段。', 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'description' => '显示名称。', - 'type' => 'string', - 'example' => '姓名', - ], - 'Description' => [ - 'description' => '描述。', - 'type' => 'string', - 'example' => '姓名描述', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'example' => 'name', - ], - 'DataType' => [ - 'description' => '数据类型'."\n" - .'。', - 'type' => 'string', - 'example' => 'string', - ], - 'Pattern' => [ - 'description' => '正则表达式校验规则。', - 'type' => 'string', - 'example' => '^', - ], - 'PatternErrorMessage' => [ - 'description' => '正则表达式校验错误提示信息。', - 'type' => 'string', - 'example' => '不是有效的email地址'."\n", - ], - 'MinLength' => [ - 'description' => '最小长度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'MaxLength' => [ - 'description' => '最大长度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Minimum' => [ - 'description' => '数字最小值。', - 'type' => 'number', - 'format' => 'double', - 'example' => '1', - ], - 'Maximum' => [ - 'description' => '数字最大值。', - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - 'Required' => [ - 'description' => '是否必填。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'System' => [ - 'description' => '是否是系统字段。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Disabled' => [ - 'description' => '是否被禁用。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Array' => [ - 'description' => '是否是数组。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ReadOnly' => [ - 'description' => '是否只读。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'EditorType' => [ - 'description' => '编辑器类型。', - 'type' => 'string', - 'example' => 'textbox', - ], - 'Attributes' => [ - 'description' => '扩展属性。', - 'type' => 'string', - 'example' => '{}', - ], - 'DisplayOrder' => [ - 'description' => '列表展示顺序。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'CreatedTime' => [ - 'description' => '创建时间。'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1717664210000', - ], - 'UpdatedTime' => [ - 'description' => '更新时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1717664210000', - ], - 'Creator' => [ - 'description' => '创建者。', - 'type' => 'string', - 'example' => 'creator@cccV2-kmz', + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'chat-65382141036853491'."\n"], + 'ChatType' => ['description' => '会话类型。', 'type' => 'string', 'example' => 'INBOUND'], + 'CallVariables' => ['description' => '随路数据。', 'type' => 'string', 'example' => '无'], + 'Members' => [ + 'description' => '参与这个 Chat会话的坐席和客户的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'."\n"], + 'UserType' => ['description' => '用户类型。'."\n" + ."\n" + .'枚举值：'."\n" + .'- CUSTOMER：客户'."\n" + .'- AGENT：坐席', 'type' => 'string', 'example' => 'Manager'], + 'Status' => ['description' => '客服在这个会话中的状态。'."\n" + ."\n" + .'枚举值：'."\n" + .'- RINGING'."\n" + .'- TALKING'."\n" + .'- RELEASED（结束）'."\n" + .'- MISSED（未接）', 'type' => 'string', 'example' => 'RINGING'], + 'SkillGroupId' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'a527a80a-75cf-448f-aba0-fca37c61946d'], + 'ReleaseInitiator' => ['description' => '挂断方。', 'type' => 'string', 'example' => 'User'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], - 'ProcessDefinition' => [ - 'description' => '流程信息。', - 'type' => 'string', - 'example' => '[{\\"id\\":\\"TICKET_START\\",\\"name\\":\\"开始\\",\\"nodeIndex\\":0,\\"properties\\":{\\"position\\":{\\"x\\":250,\\"y\\":200}},\\"type\\":\\"TICKET_START\\",\\"events\\":[{\\"edgeId\\":\\"8bd07339\\",\\"sourceAnchor\\":0,\\"next\\":\\"APPROVAL__JNBSSREc\\",\\"targetAnchor\\":0}]},{\\"id\\":\\"TICKET_FINISH\\",\\"name\\":\\"结束\\",\\"nodeIndex\\":9999,\\"properties\\":{\\"position\\":{\\"x\\":767,\\"y\\":206}},\\"type\\":\\"TICKET_FINISH\\",\\"events\\":[]},{\\"id\\":\\"APPROVAL__JNBSSREc\\",\\"name\\":\\"流程节点\\",\\"nodeIndex\\":1,\\"properties\\":{\\"skillGroupId\\":\\"chat001@cccV2-kmz\\",\\"position\\":{\\"x\\":537,\\"y\\":164.5}},\\"type\\":\\"APPROVAL\\",\\"events\\":[{\\"edgeId\\":\\"74031613\\",\\"sourceAnchor\\":1,\\"next\\":\\"TICKET_FINISH\\",\\"targetAnchor\\":0}]}]', - ], - 'UpdatedTime' => [ - 'description' => '上次修改的时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1717664210000', - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TemplateId\\": \\"4ca2e2-c8d19b82c-d7ce393ac8197d3ab\\\\n\\",\\n \\"Name\\": \\"测试模板。\\\\n\\\\n\\",\\n \\"State\\": \\"Enabled\\",\\n \\"Editor\\": \\"editor-xxx@ccc-test\\",\\n \\"CategoryId\\": \\"43c2671b-****-4223-86d0-6bd187905cc8\\",\\n \\"TicketFields\\": [\\n {\\n \\"DisplayName\\": \\"姓名\\",\\n \\"Description\\": \\"姓名描述\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\\\n\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1717664210000,\\n \\"UpdatedTime\\": 1717664210000,\\n \\"Creator\\": \\"creator@cccV2-kmz\\"\\n }\\n ],\\n \\"ProcessDefinition\\": \\"[{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_START\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"开始\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nodeIndex\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"position\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":250,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":200}},\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_START\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"events\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"edgeId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8bd07339\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sourceAnchor\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"next\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APPROVAL__JNBSSREc\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"targetAnchor\\\\\\\\\\\\\\":0}]},{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_FINISH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"结束\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nodeIndex\\\\\\\\\\\\\\":9999,\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"position\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":767,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":206}},\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_FINISH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"events\\\\\\\\\\\\\\":[]},{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APPROVAL__JNBSSREc\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"流程节点\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nodeIndex\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"skillGroupId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"chat001@cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"position\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":537,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":164.5}},\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APPROVAL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"events\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"edgeId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"74031613\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sourceAnchor\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"next\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_FINISH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"targetAnchor\\\\\\\\\\\\\\":0}]}]\\",\\n \\"UpdatedTime\\": 1717664210000\\n },\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA633111\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取工单模板', - 'summary' => '使用GetTicketTemplate获取工单模板定义信息。', - ], - 'AddBlacklistCallTagging' => [ - 'summary' => '对指定号码添加黑名单标签，可结合IVR设置，防止其频繁呼入骚扰。', - 'methods' => [ - 'get', - 'post', + 'title' => '轮询坐席状态', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-11-28T06:51:14.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PollUserStatus'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103655,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"ChannelVariables\\": \\"123\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ],\\n \\"CallVariables\\": \\"a=b;c=d\\"\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ],\\n \\"ParallelJobList\\": [\\n {\\n \\"JobId\\": \\"job-6538214103685****\\\\n\\",\\n \\"Status\\": \\"RINGING\\",\\n \\"Timestamp\\": 1609136956378\\n }\\n ]\\n },\\n \\"ChatContexts\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"chat-65382141036853491\\\\n\\",\\n \\"ChatType\\": \\"INBOUND\\",\\n \\"CallVariables\\": \\"无\\",\\n \\"Members\\": [\\n {\\n \\"Index\\": 1,\\n \\"UserId\\": \\"agent@ccc-test\\\\n\\",\\n \\"UserType\\": \\"Manager\\",\\n \\"Status\\": \\"RINGING\\",\\n \\"SkillGroupId\\": \\"a527a80a-75cf-448f-aba0-fca37c61946d\\",\\n \\"ReleaseInitiator\\": \\"User\\",\\n \\"ReleaseReason\\": \\"无\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 1\\n 无\\n skg-default@ccc-test\\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 123\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n \\n 80326034\\n BREAK\\n ccc-test\\n Warm-up\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n 1609136956378\\n false\\n 86-132xxxx4730\\n job-65382141036853491\\n ON_SITE\\n 1609136956378\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', + ], + 'ProcessCustomIMCallback' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '263383', + 'abilityTreeNodes' => ['FEATUREcccD72NOC'], + ], 'parameters' => [ + [ + 'name' => 'AccessChannelId', + 'in' => 'formData', + 'schema' => ['description' => '网络业务渠道ID。', 'type' => 'string', 'required' => true, 'example' => 'cf584733-***-***-9699-cb77aa3b7aa6'], + ], + [ + 'name' => 'ConversationId', + 'in' => 'formData', + 'schema' => ['description' => '会话id', 'type' => 'string', 'required' => true, 'example' => 'd165de4f-9851-445e-9535-66ebfa72fa51'], + ], + [ + 'name' => 'SenderId', + 'in' => 'formData', + 'schema' => ['description' => '消息发送者用户ID。', 'type' => 'string', 'required' => true, 'example' => '63061274befd6b545aab4c83'], + ], + [ + 'name' => 'SenderName', + 'in' => 'formData', + 'schema' => ['description' => '发送者名称。', 'type' => 'string', 'required' => false, 'example' => 'tom'], + ], + [ + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], + ], [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'in' => 'formData', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], ], [ - 'name' => 'Number', - 'in' => 'query', - 'schema' => [ - 'description' => '电话号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1764590****', - ], + 'name' => 'SenderAvatarMediaId', + 'in' => 'formData', + 'schema' => ['description' => '头像id', 'type' => 'string', 'required' => false, 'example' => 'xxxx'], ], [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。号码为加密号码（带有*），需要填写JobId，非加密号码，不需要填写该字段。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6582589278232****', - ], + 'name' => 'MessageContent', + 'in' => 'formData', + 'schema' => ['description' => '消息内容', 'type' => 'string', 'required' => true, 'example' => '消息内容，格式如下：'."\n" + ."\n\n" + .'文本消息：'."\n" + .'{ "contentType":"Text", "text":"你好 " }'."\n" + ."\n" + .'图片消息：'."\n" + .'{ "contentType":"Image", "mediaId": "xxx-xxx-xxx", "fileType": "png", "fileSize": 1233 }'."\n" + ."\n" + .'视频消息：'."\n" + .'{ "contentType":"Video", "mediaId": "xxx-xxx-xxx" "duration": 12, "fileSize": 1233, }'."\n" + ."\n" + .'音频消息：'."\n" + .'{ "contentType":"Audio", "mediaId": "xxx-xxx-xxx" "duration": 12, "fileSize": 1233 }'."\n" + ."\n" + .'文件消息：'."\n" + .'{ "contentType":"File", "mediaId": "xxx-xxx-xxx", "fileSize": 223232, "filename": "xyz. zip" }'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'ProcessDingTalkRobotCallbackResponse', + 'description' => 'ProcessDingTalkRobotCallbackResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'chat-65382141036853491'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '[\'OFFLINE\', \'BREAK,READY,WORKING\']'], ], + 'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'LimitExceed.CallTagsPerNumber', - 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.CustomCallTagging', - 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', - 'title' => '添加号码黑名标签', - ], - 'CreateCallTags' => [ - 'summary' => '调用CreateCallTags在指定实例下创建多个号码标签。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": \\"chat-65382141036853491\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"[\'OFFLINE\', \'BREAK,READY,WORKING\']\\"\\n ],\\n \\"Data\\": \\"无\\"\\n}","type":"json"}]', + 'title' => '第三方IM消息回调', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'PublishContactFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -47838,132 +23157,65 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'CallTagNameList', + 'name' => 'ContactFlowId', 'in' => 'query', - 'schema' => [ - 'description' => '号码标签名称列表，格式为JSON数组的字符串，数组元素是待创建的号码标签名称，号码标签名称的长度要求1-10个字符。', - 'type' => 'string', - 'required' => true, - 'example' => '["TagA","TagB"]', - ], + 'schema' => ['description' => '联系流ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0a063bf-f138-42a4-ad9f-9babe3ec1a9e'], + ], + [ + 'name' => 'DraftId', + 'in' => 'query', + 'schema' => ['description' => '草稿ID，当前联系流对应的草稿版本ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0e0b8e78-af3e-4360-a5c5-f9bb5c2b8af2'], ], ], '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' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '创建失败的号码标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '创建失败的号码标签信息。', - 'type' => 'object', - 'properties' => [ - 'Item' => [ - 'description' => '创建失败的号码标签的名称。', - 'type' => 'string', - 'example' => 'TagC', - ], - 'Reason' => [ - 'description' => '号码标签创建失败原因。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CALL_TAG_NAME_DUPLICATED' => '传入的列表中存在重复项', - 'CALL_TAG_NAME_INSERT_DUPLICATED' => '后台写入号码标签时存在重复项', - 'CALL_TAG_NAME_ILLEGAL' => '传入的列表中存在格式不合法的号码标签', - ], - 'example' => 'CALL_TAG_NAME_DUPLICATED', - ], - ], - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。'."\n" + ."\n", 'type' => 'string', 'example' => 'BFB6788F-20D4-5767-BC67-99EAAC28F789'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'LimitExceed.CallTagsPerInstance', - 'errorMessage' => 'The total number of call tag of the instance exceeds the limit %s.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], - 500 => [ - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', - ], + ], + 'title' => '发布联系流', + 'summary' => '发布联系流。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishContactFlow'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"Item\\": \\"TagC\\",\\n \\"Reason\\": \\"CALL_TAG_NAME_DUPLICATED\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"无\\nEEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n200\\n\\n TagA\\n CUSTOM_NUMBER_DUPLICATED\\n\\nOK","errorExample":""}]', - 'title' => '创建多个号码标签', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BFB6788F-20D4-5767-BC67-99EAAC28F789\\"\\n}","type":"json"}]', ], - 'CreateCustomCallTagging' => [ - 'summary' => '调用CreateCustomCallTagging在指定实例下创建一个或多个呼入号码标记。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ReadyForService' => [ + 'summary' => '调用ReadyForService使指定实例下的指定坐席就绪，就绪后坐席进入空闲状态。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -47972,148 +23224,121 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', - 'deprecated' => true, - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'CustomNumberList', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '呼入控制标记列表，格式为JSON数组的字符串，要求数组元素个数范围为1-10000。数组的元素是一个对象，包括以下属性：number（格式要求为4-32位的数字）、description、callTagNameList，其中callTagNameList是一个数组，元素是号码标签，（确保号码标签是已创建的号码标签）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"number":"1312121****","description":"王先生","callTagNameList":["TagA"]},{"number":"1388888****","description":"张先生","callTagNameList":["TagB"]}]', - ], + 'schema' => ['description' => '坐席ID，不填默认为当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'user-test@ccc-test'], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], + ], + [ + 'name' => 'OutboundScenario', + 'in' => 'query', + 'schema' => ['description' => '上线后是否进入仅外呼模式，选填，默认false。', 'type' => 'boolean', 'required' => false, 'example' => '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' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'CC49060B-87ED-489A-AD3D-00E57775DBFF'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], 'Data' => [ - 'description' => '创建失败的呼入号码标记列表。', - 'type' => 'array', - 'items' => [ - 'description' => '创建失败的呼入号码标记信息。', - 'type' => 'object', - 'properties' => [ - 'Item' => [ - 'description' => '创建失败的呼入号码标记的号码。', - 'type' => 'string', - 'example' => '1312121****', - ], - 'Reason' => [ - 'description' => '呼入号码标记创建失败原因。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CUSTOM_NUMBER_ILLEGAL' => '传入的列表中存在格式不合法的号码', - 'CUSTOM_NUMBER_DUPLICATED' => '传入的列表中存在重复的号码', - 'CUSTOM_NUMBER_ALREADY_EXISTS' => '传入的列表中存在已创建的号码标记', - 'CUSTOM_NUMBER_TAG_NOT_EXIST' => '传入的列表中存在未创建的号码标签', - 'CUSTOM_NUMBER_INSERT_DUPLICATED' => '后台写入呼入号码标记时存在重复项', - 'CUSTOM_NUMBER_TOO_MANY_TAGS' => '传入的列表中存在超出号码标签个数上限的号码', - ], - 'example' => 'CUSTOM_NUMBER_DUPLICATED', - ], + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up'."\n", + ], + 'InstanceId' => ['description' => '实例ID。'."\n" + ."\n", 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'READY', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], ], - 'enumValueTitles' => [], ], ], ], - 'enumValueTitles' => [], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.RamId', - 'errorMessage' => 'RAM user %s does not exist.', - ], - ], - 409 => [ - [ - 'errorCode' => 'AlreadyExists.CustomNumber', - 'errorMessage' => 'Custom number already exists.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'CCC::2020-07-01::CreateCustomCallTaggings', + 'title' => '坐席就绪', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:46.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReadyForService'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"Item\\": \\"1312121****\\",\\n \\"Reason\\": \\"CUSTOM_NUMBER_DUPLICATED\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"无\\nBA03159C-E808-4FF1-B27E-A61B6E888D7F\\n200\\n\\n TagA\\n CUSTOM_NUMBER_DUPLICATED\\n\\nOK","errorExample":""}]', - 'title' => '创建多个呼入号码标记', + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"CC49060B-87ED-489A-AD3D-00E57775DBFF\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\\\n\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"CC49060B-87ED-489A-AD3D-00E57775DBFF\\n200\\n\\n 80011474\\n OFFLINE\\n ccc-test\\n user-test@ccc-test\\n false\\n ON_SITE\\n\\nOK","errorExample":""}]', ], - 'DeleteCallTag' => [ - 'summary' => '调用DeleteCallTag删除指定实例下的号码标签。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RedialCall' => [ + 'summary' => '重拨脱敏后的话单中的号码', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -48122,99 +23347,209 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '呼叫中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abc'], ], [ - 'name' => 'TagName', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '号码标签名称，请确保传入的标签是已创建的号码标签。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TagA', - ], + 'schema' => ['description' => '座席用户ID信息。', 'type' => 'string', 'required' => false, 'example' => 'samzhang@abc'], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => '座席端提供的唯一ID，用来表示一个座席工作台。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'CCC-x.x.x.x-chrome102-bsdf911812c60f61e'], + ], + [ + 'name' => 'Caller', + 'in' => 'query', + 'schema' => ['description' => '主叫号码。', 'type' => 'string', 'required' => false, 'example' => '0109810****'], + ], + [ + 'name' => 'Callee', + 'in' => 'query', + 'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1318888****'], + ], + [ + 'name' => 'TimeoutSeconds', + 'in' => 'query', + 'schema' => ['description' => '超时时间，呼叫在经过该参数指定的时间仍然未接通的情况下，则主动挂断。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '300', 'minimum' => '30', 'example' => '30'], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => ['description' => '随路数据，不能超过128字节，主要用于扩展需求，普通客户无需关心。', 'type' => 'string', 'required' => false, 'example' => 'a=b'], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => '话务ID。用来重拨的上一通电话的话务ID。', 'type' => 'string', 'required' => false, 'example' => 'job-6581536084722****'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'Code' => ['description' => '状态码。返回OK代表请求成功，其他错误码详见错误码列表。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA63****'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => 'skillGroupId'], + ], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'ContextId' => ['description' => '上下文ID，严格有序递增。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789'], + 'CallContext' => [ + 'description' => '话务上下文环境。'."\n", + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '呼叫类型, 最初发起呼叫时的类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'example' => 'abc'], + 'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '139xxxx0501'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'CREATED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '8001****'], + 'UserId' => ['description' => '座席用户ID信息。', 'type' => 'string', 'example' => 'samzhang@abc'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'COACHING', + ], + 'Timestamp' => ['description' => '状态数据上次变更时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '486:USER_BUSY'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'JobId' => ['description' => '话务ID。'."\n", 'type' => 'string', 'example' => 'job-6573574060089****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'], + 'UserExtension' => ['description' => '用户分机号。', 'type' => 'string', 'example' => '8000****'."\n"], + ], + ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '用户分机号。', 'type' => 'string', 'example' => '8000****'], + 'WorkMode' => ['description' => '工作模式。枚举值：'."\n" + .'- ON_SITE: 场内模式'."\n" + .'- OFF_SITE: 场外模式'."\n" + .'- OFFICE_PHONE: 办公电话模式', 'type' => 'string', 'example' => 'ON_SITE'."\n"], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'CCC-x.x.x.x-chrome102-bsdf911812c60f61e'."\n"], + 'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'job-6573574060089****'], + 'UserId' => ['description' => '座席用户ID信息。', 'type' => 'string', 'example' => 'samzhang@abc'."\n"], + 'BreakCode' => ['description' => '小休状态码，分为系统定义和客户定义两种。'."\n" + ."\n" + .'系统定义的小休码：'."\n" + .'- Warm-up：坐席上线后置闲前的临时小休状态'."\n" + .'- RingingTimeout： 坐席振铃超时导致的小休'."\n" + .'- RejectCall：坐席拒接导致的小休'."\n" + ."\n" + .'客户自定义状态码没有限制，客户可以根据业务需要自行定义。', 'type' => 'string', 'example' => 'Warm-up'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'abc'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'False'], + 'UserState' => ['description' => '座席状态。枚举值：'."\n" + .'- READY: 空闲'."\n" + .'- WORKING: 话后处理中'."\n" + .'- DIALING: 拨号中'."\n" + .'- BREAK: 小休'."\n" + .'- OFFLINE: 离线'."\n" + .'- TALKING: 通话中'."\n" + .'- RINGING: 振铃中', 'type' => 'string', 'example' => 'READY'], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '坐席签入的技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@abc'], + ], + ], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], + ['errorCode' => 'UserBusy', 'errorMessage' => 'The user %s you called was busy. Please try again later.', 'description' => '您呼叫的用户正忙，请稍后再试。'], + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.Extension', 'errorMessage' => 'No available extension number exists.', 'description' => '没有可分配的分机号。'], ], 500 => [ - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', - ], + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"无\\nEEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n200\\nOK","errorExample":""}]', - 'title' => '删除号码标签', - ], - 'DeleteCustomCallTagging' => [ - 'summary' => '调用DeleteCustomCallTagging删除指定实例下指定号码对应的呼入号码标记。', - 'methods' => [ - 'get', - 'post', + 'title' => '重拨', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:46.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-12-30T02:49:39.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RedialCall'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA63****\\",\\n \\"Params\\": [\\n \\"skillGroupId\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 123456789,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"abc\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"139xxxx0501\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"samzhang@abc\\",\\n \\"ChannelFlags\\": \\"COACHING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"486:USER_BUSY\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8000****\\\\n\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8000****\\",\\n \\"WorkMode\\": \\"ON_SITE\\\\n\\",\\n \\"DeviceId\\": \\"CCC-x.x.x.x-chrome102-bsdf911812c60f61e\\\\n\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"UserId\\": \\"samzhang@abc\\\\n\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"abc\\",\\n \\"OutboundScenario\\": true,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@abc\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'RegisterDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -48223,118 +23558,34 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => ' ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Number', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '号码呼入标记的号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1312121****', - ], - ], - ], - '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' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"无\\nBA03159C-E808-4FF1-B27E-A61B6E888D7F\\n200\\nOK","errorExample":""}]', - 'title' => '删除呼入号码标记', - ], - 'ExportCustomCallTagging' => [ - 'summary' => '调用ExportCustomCallTagging导出指定实例下的全部呼入号码标记。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => '设备ID，用户可自行设置，无特殊要求，字符串形式即可。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-device'], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '设备密码，该密码用于在SIP设备发起注册信令时做鉴权校验，请妥善保管。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'password'], ], ], 'responses' => [ @@ -48342,76 +23593,44 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据，导出结果所在的OSS的下载链接，链接有效期为24小时。', - 'type' => 'string', - 'example' => 'http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/tagging.xlsx ?Expires=1610910578&OSSAccessKeyId=****&Signature=****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F
', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be blank.', 'description' => ''], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'CCC::2020-07-01::ExportCustomCallTaggings', + 'title' => '注册设备', + 'summary' => '调用RegisterDevice注册SIP设备到指定实例下的指定坐席， SIP设备可以是SIP话机或SIP软电话。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterDevice'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/tagging.xlsx ?Expires=1610910578&OSSAccessKeyId=****&Signature=****\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F
\\"\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F
\\n无\\n200\\n无\\nhttp://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/tagging.xlsx ?Expires=1610910578&OSSAccessKeyId=KZEA4GDDtCg431rmXTiEhr1q&Signature=4bXjOtUYgXl2z9iWpk3tXxS8SGY%3D\\nOK","errorExample":""}]', - 'title' => '导出呼入号码标记', + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\nOK","errorExample":""}]', ], - 'ImportCustomCallTagging' => [ - 'summary' => '调用ImportCustomCallTagging导入多个呼入号码标记到指定实例中。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RegisterDevices' => [ + 'summary' => '调用RegisterDevices注册一个或多个SIP设备到指定实例下的指定坐席，SIP设备可以是SIP话机或SIP软电话。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -48420,144 +23639,79 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', - 'deprecated' => true, - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'FilePath', + 'name' => 'UserIdListJson', 'in' => 'query', - 'schema' => [ - 'description' => '呼入号码标记文件的OSS对象的ObjectKey。OSS配置的是云呼的客户公共存储空间，您可以通过云呼叫中心的呼入控制页面上传呼入号码标记文件到客户公共存储空间，上传成功后，调用该接口就会从OSS中读取文件内容，然后批量导入。该接口不建议直接调用，建议通过云呼叫中心提供的公有云默认CRM系统操作。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'temp/ImportCustomCallTagging.xlsx', - ], + 'schema' => ['description' => ' 座席ID列表，格式为JSON数组的字符串，数组元素是坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["user-test@ccc-test"]'], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => '设备ID，用户可自行设置，无特殊要求，字符串形式即可。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-device'], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => ['description' => '设备密码，该密码用于在SIP设备发起注册信令时做鉴权校验，请妥善保管。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'password'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '创建失败的呼入号码标记列表。', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'Params' => [ 'type' => 'array', - 'items' => [ - 'description' => '创建失败的呼入号码标记信息。', - 'type' => 'object', - 'properties' => [ - 'Item' => [ - 'description' => '创建失败的呼入号码标记的号码。', - 'type' => 'string', - 'example' => '1312121****', - ], - 'Reason' => [ - 'description' => '呼入号码标记创建失败原因。', - 'type' => 'string', - 'enumValueTitles' => [ - 'CUSTOM_NUMBER_ILLEGAL' => '传入的列表中存在格式不合法的号码', - 'CUSTOM_NUMBER_DUPLICATED' => '传入的列表中存在重复的号码', - 'CUSTOM_NUMBER_ALREADY_EXISTS' => '传入的列表中存在已创建的号码标记', - 'CUSTOM_NUMBER_TAG_NOT_EXIST' => '传入的列表中存在未创建的号码标签', - 'CUSTOM_NUMBER_INSERT_DUPLICATED' => '后台写入呼入号码标记时存在重复项', - 'CUSTOM_NUMBER_TOO_MANY_TAGS' => '传入的列表中存在超出号码标签个数上限的号码', - ], - 'example' => 'CUSTOM_NUMBER_DUPLICATED', - ], - ], - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.InvalidFileContent', - 'errorMessage' => 'The content or format of the file (%s) is invalid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'NotExists.RamId', - 'errorMessage' => 'RAM user %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.UserResourceFileKey', - 'errorMessage' => 'User resource file key %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.OSS', - 'errorMessage' => 'An internal OSS service error occurred. %s', - ], - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'CCC::2020-07-01::ImportCustomCallTaggings', + 'title' => '注册多个设备', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterDevices'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"Item\\": \\"1312121****\\",\\n \\"Reason\\": \\"CUSTOM_NUMBER_DUPLICATED\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"无\\nBA03159C-E808-4FF1-B27E-A61B6E888D7F\\n200\\n\\n TagA\\n CUSTOM_NUMBER_DUPLICATED\\n\\nOK","errorExample":""}]', - 'title' => '导入呼入号码标记', + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n无\\nOK","errorExample":""}]', ], - 'ListBlacklistCallTaggings' => [ - 'summary' => '批量查询指定号码黑名单打标状态。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RejectChat' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -48566,302 +23720,125 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'NumberList', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '待查询黑名单打标状态的号码列表，号码为加密号码（带有***），需要带jobId字段，反之不需要。', - 'type' => 'string', - 'required' => true, - 'example' => '[{"number":"1521083xxxx","jobId":"job-481841171213393920"}]', - ], + 'schema' => ['description' => '话务ID。', 'type' => 'string', 'required' => true, 'example' => 'chat-65382141036853491'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '032C73C4-3A6F-4502-872B-4F5B41161C6E', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'array', - 'items' => [ - 'description' => '号码黑名单打标信息。', - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-481841171213393920', - ], - 'Number' => [ - 'description' => '号码。', - 'type' => 'string', - 'example' => '1521083xxxx', - ], - 'Blacklisted' => [ - 'description' => '是否有黑名单打标。', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B59382D2-5755-4C6D-861F-FA2AAD8F89F7'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'LimitExceed.CallTagsPerNumber', - 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid.', 'description' => ''], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.CustomCallTagging', - 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], - 500 => [ - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', - ], + 409 => [ + ['errorCode' => 'AlreadyExists.SkillGroup', 'errorMessage' => 'The skill group %s already exists in instance %s.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"032C73C4-3A6F-4502-872B-4F5B41161C6E\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"JobId\\": \\"job-481841171213393920\\",\\n \\"Number\\": \\"1521083xxxx\\",\\n \\"Blacklisted\\": true\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取号码黑名单打标状态', - ], - 'ListCallTags' => [ - 'summary' => '调用ListCallTags获取指定实例下的所有号码标签。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B59382D2-5755-4C6D-861F-FA2AAD8F89F7\\"\\n}","type":"json"}]', + 'title' => '拒绝聊天', + 'summary' => '坐席通过RejectChat拒绝接受被分配的聊天。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'RejectTicket' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'name' => 'TicketId', + 'in' => 'query', + 'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => false, 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5'], ], [ - 'name' => 'PageSize', + 'name' => 'Comment', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '处理意见。', 'type' => 'string', 'required' => false, 'example' => '请补充信息。'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => 'TurnDownTicketResponse', + 'description' => 'TurnDownTicketResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'List' => [ - 'description' => '号码标签列表。'."\n" - ."\n", - 'type' => 'array', - 'items' => [ - 'description' => '号码标签。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'TagName' => [ - 'description' => '号码标签名称。', - 'type' => 'string', - 'example' => 'TagA', - ], - ], - ], - ], - ], + 'Data' => ['description' => '数据。'."\n", 'type' => 'any', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TagName\\": \\"TagA\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nBA03159C-E808-4FF1-B27E-A61B6E888D7F\\n200\\n\\n 1\\n 10\\n 1\\n \\n TagA\\n ccc-test\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取号码标签列表', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListCustomCallTagging' => [ - 'summary' => '调用ListCustomCallTagging获取指定实例下的呼入号码标记列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"678F7002-CA01-4ABF-A112-585AFBDF3A3B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '退回工单', + 'summary' => '使用RejectTicket退回工单，退回的工单在创建人补充信息后可以重新提交。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ReleaseCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -48870,227 +23847,167 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', - 'deprecated' => true, + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PageNumber', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '坐席ID，不填默认使用当前RAM账号映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'PageSize', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], ], [ - 'name' => 'SearchPattern', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '根据号码或描述进行模糊匹配，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1312121****', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'], ], [ - 'name' => 'CallTagNameList', + 'name' => 'ChannelId', 'in' => 'query', - 'schema' => [ - 'description' => '按号码标签名称列表过滤，非必填，默认为空，表示不过滤。格式为JSON数组的字符串，数组元素是号码标签名称。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '["TagA"]', - ], + 'schema' => ['description' => '待挂断的话务通道ID，非必填，不填默认为当前UserId对应坐席所在的话务通道。', 'type' => 'string', 'required' => false, 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****'], ], ], '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' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], 'Data' => [ - 'description' => '数据。'."\n", + 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'List' => [ - 'description' => '呼入号码标记列表。', - 'type' => 'array', - 'items' => [ - 'description' => '呼入号码标记信息。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Number' => [ - 'description' => '呼入号码标记的号码。', - 'type' => 'string', - 'example' => '1312121****', - ], - 'Description' => [ - 'description' => '呼入号码标记的描述。', - 'type' => 'string', - 'example' => '王先生', - ], - 'Creator' => [ - 'description' => '创建者。', - 'type' => 'string', - 'example' => 'agent', - ], - 'UpdateTime' => [ - 'description' => '最后一次更新时间。', - 'type' => 'string', - 'example' => '2020-07-05 00:00:00.0', - ], - 'CallTagList' => [ - 'description' => '号码标签列表。', - 'type' => 'array', - 'items' => [ - 'description' => '号码标签信息。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'TagName' => [ - 'description' => '号码标签名称。', - 'type' => 'string', - 'example' => 'TagA', + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'CREATED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', ], + 'example' => 'OUTBOUND', ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + 'ChannelVariables' => ['description' => '随路数据', 'type' => 'string', 'example' => 'a=b;c=d;'], ], ], ], ], ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'BREAK', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], + ], + 'ContextId' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], - ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'CCC::2020-07-01::ListCustomCallTaggings', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"ChannelVariables\\": \\"a=b;c=d;\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 123456\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n 80326034\\n BREAK\\n ccc-test\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n ON_SITE\\n job-65382141036853491\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n \\n \\n ccc-test\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n \\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', + 'title' => '挂断通话', + 'summary' => '调用ReleaseCall挂断指定实例下指定通话ID对应的通话，调用者必须是坐席，且正处于通话状态。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-06-05T23:22:12.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseCall'], ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Number\\": \\"1312121****\\",\\n \\"Description\\": \\"王先生\\",\\n \\"Creator\\": \\"agent\\",\\n \\"UpdateTime\\": \\"2020-07-05 00:00:00.0\\",\\n \\"CallTagList\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TagName\\": \\"TagA\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nBA03159C-E808-4FF1-B27E-A61B6E888D7F\\n200\\n\\n 1\\n 10\\n 1\\n \\n TagA\\n 083xxxx0011\\n ccc-test\\n 2020-07-05 00:00:00.0\\n user-test\\n \\n TagA\\n ccc-test\\n \\n \\n\\nOK","errorExample":""}]', - 'title' => '获取呼入号码标记列表', + 'ramActions' => [], ], - 'ModifyCustomCallTagging' => [ - 'summary' => '调用ModifyCustomCallTagging修改指定实例下指定号码对应的呼入号码标记的信息，可以修改呼入号码标记的描述和绑定的号码标签。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ReleaseChat' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -49099,131 +24016,79 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Number', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '呼入号码标记的号码，会根据号码匹配待修改的呼入号码标记。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1312121****', - ], + 'schema' => ['description' => '话务ID。', 'type' => 'string', 'required' => true, 'example' => 'chat-6538214103685****'], ], [ - 'name' => 'CallTagNameList', + 'name' => 'UserType', 'in' => 'query', - 'schema' => [ - 'description' => '号码标签名称列表，请传入待修改的完整的号码标签列表，确保号码标签已创建。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["TagA","TagB"]', - ], + 'schema' => ['description' => '用户类型。'."\n" + .'- CUSTOMER : 访客'."\n" + .'- AGENT： 坐席', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMER'], ], [ - 'name' => 'Description', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '新的呼入号码标记描述，非必填，默认为空，为空表示不修改。', - 'type' => 'string', - 'required' => false, - 'example' => '王先生', - ], + 'schema' => ['description' => '用户ID。访客ID或坐席ID。', 'type' => 'string', 'required' => false, 'example' => 'edbcf95a-ef9f-4296-a0a6-985ac9e36db3'], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => ['description' => '网络业务的渠道Token。', 'type' => 'string', 'required' => false, 'example' => '9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3bjEn0YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jg************Hwej7WgWrmA='], ], ], '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' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B06B3244-1B44-481B-90C4-F2F92E59D6B5'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'LimitExceed.CallTagsPerNumber', - 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid.', 'description' => ''], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.CustomCallTagging', - 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], - 500 => [ - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', - ], + 409 => [ + ['errorCode' => 'AlreadyExists.SkillGroup', 'errorMessage' => 'The skill group %s already exists in instance %s.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"无\\nBA03159C-E808-4FF1-B27E-A61B6E888D7F\\n200\\nOK","errorExample":""}]', - 'title' => '修改呼入号码标记', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B06B3244-1B44-481B-90C4-F2F92E59D6B5\\"\\n}","type":"json"}]', + 'title' => '结束聊天', + 'summary' => '通话ReleaseChat接口结束当前聊天。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], ], 'RemoveBlacklistCallTagging' => [ - 'summary' => '移除指定号码的黑名单标签。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -49234,40 +24099,27 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ 'name' => 'Number', 'in' => 'query', - 'schema' => [ - 'description' => '电话号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1312121****', - ], + 'schema' => ['description' => '电话号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312121****'], ], [ 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。号码为加密号码（带有*），需要填写JobId，非加密号码，不需要填写该字段。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job-6538214103685****', - ], + 'schema' => ['description' => '通话ID。号码为加密号码（带有*），需要填写JobId，非加密号码，不需要填写该字段。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'], ], ], 'responses' => [ @@ -49277,117 +24129,66 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'LimitExceed.CallTagsPerNumber', - 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'LimitExceed.CallTagsPerNumber', 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', 'description' => '号码标签数量超出单个呼入号码标记的上线阈值。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - [ - 'errorCode' => 'NotExists.CustomCallTagging', - 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.CustomCallTagging', 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', 'description' => '呼入号码标记不存在。'], ], 500 => [ - [ - 'errorCode' => 'InternalService.DB', - 'errorMessage' => 'An internal DB service error occurred. %s', - ], + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', 'title' => '移除号码黑名单标签', - ], - 'ExportDoNotCallNumbers' => [ - 'summary' => '调用ExportDoNotCallNumbers导出指定实例下指定搜索条件过滤后的禁止外呼号码列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'summary' => '移除指定号码的黑名单标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', + ], + 'RemoveDoNotCallNumbers' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'SearchPattern', - 'in' => 'query', - 'schema' => [ - 'description' => '根据号码或者备注进行模糊匹配，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RemarkA', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Scope', + 'name' => 'NumberList', 'in' => 'query', - 'schema' => [ - 'description' => '应用范围，包括SYSTEM和INSTANCE，分别对应系统级禁止外呼和客户自定义禁止外呼，SYSTEM是关联实例所属的阿里云主账号的，INSTANCE只和当前实例关联，非必填，默认值INSTANCE。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SYSTEM' => '系统级禁止外呼配置', - 'INSTANCE' => '实例级禁止外呼配置', - ], - 'example' => 'INSTANCE', - ], + 'schema' => ['description' => '待删除的禁止外呼号码列表，格式为JSON数组的字符串，数组长度区间为1-300。', 'type' => 'string', 'required' => false, 'example' => '["1900000****","1312211****"]'], ], ], 'responses' => [ @@ -49395,112 +24196,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据，导出结果的OSS下载链接，链接有效期24小时。', - 'type' => 'string', - 'example' => 'https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/blacklist.xlsx?Expires=3294624578&OSSAccessKeyId=****&Signature=****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], 'Params' => [ + 'description' => '错误消息中占位符对应的响应参数。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => 'numberList'], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/blacklist.xlsx?Expires=3294624578&OSSAccessKeyId=****&Signature=****\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n无\\nhttps://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/temp/blacklist/export/157724711549xxxx/ccc-test/Tue%20Mar%2015%2010%3A14%3A48%20CST%202022/blacklist.xlsx?Expires=3294624578&OSSAccessKeyId=XXXX&Signature=XXXX\\nOK","errorExample":""}]', - 'title' => '导出禁止外呼号码', + 'title' => '删除禁止外呼号码', + 'summary' => '调用RemoveDoNotCallNumbers删除指定实例下的一个或多个禁止外呼号码配置项。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetDoNotCallFileUploadParameters' => [ - 'summary' => '调用GetDoNotCallFileUploadParameters获取禁呼文件的上传参数，当通过文件导入禁止外呼号码时，需要先调用此接口将禁呼号码文件上传到云联络中心的公共OSS空间，之后再调用ImportDoNotCallNumbers执行导入。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveDoNotCallNumbers'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"numberList\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n无\\n无\\nOK","errorExample":""}]', + ], + 'RemovePersonalNumbersFromUser' => [ + 'summary' => '调用RemovePersonalNumbersFromUser删除指定实例下指定坐席的一个或多个个人外呼号码。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'FileName', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '禁止外呼号码文件的名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'blacklist.xlsx', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'], + ], + [ + 'name' => 'NumberList', + 'in' => 'query', + 'schema' => ['description' => '待删除的个人外呼号码列表，通过调用ListPersonalNumbersOfUser可获取坐席当前关联的个人外呼号码列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["0101234****", "0105678****"]'], ], ], 'responses' => [ @@ -49508,147 +24280,76 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'Success' => [ - 'description' => '是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'FilePath' => [ - 'description' => 'OSS文件的Key。', - 'type' => 'string', - 'example' => 'ccc-test/blacklist.xlsx', - ], - 'Signature' => [ - 'description' => '文件上传临时凭证的签名信息，用于上传时验证合法性。', - 'type' => 'string', - 'example' => 'zi31STIMtIfa/UN2l+6lww****', - ], - 'Host' => [ - 'description' => 'OSS的接入域名。', - 'type' => 'string', - 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com', - ], - 'Policy' => [ - 'description' => '签名策略。', - 'type' => 'string', - 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMi0wMy0xNVQwMzowMzo0MC4zMTJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwidGVtcC9ibGFja2xpc3QvaW1wb3J0LzE1NzcyNDcxMTU0OTA0MDEvY2NjVjIta216LzIwMjIE1MTAwMzQwLyJd****', - ], - 'ExpireTime' => [ - 'description' => '过期时间，格式为Unix时间戳，单位秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1647313420', - ], - 'AccessKeyId' => [ - 'description' => '签名使用的accessKeyId。', - 'type' => 'string', - 'example' => '****', - ], - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"FilePath\\": \\"ccc-test/blacklist.xlsx\\",\\n \\"Signature\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"Host\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyMi0wMy0xNVQwMzowMzo0MC4zMTJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwidGVtcC9ibGFja2xpc3QvaW1wb3J0LzE1NzcyNDcxMTU0OTA0MDEvY2NjVjIta216LzIwMjIE1MTAwMzQwLyJd****\\",\\n \\"ExpireTime\\": 1647313420,\\n \\"AccessKeyId\\": \\"****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n\\n eyJleHBpcmF0aW9uIjoiMjAyMi0wMy0xNVQwMzowMzo0MC4zMTJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwidGVtcC9ibGFja2xpc3QvaW1wb3J0LzE1NzcyNDcxMTU0OTA0MDEvY2NjVjIta216LzIwMjIE1MTAwMzQwLyJdXX0=\\n temp/blacklist/import/157724711549xxxx/ccc-test/20220315100340/blacklist.xlsx\\n LTAI4GDDtCgcY8HmXTiExxxx\\n zi31STIMtIfa/UN2l+6lwwe9o=\\n https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com\\n 1647313420\\n\\nOK\\ntrue","errorExample":""}]', - 'title' => '获取禁呼文件上传参数', + 'title' => '删除坐席关联的多个号码', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ImportDoNotCallNumbers' => [ - 'summary' => '调用ImportDoNotCallNumbers向指定实例下导入一个或多个禁止外呼号码，导入方式包括手动录入和文件上传两种方式。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePersonalNumbersFromUser'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\nOK","errorExample":""}]', + ], + 'RemovePhoneNumberFromSkillGroups' => [ + 'summary' => '调用RemovePhoneNumberFromSkillGroups删除指定实例下指定号码关联的一个或多个技能组与该号码的绑定关系，删除的是号码与技能组的绑定关系，并不是真实号码。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'NumberList', - 'in' => 'query', - 'schema' => [ - 'description' => '禁止外呼号码列表，格式为JSON数组的字符串，数组元素是禁呼号码。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '["1900000****","1312121****"]', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Remark', + 'name' => 'Number', 'in' => 'query', - 'schema' => [ - 'description' => '禁呼号码的备注信息。', - 'type' => 'string', - 'required' => false, - 'example' => '测试', - ], + 'schema' => ['description' => '待解绑的号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0101234****'], ], [ - 'name' => 'FilePath', + 'name' => 'SkillGroupIdList', 'in' => 'query', - 'schema' => [ - 'description' => 'OSS文件的Key，可从GetDoNotCallFileUploadParameters接口返回值中获取，仅在文件上传方式导入时需要填写此参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'temp/blacklist/import/15772471154xxxx/ccc-test/20220315100340/blacklist.xlsx', - ], + 'schema' => ['description' => '待解绑的技能组ID列表，请确保技能组与号码之间原本就存在绑定关系。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'], ], ], 'responses' => [ @@ -49656,145 +24357,76 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'Params' => [ - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'], + ['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => '该参数无效。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n无\\nOK","errorExample":""}]', - 'title' => '导入禁止外呼号码', + 'title' => '删除多个技能组关联的号码', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListDoNotCallNumbers' => [ - 'summary' => '获取指定实例下指定搜索条件过滤后的禁止外呼号码列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumberFromSkillGroups'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', + ], + 'RemovePhoneNumbers' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'SearchPattern', - 'in' => 'query', - 'schema' => [ - 'description' => '根据电话号码或备注进行模糊匹配，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'RemarkA', - ], + [ + 'BearerToken' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc1MRAID'], + ], + 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PageSize', + 'name' => 'NumberList', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '待删除的号码列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["0101234****","0105678****"]'], ], [ - 'name' => 'Scope', + 'name' => 'Force', 'in' => 'query', - 'schema' => [ - 'description' => '应用范围，包括SYSTEM和INSTANCE，分别对应系统级禁止外呼和客户自定义禁止外呼，SYSTEM是关联实例所属的阿里云主账号的，INSTANCE只和当前实例关联，非必填，默认值INSTANCE。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SYSTEM' => '系统级禁止外呼配置', - 'INSTANCE' => '实例级禁止外呼配置', - ], - 'example' => 'INSTANCE', - ], + 'schema' => ['description' => '是否强制删除，如果号码关联了技能组、联系流或坐席，只有将该字段设置为true才可以执行删除，非必填，默认false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -49802,148 +24434,56 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'List' => [ - 'description' => '禁止外呼号码列表。', - 'type' => 'array', - 'items' => [ - 'description' => '禁止外呼号码信息。', - 'type' => 'object', - 'properties' => [ - 'Number' => [ - 'description' => '电话号码。', - 'type' => 'string', - 'example' => '1900000****', - ], - 'Scope' => [ - 'description' => '应用范围。', - 'type' => 'string', - 'enumValueTitles' => [ - 'SYSTEM' => '系统级禁止外呼配置', - 'INSTANCE' => '实例级禁止外呼配置', - ], - 'example' => 'INSTANCE', - ], - 'Remark' => [ - 'description' => '备注。', - 'type' => 'string', - 'example' => '测试', - ], - 'CreateTime' => [ - 'description' => '禁止外呼号码配置的创建时间，格式为Unix时间戳，单位毫秒。（废弃）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1626962425000', - ], - 'Creator' => [ - 'description' => '创建人，创建该记录的坐席的坐席登录名。', - 'type' => 'string', - 'example' => 'agent', - ], - 'CreatedTime' => [ - 'description' => '禁止外呼号码配置的创建时间，格式为Unix时间戳，单位毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1631440860000', - ], - ], - ], - ], - ], + 'description' => '删除失败的号码列表。', + 'type' => 'array', + 'items' => ['description' => '号码。', 'type' => 'string', 'example' => '0101234****'], + 'example' => '无', ], 'Params' => [ - 'description' => '响应参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Enumeration', - 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', - ], - [ - 'errorCode' => 'Parameter.Empty', - 'errorMessage' => 'The parameter %s may not be null or empty.', - ], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"1900000****\\",\\n \\"Scope\\": \\"INSTANCE\\",\\n \\"Remark\\": \\"测试\\",\\n \\"CreateTime\\": 1626962425000,\\n \\"Creator\\": \\"agent\\",\\n \\"CreatedTime\\": 1631440860000\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n无\\n\\n 1\\n 10\\n 1\\n \\n INSTANCE\\n 190xxxx0000\\n 1626962425000\\n user-test\\n RemarkA\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取禁止外呼号码列表', + 'title' => '删除号码', + 'summary' => '调用RemovePhoneNumbers删除指定实例下的一个或多个号码。并非真实删除某个号码，而是将这个号码与实例进行解绑，包括号码关联的技能组、联系流、坐席等，都将随之解绑。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RemoveDoNotCallNumbers' => [ - 'summary' => '调用RemoveDoNotCallNumbers删除指定实例下的一个或多个禁止外呼号码配置项。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumbers'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n \\"0101234****\\"\\n ],\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n无\\n无\\nOK","errorExample":""}]', + ], + 'RemovePhoneNumbersFromSkillGroup' => [ + 'summary' => '调用RemovePhoneNumbersFromSkillGroup删除指定实例下指定技能组关联的一个或多个号码与该技能组的关联关系。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -49952,30 +24492,29 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ 'name' => 'NumberList', 'in' => 'query', - 'schema' => [ - 'description' => '待删除的禁止外呼号码列表，格式为JSON数组的字符串，数组长度区间为1-300。', - 'type' => 'string', - 'required' => false, - 'example' => '["1900000****","1312211****"]', - ], + 'schema' => ['description' => '号码列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["0101234****","0105678****"]'], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'query', + 'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'], ], ], 'responses' => [ @@ -49983,77 +24522,46 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'Params' => [ - 'description' => '错误消息中占位符对应的响应参数。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => 'numberList', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'], + ['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => '该参数无效。'], ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"numberList\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n无\\n无\\nOK","errorExample":""}]', - 'title' => '删除禁止外呼号码', + 'title' => '删除技能组关联的多个号码', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListFlashSmsSettings' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumbersFromSkillGroup'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', + ], + 'RemoveSkillGroupsFromUser' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -50062,204 +24570,168 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ - 'name' => 'SkillGroupName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'required' => false, - 'example' => '闪信测试技能组', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ 'name' => 'SkillGroupIdList', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '取消关联的技能组ID列表，格式为JSON数组的字符串，数组元素是技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '坐席所属技能组ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '技能组ID列表。', - 'type' => 'string', - 'required' => false, - 'example' => '["skillgroup1@ccc-test"]', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], ], - 'required' => false, + 'description' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '删除坐席关联的多个技能组', + 'summary' => '调用RemoveSkillGroupsFromUser删除指定实例下指定坐席关联的一个或多个技能组与该坐席之间的关联关系。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSkillGroupsFromUser'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\nOK","errorExample":""}]', + ], + 'RemoveUsers' => [ + 'summary' => '调用RemoveUsers删除指定实例下的一个或多个坐席，该操作仅将RAM账户与实例解绑，然后将RAM账户映射的坐席从实例中删除，并不会删除RAM账户本身。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'AK' => [], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], + 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ListFlashSmsSettingsResponse', - 'description' => 'ListFlashSmsSettingsResponse', - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => '总数。'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '分页序号。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'List' => [ - 'description' => '配置列表。', - 'type' => 'array', - 'items' => [ - 'description' => '配置。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'SkillGroupId' => [ - 'description' => '技能组ID。', - 'type' => 'string', - 'example' => 'skillgroup1@ccc-test', - ], - 'Enabled' => [ - 'description' => '该技能组闪信是否处于启用状态。'."\n" - ."\n" - .'- **true**：启用状态。'."\n" - ."\n" - .'- **false**：停用状态。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'SkillGroupName' => [ - 'description' => '技能组名称。', - 'type' => 'string', - 'example' => '闪信测试技能组', - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + [ + 'name' => 'UserIdList', + 'in' => 'query', + 'schema' => ['description' => '坐席ID列表，格式为JSON数组的字符串，数组元素是坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["agent1@ccc-test","agent2@ccc-test"]'], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => ['description' => '是否强制删除。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'FilePath', + 'in' => 'query', + 'schema' => ['description' => '待删除用户列表文件的OSS对象的ObjectKey。', 'type' => 'string', 'required' => false, 'example' => 'temp/removeUsers.xlsx'], + ], + [ + 'name' => 'NotificationEmail', + 'in' => 'query', + 'schema' => ['description' => '通知邮件地址。', 'type' => 'string', 'required' => false, 'example' => '123@abc.com'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Params' => [ - 'description' => '错误参数列表。', + 'description' => '响应参数。', 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '删除坐席', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-17T01:12:02.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-04-14T05:54:04.000Z', 'description' => '请求参数发生变更'], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsers'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup1@ccc-test\\",\\n \\"Enabled\\": true,\\n \\"SkillGroupName\\": \\"闪信测试技能组\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取闪信坐技能组配置', - 'summary' => '使用ListFlashSmsSettings接口获取指定技能组闪信相关配置。', + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\nOK","errorExample":""}]', ], - 'ListFlashSmsApplications' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RemoveUsersFromSkillGroup' => [ + 'summary' => '调用RemoveUsersFromSkillGroup删除指定实例下指定技能组关联的一个或多个坐席，该操作仅删除技能组与坐席之间的关联关系，并不会删除坐席。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -50268,190 +24740,75 @@ 'BearerToken' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ - 'name' => 'ProviderId', - 'in' => 'query', - 'schema' => [ - 'description' => '闪信供应商ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'Uincall', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '闪信配置名称。', - 'type' => 'string', - 'required' => false, - 'example' => '闪信', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PageSize', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => '技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test'], ], [ - 'name' => 'InstanceId', + 'name' => 'UserIdList', 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '坐席ID列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["agent1@ccc-test","agent2@ccc-test"]'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ListFlashSmsMetadataResponse', - 'description' => 'ListFlashSmsApplicationResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'List' => [ - 'description' => '闪信配置列表。', - 'type' => 'array', - 'items' => [ - 'description' => '闪信配置。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'ProviderId' => [ - 'description' => '闪信供应商ID。', - 'type' => 'string', - 'example' => 'Uincall', - ], - 'ApplicationId' => [ - 'description' => '注册ID。', - 'type' => 'string', - 'example' => '71b396fa-***********-bd80e070b7c0', - ], - 'Name' => [ - 'description' => '配置名称。', - 'type' => 'string', - 'example' => '闪信配置', - ], - 'Value' => [ - 'description' => '配置内容。', - 'type' => 'string', - 'example' => '{"user":"600******_dev","pwd":"85abf3**********f494e","account":"6004******"}', - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的技能组ID。'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => '删除技能组关联的多个坐席', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsersFromSkillGroup'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ProviderId\\": \\"Uincall\\",\\n \\"ApplicationId\\": \\"71b396fa-***********-bd80e070b7c0\\",\\n \\"Name\\": \\"闪信配置\\",\\n \\"Value\\": \\"{\\\\\\"user\\\\\\":\\\\\\"600******_dev\\\\\\",\\\\\\"pwd\\\\\\":\\\\\\"85abf3**********f494e\\\\\\",\\\\\\"account\\\\\\":\\\\\\"6004******\\\\\\"}\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取闪信配置信息', - 'summary' => '使用ListFlashSmsApplication获取第三方闪信配置信息。', + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\nOK","errorExample":""}]', ], - 'ListFlashSmsTemplates' => [ - 'summary' => '使用ListFlashSmsTemplates获取闪信模板信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ResetAgentState' => [ + 'summary' => '调用ResetAgentState重置指定实例下指定坐席的坐席状态。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -50460,135 +24817,112 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccIPHVDY', - ], + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ - 'name' => 'ProviderId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '闪信供应商ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'Uincall', - ], + 'schema' => ['description' => '实例ID。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'ApplicationId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '闪信配置ID。', - 'type' => 'string', - 'required' => false, - 'example' => '71b396fa-1*********-70b7c0', - ], + 'schema' => ['description' => '坐席ID，非必填，不填默认使用当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'InstanceId', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '设备ID，可以随便填写，无特殊作用，无特殊要求。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ListFlashSmsTemplatesResponse', - 'description' => 'ListFlashSmsTemplatesResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'array', - 'items' => [ - 'description' => '闪信模板', - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'description' => '模板ID。', - 'type' => 'string', - 'example' => '1715*****38', - ], - 'TemplateName' => [ - 'description' => '模板名称。', - 'type' => 'string', - 'example' => '测试模板', - ], - 'TemplateDetails' => [ - 'type' => 'string', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Params' => [ - 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', + 'items' => ['description' => '参数信息。', 'type' => 'string', 'example' => '无'], + 'description' => '', + ], + 'Data' => [ + 'description' => '坐席状态数据。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'JobId' => ['description' => '通话ID，如果该字段有值，说明坐席当前处于通话过程中。', 'type' => 'string', 'example' => '无'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休码包括：Warm-up'."\n" + .'（坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否开启了仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'UserState' => [ + 'description' => '坐席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'OFFLINE', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TemplateId\\": \\"1715*****38\\",\\n \\"TemplateName\\": \\"测试模板\\",\\n \\"TemplateDetails\\": \\"\\"\\n }\\n ],\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取闪信模板信息', - ], - 'ListSmsMetadata' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '重置坐席状态', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAgentState'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"OFFLINE\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n200\\n\\n 80011112\\n OFFLINE\\n ccc-test\\n user-test@ccc-test\\n false\\n ON_SITE\\n\\nOK","errorExample":""}]', + ], + 'ResetUserPassword' => [ + 'summary' => '调用ResetUserPassword重置指定实例下指定坐席的登录密码。实际上坐席并没有登录密码，修改的是坐席关联的RAM账户的登录密码，通常用于客服忘记自己的RAM账户登录密码的场景。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -50597,66 +24931,29 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '251523', - 'abilityTreeNodes' => [ - 'FEATUREcccBM6DRP', - ], + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PageSize', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '100', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'ScenarioListJson', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => '场景类型。'."\n" - .'- SATISFACTION_SURVEY（满意度调查）'."\n" - .'- CONTACT_FLOW_NODE（IVR流程节点）'."\n" - .'- MISSED_CALL_NOTIFICATION（漏话提醒）'."\n" - .'- FLASH_SMS（阿里通信闪信通知）', - 'type' => 'string', - 'required' => false, - 'example' => '["SATISFACTION_SURVEY","CONTACT_FLOW_NODE"]', - ], + 'schema' => ['description' => '新的密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'password'], ], ], 'responses' => [ @@ -50664,343 +24961,170 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8707EB29-BAED-4302-B999-40BA61877437', - ], - 'Params' => [ - 'description' => '错误参数列表。', - 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'List' => [ - 'description' => '短信配置列表。', - 'type' => 'array', - 'items' => [ - 'description' => '短信配置。', - 'type' => 'object', - 'properties' => [ - 'SmsMetadataId' => [ - 'description' => '短信配置ID。', - 'type' => 'string', - 'example' => '5ffc1c9a-4d3d-4019-*****-73255fb01d1c', - ], - 'TemplateCode' => [ - 'description' => '模板CODE。', - 'type' => 'string', - 'example' => 'SMS_468xxxx298', - ], - 'Description' => [ - 'description' => '配置描述。', - 'type' => 'string', - 'example' => '漏话短信配置', - ], - 'Scenario' => [ - 'description' => '场景类型。', - 'type' => 'string', - 'example' => 'MISSED_CALL_NOTIFICATION', - ], - 'AliyunUid' => [ - 'description' => '阿里云账号ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15772400000****', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Name' => [ - 'description' => '配置名称。', - 'type' => 'string', - 'example' => '漏话短信提醒', - ], - 'SignName' => [ - 'description' => '短信签名名称。', - 'type' => 'string', - 'example' => '云呼叫中心', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s must not be null or empty.', - ], - [ - 'errorCode' => 'Parameter.Maximum', - 'errorMessage' => 'The parameter %s must be less than or equal to %s.', - ], - [ - 'errorCode' => 'Parameter.Minimum', - 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', - ], + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], ], - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 403 => [ + ['errorCode' => 'Permission.Role', 'errorMessage' => 'You have no permission to access role %s.', 'description' => '您无权访问指定角色。'], + ], + [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], + ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], + ['errorCode' => 'InternalService.RAM', 'errorMessage' => 'An internal RAM service error occurred. %s', 'description' => '内部RAM服务错误。'], + ['errorCode' => 'InternalService.STS', 'errorMessage' => 'An internal STS service error occurred. %s', 'description' => '内部STS服务错误。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => '重置坐席密码', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetUserPassword'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 200,\\n \\"List\\": [\\n {\\n \\"SmsMetadataId\\": \\"5ffc1c9a-4d3d-4019-*****-73255fb01d1c\\",\\n \\"TemplateCode\\": \\"SMS_468xxxx298\\",\\n \\"Description\\": \\"漏话短信配置\\",\\n \\"Scenario\\": \\"MISSED_CALL_NOTIFICATION\\",\\n \\"AliyunUid\\": 0,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"漏话短信提醒\\",\\n \\"SignName\\": \\"云呼叫中心\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '获取短信配置详情', - 'summary' => '使用ListSmsMetadata获取短信配置详情。', + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\nOK","errorExample":""}]', ], - 'ExportContactFlow' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'RestoreArchivedRecordings' => [ + 'summary' => '解冻指定实例下的通话录音。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '251084', - 'abilityTreeNodes' => [ - 'FEATUREcccTPIKHY', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ - 'name' => 'FlowId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'IVR联系流ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'lc-uf61xdtm0mf73k', - ], - ], - [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID', - 'type' => 'string', - 'required' => false, - 'example' => 'AF9834D8-6D09-4A1B-BADB-B019D9D444C8', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', - ], + 'name' => 'ContactIds', + 'in' => 'query', + 'schema' => ['description' => '话务ID列表，JSON格式。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[\\"job-216750038017142784\\"]'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ExportFlowResponse', - 'description' => 'ExportFlowResponse', 'type' => 'object', 'properties' => [ - 'FlowPackageData' => [ - 'description' => '数据', - 'type' => 'string', - 'example' => '{}', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '响应参数。', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'Instance 0 does not exist.'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F8066648-5D95-55AB-ACD3-2F4AD3BEA715'], + 'Data' => [ + 'description' => '数据。'."\n", 'type' => 'array', 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', + 'description' => '数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'Exists' => ['description' => '录音文件是否存在。', 'type' => 'string', 'example' => 'False'], + 'ContactId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-25920271311543****'], + 'Status' => ['description' => '录音解冻状态，可选值为Completed或者Progressing。', 'type' => 'string', 'example' => 'Progressing'], + 'StorageType' => ['description' => '录音文件的存储类型。', 'type' => 'string', 'example' => 'Standard'], + ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => '参数必须小于或等于系统规定的最大值。'], + ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => '参数必须大于或等于系统规定的最小值。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => '该参数不能为null值.'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FlowPackageData\\": \\"{}\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '导出IVR流程', - ], - 'ImportContactFlow' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '解冻录音文件', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestoreArchivedRecordings'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance 0 does not exist.\\",\\n \\"RequestId\\": \\"F8066648-5D95-55AB-ACD3-2F4AD3BEA715\\",\\n \\"Data\\": [\\n {\\n \\"Exists\\": \\"False\\",\\n \\"ContactId\\": \\"job-25920271311543****\\",\\n \\"Status\\": \\"Progressing\\",\\n \\"StorageType\\": \\"Standard\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ResubmitTicket' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '251083', - 'abilityTreeNodes' => [ - 'FEATUREcccTPIKHY', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'FlowPackageData', - 'in' => 'formData', - 'schema' => [ - 'description' => '数据', - 'type' => 'string', - 'required' => true, - 'example' => '{}', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', - ], + 'name' => 'TicketId', + 'in' => 'query', + 'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => true, 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5'], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => '处理意见。', 'type' => 'string', 'required' => false, 'example' => '信息已补充'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ImportFlowResponse', - 'description' => 'ImportFlowResponse', + 'title' => 'CloseTicketResponse', + 'description' => 'CloseTicketResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '27DD30C4-CAE2-481A-97CC-D3C54625341D', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], + 'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Params' => [ - 'description' => '响应参数。', + 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -51008,24 +25132,22 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27DD30C4-CAE2-481A-97CC-D3C54625341D\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '导入IVR流程', - ], - 'CreateContactFlow' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '重新提交工单', + 'summary' => '使用ResubmitTicket接口对驳回/退回的工单重新提交。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'ResumeCampaign' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -51034,126 +25156,57 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '联系流名称。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '默认流程', - ], - ], - [ - 'name' => 'Definition', - 'in' => 'query', - 'schema' => [ - 'description' => 'IVR的内容。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好，欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '版本描述。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1.0', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Type', + 'name' => 'CampaignId', 'in' => 'query', - 'schema' => [ - 'description' => '流程类型。 '."\n" - .'主流程：MAIN\\_FLOW '."\n" - .'子流程：SUB\\_FLOW '."\n" - .'满意度流程：SURVEY\\_FLOW', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MAIN_FLOW', - ], + 'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。'."\n", - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => 'IVR联系流ID。', - 'type' => 'string', - 'example' => '78128960-bb00-4ddc-8e82-923a8c5bd22d', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F505C4C8-1E12-573A-9BA7-4BEAAD129553'], + 'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"78128960-bb00-4ddc-8e82-923a8c5bd22d\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\"\\n}","type":"json"}]', - 'title' => '创建联系流', - 'summary' => '创建一个IVR流程。', - ], - 'ListContactFlows' => [ - 'summary' => '调用ListContactFlows获取指定实例下的IVR联系流列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '恢复预测式外呼活动', + 'summary' => '调用ResumeCampaign恢复指定实例下指定ID对应的预测式外呼活动。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeCampaign'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F505C4C8-1E12-573A-9BA7-4BEAAD129553\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F505C4C8-1E12-573A-9BA7-4BEAAD129553\\n OK\\n 无\\n 200\\n","errorExample":""}]', + ], + 'RetrieveCall' => [ + 'summary' => '调用RetrieveCall取回指定实例下指定通话ID对应的通话，通话必须处于保持状态才可操作取回。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -51162,96 +25215,39 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '分页序号，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页大小，范围1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Type', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '按IVR流程类型过滤，非必填，默认为空，为空表示不过滤。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SURVEY_FLOW' => '满意度流程', - 'SUB_FLOW' => '子流程', - 'MAIN_FLOW' => '主流程', - ], - 'example' => 'MAIN_FLOW', - ], + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'SortOrder', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '排序方向。取值范围：'."\n" - .'- **ASC**：升序'."\n" - .'- **DESC**（默认值）：降序', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], ], [ - 'name' => 'OrderByField', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '排序字段。', - 'type' => 'string', - 'required' => false, - 'example' => 'updatedTime', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****'], ], [ - 'name' => 'SearchPattern', + 'name' => 'ChannelId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '待取回的话务通道ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****'], ], ], 'responses' => [ @@ -51259,157 +25255,222 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => '分页序号。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '分页大小。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'List' => [ - 'description' => '联系流列表。'."\n" - ."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'IVR联系流类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'SURVEY_FLOW' => '满意度流程', - 'SUB_FLOW' => '子流程', - 'MAIN_FLOW' => '主流程', - ], - 'example' => 'MAIN_FLOW', - ], - 'Definition' => [ - 'description' => 'IVR的内容，由后台解析，客户无需关心。', - 'type' => 'string', - 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好，欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}', - ], - 'DraftId' => [ - 'description' => '草稿ID，当IVR流程处于未发布状态时返回此字段。', - 'type' => 'string', - 'example' => 'db07c0bb-6b1f-47d2-b37e-2451c617562d', - ], - 'Description' => [ - 'description' => '版本描述。', - 'type' => 'string', - 'example' => '1.0', - ], - 'UpdatedTime' => [ - 'description' => '上次修改的时间。', - 'type' => 'string', - 'example' => '2021-03-08 15:34:49.0', - ], - 'Editor' => [ - 'description' => '此草稿的当前编辑者的坐席登录名。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Published' => [ - 'description' => '是否发布过。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Name' => [ - 'description' => 'IVR联系流名称。', - 'type' => 'string', - 'example' => '默认流程', - ], - 'ContactFlowId' => [ - 'description' => 'IVR联系流ID。', - 'type' => 'string', - 'example' => '78128960-bb00-4ddc-8e82-923a8c5bd22d', - ], - 'CreatedTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2021-03-05 17:35:45.0', + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', ], - 'NumberList' => [ - 'description' => 'IVR联系流绑定的号码列表。', - 'type' => 'array', - 'items' => [ - 'description' => '号码', - 'type' => 'string', - 'example' => '400289****', + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'CREATED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'SkillGroupId' => ['description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], ], ], ], ], ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'BREAK', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], + ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Type\\": \\"MAIN_FLOW\\",\\n \\"Definition\\": \\"{\\\\\\"activities\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"INCOMING_CALL\\\\\\",\\\\\\"id\\\\\\":\\\\\\"e98f0d47\\\\\\",\\\\\\"name\\\\\\":\\\\\\"开始\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":263,\\\\\\"y\\\\\\":164}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"41f7dbd0\\\\\\"}],\\\\\\"nodeIndex\\\\\\":0},{\\\\\\"type\\\\\\":\\\\\\"HANGUP\\\\\\",\\\\\\"id\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"挂机\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":765,\\\\\\"y\\\\\\":185}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":null}],\\\\\\"nodeIndex\\\\\\":999},{\\\\\\"type\\\\\\":\\\\\\"PLAY_SAY\\\\\\",\\\\\\"id\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"放音\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"say\\\\\\":\\\\\\"您好，欢迎来到云联络中心。\\\\\\",\\\\\\"audioResourceId\\\\\\":\\\\\\"\\\\\\",\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":485.5,\\\\\\"y\\\\\\":153.5},\\\\\\"audioType\\\\\\":\\\\\\"tts\\\\\\",\\\\\\"audioInterrupt\\\\\\":false},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"e1af4f1f\\\\\\"}],\\\\\\"nodeIndex\\\\\\":1}],\\\\\\"description\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"DraftId\\": \\"db07c0bb-6b1f-47d2-b37e-2451c617562d\\",\\n \\"Description\\": \\"1.0\\",\\n \\"UpdatedTime\\": \\"2021-03-08 15:34:49.0\\",\\n \\"Editor\\": \\"ccc-test\\",\\n \\"Published\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"默认流程\\",\\n \\"ContactFlowId\\": \\"78128960-bb00-4ddc-8e82-923a8c5bd22d\\",\\n \\"CreatedTime\\": \\"2021-03-05 17:35:45.0\\",\\n \\"NumberList\\": [\\n \\"400289****\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n\\n 1\\n 10\\n 1\\n \\n MAIN_FLOW\\n 1.0\\n 2021-03-05 17:35:45.0\\n ccc-test\\n 78128960-bb00-4ddc-8e82-923a8c5bd22d\\n {\\"activities\\":[{\\"type\\":\\"INCOMING_CALL\\",\\"id\\":\\"e98f0d47\\",\\"name\\":\\"开始\\",\\"properties\\":{\\"position\\":{\\"x\\":263,\\"y\\":164}},\\"events\\":[{\\"event\\":\\"complete\\",\\"next\\":\\"2d3ad2c2\\",\\"edgeId\\":\\"41f7dbd0\\"}],\\"nodeIndex\\":0},{\\"type\\":\\"HANGUP\\",\\"id\\":\\"bd4f37e2\\",\\"name\\":\\"挂机\\",\\"properties\\":{\\"position\\":{\\"x\\":765,\\"y\\":185}},\\"events\\":[{\\"event\\":\\"complete\\",\\"next\\":null}],\\"nodeIndex\\":999},{\\"type\\":\\"PLAY_SAY\\",\\"id\\":\\"2d3ad2c2\\",\\"name\\":\\"放音\\",\\"properties\\":{\\"say\\":\\"您好，欢迎来到阿里云呼叫中心。\\",\\"audioResourceId\\":\\"\\",\\"position\\":{\\"x\\":485.5,\\"y\\":153.5},\\"audioType\\":\\"tts\\",\\"audioInterrupt\\":false},\\"events\\":[{\\"event\\":\\"complete\\",\\"next\\":\\"bd4f37e2\\",\\"edgeId\\":\\"e1af4f1f\\"}],\\"nodeIndex\\":1}],\\"description\\":\\"\\"}\\n true\\n 2021-03-08 15:34:49.0\\n db07c0bb-6b1f-47d2-b37e-2451c617562d\\n ccc-test\\n 测试IVR\\n [\\"400xxxx289\\"]\\n \\n\\nOK","errorExample":""}]', - 'title' => '获取联系流列表', + 'title' => '取回通话', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RetrieveCall'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n skg-test1@ccc-test\\n \\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', ], - 'GetContactFlow' => [ - 'methods' => [ - 'post', - 'get', + 'SaveDocument' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'SchemaId', + 'in' => 'formData', + 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'], + ], + [ + 'name' => 'DocumentId', + 'in' => 'formData', + 'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + ], + [ + 'name' => 'DocumentJson', + 'in' => 'formData', + 'schema' => ['description' => '要保存的文档内容，需要符合Schema定义的规则', 'type' => 'string', 'required' => true, 'example' => '{"name":"tom"}'], + ], + [ + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'SaveDocumentResponse', + 'description' => 'SaveDocumentResponse', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => '数据。', 'type' => 'string', 'example' => '0101234****'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息'."\n" + ."\n", 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"0101234****\\",\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '保存Document', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'SaveRTCStatsV2' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -51418,42 +25479,45 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '50605', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'ContactFlowId', + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '257e73de-1ee8-123b-0b9a-00163e0a****'], + ], + [ + 'name' => 'GeneralInfo', + 'in' => 'query', + 'schema' => ['description' => '通用信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[null,"","","1647337928819","1647337888816","agent",null,"上海","10.10.XX.XX","11.1.XX.XX","2002"]'], + ], + [ + 'name' => 'SenderReport', + 'in' => 'query', + 'schema' => ['description' => '发送报告内容。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["11090","2055127460","0","2236","384592","ssrc_2055127460_send","2022-03-15T09:52:08.820Z","1"]'], + ], + [ + 'name' => 'ReceiverReport', 'in' => 'query', - 'schema' => [ - 'description' => '联系流ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '274601be-a6d5-4429-bcef-32b51d031c6e', - ], + 'schema' => ['description' => '收到报告内容。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["1","1649328987","40","PCMU","383560","89","49","ssrc_1649328987_recv","2022-03-15T09:52:08.820Z","","0","20000"]'], ], [ - 'name' => 'DraftId', + 'name' => 'GoogAddress', 'in' => 'query', - 'schema' => [ - 'description' => '草稿ID，当前联系流对应的可编辑草稿版本ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '566399d7-5558-447c-a72f-9be2768b6a82', - ], + 'schema' => ['description' => '接入点地址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["47.101.XX.XX","44368","47.104.XX.XX","37947"]'], ], ], 'responses' => [ @@ -51461,116 +25525,46 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780', - ], - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '流程类型： '."\n" - .'MAIN\\_FLOW（主流程） '."\n" - .'SUB\\_FLOW（子流程） '."\n" - .'SURVEY\\_FLOW（满意度流程）', - 'type' => 'string', - 'example' => 'MAIN_FLOW', - ], - 'Definition' => [ - 'description' => 'IVR的内容。', - 'type' => 'string', - 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好，欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}', - ], - 'DraftId' => [ - 'description' => '草稿ID，当前联系流对应的可编辑草稿版本ID。', - 'type' => 'string', - 'example' => '566399d7-5558-447c-a72f-9be2768b6a82'."\n", - ], - 'Description' => [ - 'description' => '版本描述。', - 'type' => 'string', - 'example' => '1.0'."\n", - ], - 'UpdatedTime' => [ - 'description' => '上次修改的时间。', - 'type' => 'string', - 'example' => '2021-07-14 10:48:43.0', - ], - 'Editor' => [ - 'description' => '此草稿的当前编辑者的坐席登录名。', - 'type' => 'string', - 'example' => 'editor-xxx', - ], - 'Published' => [ - 'description' => '是否已发布 True：已发布：False：未发布', - 'type' => 'boolean', - 'example' => 'False', - ], - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'Name' => [ - 'description' => 'IVR名称。', - 'type' => 'string', - 'example' => '欢迎语', - ], - 'ContactFlowId' => [ - 'description' => '联系流ID。', - 'type' => 'string', - 'example' => '274601be-a6d5-4429-bcef-32b51d031c6e'."\n", - ], - 'CreatedTime' => [ - 'description' => '联系流程草稿创建时间。', - 'type' => 'string', - 'example' => '2021-07-14 10:48:43.0', - ], - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'TimeStamp' => ['description' => '生成记录时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1647309061000'], + 'RowCount' => ['description' => '行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 403 => [ + ['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => '您无权访问这些用户。'], + ], + [ + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], + ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\",\\n \\"Data\\": {\\n \\"Type\\": \\"MAIN_FLOW\\",\\n \\"Definition\\": \\"{\\\\\\"activities\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"INCOMING_CALL\\\\\\",\\\\\\"id\\\\\\":\\\\\\"e98f0d47\\\\\\",\\\\\\"name\\\\\\":\\\\\\"开始\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":263,\\\\\\"y\\\\\\":164}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"41f7dbd0\\\\\\"}],\\\\\\"nodeIndex\\\\\\":0},{\\\\\\"type\\\\\\":\\\\\\"HANGUP\\\\\\",\\\\\\"id\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"挂机\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":765,\\\\\\"y\\\\\\":185}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":null}],\\\\\\"nodeIndex\\\\\\":999},{\\\\\\"type\\\\\\":\\\\\\"PLAY_SAY\\\\\\",\\\\\\"id\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"放音\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"say\\\\\\":\\\\\\"您好，欢迎来到云联络中心。\\\\\\",\\\\\\"audioResourceId\\\\\\":\\\\\\"\\\\\\",\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":485.5,\\\\\\"y\\\\\\":153.5},\\\\\\"audioType\\\\\\":\\\\\\"tts\\\\\\",\\\\\\"audioInterrupt\\\\\\":false},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"e1af4f1f\\\\\\"}],\\\\\\"nodeIndex\\\\\\":1}],\\\\\\"description\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"DraftId\\": \\"566399d7-5558-447c-a72f-9be2768b6a82\\\\n\\",\\n \\"Description\\": \\"1.0\\\\n\\",\\n \\"UpdatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"Editor\\": \\"editor-xxx\\",\\n \\"Published\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"欢迎语\\",\\n \\"ContactFlowId\\": \\"274601be-a6d5-4429-bcef-32b51d031c6e\\\\n\\",\\n \\"CreatedTime\\": \\"2021-07-14 10:48:43.0\\"\\n }\\n}","type":"json"}]', - 'title' => '获取指定联系流', - 'summary' => '获取指定联系流。', - ], - 'StartEditContactFlow' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '上报坐席端WebRTC统计信息', + 'summary' => '调用SaveRTCStatsV2上报坐席端WebRTC语音传输统计信息，普通客户无需关心该接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1647309061000,\\n \\"RowCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\n1\\nOK\\n1647309061000\\ntrue","errorExample":""}]', + ], + 'SaveTerminalLog' => [ + 'summary' => '调用SaveTerminalLog上报坐席端日志信息，普通客户无需关心该接口。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -51581,29 +25575,58 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '50606', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'ContactFlowId', + 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'description' => '联系流ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '798e83a9-5140-4039-afa1-761ca4cca2df', - ], + 'schema' => ['description' => '话务通道的CallId，有SIP协议生成，每个SIP通话都有一个CallId。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e13c9740-1e37-123b-21b6-00163e352f9'], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-b8b0ca63-330c-4e65-8ae3-9de2c7ce7683'], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'APP名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CCCClient'], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'schema' => ['description' => '数据类型，默认是1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '1'], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => ['description' => '内容信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'none'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '状态信息，true或false。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'true'], + ], + [ + 'name' => 'UniqueRequestId', + 'in' => 'query', + 'schema' => ['description' => '方法请求ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'none'], + ], + [ + 'name' => 'MethodName', + 'in' => 'query', + 'schema' => ['description' => '方法名称。', 'type' => 'string', 'required' => false, 'example' => 'TurnServerTest'], ], ], 'responses' => [ @@ -51611,123 +25634,89 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '数据，联系流草稿ID。', - 'type' => 'string', - 'example' => 'b3114362-9062-46c7-82dc-ae55ac168b2e', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BC2733CE-C470-564A-8C11-9DC02468823A', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'TimeStamp' => ['description' => '生成日志时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1647309061000'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 400 => [ + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => '该参数的格式不合法。'], + ], + 403 => [ + ['errorCode' => 'Permission.Unauthorized', 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', 'description' => '您无权执行此操作。 必须具有指定权限。'], + ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"b3114362-9062-46c7-82dc-ae55ac168b2e\\",\\n \\"RequestId\\": \\"BC2733CE-C470-564A-8C11-9DC02468823A\\"\\n}","type":"json"}]', - 'title' => '创建联系流草稿', - 'summary' => '发起编辑联系流，生成联系流草稿。', - ], - 'CommitContactFlow' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '保存坐席端日志信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SaveTerminalLog'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1647309061000\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\nOK\\n1647309061000\\ntrue","errorExample":""}]', + ], + 'SaveWebRTCStats' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '50608', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'ContactFlowId', + 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'description' => '联系流ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '7d706489-d06d-4a92-8666-8c9dba2c5cb1', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '257e73de-1ee8-123b-0b9a-00163e0a****'], ], [ - 'name' => 'Definition', + 'name' => 'GeneralInfo', 'in' => 'query', - 'schema' => [ - 'description' => 'IVR的定义。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好，欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}', - ], + 'schema' => ['description' => '通用信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[null,"","","1647337928819","1647337888816","agent",null,"上海","10.10.XX.XX","11.1.XX.XX","2002"]'], ], [ - 'name' => 'Description', + 'name' => 'SenderReport', 'in' => 'query', - 'schema' => [ - 'description' => '版本描述。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '发送报告内容。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["11090","2055127460","0","2236","384592","ssrc_2055127460_send","2022-03-15T09:52:08.820Z","1"]'], ], [ - 'name' => 'DraftId', + 'name' => 'ReceiverReport', 'in' => 'query', - 'schema' => [ - 'description' => '草稿ID，当前联系流对应的草稿版本ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b28f74ca-5846-4496-8bbd-34fb1750798c', - ], + 'schema' => ['description' => '收到报告内容。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["1","1649328987","40","PCMU","383560","89","49","ssrc_1649328987_recv","2022-03-15T09:52:08.820Z","","0","20000"]'], + ], + [ + 'name' => 'GoogAddress', + 'in' => 'query', + 'schema' => ['description' => '接入点地址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["47.101.XX.XX","44368","47.104.XX.XX","37947"]'], ], ], 'responses' => [ @@ -51735,52 +25724,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '937617D5-01E9-5A39-B52D-15D5C143260C', - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'TimeStamp' => ['description' => '生成记录时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1555492246000'], + 'RowCount' => ['description' => '行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 403 => [ + ['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => '您无权访问这些用户。'], + ], + [ + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], + ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"937617D5-01E9-5A39-B52D-15D5C143260C\\"\\n}","type":"json"}]', - 'title' => '提交联系流', - 'summary' => '提交联系流。', - ], - 'PublishContactFlow' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '上报坐席端WebRTC统计信息', + 'summary' => '调用SaveWebRTCStats上报坐席端WebRTC语音传输统计信息，普通客户无需关心该接口。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"CF1C21B9-2D49-4B54-880F-FBE248C16903\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1555492246000,\\n \\"RowCount\\": 1\\n}","type":"json"}]', + ], + 'SaveWebRtcInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -51789,96 +25768,86 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '50607', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'ContactFlowId', + 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'description' => '联系流ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b0a063bf-f138-42a4-ad9f-9babe3ec1a9e', - ], + 'schema' => ['description' => '话务通道的CallId，有SIP协议生成，每个SIP通话都有一个CallId。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e13c9740-1e37-123b-21b6-00163e352f9'], ], [ - 'name' => 'DraftId', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '草稿ID，当前联系流对应的草稿版本ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0e0b8e78-af3e-4360-a5c5-f9bb5c2b8af2', - ], + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-b8b0ca63-330c-4e65-8ae3-9de2c7ce7683'], + ], + [ + 'name' => 'ContentType', + 'in' => 'query', + 'schema' => ['description' => '上报内容，值来自前端WebRTC中rtcPeerConnection.getStats(selector)获取的语音传输质量数据，只在云联络中心的公有云平台中使用，集成客户无需关心。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4'], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => ['description' => '上报内容信息，只在云联络中心的公有云平台中使用，集成客户无需关心。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"media_source":{},"remote_inbound_rtp":{},"outbound_rtp":{},"inbound_rtp":{},"remote_outbound_rtp":{},"candidate":{},"basic":{"callId":"e13c9740-1e37-123b-21b6-00163e352f9","timestamp":"1647262108395","callStartTime":"1647262108393","uid":"user-test","access_point":"shanghai","browser":"90","ip":"127.0.0.1"}}'], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。'."\n" - ."\n", - 'type' => 'string', - 'example' => 'BFB6788F-20D4-5767-BC67-99EAAC28F789', - ], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903'], + 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'TimeStamp' => ['description' => '信息入库时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1647262108395'], + 'RowCount' => ['description' => '信息入库返回的行数，表示成功写入多少条记录，如果不为1，可能有异常，需要关注。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 403 => [ + ['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => '您无权访问这些用户。'], + ], + [ + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], + ], + 500 => [ + ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => '内部服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BFB6788F-20D4-5767-BC67-99EAAC28F789\\"\\n}","type":"json"}]', - 'title' => '发布联系流', - 'summary' => '发布联系流。', - ], - 'DiscardEditingContactFlow' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '上报WebRTC状态信息', + 'summary' => '调用SaveWebRtcInfo上报座席端WebRTC的通话状态信息，包括通话质量监控数据等，用于后台统计和监控，客户无需关心该接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"CF1C21B9-2D49-4B54-880F-FBE248C16903\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1647262108395,\\n \\"RowCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"CF1C21B9-2D49-4B54-880F-FBE248C16903\\n无\\n200\\n1\\nOK\\n1647262108395\\ntrue","errorExample":""}]', + ], + 'SendDtmfSignaling' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -51887,42 +25856,44 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'ContactFlowId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '联系流ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '3ff4e021-fd63-4572-ad8c-10ed69972965', - ], + 'schema' => ['description' => '发送DTMF的坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'DraftId', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '草稿ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0aa493d6-58eb-4290-9ba2-e1c2c615b46b', - ], + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6573574060089****'], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => ['description' => '待发送DTMF的话务通道ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ch:customer:0108989****->1318888****:1609234221870:job-6573574060089****'], + ], + [ + 'name' => 'Dtmf', + 'in' => 'query', + 'schema' => ['description' => 'DTMF按键信息，即拨号盘上的按键，包括0-9、*、#。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5', 'maxLength' => 1000000, 'minLength' => 0], ], ], 'responses' => [ @@ -51930,53 +25901,158 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => '842399EC-7D32-4472-AD08-9504C3F141FF'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CB72B537-B531-598F-9617-A636FB8040C0', + 'Data' => [ + 'description' => '数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'CallContext' => [ + 'description' => '话务上下文环境。'."\n", + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。'."\n", 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。'."\n", 'type' => 'string', 'example' => 'job-6573574060089****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。'."\n", 'type' => 'string', 'example' => '无'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'ANSWERED', + ], + 'Destination' => ['description' => '话务通道的被叫方。'."\n", 'type' => 'string', 'example' => '8001****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'MONITORING', + ], + 'SkillGroupId' => ['description' => '话务通道关联的技能组ID，呼入场景下，关联的技能组ID由IVR中转人工模块配置的技能组决定，呼出场景下，关联的技能组ID为座席签入的第一个技能组的ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609234222367'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6573574060089****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609234221870:job-6573574060089****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8001****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0101234****'], + ], + ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。'."\n", + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609234222375'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609234221864'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1390000****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6573574060089****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"CB72B537-B531-598F-9617-A636FB8040C0\\"\\n}","type":"json"}]', - 'title' => '撤销联系流编辑', - 'summary' => '撤销联系流编辑，丢弃对应草稿。', - ], - 'DeleteContactFlow' => [ - 'summary' => '删除指定联系流。', - 'methods' => [ - 'post', - 'get', + 'title' => '发送按键信息', + 'summary' => '调用SendDtmfSignaling在通话过程中发送DTMF按键信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendDtmfSignaling'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"842399EC-7D32-4472-AD08-9504C3F141FF\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609234222367,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609234221870:job-6573574060089****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"Originator\\": \\"0101234****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609234222375,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609234221864,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"842399EC-7D32-4472-AD08-9504C3F141FF\\n无\\n200\\n无\\n\\n \\n ccc-test\\n OUTBOUND\\n job-65735740600893440\\n \\n 8001****\\n ANSWERED\\n 无\\n OUTBOUND\\n 1\\n 无\\n skill-group@ccc-test\\n ch:user:131888****->8001****:1609234221870:job-65735740600893440\\"\\n 1609234222367\\n 无\\n 0101234****\\n []\\n user-test@ccc-test\\n 8001****\\n job-65735740600893440\\n \\n \\n \\n 8001****\\n TALKING\\n ccc-test\\n Warm-up\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bse05179638553000176add4046f\\n 1609234222375\\n false\\n 1390000****\\n job-65735740600893440\\n ON_SITE\\n 1609234221864\\n [\\"skill-group@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', + ], + 'SignInGroup' => [ + 'summary' => '调用SignInGroup使坐席签入指定实例下的指定技能组，即坐席上线操作。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -51988,43 +26064,41 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREcccD5GAHN', - ], + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'ContactFlowId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '联系流ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0f87c997-b0c1-41d4-9e9e-1b791de6ad1f', - ], + 'schema' => ['description' => '坐席ID，不填默认使用当前RAM账号映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'Force', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => '语音设备ID。当有多个语音设备可用时，通过此参数指定其中一个语音设备，比如浏览器WebRTC或者SIP话机等。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CCC-xx.xx.xx.xx-chrome119-bse1b618bff3xxxxd'], + ], + [ + 'name' => 'SignedSkillGroupIdList', + 'in' => 'query', + 'schema' => ['description' => '想要签入的技能组ID列表，格式为JSON数组字符串，数组元素是技能组ID。', 'type' => 'string', 'required' => true, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'], + ], + [ + 'name' => 'ChatDeviceId', + 'in' => 'query', + 'schema' => ['description' => 'Chat设备ID。', 'type' => 'string', 'required' => false, 'example' => '4c51c9116c36537cb850dc1081d745df'], + ], + [ + 'name' => 'Additivity', + 'in' => 'query', + 'schema' => ['description' => '座席已经签入一些技能组后，如果指定此参数为True, 则可以签入更多新技能组。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ @@ -52032,1420 +26106,1498 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '07511949-6DC4-5D0B-8FA8-FF8FA29B4217', + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'."\n"], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => '无'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'READY', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + 'ChatDeviceId' => ['description' => 'Chat设备ID。', 'type' => 'string', 'example' => '4c51c9116c36537cb850dc1081d745df'], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"07511949-6DC4-5D0B-8FA8-FF8FA29B4217\\"\\n}","type":"json"}]', - 'title' => '删除联系流', - ], - 'DeleteSchemaProperty' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '签入技能组', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SignInGroup'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\\\n\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ],\\n \\"ChatDeviceId\\": \\"4c51c9116c36537cb850dc1081d745df\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n 80326034\\n BREAK\\n ccc-test\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n ON_SITE\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n\\nOK","errorExample":""}]', + ], + 'SignOutGroup' => [ + 'summary' => '调用SignOutGroup使坐席签出当前签入的技能组，即坐席下线操作。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - ], - 'deprecated' => false, - 'parameters' => [ [ - 'name' => 'SchemaId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'schema id', - 'type' => 'string', - 'required' => true, - 'example' => 'profile', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], + 'parameters' => [ [ - 'name' => 'PropertyName', - 'in' => 'formData', - 'schema' => [ - 'description' => '字段名', - 'type' => 'string', - 'required' => true, - 'example' => 'name', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID', - 'type' => 'string', - 'required' => false, - 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', - ], + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => '坐席ID，不填默认使用当前RAM账号映射的坐席。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'DeleteSchemaPropertyResponse', - 'description' => 'DeleteSchemaPropertyResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '错误说明', - 'type' => 'string', - 'example' => 'User 244715989906081477 does not exist in instance worldfirst01.', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => '200'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Params' => [ - 'description' => '错误参数信息', + 'description' => '响应参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '错误参数', - 'type' => 'string', - 'example' => 'id格式错误', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'BREAK', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"User 244715989906081477 does not exist in instance worldfirst01.\\",\\n \\"Params\\": [\\n \\"id格式错误\\"\\n ]\\n}","type":"json"}]', - 'title' => '删除Scheme字段', - ], - 'DisableSchemaProperty' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '签出技能组', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SignOutGroup'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n BREAK\\n ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n false\\n 86-132xxxx4730\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n 80326034\\n user-test@ccc-test\\n 1609136956378\\n ON_SITE\\n job-65382141036853491\\n 1609136956378\\n\\n200","errorExample":""}]', + ], + 'StartBack2BackCall' => [ + 'summary' => '调用StartBack2BackCall发起双呼。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ - 'name' => 'SchemaId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'schema id', - 'type' => 'string', - 'required' => true, - 'example' => 'profile', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'PropertyName', - 'in' => 'formData', - 'schema' => [ - 'description' => '字段名', - 'type' => 'string', - 'required' => true, - 'example' => 'name', - ], + 'name' => 'Caller', + 'in' => 'query', + 'schema' => ['description' => '主叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1391814****'], ], [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID', - 'type' => 'string', - 'required' => false, - 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780', - ], + 'name' => 'Callee', + 'in' => 'query', + 'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1372168****'], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', - ], + 'name' => 'TimeoutSeconds', + 'in' => 'query', + 'schema' => ['description' => '双呼超时时间，呼叫在经过该参数指定的时间仍然未接通的情况下，则主动挂断，非必填，默认30，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '30'], + ], + [ + 'name' => 'Broker', + 'in' => 'query', + 'schema' => ['description' => '中间号码，需要是实例下可用的外呼号码，双呼时会使用该号码先后呼叫主叫和被叫。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0102157****'], + ], + [ + 'name' => 'AdditionalBroker', + 'in' => 'query', + 'schema' => ['description' => '附加中间号码，如果该参数存在，则呼叫主叫时使用中间号码，呼叫被叫时使用该参数指定的号码，非必填， 默认空。', 'type' => 'string', 'required' => false, 'example' => '0102156****'], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => ['description' => '随路数据，不能超过128字节，主要用于扩展需求，普通客户无需关心。', 'type' => 'string', 'required' => false, 'example' => '无'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'DisableSchemaPropertyResponse', - 'description' => 'DisableSchemaPropertyResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '附加信息', - 'type' => 'string', - 'example' => 'User 244715989906081477 does not exist in instance worldfirst01.', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94'], 'Params' => [ - 'description' => '参数信息。', + 'description' => '响应参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '[\'userId\']', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'BACK2BACK', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-1034159089076****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '无'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'NONE', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1372168****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => '无'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => 'COACHING', 'MONITORING' => 'MONITORING', 'MONITORED' => 'MONITORED', 'COACHED' => 'COACHED', 'HOLD' => 'HOLD', 'MUTED' => 'MUTED'], + 'example' => 'MONITORING', + ], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1618217874062'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => 'INBOUND', 'BARGE' => 'BARGE', 'CONSULTANT' => 'CONSULTANT', 'CONFERENCE' => 'CONFERENCE', 'MONITOR' => 'MONITOR', 'INTERNAL' => 'INTERNAL', 'OUTBOUND' => 'OUTBOUND', 'INTERCEPT' => 'INTERCEPT', 'BACK2BACK' => 'BACK2BACK', 'PREDICTIVE' => 'PREDICTIVE', + 'COACH' => 'COACH', + ], + 'example' => 'BACK2BACK', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-1034159089076****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****'], + 'Originator' => ['description' => '话务通道的主叫方', 'type' => 'string', 'example' => '0102157****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8001****'], + ], + ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8020****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1618217872911'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1618217794599'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'DeviceState' => [ + 'description' => '设备状态。', + 'type' => 'string', + 'enumValueTitles' => ['UNREGISTERED' => '未注册', 'ONLINE' => '在线', 'OFFLINE' => '离线'], + 'example' => '无', + ], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-1034159089076****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'OFFLINE', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], + ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的号码。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"User 244715989906081477 does not exist in instance worldfirst01.\\",\\n \\"Params\\": [\\n \\"[\'userId\']\\"\\n ]\\n}","type":"json"}]', - 'title' => '禁用Schema字段', - ], - 'EnableSchemaProperty' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '发起双呼', + 'description' => '双呼和传统的双方通话不同，主叫并不直接呼叫对方，而是通过一个背靠背代理（Back to Back Agent），背靠背代理首先呼叫主叫方，接通后，再呼叫被叫方，然后把二者拉进一个会场。在这种方式下，由于每个呼叫的所有消息流经背靠背代理，因此服务提供商可以据此提供增值服务，比如计时、录音、隐藏真实号码等等。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartBack2BackCall'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"BACK2BACK\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-1034159089076****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"1372168****\\",\\n \\"UserId\\": \\"无\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1618217874062,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"BACK2BACK\\",\\n \\"JobId\\": \\"job-1034159089076****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0102157****\\",\\n \\"UserExtension\\": \\"8001****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8020****\\",\\n \\"Heartbeat\\": 1618217872911,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1618217794599,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"无\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-1034159089076****\\",\\n \\"UserState\\": \\"OFFLINE\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\n无\\n200\\n无\\n\\n \\n ccc-test\\n BACK2BACK\\n job-103415908907622400\\n \\n 1014\\n NONE\\n 无\\n 无\\n 010xxxx2157\\n []\\n 无\\n 80011474\\n BACK2BACK\\n 无\\n ch:user:1318888888->80011474:1609225718294:job-65700074013925376\\n 1618217874062\\n job-103415908907622400\\n \\n \\n \\n OFFLINE\\n ccc-test\\n ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c\\n Warm-up\\n false\\n 无\\n 86-132xxxx4730\\n 80202301\\n 无\\n user-test@ccc-test\\n 1618217872911\\n ON_SITE\\n job-103415908907622400\\n 1618217794599\\n [\\"skg-default@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', + ], + 'StartChat' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'SchemaId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'schema id', - 'type' => 'string', - 'required' => true, - 'example' => 'profile', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ccc-test'], ], [ - 'name' => 'PropertyName', - 'in' => 'formData', + 'name' => 'UserList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '字段名', - 'type' => 'string', + 'description' => '聊天成员信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserId' => ['description' => '成员ID。', 'type' => 'string', 'required' => false, 'example' => 'fcd020fe-d8e4-40e5-8c77-1a272a174a7d'], + 'UserType' => ['description' => '成员类型。'."\n" + .'- AGENT : 坐席'."\n" + .'- CUSTOMER : 访客', 'type' => 'string', 'required' => false, 'example' => 'CUSTOMER'], + 'AvatarUrl' => ['description' => '成员头像链接。', 'type' => 'string', 'required' => false, 'example' => 'http://xxx.com/image'], + 'Nickname' => ['description' => '成员昵称。', 'type' => 'string', 'required' => false, 'example' => '访客-1a272a174a7d'], + ], + 'required' => false, + 'description' => '', + ], 'required' => true, - 'example' => 'name', ], ], [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID', - 'type' => 'string', - 'required' => false, - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], + 'name' => 'Token', + 'in' => 'query', + 'schema' => ['description' => '网络业务的渠道Token。', 'type' => 'string', 'required' => false, 'example' => '9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3bjEn0YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jg************Hwej7WgWrmA='], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'name' => 'AccessChannelId', + 'in' => 'query', + 'schema' => ['description' => '网络业务渠道ID。', 'type' => 'string', 'required' => false, 'example' => 'cf584733-***-***-9699-cb77aa3b7aa6'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'EnableSchemaPropertyResponse', - 'description' => 'EnableSchemaPropertyResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => 'The operation is not allowed. User state (READY) does not meet expectations (OFFLINE).', - ], - 'Params' => [ - 'description' => '响应参数。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '[\'wudi@zcwlwhkf\']', + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], + 'Data' => [ + 'description' => '响应数据。', + 'type' => 'object', + 'properties' => [ + 'ChatConversationId' => ['description' => '聊天会话ID。', 'type' => 'string', 'example' => '$23086709$EAUNIT'], + 'JobId' => ['description' => '话务ID。', 'type' => 'string', 'example' => 'chat-525523618219921408'], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], + ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid.', 'description' => ''], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + 409 => [ + ['errorCode' => 'AlreadyExists.SkillGroup', 'errorMessage' => 'The skill group %s already exists in instance %s.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"The operation is not allowed. User state (READY) does not meet expectations (OFFLINE).\\",\\n \\"Params\\": [\\n \\"[\'wudi@zcwlwhkf\']\\"\\n ]\\n}","type":"json"}]', - 'title' => '启用Schema字段', - ], - 'GetSchema' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"ChatConversationId\\": \\"$23086709$EAUNIT\\",\\n \\"JobId\\": \\"chat-525523618219921408\\"\\n }\\n}","type":"json"}]', + 'title' => '发起聊天', + 'summary' => '调用StartChat发起聊天。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'StartConference' => [ + 'summary' => '调用StartConference发起一个会议。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ - 'name' => 'SchemaId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'schema id', - 'type' => 'string', - 'required' => true, - 'example' => 'profile', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'required' => false, - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => '发起会议的坐席ID，非必填，不填则默认使用当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx', - ], + 'name' => 'ParticipantListJson', + 'in' => 'query', + 'schema' => ['description' => '参会方列表，格式为JSON数组的字符串，数组元素是参会方，如果是内呼坐席，参会方是目标的坐席分机号，如果是外呼客户，参会方是客户号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["8045****","1317511****"]'], + ], + [ + 'name' => 'TimeoutSeconds', + 'in' => 'query', + 'schema' => ['description' => '超时时间，呼叫在经过该参数指定的时间仍然未接通的情况下，则主动挂断，非必填，默认30，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '30'], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => ['description' => '随路数据，不能超过128字节，主要用于扩展需求，普通客户无需关心。', 'type' => 'string', 'required' => false, 'example' => '无'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'GetSchemaResponse', - 'description' => 'GetSchemaResponse', 'type' => 'object', 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FDD327D1-AB8A-596B-883F-F63582A73F1D'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => '5e0964fd-951c-4e45-b518-d09d4d2db8ca', - ], - 'Id' => [ - 'description' => 'schema id', - 'type' => 'string', - 'example' => 'profile', - ], - 'Description' => [ - 'description' => '描述', - 'type' => 'string', - 'example' => '客户profile', - ], - 'Properties' => [ - 'description' => '字段列表', + 'CallContext' => [ + 'description' => '话务上下文环境。'."\n", 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'type' => 'string', - 'description' => '显示名称', - 'example' => '姓名', - ], - 'Description' => [ - 'type' => 'string', - 'description' => '描述', - 'example' => 'name', - ], - 'Name' => [ - 'type' => 'string', - 'description' => '名称', - 'example' => 'name', - ], - 'DataType' => [ - 'type' => 'string', - 'example' => 'string', - 'description' => '数据类型', - ], - 'Pattern' => [ - 'type' => 'string', - 'example' => '^', - 'description' => '正则表达式校验规则', - ], - 'PatternErrorMessage' => [ - 'type' => 'string', - 'example' => '不是有效的email地址', - 'description' => '正则表达式校验错误提示信息', - ], - 'MinLength' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '最小长度', - 'example' => '1', - ], - 'MaxLength' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '最大长度', - 'example' => '10', - ], - 'Minimum' => [ - 'type' => 'number', - 'format' => 'double', - 'description' => '数字最小值', - 'example' => '1', - ], - 'Maximum' => [ - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - 'description' => '数字最大值', - ], - 'Required' => [ - 'type' => 'boolean', - 'description' => '是否必填', - 'example' => 'false', - ], - 'System' => [ - 'type' => 'boolean', - 'example' => 'false', - 'description' => '是否是系统字段', - ], - 'Disabled' => [ - 'type' => 'boolean', - 'description' => '是否被禁用', - 'example' => 'false', - ], - 'Array' => [ - 'type' => 'boolean', - 'description' => '是否是数组', - 'example' => 'false', - ], - 'ReadOnly' => [ - 'type' => 'boolean', - 'description' => '是否只读', - 'example' => 'false', - ], - 'EditorType' => [ - 'type' => 'string', - 'description' => '编辑器类型', - 'example' => 'textbox', - ], - 'Attributes' => [ - 'type' => 'string', - 'description' => '扩展属性', - 'example' => '{}', - ], - 'DisplayOrder' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '列表展示顺序', - 'example' => '1', - ], - 'CreatedTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '创建时间', - 'example' => '2021-07-14 10:48:43.0', - ], - 'UpdatedTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2021-07-14 10:48:43.0', - 'description' => '更新时间', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', ], - 'Creator' => [ - 'type' => 'string', - 'description' => '创建者', - 'example' => 'tom', + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。'."\n", 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'ANSWERED', + ], + 'Destination' => ['description' => '话务通道的被叫方。'."\n" + ."\n", 'type' => 'string', 'example' => '8001****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'."\n"], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'MONITORING', + ], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6573574060089****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609225718294:job-65700074013925376'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'."\n"], + ], ], ], - 'description' => '字段', ], ], - 'CreatedTime' => [ - 'description' => '创建时间。'."\n", - 'type' => 'string', - 'example' => '2021-07-14 10:48:43.0', - ], - 'UpdatedTime' => [ - 'description' => '上次修改的时间。', - 'type' => 'string', - 'example' => '2021-07-14 10:48:43.0', - ], - 'Deleted' => [ - 'description' => '是否被删除', - 'type' => 'boolean', - 'example' => 'false', + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up'."\n", + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => '1609136956378'."\n"], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'DeviceState' => [ + 'description' => '设备状态。', + 'type' => 'string', + 'enumValueTitles' => ['UNREGISTERED' => '未注册', 'ONLINE' => '在线', 'OFFLINE' => '离线'], + 'example' => 'false', + ], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], ], ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '19D09CCC-F298-4124-849A-AFA217819011', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => 'Service abnormal, the instance 0418 is ceased.', - ], - 'Params' => [ - 'description' => '响应参数。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的号码。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"5e0964fd-951c-4e45-b518-d09d4d2db8ca\\",\\n \\"Id\\": \\"profile\\",\\n \\"Description\\": \\"客户profile\\",\\n \\"Properties\\": {\\n \\"key\\": {\\n \\"DisplayName\\": \\"姓名\\",\\n \\"Description\\": \\"name\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 10,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 0,\\n \\"UpdatedTime\\": 0,\\n \\"Creator\\": \\"tom\\"\\n }\\n },\\n \\"CreatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"UpdatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"Deleted\\": false\\n },\\n \\"RequestId\\": \\"19D09CCC-F298-4124-849A-AFA217819011\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Service abnormal, the instance 0418 is ceased.\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取Schema', - ], - 'DeleteSchema' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '发起会议', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartConference'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"FDD327D1-AB8A-596B-883F-F63582A73F1D\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\\\n\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-65700074013925376\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8032****\\\\n\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\\\n\\",\\n \\"InstanceId\\": \\"1609136956378\\\\n\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"false\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'StartEditContactFlow' => [ + 'summary' => '发起编辑联系流，生成联系流草稿。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - ], - 'deprecated' => false, - 'parameters' => [ - [ - 'name' => 'SchemaId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'schema id', - 'type' => 'string', - 'required' => true, - 'example' => 'profile', - ], - ], - [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'required' => false, - 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3', - ], - ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], + ], + 'parameters' => [ [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'ContactFlowId', + 'in' => 'query', + 'schema' => ['description' => '联系流ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '798e83a9-5140-4039-afa1-761ca4cca2df'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'DeleteSchemaResponse', - 'description' => 'DeleteSchemaResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '响应参数。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '数据，联系流草稿ID。', 'type' => 'string', 'example' => 'b3114362-9062-46c7-82dc-ae55ac168b2e'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BC2733CE-C470-564A-8C11-9DC02468823A'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"678F7002-CA01-4ABF-A112-585AFBDF3A3B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '删除Schema', - ], - 'GetDocumentUploadParameters' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '创建联系流草稿', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartEditContactFlow'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"b3114362-9062-46c7-82dc-ae55ac168b2e\\",\\n \\"RequestId\\": \\"BC2733CE-C470-564A-8C11-9DC02468823A\\"\\n}","type":"json"}]', + ], + 'StartPredictiveCall' => [ + 'summary' => '调用StartPredictiveCall发起预测式外呼。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], + ], 'parameters' => [ [ - 'name' => 'FileName', - 'in' => 'formData', - 'schema' => [ - 'description' => '文件名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'blacklist.xlsx', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'required' => false, - 'example' => '24BE19E8-BF7D-4992-A35E-15EBA874F2E5', - ], + 'name' => 'Caller', + 'in' => 'query', + 'schema' => ['description' => '主叫号码，需要是实例下可用的外呼号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0109810****'], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'name' => 'Callee', + 'in' => 'query', + 'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312353****'], + ], + [ + 'name' => 'TimeoutSeconds', + 'in' => 'query', + 'schema' => ['description' => '超时时间，呼叫在经过该参数指定的时间仍然未接通的情况下，则主动挂断，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '10'], + ], + [ + 'name' => 'ContactFlowId', + 'in' => 'query', + 'schema' => ['description' => 'IVR联系流ID，被叫接通后，通话将自动转入此IVR流程。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9774c36c-12fe-4e37-adce-89bc77ce****'], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => ['description' => '随路数据，主要用于扩展需求，普通用户无需关心。', 'type' => 'string', 'required' => false, 'example' => '无'], + ], + [ + 'name' => 'ContactFlowVariables', + 'in' => 'query', + 'schema' => ['description' => '传入的联系流变量，格式为JSON数组的字符串，数组元素是一个键值对，Key为变量名，Value为变量值。在联系流ID对应的IVR的开始节点中新建同名的自定义参数，即可在IVR流程中使用该参数。', 'type' => 'string', 'required' => false, 'example' => '{"name":"王先生","time":"19点20分","address":"某某中心"}'], + ], + [ + 'name' => 'MaskedCallee', + 'in' => 'query', + 'schema' => ['description' => '脱敏后的被叫号码，如果该字段不为空，表示需要对被叫号码脱敏，脱敏规则由客户自行定义，只需将脱敏后的被叫号码填入即可，使用脱敏被叫会导致某些场景下看到的是脱敏后的被叫号码，无法查看真实被叫号码。', 'type' => 'string', 'required' => false, 'example' => '1312353****'], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'query', + 'schema' => ['description' => '技能组ID，非必填，如果该参数有值，则外呼号码仅从该参数指定的技能组的关联号码中选取。', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'GetTempAttachmentUploadUrlResponse', - 'description' => 'GetTempAttachmentUploadUrlResponse', 'type' => 'object', 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94'], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], 'Data' => [ 'description' => '数据。', 'type' => 'object', 'properties' => [ - 'AccessKeyId' => [ - 'title' => '签名使用的accessKeyId', - 'description' => '签名使用的accessKeyId', - 'type' => 'string', - 'example' => '****', - ], - 'Policy' => [ - 'title' => '签名策略', - 'description' => '签名策略', - 'type' => 'string', - 'example' => 'Permit', - ], - 'Signature' => [ - 'title' => '签名', - 'description' => '签名', - 'type' => 'string', - 'example' => 'zi31STIMtIfa/UN2l+6lww****', - ], - 'FilePath' => [ - 'title' => 'oss文件路径', - 'description' => 'oss文件路径', - 'type' => 'string', - 'example' => 'ccc-test/blacklist.xlsx', - ], - 'Host' => [ - 'title' => 'oss host', - 'description' => 'oss host', - 'type' => 'string', - 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com', + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6570007401392****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '无'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'NONE', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '8001****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => '[]', + ], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609225718295'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '无'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6570007401392****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609225718294:job-6570007401392****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8001****'], + ], + ], + ], + ], ], - 'ExpireTime' => [ - 'title' => '到期时间', - 'description' => '到期时间', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1647313420', + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'DeviceState' => [ + 'description' => '设备状态。', + 'type' => 'string', + 'enumValueTitles' => ['UNREGISTERED' => '未注册', 'ONLINE' => '在线', 'OFFLINE' => '离线'], + 'example' => 'ONLINE', + ], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6570007401392****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'READY', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], ], ], ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '响应参数。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的号码。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"AccessKeyId\\": \\"****\\",\\n \\"Policy\\": \\"Permit\\",\\n \\"Signature\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"FilePath\\": \\"ccc-test/blacklist.xlsx\\",\\n \\"Host\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com\\",\\n \\"ExpireTime\\": 1647313420\\n },\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取导入Document上传地址', - ], - 'UpdateSchemaProperty' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '发起预测式外呼', + 'description' => '云呼叫中心除了支持客服从坐席工作台发起外呼外，还支持从自有业务系统后台发起外呼，待接通后转给坐席。以支持把云呼叫中心功能无缝嵌入您的业务流程。'."\n" + .'比如，您的客户可以在您的微信公众号上，输入自己的号码，并点击咨询产品的按钮，由您的后台系统调用本接口，实现呼叫客户手机，接通后播放“我们收到您在公众号上对我们产品的咨询，现在给您转接顾问，请稍等”，并转给合适的客服接听通话。'."\n" + .'相较于1.0的DialEX接口，用户使用该接口可以更加灵活的进行配置。除了可以自定义外呼转入的IVR外，还可以传入自定义的参数，在IVR中对参数进行语音播报，实现通知的场景。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-11-29T08:23:20.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-11-29T08:23:20.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-08-20T10:36:28.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPredictiveCall'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"[]\\",\\n \\"Timestamp\\": 1609225718295,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-6570007401392****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8001****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"ONLINE\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\n无\\n200\\n无\\n\\n \\n ccc-test\\n OUTBOUND\\n job-65700074013925376\\n \\n 8001****\\n NONE\\n 无\\n 1318888****\\n []\\n 无\\n user-test@ccc-test\\n 8001****\\n OUTBOUND\\n 无\\n ch:user:131888****->8001****:1609225718294:job-65700074013925376\\n 1609225718295\\n job-65700074013925376\\n \\n \\n \\n 8001****\\n 无\\n READY\\n ccc-test\\n Warm-up\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c\\n 1609136956378\\n false\\n 86-1324730****\\n job-65700074013925376\\n ON_SITE\\n 1609136956378\\n [\\"skill-group@ccc-test\\"]\\n \\n\\nOK","errorExample":""}]', + ], + 'StartPrivacyCall' => [ + 'summary' => '发起隐私呼叫。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SchemaId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'schema id', - 'type' => 'string', - 'required' => true, - 'example' => 'profile', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '云联络中心实例ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Property', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '字段', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '显示名称', - 'type' => 'string', - 'required' => false, - 'example' => '姓名', - ], - 'Description' => [ - 'description' => '描述。', - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], - 'Name' => [ - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => 'name', - ], - 'DataType' => [ - 'description' => '数据类型', - 'type' => 'string', - 'required' => true, - 'example' => 'string', - ], - 'Pattern' => [ - 'description' => '正则表达式校验规则', - 'type' => 'string', - 'required' => false, - 'example' => '(.*)', - ], - 'PatternErrorMessage' => [ - 'description' => '正则表达式校验错误提示信息', - 'type' => 'string', - 'required' => false, - 'example' => '不是有效的email地址', - ], - 'MinLength' => [ - 'description' => '最小长度', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'MaxLength' => [ - 'description' => '最大长度', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - 'Minimum' => [ - 'description' => '数字最小值', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '10800', - ], - 'Maximum' => [ - 'description' => '数字最大值', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '11', - ], - 'Required' => [ - 'description' => '是否必填', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'Disabled' => [ - 'description' => '是否被禁用', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'Array' => [ - 'description' => '是否是数组', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'ReadOnly' => [ - 'description' => '是否只读', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'EditorType' => [ - 'description' => '编辑器类型', - 'type' => 'string', - 'required' => false, - 'example' => 'textbox', - ], - 'Attributes' => [ - 'description' => '扩展属性', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"instanceId\\":\\"4cc3f160-ca64-49ff-bc70-390a044a4e83\\",\\"appId\\":\\"1684145288664\\",\\"commodityCode\\":\\"dide_pre\\",\\"dide_pre_set\\":\\"version_ent\\"}', - ], - 'DisplayOrder' => [ - 'description' => '列表展示顺序', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => false, - ], + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'example' => 'ALIPUBB7A727C170949'], ], [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID', - 'type' => 'string', - 'required' => false, - 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E', - ], + 'name' => 'Caller', + 'in' => 'query', + 'schema' => ['description' => '主叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0109810****'], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例 ID', - 'type' => 'string', - 'required' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx', - ], + 'name' => 'Callee', + 'in' => 'query', + 'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1888888****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'UpdateSchemaPropertyResponse', - 'description' => 'UpdateSchemaPropertyResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A450574A-337F-43E2-BC59-9C6594C994C6', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码'."\n" - ."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3'], 'Params' => [ - 'description' => '响应参数。', + 'description' => '参数信息。', 'type' => 'array', - 'items' => [ - 'description' => '参数信息。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['type' => 'string', 'description' => ''], ], + 'Data' => ['description' => '返回结果，通话ID。', 'type' => 'string', 'example' => 'job-xxx'], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的号码。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A450574A-337F-43E2-BC59-9C6594C994C6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '更新Schema字段', - ], - 'SaveDocument' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0630E5DF-CEB0-445B-8626-D5C7481181C3\\",\\n \\"Params\\": [\\n \\"\\"\\n ],\\n \\"Data\\": \\"job-xxx\\"\\n}","type":"json"}]', + 'title' => '发起隐私呼叫', + 'changeSet' => [ + ['createdAt' => '2022-09-07T01:59:54.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPrivacyCall'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'SubmitCampaign' => [ + 'summary' => '调用SubmitCampaign启动指定实例下指定ID对应的预测式外呼活动。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'write', 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], + ], 'parameters' => [ [ - 'name' => 'SchemaId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'schema id', - 'type' => 'string', - 'required' => true, - 'example' => 'profile', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'DocumentId', - 'in' => 'formData', + 'name' => 'CampaignId', + 'in' => 'query', + 'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '文档ID', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315'], + 'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'string', 'example' => '200'], + ], ], ], + ], + 'title' => '启动预测式外呼活动', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCampaign'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\n OK\\n 无\\n 200\\n","errorExample":""}]', + ], + 'SwitchToConference' => [ + 'summary' => '调用SwitchToConference将指定实例下的指定通话的状态切换至三方会议，通常用于咨询转会议的场景。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DocumentJson', - 'in' => 'formData', - 'schema' => [ - 'description' => '要保存的文档内容，需要符合Schema定义的规则', - 'type' => 'string', - 'required' => true, - 'example' => '{"name":"tom"}', - ], + 'AK' => [], ], [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID', - 'type' => 'string', - 'required' => false, - 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], + 'parameters' => [ [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => '坐席ID，不填默认使用当前RAM账号映射的坐席。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => '无效字段，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-24114064019637****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'SaveDocumentResponse', - 'description' => 'SaveDocumentResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'string', - 'example' => '0101234****', - ], - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9C96A73-09C9-5E2A-8CDB-85EC0BC246DA'], 'Params' => [ - 'description' => '响应参数。', + 'description' => '响应参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'NONE', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '8001****'], + 'SkillGroupId' => ['description' => '该通话相关技能组。呼入场景下，技能组由IVR中路由的排队队列指定。在呼出场景下，技能组是座席签入的第一个技能组。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'MONITORING', + ], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609255716900'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609225718294:job-6538214103685****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '1318888****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + ], + ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => 'agent@ccc-test'], + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8032****'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => '1609136956378'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'DeviceState' => [ + 'description' => '设备状态。', + 'type' => 'string', + 'enumValueTitles' => ['UNREGISTERED' => '未注册', 'ONLINE' => '在线', 'OFFLINE' => '离线'], + 'example' => 'false', + ], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'."\n"], + ], + ], + ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"0101234****\\",\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '保存Document', - ], - 'DeleteDocuments' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '转会议', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:44.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchToConference'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"D9C96A73-09C9-5E2A-8CDB-85EC0BC246DA\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609255716900,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-6538214103685****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Heartbeat\\": 0,\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"1609136956378\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"false\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\\\n\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'TakeBreak' => [ + 'summary' => '调用TakeBreak将指定实例下的指定坐席设置为小休状态。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], 'parameters' => [ [ - 'name' => 'SchemaId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'schema id', - 'type' => 'string', - 'required' => true, - 'example' => 'profile', - ], - ], - [ - 'name' => 'DocumentIds', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '文档id列表', - 'type' => 'array', - 'items' => [ - 'description' => '文档id', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'required' => false, - 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3', - ], + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => '坐席ID，不填默认使用当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], + ], + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => ['description' => '小休状态码，客户可以自定义任何小休状态。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'lunchtime'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'DeleteDocumentsResponse', - 'description' => 'DeleteDocumentsResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A450574A-337F-43E2-BC59-9C6594C994C6', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + 'Code' => ['description' => '响应码。'."\n", 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。'."\n", 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。'."\n", 'type' => 'string', 'example' => 'B59382D2-5755-4C6D-861F-FA2AAD8F89F7'], 'Params' => [ - 'description' => '参数信息。', + 'description' => '响应参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], + 'Data' => [ + 'description' => '数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => '坐席分机号。', 'type' => 'string', 'example' => '8001****'], + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609249563836'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'Reserved' => ['description' => '坐席最近一次被预定的时间，被预定意味着马上将有来电分配给该坐席，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609234221864'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '席上线后置闲前的临时小休状态'], + 'example' => 'lunchtime', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1390000****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => '无'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'BREAK', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A450574A-337F-43E2-BC59-9C6594C994C6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '删除文档（批量）', - ], - 'DeleteDocument' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '小休', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:44.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TakeBreak'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B59382D2-5755-4C6D-861F-FA2AAD8F89F7\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609249563836,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609234221864,\\n \\"BreakCode\\": \\"lunchtime\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"B59382D2-5755-4C6D-861F-FA2AAD8F89F7\\n无\\n200\\n无\\n\\n 8001****\\n BREAK\\n ccc-test\\n default\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-bs3b5f22c6d78f000176aebe9471\\n 1609249563836\\n false\\n 1390000****\\n 无\\n ON_SITE\\n 1609234221864\\n [\\"skill-group@ccc-test\\"]\\n\\nOK","errorExample":""}]', + ], + 'TerminateTicket' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'SchemaId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'schema id', - 'type' => 'string', - 'required' => true, - 'example' => 'profile', - ], - ], - [ - 'name' => 'DocumentId', - 'in' => 'formData', - 'schema' => [ - 'description' => '文档ID', - 'type' => 'string', - 'required' => true, - 'example' => 'xxx', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', - ], + 'name' => 'TicketId', + 'in' => 'query', + 'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => false, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID', - 'type' => 'string', - 'required' => true, - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012****', - ], + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => '处理意见。', 'type' => 'string', 'required' => false, 'example' => '关单'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'DeleteDocumentResponse', - 'description' => 'DeleteDocumentResponse', + 'title' => 'CloseTicketResponse', + 'description' => 'CloseTicketResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8707EB29-BAED-4302-B999-40BA61877437', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息'."\n" - ."\n", - 'type' => 'string', - 'example' => '无', - ], + 'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Params' => [ - 'description' => '响应参数。', + 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -53453,345 +27605,72 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '删除文档', - ], - 'ListDocuments' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '关闭工单', + 'summary' => '使用TerminateTicket关闭工单。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'TransferTicketTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'SchemaId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'schema id', - 'type' => 'string', - 'required' => true, - 'example' => 'profile', - ], - ], - [ - 'name' => 'SearchPattern', - 'in' => 'formData', - 'schema' => [ - 'description' => '搜索条件表达式', - 'type' => 'string', - 'required' => false, - 'example' => '支持Lucene搜索语法', - ], - ], - [ - 'name' => 'Sorts', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '自定义排序值', - 'type' => 'array', - 'items' => [ - 'description' => '自定义排序值', - 'type' => 'object', - 'properties' => [ - 'PropertyName' => [ - 'description' => '字段名', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'Order' => [ - 'description' => '排序顺序。取值：'."\n" - ."\n" - .'- ASC（默认值）：升序。'."\n" - .'- DESC：降序。', - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'NextPageToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '下一个分页token', - 'type' => 'string', - 'required' => false, - 'example' => 'eyJ0YWJsZUlkIjoiY2Y2MTQxYjA5NDY0NDUxMzk5YjFjMTA5YTMxZWNkMzEiLCJ0b2tlbiI6IjAwMDAwMDAwMDAwNzAzNzcifQ==', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => '分页大小', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID', - 'type' => 'string', - 'required' => false, - 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'ListDocumentsResponse', - 'description' => 'ListDocumentsResponse', - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'Schema' => [ - 'description' => 'scheme', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => '87b12784-8ce2-40b6-b21f-c49cb3b5501e', - ], - 'Id' => [ - 'description' => 'schame id', - 'type' => 'string', - 'example' => 'profile', - ], - 'Description' => [ - 'description' => '描述信息', - 'type' => 'string', - 'example' => '-', - ], - 'Properties' => [ - 'description' => '字段列表', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'type' => 'string', - 'description' => '字段名称', - 'example' => 'name', - ], - 'Description' => [ - 'type' => 'string', - 'example' => '-', - 'description' => '描述', - ], - 'Name' => [ - 'type' => 'string', - 'description' => '名称', - 'example' => 'name', - ], - 'DataType' => [ - 'type' => 'string', - 'example' => 'string', - 'description' => '数据类型', - ], - 'Pattern' => [ - 'type' => 'string', - 'example' => '*', - 'description' => '正则表达式', - ], - 'PatternErrorMessage' => [ - 'type' => 'string', - 'example' => '格式错误', - 'description' => '正则表达式错误提示', - ], - 'MinLength' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '最小长度', - 'example' => '1', - ], - 'MaxLength' => [ - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'description' => '最大长度', - ], - 'Minimum' => [ - 'type' => 'number', - 'format' => 'double', - 'description' => '最小值', - 'example' => '1', - ], - 'Maximum' => [ - 'type' => 'number', - 'format' => 'double', - 'description' => '最大值', - 'example' => '1', - ], - 'Required' => [ - 'type' => 'boolean', - 'description' => '是否必填', - 'example' => 'false', - ], - 'System' => [ - 'type' => 'boolean', - 'example' => 'false', - 'description' => '是否系统字段', - ], - 'Disabled' => [ - 'type' => 'boolean', - 'example' => 'false', - 'description' => '是否禁用', - ], - 'Array' => [ - 'type' => 'boolean', - 'description' => '是否是数组', - 'example' => 'false', - ], - 'ReadOnly' => [ - 'type' => 'boolean', - 'description' => '是否只读', - 'example' => 'false', - ], - 'EditorType' => [ - 'type' => 'string', - 'example' => 'textbox', - 'description' => '编辑器类型', - ], - 'Attributes' => [ - 'type' => 'string', - 'description' => '扩展属性', - 'example' => '{}', - ], - 'DisplayOrder' => [ - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'description' => '显示顺序', - ], - 'CreatedTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2020-10-14T09:53:53Z', - 'description' => '创建时间', - ], - 'UpdatedTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2020-10-14T09:53:53Z', - 'description' => '更新时间', - ], - 'Creator' => [ - 'type' => 'string', - 'description' => '创建者', - 'example' => 'tom', - ], - ], - 'description' => '字段', - ], - ], - 'CreatedTime' => [ - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2020-10-14T09:53:53Z', - ], - 'UpdatedTime' => [ - 'description' => '更新时间', - 'type' => 'string', - 'example' => '2020-10-14T09:53:53Z'."\n", - ], - 'Deleted' => [ - 'description' => '是否被删除', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - 'Documents' => [ - 'description' => '文档列表', - 'type' => 'array', - 'items' => [ - 'description' => '文档内容', - 'type' => 'object', - 'example' => '{}', - ], - ], - 'TotalCount' => [ - 'description' => '总条目数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'NextPageToken' => [ - 'description' => '下一页标识。', - 'type' => 'string', - 'example' => '54d1a616d95a4a01ba58967a9115b649', - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], + 'name' => 'TicketId', + 'in' => 'query', + 'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => false, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => '节点ID。', 'type' => 'string', 'required' => false, 'example' => 'f780ade8-3ca9-458b-b067-63077946a570'], + ], + [ + 'name' => 'Assignee', + 'in' => 'query', + 'schema' => ['description' => '处理人ID。', 'type' => 'string', 'required' => true, 'example' => 'assignee@ccc-test'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => '处理意见。', 'type' => 'string', 'required' => false, 'example' => '请assignee处理'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'TransferTicketTaskResponse', + 'description' => 'TransferTicketTaskResponse', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Params' => [ - 'description' => '响应参数。', + 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -53799,568 +27678,338 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Schema\\": {\\n \\"InstanceId\\": \\"87b12784-8ce2-40b6-b21f-c49cb3b5501e\\",\\n \\"Id\\": \\"profile\\",\\n \\"Description\\": \\"-\\",\\n \\"Properties\\": {\\n \\"key\\": {\\n \\"DisplayName\\": \\"name\\",\\n \\"Description\\": \\"-\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"*\\",\\n \\"PatternErrorMessage\\": \\"格式错误\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 1,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 1,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 0,\\n \\"UpdatedTime\\": 0,\\n \\"Creator\\": \\"tom\\"\\n }\\n },\\n \\"CreatedTime\\": \\"2020-10-14T09:53:53Z\\",\\n \\"UpdatedTime\\": \\"2020-10-14T09:53:53Z\\\\n\\",\\n \\"Deleted\\": false\\n },\\n \\"Documents\\": [\\n {}\\n ],\\n \\"TotalCount\\": 1,\\n \\"NextPageToken\\": \\"54d1a616d95a4a01ba58967a9115b649\\"\\n },\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取文档列表', - ], - 'ImportDocuments' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"678F7002-CA01-4ABF-A112-585AFBDF3A3B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '工单指派', + 'summary' => '使用TransferTicketTask指派工单给其他处理人处理。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'UnmuteCall' => [ + 'summary' => '调用UnmuteCall取消通话静音。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ - 'name' => 'SchemaId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'schema id', - 'type' => 'string', - 'required' => true, - 'example' => 'profile', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'OssFileKey', - 'in' => 'formData', - 'schema' => [ - 'description' => 'OSS文件的Key', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test/test-file.wav', - ], + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => '需要取消静音的坐席ID，不填默认使用当前RAM账户映射的坐席。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'required' => false, - 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', - ], + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => '设备ID，无意义，可以随便填写。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device'], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => '通话ID。', 'type' => 'string', 'required' => false, 'example' => 'job-6538214103685****'."\n"], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => ['description' => '待取消静音的话务通道ID，非必填，默认为空，为空表示取消静音UserId对应的坐席的话务通道。', 'type' => 'string', 'required' => false, 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ImportDocumentsResponse', - 'description' => 'ImportDocumentsResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'Params' => [ - 'description' => '响应参数。', + 'description' => '响应参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + ], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'CallContext' => [ + 'description' => '话务上下文环境。', + 'type' => 'object', + 'properties' => [ + 'CallType' => [ + 'description' => '通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelContexts' => [ + 'description' => '话务通道列表。', + 'type' => 'array', + 'items' => [ + 'description' => '话务通道。', + 'type' => 'object', + 'properties' => [ + 'Index' => ['description' => '系统自增ID，客户无需关心。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ReleaseInitiator' => ['description' => '话务通道的挂断方，表示该话务通道是谁首先发起的挂断。', 'type' => 'string', 'example' => '1390501****'], + 'ChannelState' => [ + 'description' => '话务通道的状态。', + 'type' => 'string', + 'enumValueTitles' => ['CREATED' => '已创建', 'ANSWERED' => '已接通', 'RELEASED' => '已挂断', 'RETIRED' => '已失效', 'EARLY_MEDIA' => '早媒体阶段', 'NONE' => '初始状态', 'RINGING' => '振铃中'], + 'example' => 'CREATED', + ], + 'Destination' => ['description' => '话务通道的被叫方。', 'type' => 'string', 'example' => '1390501****'], + 'UserId' => ['description' => '话务通道关联的坐席ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'ChannelFlags' => [ + 'description' => '话务通道标志。', + 'type' => 'string', + 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], + 'example' => 'MONITORING', + ], + 'SkillGroupId' => ['description' => '该通话相关技能组。呼入场景下，技能组由IVR中路由的排队队列指定。在呼出场景下，技能组是座席签入的第一个技能组。', 'type' => 'string', 'example' => 'skillgroup@ccc-test'], + 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315'], + 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自SIP协议中定义的响应码，请客户参考SIP协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination'], + 'CallType' => [ + 'description' => '话务通道的通话类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => '咨询', 'CONFERENCE' => '会议', 'MONITOR' => '监听', 'INTERNAL' => '内部通话', 'OUTBOUND' => '呼出', 'INTERCEPT' => '强拆', 'BACK2BACK' => '双呼', 'PREDICTIVE' => '预测式外呼', + 'COACH' => '辅导', + ], + 'example' => 'OUTBOUND', + ], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'ChannelId' => ['description' => '话务通道ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****'], + 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****'], + 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****'], + ], + ], + ], + ], + ], + 'UserContext' => [ + 'description' => '坐席上下文环境。', + 'type' => 'object', + 'properties' => [ + 'Heartbeat' => ['description' => '上次收到坐席心跳的时间，格式为Unix时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378'], + 'Extension' => ['description' => '座席分机号。', 'type' => 'string', 'example' => '8032****'], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'enumValueTitles' => ['ON_SITE' => '场内模式', 'OFF_SITE' => '场外模式', 'OFFICE_PHONE' => '办公电话模式'], + 'example' => 'ON_SITE', + ], + 'Mobile' => ['description' => '坐席的个人电话号码。', 'type' => 'string', 'example' => '1324730****'], + 'DeviceId' => ['description' => '设备ID，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'], + 'JobId' => ['description' => '通话ID。', 'type' => 'string', 'example' => 'job-6538214103685****'], + 'UserId' => ['description' => '坐席ID。', 'type' => 'string', 'example' => 'agent@ccc-test'], + 'BreakCode' => [ + 'description' => '小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。', + 'type' => 'string', + 'enumValueTitles' => ['RingingTimeout' => '坐席振铃超时导致的小休', 'RejectCall' => '坐席拒接导致的小休', 'Warm-up' => '坐席上线后置闲前的临时小休状态'], + 'example' => 'Warm-up', + ], + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'OutboundScenario' => ['description' => '坐席是否处于仅外呼模式。', 'type' => 'boolean', 'example' => 'false'], + 'UserState' => [ + 'description' => '座席状态。', + 'type' => 'string', + 'enumValueTitles' => ['READY' => '空闲', 'WORKING' => '话后处理中', 'DIALING' => '拨号中', 'BREAK' => '小休', 'OFFLINE' => '离线', 'TALKING' => '通话中', 'RINGING' => '振铃中'], + 'example' => 'TALKING', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => ['description' => '技能组ID。', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'], + ], + ], + ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => '该参数不能为null或含有空白符的字符串。'], + ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], + ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => '非法操作，用户状态不符合预期。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => '通话中不存在指定的Channel信息。'], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => '指定的通话信息不存在。'], + ], + 500 => [ + ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => '内部CTI服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '导入文档', - ], - 'CreateSchema' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '取消通话静音', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-26T08:13:44.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnmuteCall'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-6538214103685****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Heartbeat\\": 1609136956378,\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\n\\n \\n 80326034\\n BREAK\\n ccc-test\\n user-test@ccc-test\\n ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90\\n Warm-up\\n 1609136956378\\n false\\n 86-132xxxx4730\\n ON_SITE\\n job-65382141036853491\\n [\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]\\n \\n \\n ccc-test\\n OUTBOUND\\n job-65382141036853491\\n \\n 139xxxx0501\\n CREATED\\n 139xxxx0501\\n OUTBOUND\\n 1\\n skg-default@ccc-test\\n \\n ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491\\n 1609138903315\\n 404 - No destination\\n 083xxxx0019\\n MONITORING\\n user-test@ccc-test\\n 80326034\\n job-65382141036853491\\n \\n \\n\\nOK","errorExample":""}]', + ], + 'UnregisterDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], + ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'schema id', - 'type' => 'string', - 'required' => false, - 'example' => 'profile', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => '信息描述', - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], - ], - [ - 'name' => 'Properties', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '字段列表', - 'type' => 'array', - 'items' => [ - 'description' => '字段列表', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '坐席展示名。', - 'type' => 'string', - 'required' => false, - 'example' => '显示名称', - ], - 'Description' => [ - 'description' => '版本描述。', - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], - 'Name' => [ - 'description' => '名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'name', - ], - 'DataType' => [ - 'description' => '数据类型', - 'type' => 'string', - 'required' => true, - 'example' => 'string', - ], - 'Pattern' => [ - 'description' => '正则表达式校验规则', - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], - 'PatternErrorMessage' => [ - 'description' => '正则表达式校验错误提示信息', - 'type' => 'string', - 'required' => false, - 'example' => '错误的格式', - ], - 'MinLength' => [ - 'description' => '最小长度', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'MaxLength' => [ - 'description' => '最大长度', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - 'Minimum' => [ - 'description' => '数字最小值', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1', - ], - 'Maximum' => [ - 'description' => '数字最大值', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1', - ], - 'Required' => [ - 'description' => '是否必填', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'Disabled' => [ - 'description' => '是否被禁用', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'Array' => [ - 'description' => '是否是数组', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'ReadOnly' => [ - 'description' => '是否只读', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'EditorType' => [ - 'description' => '编辑器类型', - 'type' => 'string', - 'required' => false, - 'example' => 'textbox', - ], - 'Attributes' => [ - 'description' => '扩展属性', - 'type' => 'string', - 'required' => false, - 'example' => '{\'Clusters\': {\'Description\': \'The list of clusters.\'}, \'ClusterIds\': {\'Description\': \'The list of cluster IDs.\'}}', - ], - 'DisplayOrder' => [ - 'description' => '列表展示顺序', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'required' => false, - 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => '坐席ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'CreateSchemaResponse', - 'description' => 'CreateSchemaResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'string', - 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息', - 'type' => 'string', - 'example' => '无', - ], - 'Params' => [ - 'description' => '响应参数。', - 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ], + 403 => [ + ['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => '您无权访问这些用户。'], + ], + [ + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], + ], + 500 => [ + ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => '内部数据服务错误。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\",\\n \\"RequestId\\": \\"9F766284-F103-4298-8EC5-19F9F9BE5522\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '创建Schema', - ], - 'AddSchemaProperty' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '删除注册设备', + 'summary' => '调用UnregisterDevice删除指定实例下指定坐席的设备注册记录，删除后将导致与坐席关联的SIP话机或SIP软电话不可用。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnregisterDevice'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","errorExample":""},{"type":"xml","example":"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\n无\\n200\\nOK","errorExample":""}]', + ], + 'UpdateCallSummary' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], + ], 'parameters' => [ [ - 'name' => 'SchemaId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'schema id', - 'type' => 'string', - 'required' => true, - 'example' => 'profile', - ], - ], - [ - 'name' => 'Property', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '字段', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '名称', - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'Description' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], - 'Name' => [ - 'description' => '名称', - 'type' => 'string', - 'required' => true, - 'example' => 'name', - ], - 'DataType' => [ - 'description' => '数据类型', - 'type' => 'string', - 'required' => true, - 'example' => 'string', - ], - 'Pattern' => [ - 'description' => '正则表达式校验规则', - 'type' => 'string', - 'required' => false, - 'example' => '*', - ], - 'PatternErrorMessage' => [ - 'description' => '正则表达式校验错误提示信息', - 'type' => 'string', - 'required' => false, - 'example' => '格式错误', - ], - 'MinLength' => [ - 'description' => '最小长度', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'MaxLength' => [ - 'description' => '最大长度', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - 'Minimum' => [ - 'description' => '数字最小值', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1', - ], - 'Maximum' => [ - 'description' => '数字最大值', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '1', - ], - 'Required' => [ - 'description' => '是否必填', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'Disabled' => [ - 'description' => '是否被禁用', - 'type' => 'boolean', - 'required' => false, - 'example' => 'False', - ], - 'Array' => [ - 'description' => '是否是数组', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'ReadOnly' => [ - 'description' => '是否只读', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'EditorType' => [ - 'description' => '编辑器类型', - 'type' => 'string', - 'required' => false, - 'example' => 'textbox', - ], - 'Attributes' => [ - 'description' => '扩展属性', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"newName\\":\\"小桔充电-demo\\",\\"appId\\":\\"69FRKB4193W8BYP0\\"}', - ], - 'DisplayOrder' => [ - 'description' => '列表展示顺序', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => false, - ], + 'name' => 'TicketId', + 'in' => 'query', + 'schema' => ['description' => '小结ID。', 'type' => 'string', 'required' => true, 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5'], ], [ - 'name' => 'RequestId', - 'in' => 'formData', - 'schema' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'required' => false, - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], + 'name' => 'Context', + 'in' => 'query', + 'schema' => ['title' => '更新内容', 'description' => '更新内容。', 'type' => 'string', 'required' => false, 'example' => '{"summaryTitle":"标题","summaryContent":"内容","keywords":"关键信息"}'], ], [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx', - ], + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'AddSchemaPropertyResponse', - 'description' => 'AddSchemaPropertyResponse', + 'title' => 'UpdateCallSummaryResponse', + 'description' => 'UpdateCallSummaryResponse', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + 'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Params' => [ - 'description' => '响应参数。', + 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '响应参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -54368,479 +28017,374 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA633111\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '添加Schema字段', - ], - 'GetSummaryTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '更新会话小结', + 'summary' => '使用UpdateCallSummary更新会话小结。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + ], + 'UpdateCampaign' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'CampaignId', + 'in' => 'query', + 'schema' => ['description' => '预测式外呼活动ID。', 'type' => 'string', 'required' => true, 'example' => 'ab11908b-6ebc-4b0c-b51e-3e17c7060'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '开始时间，格式为Unix时间戳，单位毫秒。', 'type' => 'string', 'required' => false, 'example' => '1689901200000'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '结束时间，格式为Unix时间戳，单位毫秒。', 'type' => 'string', 'required' => false, 'example' => '1689933600000'], + ], + [ + 'name' => 'CallableTime', + 'in' => 'query', + 'schema' => ['description' => '可执行时间，支持多个时间段。', 'type' => 'string', 'required' => false, 'example' => '['."\n" + .' {'."\n" + .' "beginTime": "09:00:00",'."\n" + .' "endTime": "12:00:00"'."\n" + .' }'."\n" + .']'], + ], + [ + 'name' => 'StrategyParameters', + 'in' => 'query', + 'schema' => ['description' => '策略参数。', 'type' => 'string', 'required' => false, 'example' => 'PACING策略，参考参数'."\n" + .'{'."\n" + .' "ratio": 2'."\n" + .'}'."\n" + ."\n" + .'PID策略，参考参数'."\n" + .'{'."\n" + .' "abandonRate":5,'."\n" + .' "historicalConnectedRate":45'."\n" + .'}'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '预测式外呼活动名称。', 'type' => 'string', 'required' => false, 'example' => '云联络中心测试'], + ], + [ + 'name' => 'ContactFlowId', 'in' => 'query', + 'schema' => ['description' => '联系流ID。', 'type' => 'string', 'required' => false, 'example' => '3a310f56-4d30-4081-ba24-5d87a3b7262e'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '模板ID。', - 'type' => 'string', - 'required' => true, - 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E'], + 'Code' => ['title' => 'code', 'description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['title' => 'message', 'description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + ], ], ], + ], + 'title' => '修改外呼活动', + 'summary' => '修改外呼活动参数。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + ], + 'UpdateChatRoutingProfile' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d'], + ], + [ + 'name' => 'RoutingProfiles', + 'in' => 'query', + 'schema' => ['description' => '会话分配/转接配置。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{'."\n" + .' "RoutingType": "Automatic",'."\n" + .' "AgentConcurrencySettings": {'."\n" + .' "AllowExceedingLimitWhenTransferring": false,'."\n" + .' "ConcurrencyLimit": 4,'."\n" + .' "AllowExceedingLimitWhenClaiming": true,'."\n" + .' "Enabled": true'."\n" + .' },'."\n" + .' "ChatSettings": {'."\n" + .' "IdleChatTimeoutSeconds": 300'."\n" + .' },'."\n" + .' "DistributionSettings": {'."\n" + .' "Enabled": true,'."\n" + .' "AgentRingTimeoutSeconds": 119,'."\n" + .' "MaxNumberOfConversationsAgentCanMiss": 5,'."\n" + .' "PostAgentMissingConversionsAction": "Nothing"'."\n" + .' }'."\n" + .'}'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'GetSummaryTemplateResponse', - 'description' => 'GetSummaryTemplateResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'TemplateId' => [ - 'description' => '模板ID。', - 'type' => 'string', - 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492'."\n", - ], - 'CategoryId' => [ - 'description' => '小结类目ID。', - 'type' => 'string', - 'example' => '8939-4223-86d0-6bd187905cc8', - ], - 'Name' => [ - 'description' => '模板名称。', - 'type' => 'string', - 'example' => '测试模板', - ], - 'State' => [ - 'description' => '状态码。'."\n" - ."\n" - .'- Enabled 启用中'."\n" - .'- Disabled 已禁用', - 'type' => 'string', - 'example' => 'Enabled', - ], - 'Editor' => [ - 'description' => '模板编辑人。', - 'type' => 'string', - 'example' => 'editor-xxx@ccc-test', - ], - 'PropertyList' => [ - 'description' => '模板字段列表。', - 'type' => 'array', - 'items' => [ - 'description' => '字段定义。', - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => '显示名称。', - 'type' => 'string', - 'example' => 'DisplayName-A', - ], - 'Description' => [ - 'description' => '字段描述。', - 'type' => 'string', - 'example' => 'Description-xxxx', - ], - 'Name' => [ - 'description' => '字段名称。', - 'type' => 'string', - 'example' => 'Name-A', - ], - 'DataType' => [ - 'description' => '数据类型'."\n" - .'。', - 'type' => 'string', - 'example' => 'string'."\n", - ], - 'Pattern' => [ - 'description' => '正则表达式校验规则。', - 'type' => 'string', - 'example' => '^', - ], - 'PatternErrorMessage' => [ - 'description' => '正则表达式校验错误提示信息。', - 'type' => 'string', - 'example' => '不是有效的email地址'."\n", - ], - 'MinLength' => [ - 'description' => '最小长度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'MaxLength' => [ - 'description' => '最大长度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Minimum' => [ - 'description' => '数字最小值。', - 'type' => 'number', - 'format' => 'double', - 'example' => '1', - ], - 'Maximum' => [ - 'description' => '数字最大值。', - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - 'Required' => [ - 'description' => '是否必填。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'System' => [ - 'description' => '是否是系统字段。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Disabled' => [ - 'description' => '是否被禁用。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Array' => [ - 'description' => '是否是数组。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ReadOnly' => [ - 'description' => '是否只读。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'EditorType' => [ - 'description' => '编辑器类型。', - 'type' => 'string', - 'example' => 'textbox', - ], - 'Attributes' => [ - 'description' => '扩展属性。', - 'type' => 'string', - 'example' => '{}', - ], - 'DisplayOrder' => [ - 'description' => '列表展示顺序。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'CreatedTime' => [ - 'description' => '创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1717664210000', - ], - 'UpdatedTime' => [ - 'description' => '更新时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1717664210000', - ], - 'Creator' => [ - 'description' => '创建者。', - 'type' => 'string', - 'example' => 'cretor-xxx@ccc-test'."\n", - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E'], 'Params' => [ 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission', 'description' => ''], + ], + [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TemplateId\\": \\"43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492\\\\n\\",\\n \\"CategoryId\\": \\"8939-4223-86d0-6bd187905cc8\\",\\n \\"Name\\": \\"测试模板\\",\\n \\"State\\": \\"Enabled\\",\\n \\"Editor\\": \\"editor-xxx@ccc-test\\",\\n \\"PropertyList\\": [\\n {\\n \\"DisplayName\\": \\"DisplayName-A\\",\\n \\"Description\\": \\"Description-xxxx\\",\\n \\"Name\\": \\"Name-A\\",\\n \\"DataType\\": \\"string\\\\n\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\\\n\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1717664210000,\\n \\"UpdatedTime\\": 1717664210000,\\n \\"Creator\\": \\"cretor-xxx@ccc-test\\\\n\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"30C7D235-DDCF-4C7F-A462-5E2598252C2B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取会话小结模板', - 'summary' => '使用GetSummaryTemplate获取会话小结模板内容。', - ], - 'UpdateCallSummary' => [ - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '更新会话转接配置', + 'summary' => '使用UpdateChatRoutingProfile进行会话转接配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'UpdateConfigItems' => [ + 'summary' => '调用UpdateConfigItems添加或修改指定实例下的配置信息，例如：来电显示是否隐藏号码，呼入场景下是否允许坐席主动挂机等。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccTMAX45'], + ], 'parameters' => [ [ - 'name' => 'TicketId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '小结ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'Context', + 'name' => 'ObjectId', 'in' => 'query', - 'schema' => [ - 'title' => '更新内容', - 'description' => '更新内容。', - 'type' => 'string', - 'required' => false, - 'example' => '{"summaryTitle":"标题","summaryContent":"内容","keywords":"关键信息"}', - ], + 'schema' => ['description' => '配置信息所属的对象的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'InstanceId', + 'name' => 'ObjectType', + 'in' => 'query', + 'schema' => ['description' => '配置信息所属对象的类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE'], + ], + [ + 'name' => 'ConfigItems', 'in' => 'query', 'schema' => [ - 'description' => '实例ID。', + 'description' => '配置项列表，格式为JSON数组的字符串，数组元素是一个对象，该对象包含两个字段，name，value，name是配置项的名称，value是配置项的值。配置项名称包含系统定义和客户自定义两种，系统定义包括是否允许坐席挂机、是否自动接听、久振未接时长等，这部分配置项名称是固定的，值可以由客户自定义，除此之外，配置项名称也支持客户自定义，客户可以根据需要添加配置项。'."\n", 'type' => 'string', 'required' => true, - 'example' => 'ccc-test', + 'docRequired' => true, + 'enumValueTitles' => ['AllowAudioDownload' => '是否允许坐席下载录音，取值：0（不允许）、1（允许）。', 'RecordingStorageSetting' => '实例录音存储配置。', 'AllowChooseSignedSkillGroup' => '坐席上线前是否手动选择签入的技能组，取值：0（自动签入所属的全部技能组）、1（手动选择签入的技能组）。', 'AgentRingingTimeoutSeconds' => '坐席久振未接超时时长，取值范围为5-90，单位秒。', 'ShowCalledID' => '坐席来电显示，取值：-1（隐藏全部来电号码）、0（隐藏部分来电号码）、1（显示完整来电号码）。', 'ShowCalleeID' => '坐席外呼显示，取值：-1（隐藏全部外呼号码）、0（隐藏部分外呼号码）、1（显示完整外呼号码）。', 'AllowHangup' => '坐席呼入挂机方式，取值：0（不允许坐席挂机）、1（允许坐席挂机）。', 'AutoAnswerCall' => '坐席接听来电方式，取值：-1（手动接听）、n（振铃n秒后接听）。'], + 'example' => '[{"name":"ShowCalledID","value":"-1"},{"name":"ShowCalleeID","value":"1"},{"name":"AllowHangup","value":"0"},{"name":"AutoAnswerCall","value":"-1"},{"name":"AllowAudioDownload","value":"1"},{"name":"AllowChooseSignedSkillGroup","value":"1"}]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'UpdateCallSummaryResponse', - 'description' => 'UpdateCallSummaryResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据。', - 'type' => 'any', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8E7Y5B39-3E24-4A04-81E6-6C4F5B39DF75'], 'Params' => [ - 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '响应参数。', 'type' => 'string', 'example' => '无'], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ], 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => '云联络中心实例中不存在指定的用户。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '更新会话小结', - 'summary' => '使用UpdateCallSummary更新会话小结。', - ], - 'CreateCallSummary' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '更新配置项', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConfigItems'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"8E7Y5B39-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"8E7Y5B39-3E24-4A04-81E6-6C4F5B39DF75\\n无\\n200\\n无\\nOK","errorExample":""}]', + ], + 'UpdateSchemaProperty' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [], 'parameters' => [ [ - 'name' => 'CustomerId', - 'in' => 'query', - 'schema' => [ - 'title' => '客户ID', - 'description' => '客户ID', - 'type' => 'string', - 'required' => false, - 'example' => '51e155ce-3747-*****-b402-13c69597b920', - ], + 'name' => 'SchemaId', + 'in' => 'formData', + 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile'], ], [ - 'name' => 'Context', - 'in' => 'query', + 'name' => 'Property', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'summary信息', - 'description' => 'summary信息', - 'type' => 'string', + 'description' => '字段', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => '显示名称', 'type' => 'string', 'required' => false, 'example' => '姓名'], + 'Description' => ['description' => '描述。', 'type' => 'string', 'required' => false, 'example' => '-'], + 'Name' => ['description' => '名称', 'type' => 'string', 'required' => true, 'example' => 'name'], + 'DataType' => ['description' => '数据类型', 'type' => 'string', 'required' => true, 'example' => 'string'], + 'Pattern' => ['description' => '正则表达式校验规则', 'type' => 'string', 'required' => false, 'example' => '(.*)'], + 'PatternErrorMessage' => ['description' => '正则表达式校验错误提示信息', 'type' => 'string', 'required' => false, 'example' => '不是有效的email地址'], + 'MinLength' => ['description' => '最小长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + 'MaxLength' => ['description' => '最大长度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + 'Minimum' => ['description' => '数字最小值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '10800'], + 'Maximum' => ['description' => '数字最大值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '11'], + 'Required' => ['description' => '是否必填', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'Disabled' => ['description' => '是否被禁用', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'Array' => ['description' => '是否是数组', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'ReadOnly' => ['description' => '是否只读', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'EditorType' => ['description' => '编辑器类型', 'type' => 'string', 'required' => false, 'example' => 'textbox'], + 'Attributes' => ['description' => '扩展属性', 'type' => 'string', 'required' => false, 'example' => '{\\"instanceId\\":\\"4cc3f160-ca64-49ff-bc70-390a044a4e83\\",\\"appId\\":\\"1684145288664\\",\\"commodityCode\\":\\"dide_pre\\",\\"dide_pre_set\\":\\"version_ent\\"}'], + 'DisplayOrder' => ['description' => '列表展示顺序', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], 'required' => false, - 'example' => '{"summaryTitle":"标题","summaryContent":"内容","keywords":"关键信息"}', ], ], [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'title' => '会话ID', - 'description' => '会话ID', - 'type' => 'string', - 'required' => false, - 'example' => 'job-522327189435260928', - ], + 'name' => 'RequestId', + 'in' => 'formData', + 'schema' => ['description' => '请求ID', 'type' => 'string', 'required' => false, 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E'], ], [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'in' => 'formData', + 'schema' => ['description' => '实例 ID', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'CreateTicketResponse', - 'description' => 'CreateTicketResponse', + 'title' => 'UpdateSchemaPropertyResponse', + 'description' => 'UpdateSchemaPropertyResponse', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '数据，小结ID。', - 'type' => 'string', - 'example' => 'c58b9719-3bc3-441d-a4d3-fc0309ef7066', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8707EB29-BAED-4302-B999-40BA61877437', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A450574A-337F-43E2-BC59-9C6594C994C6'], + 'HttpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码'."\n" + ."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Params' => [ - 'description' => '错误参数列表。', + 'description' => '响应参数。', 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '参数信息。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -54848,192 +28392,211 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"c58b9719-3bc3-441d-a4d3-fc0309ef7066\\",\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '创建会话小结', - 'summary' => '使用CreateCallSummary创建会话小结。', - ], - 'ListCallSummaries' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A450574A-337F-43E2-BC59-9C6594C994C6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '更新Schema字段', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'UpdateSubscription' => [ + 'summary' => '使用UpdateSubscription接口进行消息订阅配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ - 'name' => 'ContactIdList', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '通话ID列表', - 'description' => '通话ID列表。', - 'type' => 'array', - 'items' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'job-544789******759424', - ], - 'required' => false, - ], + 'schema' => ['description' => '云联络中心实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'], ], [ - 'name' => 'InstanceId', + 'name' => 'AliyunUid', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc-test', - ], + 'schema' => ['description' => '无需填写', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '无'], + ], + [ + 'name' => 'ProducerId', + 'in' => 'query', + 'schema' => ['description' => 'MQ方式，对应GroupId。'."\n" + .'Webhook方式，填写PID_Webhook。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'GID_xxx'], + ], + [ + 'name' => 'DefaultTopic', + 'in' => 'query', + 'schema' => ['description' => 'MQ方式为MQ的Topic。Webhook方式填写Topic_Webhook', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ccc-event'], + ], + [ + 'name' => 'AccessPoint', + 'in' => 'query', + 'schema' => ['description' => 'MQ的接入地址。Webhook的服务地址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rmq-cn-****.cn-shanghai.rmq.aliyuncs.com:8080'], + ], + [ + 'name' => 'EventSubscriptionsJson', + 'in' => 'query', + 'schema' => ['description' => '消息订阅清单。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"Name ":"StopConsultant ","Disabled ":true},{"Name ":"QueueingRerouted ","Disabled ":true},{"Name ":"IvrTracking ","Disabled ":true},{"Name ":"DualTrackRecordingReady ","Disabled ":true},{"Name ":"SatisfactionSurveyResponse ","Disabled ":true},{"Name ":"Dialing ","Disabled ":false},{"Name ":"Abandoned ","Disabled ":true},{"Name ":"QueueingCancelled ","Disabled ":true},{"Name ":"RecordingReady ","Disabled ":true},{"Name ":"StopCoach ","Disabled ":true},{"Name ":"Established ","Disabled ":true},{"Name ":"InitiateConsultant ","Disabled ":true},{"Name ":"Route2IVR ","Disabled ":false},{"Name ":"Retrieved ","Disabled ":true},{"Name ":"CampaignPaused ","Disabled ":true},{"Name ":"TextStream ","Disabled ":true},{"Name ":"AgentRelease ","Disabled ":true},{"Name ":"VoicemailReady ","Disabled ":true},{"Name ":"Released ","Disabled ":false},{"Name ":"CDRReady ","Disabled ":true},{"Name ":"CaseAttempted ","Disabled ":true},{"Name ":"AgentBreak ","Disabled ":true},{"Name ":"AgentRingingTimeout ","Disabled ":true},{"Name ":"AgentReady ","Disabled ":true},{"Name ":"CampaignResumed ","Disabled ":true},{"Name ":"AgentDialing ","Disabled ":true},{"Name ":"Ringing ","Disabled ":true},{"Name ":"StartConsultant ","Disabled ":false},{"Name ":"QueueingTimeout ","Disabled ":true},{"Name ":"AgentTalk ","Disabled ":true},{"Name ":"AgentRinging ","Disabled ":true},{"Name ":"StartMonitor ","Disabled ":true},{"Name ":"BlindTransfer ","Disabled ":true},{"Name ":"Intercept ","Disabled ":true},{"Name ":"RingingTimeout ","Disabled ":true},{"Name ":"StartConference ","Disabled ":true},{"Name ":"QueueingOverflow ","Disabled ":true},{"Name ":"BargeIn ","Disabled ":true},{"Name ":"StopConference ","Disabled ":true},{"Name ":"AgentCheckOut ","Disabled ":true},{"Name ":"CampaignSubmitted ","Disabled ":true},{"Name ":"AgentCheckIn ","Disabled ":true},{"Name ":"Enqueue ","Disabled ":false},{"Name ":"AttendedTransfer ","Disabled ":true},{"Name ":"StopMonitor ","Disabled ":true},{"Name ":"DispatchingFailure ","Disabled ":true},{"Name ":"SatisfactionSurveyOffer ","Disabled ":true},{"Name ":"CampaignCompleted ","Disabled ":true},{"Name ":"CampaignAborted ","Disabled ":true},{"Name ":"AssignAgent ","Disabled ":true},{"Name ":"Held ","Disabled ":true},{"Name ":"StartCoach ","Disabled ":true}]'], + ], + [ + 'name' => 'MqType', + 'in' => 'query', + 'schema' => ['description' => '消息推送类型。'."\n" + .'- rocketmq4'."\n" + .'- rocketmq5'."\n" + .'- webhook', 'type' => 'string', 'required' => false, 'example' => 'rocketmq5'], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => ['description' => 'MQ用户名，只有当MqType==rocketmq5时，需要指定。', 'type' => 'string', 'required' => false, 'example' => 'username'], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => ['description' => 'MQ 密码，只有当 MqType==rocketmq5 时，需要指定。', 'type' => 'string', 'required' => false, 'example' => 'password'], + ], + [ + 'name' => 'MqInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'MQ实例，当MqType==rocketmq4或MqType==rocketmq5时，需要指定', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ListCallSummariesResponse', - 'description' => 'ListCallSummariesResponse', 'type' => 'object', 'properties' => [ + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], + ], 'Data' => [ 'description' => '数据。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TicketId' => [ - 'title' => '小结ID', - 'description' => '小结ID。', - 'type' => 'string', - 'example' => 'ac0dd304-****-****-****-4a90010f0d38', - ], - 'ContactId' => [ - 'title' => '通话ID', - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-544789******759424', - ], - 'Context' => [ - 'title' => 'summary信息', - 'description' => '小结信息。', - 'type' => 'string', - 'example' => '{'."\n" - .' "_sys_field_config": ['."\n" - .' {'."\n" - .' "Array": false,'."\n" - .' "Required": true,'."\n" - .' "DisplayName": "主题",'."\n" - .' "Attributes": "{}",'."\n" - .' "DataType": "TEXT",'."\n" - .' "EditorType": "TEXT",'."\n" - .' "MaxLength": 30,'."\n" - .' "System": true,'."\n" - .' "Name": "summaryTitle"'."\n" - .' },'."\n" - .' {'."\n" - .' "Array": false,'."\n" - .' "DisplayName": "小结",'."\n" - .' "Attributes": "{}",'."\n" - .' "DataType": "TEXT",'."\n" - .' "EditorType": "TEXTAREA",'."\n" - .' "MaxLength": 1000,'."\n" - .' "System": true,'."\n" - .' "Name": "summaryContent"'."\n" - .' },'."\n" - .' {'."\n" - .' "Array": true,'."\n" - .' "DisplayName": "标签",'."\n" - .' "Attributes": "{}",'."\n" - .' "DataType": "TEXT",'."\n" - .' "EditorType": "SELECT",'."\n" - .' "System": true,'."\n" - .' "Name": "keywords"'."\n" - .' }'."\n" - .' ],'."\n" - .' "summaryContent": "小结内容",'."\n" - .' "creator": "creator@ccc-test",'."\n" - .' "bizType": "Summary",'."\n" - .' "keywords": ['."\n" - .' "标签1"'."\n" - .' ],'."\n" - .' "source": "Console",'."\n" - .' "summaryTitle": "测试会话小结",'."\n" - .' "instanceId": "ccc-test",'."\n" - .' "externalInput": "{\\"summaryTitle\\":\\"测试会话小结\\",\\"summaryContent\\":\\"小结内容\\",\\"keywords\\":[\\"标签1\\"],\\"_sys_field_config\\":[{\\"DisplayName\\":\\"主题\\",\\"Name\\":\\"summaryTitle\\",\\"Required\\":true,\\"EditorType\\":\\"TEXT\\",\\"Array\\":false,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"MaxLength\\":30,\\"Attributes\\":\\"{}\\"},{\\"DisplayName\\":\\"小结\\",\\"Name\\":\\"summaryContent\\",\\"EditorType\\":\\"TEXTAREA\\",\\"Array\\":false,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"MaxLength\\":1000,\\"Attributes\\":\\"{}\\"},{\\"DisplayName\\":\\"标签\\",\\"Name\\":\\"keywords\\",\\"EditorType\\":\\"SELECT\\",\\"Array\\":true,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"Attributes\\":\\"{}\\"}]}",'."\n" - .' "templateName": "Summary-Ticket",'."\n" - .' "bizId": "job-544789******759424",'."\n" - .' "ticketStartTime": 1723449513735,'."\n" - .' "ticketId": "ac0dd304-****-****-****-4a90010f0d38",'."\n" - .' "definitionId": "Summary-Ticket:2:6881f43a-****-11ee-*****-6eb35a90a7a6"'."\n" - .'}', - ], - 'CreatedTime' => [ - 'title' => '创建时间', - 'description' => '创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1723449513735', - ], - 'Creator' => [ - 'title' => '创建人', - 'description' => '创建人。', - 'type' => 'string', - 'example' => 'creator@ccc-test', - ], - 'Editor' => [ - 'description' => '编辑人。', - 'type' => 'string', - 'example' => 'editor@ccc-test', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'ccc-test'], + 'ProducerId' => ['description' => 'MQ 方式，对应 GroupId。 Webhook 方式，填写 PID_Webhook。', 'type' => 'string', 'example' => 'GID_xxx'], + 'Topic' => ['description' => 'MQ 方式为 MQ 的 Topic。Webhook 方式填写 Topic_Webhook', 'type' => 'string', 'example' => 'ccc-event'], + 'AccessPoint' => ['description' => 'MQ 的接入地址。Webhook 的服务地址。', 'type' => 'string', 'example' => 'rmq-cn-****.cn-shanghai.rmq.aliyuncs.com:8080'], + 'Username' => ['description' => 'MQ 用户名，只有当 MqType==rocketmq5 时，需要指定。', 'type' => 'string', 'example' => 'username'], + 'MqType' => ['description' => '消息推送类型。'."\n" + .'- rocketmq4'."\n" + .'- rocketmq5'."\n" + .'- webhook', 'type' => 'string', 'example' => 'rocketmq5'], + 'MqInstanceId' => ['description' => 'MQ 实例，当 MqType==rocketmq4 或 MqType==rocketmq5 时，需要指定', 'type' => 'string', 'example' => 'rmq-cn-****'], + 'EventList' => [ + 'description' => '消息事件清单。', + 'type' => 'array', + 'items' => [ + 'description' => '消息事件。', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '事件名称。', 'type' => 'string', 'example' => 'Dialing'], + 'Disabled' => ['description' => '是否推送。', 'type' => 'boolean', 'example' => 'true'], + 'Topic' => ['description' => '事件主题。', 'type' => 'string', 'example' => '无'], + ], ], ], ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '932579BC-811A-503D-B322-4C2E57087CAA', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => '无', - ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => '该参数不能为null值。'], + ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => '该参数必须为系统限定的枚举值之一。'], + ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => '该参数不能为null值或为空字符串。'], + ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], + ], + ], + 'title' => '配置消息订阅', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ProducerId\\": \\"GID_xxx\\",\\n \\"Topic\\": \\"ccc-event\\",\\n \\"AccessPoint\\": \\"rmq-cn-****.cn-shanghai.rmq.aliyuncs.com:8080\\",\\n \\"Username\\": \\"username\\",\\n \\"MqType\\": \\"rocketmq5\\",\\n \\"MqInstanceId\\": \\"rmq-cn-****\\",\\n \\"EventList\\": [\\n {\\n \\"Name\\": \\"Dialing\\",\\n \\"Disabled\\": true,\\n \\"Topic\\": \\"无\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'UpdateTicket' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], + ], + [ + 'name' => 'TicketId', + 'in' => 'query', + 'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => true, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => ['description' => '工单标题。', 'type' => 'string', 'required' => false, 'example' => '标题'], + ], + [ + 'name' => 'CustomerId', + 'in' => 'query', + 'schema' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => '51e155ce-***-****-b402-13c69597b920'], + ], + [ + 'name' => 'Context', + 'in' => 'query', + 'schema' => ['description' => '工单表单信息。', 'type' => 'string', 'required' => false, 'example' => '{"productName":"玩具1"}'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'UpdateTicketResponse', + 'description' => 'UpdateTicketResponse', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], 'Params' => [ 'description' => '错误参数列表。', 'type' => 'array', - 'items' => [ - 'description' => '错误参数。', - 'type' => 'string', - 'example' => '无', - ], + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], @@ -55041,571 +28604,991 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'NotExists.InstanceId', - 'errorMessage' => 'The specified instance %s does not exist.', - ], + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TicketId\\": \\"ac0dd304-****-****-****-4a90010f0d38\\",\\n \\"ContactId\\": \\"job-544789******759424\\",\\n \\"Context\\": \\"{\\\\n \\\\\\"_sys_field_config\\\\\\": [\\\\n {\\\\n \\\\\\"Array\\\\\\": false,\\\\n \\\\\\"Required\\\\\\": true,\\\\n \\\\\\"DisplayName\\\\\\": \\\\\\"主题\\\\\\",\\\\n \\\\\\"Attributes\\\\\\": \\\\\\"{}\\\\\\",\\\\n \\\\\\"DataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"EditorType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"MaxLength\\\\\\": 30,\\\\n \\\\\\"System\\\\\\": true,\\\\n \\\\\\"Name\\\\\\": \\\\\\"summaryTitle\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"Array\\\\\\": false,\\\\n \\\\\\"DisplayName\\\\\\": \\\\\\"小结\\\\\\",\\\\n \\\\\\"Attributes\\\\\\": \\\\\\"{}\\\\\\",\\\\n \\\\\\"DataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"EditorType\\\\\\": \\\\\\"TEXTAREA\\\\\\",\\\\n \\\\\\"MaxLength\\\\\\": 1000,\\\\n \\\\\\"System\\\\\\": true,\\\\n \\\\\\"Name\\\\\\": \\\\\\"summaryContent\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"Array\\\\\\": true,\\\\n \\\\\\"DisplayName\\\\\\": \\\\\\"标签\\\\\\",\\\\n \\\\\\"Attributes\\\\\\": \\\\\\"{}\\\\\\",\\\\n \\\\\\"DataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"EditorType\\\\\\": \\\\\\"SELECT\\\\\\",\\\\n \\\\\\"System\\\\\\": true,\\\\n \\\\\\"Name\\\\\\": \\\\\\"keywords\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"summaryContent\\\\\\": \\\\\\"小结内容\\\\\\",\\\\n \\\\\\"creator\\\\\\": \\\\\\"creator@ccc-test\\\\\\",\\\\n \\\\\\"bizType\\\\\\": \\\\\\"Summary\\\\\\",\\\\n \\\\\\"keywords\\\\\\": [\\\\n \\\\\\"标签1\\\\\\"\\\\n ],\\\\n \\\\\\"source\\\\\\": \\\\\\"Console\\\\\\",\\\\n \\\\\\"summaryTitle\\\\\\": \\\\\\"测试会话小结\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"ccc-test\\\\\\",\\\\n \\\\\\"externalInput\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"summaryTitle\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"测试会话小结\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"summaryContent\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"小结内容\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"keywords\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"标签1\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"_sys_field_config\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"DisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"主题\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"summaryTitle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Required\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"EditorType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Array\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"DataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"System\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"MaxLength\\\\\\\\\\\\\\":30,\\\\\\\\\\\\\\"Attributes\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{}\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"DisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"小结\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"summaryContent\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EditorType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXTAREA\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Array\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"DataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"System\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"MaxLength\\\\\\\\\\\\\\":1000,\\\\\\\\\\\\\\"Attributes\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{}\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"DisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"标签\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"keywords\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EditorType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SELECT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Array\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"DataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"System\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"Attributes\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{}\\\\\\\\\\\\\\"}]}\\\\\\",\\\\n \\\\\\"templateName\\\\\\": \\\\\\"Summary-Ticket\\\\\\",\\\\n \\\\\\"bizId\\\\\\": \\\\\\"job-544789******759424\\\\\\",\\\\n \\\\\\"ticketStartTime\\\\\\": 1723449513735,\\\\n \\\\\\"ticketId\\\\\\": \\\\\\"ac0dd304-****-****-****-4a90010f0d38\\\\\\",\\\\n \\\\\\"definitionId\\\\\\": \\\\\\"Summary-Ticket:2:6881f43a-****-11ee-*****-6eb35a90a7a6\\\\\\"\\\\n}\\",\\n \\"CreatedTime\\": 1723449513735,\\n \\"Creator\\": \\"creator@ccc-test\\",\\n \\"Editor\\": \\"editor@ccc-test\\"\\n }\\n ],\\n \\"RequestId\\": \\"932579BC-811A-503D-B322-4C2E57087CAA\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', - 'title' => '获取会话小结', - 'summary' => '使用ListCallSummaries接口获取会话小结。', - ], - 'AnalyzeConversation' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '更新工单信息', + 'summary' => '使用UpdateTicket更新工单内容。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], + 'ramActions' => [], + ], + 'WithdrawTicket' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', - ], - ], - [ - 'name' => 'ContactId', + 'name' => 'TicketId', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'job-10963442671187****', - ], + 'schema' => ['description' => '工单ID。', 'type' => 'string', 'required' => true, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'], ], [ - 'name' => 'TaskListJson', + 'name' => 'Comment', 'in' => 'query', - 'schema' => [ - 'description' => '分析的任务类型列表。其内容可以是：'."\n" - .'- title：标题'."\n" - .'- summary：小结'."\n" - .'- keywords：关键词'."\n" - .'- fields：字段'."\n" - ."\n" - .'目前仅summary和title可同时传递，其他的参数只能单独传递。', - 'type' => 'string', - 'required' => false, - 'example' => '["keywords"]', - ], + 'schema' => ['description' => '处理意见。', 'type' => 'string', 'required' => true, 'example' => '撤回，补充信息'], ], [ - 'name' => 'FieldListJson', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '当TaskListJson参数为fields, 此参数指定要提取的字段内容。', - 'type' => 'string', - 'required' => false, - 'example' => '['."\n" - .' {'."\n" - .' "code": "OrderNo",'."\n" - .' "name": "订单号",'."\n" - .' "description": "订单号"'."\n" - .' },'."\n" - .' {'."\n" - .' "code": "ProductName",'."\n" - .' "name": "商品名称",'."\n" - .' "description": "商品名称"'."\n" - .' }'."\n" - .']', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'CancelTicketResponse', + 'description' => 'CancelTicketResponse', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID,可用于接口的日志查询', - 'type' => 'string', - 'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522', - ], - 'Data' => [ - 'description' => '返回结果。根据分析任务的不同，返回的内容也不相同。', - 'type' => 'string', - 'example' => '{'."\n" - .' "订单号": "1234",'."\n" - .' "商品名称": "笔记本"'."\n" - .'}', + 'Data' => ['description' => '数据。', 'type' => 'any', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5'], + 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '无'], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => ['description' => '错误参数。', 'type' => 'string', 'example' => '无'], ], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid. %s', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], + 404 => [ + ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => '指定的呼叫中心实例不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '撤回工单', + 'summary' => '使用WithdrawTicket撤回工单。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"9F766284-F103-4298-8EC5-19F9F9BE5522\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"订单号\\\\\\": \\\\\\"1234\\\\\\",\\\\n \\\\\\"商品名称\\\\\\": \\\\\\"笔记本\\\\\\"\\\\n}\\"\\n}","type":"json"}]', - 'title' => '分析对话内容', - 'summary' => '分析指定的文字通话内容，提取摘要类相关信息，比如标题，关键词、小结以及其他指定的信息。', - 'description' => '此接口可用于在线会话以及语音会话。当用于语音会话时，需要实现开启语音实时转写的功能。', + 'ramActions' => [], ], - 'AddFeedback' => [ - 'methods' => [ - 'post', - 'get', + ], + 'endpoints' => [ + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ccc.cn-shanghai.aliyuncs.com', 'endpoint' => 'ccc.cn-shanghai.aliyuncs.com', 'vpc' => 'ccc-vpc.cn-shanghai.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AbnormalService.Ceased', 'message' => 'Service abnormal. The instance %s is stopped.', 'http_code' => 403, 'description' => '服务异常，实例已停止。'], + ['code' => 'AbnormalService.Creating', 'message' => 'Service abnormal. The instance %s is being created.', 'http_code' => 403, 'description' => '服务异常，正在创建实例。'], + ['code' => 'AbnormalService.Disabled', 'message' => 'Service abnormal. Call center service of %s is not enabled.', 'http_code' => 403, 'description' => '服务异常，云联络中心服务未启用。'], + ['code' => 'AlreadyExists.CustomNumber', 'message' => 'Custom number already exists.', 'http_code' => 409, 'description' => '呼入号码标记已存在。'], + ['code' => 'AlreadyExists.DomainName', 'message' => 'Instance %s already exists.', 'http_code' => 409, 'description' => '云联络中心实例已存在。'], + ['code' => 'AlreadyExists.InstanceId', 'message' => 'The instance %s already exists.', 'http_code' => 409, 'description' => '云联络中心实例已存在。'], + ['code' => 'AlreadyExists.PhoneNumber', 'message' => 'The specified number %s already exists in the instance.', 'http_code' => 409, 'description' => '云联络中心实例中已经存在指定的号码。'], + ['code' => 'AlreadyExists.RamUser', 'message' => 'RAM user %s already exists.', 'http_code' => 409, 'description' => 'Ram用户已存在。'], + ['code' => 'AlreadyExists.SkillGroupId', 'message' => 'Skill group %s already exists in instance %s.', 'http_code' => 409, 'description' => '云联络中心实例中已经存在指定的技能组。'], + ['code' => 'AlreadyExists.User', 'message' => 'User %s already exists in instance %s.', 'http_code' => 409, 'description' => '云联络中心实例下已存在指定的用户。'], + ['code' => 'AlreadyExists.UserName', 'message' => 'User name %s already exists。', 'http_code' => 409, 'description' => '用户名%s已存在。'], + ['code' => 'Authentication.Signature', 'message' => 'Failed to generate signature for SIP authentication.', 'http_code' => 500, 'description' => '无法为SIP身份验证生成签名。'], + ['code' => 'InternalService.AC', 'message' => 'An internal AC service error occurred. %s', 'http_code' => 500, 'description' => '内部AC服务错误。'], + ['code' => 'InternalService.Account', 'message' => 'An internal Account service error occurred. %s', 'http_code' => 500, 'description' => '内部Account服务错误。'], + ['code' => 'InternalService.Common', 'message' => 'An internal service error occurred. %s', 'http_code' => 500, 'description' => '内部服务错误。'], + ['code' => 'InternalService.CTI', 'message' => 'An internal CTI service error occurred. %s', 'http_code' => 500, 'description' => '内部CTI服务错误。'], + ['code' => 'InternalService.DB', 'message' => 'An internal DB service error occurred. %s', 'http_code' => 500, 'description' => '内部数据服务错误。'], + ['code' => 'InternalService.IVR', 'message' => 'An internal IVR service error occurred. %s', 'http_code' => 500, 'description' => '内部IVR服务错误。'], + ['code' => 'InternalService.OSS', 'message' => 'An internal OSS service error occurred. %s', 'http_code' => 500, 'description' => '内部OSS服务错误。'], + ['code' => 'InternalService.RAM', 'message' => 'An internal RAM service error occurred. %s', 'http_code' => 500, 'description' => '内部RAM服务错误。'], + ['code' => 'InternalService.Redis', 'message' => 'An internal Redis service error occurred. %s', 'http_code' => 500, 'description' => '内部Redis服务错误。'], + ['code' => 'InternalService.ResourcePlatform', 'message' => 'An internal ResourcePlatform service error occurred. %s', 'http_code' => 500, 'description' => '内部ResourcePlatform服务错误。'], + ['code' => 'InternalService.STS', 'message' => 'An internal STS service error occurred. %s', 'http_code' => 500, 'description' => '内部STS服务错误。'], + ['code' => 'InternalService.WorkFlow', 'message' => 'An internal WorkFlow service error occurred. %s', 'http_code' => 500, 'description' => '内部WorkFlow服务错误。'], + ['code' => 'InUse.Instance', 'message' => 'Instance %s is in use now.', 'http_code' => 400, 'description' => '指定的云联络中心实例正在使用中。'], + ['code' => 'InUse.SkillGroup', 'message' => 'Skill group %s is in use now.', 'http_code' => 400, 'description' => '技能组正在被使用，该状态表明技能组可能关联着号码或坐席。'], + ['code' => 'InvalidOperation.ChannelState', 'message' => 'The operation is not allowed. Channel state (%s) does not meet expectations (%s).', 'http_code' => 400, 'description' => '非法操作，channel状态不符合预期。'], + ['code' => 'InvalidOperation.ContactFlow', 'message' => 'The operation is not allowed. Contact flow %s is edited by someone else.', 'http_code' => 400, 'description' => '不允许该操作。 该联系流正在由其他人编辑。'], + ['code' => 'InvalidOperation.DeviceState', 'message' => 'The operation is not allowed. Device state (%s) does not meet expectations (%s).', 'http_code' => 400, 'description' => '非法操作。 设备状态不符合预期。'], + ['code' => 'InvalidOperation.DraftContactFlow', 'message' => 'Draft %s of ContactFlow %s is edited by someone else.', 'http_code' => 400, 'description' => '该联系流草稿正在由其他人编辑。'], + ['code' => 'InvalidOperation.DuplicatedCallee', 'message' => 'The operation is not allowed. The called number %s already exists in call %s.', 'http_code' => 400, 'description' => '非法操作，新加入的一方已在通道中。'], + ['code' => 'InvalidOperation.SignedSkillGroup', 'message' => 'The operation is not allowed. User have not yet signed in any skill group.', 'http_code' => 400, 'description' => '非法操作，用户尚未迁入任何技能组。'], + ['code' => 'InvalidOperation.UserState', 'message' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'http_code' => 400, 'description' => '非法操作，用户状态不符合预期。'], + ['code' => 'LimitExceed.CallTagsPerInstance', 'message' => 'The total number of call tag of the instance exceeds the limit %s.', 'http_code' => 400, 'description' => '号码标签数量超出单个实例的上限阈值。'], + ['code' => 'LimitExceed.CallTagsPerNumber', 'message' => 'The total number of call tag of numbers exceeds the limit %s.', 'http_code' => 400, 'description' => '号码标签数量超出单个呼入号码标记的上线阈值。'], + ['code' => 'LimitExceeded.File', 'message' => 'The size of the file exceeds the limit of %s MB.', 'http_code' => 400, 'description' => '文件大小超过上限。无法继续添加，如有特殊需要，请您通过工单进行问题反馈。'], + ['code' => 'LimitExceeded.SkillGroup', 'message' => 'The total count of skill group exceeds the limit %s.', 'http_code' => 400, 'description' => '技能组数量超过上限。'], + ['code' => 'LimitExceeded.SkillGroupsPerUser', 'message' => 'The total count of skill group of a user exceeds the limit %s.', 'http_code' => 400, 'description' => '单用户关联的技能组数量超过上限。'], + ['code' => 'LimitExceeded.User', 'message' => 'The total count of user exceeds the limit %s.', 'http_code' => 400, 'description' => '用户数量超过上限。无法继续添加用户，如有特殊需要，请您通过工单进行问题反馈。'], + ['code' => 'NoPermission.User', 'message' => 'User %s has no permission to %s.', 'http_code' => 403, 'description' => '用户%s没有%s的权限。'], + ['code' => 'NotExist.Instance', 'message' => 'Call center instance %s does not exist.', 'http_code' => 404, 'description' => '云联络中心实例%s不存在。'], + ['code' => 'NotExist.SkillGroup', 'message' => 'Skill group %s does not exist.', 'http_code' => 404, 'description' => '技能组%s不存在。'], + ['code' => 'NotExist.User', 'message' => 'User %s of instance %s does not exist.', 'http_code' => 404, 'description' => '用户%s在实例%s中不存在。'], + ['code' => 'NotExists.AudioResourceFileKey', 'message' => 'Audio resource file key %s does not exist.', 'http_code' => 404, 'description' => '指定的音频资源文件密钥不存在。'], + ['code' => 'NotExists.AudioResourceId', 'message' => 'Audio resource %s does not exists.', 'http_code' => 404, 'description' => '指定的音频资源不存在。'], + ['code' => 'NotExists.ChannelId', 'message' => 'The specified channel %s does not exist in call %s.', 'http_code' => 404, 'description' => '通话中不存在指定的Channel信息。'], + ['code' => 'NotExists.ContactFlowDraftId', 'message' => 'Draft %s of contact flow %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例的联系流中不存在指定的草稿。'], + ['code' => 'NotExists.ContactFlowId', 'message' => 'Contact flow %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例中不存在指定的联系流。'], + ['code' => 'NotExists.ContactFlowSnapshotId', 'message' => 'Snapshot %s of contact flow %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例的联系流中不存在指定的快照。'], + ['code' => 'NotExists.CustomCallTagging', 'message' => 'Custom call tagging %s does not exist in instance %s.', 'http_code' => 404, 'description' => '呼入号码标记不存在。'], + ['code' => 'NotExists.Extension', 'message' => 'No available extension number exists.', 'http_code' => 404, 'description' => '没有可分配的分机号。'], + ['code' => 'NotExists.FunctionMetaId', 'message' => 'Function meta %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例中不存在指定的Function Meta。'], + ['code' => 'NotExists.InstanceId', 'message' => 'The specified instance %s does not exist.', 'http_code' => 404, 'description' => '指定的呼叫中心实例不存在。'], + ['code' => 'NotExists.JobId', 'message' => 'The call %s does not exist.', 'http_code' => 404, 'description' => '指定的通话信息不存在。'], + ['code' => 'NotExists.Number', 'message' => 'The specified number %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例中不存在指定的号码。'], + ['code' => 'NotExists.OutboundNumber', 'message' => 'A valid number for outbound call is not found.', 'http_code' => 404, 'description' => '找不到呼出电话的有效号码。'], + ['code' => 'NotExists.RamId', 'message' => 'RAM user %s does not exist.', 'http_code' => 404, 'description' => '指定的RAM用户不存在。'], + ['code' => 'NotExists.RoleId', 'message' => 'Role %s does not exist.', 'http_code' => 404, 'description' => '指定的角色不存在。'], + ['code' => 'NotExists.SkillGroupId', 'message' => 'The skill group ID %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例中不存在指定的技能组ID。'], + ['code' => 'NotExists.SkillGroupName', 'message' => 'The skill group name %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例中不存在指定的技能组名称。'], + ['code' => 'NotExists.Switch', 'message' => 'The switch %s does not exist.', 'http_code' => 404, 'description' => 'Switch不存在'], + ['code' => 'NotExists.UserId', 'message' => 'The user %s does not exist in instance %s.', 'http_code' => 404, 'description' => '云联络中心实例中不存在指定的用户。'], + ['code' => 'NotExists.UserResourceFileKey', 'message' => 'User resource file key %s does not exist.', 'http_code' => 404, 'description' => 'OSS用户资源文件的Key不存在。'], + ['code' => 'NotFound.CallingNumber', 'message' => 'No available calling number found in the group %s.', 'http_code' => 404, 'description' => '在组 %s 中找不到可用的主叫号码。'], + ['code' => 'Parameter.Blank', 'message' => 'The parameter %s may not be null or blank.', 'http_code' => 400, 'description' => '该参数不能为null或含有空白符的字符串。'], + ['code' => 'Parameter.Blank', 'message' => 'The parameter %s must not be null or empty.', 'http_code' => 400, 'description' => '该参数不能为null值。'], + ['code' => 'Parameter.CallerType', 'message' => 'Invalid caller type. Caller type (%s) does not meet expectations (%s).', 'http_code' => 400, 'description' => '非法的调用类型，调用类型不符合预期。'], + ['code' => 'Parameter.Empty', 'message' => 'The parameter %s may not be null or empty.', 'http_code' => 400, 'description' => '该参数不能为null值或为空字符串。'], + ['code' => 'Parameter.Enumeration', 'message' => 'The parameter %s must be one of the value of enumeration %s.', 'http_code' => 400, 'description' => '该参数必须为系统限定的枚举值之一。'], + ['code' => 'Parameter.Format', 'message' => 'The format of parameter %s is invalid. %s', 'http_code' => 400, 'description' => '该参数的格式不合法。'], + ['code' => 'Parameter.Invalid', 'message' => 'The parameter %s is invalid. %s.', 'http_code' => 400, 'description' => '该参数无效。'], + ['code' => 'Parameter.InvalidFileContent', 'message' => 'The content or format of the file (%s) is invalid.', 'http_code' => 400, 'description' => '参数错误，传入的文件内容无效。'], + ['code' => 'Parameter.Maximum', 'message' => 'The parameter %s must be less than or equal to %s.', 'http_code' => 400, 'description' => '参数必须小于或等于系统规定的最大值。'], + ['code' => 'Parameter.Minimum', 'message' => 'The parameter %s must be greater than or equal to %s.', 'http_code' => 400, 'description' => '参数必须大于或等于系统规定的最小值。'], + ['code' => 'Parameter.Null', 'message' => 'The parameter %s may not be null.', 'http_code' => 400, 'description' => '该参数不能为null值.'], + ['code' => 'Parameter.UnknownCaller', 'message' => 'Invalid caller. Caller UID is null.', 'http_code' => 400, 'description' => '无效的调用者，Caller Uid 为null。'], + ['code' => 'Permission.Common', 'message' => 'You have no permission to access. %s', 'http_code' => 403, 'description' => '您无权进行访问。'], + ['code' => 'Permission.Instance', 'message' => 'You have no permission to access instance %s.', 'http_code' => 403, 'description' => '您无权访问指定的实例。'], + ['code' => 'Permission.PhoneNumber', 'message' => 'You have no permission to access number(s) %s.', 'http_code' => 403, 'description' => '您无权使用该号码。'], + ['code' => 'Permission.RAM', 'message' => 'You are not authorized to perform this action. RAM authorization is required.', 'http_code' => 403, 'description' => '您无权执行此操作。 需要RAM授权。'], + ['code' => 'Permission.Role', 'message' => 'You have no permission to access role %s.', 'http_code' => 403, 'description' => '您无权访问指定角色。'], + ['code' => 'Permission.SkillGroup', 'message' => 'You have no permission to access skill group(s) %s.', 'http_code' => 403, 'description' => '您无权访问这些技能组。'], + ['code' => 'Permission.StsToken', 'message' => 'You have no permission to access sts token %s.', 'http_code' => 403, 'description' => '您无权访问STS Token。'], + ['code' => 'Permission.Unauthorized', 'message' => 'You are not authorized to perform this action. %s privileges are required.', 'http_code' => 403, 'description' => '您无权执行此操作。 必须具有指定权限。'], + ['code' => 'Permission.User', 'message' => 'You have no permission to access user(s) %s.', 'http_code' => 403, 'description' => '您无权访问这些用户。'], + ['code' => 'UserBusy', 'message' => 'The user %s you called was busy. Please try again later.', 'http_code' => 400, 'description' => '您呼叫的用户正忙，请稍后再试。'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'AppendCases'], + ], + 'createdAt' => '2025-11-13T08:46:40.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateCampaign'], + ], + 'createdAt' => '2025-11-13T08:46:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateInstance'], + ], + 'createdAt' => '2025-10-28T09:55:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'MakeCall'], + ], + 'createdAt' => '2025-04-08T07:49:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListRealtimeAgentStates'], + ], + 'createdAt' => '2025-02-13T02:21:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetConversationDetail'], + ], + 'createdAt' => '2024-12-12T15:21:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'BlindTransfer'], + ], + 'createdAt' => '2024-10-28T02:30:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListCallDetailRecordsV2'], + ], + 'createdAt' => '2024-09-06T02:26:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'MakeCall'], + ], + 'createdAt' => '2024-08-30T02:21:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'LaunchSurvey'], + ], + 'createdAt' => '2024-08-13T06:55:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListCallDetailRecords'], + ], + 'createdAt' => '2024-07-29T10:26:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListRealtimeAgentStates'], + ['description' => '请求参数发生变更', 'api' => 'ListRealtimeSkillGroupStates'], + ], + 'createdAt' => '2024-06-21T06:52:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'LaunchSurvey'], + ], + 'createdAt' => '2024-06-21T06:40:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetCampaign'], + ['description' => '响应参数发生变更', 'api' => 'ListCampaigns'], + ], + 'createdAt' => '2024-06-06T11:38:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], + ], + 'createdAt' => '2024-06-06T07:19:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], + ], + 'createdAt' => '2024-05-28T06:54:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], + ], + 'createdAt' => '2024-05-17T08:45:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], + ], + 'createdAt' => '2024-05-15T02:47:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], + ], + 'createdAt' => '2024-04-24T12:54:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'BlindTransfer'], + ['description' => '请求参数发生变更', 'api' => 'InitiateAttendedTransfer'], + ], + 'createdAt' => '2024-04-01T09:23:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'AnswerCall'], + ], + 'createdAt' => '2024-02-05T03:20:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'ListUnassignedNumbers'], + ], + 'createdAt' => '2024-02-02T03:52:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListCustomCallTagging'], + ], + 'createdAt' => '2024-01-29T09:14:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'MuteCall'], + ], + 'createdAt' => '2024-01-18T12:07:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CoachCall'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'MakeCall'], + ], + 'createdAt' => '2024-01-11T08:11:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateUser'], + ], + 'createdAt' => '2023-12-22T03:22:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateAudioFile'], + ['description' => '响应参数发生变更', 'api' => 'GetCampaign'], + ['description' => '响应参数发生变更', 'api' => 'GetHistoricalCampaignReport'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetHistoricalInstanceReport'], + ['description' => '响应参数发生变更', 'api' => 'ListCampaignTrendingReport'], + ['description' => '响应参数发生变更', 'api' => 'ListCases'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListHistoricalAgentReport'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListHistoricalAgentSkillGroupReport'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListHistoricalSkillGroupReport'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListIntervalAgentReport'], + ], + 'createdAt' => '2023-11-22T01:05:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListAudioFiles'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListBriefSkillGroups'], + ['description' => '响应参数发生变更', 'api' => 'ListCampaigns'], + ['description' => '请求参数发生变更', 'api' => 'ModifyAudioFile'], + ['description' => '响应参数发生变更', 'api' => 'ModifySkillLevelsOfUser'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ModifyUser'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'PollUserStatus'], + ['description' => '响应参数发生变更', 'api' => 'RemovePhoneNumbers'], + ], + 'createdAt' => '2023-11-17T01:12:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'AddNumbersToSkillGroup'], + ['description' => '请求参数发生变更', 'api' => 'BlindTransfer'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateUser'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetInstanceTrendingReport'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetLoginDetails'], + ], + 'createdAt' => '2023-11-07T07:22:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateSkillGroup'], + ['description' => '响应参数发生变更', 'api' => 'ExportDoNotCallNumbers'], + ['description' => '响应参数发生变更', 'api' => 'GetSkillGroup'], + ['description' => '响应参数发生变更', 'api' => 'GetTurnCredentials'], + ['description' => '响应参数发生变更', 'api' => 'GetTurnServerList'], + ['description' => '响应参数发生变更', 'api' => 'ImportDoNotCallNumbers'], + ['description' => '请求参数发生变更', 'api' => 'InterceptCall'], + ['description' => '请求参数发生变更', 'api' => 'ListContactFlows'], + ], + 'createdAt' => '2023-11-06T05:45:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'BargeInCall'], + ['description' => '请求参数发生变更', 'api' => 'CancelAttendedTransfer'], + ['description' => '请求参数发生变更', 'api' => 'CompleteAttendedTransfer'], + ['description' => '请求参数发生变更', 'api' => 'HoldCall'], + ['description' => '请求参数发生变更', 'api' => 'InitiateAttendedTransfer'], + ], + 'createdAt' => '2023-10-26T08:14:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'AnswerCall'], + ], + 'createdAt' => '2023-10-26T07:16:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListCallDetailRecords'], + ], + 'createdAt' => '2023-10-09T15:22:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'AnswerCall'], + ['description' => '响应参数发生变更', 'api' => 'ReleaseCall'], + ], + 'createdAt' => '2023-06-05T23:22:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetMonoRecording'], + ], + 'createdAt' => '2023-06-05T09:02:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListHistoricalAgentReport'], + ['description' => '响应参数发生变更', 'api' => 'ListIntervalAgentReport'], + ], + 'createdAt' => '2023-05-23T11:59:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListAgentStateLogs'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2023-05-10T07:29:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListMultiChannelRecordings'], + ], + 'createdAt' => '2023-05-08T07:40:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'BlindTransfer'], + ['description' => '请求参数发生变更', 'api' => 'InitiateAttendedTransfer'], + ], + 'createdAt' => '2023-04-25T07:34:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ModifyUser'], + ['description' => '请求参数发生变更', 'api' => 'RemoveUsers'], + ], + 'createdAt' => '2023-04-14T05:54:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'BlindTransfer'], + ['description' => '请求参数发生变更', 'api' => 'InitiateAttendedTransfer'], + ], + 'createdAt' => '2023-04-12T02:15:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListCallDetailRecords'], + ], + 'createdAt' => '2023-03-24T08:21:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'RedialCall'], + ], + 'createdAt' => '2022-12-30T02:50:22.000Z', + 'description' => 'Redia接口参数调整', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListCallDetailRecords'], + ], + 'createdAt' => '2022-12-07T10:57:14.000Z', + 'description' => '- Support ListCallDetailRecords DialingTime response.', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'ListLegacyAppraiseLogs'], + ], + 'createdAt' => '2022-12-06T08:58:56.000Z', + 'description' => '- Add ListAppraiseLogs api.', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ChangeWorkMode'], + ], + 'createdAt' => '2022-11-28T07:11:28.000Z', + 'description' => '修改工作模式增加签入技能组和移动号码参数', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'PollUserStatus'], + ], + 'createdAt' => '2022-11-28T06:52:47.000Z', + 'description' => '增加CallVariables', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListSkillGroupStates'], + ], + 'createdAt' => '2022-11-25T02:04:46.000Z', + 'description' => '- ListSkillGroupStates support inbound/outbound agent count by inbound/outbound.', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetAudioFile'], + ['description' => '响应参数发生变更', 'api' => 'ListAudioFiles'], + ], + 'createdAt' => '2022-10-17T02:12:18.000Z', + 'description' => '删除录音相关接口中无效的返回字段。', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListRealtimeAgentStates'], + ], + 'createdAt' => '2022-10-17T02:12:17.000Z', + 'description' => '- ListRealtimeAgentStates支持Query和CallTypeList查询', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListAgentStates'], + ], + 'createdAt' => '2022-10-17T02:12:16.000Z', + 'description' => '- 增加excludeOfflineUsers查询参数', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetCallDetailRecord'], + ['description' => '响应参数发生变更', 'api' => 'ListCallDetailRecords'], + ], + 'createdAt' => '2022-10-14T06:48:16.000Z', + 'description' => '- Supported releaseReason response', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'StartPrivacyCall'], + ], + 'createdAt' => '2022-09-07T02:00:28.000Z', + 'description' => 'StartPrivacyCall提供Open Api', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'GetUploadAudioDataParams'], + ], + 'createdAt' => '2022-08-24T07:35:41.000Z', + 'description' => '- support api for getting quality check params', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ListRealtimeAgentStates'], + ], + 'createdAt' => '2022-07-12T04:34:09.000Z', + 'description' => '变更ListRealtimeAgentStates接口的SkillgroupId参数的文档必填熟悉为关闭。', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'ListLegacyAgentEventLogs'], + ['description' => 'OpenAPI 下线', 'api' => 'ListLegacyAgentStatusLogs'], + ['description' => 'OpenAPI 下线', 'api' => 'ListLegacyQueueEventLogs'], + ], + 'createdAt' => '2022-07-05T09:31:50.000Z', + 'description' => '- support legacy api', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListSkillGroupStates'], + ], + 'createdAt' => '2022-07-04T11:52:53.000Z', + 'description' => '- 返回技能组仅外呼空闲坐席数量', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListHistoricalAgentReport'], + ], + 'createdAt' => '2022-07-04T11:50:45.000Z', + 'description' => '- ListHistoricalAgentReport返回技能组相关信息', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListAgentStates'], ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], + 'createdAt' => '2022-07-01T13:18:19.000Z', + 'description' => '- 新增仅外呼状态返回值', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListPhoneNumbers'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'createdAt' => '2022-06-30T08:59:40.000Z', + 'description' => '删除ListPhoneNumbers中无效的返回字段。', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListSkillGroupStates'], + ['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc-test', - ], - ], - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'AI任务ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'f780ade8-****-458b-b067-63077946a570', - ], - ], - [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => '任务类型。'."\n" - .'- Abstract:fields（字段抽取）'."\n" - .'- Abstract:keywords（热词）'."\n" - .'- Abstract:title_summary（小结）', - 'type' => 'string', - 'required' => false, - 'example' => 'Abstract:fields'."\n", - ], - ], - [ - 'name' => 'Feedback', - 'in' => 'query', - 'schema' => [ - 'description' => '用户回流的数据。', - 'type' => 'string', - 'required' => false, - 'example' => '{"问题描述":"客户询问沙发生产周期并尝试加快", "客服方案":"订单确认，建议联系在线客服", "完成度判断":"否"}'."\n", - ], - ], - [ - 'name' => 'Rating', - 'in' => 'query', - 'schema' => [ - 'description' => '评价：'."\n" - .'- thumbsDown：点踩。 '."\n" - .'- thumbsUp：点赞。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'thumbsUp', - ], - ], + 'createdAt' => '2022-06-15T03:11:04.000Z', + 'description' => '- 支持acc部分字段', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListSkillGroupStates'], + ['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C81FD1A5-4B99-470A-A527-D80150228784', - ], - ], - ], - ], + 'createdAt' => '2022-06-07T11:35:47.000Z', + 'description' => '- 增加10秒服务水平', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListRealtimeAgentStates'], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Parameter.Format', - 'errorMessage' => 'The format of parameter %s is invalid. %s', - ], - [ - 'errorCode' => 'Parameter.Blank', - 'errorMessage' => 'The parameter %s may not be null or blank.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalService.Common', - 'errorMessage' => 'An internal service error occurred. %s', - ], - ], + 'createdAt' => '2022-05-25T03:04:15.000Z', + 'description' => '- 增加ListRealtimeAgentStates返回参数WorkMode/OutboundScenario', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'ImportAdmins'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2022-04-20T06:13:53.000Z', + 'description' => 'Support ImportAdmin', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateCampaign'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C81FD1A5-4B99-470A-A527-D80150228784\\"\\n}","type":"json"}]', - 'title' => 'AI总结打分', - 'summary' => '使用AddFeedback接口对AI功能进行评价打分。', + 'createdAt' => '2022-04-18T03:06:59.000Z', + 'description' => 'CreateCamapign支持SP参数', ], - 'GetUploadAudioDataParams' => [ - 'summary' => '获取离线质检音频文件相关参数。一般情况下，如果客户在云联络中心中配置了质检功能，则需要离线质检的音频文件和相应的参数会自动传递给智能质检；只有当客户没有在云联络中心中配置质检功能，并且希望自己把云联络中心的录音推送给质检时才需要调用此接口获取推送质检录音的相关参数。', - 'methods' => [ - 'get', + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'AnswerCall'], + ['description' => '响应参数发生变更', 'api' => 'BlindTransfer'], + ['description' => '响应参数发生变更', 'api' => 'LaunchSurvey'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-03-15T12:26:19.000Z', + 'description' => '增加消息顺序号', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], - ], + 'createdAt' => '2022-03-10T06:25:38.000Z', + 'description' => '支持技能组30秒服务水平统计', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetCallDetailRecord'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '云联络中心实例ID', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'job-38860977107324****', - ], - ], + 'createdAt' => '2022-03-03T08:33:51.000Z', + 'description' => '增加坐席事件时长', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetUser'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID,可用于接口的日志查询', - 'type' => 'string', - 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', - ], - 'Data' => [ - 'description' => '数据。'."\n", - 'type' => 'object', - 'properties' => [ - 'ParamsStr' => [ - 'description' => '离线质检音频文件相关参数', - 'type' => 'string', - 'example' => '{'."\n" - .' "autoSplit": 1,'."\n" - .' "appKey": ****,'."\n" - .' "sampleRate": 8,'."\n" - .' "callList": ['."\n" - .' {'."\n" - .' "callId": "job-46686139435843****",'."\n" - .' "validTimes": ['."\n" - .' {'."\n" - .' "begin_time": 0,'."\n" - .' "end_time": 30720,'."\n" - .' "speaker_id": "张**"'."\n" - .' }'."\n" - .' ],'."\n" - .' "resolveType": "ali-ACC",'."\n" - .' "instance": "c****",'."\n" - .' "callee": "153****",'."\n" - .' "accUid": 105****967,'."\n" - .' "callStartTime": 1704870035381,'."\n" - .' "customerServiceName": "张**",'."\n" - .' "tid": "2ccd8732-62ed-****b9",'."\n" - .' "callType": 1,'."\n" - .' "skillGroupUUID": "skg-default@c****",'."\n" - .' "caller": "2023****",'."\n" - .' "customerServicePhone": "80****54",'."\n" - .' "channels": ['."\n" - .' {'."\n" - .' "speaker_id": "张**",'."\n" - .' "channel_key": "ch-user-153****-80****54-1704870030317-job-46686139435843****"'."\n" - .' }'."\n" - .' ],'."\n" - .' "sourceType": 1,'."\n" - .' "channelKey": "ch-user-153****-80****54-1704870030317-job-46686139435843****",'."\n" - .' "skillGroupName": "金****",'."\n" - .' "voiceFileUrl": "https://ccc-***.oss-cn-****.aliyuncs.com/ccc-****/c****/2024/01/job-46686139435843****.mkv?Expires=****&OSSAccessKeyId=****&Signature=****",'."\n" - .' "skillGroupId": 0,'."\n" - .' "customerServiceId": 203242802****'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], - ], - ], - ], - ], - ], + 'createdAt' => '2022-02-28T07:49:12.000Z', + 'description' => 'GetUser接口返回参数增加DisplayId工号字段', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'ListAgentSummaryReportsSinceMidnight'], + ['description' => 'OpenAPI 下线', 'api' => 'ListSkillGroupStates'], + ['description' => 'OpenAPI 下线', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Data\\": {\\n \\"ParamsStr\\": \\"{\\\\n \\\\\\"autoSplit\\\\\\": 1,\\\\n \\\\\\"appKey\\\\\\": ****,\\\\n \\\\\\"sampleRate\\\\\\": 8,\\\\n \\\\\\"callList\\\\\\": [\\\\n {\\\\n \\\\\\"callId\\\\\\": \\\\\\"job-46686139435843****\\\\\\",\\\\n \\\\\\"validTimes\\\\\\": [\\\\n {\\\\n \\\\\\"begin_time\\\\\\": 0,\\\\n \\\\\\"end_time\\\\\\": 30720,\\\\n \\\\\\"speaker_id\\\\\\": \\\\\\"张**\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"resolveType\\\\\\": \\\\\\"ali-ACC\\\\\\",\\\\n \\\\\\"instance\\\\\\": \\\\\\"c****\\\\\\",\\\\n \\\\\\"callee\\\\\\": \\\\\\"153****\\\\\\",\\\\n \\\\\\"accUid\\\\\\": 105****967,\\\\n \\\\\\"callStartTime\\\\\\": 1704870035381,\\\\n \\\\\\"customerServiceName\\\\\\": \\\\\\"张**\\\\\\",\\\\n \\\\\\"tid\\\\\\": \\\\\\"2ccd8732-62ed-****b9\\\\\\",\\\\n \\\\\\"callType\\\\\\": 1,\\\\n \\\\\\"skillGroupUUID\\\\\\": \\\\\\"skg-default@c****\\\\\\",\\\\n \\\\\\"caller\\\\\\": \\\\\\"2023****\\\\\\",\\\\n \\\\\\"customerServicePhone\\\\\\": \\\\\\"80****54\\\\\\",\\\\n \\\\\\"channels\\\\\\": [\\\\n {\\\\n \\\\\\"speaker_id\\\\\\": \\\\\\"张**\\\\\\",\\\\n \\\\\\"channel_key\\\\\\": \\\\\\"ch-user-153****-80****54-1704870030317-job-46686139435843****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"sourceType\\\\\\": 1,\\\\n \\\\\\"channelKey\\\\\\": \\\\\\"ch-user-153****-80****54-1704870030317-job-46686139435843****\\\\\\",\\\\n \\\\\\"skillGroupName\\\\\\": \\\\\\"金****\\\\\\",\\\\n \\\\\\"voiceFileUrl\\\\\\": \\\\\\"https://ccc-***.oss-cn-****.aliyuncs.com/ccc-****/c****/2024/01/job-46686139435843****.mkv?Expires=****&OSSAccessKeyId=****&Signature=****\\\\\\",\\\\n \\\\\\"skillGroupId\\\\\\": 0,\\\\n \\\\\\"customerServiceId\\\\\\": 203242802****\\\\n }\\\\n ]\\\\n}\\"\\n }\\n}","type":"json"}]', - 'title' => '获取离线质检音频相关参数', + 'createdAt' => '2022-02-28T02:23:52.000Z', + 'description' => 'ACC专用接口', ], - 'ListFeedbacks' => [ - 'summary' => '查询反馈记录', - 'methods' => [ - 'get', - 'post', + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateCustomCallTagging'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteCustomCallTagging'], + ['description' => 'OpenAPI 下线', 'api' => 'ListCustomCallTagging'], + ['description' => 'OpenAPI 下线', 'api' => 'ModifyCustomCallTagging'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-02-24T14:32:10.000Z', + 'description' => '公开云呼2.0黑名单相关接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateCallTags'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteCallTag'], + ['description' => 'OpenAPI 下线', 'api' => 'ExportCustomCallTagging'], + ['description' => 'OpenAPI 下线', 'api' => 'ExportDoNotCallNumbers'], + ['description' => 'OpenAPI 下线', 'api' => 'GetDoNotCallFileUploadParameters'], + ['description' => 'OpenAPI 下线', 'api' => 'ImportCustomCallTagging'], + ['description' => 'OpenAPI 下线', 'api' => 'ImportDoNotCallNumbers'], + ['description' => 'OpenAPI 下线', 'api' => 'ListCallTags'], + ['description' => 'OpenAPI 下线', 'api' => 'ListDoNotCallNumbers'], + ['description' => 'OpenAPI 下线', 'api' => 'RemoveDoNotCallNumbers'], + ], + 'createdAt' => '2022-02-24T13:01:42.000Z', + 'description' => '公开云呼2.0黑名单相关接口', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetCallDetailRecord'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-02-23T06:55:22.000Z', + 'description' => 'GetCallDetailRecord接口返回值中，增加FlowType字段，MAIN_FLOW / SURVEY_FLOW， 分别标识主流成和满意度调查流程', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateUser'], + ['description' => '请求参数发生变更', 'api' => 'ModifyUser'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', + 'createdAt' => '2022-02-21T07:56:04.000Z', + 'description' => '创建/修改用户接口添加工号的入参。', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetLoginDetails'], + ['description' => '响应参数发生变更', 'api' => 'GetUser'], + ['description' => '响应参数发生变更', 'api' => 'ListUsers'], + ['description' => 'OpenAPI 下线', 'api' => 'RegisterDevices'], + ['description' => '响应参数发生变更', 'api' => 'ReleaseCall'], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '呼叫中心实例ID', - 'type' => 'string', - 'required' => false, - 'example' => 'ccc-test'."\n", - ], - ], - [ - 'name' => 'TaskIdList', - 'in' => 'query', - 'schema' => [ - 'description' => '任务ID列表', - 'type' => 'string', - 'required' => false, - 'example' => '["20251216-8B9B7B02-16FE-54BE-942A-F59DE0656032"]', - ], - ], + 'createdAt' => '2022-01-19T15:24:03.000Z', + 'description' => '支持SIP话机配置', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetLoginDetails'], ], - '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' => '26E54929-CA86-1035-9B42-0C8F291BB027', - ], - 'HttpStatusCode' => [ - 'description' => 'HTTP状态码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Code' => [ - 'description' => '响应码', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '返回的数据集合', - 'type' => 'array', - 'items' => [ - 'description' => '返回的数据元素', - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'ccc-test', - ], - 'TaskId' => [ - 'description' => '任务ID。', - 'type' => 'string', - 'example' => '20251216-8B9B7B02-16FE-54BE-942A-F59DE0656032', - ], - 'TaskName' => [ - 'description' => '任务名称。', - 'type' => 'string', - 'example' => 'PostCallAnalyzer:solution', - ], - 'UserResponse' => [ - 'description' => '用户反馈的数据', - 'type' => 'string', - 'example' => 'xxxxxxx', - ], - 'UserRating' => [ - 'description' => '用户对此任务的评分', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-1', - ], - 'ContactId' => [ - 'description' => '通话ID。', - 'type' => 'string', - 'example' => 'job-25920271311543****', - ], - ], - ], - ], - ], - ], - ], + 'createdAt' => '2021-12-22T06:06:04.000Z', + 'description' => 'GetLoginDetails返回值增加WorkMode', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'StartPredictiveCall'], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'NotExist.Instance', - 'errorMessage' => 'Call center instance %s does not exist.', - ], - ], + 'createdAt' => '2021-12-16T13:15:34.000Z', + 'description' => 'Request增加技能组参数', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'MakeCall'], + ['description' => '请求参数发生变更', 'api' => 'StartPredictiveCall'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2021-12-01T09:27:12.000Z', + 'description' => '增加注销话机接口', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetCallDetailRecord'], + ['description' => '响应参数发生变更', 'api' => 'ListCallDetailRecords'], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'createdAt' => '2021-09-08T02:46:28.000Z', + 'description' => '增加主叫归属地callerLocation和被叫归属地calleeLocation, 部分号码查询不到归属地信息时，该字段为null', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'StartPredictiveCall'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"26E54929-CA86-1035-9B42-0C8F291BB027\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TaskId\\": \\"20251216-8B9B7B02-16FE-54BE-942A-F59DE0656032\\",\\n \\"TaskName\\": \\"PostCallAnalyzer:solution\\",\\n \\"UserResponse\\": \\"xxxxxxx\\",\\n \\"UserRating\\": -1,\\n \\"ContactId\\": \\"job-25920271311543****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询反馈记录', + 'createdAt' => '2021-08-20T10:37:34.000Z', + 'description' => '后台外呼接口上线', ], - ], - 'endpoints' => [ [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'ccc.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'MakeCall'], + ], + 'createdAt' => '2021-08-18T13:14:49.000Z', + 'description' => 'MakeCall增加随路数据', ], ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVoicemailRecording'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalCampaignReport'], + ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentStateLogs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCallTag'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportCorpNumbers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumberFromSkillGroups'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPhoneNumbers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCallTags'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDoNotCallFileUploadParameters'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsersFromSkillGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportDoNotCallNumbers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportCustomCallTagging'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillLevelsOfUser'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUnassignedNumbers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstancesOfUser'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterDevices'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseCampaign'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVoicemails'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIvrTrackingDetails'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBriefSkillGroups'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnmuteCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAudioFiles'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssignUsers'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConfigItems'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaignTrendingReport'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEarlyMediaRecording'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrivilegesOfUser'], + ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroupStates'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallTags'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyAgentEventLogs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustomCallTagging'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListContactFlows'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPersonalNumbersOfUser'], + ['threshold' => '1100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPredictiveCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAudioFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFileUploadParameters'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCampaign'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMultiChannelRecordings'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishContactFlow'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSkillGroupsFromUser'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRealtimeAgentStates'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LaunchAuthentication'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalInstanceReport'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomCallTagging'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAttempts'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetUserPassword'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCampaign'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTurnServerList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportDoNotCallNumbers'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnswerCall'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallDetailRecords'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendDtmfSignaling'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRecentCallDetailRecords'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyAgentStatusLogs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySkillGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUser'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDevices'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RetrieveCall'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroups'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HoldCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePersonalNumbersFromUser'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAudioFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroup'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUploadAudioDataParams'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetContactFlow'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCaseFileUploadUrl'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReadyForService'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMultiChannelRecording'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BargeInCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartEditContactFlow'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealtimeCampaignStats'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportCustomCallTagging'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveDoNotCallNumbers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalCallerReport'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPrivacyCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUserLevelsOfSkillGroup'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SaveTerminalLog'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateContactFlow'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLoginDetails'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSkillGroupsToUser'], + ['threshold' => '400', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMonoRecording'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPhoneNumbers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddNumbersToSkillGroup'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAgentState'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAudioFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeWorkMode'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTurnCredentials'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EndConference'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportAdmins'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalSkillGroupReport'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MonitorCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDoNotCallNumbers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSkillGroup'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AppendCases'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BlindTransfer'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceTrendingReport'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchToConference'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnregisterDevice'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LaunchSurvey'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySkillLevelsOfUser'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserLevelsOfSkillGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DiscardEditingContactFlow'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoles'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCallDetailRecord'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPhoneNumber'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CoachCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUser'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPersonalNumbersToUser'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalAgentReport'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InterceptCall'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestoreArchivedRecordings'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFileDownloadUrl'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalInstanceReport'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalAgentSkillGroupReport'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentStates'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomCallTagging'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartBack2BackCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalAgentSkillGroupReport'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumbersFromSkillGroup'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CompleteAttendedTransfer'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomCallTagging'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNumberLocation'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRamUsers'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MuteCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalAgentReport'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContactFlow'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumbers'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelAttendedTransfer'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeCampaign'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TakeBreak'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalSkillGroupReport'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConversationDetail'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitiateAttendedTransfer'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MakeCall'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUsersToSkillGroup'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConfigItems'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SignInGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCampaign'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealtimeInstanceStates'], + ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RedialCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPhoneNumberToSkillGroups'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartConference'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterDevice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCases'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyQueueEventLogs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstance'], + ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentSummaryReportsSinceMidnight'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOutboundNumbersOfUser'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMonoRecordings'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddCases'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PollUserStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbortCampaign'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaigns'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPhoneNumbersOfSkillGroup'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SignOutGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRealtimeSkillGroupStates'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSkillGroup'], + ], + 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], + ], + 'ram' => [ + 'productCode' => 'CloudCallCenter', + 'productName' => '云联络中心', + 'ramCodes' => ['ccc'], + 'ramLevel' => '操作级', + 'ramConditions' => [], + 'ramActions' => [], + 'resourceTypes' => [], + ], ]; -- cgit v1.2.3