diff options
Diffstat (limited to 'data/zh_cn/ccc/2020-07-01')
| -rw-r--r-- | data/zh_cn/ccc/2020-07-01/api-docs.php | 55611 |
1 files changed, 55611 insertions, 0 deletions
diff --git a/data/zh_cn/ccc/2020-07-01/api-docs.php b/data/zh_cn/ccc/2020-07-01/api-docs.php new file mode 100644 index 0000000..d924900 --- /dev/null +++ b/data/zh_cn/ccc/2020-07-01/api-docs.php @@ -0,0 +1,55611 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'CCC', + 'version' => '2020-07-01', + ], + 'directories' => [ + [ + 'id' => 168396, + 'title' => '权限', + 'type' => 'directory', + 'children' => [ + 'ListPrivilegesOfUser', + 'ListRoles', + ], + ], + [ + 'id' => 168399, + 'title' => '实例', + 'type' => 'directory', + 'children' => [ + 'DeleteInstance', + 'CreateInstance', + 'GetInstance', + 'ListInstances', + 'ListInstancesOfUser', + 'ModifyInstance', + ], + ], + [ + 'id' => 168405, + 'title' => '号码', + 'type' => 'directory', + 'children' => [ + 'AddPersonalNumbersToUser', + 'AddPhoneNumbers', + 'AddPhoneNumberToSkillGroups', + 'ListOutboundNumbersOfUser', + 'ListPersonalNumbersOfUser', + 'ListPhoneNumbers', + 'ListPhoneNumbersOfSkillGroup', + 'ListUnassignedNumbers', + 'ModifyPhoneNumber', + 'ImportCorpNumbers', + 'RemovePersonalNumbersFromUser', + 'RemovePhoneNumberFromSkillGroups', + 'RemovePhoneNumbers', + 'RemovePhoneNumbersFromSkillGroup', + ], + ], + [ + 'id' => 168421, + 'title' => '技能组', + 'type' => 'directory', + 'children' => [ + 'AddNumbersToSkillGroup', + 'AddUsersToSkillGroup', + 'CreateSkillGroup', + 'DeleteSkillGroup', + 'GetSkillGroup', + 'ListBriefSkillGroups', + 'ListSkillGroups', + 'ListSkillLevelsOfUser', + 'ModifySkillGroup', + 'ModifySkillLevelsOfUser', + 'RemoveSkillGroupsFromUser', + ], + ], + [ + 'id' => 168433, + 'title' => '坐席', + 'type' => 'directory', + 'children' => [ + 'ImportRamUsers', + 'ChangeVisibility', + 'AddSkillGroupsToUser', + 'AssignUsers', + 'ChangeWorkMode', + 'CreateUser', + 'GetUser', + 'ImportAdmins', + 'ListDevices', + 'ListRamUsers', + 'ListUserLevelsOfSkillGroup', + 'ListUsers', + 'ModifyUser', + 'ModifyUserLevelsOfSkillGroup', + 'RegisterDevice', + 'RegisterDevices', + 'RemoveUsers', + 'RemoveUsersFromSkillGroup', + 'ResetAgentState', + 'ResetUserPassword', + 'UnregisterDevice', + ], + ], + [ + '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', + ], + ], + [ + 'id' => 168487, + 'title' => '预测式外呼', + 'type' => 'directory', + 'children' => [ + 'ModifyCampaignNumbers', + 'AbortCampaign', + 'AddCases', + 'AppendCases', + 'CreateCampaign', + 'GetCampaign', + 'GetCaseFileUploadUrl', + 'GetHistoricalCampaignReport', + 'GetRealtimeCampaignStats', + 'ListAttempts', + 'ListCampaigns', + 'ListCampaignTrendingReport', + 'ListCases', + 'PauseCampaign', + 'ResumeCampaign', + 'UpdateCampaign', + 'SubmitCampaign', + ], + ], + [ + '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', + ], + ], + [ + 'id' => 171708, + 'title' => '录音', + 'type' => 'directory', + 'children' => [ + 'RestoreArchivedRecordings', + 'GetMonoRecording', + 'GetMultiChannelRecording', + 'GetVoicemailRecording', + 'GetEarlyMediaRecording', + 'ListMultiChannelRecordings', + 'ListMonoRecordings', + ], + ], + [ + 'id' => 168531, + 'title' => '音频', + 'type' => 'directory', + 'children' => [ + 'CreateAudioFile', + 'DeleteAudioFile', + 'GetAudioFile', + 'GetAudioFileDownloadUrl', + 'GetAudioFileUploadParameters', + 'ListAudioFiles', + 'ModifyAudioFile', + ], + ], + [ + 'id' => 168539, + 'title' => '配置', + 'type' => 'directory', + 'children' => [ + 'GetLoginDetails', + 'GetTurnCredentials', + 'GetTurnServerList', + 'ListConfigItems', + 'UpdateConfigItems', + ], + ], + [ + 'id' => 282482, + 'title' => 'IM', + 'type' => 'directory', + 'children' => [ + 'ProcessCustomIMCallback', + 'CreateChatMediaUrl', + 'ListVisitorChatMessages', + 'GetChatRoutingProfile', + 'UpdateChatRoutingProfile', + 'GetChatMediaUrl', + 'ListWaitingChats', + 'ClaimChat', + 'ReleaseChat', + 'StartChat', + 'RejectChat', + 'GetVisitorLoginDetails', + 'AcceptChat', + ], + ], + [ + 'id' => 282483, + 'title' => '工单', + 'type' => 'directory', + 'children' => [ + 'FinishTicketTask', + 'UpdateTicket', + 'GetTicket', + 'ListCommonTicketFields', + 'TerminateTicket', + 'GetTicketSummaryReport', + 'ResubmitTicket', + 'DeleteTicketTemplate', + 'RejectTicket', + 'DisableTicketTemplate', + 'WithdrawTicket', + 'ListTicketTasks', + 'ListTickets', + 'TransferTicketTask', + 'DeleteTicket', + 'EnableTicketTemplate', + 'AddTicketTask', + 'ListTicketTemplates', + 'CreateTicket', + 'ListCategories', + 'GetTicketTemplate', + ], + ], + [ + 'id' => 168545, + 'title' => '呼入控制', + 'type' => 'directory', + 'children' => [ + 'AddBlacklistCallTagging', + 'CreateCallTags', + 'CreateCustomCallTagging', + 'DeleteCallTag', + 'DeleteCustomCallTagging', + 'ExportCustomCallTagging', + 'ImportCustomCallTagging', + 'ListBlacklistCallTaggings', + 'ListCallTags', + 'ListCustomCallTagging', + 'ModifyCustomCallTagging', + 'RemoveBlacklistCallTagging', + ], + ], + [ + 'id' => 168555, + 'title' => '外呼控制', + 'type' => 'directory', + 'children' => [ + 'ExportDoNotCallNumbers', + 'GetDoNotCallFileUploadParameters', + 'ImportDoNotCallNumbers', + 'ListDoNotCallNumbers', + 'RemoveDoNotCallNumbers', + ], + ], + [ + 'id' => 282484, + 'title' => '短信', + 'type' => 'directory', + 'children' => [ + 'ListFlashSmsSettings', + 'ListFlashSmsApplications', + 'ListFlashSmsTemplates', + 'ListSmsMetadata', + ], + ], + [ + 'id' => 168419, + 'title' => 'IVR', + 'type' => 'directory', + 'children' => [ + 'ExportContactFlow', + 'ImportContactFlow', + 'CreateContactFlow', + 'ListContactFlows', + 'GetContactFlow', + 'StartEditContactFlow', + 'CommitContactFlow', + 'PublishContactFlow', + 'DiscardEditingContactFlow', + 'DeleteContactFlow', + ], + ], + [ + 'id' => 192288, + 'title' => '客户', + 'type' => 'directory', + 'children' => [ + 'DeleteSchemaProperty', + 'DisableSchemaProperty', + 'EnableSchemaProperty', + 'GetSchema', + 'DeleteSchema', + 'GetDocumentUploadParameters', + 'UpdateSchemaProperty', + 'SaveDocument', + 'DeleteDocuments', + 'DeleteDocument', + 'ListDocuments', + 'ImportDocuments', + 'CreateSchema', + 'AddSchemaProperty', + ], + ], + [ + 'id' => 282485, + 'title' => '坐席辅助', + 'type' => 'directory', + 'children' => [ + 'GetSummaryTemplate', + 'UpdateCallSummary', + 'CreateCallSummary', + 'ListCallSummaries', + 'AnalyzeConversation', + 'AddFeedback', + ], + ], + [ + 'id' => 282486, + 'title' => '质检', + 'type' => 'directory', + 'children' => [ + 'GetUploadAudioDataParams', + ], + ], + [ + 'id' => 365417, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'ListFeedbacks', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'ListPrivilegesOfUser' => [ + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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 {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Scope\\": \\"SELF_ONLY\\",\\n \\"Name\\": \\"Workbench:Call\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Scope>SELF_ONLY</Scope>\\n <InstanceId>ccc-test</InstanceId>\\n <Name>Workbench:Call</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取坐席的权限列表', + 'summary' => '调用ListPrivilegesOfUser获取当前用户拥有的权限。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListRoles' => [ + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Parameter.Invalid', + 'errorMessage' => 'The parameter %s is invalid. %s.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '251524', + 'abilityTreeNodes' => [ + 'FEATUREccc8HB4RI', + ], + ], + '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', + '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' => '无', + ], + ], + ], + ], + ], + ], + '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\\": \\"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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREcccTMAX45', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + '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' => '云联络中心的测试实例。', + ], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '云联络中心实例的二级域名，即实例ID，全局唯一。长度为4-48个字符，仅可包含大小写英文字母、数字、下划线（_）和短横线（-）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc-test', + ], + ], + [ + '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' => '数据，返回的是后台创建实例的工作流的ID。', + 'type' => 'string', + 'example' => '75c1346c-1dc2-4ed8-973f-edf8b1e5fe77', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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' => '创建实例', + ], + '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' => '[email protected]', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 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\\": \\"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\\": \\"[email protected]\\",\\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', + ], + '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', + ], + ], + ], + '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' => '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' => '[email protected]', + ], + '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****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"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\\": \\"[email protected]\\",\\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）。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListInstancesOfUser' => [ + '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', + ], + ], + ], + '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' => '[email protected]', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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\\": \\"[email protected]\\",\\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":"<RequestId>3969FC68-CEC2-4398-B76A-60D2F7EDEBAF</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Status>RUNNING</Status>\\n <Description>测试实例</Description>\\n <DomainName>ccc-test</DomainName>\\n <ConsoleUrl>https://ccc-v2.aliyun.com/#/workbench/ccc-test</ConsoleUrl>\\n <AliyunUid>157123456789****</AliyunUid>\\n <Id>ccc-test</Id>\\n <Name>云呼测试实例</Name>\\n <AdminList>\\n <Extension>8032****</Extension>\\n <LoginName>user-test</LoginName>\\n <RoleName>Admin</RoleName>\\n <Email>1886666****@163.com</Email>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <DisplayName>云呼测试1</DisplayName>\\n <RoleId>Admin@ccc-test</RoleId>\\n <Mobile>1382114****</Mobile>\\n <WorkMode>ON_SITE</WorkMode>\\n </AdminList>\\n <NumberList>\\n <Usage>Bidirection</Usage>\\n <Active>true</Active>\\n <Number>0830011****</Number>\\n <InstanceId>ccc-test</InstanceId>\\n <ContactFlowId>a3fb6c62-9b49-4942-ae5b-cf2abd4123ek</ContactFlowId>\\n <UserId>user-test@ccc-test</UserId>\\n <City>乐山</City>\\n <Province>四川</Province>\\n <SkillGroups>\\n <Description>测试</Description>\\n <PhoneNumberCount>1</PhoneNumberCount>\\n <InstanceId>ccc-test</InstanceId>\\n <UserCount>2</UserCount>\\n <DisplayName>测试技能组</DisplayName>\\n <SkillGroupId>test@ccc-test</SkillGroupId>\\n <Name>test</Name>\\n </SkillGroups>\\n </NumberList>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取用户所属的实例列表', + 'summary' => '调用ListInstancesOfUser获取用户所属的云联络中心实例列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyInstance' => [ + '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' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的描述，长度不超过256个字符。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '新的实例描述。', + ], + ], + ], + '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' => '83TKE671A-3E24-4A04-81E6-6C4F5B39DF75', + ], + 'Data' => [ + 'description' => '数据。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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":"<RequestId>83TKE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>无</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '修改实例', + 'summary' => '调用ModifyInstance修改云联络中心实例。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddPersonalNumbersToUser' => [ + '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' => 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' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', + ], + 'Data' => [ + 'description' => '添加失败的号码列表。', + 'type' => 'array', + 'items' => [ + 'description' => '号码', + 'type' => 'string', + 'example' => '0101234****', + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 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\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": [\\n \\"0101234****\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>[\\"0100xxxx009\\"]</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '添加多个号码到坐席', + 'summary' => '调用AddPersonalNumbersToUser添加一个或多个个人外呼号码到指定实例下的指定坐席。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddPhoneNumbers' => [ + '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' => 'ContactFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '绑定的IVR联系流ID，仅当号码用途包含呼入时，该参数才有效，非必填，默认为空。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dDMD_0mif4hv', + ], + ], + [ + 'name' => 'Usage', + 'in' => 'query', + 'schema' => [ + 'description' => '号码的用途，注意，如果传入的号码为400号码，则用途只能填Inbound。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + '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' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + ], + 'Data' => [ + 'description' => '添加失败的号码列表。', + 'type' => 'array', + 'items' => [ + 'description' => '号码。', + 'type' => 'string', + 'example' => '0101234****', + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>无</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '添加号码', + 'summary' => '调用AddPhoneNumbers添加一个或多个号码到指定实例下。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddPhoneNumberToSkillGroups' => [ + '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' => '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' => [ + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '添加号码到多个技能组', + 'summary' => '调用AddPhoneNumberToSkillGroups将号码关联到指定实例下的一个或多个技能组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListOutboundNumbersOfUser' => [ + 'summary' => '调用ListOutboundNumbersOfUser获取指定实例下指定坐席的可外呼号码。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + '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' => true, + 'docRequired' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '坐席ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'agent@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' => 'SkillGroupIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '签入技能组ID列表，非必填，默认为空，表示查询UserId归属的所有技能组的外呼号码，如果有值，则查询该值指定的技能组下的外呼号码。注意，此处传入的技能组ID必须是UserId所在的技能组的ID。', + 'type' => 'string', + 'required' => false, + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + [ + '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\\": \\"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":"<TotalCount>1</TotalCount>\\n<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<PageSize>10</PageSize>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <City>乐山</City>\\n <Number>083xxxx0019</Number>\\n <Province>四川</Province>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取坐席的外呼号码列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPersonalNumbersOfUser' => [ + '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。', + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，范围1-100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'IsMember', + 'in' => 'query', + 'schema' => [ + 'description' => '是否关联坐席，若为true，则查询UserId关联的个人外呼号码列表，若为false，则查询UserId可关联但未关联的个人外呼号码列表。通常和AddPersonalNumbersToUser接口一起使用。', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'SearchPattern', + 'in' => 'query', + 'schema' => [ + 'description' => '根据号码进行模糊匹配，非必填，不填默认为空。', + 'type' => 'string', + 'required' => false, + 'example' => '0833', + ], + ], + ], + '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' => [ + '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', + ], + 'Province' => [ + '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.', + ], + ], + 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\\": 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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Active>true</Active>\\n <Number>083xxxx0011</Number>\\n <InstanceId>ccc-test</InstanceId>\\n <ContactFlowId>a3fb6c62-9b49-4942-ae5b-cf2abd4123ek</ContactFlowId>\\n <City>乐山</City>\\n <Province>四川</Province>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取坐席的个人号码列表', + 'summary' => '调用ListPersonalNumbersOfUser获取指定实例下指定坐席的个人外呼号码列表，也可通过该接口反查可添加为坐席个人外呼号码的号码列表。', + 'description' => '注意：如果号码已绑定了技能组，则不会出现在可作为个人外呼号码的号码列表中。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPhoneNumbers' => [ + 'summary' => '调用ListPhoneNumbers获取指定实例下的号码列表。', + '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' => 'SearchPattern', + 'in' => 'query', + 'schema' => [ + 'description' => '根据号码进行模糊匹配，非必填，默认为空，为空表示不过滤。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '0833', + ], + ], + [ + 'name' => 'Usage', + 'in' => 'query', + 'schema' => [ + 'description' => '号码的用途，非必填，默认为空，为空表示不过滤。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [ + 'Outbound' => '呼出', + 'Inbound' => '呼入', + 'Bidirection' => '呼入和呼出', + ], + 'example' => 'Bidirection', + 'maxLength' => 200, + 'minLength' => 1, + ], + ], + [ + 'name' => 'Active', + 'in' => 'query', + 'schema' => [ + 'description' => '号码是否可用，非必填，默认为空，为空表示不过滤。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => 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' => '20', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<PageSize>20</PageSize>\\n<Message>无</Message>\\n<PageNumber>1</PageNumber>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Usage>Bidirection</Usage>\\n <Active>true</Active>\\n <Number>083xxxx0011</Number>\\n <InstanceId>ccc-test</InstanceId>\\n <ContactFlowId>a3fb6c62-9b49-4942-ae5b-cf2abd4123ek</ContactFlowId>\\n <UserId>user-test@ccc-test</UserId>\\n <CreateTime>1617958538000</CreateTime>\\n <ContactFlowName>测试IVR</ContactFlowName>\\n <City>乐山</City>\\n <Tags>M1</Tags>\\n <Province>四川</Province>\\n <Provider>ali</Provider>\\n <SkillGroups>\\n <InstanceId>ccc-test</InstanceId>\\n <DisplayName>测试技能组</DisplayName>\\n <SkillGroupId>test@ccc-test</SkillGroupId>\\n <Name>test</Name>\\n </SkillGroups>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取号码列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPhoneNumbersOfSkillGroup' => [ + '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' => 'SkillGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '技能组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + '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' => 'IsMember', + 'in' => 'query', + 'schema' => [ + 'description' => '是否关联技能组，若为true，则查询SkillgroupId关联的号码列表，若为false，则查询SkillgroupId可关联但未关联的号码列表。通常和AddNumbersToSkillGroup接口一起使用。', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'SearchPattern', + 'in' => 'query', + 'schema' => [ + 'description' => '根据号码进行模糊匹配，非必填，默认为空，为空表示不过滤。', + 'type' => 'string', + 'required' => false, + 'example' => '0833', + ], + ], + [ + 'name' => 'Active', + 'in' => 'query', + 'schema' => [ + 'description' => '号码是否可用，非必填，默认为空，为空表示不过滤。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + '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' => [ + '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', + ], + 'Usage' => [ + 'description' => '号码用途。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Outbound' => '呼出', + 'Inbound' => '呼入', + 'Bidirection' => '呼入和呼出', + ], + 'example' => 'Bidirection', + ], + 'ContactFlowId' => [ + 'description' => '号码关联的IVR联系流ID。', + 'type' => 'string', + 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek', + ], + 'Province' => [ + '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.', + ], + ], + 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 \\"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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Usage>Bidirection</Usage>\\n <Active>true</Active>\\n <Number>083xxxx0011</Number>\\n <InstanceId>ccc-test</InstanceId>\\n <ContactFlowId>a3fb6c62-9b49-4942-ae5b-cf2abd4123ek</ContactFlowId>\\n <City>乐山</City>\\n <Province>四川</Province>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取技能组的号码列表', + 'summary' => '调用ListPhoneNumbersOfSkillGroup获取指定实例下指定技能组关联的号码列表，也可以通过该接口反查未关联但可关联到该技能组的号码。', + 'description' => '注意：如果号码已作为个人外呼号码使用，则不会出现在可添加到技能组的号码列表中。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListUnassignedNumbers' => [ + 'summary' => '调用ListUnassignedNumbers获取阿里云主账号下未分配到实例的号码列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SearchPattern', + 'in' => 'query', + 'schema' => [ + 'description' => '根据号码进行模糊匹配，非必填，默认为空，为空表示不过滤。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '0833', + ], + ], + [ + '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。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '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' => '四川', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalService.ResourcePlatform', + 'errorMessage' => 'An internal ResourcePlatform service error occurred. %s', + ], + ], + ], + '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":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F\\t</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>20</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Usage>true</Usage>\\n <Active>true</Active>\\n <Number>083xxxx0011\\t</Number>\\n <City>乐山</City>\\n <Province>四川</Province>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取未分配号码列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyPhoneNumber' => [ + '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' => 'Number', + 'in' => 'query', + 'schema' => [ + 'description' => '号码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0102134****', + ], + ], + [ + 'name' => 'Usage', + 'in' => 'query', + 'schema' => [ + 'description' => '号码用途。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'Outbound' => '呼出', + 'Inbound' => '呼入', + 'Bidirection' => '呼入和呼出', + ], + 'example' => 'Bidirection', + 'maxLength' => 200, + 'minLength' => 1, + ], + ], + [ + 'name' => 'ContactFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '号码绑定的IVR联系流ID，仅在号码用途为Inbound或Bidirection时，该字段才有效。', + 'type' => 'string', + 'required' => false, + 'example' => '78128960-bb00-4ddc-8a82-923a8c5bd22d', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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.Number', + 'errorMessage' => 'The specified number %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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '修改号码', + 'summary' => '调用ModifyPhoneNumber修改指定实例下指定号码的信息，主要是修改号码用途和绑定的联系流ID。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ImportCorpNumbers' => [ + 'summary' => '导入自有线路号码，首次导入前，需联系云联络中心-售后技术支持进行加白。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREccc1MRAID', + ], + ], + 'parameters' => [ + [ + 'name' => 'NumberList', + 'in' => 'query', + 'schema' => [ + 'description' => '号码列表', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[\'029xxxxxx\']', + ], + ], + [ + 'name' => 'TagList', + 'in' => 'query', + 'schema' => [ + 'description' => '业务标签', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'Province', + 'in' => 'query', + 'schema' => [ + 'description' => '省份', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '陕西', + ], + ], + [ + 'name' => 'City', + 'in' => 'query', + '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 => [ + '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' => 'C42981C7-93D9-55CD-B078-784F8522E0E1', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + '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' => true, + 'docRequired' => true, + 'example' => 'agent@ccc-test', + ], + ], + [ + 'name' => 'NumberList', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的个人外呼号码列表，通过调用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' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', + ], + ], + ], + ], + ], + '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.', + ], + ], + 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\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '删除坐席关联的多个号码', + 'summary' => '调用RemovePersonalNumbersFromUser删除指定实例下指定坐席的一个或多个个人外呼号码。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemovePhoneNumberFromSkillGroups' => [ + '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' => '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' => [ + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '删除多个技能组关联的号码', + 'summary' => '调用RemovePhoneNumberFromSkillGroups删除指定实例下指定号码关联的一个或多个技能组与该号码的绑定关系，删除的是号码与技能组的绑定关系，并不是真实号码。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemovePhoneNumbers' => [ + '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' => 'NumberList', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的号码列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["0101234****","0105678****"]', + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制删除，如果号码关联了技能组、联系流或坐席，只有将该字段设置为true才可以执行删除，非必填，默认false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + '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' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + ], + 'Data' => [ + 'description' => '删除失败的号码列表。', + 'type' => 'array', + 'items' => [ + 'description' => '号码。', + 'type' => 'string', + 'example' => '0101234****', + ], + 'example' => '无', + ], + 'Params' => [ + '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.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>无</Data>\\n<FailureList>无</FailureList>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '删除号码', + 'summary' => '调用RemovePhoneNumbers删除指定实例下的一个或多个号码。并非真实删除某个号码，而是将这个号码与实例进行解绑，包括号码关联的技能组、联系流、坐席等，都将随之解绑。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemovePhoneNumbersFromSkillGroup' => [ + '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' => 'NumberList', + 'in' => 'query', + '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' => [ + 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', + ], + ], + ], + ], + ], + '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' => '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '删除技能组关联的多个号码', + 'summary' => '调用RemovePhoneNumbersFromSkillGroup删除指定实例下指定技能组关联的一个或多个号码与该技能组的关联关系。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddNumbersToSkillGroup' => [ + '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' => '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', + ], + ], + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","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', + ], + ], + ], + ], + ], + '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.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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '添加多个坐席到技能组', + 'summary' => '调用AddUsersToSkillGroup添加一个或多个坐席到同一个技能组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateSkillGroup' => [ + '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-64个字符，可以包含数字、字母、下划线（_）、短横线（-），必须以字母开头。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'skillgroup', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + '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' => [ + 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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Description>测试</Description>\\n <InstanceId>ccc-test</InstanceId>\\n <SkillGroupId>skg-test@ccc-test</SkillGroupId>\\n <Name>test</Name>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '创建技能组', + 'summary' => '调用CreateSkillGroup在指定实例下创建一个技能组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteSkillGroup' => [ + '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' => 'skillgroup@ccc-test', + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制删除，如果技能组关联了号码或坐席，需要启用强制删除标志才能删除成功。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => true, + 'maximum' => '200', + 'minimum' => '1', + 'example' => 'true', + 'default' => 'false', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + 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}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '删除技能组', + 'summary' => '调用DeleteSkillGroup删除指定实例下指定技能组ID对应的技能组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetSkillGroup' => [ + 'summary' => '调用GetSkillGroup获取指定实例下指定技能组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' => 'SkillGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '技能组ID，格式为：技能组名称@实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'skillgroup@ccc-test', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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' => '[{"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', + ], + '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' => 'SearchPattern', + 'in' => 'query', + 'schema' => [ + 'description' => '根据技能组名称或技能组展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'skillgroup', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页序号，范围1-100。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + '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' => [ + 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' => '3969FC68-CEC2-4398-B76A-60D2F7EDEBAF', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"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":"<RequestId>3969FC68-CEC2-4398-B76A-60D2F7EDEBAF</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <SkillGroupName>测试技能组</SkillGroupName>\\n <Description>测试技能组</Description>\\n <PhoneNumberCount>1</PhoneNumberCount>\\n <InstanceId>ccc-test</InstanceId>\\n <UserCount>1</UserCount>\\n <DisplayName>测试技能组</DisplayName>\\n <SkillGroupId>test@ccc-test</SkillGroupId>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取技能组概要列表', + 'summary' => '调用ListBriefSkillGroups获取指定实例下的技能组概要信息列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListSkillGroups' => [ + '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' => 'SearchPattern', + 'in' => 'query', + 'schema' => [ + 'description' => '根据技能组名称或技能组展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '测试技能组', + ], + ], + [ + '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' => 'MediaType', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '[{"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":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <SkillGroupName>test</SkillGroupName>\\n <Description>测试</Description>\\n <PhoneNumberCount>1</PhoneNumberCount>\\n <InstanceId>ccc-test</InstanceId>\\n <UserCount>2</UserCount>\\n <DisplayName>测试技能组</DisplayName>\\n <SkillGroupId>test@ccc-test</SkillGroupId>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取技能组列表', + 'summary' => '调用ListSkillGroups获取指定实例下的技能组列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListSkillLevelsOfUser' => [ + '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。', + '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' => [ + 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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <SkillLevel>5</SkillLevel>\\n <SkillGroupName>测试技能组</SkillGroupName>\\n <SkillGroupId>test@ccc-test</SkillGroupId>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取坐席的技能组等级列表', + 'summary' => '获取指定实例下指定坐席关联的技能组的技能等级列表，也可以使用该接口查询坐席可关联但未关联的技能组列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifySkillGroup' => [ + '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' => 'skillgroup@ccc-test', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => '技能组展示名，长度为1-64个字符。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '新测试技能组', + 'maxLength' => 200, + 'minLength' => 1, + ], + ], + [ + 'name' => 'Description', + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '修改技能组', + 'summary' => '调用ModifySkillGroup修改指定实例下指定技能组ID对应的技能组的信息，主要是修改技能组展示名和技能组的描述信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifySkillLevelsOfUser' => [ + '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' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '坐席ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'agent@ccc-test', + ], + ], + [ + 'name' => 'SkillLevelList', + '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}]', + ], + ], + ], + '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' => 'E49D8B83-A3EC-44D4-A920-578BC3C698AD', + ], + 'Data' => [ + 'description' => '数据。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + '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.', + ], + ], + 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.', + ], + ], + [ + [ + '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\\": \\"E49D8B83-A3EC-44D4-A920-578BC3C698AD\\",\\n \\"Data\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>E49D8B83-A3EC-44D4-A920-578BC3C698AD</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '修改坐席的多个技能等级', + 'summary' => '修改指定实例下指定坐席的一个或多个技能组下的技能等级。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveSkillGroupsFromUser' => [ + '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' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '坐席ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'agent@ccc-test', + ], + ], + [ + 'name' => 'SkillGroupIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '取消关联的技能组ID列表，格式为JSON数组的字符串，数组元素是技能组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["skillgroup1@ccc-test","skillgroup2@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' => '无', + ], + 'Data' => [ + 'description' => '数据。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>无</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '删除坐席关联的多个技能组', + 'summary' => '调用RemoveSkillGroupsFromUser删除指定实例下指定坐席关联的一个或多个技能组与该坐席之间的关联关系。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ImportRamUsers' => [ + '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' => 'RoleId', + 'in' => 'query', + 'schema' => [ + 'description' => '角色ID，坐席导入成功后在实例中的角色，包括管理员、技能组组长和坐席三种角色。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Agent@ccc-test'."\n", + ], + ], + [ + '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}]'."\n", + ], + ], + [ + 'name' => 'RamIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '待添加的RAM用户ID列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["28036411123456****","29234301123456****"]'."\n", + ], + ], + [ + 'name' => 'WorkMode', + 'in' => 'query', + 'schema' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + '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'."\n", + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', + ], + '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.', + ], + ], + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '云联络中心实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'szpczf', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '坐席ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'sam@szpczf', + ], + ], + [ + 'name' => 'Invisible', + 'in' => 'query', + 'schema' => [ + 'description' => '是否切换为隐身状态。隐身状态和仅外呼含义一致。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '无', + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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).', + ], + ], + 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.', + ], + ], + ], + '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', + ], + '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' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '坐席ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'agent@ccc-test', + ], + ], + [ + 'name' => 'SkillLevelList', + '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}]', + ], + ], + ], + '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' => 'BA7F9545-8312-4190-9BD0-63144B3F1ACC', + ], + ], + ], + ], + ], + '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.', + ], + ], + 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.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA7F9545-8312-4190-9BD0-63144B3F1ACC\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA7F9545-8312-4190-9BD0-63144B3F1ACC</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '添加多个技能组到坐席', + 'summary' => '调用AddSkillGroupsToUser添加一个或多个技能组到指定实例下的指定坐席。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AssignUsers' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'RoleId', + 'in' => 'query', + 'schema' => [ + 'description' => '角色ID，坐席导入成功后在实例中的角色，包括管理员、技能组组长和坐席三种角色。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Agent@ccc-test', + ], + ], + [ + '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' => '工作模式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>1ca2b084-6f0a-454b-9851-29768a9a5832</Data>\\n<WorkflowId>1ca2b084-6f0a-454b-9851-29768a9a5832</WorkflowId>\\n<Sync>无</Sync>\\n<Code>OK</Code>","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' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n", + '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，浏览器WebRTC软电话或实体话机设备的标识ID，同一时间只允许一种设备注册。', + 'type' => 'string', + 'required' => false, + 'example' => 'ACC-YUNBS-1.0.10-****', + ], + ], + [ + 'name' => 'WorkMode', + 'in' => 'query', + 'schema' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + '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' => '响应码。'."\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' => '无', + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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":"<RequestId>87731ED1-6224-48A5-99E3-6237FF9B1C00</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <Extension>80011474</Extension>\\n <UserState>OFFLINE</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bs990cd82101cc000176af19ec8e</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>无</JobId>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '改变坐席工作模式', + 'summary' => '调用ChangeWorkMode改变坐席的工作模式。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateUser' => [ + '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' => 'LoginName', + 'in' => 'query', + 'schema' => [ + 'description' => '坐席登录名，长度为4-64个字符，可包含英文大小写字母、数字、英文句点“.”、下划线“_”或短划线“-”。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'agent', + ], + ], + [ + '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' => '[email protected]', + ], + ], + [ + 'name' => 'WorkMode', + 'in' => 'query', + 'schema' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => [ + 'ON_SITE' => '场内模式', + 'OFF_SITE' => '场外模式', + 'OFFICE_PHONE' => '办公电话模式', + ], + 'example' => 'ON_SITE', + ], + ], + [ + 'name' => 'RoleId', + 'in' => 'query', + 'schema' => [ + 'description' => '角色ID，格式为：角色@实例ID，包含三种角色：Admin（管理员）、Manager（技能组组长）、Agent（坐席）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Agent@ccc-test', + ], + ], + [ + '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}]', + ], + ], + [ + 'name' => 'ResetPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '首次登录时是否需要重置密码，如果为true，则在首次登录RAM账户时会提示重置密码，否则不提示。默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DisplayId', + 'in' => 'query', + 'schema' => [ + 'description' => '坐席的工号，客户可根据需要自行设置。', + 'type' => 'string', + 'required' => false, + 'example' => '1001', + ], + ], + [ + 'name' => 'AvatarUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '坐席头像地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://abc.com/sam.jpg', + ], + ], + [ + 'name' => 'Nickname', + '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' => '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' => '[email protected]', + ], + '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' => '无', + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 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.', + ], + ], + 409 => [ + [ + 'errorCode' => 'AlreadyExists.User', + 'errorMessage' => 'User %s already exists in instance %s.', + ], + ], + ], + '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\\": \\"[email protected]\\",\\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":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <Extension>8032****</Extension>\\n <LoginName>user-test-1</LoginName>\\n <Email>1886666****@163.com</Email>\\n <UserId>user-test-1@ccc-test</UserId>\\n <DisplayName>云呼测试1</DisplayName>\\n <Mobile>1382114****</Mobile>\\n <WorkMode>ON_SITE</WorkMode>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '创建坐席', + 'summary' => '调用CreateUser在指定实例下创建一个新的坐席。', + 'description' => '创建坐席实际上就是创建一个RAM子账户，云联络中心的坐席与RAM子账户是相互映射的，所以创建时传入的参数就和创建RAM账户时类似，比如：LoginName就是RAM账号的登录名，Email就是创建RAM账号时预留的邮箱，该邮箱会接收到带有RAM账户初始登录密码的邮件。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetUser' => [ + '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，选填，UserId和Extension任选一个填写即可。', + 'type' => 'string', + 'required' => false, + 'example' => 'agent@ccc-test', + ], + ], + [ + 'name' => 'Extension', + 'in' => 'query', + 'schema' => [ + 'description' => '坐席分机号，选填，UserId和Extension任选一个填写即可。', + 'type' => 'string', + 'required' => false, + 'example' => '8003****', + ], + ], + ], + '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' => [ + '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' => '[email protected]', + ], + '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' => '无', + ], + ], + ], + ], + ], + ], + '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 \\"DisplayName\\": \\"坐席小王\\",\\n \\"DisplayId\\": \\"1001\\",\\n \\"Extension\\": \\"8003****\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"[email protected]\\",\\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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <Extension>80xxxx91</Extension>\\n <LoginName>user-test</LoginName>\\n <DeviceState>OFFLINE</DeviceState>\\n <RoleName>Admin</RoleName>\\n <Email>[email protected]</Email>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>Yealink SIP-T23G 44.84.203.6</DeviceId>\\n <UserId>user-test@ccc-test</UserId>\\n <DisplayName>测试用户</DisplayName>\\n <DeviceExt>80xxxx33</DeviceExt>\\n <RoleId>Admin@ccc-test</RoleId>\\n <Mobile>139xxxx1234</Mobile>\\n <WorkMode>ON_SITE</WorkMode>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取坐席', + 'summary' => '调用GetUser获取指定实例下指定坐席ID对应的坐席信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ImportAdmins' => [ + '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' => 'RamIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云RAM账户的UID列表，格式为JSON数组的字符串，数组元素最多20个。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["26972543893791****"]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应数据', + '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****', + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + '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。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + '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', + ], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '响应参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + 'Data' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <Extension>80326034</Extension>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>BS-2020-09-01-11:11:11.888-192_168_12_123</DeviceId>\\n <CallId>561d53be3fa11c4700a40ce8592ef880@0:0:0:0:0:0:0:0</CallId>\\n <Expires>1609118499750</Expires>\\n <Contact>sip:[email protected]:64189;transport=tcp;registering_acc=18_134_23_4</Contact>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取设备列表', + 'summary' => '获取指定实例下指定坐席的设备列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListRamUsers' => [ + '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' => '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' => [ + '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' => '[email protected]', + ], + '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' => '无', + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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\\": \\"[email protected]\\",\\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":"<RequestId>24753D71-C91D-1A38-A8AD-372BF12453F6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <LoginName>user-test</LoginName>\\n <Email>1886666****@163.com\\t</Email>\\n <Primary>false</Primary>\\n <AliyunUid>157724000000000</AliyunUid>\\n <RamId>28036411123456xxxx</RamId>\\n <DisplayName>测试用户\\t</DisplayName>\\n <Mobile>1382114****</Mobile>\\n </List>\\n</Data>\\n<Code>OK</Code>","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', + ], + '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' => 'SkillGroupId', + 'in' => 'query', + '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' => [ + '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****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <LoginName>user-test</LoginName>\\n <RoleName>Admin</RoleName>\\n <SkillLevel>5</SkillLevel>\\n <SkillGroupName>Default</SkillGroupName>\\n <UserId>user-test@ccc-test</UserId>\\n <DisplayName>测试坐席</DisplayName>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <RoleId>Admin@ccc-test</RoleId>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取技能组的坐席等级列表', + 'summary' => '调用ListUserLevelsOfSkillGroup获取指定实例下指定技能组下属的坐席技能等级列表，也可以调用该接口反差可关联但未关联指定技能组的坐席列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListUsers' => [ + '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' => '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' => '[email protected]', + ], + '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' => '无', + ], + ], + ], + ], + ], + ], + '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' => '[{"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\\": \\"[email protected]\\",\\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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <LoginName>user-test</LoginName>\\n <Email>1886666****@163.com</Email>\\n <DeviceId>Yealink SIP-T23G 44.84.203.6</DeviceId>\\n <PrimaryAccount>false</PrimaryAccount>\\n <RamId>2022546208793</RamId>\\n <DisplayId>1001</DisplayId>\\n <RoleId>Admin@ccc-test</RoleId>\\n <Mobile>1382114****</Mobile>\\n <Extension>80xxxx31</Extension>\\n <DeviceState>OFFLINE</DeviceState>\\n <RoleName>Admin</RoleName>\\n <UserId>user-test@ccc-test</UserId>\\n <DisplayName>测试用户</DisplayName>\\n <DeviceExt>80xxxx33</DeviceExt>\\n <WorkMode>ON_SITE</WorkMode>\\n <PersonalOutboundNumberList>\\n <Usage>Bidirection</Usage>\\n <Active>true</Active>\\n <Number>083xxxx0011</Number>\\n <City>乐山</City>\\n <Province>四川</Province>\\n </PersonalOutboundNumberList>\\n <SkillLevelList>\\n <SkillGroupName>skg-test</SkillGroupName>\\n <SkillLevel>5</SkillLevel>\\n <SkillGroupId>skg-test@ccc-test</SkillGroupId>\\n </SkillLevelList>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取坐席列表', + 'summary' => '调用ListUsers获取指定实例下的坐席列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyUser' => [ + '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' => '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' => '工作模式。', + 'type' => 'string', + 'required' => true, + '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' => [ + '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' => '无', + ], + '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.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', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>无</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '修改坐席', + 'summary' => '调用ModifyUser修改指定实例下指定坐席的信息，可修改电话号码、工作模式、角色和工号。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyUserLevelsOfSkillGroup' => [ + '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' => 'SkillGroupId', + 'in' => 'query', + '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' => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>E49D8B83-A3EC-44D4-A920-578BC3C698AD</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>无</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '修改技能组的多个坐席等级', + 'summary' => '调用ModifyUserLevelsOfSkillGroup修改指定实例下指定技能组下属的一个或多个坐席的技能等级。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RegisterDevice' => [ + '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' => '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' => [ + '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' => [ + 'type' => 'array', + 'items' => [ + 'description' => '响应参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Parameter.Blank', + 'errorMessage' => 'The parameter %s must not be blank.', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '注册设备', + 'summary' => '调用RegisterDevice注册SIP设备到指定实例下的指定坐席， SIP设备可以是SIP话机或SIP软电话。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RegisterDevices' => [ + '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' => 'UserIdListJson', + 'in' => 'query', + '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' => [ + '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' => '无', + ], + ], + ], + ], + ], + ], + '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\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '注册多个设备', + 'summary' => '调用RegisterDevices注册一个或多个SIP设备到指定实例下的指定坐席，SIP设备可以是SIP话机或SIP软电话。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveUsers' => [ + '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' => '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' => '[email protected]', + ], + ], + ], + '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' => '响应参数。', + '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.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.', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '删除坐席', + 'summary' => '调用RemoveUsers删除指定实例下的一个或多个坐席，该操作仅将RAM账户与实例解绑，然后将RAM账户映射的坐席从实例中删除，并不会删除RAM账户本身。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveUsersFromSkillGroup' => [ + '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' => 'skillgroup@ccc-test', + ], + ], + [ + 'name' => 'UserIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '坐席ID列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["agent1@ccc-test","agent2@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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '删除技能组关联的多个坐席', + 'summary' => '调用RemoveUsersFromSkillGroup删除指定实例下指定技能组关联的一个或多个坐席，该操作仅删除技能组与坐席之间的关联关系，并不会删除坐席。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ResetAgentState' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n", + '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', + ], + ], + ], + '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' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', + ], + 'Params' => [ + 'type' => 'array', + 'items' => [ + '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' => '无', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '[{"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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Extension>80011112</Extension>\\n <UserState>OFFLINE</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <OutboundScenario>false</OutboundScenario>\\n <WorkMode>ON_SITE</WorkMode>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '重置坐席状态', + 'summary' => '调用ResetAgentState重置指定实例下指定坐席的坐席状态。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ResetUserPassword' => [ + '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' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '坐席ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'agent@ccc-test', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '新的密码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'password', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Parameter.Blank', + 'errorMessage' => 'The parameter %s may not be null or blank.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Permission.Role', + 'errorMessage' => 'You have no permission to access role %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.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', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '重置坐席密码', + 'summary' => '调用ResetUserPassword重置指定实例下指定坐席的登录密码。实际上坐席并没有登录密码，修改的是坐席关联的RAM账户的登录密码，通常用于客服忘记自己的RAM账户登录密码的场景。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UnregisterDevice' => [ + 'summary' => '调用UnregisterDevice删除指定实例下指定坐席的设备注册记录，删除后将导致与坐席关联的SIP话机或SIP软电话不可用。', + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Parameter.Blank', + 'errorMessage' => 'The parameter %s must not be null or empty.', + ], + ], + 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.', + ], + ], + 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\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '删除注册设备', + ], + 'AnswerCall' => [ + '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' => '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-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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalService.CTI', + 'errorMessage' => 'An internal CTI service error occurred.', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AssociatedData/>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '接听通话', + 'summary' => '调用AnswerCall接听指定实例下指定通话ID对应的通话。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BargeInCall' => [ + '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' => '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****', + ], + ], + [ + 'name' => 'BargedUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '被强插的座席ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'agent2@ccc-test', + ], + ], + [ + 'name' => 'TimeoutSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => '强插超时时间，经过指定的时间强插仍未成功，则取消强插，正常情况下，强插操作会马上成功，设置超时时间是为了防止异常发生，此字段选填，默认30，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '3600', + 'minimum' => '0', + 'example' => '60', + ], + ], + ], + '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' => '响应参数列表。', + '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' => '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****', + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>10</Index>\\n <SkillGroupId>skg-test1@ccc-test</SkillGroupId>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '强插通话', + 'summary' => '调用BargeInCall强行插入指定实例下指定通话ID对应的正在通话中的通话，强插成功后，通话将由原来的双方通话变成三人会议。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BlindTransfer' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + '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，无意义，可以随便填写。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'ACC-YUNBS-1.0.10-****', + ], + ], + [ + 'name' => 'Transferor', + 'in' => 'query', + 'schema' => [ + 'description' => '转接发起方，当场景是直接转接到外部号码时，用此参数指定的号码作为主叫，转内部坐席或技能组时，此参数无效，发起方由UserId指定。', + 'type' => 'string', + 'required' => false, + 'example' => '08314325****', + ], + ], + [ + 'name' => 'Transferee', + 'in' => 'query', + 'schema' => [ + 'description' => '被转接方，可以是坐席ID或技能组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'agent@ccc-test', + ], + ], + [ + 'name' => 'TimeoutSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => '直接转接超时时间，超过指定时间被转接方没有接起通话，则挂断通话，此字段选填，默认30，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '120', + 'minimum' => '3', + 'example' => '60', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '通话ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'job-6538214103685****', + ], + ], + [ + 'name' => 'CallPriority', + 'in' => 'query', + 'schema' => [ + 'description' => '转接到技能组队列时的排队优先级，取值范围0-9，0优先级最高，9最低。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'StrategyName', + 'in' => 'query', + 'schema' => [ + 'description' => '转接到技能组队列时的座席分配策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'MOST_IDLE，MOST_SKILLED，MOST_ACQUAINTED，CUSTOMIZED等', + ], + ], + [ + '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" + .'}', + ], + ], + [ + 'name' => 'TransfereeType', + 'in' => 'query', + 'schema' => [ + 'description' => '转接目的类型，可选值为AGENT，SKILL_GROUP，IVR和EXTERNAL_NUMBER。如果此参数不传，则系统会根据转接的目标号码的格式进行判断，如果发现有判不准确的情况，则需要指定此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'SKILL_GROUP', + ], + ], + [ + 'name' => 'ContactFlowVariables', + 'in' => 'query', + 'schema' => [ + 'description' => '传递给联系流的变量，选填，这里配置的变量，可以在IVR流程中拿到并使用，格式为JSON字符串格式的键值对集合。', + 'type' => 'string', + 'required' => false, + 'example' => '{"name":"王先生","time":"19点20分","address":"某某中心"}', + ], + ], + [ + 'name' => 'RoutingType', + 'in' => 'query', + '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' => [ + 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' => '响应参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '响应参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalService.CTI', + 'errorMessage' => 'An internal CTI service error occurred. %s', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <AssociatedData/>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '直接转接通话', + 'summary' => '直接转接通话到其他坐席或某个技能组队列或外部号码，直接转接也叫盲转或单步转。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CancelAttendedTransfer' => [ + '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' => '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****', + ], + ], + ], + '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' => '响应参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '响应参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>10</Index>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '取消咨询转移', + 'summary' => '调用CancelAttendedTransfer取消咨询转接，在发起咨询转接后，完成咨询转接前，均可调用该接口取消咨询转接，即使被转接方已经接通，也可以取消。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CoachCall' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + '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' => '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-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' => [ + 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', + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 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.', + ], + ], + ], + '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":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>1</Index>\\n <AssociatedData>无</AssociatedData>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <ChannelId>ch:user:139xxxx0501->8032xxxx:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>COACHING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>8032xxxx</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>Warm-up</BreakCode>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <Uri>无</Uri>\\n <Extension>8032xxxx</Extension>\\n <DeviceState>UNREGISTERED</DeviceState>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <JobId>job-65382141036853491</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609136956370</Reserved>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '辅导通话', + 'summary' => '调用CoachCall辅导指定实例下指定通话ID对应的通话中的指定坐席，辅导过程中被辅导坐席可以听到辅导者的声音，客户无法听到辅导者的声音。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CompleteAttendedTransfer' => [ + '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' => '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****', + ], + ], + ], + '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' => '响应参数列表。', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>10</Index>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '完成咨询转接', + 'summary' => '调用CompleteAttendedTransfer完成咨询转。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EndConference' => [ + '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' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要退出会议的坐席ID，选填，不填默认为当前RAM账户映射的坐席。', + 'type' => 'string', + 'required' => false, + 'example' => 'agent@ccc-test', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '通话ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'job-6538214103685****', + ], + ], + ], + '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' => '0630E5DF-CEB0-445B-8626-D5C7481181C3', + ], + 'Params' => [ + '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' => '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****', + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 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\\": \\"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', + ], + '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' => 'Number', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的号码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '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' => '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' => '北京', + ], + ], + ], + ], + ], + ], + ], + '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 \\"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', + ], + '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' => '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' => '无', + ], + ], + 'Data' => [ + '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****', + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>174F7777-2F6C-4F10-B889-C698E26C1AE0</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <CallContext>\\n <InstanceId>无</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65825892782321664</JobId>\\n <ChannelContexts>\\n <Destination>8001****</Destination>\\n <ChannelState>ANSWERED</ChannelState>\\n <ReleaseReason>无</ReleaseReason>\\n <Originator>1318888****</Originator>\\n <ReleaseInitiator>无</ReleaseInitiator>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>8001****</UserExtension>\\n <CallType>OUTBOUND</CallType>\\n <AssociatedData>无</AssociatedData>\\n <SkillGroupId>skill-group@ccc-test</SkillGroupId>\\n <ChannelId>ch:user:1318888****->8001****:1609255715825:job-65825892782321664</ChannelId>\\n <Timestamp>1609255716900</Timestamp>\\n <JobId>job-65825892782321664</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <Extension>8001****</Extension>\\n <UserState>TALKING</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>Warm-up</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bs990cd82101cc000176af19ec8e</DeviceId>\\n <Heartbeat>1609255716908</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>1390000****</Mobile>\\n <JobId>job-65825892782321664</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609255715822</Reserved>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '保持通话', + 'summary' => '调用HoldCall保持指定实例下指定通话ID对应的通话，通话被保持后，将暂时被挂起，此时被保持方会听到保持音乐。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'InitiateAttendedTransfer' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + '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，无意义，可以随便填写。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'ACC-YUNBS-1.0.10-****', + ], + ], + [ + 'name' => 'Transferor', + 'in' => 'query', + 'schema' => [ + 'description' => '转接发起方，当场景是咨询转接到外部号码时，用此参数指定的号码作为主叫，转内部坐席或技能组时，此参数无效，发起方由UserId指定。', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'Transferee', + 'in' => 'query', + 'schema' => [ + 'description' => '被转接方，可以是坐席ID或技能组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'agent2@ccc-test', + ], + ], + [ + 'name' => 'TimeoutSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => '咨询转接超时时间，超过指定时间被转接方没有接起通话，则挂断通话，此字段选填，默认30，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '通话ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'job-6538214103685****', + ], + ], + [ + 'name' => 'CallPriority', + 'in' => 'query', + 'schema' => [ + 'description' => '转接到技能组队列时的排队优先级，取值范围0-9，0优先级最高，9最低。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'StrategyName', + 'in' => 'query', + 'schema' => [ + 'description' => '转接到技能组队列时的座席分配策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'MOST_IDLE，MOST_SKILLED，MOST_ACQUAINTED，CUSTOMIZED等', + ], + ], + [ + '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" + .'}', + ], + ], + [ + 'name' => 'TransfereeType', + 'in' => 'query', + 'schema' => [ + 'description' => '转接目的类型，可选值为AGENT，SKILL_GROUP和EXTERNAL。如果此参数不传，则系统会根据转接的目标号码的格式进行判断，如果发现有判不准确的情况，则需要指定此参数。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AGENT' => '座席', + 'EXTERNAL' => '外部号码', + 'SKILL_GROUP' => '技能组', + ], + 'example' => 'SKILL_GROUP', + ], + ], + [ + 'name' => 'RoutingType', + 'in' => 'query', + 'schema' => [ + 'description' => '话务分配类型，可选参数为自动分配(Automatic)或者手动分配(Manual)。如果此参数为空，则默认为自动分配的方式，这也是当前系统的默认行为。选择手动分配方式时，需要您自己配合调用ClaimCall等接口把电话分给指定的座席。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Manual' => '手动分配', + 'Automatic' => '自动分配', + ], + 'example' => 'Automatic', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => '随路数据，主要用于扩展需求，普通用户无需关心。', + 'type' => 'string', + 'required' => false, + 'example' => 'a=b', + ], + ], + [ + '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', + ], + ], + ], + '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' => '响应参数列表。', + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>10</Index>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '发起咨询转接', + 'summary' => '咨询转接通话到其他坐席或某个技能组队列或外部号码，咨询转接也叫关注转或双步转。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'InterceptCall' => [ + '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' => '发起强拆的坐席。', + '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', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '通话ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'job-6538214103685****', + ], + ], + [ + 'name' => 'InterceptedUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '被强拆的座席ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'agent2@ccc-test', + ], + ], + [ + 'name' => 'TimeoutSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => '强拆超时时间，经过指定的时间强拆仍未成功，则取消强拆，正常情况下，强拆操作会马上成功，设置超时时间是为了防止异常发生，此字段选填，默认30，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '3600', + 'minimum' => '0', + 'example' => '60', + ], + ], + ], + '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' => '响应参数列表。', + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>10</Index>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '强拆通话', + 'summary' => '调用InterceptCall强行拆开指定实例下指定通话ID对应的通话，通话必须处于监听状态，且由监听者发起强拆，强拆成功后，原本与客户通话的坐席会被挂断，发起强拆的坐席代替原坐席继续与客户通话。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'LaunchAuthentication' => [ + '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' => 'DeviceId', + 'in' => 'query', + '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-6538214103685****', + ], + ], + [ + '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 => [ + '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' => [ + '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-****', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>10</Index>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '发起IVR核身', + 'summary' => '调用LaunchAuthentication使通话临时转入指定的IVR流程，调用此接口后，会在通话过程中进入IVR交互环节，通用用于核身操作。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'LaunchSurvey' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + '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，无意义，可以随便填写。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'device', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '通话ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'job-6580466654649****', + ], + ], + [ + 'name' => 'ContactFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IVR满意度流程的联系流ID，请确保填入的联系流ID是可用的满意度调查流程。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '4685b65a-eb8f-11ec-8ea0-0242ac120002', + ], + ], + [ + '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' => '满意度采集渠道，非必填，默认为语音满意度。', + 'type' => 'string', + 'required' => 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' => '响应码。'."\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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>AF1E5957-5276-48FF-A6E6-347166A4ADCD</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <ContextId>123456789</ContextId>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65804666546491392</JobId>\\n <ChannelContexts>\\n <Destination>1318888****</Destination>\\n <ChannelState>ANSWERED</ChannelState>\\n <ReleaseInitiator>无</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>1</Index>\\n <AssociatedData>无</AssociatedData>\\n <SkillGroupId>skill-group@ccc-test</SkillGroupId>\\n <ChannelId>ch-user-1917047****-80154160-1655094662943-job-d4a3d2f1-7d8b-40a4-bd3d-3cc20842c620</ChannelId>\\n <Timestamp>1609250655922</Timestamp>\\n <ReleaseReason>无</ReleaseReason>\\n <Originator>1318888****</Originator>\\n <ChannelFlags>[]</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>8001****</UserExtension>\\n <JobId>job-65804666546491392</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <Extension>8001****</Extension>\\n <UserState>TALKING</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>default</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bs3b5f22c6d78f000176aebe9471</DeviceId>\\n <Heartbeat>1609250656122</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>1390000****</Mobile>\\n <JobId>job-65804666546491392</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609250655090</Reserved>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '发起满意度调查', + 'summary' => '调用LaunchSurvey发送满意度调查，该操作会导致挂机，如果是语音满意度，客户会在坐席挂机后进入IVR满意度调查流程，并在IVR流程中完成满意度采集。如果是短信满意度，则通话结束，客户收到满意度调查短信。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'MakeCall' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '50581', + 'abilityTreeNodes' => [ + 'FEATUREcccIPHVDY', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n", + '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' => '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' => [ + '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' => '无', + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '[{"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":"<RequestId>26A34338-5CD9-4C95-A7A6-5BDCE76C6B94</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <ContextId>123456</ContextId>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65700074013925376</JobId>\\n <ChannelContexts>\\n <Destination>8001****</Destination>\\n <ChannelState>NONE</ChannelState>\\n <ReleaseReason>无</ReleaseReason>\\n <Originator>1318888****</Originator>\\n <ChannelFlags>[]</ChannelFlags>\\n <ReleaseInitiator>无</ReleaseInitiator>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>8001****</UserExtension>\\n <CallType>OUTBOUND</CallType>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:131888****->8001****:1609225718294:job-65700074013925376</ChannelId>\\n <Timestamp>1609225718295</Timestamp>\\n <JobId>job-65700074013925376</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <Extension>8001****</Extension>\\n <UserState>READY</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>Warm-up</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c</DeviceId>\\n <OutboundScenario>false</OutboundScenario>\\n <JobId>job-65700074013925376</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '发起呼叫', + 'summary' => '调用MakeCall发起呼叫，被叫可以是内部坐席，也可以是外部客户 。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'MonitorCall' => [ + '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' => 'DeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备ID，无意义，可以随便填写。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'device', + ], + ], + [ + 'name' => 'MonitoredUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '被监听的座席的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'agent2@ccc-test', + ], + ], + [ + 'name' => 'TimeoutSeconds', + 'in' => 'query', + 'schema' => [ + 'description' => '监听超时时间，经过指定的时间监听仍未成功，则取消监听，正常情况下，监听操作会马上成功，设置超时时间是为了防止异常发生，此字段选填，默认30，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + ], + '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' => '响应参数列表。', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>1</Index>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AssociatedData/>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '监听通话', + 'summary' => '调用MonitorCall监听指定实例下指定通话ID对应的通话。通话必须处于坐席和客户双方正常接通状态，且发起监听的坐席有权限对被监听坐席进行监听。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'MuteCall' => [ + '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' => '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-6581536084722****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '待静音的话务通道ID，非必填，默认为空，为空表示静音UserId对应的坐席的话务通道。', + 'type' => 'string', + 'required' => false, + 'example' => 'ch:user:1318888****->8001****:1609253204816:job-6581536084722****', + ], + ], + ], + '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' => 'A275B008-A25B-494D-AB53-93CE253815B6', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>A275B008-A25B-494D-AB53-93CE253815B6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65815360847228928</JobId>\\n <ChannelContexts>\\n <Destination>8001****</Destination>\\n <ChannelState>ANSWERED</ChannelState>\\n <ReleaseInitiator>无</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>1</Index>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:1318888****-&gt;8001****:1609253204816:job-65815360847228928\\"</ChannelId>\\n <Timestamp>1609253212511</Timestamp>\\n <ReleaseReason>无</ReleaseReason>\\n <Originator>1318888****</Originator>\\n <ChannelFlags>[]</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>8001****</UserExtension>\\n <JobId>job-65815360847228928</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <Extension>8001****</Extension>\\n <UserState>TALKING</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>Warm-up</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bs736efb521810000176aef6e955</DeviceId>\\n <Heartbeat>1609253205896</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>1390000****</Mobile>\\n <JobId>job-65815360847228928</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609253204811</Reserved>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '静音通话', + 'summary' => '调用MuteCall静音指定实例下指定通话ID对应的通话，只能由正在通话状态的坐席调用，且只能静音调用者自己，坐席静音后，客户将无法听见坐席的声音。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PickOutboundNumbers' => [ + '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' => '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', + ], + ], + [ + 'name' => 'SkillGroupIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '技能组ID集合，格式为JSON数组的字符串，数组元素是技能组ID，号码与技能组是关联的，此参数用于指定从哪些技能组挑选号码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["skillgroup@ccc-test"]', + ], + ], + ], + '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', + ], + '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' => '北京', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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 {\\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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Callee>\\n <Number>1388888****</Number>\\n <City> 北京</City>\\n <Province>北京</Province>\\n </Callee>\\n <Caller>\\n <Number>0108989****</Number>\\n <City>北京</City>\\n <Province>北京</Province>\\n </Caller>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '选择外呼号码', + 'summary' => '调用PickOutboundNumbers根据传入的被叫号码选择适合的主叫号码，选号逻辑由智能算法控制。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PollUserStatus' => [ + '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' => 'DeviceId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备ID，无意义，可以随便填写。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'device', + ], + ], + ], + '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' => '响应参数列表。', + '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' => [ + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + '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' => '无', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.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\\": \\"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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <ContextId/>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>1</Index>\\n <AssociatedData>无</AssociatedData>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <ChannelVariables>123</ChannelVariables>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <Extension>80326034</Extension>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>Warm-up</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <JobId>job-65382141036853491</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609136956378</Reserved>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '轮询坐席状态', + 'summary' => '轮询指定实例下指定坐席的坐席状态，一般由前端坐席工作台调用，用于同步坐席状态。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ReadyForService' => [ + '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，不填默认为当前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' => [ + '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' => '无', + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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).', + ], + ], + 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\\": \\"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":"<RequestId>CC49060B-87ED-489A-AD3D-00E57775DBFF</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Extension>80011474</Extension>\\n <UserState>OFFLINE</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <OutboundScenario>false</OutboundScenario>\\n <WorkMode>ON_SITE</WorkMode>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '坐席就绪', + 'summary' => '调用ReadyForService使指定实例下的指定坐席就绪，就绪后坐席进入空闲状态。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RedialCall' => [ + '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' => 'abc', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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' => '重拨脱敏后的话单中的号码', + ], + 'ReleaseCall' => [ + '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，不填默认使用当前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****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '待挂断的话务通道ID，非必填，不填默认为当前UserId对应坐席所在的话务通道。', + 'type' => 'string', + 'required' => false, + 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****', + ], + ], + ], + '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' => '响应参数列表。', + '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', + ], + ], + ], + ], + 'ContextId' => [ + 'description' => '系统自增ID，客户无需关心。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + ], + ], + ], + ], + ], + ], + '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 \\"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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <Extension>80326034</Extension>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <AssociatedData/>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '挂断通话', + 'summary' => '调用ReleaseCall挂断指定实例下指定通话ID对应的通话，调用者必须是坐席，且正处于通话状态。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RetrieveCall' => [ + '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' => '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****', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '待取回的话务通道ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****', + ], + ], + ], + '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' => '响应参数列表。', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <SkillGroupId>skg-test1@ccc-test</SkillGroupId>\\n <AssociatedData/>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '取回通话', + 'summary' => '调用RetrieveCall取回指定实例下指定通话ID对应的通话，通话必须处于保持状态才可操作取回。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SaveRTCStatsV2' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '50605', + 'abilityTreeNodes' => [ + 'FEATUREcccD5GAHN', + ], + ], + '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****', + ], + ], + [ + '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' => '收到报告内容。', + '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' => [ + 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', + ], + 'RowCount' => [ + 'description' => '行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + '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.', + ], + ], + 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 \\"RowCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<RowCount>1</RowCount>\\n<Code>OK</Code>\\n<TimeStamp>1647309061000</TimeStamp>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '上报坐席端WebRTC统计信息', + 'summary' => '调用SaveRTCStatsV2上报坐席端WebRTC语音传输统计信息，普通客户无需关心该接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SaveTerminalLog' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '50606', + 'abilityTreeNodes' => [ + 'FEATUREcccD5GAHN', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + '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' => [ + 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":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>\\n<TimeStamp>1647309061000</TimeStamp>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '保存坐席端日志信息', + 'summary' => '调用SaveTerminalLog上报坐席端日志信息，普通客户无需关心该接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SaveWebRtcInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '50607', + 'abilityTreeNodes' => [ + 'FEATUREcccD5GAHN', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + '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' => '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' => [ + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalService.Common', + 'errorMessage' => 'An internal service error occurred. %s', + ], + ], + ], + '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":"<RequestId>CF1C21B9-2D49-4B54-880F-FBE248C16903</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<RowCount>1</RowCount>\\n<Code>OK</Code>\\n<TimeStamp>1647262108395</TimeStamp>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '上报WebRTC状态信息', + 'summary' => '调用SaveWebRtcInfo上报座席端WebRTC的通话状态信息，包括通话质量监控数据等，用于后台统计和监控，客户无需关心该接口。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SaveWebRTCStats' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '50608', + 'abilityTreeNodes' => [ + 'FEATUREcccD5GAHN', + ], + ], + '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****', + ], + ], + [ + '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' => '收到报告内容。', + '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' => [ + 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' => '1555492246000', + ], + 'RowCount' => [ + 'description' => '行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + '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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalService.Common', + 'errorMessage' => 'An internal service error occurred. %s', + ], + ], + ], + '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', + ], + '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' => '发送DTMF的坐席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', + ], + ], + [ + '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' => [ + 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' => '842399EC-7D32-4472-AD08-9504C3F141FF', + ], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '响应参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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).', + ], + ], + 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', + ], + ], + ], + '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":"<RequestId>842399EC-7D32-4472-AD08-9504C3F141FF</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65735740600893440</JobId>\\n <ChannelContexts>\\n <Destination>8001****</Destination>\\n <ChannelState>ANSWERED</ChannelState>\\n <ReleaseInitiator>无</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>1</Index>\\n <AssociatedData>无</AssociatedData>\\n <SkillGroupId>skill-group@ccc-test</SkillGroupId>\\n <ChannelId>ch:user:131888****->8001****:1609234221870:job-65735740600893440\\"</ChannelId>\\n <Timestamp>1609234222367</Timestamp>\\n <ReleaseReason>无</ReleaseReason>\\n <Originator>0101234****</Originator>\\n <ChannelFlags>[]</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>8001****</UserExtension>\\n <JobId>job-65735740600893440</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <Extension>8001****</Extension>\\n <UserState>TALKING</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>Warm-up</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bse05179638553000176add4046f</DeviceId>\\n <Heartbeat>1609234222375</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>1390000****</Mobile>\\n <JobId>job-65735740600893440</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609234221864</Reserved>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '发送按键信息', + 'summary' => '调用SendDtmfSignaling在通话过程中发送DTMF按键信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SignInGroup' => [ + '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，不填默认使用当前RAM账号映射的坐席。', + 'type' => 'string', + 'required' => false, + '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', + ], + ], + [ + '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' => [ + 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' => '响应参数列表。', + 'type' => 'array', + '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' => '振铃中', + ], + 'example' => 'READY', + ], + 'SignedSkillGroupIdList' => [ + 'description' => '坐席签入的技能组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '技能组ID。', + 'type' => 'string', + 'example' => 'skillgroup1@ccc-test', + ], + ], + 'ChatDeviceId' => [ + 'description' => 'Chat设备ID。', + 'type' => 'string', + 'example' => '4c51c9116c36537cb850dc1081d745df', + ], + ], + ], + ], + ], + ], + ], + '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' => '[{"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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <Extension>80326034</Extension>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <WorkMode>ON_SITE</WorkMode>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '签入技能组', + 'summary' => '调用SignInGroup使坐席签入指定实例下的指定技能组，即坐席上线操作。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SignOutGroup' => [ + '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，不填默认使用当前RAM账号映射的坐席。', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '无', + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n <Extension>80326034</Extension>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <Reserved>1609136956378</Reserved>\\n</Data>\\n<Code>200</Code>","errorExample":""}]', + 'title' => '签出技能组', + 'summary' => '调用SignOutGroup使坐席签出当前签入的技能组，即坐席下线操作。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StartBack2BackCall' => [ + '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' => 'Caller', + 'in' => 'query', + 'schema' => [ + 'description' => '主叫号码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1391814****', + ], + ], + [ + 'name' => 'Callee', + 'in' => 'query', + 'schema' => [ + 'description' => '被叫号码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1372168****', + ], + ], + [ + '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' => [ + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>26A34338-5CD9-4C95-A7A6-5BDCE76C6B94</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>BACK2BACK</CallType>\\n <JobId>job-103415908907622400</JobId>\\n <ChannelContexts>\\n <Destination>1014</Destination>\\n <ChannelState>NONE</ChannelState>\\n <ReleaseReason>无</ReleaseReason>\\n <ReleaseInitiator>无</ReleaseInitiator>\\n <Originator>010xxxx2157</Originator>\\n <ChannelFlags>[]</ChannelFlags>\\n <UserId>无</UserId>\\n <UserExtension>80011474</UserExtension>\\n <CallType>BACK2BACK</CallType>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:1318888888->80011474:1609225718294:job-65700074013925376</ChannelId>\\n <Timestamp>1618217874062</Timestamp>\\n <JobId>job-103415908907622400</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <UserState>OFFLINE</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <DeviceId>ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <OutboundScenario>false</OutboundScenario>\\n <Uri>无</Uri>\\n <Mobile>86-132xxxx4730</Mobile>\\n <Extension>80202301</Extension>\\n <DeviceState>无</DeviceState>\\n <UserId>user-test@ccc-test</UserId>\\n <Heartbeat>1618217872911</Heartbeat>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-103415908907622400</JobId>\\n <Reserved>1618217794599</Reserved>\\n <SignedSkillGroupIdList>[\\"skg-default@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '发起双呼', + 'summary' => '调用StartBack2BackCall发起双呼。', + 'description' => '双呼和传统的双方通话不同，主叫并不直接呼叫对方，而是通过一个背靠背代理（Back to Back Agent），背靠背代理首先呼叫主叫方，接通后，再呼叫被叫方，然后把二者拉进一个会场。在这种方式下，由于每个呼叫的所有消息流经背靠背代理，因此服务提供商可以据此提供增值服务，比如计时、录音、隐藏真实号码等等。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StartConference' => [ + '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，非必填，不填则默认使用当前RAM账户映射的坐席。', + 'type' => 'string', + 'required' => false, + 'example' => 'agent@ccc-test', + ], + ], + [ + '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' => [ + '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' => [ + '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' => '话务通道。', + '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", + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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', + ], + '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' => 'Caller', + 'in' => 'query', + 'schema' => [ + 'description' => '主叫号码，需要是实例下可用的外呼号码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0109810****', + ], + ], + [ + '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' => [ + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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":"<RequestId>26A34338-5CD9-4C95-A7A6-5BDCE76C6B94</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65700074013925376</JobId>\\n <ChannelContexts>\\n <Destination>8001****</Destination>\\n <ChannelState>NONE</ChannelState>\\n <ReleaseReason>无</ReleaseReason>\\n <Originator>1318888****</Originator>\\n <ChannelFlags>[]</ChannelFlags>\\n <ReleaseInitiator>无</ReleaseInitiator>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>8001****</UserExtension>\\n <CallType>OUTBOUND</CallType>\\n <AssociatedData>无</AssociatedData>\\n <ChannelId>ch:user:131888****->8001****:1609225718294:job-65700074013925376</ChannelId>\\n <Timestamp>1609225718295</Timestamp>\\n <JobId>job-65700074013925376</JobId>\\n </ChannelContexts>\\n </CallContext>\\n <UserContext>\\n <Extension>8001****</Extension>\\n <DeviceState>无</DeviceState>\\n <UserState>READY</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>Warm-up</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bsd87c04aaa8f7000176ad354b1c</DeviceId>\\n <Heartbeat>1609136956378</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-1324730****</Mobile>\\n <JobId>job-65700074013925376</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609136956378</Reserved>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '发起预测式外呼', + 'summary' => '调用StartPredictiveCall发起预测式外呼。', + 'description' => '云呼叫中心除了支持客服从坐席工作台发起外呼外，还支持从自有业务系统后台发起外呼，待接通后转给坐席。以支持把云呼叫中心功能无缝嵌入您的业务流程。'."\n" + .'比如，您的客户可以在您的微信公众号上，输入自己的号码，并点击咨询产品的按钮，由您的后台系统调用本接口，实现呼叫客户手机，接通后播放“我们收到您在公众号上对我们产品的咨询，现在给您转接顾问，请稍等”，并转给合适的客服接听通话。'."\n" + .'相较于1.0的DialEX接口，用户使用该接口可以更加灵活的进行配置。除了可以自定义外呼转入的IVR外，还可以传入自定义的参数，在IVR中对参数进行语音播报，实现通知的场景。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StartPrivacyCall' => [ + '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, + 'docRequired' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ALIPUBB7A727C170949', + ], + ], + [ + 'name' => 'Caller', + 'in' => 'query', + 'schema' => [ + 'description' => '主叫号码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0109810****', + ], + ], + [ + 'name' => 'Callee', + 'in' => 'query', + 'schema' => [ + 'description' => '被叫号码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1888888****', + ], + ], + ], + '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", + 'type' => 'string', + 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3', + ], + 'Params' => [ + 'description' => '参数信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Data' => [ + 'description' => '返回结果，通话ID。', + 'type' => 'string', + 'example' => 'job-xxx', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + '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，不填默认使用当前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' => [ + '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' => '无', + ], + ], + '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", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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', + ], + '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，不填默认使用当前RAM账户映射的坐席。', + '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', + ], + ], + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => '小休状态码，客户可以自定义任何小休状态。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lunchtime', + ], + ], + ], + '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' => 'B59382D2-5755-4C6D-861F-FA2AAD8F89F7', + ], + 'Params' => [ + 'description' => '响应参数列表。', + 'type' => 'array', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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).', + ], + ], + 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\\": \\"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":"<RequestId>B59382D2-5755-4C6D-861F-FA2AAD8F89F7</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <Extension>8001****</Extension>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <BreakCode>default</BreakCode>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-bs3b5f22c6d78f000176aebe9471</DeviceId>\\n <Heartbeat>1609249563836</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>1390000****</Mobile>\\n <JobId>无</JobId>\\n <WorkMode>ON_SITE</WorkMode>\\n <Reserved>1609234221864</Reserved>\\n <SignedSkillGroupIdList>[\\"skill-group@ccc-test\\"]</SignedSkillGroupIdList>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '小休', + 'summary' => '调用TakeBreak将指定实例下的指定坐席设置为小休状态。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UnmuteCall' => [ + '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，不填默认使用当前RAM账户映射的坐席。', + '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', + ], + ], + [ + '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' => [ + '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' => '该通话相关技能组。呼入场景下，技能组由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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserContext>\\n <Extension>80326034</Extension>\\n <UserState>BREAK</UserState>\\n <InstanceId>ccc-test</InstanceId>\\n <UserId>user-test@ccc-test</UserId>\\n <DeviceId>ACC-YUNBS-1.0.10-b18bp53c1736c2914176a801ei90</DeviceId>\\n <BreakCode>Warm-up</BreakCode>\\n <Heartbeat>1609136956378</Heartbeat>\\n <OutboundScenario>false</OutboundScenario>\\n <Mobile>86-132xxxx4730</Mobile>\\n <WorkMode>ON_SITE</WorkMode>\\n <JobId>job-65382141036853491</JobId>\\n <SignedSkillGroupIdList>[\\"skg-test1@ccc-test\\",\\"skg-test2@ccc-test\\"]</SignedSkillGroupIdList>\\n </UserContext>\\n <CallContext>\\n <InstanceId>ccc-test</InstanceId>\\n <CallType>OUTBOUND</CallType>\\n <JobId>job-65382141036853491</JobId>\\n <ChannelContexts>\\n <Destination>139xxxx0501</Destination>\\n <ChannelState>CREATED</ChannelState>\\n <ReleaseInitiator>139xxxx0501</ReleaseInitiator>\\n <CallType>OUTBOUND</CallType>\\n <Index>1</Index>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AssociatedData/>\\n <ChannelId>ch:user:139xxxx0501->80326034:1609138902226:job-65382141036853491</ChannelId>\\n <Timestamp>1609138903315</Timestamp>\\n <ReleaseReason>404 - No destination</ReleaseReason>\\n <Originator>083xxxx0019</Originator>\\n <ChannelFlags>MONITORING</ChannelFlags>\\n <UserId>user-test@ccc-test</UserId>\\n <UserExtension>80326034</UserExtension>\\n <JobId>job-65382141036853491</JobId>\\n </ChannelContexts>\\n </CallContext>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '取消通话静音', + 'summary' => '调用UnmuteCall取消通话静音。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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' => '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' => [ + 'title' => '号码列表', + 'description' => '号码列表。', + 'type' => 'array', + 'items' => [ + 'description' => '号码。', + 'type' => 'string', + 'required' => false, + 'example' => '["0830011xxxx", "0830312xxxx"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + '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' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => 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' => [ + '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', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<AbortCampaignResponse>\\n <RequestId>7CC6523B-0E51-1B62-8DA5-6A9831CAE315</RequestId>\\n <Code>OK</Code>\\n <Message>无</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n</AbortCampaignResponse>","errorExample":""}]', + 'title' => '终止预测式外呼活动', + ], + 'AddCases' => [ + 'summary' => '调用AddCases添加外呼名单到指定实例下指定ID对应的预测式外呼活动。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + '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' => 'c58b9719-3bc3-441d-a4d3-fc0309ef7066'."\n", + ], + ], + [ + 'name' => 'CaseList', + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcccQFUGXR', + ], + ], + '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' => '78cf6864-9a22-4ea8-a59d-5adc2d747b0e', + ], + ], + [ + 'name' => 'body', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + '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, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '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', + ], + 'PhoneNumber' => [ + 'type' => 'string', + ], + 'CustomVariables' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcccQFUGXR', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'CaseList', + 'in' => 'query', + 'style' => 'json', + '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"}', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'QueueId', + 'in' => 'query', + 'schema' => [ + 'description' => '预测式外呼活动关联的技能组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'skillgroup@ccc-test', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '预测式外呼活动名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-campaign', + ], + ], + [ + 'name' => 'CaseFileKey', + 'in' => 'query', + 'schema' => [ + 'description' => '预测式外呼名单文件，是一个OSS对象的Key，通过GetCaseFileUploadUrl接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'ccc-test/namelist.csv', + ], + ], + [ + 'name' => 'ContactFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '预测式外呼活动关联的联系流ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c1f2bc75-422e-43c7-9c9d9d95633a', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '预测式外呼活动开始时间，格式为Unix时间戳，单位毫秒。', + 'type' => 'string', + 'required' => true, + 'example' => '1634140800000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '预测式外呼活动结束时间，格式为Unix时间戳，单位毫秒。', + 'type' => 'string', + 'required' => true, + 'example' => '1634313600000', + ], + ], + [ + '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" }]', + ], + ], + [ + 'name' => 'StrategyType', + 'in' => 'query', + 'schema' => [ + 'description' => '预测式外呼活动的策略模式。'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'PACING' => '固定比例外呼，外呼数量=空闲坐席*比例。', + 'PID' => '系统基于PID控制策略，自动调整外呼电话数量。', + ], + 'example' => 'PACING', + 'enum' => [ + 'SP', + 'PID', + 'PACING', + 'ASAP', + 'CUSTOMIZED', + ], + ], + ], + [ + 'name' => 'StrategyParameters', + 'in' => 'query', + 'schema' => [ + 'description' => '预测式外呼活动的策略参数，PID策略下的格式参数示例：{"abandonRate":"5","historicalConnectedRate":"35"}，PACING策略下的格式参数示例：{"ratio":1}。abandonRate表示期望呼损率，historicalConnectedRate表示历史参考接通率，ratio表示固定外呼比例。', + 'type' => 'string', + 'required' => true, + 'example' => '{"ratio":1}', + ], + ], + [ + 'name' => 'MaxAttemptCount', + 'in' => 'query', + 'schema' => [ + 'description' => '预测式外呼活动的最大尝试次数，表示当活动的号码呼叫失败时，最多重呼几次。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'MinAttemptInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '预测式外呼活动的最小重呼间隔，表示失败重呼时的最小间隔，单位分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Simulation', + 'in' => 'query', + 'schema' => [ + 'description' => '是否是模拟活动，用于测试，普通客户无需关心。', + 'type' => 'boolean', + 'required' => false, + 'example' => '无', + 'default' => 'false', + ], + ], + [ + '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' => [ + 'title' => '主叫号码列表', + 'description' => '主叫号码列表', + 'type' => 'array', + 'items' => [ + 'title' => '号码', + 'description' => '号码', + 'type' => 'string', + 'required' => false, + 'example' => '01012345678', + ], + 'required' => false, + ], + ], + [ + '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":"<CreateCampaignResponse>\\n <RequestId>7CC6523B-0E51-1B62-8DA5-6A9831CAE315</RequestId>\\n <CampaignId>6badb397-a8b5-40b6-21019d382a09</CampaignId>\\n <Code>OK</Code>\\n <Message>无</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n</CreateCampaignResponse>","errorExample":""}]', + 'title' => '创建预测式外呼活动', + ], + 'GetCampaign' => [ + 'summary' => '调用GetCampaign获取指定实例下指定ID对应的预测式外呼活动。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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', + ], + ], + ], + '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', + ], + 'CompletionRate' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'ContactFlowId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => '预测式外呼活动名单文件名称，名称的格式要求为英文大小写字母，文件格式要求csv格式。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'case.csv', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + '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 \\"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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + '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', + ], + ], + ], + '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' => '响应信息。'."\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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc-test'."\n", + ], + ], + [ + 'name' => 'QueueId', + 'in' => 'query', + 'schema' => [ + 'title' => '活动ID', + 'description' => '预测式外呼活动ID。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'skillgroup@ccc-test'."\n", + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + '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****', + ], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => [ + 'title' => '坐席ID', + 'description' => '按坐席ID过滤，非必填，默认为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'agent@ccc-test', + ], + ], + [ + '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' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315', + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '按预测式外呼活动状态过滤，非必填，默认为空。'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Draft' => '草稿', + 'Completed' => '已完成', + 'Executing' => '执行中', + 'Pending' => '待执行', + 'Aborted' => '已终止', + 'Paused' => 'Paused', + ], + 'example' => 'Draft', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '按预测式外呼活动名称过滤，不支持模糊匹配，非必填，默认为空，表示不过滤。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-campaign', + ], + ], + [ + 'name' => 'PlanedStartTimeFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '外呼活动计划开始时间，非必填，默认查询所有时间范围。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-10-14 00:00:00', + ], + ], + [ + 'name' => 'PlanedStartTimeTo', + 'in' => 'query', + 'schema' => [ + 'description' => '外呼活动计划结束时间，非必填，默认查询所有时间范围。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-10-14 20:59:59', + ], + ], + [ + '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 => [ + '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', + ], + 'Data' => [ + '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' => [ + '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":"<ListCampaignsResponse>\\n <RequestId>6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0</RequestId>\\n <Message>无</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>\\n <List>\\n <ActualEndTime>1634008800000</ActualEndTime>\\n <ActualStartTime>1634000460000</ActualStartTime>\\n <CasesAborted>0</CasesAborted>\\n <CasesUncompleted>0</CasesUncompleted>\\n <CasesConnected>40</CasesConnected>\\n <CompletedRate>100</CompletedRate>\\n <MaxAttemptCount>1</MaxAttemptCount>\\n <MinAttemptInterval>1</MinAttemptInterval>\\n <Name>test-campalgn</Name>\\n <PlanedEndTime>1634054400000</PlanedEndTime>\\n <PlanedStartTime>1633968000000</PlanedStartTime>\\n <QueueName>默认技能组</QueueName>\\n <TotalCases>100</TotalCases>\\n <State>Completed</State>\\n <CampaignId>6badb397-a8b5-40b6-21019d382a09</CampaignId>\\n <StrategyType>PACING</StrategyType>\\n <StrategyParameters>{\\"ratio\\":1}</StrategyParameters>\\n <QueueId>skg-default@report-test-2</QueueId>\\n <Simulation>false</Simulation>\\n </List>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>1</TotalCount>\\n </Data>\\n <Code>OK</Code>\\n <Success>true</Success>\\n</ListCampaignsResponse>","errorExample":""}]', + 'title' => '获取预测式外呼活动列表', + ], + 'ListCampaignTrendingReport' => [ + 'summary' => '获取指定实例下指定ID对应的预测式外呼活动的趋势报表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + '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', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '结束时间', + 'description' => '结束时间，非必填，默认为预测式外呼活动的结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2021-10-14 20:59:59', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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":"<ListCampaignTrendingReportResponse>\\n <Code>OK</Code>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Message>无</Message>\\n <RequestId>6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0</RequestId>\\n <Data>\\n <Datetime>1634037840000</Datetime>\\n <Concurrency>1</Concurrency>\\n <TalkAgents>0</TalkAgents>\\n <ReadyAgents>2</ReadyAgents>\\n <WorkAgents>0</WorkAgents>\\n <LoggedInAgents>2</LoggedInAgents>\\n <BreakAgents>0</BreakAgents>\\n </Data>\\n</ListCampaignTrendingReportResponse>","errorExample":""}]', + 'title' => '获取预测式外呼活动趋势报表', + ], + 'ListCases' => [ + 'summary' => '调用ListCases获取指定实例下指定ID对应的预测式外呼活动的外呼名单执行详情列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + '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', + ], + ], + [ + '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' => [ + 200 => [ + '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', + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":"<ListCasesResponse>\\n <RequestId>7CC6523B-0E51-1B62-8DA5-6A9831CAE316</RequestId>\\n <Message>无</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>\\n <List>\\n <AbandonType>NA</AbandonType>\\n <AttemptCount>1</AttemptCount>\\n <ExpandInfo>待删除</ExpandInfo>\\n <FailureReason>无</FailureReason>\\n <PhoneNumber>18888888888</PhoneNumber>\\n <State>Connected</State>\\n <CaseId>60ecb1a2-4480-4d01-bede-c5b7655bfadf</CaseId>\\n <CustomVariables>{\\"name\\":\\"yy\\",\\"客戶标签\\":\\"tag-yy\\"}</CustomVariables>\\n </List>\\n <PageNumber>1</PageNumber>\\n <PageSize>100</PageSize>\\n <TotalCount>1</TotalCount>\\n </Data>\\n <Code>OK</Code>\\n <Success>true</Success>\\n</ListCasesResponse>","errorExample":""}]', + 'title' => '获取预测式外呼名单列表', + ], + 'PauseCampaign' => [ + 'summary' => '调用PauseCampaign暂停指定实例下指定ID对应的预测式外呼活动。', + 'methods' => [ + 'get', + 'post', + ], + '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' => 'CampaignId', + 'in' => 'query', + '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' => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + '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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F505C4C8-1E12-573A-9BA7-4BEAAD129553\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<ResumeCampaignResponse>\\n <RequestId>F505C4C8-1E12-573A-9BA7-4BEAAD129553</RequestId>\\n <Code>OK</Code>\\n <Message>无</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n</ResumeCampaignResponse>","errorExample":""}]', + 'title' => '恢复预测式外呼活动', + ], + 'UpdateCampaign' => [ + 'summary' => '修改外呼活动参数。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + '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' => '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' => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + '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', + ], + ], + ], + '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', + ], + 'Code' => [ + 'title' => 'code', + 'description' => '响应码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'title' => 'message', + 'description' => '响应信息。', + 'type' => 'string', + 'example' => '无', + ], + 'HttpStatusCode' => [ + 'title' => 'httpStatusCode', + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitCampaignResponse>\\n <RequestId>7CC6523B-0E51-1B62-8DA5-6A9831CAE315</RequestId>\\n <Code>OK</Code>\\n <Message>无</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n</SubmitCampaignResponse>","errorExample":""}]', + 'title' => '启动预测式外呼活动', + ], + 'GetIvrTrackingSummary' => [ + 'summary' => '获取IVR轨迹小结', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcccKJSOHN', + ], + ], + 'parameters' => [ + [ + 'name' => 'ContactId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '通话ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'job-489361145506897920', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0f7ad007-ab50-4b3d-a87a-56864eb40dab', + ], + ], + ], + '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' => 'Unknown error code \'NoPermission.Recording\'. Reason: null', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', + ], + 'Data' => [ + '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', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => [ + 'description' => '坐席ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'agent@ccc-test', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间戳，默认为当天的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' => '1558443508000', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '分段统计类型，非必填，默认为Daily（按天汇总）。', + 'type' => 'string', + 'required' => false, + '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' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', + ], + 'Data' => [ + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '获取分组坐席分段统计报表', + ], + 'ListHistoricalAgentSkillGroupReport' => [ + 'summary' => '调用ListHistoricalAgentSkillGroupReport获取指定实例下的一个或多个坐席的历史分组数据报表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'riskType' => 'none', + 'chargeType' => 'free', + ], + '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' => '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'."\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' => [ + 200 => [ + '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', + ], + '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' => [ + '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', + ], + ], + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Parameter.Blank', + 'errorMessage' => 'The parameter %s must not be null or empty.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREccc5HY0NN', + ], + ], + 'parameters' => [ + [ + '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' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', + ], + 'Data' => [ + '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' => '坐席事件列表。', + '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', + ], + 'EventTime' => [ + 'description' => '事件发生时间戳，格式为Unix时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1604639129000', + ], + 'Duration' => [ + 'description' => '时间的持续时长，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'EventTime' => [ + 'description' => '事件发生时间戳，格式为Unix时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1604639129000', + ], + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"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":"<RequestId>7BEEA660-A45A-45E3-98CC-AFC65E715C23</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <SkillGroupIds>skg-default@ccc-test</SkillGroupIds>\\n <CalledNumber>133xxxx2315</CalledNumber>\\n <ContactType>Outbound</ContactType>\\n <InstanceId>ccc-test</InstanceId>\\n <ContactDisposition>Success</ContactDisposition>\\n <ReleaseInitiator>customer</ReleaseInitiator>\\n <Satisfaction>1</Satisfaction>\\n <EarlyMediaState>NotConnected</EarlyMediaState>\\n <StartTime>1532458000000</StartTime>\\n <ContactId>job-109634426711871319</ContactId>\\n <CallDuration>50</CallDuration>\\n <CallingNumber>053xxxx3128</CallingNumber>\\n <CalleeLocation>北京</CalleeLocation>\\n <ReleaseTime>1532458000000</ReleaseTime>\\n <RecordingReady>true</RecordingReady>\\n <SkillGroupNames>默认技能组</SkillGroupNames>\\n <SatisfactionSurveyChannel>语音</SatisfactionSurveyChannel>\\n <SatisfactionSurveyOffered>true</SatisfactionSurveyOffered>\\n <AgentIds>user-test@ccc-test\\t</AgentIds>\\n <EstablishedTime>1532458000000</EstablishedTime>\\n <CallerLocation>北京</CallerLocation>\\n <AgentNames>云呼测试坐席</AgentNames>\\n <AgentEvents>\\n <SkillGroupId>skg-default@ccc-test</SkillGroupId>\\n <AgentId>user-test@ccc-test</AgentId>\\n <AgentName>测试坐席\\t</AgentName>\\n <EventSequence>\\n <EventTime>1604639129000</EventTime>\\n <Event>Dialing</Event>\\n </EventSequence>\\n </AgentEvents>\\n <QueueEvents>\\n <FlowId>edaf2eaa-8f88-44ca-812e-41b3cd2b7a90</FlowId>\\n <QueueId>skg-default@ccc-test</QueueId>\\n <QueueName>Defalut</QueueName>\\n <QueueType>1</QueueType>\\n <EventSequence>\\n <EventTime>1604639129000</EventTime>\\n <Event>Enqueue</Event>\\n </EventSequence>\\n </QueueEvents>\\n <CustomerEvents>\\n <CustomerId>133xxxx2315</CustomerId>\\n <EventSequence>\\n <EventTime>1532458000000</EventTime>\\n <Event>Released</Event>\\n </EventSequence>\\n </CustomerEvents>\\n <IvrEvents>\\n <FlowId>edaf2eaa-8f88-44ca-812e-41b3cd2b7a90</FlowId>\\n <FlowType>MAIN_FLOW</FlowType>\\n <EventSequence>\\n <EventTime>1604639129000</EventTime>\\n <Event>Route2IVR</Event>\\n </EventSequence>\\n </IvrEvents>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取通话详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetConversationDetail' => [ + 'summary' => '调用GetConversationDetail获取指定实例下指定通话ID对应的通话的对话详情，注意，实例及技能组需要开通质检推送才能获取到对话详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '136495', + 'abilityTreeNodes' => [ + 'FEATUREccc5HY0NN', + ], + ], + '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, + 'example' => 'job-25884193037652****', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Parameter.Blank', + 'errorMessage' => 'The parameter %s may not be null or blank.', + ], + ], + ], + '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', + ], + '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' => 'CallingNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '来电号码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1900000****', + ], + ], + [ + 'name' => 'StopTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的结束时间戳，格式为Unix时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '4102416000000', + 'minimum' => '0', + 'example' => '1646928000000', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的开始时间戳，格式为Unix时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '4102416000000', + 'minimum' => '0', + 'example' => '1646841600000', + ], + ], + ], + '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' => [ + 'LastCallingTime' => [ + 'description' => '最近一次来电时间，格式为Unix时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646917200000', + ], + 'TotalCalls' => [ + 'description' => '该号码在查询时间段的总来电次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Parameter.Format', + 'errorMessage' => 'The format of parameter %s is invalid. %s', + ], + [ + 'errorCode' => 'Parameter.Invalid', + 'errorMessage' => 'The 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\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"LastCallingTime\\": 1646917200000,\\n \\"TotalCalls\\": 10\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <LastCallingTime>1646917200000</LastCallingTime>\\n <TotalCalls>10</TotalCalls>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取历史来电报表', + 'summary' => '调用GetHistoricalCallerReport获取指定实例下指定来电号码的历史呼入报表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetHistoricalInstanceReport' => [ + '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' => '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' => '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', + ], + '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', + ], + 'AverageFirstResponseTime' => [ + 'description' => 'Chat会话平均首次响应时长，单位为秒。', + 'type' => 'number', + 'format' => 'float', + 'example' => '12', + ], + 'AccessChannelTypeDetailList' => [ + 'description' => '各渠道的统计数据。', + 'type' => 'array', + 'items' => [ + 'description' => '渠道的统计数据。', + 'type' => 'object', + 'properties' => [ + 'AccessChannelType' => [ + 'description' => '渠道类型。', + 'type' => 'string', + 'example' => 'Web', + ], + 'CallsOffered' => [ + 'description' => '分配的会话数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"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":"<RequestId>943D8EF3-3321-471F-A104-51C96FCA94D6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Inbound>\\n <ServiceLevel20>0</ServiceLevel20>\\n <CallsAbandonedInQueue>0</CallsAbandonedInQueue>\\n <TotalWorkTime>0</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>0</CallsRinged>\\n <MaxAbandonedInIVRTime>0</MaxAbandonedInIVRTime>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>0</MaxRingTime>\\n <CallsOffered>0</CallsOffered>\\n <CallsAbandoned>0</CallsAbandoned>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <MaxAbandonedInRingTime>0</MaxAbandonedInRingTime>\\n <TotalRingTime>0</TotalRingTime>\\n <HandleRate>0</HandleRate>\\n <TotalAbandonedInIVRTime>0</TotalAbandonedInIVRTime>\\n <AverageAbandonedInQueueTime>0</AverageAbandonedInQueueTime>\\n <TotalTalkTime>0</TotalTalkTime>\\n <AverageWaitTime>0</AverageWaitTime>\\n <TotalAbandonedInRingTime>0</TotalAbandonedInRingTime>\\n <CallsQueued>0</CallsQueued>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <AverageAbandonedInIVRTime>0</AverageAbandonedInIVRTime>\\n <TotalAbandonTime>0</TotalAbandonTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n <CallsBlindTransferred>0</CallsBlindTransferred>\\n <CallsAbandonedInIVR>0</CallsAbandonedInIVR>\\n <MaxAbandonedInQueueTime>0</MaxAbandonedInQueueTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <CallsAbandonedInRing>0</CallsAbandonedInRing>\\n <CallsHandled>0</CallsHandled>\\n <MaxWaitTime>0</MaxWaitTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferred>0</CallsAttendedTransferred>\\n <MaxAbandonTime>0</MaxAbandonTime>\\n <AverageRingTime>0</AverageRingTime>\\n <TotalWaitTime>0</TotalWaitTime>\\n <AverageAbandonTime>0</AverageAbandonTime>\\n <AverageAbandonedInRingTime>0</AverageAbandonedInRingTime>\\n <TotalAbandonedInQueueTime>0</TotalAbandonedInQueueTime>\\n <AverageWorkTime>0</AverageWorkTime>\\n <MaxWorkTime>0</MaxWorkTime>\\n <AbandonRate>0</AbandonRate>\\n </Inbound>\\n <Outbound>\\n <TotalDialingTime>0</TotalDialingTime>\\n <TotalWorkTime>0</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>0</CallsRinged>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>0</MaxRingTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <TotalRingTime>0</TotalRingTime>\\n <AverageDialingTime>0</AverageDialingTime>\\n <CallsAnswered>0</CallsAnswered>\\n <TotalTalkTime>0</TotalTalkTime>\\n <CallsDialed>0</CallsDialed>\\n <MaxDialingTime>0</MaxDialingTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n <AnswerRate>0</AnswerRate>\\n <CallsBlindTransferred>0</CallsBlindTransferred>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferred>0</CallsAttendedTransferred>\\n <AverageRingTime>0</AverageRingTime>\\n <AverageWorkTime>0</AverageWorkTime>\\n <MaxWorkTime>0</MaxWorkTime>\\n </Outbound>\\n <Overall>\\n <TotalReadyTime>0</TotalReadyTime>\\n <TotalCalls>0</TotalCalls>\\n <TotalBreakTime>0</TotalBreakTime>\\n <TotalWorkTime>0</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <AverageBreakTime>0</AverageBreakTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <TotalTalkTime>0</TotalTalkTime>\\n <AverageReadyTime>0</AverageReadyTime>\\n <TotalLoggedInTime>0</TotalLoggedInTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxReadyTime>0</MaxReadyTime>\\n <AverageWorkTime>0</AverageWorkTime>\\n <MaxWorkTime>0</MaxWorkTime>\\n <MaxBreakTime>0</MaxBreakTime>\\n <OccupancyRate>0</OccupancyRate>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n </Overall>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取历史实例数据报表', + 'summary' => '调用GetHistoricalInstanceReport获取指定实例的历史数据报表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetInstanceTrendingReport' => [ + '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' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间戳，默认是当天开始时间，最早为当前时间往前180天，开始和截止时间间隔不能超过7天，格式为Unix时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '4133952000000', + 'minimum' => '0', + 'example' => '1604639129000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + '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' => [ + 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', + ], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"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":"<RequestId>943D8EF3-3321-471F-A104-51C96FCA94D6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Inbound>\\n <TotalCalls>0</TotalCalls>\\n <CallsAbandonedInQueue>0</CallsAbandonedInQueue>\\n <CallsQueued>0</CallsQueued>\\n <CallsAbandonedInRing>0</CallsAbandonedInRing>\\n <CallsHandled>0</CallsHandled>\\n <StatsTime>1604639129000</StatsTime>\\n <CallsAbandonedInIVR>0</CallsAbandonedInIVR>\\n </Inbound>\\n <Outbound>\\n <CallsAnswered>0</CallsAnswered>\\n <TotalCalls>0</TotalCalls>\\n <StatsTime>1604639129000</StatsTime>\\n </Outbound>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取实例趋势报表', + 'summary' => '调用GetInstanceTrendingReport获取指定实例的变化趋势报表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetRealtimeInstanceStates' => [ + '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' => 'MediaType', + 'in' => 'query', + 'schema' => [ + 'description' => '媒体类型，默认是语音(AUDIO)。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALL' => '全部', + 'VIDEO' => '视频', + 'CHAT' => '聊天', + 'AUDIO' => '语音', + ], + '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', + ], + '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' => [ + '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\\": \\"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":"<RequestId>943D8EF3-3321-471F-A104-51C96FCA94D6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <BreakingAgents>0</BreakingAgents>\\n <TalkingAgents>0</TalkingAgents>\\n <InstanceId>ccc-test</InstanceId>\\n <LoggedInAgents>0</LoggedInAgents>\\n <ReadyAgents>0</ReadyAgents>\\n <WaitingCalls>0</WaitingCalls>\\n <LongestCall>0</LongestCall>\\n <TotalAgents>0</TotalAgents>\\n <InteractiveCalls>0</InteractiveCalls>\\n <WorkingAgents>0</WorkingAgents>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取实时实例状态', + 'summary' => '调用GetRealtimeInstanceStates获取指定实例的实时状态。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListAgentStateLogs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间戳，默认是当天开始时间，最早为当前日期之前的180天，格式为Unix时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '4133952000000', + 'minimum' => '0', + 'example' => '1620230400000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '截止时间戳，默认是当前时间，EndTime和StartTime的时间差不能超过7天，格式为Unix时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '4133952000000', + 'minimum' => '0', + 'example' => '1620273600000', + ], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + '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' => [ + 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', + ], + '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' => '拨号', + ], + 'example' => 'Break', + ], + 'OutboundScenario' => [ + 'description' => '坐席是否为仅外呼状态。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'BreakCode' => [ + 'description' => '小休码。', + 'type' => 'string', + 'example' => '会议', + ], + 'WorkMode' => [ + 'description' => '工作模式。', + 'type' => 'string', + 'example' => 'ON_SITE', + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"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":"<RequestId>943D8EF3-3321-471F-A104-51C96FCA94D6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <State>Break</State>\\n <StateCode>CHECK_IN_BREAK</StateCode>\\n <StartTime>1620259200000</StartTime>\\n <OutboundScenario>false</OutboundScenario>\\n <Duration>5903871</Duration>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取坐席状态日志列表', + 'summary' => '调用ListAgentStateLogs获取指定实例下指定坐席的状态日志列表。注意本接口即将过期，请使用替代接口ListRealtimeAgentStates。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListCallDetailRecords' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + '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' => '排序字段，非必填，默认为startTime（通话开始时间）。'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'callDuration' => '通话时长', + 'ringTime' => '响铃时长', + 'talkTime' => '通话时长', + 'dialingTime' => '拨号时长', + 'startTime' => '通话开始时间', + 'ivrTime' => 'IVR时长', + 'queueTime' => '排队时长', + ], + 'example' => 'startTime', + ], + ], + [ + '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' => '按满意度调查渠道过滤。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'IVR' => '语音满意度', + 'SMS' => '短信满意度', + ], + 'example' => 'IVR', + ], + ], + [ + 'name' => 'SatisfactionDescriptionList', + 'in' => 'query', + 'schema' => [ + 'description' => '按满意度描述列表过滤，描述内容由客户自定义。', + 'type' => 'string', + 'required' => false, + 'example' => '["满意","一般"]', + ], + ], + [ + 'name' => 'EarlyMediaStateList', + 'in' => 'query', + 'schema' => [ + 'description' => '按未接通原因列表过滤。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'NoAnswer' => '无人接听', + 'OutOfService' => '停机', + 'NotExist' => '空号', + 'Restricted' => '呼叫受限', + 'Busy' => '占线', + 'NotConnected' => '无法接通', + 'PowerOff' => '关机', + ], + 'example' => '["NotConnected","NoAnswer"]', + ], + ], + [ + 'name' => 'ContactDispositionList', + '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"]', + ], + ], + [ + 'name' => 'ContactTypeList', + 'in' => 'query', + 'schema' => [ + 'description' => '按通话类型列表过滤。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Outbound' => '呼出', + 'Back2Back' => '双呼', + 'PrivacyDial' => '加密通话', + 'Internal' => '内部呼叫', + 'Predictive' => '预测式外呼', + 'Inbound' => '呼入', + 'Conference' => '会议', + ], + 'example' => '["Internal","Inbound"]', + ], + ], + ], + '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' => [ + '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", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>11</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <IvrTime>8</IvrTime>\\n <CalledNumber>133xxxx2315</CalledNumber>\\n <ContactType>Outbound</ContactType>\\n <ContactDisposition>Success</ContactDisposition>\\n <SatisfactionIndex>1</SatisfactionIndex>\\n <ContactId>job-125152394144124921</ContactId>\\n <CallingNumber>053xxxx3128</CallingNumber>\\n <RecordingReady>true</RecordingReady>\\n <SkillGroupNames>默认技能组</SkillGroupNames>\\n <SatisfactionSurveyOffered>true</SatisfactionSurveyOffered>\\n <QueueTime>0</QueueTime>\\n <EstablishedTime>1532448000000</EstablishedTime>\\n <SkillGroupIds>skg-default@ccc-test</SkillGroupIds>\\n <Broker>053xxxx3127</Broker>\\n <InstanceId>ccc-test</InstanceId>\\n <ReleaseInitiator>agent</ReleaseInitiator>\\n <EarlyMediaState>NotConnected</EarlyMediaState>\\n <StartTime>1532448000000</StartTime>\\n <RingTime>5</RingTime>\\n <CallDuration>30</CallDuration>\\n <CalleeLocation>北京</CalleeLocation>\\n <ReleaseTime>1532707199000</ReleaseTime>\\n <SatisfactionSurveyChannel>IVR</SatisfactionSurveyChannel>\\n <AgentIds>user-test@ccc-test</AgentIds>\\n <SatisfactionDescription>满意</SatisfactionDescription>\\n <AdditionalBroker>053xxxx3128</AdditionalBroker>\\n <CallerLocation>北京</CallerLocation>\\n <WaitTime>5</WaitTime>\\n <AgentNames>云呼测试坐席</AgentNames>\\n <RecordingDuration>10</RecordingDuration>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取通话详情列表', + 'summary' => '调用ListCallDetailRecords获取指定实例下指定搜索条件过滤后的通话详情列表。接口不再迭代更新，建议优先使用ListCallDetailRecordsV2接口。', + 'description' => '为了保证查询效率，返回数据中的TotalCount字段，只会在查询第一页时赋值，查询其他页时返回0。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListCallDetailRecordsV2' => [ + 'summary' => '获取指定实例下指定搜索条件过滤后的通话详情列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + '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' => '1657853640015', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '获取的历史数据的终止时间，默认为当前时间，格式为 Unix 时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '4133952000000', + 'minimum' => '0', + 'example' => '1657879880010', + ], + ], + [ + '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, + 'docRequired' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'OrderByField', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，非必填，默认为 startTime（通话开始时间）。'."\n" + ."\n" + .'枚举值：'."\n" + ."\n" + .'startTime：通话开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => 'startTime', + ], + ], + [ + '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:专属开发渠道*', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ContactIdList', + 'in' => 'query', + 'schema' => [ + 'description' => '通话ID列表。', + 'type' => 'string', + 'required' => false, + 'example' => '["job-123456789","job-234567891"]', + ], + ], + [ + 'name' => 'ContactTypeList', + '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"]', + ], + ], + [ + 'name' => 'ContactDispositionList', + '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"]', + ], + ], + [ + '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' => [ + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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 }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取通话详情列表', + 'description' => 'ListCallDetailRecordsV2用来替代ListCallDetailRecords接口，后续新增字段和查询条件会在ListCallDetailRecordsV2持续优化。另外为了保证查询效率，返回数据中的 TotalCount 字段，只会在查询第一页时赋值，查询其他页时返回 0。', + ], + 'ListHistoricalAgentReport' => [ + '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' => '100', + ], + ], + [ + 'name' => 'AgentIdList', + 'in' => 'formData', + '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时，最早为当前时间往前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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '技能组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'wwtest@test_yunhu', + ], + ], + ], + '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' => '100', + ], + 'TotalCount' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'List' => [ + '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数组的字符串，数组元素是技能组名称。', + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": 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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>10</TotalCount>\\n <PageSize>100</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <DisplayId>8001xxxx</DisplayId>\\n <AgentId>user-test@ccc-test</AgentId>\\n <AgentName>云呼测试坐席</AgentName>\\n <Inbound>\\n <TotalWorkTime>0</TotalWorkTime>\\n <CallsRinged>0</CallsRinged>\\n <TotalHoldTime>0</TotalHoldTime>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <CallsOffered>0</CallsOffered>\\n <MaxRingTime>0</MaxRingTime>\\n <CallsHold>0</CallsHold>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHandled>0</CallsHandled>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <TotalRingTime>0</TotalRingTime>\\n <HandleRate>0</HandleRate>\\n <CallsAttendedTransferIn>0</CallsAttendedTransferIn>\\n <TotalTalkTime>0</TotalTalkTime>\\n <AverageRingTime>0</AverageRingTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <CallsBlindTransferOut>0</CallsBlindTransferOut>\\n <AverageWorkTime>0</AverageWorkTime>\\n <CallsAttendedTransferOut>0</CallsAttendedTransferOut>\\n <CallsBlindTransferIn>0</CallsBlindTransferIn>\\n <MaxWorkTime>0</MaxWorkTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n </Inbound>\\n <Outbound>\\n <TotalDialingTime>0</TotalDialingTime>\\n <TotalWorkTime>0</TotalWorkTime>\\n <CallsRinged>0</CallsRinged>\\n <TotalHoldTime>0</TotalHoldTime>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>0</MaxRingTime>\\n <CallsHold>0</CallsHold>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <TotalRingTime>0</TotalRingTime>\\n <AverageDialingTime>0</AverageDialingTime>\\n <CallsAnswered>0</CallsAnswered>\\n <TotalTalkTime>0</TotalTalkTime>\\n <CallsDialed>0</CallsDialed>\\n <MaxDialingTime>0</MaxDialingTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <CallsAttendedTransferOut>0</CallsAttendedTransferOut>\\n <AverageTalkTime>0</AverageTalkTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AnswerRate>0</AnswerRate>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferIn>0</CallsAttendedTransferIn>\\n <AverageRingTime>0</AverageRingTime>\\n <CallsBlindTransferOut>0</CallsBlindTransferOut>\\n <AverageWorkTime>0</AverageWorkTime>\\n <CallsBlindTransferIn>0</CallsBlindTransferIn>\\n <MaxWorkTime>0</MaxWorkTime>\\n </Outbound>\\n <Overall>\\n <TotalReadyTime>0</TotalReadyTime>\\n <TotalCalls>0</TotalCalls>\\n <TotalBreakTime>0</TotalBreakTime>\\n <TotalWorkTime>0</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <AverageBreakTime>0</AverageBreakTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <TotalTalkTime>0</TotalTalkTime>\\n <AverageReadyTime>0</AverageReadyTime>\\n <TotalLoggedInTime>0</TotalLoggedInTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <MaxReadyTime>0</MaxReadyTime>\\n <AverageWorkTime>0</AverageWorkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxBreakTime>0</MaxBreakTime>\\n <MaxWorkTime>0</MaxWorkTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n <OccupancyRate>0</OccupancyRate>\\n </Overall>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取坐席历史数据报表', + 'summary' => '调用ListHistoricalAgentReport获取指定实例下的一个或多个坐席的历史数据报表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + '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' => '技能组历史数据。', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>26A34338-5CD9-4C95-A7A6-5BDCE76C6B94</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>4</TotalCount>\\n <PageSize>100</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <SkillGroupName>test1</SkillGroupName>\\n <SkillGroupId>skg-test1@ccc-test</SkillGroupId>\\n <Inbound>\\n <ServiceLevel20>0</ServiceLevel20>\\n <CallsAbandonedInQueue>0</CallsAbandonedInQueue>\\n <TotalWorkTime>85</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>7</CallsRinged>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>12</MaxRingTime>\\n <CallsOffered>7</CallsOffered>\\n <CallsAbandoned>0</CallsAbandoned>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <MaxAbandonedInRingTime>0</MaxAbandonedInRingTime>\\n <TotalRingTime>32</TotalRingTime>\\n <HandleRate>1</HandleRate>\\n <AverageAbandonedInQueueTime>0</AverageAbandonedInQueueTime>\\n <TotalTalkTime>447</TotalTalkTime>\\n <AverageWaitTime>5</AverageWaitTime>\\n <TotalAbandonedInRingTime>0</TotalAbandonedInRingTime>\\n <CallsQueued>7</CallsQueued>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <CallsAttendedTransferOut>0</CallsAttendedTransferOut>\\n <TotalAbandonTime>0</TotalAbandonTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>64</AverageTalkTime>\\n <MaxAbandonedInQueueTime>0</MaxAbandonedInQueueTime>\\n <CallsTimeout>0</CallsTimeout>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <CallsAbandonedInRing>0</CallsAbandonedInRing>\\n <CallsOverflow>0</CallsOverflow>\\n <CallsHandled>7</CallsHandled>\\n <MaxWaitTime>13</MaxWaitTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferIn>0</CallsAttendedTransferIn>\\n <MaxAbandonTime>0</MaxAbandonTime>\\n <AverageRingTime>5</AverageRingTime>\\n <TotalWaitTime>34</TotalWaitTime>\\n <AverageAbandonTime>0</AverageAbandonTime>\\n <AverageAbandonedInRingTime>0</AverageAbandonedInRingTime>\\n <TotalAbandonedInQueueTime>0</TotalAbandonedInQueueTime>\\n <CallsBlindTransferOut>0</CallsBlindTransferOut>\\n <AverageWorkTime>13</AverageWorkTime>\\n <MaxWorkTime>12</MaxWorkTime>\\n <CallsBlindTransferIn>0</CallsBlindTransferIn>\\n <AbandonRate>0</AbandonRate>\\n </Inbound>\\n <Outbound>\\n <TotalDialingTime>218</TotalDialingTime>\\n <TotalWorkTime>9</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>0</CallsRinged>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>0</MaxRingTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <TotalRingTime>0</TotalRingTime>\\n <AverageDialingTime>37</AverageDialingTime>\\n <CallsAnswered>1</CallsAnswered>\\n <TotalTalkTime>3</TotalTalkTime>\\n <CallsDialed>6</CallsDialed>\\n <MaxDialingTime>12</MaxDialingTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <CallsAttendedTransferOut>0</CallsAttendedTransferOut>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>3</AverageTalkTime>\\n <AnswerRate>0</AnswerRate>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferIn>0</CallsAttendedTransferIn>\\n <AverageRingTime>0</AverageRingTime>\\n <CallsBlindTransferOut>0</CallsBlindTransferOut>\\n <AverageWorkTime>2</AverageWorkTime>\\n <MaxWorkTime>0</MaxWorkTime>\\n <CallsBlindTransferIn>0</CallsBlindTransferIn>\\n </Outbound>\\n <Overall>\\n <TotalReadyTime>22428</TotalReadyTime>\\n <TotalCalls>13</TotalCalls>\\n <TotalBreakTime>3</TotalBreakTime>\\n <TotalWorkTime>94</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <AverageBreakTime>0</AverageBreakTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <TotalTalkTime>449</TotalTalkTime>\\n <AverageReadyTime>0</AverageReadyTime>\\n <TotalLoggedInTime>23218</TotalLoggedInTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxReadyTime>19328</MaxReadyTime>\\n <AverageWorkTime>8</AverageWorkTime>\\n <MaxWorkTime>12</MaxWorkTime>\\n <MaxBreakTime>1</MaxBreakTime>\\n <OccupancyRate>0.02332222293912065</OccupancyRate>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n </Overall>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取技能组历史数据报表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListIntervalAgentReport' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AgentId', + 'in' => 'query', + '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' => '分段统计类型，非必填，默认为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' => '943D8EF3-3321-471F-A104-51C96FCA94D6', + ], + 'Data' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<RequestId>943D8EF3-3321-471F-A104-51C96FCA94D6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <StatsTime>1620291600000</StatsTime>\\n <Inbound>\\n <TotalWorkTime>0</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>0</CallsRinged>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>0</MaxRingTime>\\n <CallsOffered>0</CallsOffered>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <CallsHandled>0</CallsHandled>\\n <TotalRingTime>0</TotalRingTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <HandleRate>0</HandleRate>\\n <CallsAttendedTransferIn>0</CallsAttendedTransferIn>\\n <TotalTalkTime>0</TotalTalkTime>\\n <AverageRingTime>0</AverageRingTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <CallsBlindTransferOut>0</CallsBlindTransferOut>\\n <AverageWorkTime>0</AverageWorkTime>\\n <CallsAttendedTransferOut>0</CallsAttendedTransferOut>\\n <MaxWorkTime>0</MaxWorkTime>\\n <CallsBlindTransferIn>0</CallsBlindTransferIn>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n </Inbound>\\n <Outbound>\\n <TotalDialingTime>148</TotalDialingTime>\\n <TotalWorkTime>4</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>0</CallsRinged>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>0</MaxRingTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <TotalRingTime>0</TotalRingTime>\\n <AverageDialingTime>30</AverageDialingTime>\\n <CallsAnswered>0</CallsAnswered>\\n <TotalTalkTime>0</TotalTalkTime>\\n <CallsDialed>5</CallsDialed>\\n <MaxDialingTime>60</MaxDialingTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <CallsAttendedTransferOut>0</CallsAttendedTransferOut>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n <AnswerRate>0</AnswerRate>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferIn>0</CallsAttendedTransferIn>\\n <AverageRingTime>0</AverageRingTime>\\n <CallsBlindTransferOut>0</CallsBlindTransferOut>\\n <AverageWorkTime>1</AverageWorkTime>\\n <MaxWorkTime>2</MaxWorkTime>\\n <CallsBlindTransferIn>0</CallsBlindTransferIn>\\n </Outbound>\\n <Overall>\\n <TotalReadyTime>763</TotalReadyTime>\\n <TotalCalls>5</TotalCalls>\\n <TotalBreakTime>1</TotalBreakTime>\\n <LastCheckoutTime>0</LastCheckoutTime>\\n <TotalWorkTime>4</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <AverageBreakTime>0</AverageBreakTime>\\n <FirstCheckInTime>0</FirstCheckInTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <TotalTalkTime>0</TotalTalkTime>\\n <AverageReadyTime>0</AverageReadyTime>\\n <TotalLoggedInTime>914</TotalLoggedInTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxReadyTime>435</MaxReadyTime>\\n <AverageWorkTime>1</AverageWorkTime>\\n <MaxWorkTime>2</MaxWorkTime>\\n <MaxBreakTime>1</MaxBreakTime>\\n <OccupancyRate>0</OccupancyRate>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n </Overall>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取坐席分段统计报表', + 'summary' => '调用ListIntervalAgentReport获取指定实例下指定坐席的分段统计报表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListIntervalInstanceReport' => [ + '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' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，格式为Unix时间戳，单位毫秒，非必填，默认为当天的0时，统计的时间精度为小时，向前取整，闭区间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '4133952000000', + 'minimum' => '0', + 'example' => '1620230400000', + ], + ], + [ + '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' => '1620316799000', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '分段统计类型，非必填，默认为Daily（按天汇总）。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Hourly' => '按小时统计', + 'Daily' => '按天统计', + ], + 'example' => 'Hourly', + ], + ], + ], + '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', + ], + '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' => '整体指标。', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": 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":"<RequestId>943D8EF3-3321-471F-A104-51C96FCA94D6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <StatsTime>1620291600000</StatsTime>\\n <Inbound>\\n <ServiceLevel20>1</ServiceLevel20>\\n <CallsAbandonedInQueue>0</CallsAbandonedInQueue>\\n <TotalWorkTime>85</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>7</CallsRinged>\\n <MaxAbandonedInIVRTime>0</MaxAbandonedInIVRTime>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>12</MaxRingTime>\\n <CallsOffered>7</CallsOffered>\\n <CallsAbandoned>0</CallsAbandoned>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <MaxAbandonedInRingTime>0</MaxAbandonedInRingTime>\\n <TotalRingTime>32</TotalRingTime>\\n <HandleRate>1</HandleRate>\\n <TotalAbandonedInIVRTime>0</TotalAbandonedInIVRTime>\\n <AverageAbandonedInQueueTime>0</AverageAbandonedInQueueTime>\\n <TotalTalkTime>447</TotalTalkTime>\\n <AverageWaitTime>5</AverageWaitTime>\\n <TotalAbandonedInRingTime>0</TotalAbandonedInRingTime>\\n <CallsQueued>7</CallsQueued>\\n <MaxTalkTime>219</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <AverageAbandonedInIVRTime>0</AverageAbandonedInIVRTime>\\n <TotalAbandonTime>0</TotalAbandonTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>64</AverageTalkTime>\\n <CallsBlindTransferred>0</CallsBlindTransferred>\\n <CallsAbandonedInIVR>0</CallsAbandonedInIVR>\\n <MaxAbandonedInQueueTime>0</MaxAbandonedInQueueTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <CallsAbandonedInRing>0</CallsAbandonedInRing>\\n <CallsHandled>7</CallsHandled>\\n <MaxWaitTime>13</MaxWaitTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferred>0</CallsAttendedTransferred>\\n <MaxAbandonTime>0</MaxAbandonTime>\\n <AverageRingTime>5</AverageRingTime>\\n <TotalWaitTime>34</TotalWaitTime>\\n <AverageAbandonTime>0</AverageAbandonTime>\\n <AverageAbandonedInRingTime>0</AverageAbandonedInRingTime>\\n <TotalAbandonedInQueueTime>0</TotalAbandonedInQueueTime>\\n <AverageWorkTime>13</AverageWorkTime>\\n <AbandonedRate>0</AbandonedRate>\\n <MaxWorkTime>17</MaxWorkTime>\\n </Inbound>\\n <Outbound>\\n <TotalDialingTime>0</TotalDialingTime>\\n <TotalWorkTime>0</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>0</CallsRinged>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>0</MaxRingTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <TotalRingTime>0</TotalRingTime>\\n <AverageDialingTime>0</AverageDialingTime>\\n <CallsAnswered>0</CallsAnswered>\\n <TotalTalkTime>0</TotalTalkTime>\\n <CallsDialed>0</CallsDialed>\\n <MaxDialingTime>0</MaxDialingTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n <AnswerRate>0</AnswerRate>\\n <CallsBlindTransferred>0</CallsBlindTransferred>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferred>0</CallsAttendedTransferred>\\n <AverageRingTime>0</AverageRingTime>\\n <AverageWorkTime>0</AverageWorkTime>\\n <MaxWorkTime>0</MaxWorkTime>\\n </Outbound>\\n <Overall>\\n <TotalReadyTime>0</TotalReadyTime>\\n <TotalCalls>0</TotalCalls>\\n <TotalBreakTime>0</TotalBreakTime>\\n <TotalWorkTime>0</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <AverageBreakTime>0</AverageBreakTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <TotalTalkTime>0</TotalTalkTime>\\n <AverageReadyTime>0</AverageReadyTime>\\n <TotalLoggedInTime>0</TotalLoggedInTime>\\n <MaxTalkTime>0</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxReadyTime>0</MaxReadyTime>\\n <AverageWorkTime>0</AverageWorkTime>\\n <MaxWorkTime>0</MaxWorkTime>\\n <MaxBreakTime>0</MaxBreakTime>\\n <OccupancyRate>0</OccupancyRate>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n </Overall>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取实例分段统计报表', + 'summary' => '调用ListIntervalInstanceReport获取指定实例的分段统计报表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListIntervalSkillGroupReport' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + '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', + ], + ], + [ + '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' => '分段统计类型，默认为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' => '943D8EF3-3321-471F-A104-51C96FCA94D6', + ], + 'Data' => [ + 'description' => '技能组分段统计数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '技能组分段统计数据。', + 'type' => 'object', + 'properties' => [ + 'StatsTime' => [ + 'description' => '时间段的开始时间，格式为Unix时间戳，单位毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1604639129000', + ], + 'Inbound' => [ + 'description' => '呼入指标。', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":"<RequestId>943D8EF3-3321-471F-A104-51C96FCA94D6</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <StatsTime>1604639129000</StatsTime>\\n <Inbound>\\n <ServiceLevel20>0</ServiceLevel20>\\n <CallsAbandonedInQueue>0</CallsAbandonedInQueue>\\n <TotalWorkTime>23</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <CallsRinged>3</CallsRinged>\\n <AverageHoldTime>0</AverageHoldTime>\\n <MaxRingTime>18</MaxRingTime>\\n <CallsOffered>3</CallsOffered>\\n <CallsAbandoned>0</CallsAbandoned>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <MaxAbandonedInRingTime>0</MaxAbandonedInRingTime>\\n <TotalRingTime>33</TotalRingTime>\\n <HandleRate>0.6666666666666666</HandleRate>\\n <AverageAbandonedInQueueTime>0</AverageAbandonedInQueueTime>\\n <TotalTalkTime>9</TotalTalkTime>\\n <AverageWaitTime>11</AverageWaitTime>\\n <TotalAbandonedInRingTime>0</TotalAbandonedInRingTime>\\n <CallsQueued>3</CallsQueued>\\n <MaxTalkTime>6</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <CallsAttendedTransferOut>0</CallsAttendedTransferOut>\\n <TotalAbandonTime>0</TotalAbandonTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>5</AverageTalkTime>\\n <MaxAbandonedInQueueTime>0</MaxAbandonedInQueueTime>\\n <CallsTimeout>0</CallsTimeout>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <CallsAbandonedInRing>0</CallsAbandonedInRing>\\n <CallsOverflow>0</CallsOverflow>\\n <CallsHandled>2</CallsHandled>\\n <MaxWaitTime>18</MaxWaitTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <CallsAttendedTransferIn>0</CallsAttendedTransferIn>\\n <MaxAbandonTime>0</MaxAbandonTime>\\n <AverageRingTime>11</AverageRingTime>\\n <TotalWaitTime>33</TotalWaitTime>\\n <AverageAbandonTime>0</AverageAbandonTime>\\n <AverageAbandonedInRingTime>0</AverageAbandonedInRingTime>\\n <TotalAbandonedInQueueTime>0</TotalAbandonedInQueueTime>\\n <CallsBlindTransferOut>0</CallsBlindTransferOut>\\n <AverageWorkTime>8</AverageWorkTime>\\n <MaxWorkTime>19</MaxWorkTime>\\n <CallsBlindTransferIn>0</CallsBlindTransferIn>\\n <AbandonRate>0</AbandonRate>\\n </Inbound>\\n <Outbound>\\n <TotalDialingTime>60</TotalDialingTime>\\n <TotalWorkTime>5</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <CallsHold>0</CallsHold>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <AverageDialingTime>30</AverageDialingTime>\\n <CallsAnswered>1</CallsAnswered>\\n <TotalTalkTime>5</TotalTalkTime>\\n <CallsDialed>2</CallsDialed>\\n <MaxDialingTime>49</MaxDialingTime>\\n <MaxTalkTime>5</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <AverageWorkTime>3</AverageWorkTime>\\n <MaxWorkTime>4</MaxWorkTime>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>5</AverageTalkTime>\\n <AnswerRate>0</AnswerRate>\\n </Outbound>\\n <Overall>\\n <TotalReadyTime>9106</TotalReadyTime>\\n <TotalCalls>5</TotalCalls>\\n <TotalBreakTime>5</TotalBreakTime>\\n <TotalWorkTime>27</TotalWorkTime>\\n <TotalHoldTime>0</TotalHoldTime>\\n <SatisfactionSurveysOffered>0</SatisfactionSurveysOffered>\\n <AverageHoldTime>0</AverageHoldTime>\\n <SatisfactionIndex>0</SatisfactionIndex>\\n <AverageBreakTime>0</AverageBreakTime>\\n <SatisfactionSurveysResponded>0</SatisfactionSurveysResponded>\\n <TotalTalkTime>13</TotalTalkTime>\\n <AverageReadyTime>0</AverageReadyTime>\\n <TotalLoggedInTime>9236</TotalLoggedInTime>\\n <MaxTalkTime>6</MaxTalkTime>\\n <SatisfactionRate>0</SatisfactionRate>\\n <MaxReadyTime>4927</MaxReadyTime>\\n <AverageWorkTime>6</AverageWorkTime>\\n <MaxWorkTime>19</MaxWorkTime>\\n <MaxBreakTime>1</MaxBreakTime>\\n <OccupancyRate>0.00422315148470254</OccupancyRate>\\n <MaxHoldTime>0</MaxHoldTime>\\n <AverageTalkTime>0</AverageTalkTime>\\n </Overall>\\n</Data>\\n<Code>OK</Code>","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' => '节点的属性集合。', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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":"<RequestId>D2RB671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>4</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Callee>053xxxx3128</Callee>\\n <NodeName>放音</NodeName>\\n <Instance>ccc-test</Instance>\\n <EnterTime>1621910542876</EnterTime>\\n <NodeExitCode>Success</NodeExitCode>\\n <ContactId>job-109634426711871319</ContactId>\\n <ChannelId>65cp2c15-92ac-4e67-98b2-073a3c541c5d</ChannelId>\\n <ChannelVariables>A=B;C=D</ChannelVariables>\\n <FlowId>abc99462-1058-47d0-a114-f145ea7444ff</FlowId>\\n <LeaveTime>1621910545105</LeaveTime>\\n <NodeProperties>{\\"say\\":\\"您好。\\"}</NodeProperties>\\n <Caller>133xxxx2315</Caller>\\n <FlowName>测试IVR</FlowName>\\n <NodeType>PLAY_OR_SAY</NodeType>\\n <NodeId>e0bc19a3</NodeId>\\n <NodeVariables>{\\"digits\\":\\"2\\"}</NodeVariables>\\n </List>\\n</Data>\\n<Code>OK</Code>","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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Extension>80317391</Extension>\\n <CounterParty>user-admin@ccc-test</CounterParty>\\n <StateTime>8</StateTime>\\n <InstanceId>ccc-test</InstanceId>\\n <State>ACW</State>\\n <StateCode>Monitored</StateCode>\\n <AgentName>云呼测试坐席</AgentName>\\n <AgentId>user-test@ccc-test</AgentId>\\n </List>\\n <List>\\n <SkillGroupIdList>[\\"skg-default@ccc-test\\"]</SkillGroupIdList>\\n </List>\\n</Data>\\n<Code>OK</Code>","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":"<RequestId>26A34338-5CD9-4C95-A7A6-5BDCE76C6B94</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>2</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <BreakingAgents>0</BreakingAgents>\\n <TalkingAgents>0</TalkingAgents>\\n <SkillGroupName>test1</SkillGroupName>\\n <InstanceId>ccc-test</InstanceId>\\n <LoggedInAgents>2</LoggedInAgents>\\n <ReadyAgents>2</ReadyAgents>\\n <WaitingCalls>0</WaitingCalls>\\n <SkillGroupId>skg-test1@ccc-test</SkillGroupId>\\n <LongestCall>0</LongestCall>\\n <WorkingAgents>0</WorkingAgents>\\n </List>\\n</Data>\\n<Code>OK</Code>","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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>11</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <SkillGroupIds>skg-default@ccc-test</SkillGroupIds>\\n <CalledNumber>133xxxx2315</CalledNumber>\\n <ContactType>Outbound</ContactType>\\n <InstanceId>ccc-test</InstanceId>\\n <ContactDisposition>Success</ContactDisposition>\\n <StartTime>1532448000000</StartTime>\\n <AgentIds>user-test@ccc-test</AgentIds>\\n <Duration>16</Duration>\\n <ContactId>job-76604722428454704</ContactId>\\n <CallDuration>16</CallDuration>\\n <CallingNumber>053xxxx3128</CallingNumber>\\n </List>\\n</Data>\\n<Code>OK</Code>","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":"<ListVoicemailsResponse>\\n <Code>OK</Code>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Message>无</Message>\\n <RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n <Data>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>11</TotalCount>\\n <List>\\n <CdrStartTime>1532448000000</CdrStartTime>\\n <Caller>073xxxx7539</Caller>\\n <ContactId>job-125152394144124921</ContactId>\\n <RecordingDuration>10</RecordingDuration>\\n <InstanceId>ccc-test</InstanceId>\\n <Name>voicemail-test</Name>\\n </List>\\n </Data>\\n</ListVoicemailsResponse>","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":"<p>好的，不客气</p>","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\\\\\\":\\\\\\"<p>好的，不客气</p>\\\\\\",\\\\\\"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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <FileUrl>http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-65382141036893491.wav?Expires=1610910578&OSSAccessKeyId=XXXX&Signature=XXXX</FileUrl>\\n <FileName>job-65382141036893491.wav</FileName>\\n</Data>\\n<Code>OK</Code>","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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <FileUrl>http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-65382141036893491.mkv?Expires=1610910578&OSSAccessKeyId=XXXX&Signature=XXXX</FileUrl>\\n <FileName>job-65382141036893491.mkv</FileName>\\n</Data>\\n<Code>OK</Code>","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":"<GetVoicemailRecordingResponse>\\n <Code>OK</Code>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Message>无</Message>\\n <RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n <Data>\\n <FileUrl>http://xxxx</FileUrl>\\n <FileName>abc</FileName>\\n </Data>\\n</GetVoicemailRecordingResponse>","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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <UserName>1602585817:null</UserName>\\n <Password>M0NQNG/uRUrfIxW7er/S9gKXsT0=</Password>\\n</Data>\\n<Code>OK</Code>","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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <Value>1</Value>\\n <ObjectType>INSTANCE</ObjectType>\\n <ObjectId>ccc-test</ObjectId>\\n <InstanceId>ccc-test</InstanceId>\\n <Name>test-item</Name>\\n</Data>\\n<Code>OK</Code>","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":"<RequestId>8E7Y5B39-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Code>OK</Code>","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":"<p>这种的名片选单面还是双面</p>"}', + ], + ], + ], + ], + '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\\\\\\":\\\\\\"<p>这种的名片选单面还是双面</p>\\\\\\"}\\"\\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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B06B3244-1B44-481B-90C4-F2F92E59D6B5\\"\\n}","type":"json"}]', + 'title' => '结束聊天', + 'summary' => '通话ReleaseChat接口结束当前聊天。', + ], + 'StartChat' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'UserList', + '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, + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => '网络业务的渠道Token。', + 'type' => 'string', + 'required' => false, + 'example' => '9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3bjEn0YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jg************Hwej7WgWrmA=', + ], + ], + [ + 'name' => 'AccessChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '网络业务渠道ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cf584733-***-***-9699-cb77aa3b7aa6', + ], + ], + ], + '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' => [ + 'ChatConversationId' => [ + 'description' => '聊天会话ID。', + 'type' => 'string', + 'example' => '$23086709$EAUNIT', + ], + 'JobId' => [ + 'description' => '话务ID。', + 'type' => 'string', + 'example' => 'chat-525523618219921408', + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + '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' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '话务ID。', + 'type' => 'string', + 'required' => 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' => 'B59382D2-5755-4C6D-861F-FA2AAD8F89F7', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + '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' => '无', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + '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' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '话务ID。', + 'type' => 'string', + 'required' => 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' => '2263B273-AC1B-44EB-BA98-87F2322C6780', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + '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' => '3d26b90a-c5d2-4b09-8219-********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'DescribeTicketResponse', + 'description' => 'DescribeTicketResponse', + 'type' => 'object', + 'properties' => [ + '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' => '无', + ], + ], + ], + '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' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => 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' => [ + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + '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' => false, + 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'description' => '处理意见。', + 'type' => 'string', + 'required' => false, + 'example' => '关单', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'CloseTicketResponse', + 'description' => 'CloseTicketResponse', + 'type' => 'object', + 'properties' => [ + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '工单状态。'."\n" + .'- Processing（处理中）'."\n" + .'- Withdrawal（已撤回）'."\n" + .'- Rejected（已退回）'."\n" + .'- Closed（已关单）', + 'type' => 'string', + 'required' => false, + 'example' => '无', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '工单类目ID。', + 'type' => 'string', + 'required' => false, + 'example' => '43c2671b-***-***-86d0-6bd187905cc8', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，基于工单创建时间过滤。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1716998400000', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Participant', + 'in' => 'query', + 'schema' => [ + 'description' => '参与人ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'participant@ccc-test'."\n", + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + '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' => [ + 200 => [ + 'schema' => [ + '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', + ], + 'Data' => [ + 'description' => '数据。', + 'type' => 'object', + 'properties' => [ + 'TicketsCreated' => [ + 'description' => '工单创建数量。', + 'type' => 'string', + 'example' => '10', + ], + 'TicketsParticipated' => [ + 'description' => '工单已处理数量。', + 'type' => 'string', + 'example' => '5', + ], + 'TicketsAssigned' => [ + 'description' => '工单待处理数量。', + 'type' => 'string', + 'example' => '3', + ], + ], + ], + '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', + ], + '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' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'description' => '处理意见。', + 'type' => 'string', + 'required' => false, + 'example' => '信息已补充', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'CloseTicketResponse', + 'description' => 'CloseTicketResponse', + 'type' => 'object', + 'properties' => [ + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '工单模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => '**43c2671b-8939-4223-***-6bd187905cc8_1717664210492', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', + ], + ], + ], + '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' => '无', + ], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '错误参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + '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' => false, + 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'description' => '处理意见。', + 'type' => 'string', + 'required' => false, + 'example' => '请补充信息。', + ], + ], + ], + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '工单模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc-test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'DisableTicketTemplateResponse', + 'description' => 'DisableTicketTemplateResponse', + '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' => '无', + ], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '错误参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TicketId', + 'in' => 'query', + 'schema' => [ + 'description' => '工单ID。', + 'type' => 'string', + 'required' => true, + 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', + ], + ], + [ + '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' => 'CancelTicketResponse', + 'description' => 'CancelTicketResponse', + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + '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' => false, + 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', + ], + ], + ], + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'deprecated' => false, + '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', + ], + ], + [ + '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' => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + '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', + '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' => '错误参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '错误参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TicketId', + 'in' => 'query', + 'schema' => [ + 'description' => '工单ID。', + 'type' => 'string', + 'required' => false, + 'example' => '3d26b90a-c5d2-4b09-8219-********', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc-test', + ], + ], + ], + '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' => '无', + ], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '错误参数', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '工单模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc-test', + ], + ], + ], + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'TicketId', + 'in' => 'query', + 'schema' => [ + 'description' => '工单ID。', + 'type' => 'string', + 'required' => true, + 'example' => '3d26b90a-c5d2-4b09-8219-********', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '工单流程节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => '3b8c672f-48f6-45f5-bf41-9d4cb2b4a716', + ], + ], + [ + 'name' => 'Assignee', + 'in' => 'query', + 'schema' => [ + 'description' => '加签指派的处理人。', + 'type' => 'string', + 'required' => true, + 'example' => 'assignee@ccc-test', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'description' => '处理意见。', + 'type' => 'string', + 'required' => true, + 'example' => '请assignee处理。', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + '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' => [ + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'SearchPattern', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称，模糊搜索。', + 'type' => 'string', + 'required' => false, + 'example' => '模板1', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '工单类目ID。', + 'type' => 'string', + 'required' => false, + 'example' => '43c2671b-********86d0-6bd187905cc8', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListTicketTemplatesResponse', + 'description' => 'ListTicketTemplatesResponse', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '数据。', + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + '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****', + ], + ], + [ + 'name' => 'Context', + 'in' => 'query', + 'schema' => [ + 'description' => '工单字段信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{"productName":"玩具1"}', + ], + ], + ], + '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' => 'A450574A-337F-43E2-BC59-9C6594C994C6', + ], + 'Data' => [ + 'description' => '返回数据，工单ID。', + 'type' => 'string', + 'example' => '3d26b90a-c5d2-4b09-8219-60cda1******', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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创建工单。', + ], + 'ListCategories' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '类目类别。', + 'type' => 'string', + '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' => [ + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'required' => false, + 'example' => '4ca2e2-c8d19b82c-d7ce393ac8197d3ab', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'TemplateVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '模板版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1703517780627', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'GetTicketTemplateResponse', + 'description' => 'GetTicketTemplateResponse', + 'type' => 'object', + 'properties' => [ + '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', + ], + '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' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + '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' => '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' => [ + '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.', + ], + [ + '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', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalService.DB', + 'errorMessage' => 'An internal DB service error occurred. %s', + ], + ], + ], + '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":"<Message>无</Message>\\n<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Item>TagA</Item>\\n <Reason>CUSTOM_NUMBER_DUPLICATED</Reason>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '创建多个号码标签', + ], + 'CreateCustomCallTagging' => [ + 'summary' => '调用CreateCustomCallTagging在指定实例下创建一个或多个呼入号码标记。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'CustomNumberList', + '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"]}]', + ], + ], + ], + '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' => '无', + ], + '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', + ], + ], + 'enumValueTitles' => [], + ], + ], + ], + 'enumValueTitles' => [], + ], + ], + ], + '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.', + ], + ], + 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', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CCC::2020-07-01::CreateCustomCallTaggings', + ], + ], + '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":"<Message>无</Message>\\n<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Item>TagA</Item>\\n <Reason>CUSTOM_NUMBER_DUPLICATED</Reason>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '创建多个呼入号码标记', + ], + 'DeleteCallTag' => [ + 'summary' => '调用DeleteCallTag删除指定实例下的号码标签。', + 'methods' => [ + 'get', + 'post', + ], + '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' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => '号码标签名称，请确保传入的标签是已创建的号码标签。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TagA', + ], + ], + ], + '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' => '无', + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>无</Message>\\n<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '删除号码标签', + ], + 'DeleteCustomCallTagging' => [ + 'summary' => '调用DeleteCustomCallTagging删除指定实例下指定号码对应的呼入号码标记。', + 'methods' => [ + 'get', + 'post', + ], + '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' => 'Number', + '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', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>无</Message>\\n<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '删除呼入号码标记', + ], + 'ExportCustomCallTagging' => [ + 'summary' => '调用ExportCustomCallTagging导出指定实例下的全部呼入号码标记。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc-test', + ], + ], + ], + '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
', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CCC::2020-07-01::ExportCustomCallTaggings', + ], + ], + '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":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F
</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/tagging.xlsx ?Expires=1610910578&OSSAccessKeyId=KZEA4GDDtCg431rmXTiEhr1q&Signature=4bXjOtUYgXl2z9iWpk3tXxS8SGY%3D</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '导出呼入号码标记', + ], + 'ImportCustomCallTagging' => [ + 'summary' => '调用ImportCustomCallTagging导入多个呼入号码标记到指定实例中。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc-test', + ], + ], + [ + 'name' => 'FilePath', + 'in' => 'query', + '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' => [ + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CCC::2020-07-01::ImportCustomCallTaggings', + ], + ], + '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":"<Message>无</Message>\\n<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Item>TagA</Item>\\n <Reason>CUSTOM_NUMBER_DUPLICATED</Reason>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '导入呼入号码标记', + ], + 'ListBlacklistCallTaggings' => [ + 'summary' => '批量查询指定号码黑名单打标状态。', + 'methods' => [ + 'get', + 'post', + ], + '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' => 'NumberList', + 'in' => 'query', + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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":"<Message>无</Message>\\n<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <TagName>TagA</TagName>\\n <InstanceId>ccc-test</InstanceId>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取号码标签列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListCustomCallTagging' => [ + 'summary' => '调用ListCustomCallTagging获取指定实例下的呼入号码标记列表。', + '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-100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，范围1-100。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'SearchPattern', + 'in' => 'query', + 'schema' => [ + 'description' => '根据号码或描述进行模糊匹配，非必填，默认为空，为空表示不过滤。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1312121****', + ], + ], + [ + 'name' => 'CallTagNameList', + 'in' => 'query', + 'schema' => [ + 'description' => '按号码标签名称列表过滤，非必填，默认为空，表示不过滤。格式为JSON数组的字符串，数组元素是号码标签名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '["TagA"]', + ], + ], + ], + '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' => '无', + ], + 'Data' => [ + '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' => '呼入号码标记列表。', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CCC::2020-07-01::ListCustomCallTaggings', + ], + ], + '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":"<Message>无</Message>\\n<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Description>TagA</Description>\\n <Number>083xxxx0011</Number>\\n <InstanceId>ccc-test</InstanceId>\\n <UpdateTime>2020-07-05 00:00:00.0</UpdateTime>\\n <Creator>user-test</Creator>\\n <CallTagList>\\n <TagName>TagA</TagName>\\n <InstanceId>ccc-test</InstanceId>\\n </CallTagList>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取呼入号码标记列表', + ], + 'ModifyCustomCallTagging' => [ + 'summary' => '调用ModifyCustomCallTagging修改指定实例下指定号码对应的呼入号码标记的信息，可以修改呼入号码标记的描述和绑定的号码标签。', + 'methods' => [ + 'get', + 'post', + ], + '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' => 'Number', + 'in' => 'query', + 'schema' => [ + 'description' => '呼入号码标记的号码，会根据号码匹配待修改的呼入号码标记。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1312121****', + ], + ], + [ + 'name' => 'CallTagNameList', + 'in' => 'query', + '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' => '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.', + ], + [ + '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', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>无</Message>\\n<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '修改呼入号码标记', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveBlacklistCallTagging' => [ + 'summary' => '移除指定号码的黑名单标签。', + 'methods' => [ + 'get', + 'post', + ], + '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' => 'Number', + 'in' => 'query', + '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****', + ], + ], + ], + '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' => '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.', + ], + ], + 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', + ], + ], + ], + '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', + ], + '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', + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'description' => '应用范围，包括SYSTEM和INSTANCE，分别对应系统级禁止外呼和客户自定义禁止外呼，SYSTEM是关联实例所属的阿里云主账号的，INSTANCE只和当前实例关联，非必填，默认值INSTANCE。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'SYSTEM' => '系统级禁止外呼配置', + 'INSTANCE' => '实例级禁止外呼配置', + ], + 'example' => 'INSTANCE', + ], + ], + ], + '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/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' => '无', + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>https://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</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '导出禁止外呼号码', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetDoNotCallFileUploadParameters' => [ + 'summary' => '调用GetDoNotCallFileUploadParameters获取禁呼文件的上传参数，当通过文件导入禁止外呼号码时，需要先调用此接口将禁呼号码文件上传到云联络中心的公共OSS空间，之后再调用ImportDoNotCallNumbers执行导入。', + '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' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => '禁止外呼号码文件的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'blacklist.xlsx', + ], + ], + ], + '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' => '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' => '****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <Policy>eyJleHBpcmF0aW9uIjoiMjAyMi0wMy0xNVQwMzowMzo0MC4zMTJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwidGVtcC9ibGFja2xpc3QvaW1wb3J0LzE1NzcyNDcxMTU0OTA0MDEvY2NjVjIta216LzIwMjIE1MTAwMzQwLyJdXX0=</Policy>\\n <FilePath>temp/blacklist/import/157724711549xxxx/ccc-test/20220315100340/blacklist.xlsx</FilePath>\\n <AccessKeyId>LTAI4GDDtCgcY8HmXTiExxxx</AccessKeyId>\\n <Signature>zi31STIMtIfa/UN2l+6lwwe9o=</Signature>\\n <Host>https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com</Host>\\n <ExpireTime>1647313420</ExpireTime>\\n</Data>\\n<Code>OK</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '获取禁呼文件上传参数', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ImportDoNotCallNumbers' => [ + 'summary' => '调用ImportDoNotCallNumbers向指定实例下导入一个或多个禁止外呼号码，导入方式包括手动录入和文件上传两种方式。', + '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' => 'NumberList', + 'in' => 'query', + 'schema' => [ + 'description' => '禁止外呼号码列表，格式为JSON数组的字符串，数组元素是禁呼号码。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '["1900000****","1312121****"]', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '禁呼号码的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + [ + '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' => [ + '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' => '无', + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '导入禁止外呼号码', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListDoNotCallNumbers' => [ + 'summary' => '获取指定实例下指定搜索条件过滤后的禁止外呼号码列表。', + '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', + ], + ], + [ + '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' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'description' => '应用范围，包括SYSTEM和INSTANCE，分别对应系统级禁止外呼和客户自定义禁止外呼，SYSTEM是关联实例所属的阿里云主账号的，INSTANCE只和当前实例关联，非必填，默认值INSTANCE。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'SYSTEM' => '系统级禁止外呼配置', + 'INSTANCE' => '实例级禁止外呼配置', + ], + 'example' => 'INSTANCE', + ], + ], + ], + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + '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.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.', + ], + ], + ], + '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":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Scope>INSTANCE</Scope>\\n <Number>190xxxx0000</Number>\\n <CreateTime>1626962425000</CreateTime>\\n <Creator>user-test</Creator>\\n <Remark>RemarkA</Remark>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取禁止外呼号码列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveDoNotCallNumbers' => [ + 'summary' => '调用RemoveDoNotCallNumbers删除指定实例下的一个或多个禁止外呼号码配置项。', + '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' => 'NumberList', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的禁止外呼号码列表，格式为JSON数组的字符串，数组长度区间为1-300。', + 'type' => 'string', + 'required' => false, + 'example' => '["1900000****","1312211****"]', + ], + ], + ], + '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' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', + ], + 'Params' => [ + 'description' => '错误消息中占位符对应的响应参数。', + 'type' => 'array', + 'items' => [ + 'description' => '响应参数。', + 'type' => 'string', + 'example' => 'numberList', + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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":"<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Params>无</Params>\\n<Data>无</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '删除禁止外呼号码', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListFlashSmsSettings' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SkillGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '技能组名称。', + 'type' => 'string', + 'required' => false, + 'example' => '闪信测试技能组', + ], + ], + [ + 'name' => 'SkillGroupIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + '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' => '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' => '无', + ], + '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', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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接口获取指定技能组闪信相关配置。', + ], + 'ListFlashSmsApplications' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + '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', + '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', + ], + ], + ], + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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获取第三方闪信配置信息。', + ], + 'ListFlashSmsTemplates' => [ + 'summary' => '使用ListFlashSmsTemplates获取闪信模板信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcccIPHVDY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProviderId', + 'in' => 'query', + '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, + 'example' => 'ccc-test', + ], + ], + ], + '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' => '无', + ], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '错误参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '251523', + 'abilityTreeNodes' => [ + 'FEATUREcccBM6DRP', + ], + ], + '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' => '100', + ], + ], + [ + 'name' => 'ScenarioListJson', + '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"]', + ], + ], + ], + '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' => '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' => '云呼叫中心', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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获取短信配置详情。', + ], + 'ExportContactFlow' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '251084', + 'abilityTreeNodes' => [ + 'FEATUREcccTPIKHY', + ], + ], + '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' => 'formData', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', + ], + ], + ], + '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' => '响应参数。', + 'type' => 'array', + 'items' => [ + 'description' => '错误参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '251083', + 'abilityTreeNodes' => [ + 'FEATUREcccTPIKHY', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowPackageData', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据', + 'type' => 'string', + 'required' => true, + 'example' => '{}', + ], + ], + [ + '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' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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.', + ], + ], + ], + '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', + ], + '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' => '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', + ], + ], + [ + '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' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小，范围1-100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '按IVR流程类型过滤，非必填，默认为空，为空表示不过滤。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'SURVEY_FLOW' => '满意度流程', + 'SUB_FLOW' => '子流程', + 'MAIN_FLOW' => '主流程', + ], + 'example' => 'MAIN_FLOW', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方向。取值范围：'."\n" + .'- **ASC**：升序'."\n" + .'- **DESC**（默认值）：降序', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'OrderByField', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'updatedTime', + ], + ], + [ + 'name' => 'SearchPattern', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + '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' => '分页序号。', + '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', + ], + 'NumberList' => [ + 'description' => 'IVR联系流绑定的号码列表。', + 'type' => 'array', + 'items' => [ + 'description' => '号码', + 'type' => 'string', + 'example' => '400289****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": 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":"<RequestId>EEEE671A-3E24-4A04-81E6-6C4F5B39DF75</RequestId>\\n<Message>无</Message>\\n<HttpStatusCode>200</HttpStatusCode>\\n<Data>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <List>\\n <Type>MAIN_FLOW</Type>\\n <Description>1.0</Description>\\n <CreatedTime>2021-03-05 17:35:45.0</CreatedTime>\\n <InstanceId>ccc-test</InstanceId>\\n <ContactFlowId>78128960-bb00-4ddc-8e82-923a8c5bd22d</ContactFlowId>\\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\\":\\"\\"}</Definition>\\n <Published>true</Published>\\n <UpdatedTime>2021-03-08 15:34:49.0</UpdatedTime>\\n <DraftId>db07c0bb-6b1f-47d2-b37e-2451c617562d</DraftId>\\n <Editor>ccc-test</Editor>\\n <Name>测试IVR</Name>\\n <NumberList>[\\"400xxxx289\\"]</NumberList>\\n </List>\\n</Data>\\n<Code>OK</Code>","errorExample":""}]', + 'title' => '获取联系流列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetContactFlow' => [ + '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' => 'ContactFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '联系流ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '274601be-a6d5-4429-bcef-32b51d031c6e', + ], + ], + [ + 'name' => 'DraftId', + 'in' => 'query', + 'schema' => [ + 'description' => '草稿ID，当前联系流对应的可编辑草稿版本ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '566399d7-5558-447c-a72f-9be2768b6a82', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 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\\": \\"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', + ], + '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' => 'ContactFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '联系流ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '798e83a9-5140-4039-afa1-761ca4cca2df', + ], + ], + ], + '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' => '数据，联系流草稿ID。', + 'type' => 'string', + 'example' => 'b3114362-9062-46c7-82dc-ae55ac168b2e', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BC2733CE-C470-564A-8C11-9DC02468823A', + ], + ], + ], + ], + ], + '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\\": \\"b3114362-9062-46c7-82dc-ae55ac168b2e\\",\\n \\"RequestId\\": \\"BC2733CE-C470-564A-8C11-9DC02468823A\\"\\n}","type":"json"}]', + 'title' => '创建联系流草稿', + 'summary' => '发起编辑联系流，生成联系流草稿。', + ], + 'CommitContactFlow' => [ + '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' => 'ContactFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '联系流ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '7d706489-d06d-4a92-8666-8c9dba2c5cb1', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'DraftId', + 'in' => 'query', + 'schema' => [ + 'description' => '草稿ID，当前联系流对应的草稿版本ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'b28f74ca-5846-4496-8bbd-34fb1750798c', + ], + ], + ], + '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' => '937617D5-01E9-5A39-B52D-15D5C143260C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 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\\": \\"937617D5-01E9-5A39-B52D-15D5C143260C\\"\\n}","type":"json"}]', + 'title' => '提交联系流', + 'summary' => '提交联系流。', + ], + 'PublishContactFlow' => [ + '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' => 'ContactFlowId', + 'in' => 'query', + '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' => [ + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 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\\": \\"BFB6788F-20D4-5767-BC67-99EAAC28F789\\"\\n}","type":"json"}]', + 'title' => '发布联系流', + 'summary' => '发布联系流。', + ], + 'DiscardEditingContactFlow' => [ + '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' => 'ContactFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '联系流ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '3ff4e021-fd63-4572-ad8c-10ed69972965', + ], + ], + [ + 'name' => 'DraftId', + 'in' => 'query', + 'schema' => [ + 'description' => '草稿ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0aa493d6-58eb-4290-9ba2-e1c2c615b46b', + ], + ], + ], + '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' => 'CB72B537-B531-598F-9617-A636FB8040C0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 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\\": \\"CB72B537-B531-598F-9617-A636FB8040C0\\"\\n}","type":"json"}]', + 'title' => '撤销联系流编辑', + 'summary' => '撤销联系流编辑，丢弃对应草稿。', + ], + 'DeleteContactFlow' => [ + 'summary' => '删除指定联系流。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + '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', + ], + ], + [ + 'name' => 'ContactFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '联系流ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0f87c997-b0c1-41d4-9e9e-1b791de6ad1f', + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + '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' => '07511949-6DC4-5D0B-8FA8-FF8FA29B4217', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 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\\": \\"07511949-6DC4-5D0B-8FA8-FF8FA29B4217\\"\\n}","type":"json"}]', + 'title' => '删除联系流', + ], + 'DeleteSchemaProperty' => [ + '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' => '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' => 'formData', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', + ], + ], + ], + '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.', + ], + 'Params' => [ + 'description' => '错误参数信息', + 'type' => 'array', + 'items' => [ + 'description' => '错误参数', + 'type' => 'string', + 'example' => 'id格式错误', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + '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' => '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' => [ + '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' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + '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' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', + ], + ], + ], + '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\']', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + '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' => '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' => 'GetSchemaResponse', + 'description' => 'GetSchemaResponse', + 'type' => 'object', + 'properties' => [ + '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' => '字段列表', + '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' => '更新时间', + ], + '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' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + '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', + ], + ], + [ + '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' => [ + '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' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + '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.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + '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' => '姓名', + ], + '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' => 'RequestId', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求ID', + 'type' => 'string', + 'required' => false, + 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '实例 ID', + 'type' => 'string', + 'required' => true, + 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx', + ], + ], + ], + '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' => '无', + ], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => [ + 'description' => '参数信息。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + '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.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + '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' => 'RequestId', + 'in' => 'formData', + 'schema' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'required' => false, + 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3', + ], + ], + [ + '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' => [ + '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' => '响应参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + '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' => 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' => [ + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + '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' => '无', + ], + 'Params' => [ + 'description' => '响应参数。', + 'type' => 'array', + 'items' => [ + 'description' => '响应参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + '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' => [ + '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' => '响应参数。', + 'type' => 'array', + 'items' => [ + 'description' => '响应参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + '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', + ], + ], + ], + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + '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' => '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' => [ + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc-test', + ], + ], + ], + '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' => '无', + ], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '错误参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TicketId', + 'in' => 'query', + 'schema' => [ + 'description' => '小结ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5', + ], + ], + [ + 'name' => 'Context', + 'in' => 'query', + 'schema' => [ + 'title' => '更新内容', + 'description' => '更新内容。', + 'type' => 'string', + 'required' => false, + 'example' => '{"summaryTitle":"标题","summaryContent":"内容","keywords":"关键信息"}', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc-test', + ], + ], + ], + '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' => '无', + ], + 'Params' => [ + 'description' => '错误参数列表。', + 'type' => 'array', + 'items' => [ + 'description' => '错误参数。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + ], + ], + '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\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', + 'title' => '更新会话小结', + 'summary' => '使用UpdateCallSummary更新会话小结。', + ], + 'CreateCallSummary' => [ + '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' => 'Context', + 'in' => 'query', + 'schema' => [ + 'title' => 'summary信息', + 'description' => 'summary信息', + 'type' => 'string', + 'required' => false, + 'example' => '{"summaryTitle":"标题","summaryContent":"内容","keywords":"关键信息"}', + ], + ], + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => [ + 'title' => '会话ID', + 'description' => '会话ID', + 'type' => 'string', + 'required' => false, + 'example' => 'job-522327189435260928', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc-test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'ContactIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '通话ID列表', + 'description' => '通话ID列表。', + 'type' => 'array', + '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' => 'ListCallSummariesResponse', + 'description' => 'ListCallSummariesResponse', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + ], + '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' => '无', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExists.InstanceId', + 'errorMessage' => 'The specified instance %s does not exist.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + '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' => false, + 'example' => 'job-10963442671187****', + ], + ], + [ + 'name' => 'TaskListJson', + 'in' => 'query', + 'schema' => [ + 'description' => '分析的任务类型列表。其内容可以是：'."\n" + .'- title：标题'."\n" + .'- summary：小结'."\n" + .'- keywords：关键词'."\n" + .'- fields：字段'."\n" + ."\n" + .'目前仅summary和title可同时传递，其他的参数只能单独传递。', + 'type' => 'string', + 'required' => false, + 'example' => '["keywords"]', + ], + ], + [ + 'name' => 'FieldListJson', + '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" + .']', + ], + ], + ], + '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' => '9F766284-F103-4298-8EC5-19F9F9BE5522', + ], + 'Data' => [ + 'description' => '返回结果。根据分析任务的不同，返回的内容也不相同。', + 'type' => 'string', + 'example' => '{'."\n" + .' "订单号": "1234",'."\n" + .' "商品名称": "笔记本"'."\n" + .'}', + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '此接口可用于在线会话以及语音会话。当用于语音会话时，需要实现开启语音实时转写的功能。', + ], + 'AddFeedback' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + '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', + ], + ], + [ + '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' => [ + 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', + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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功能进行评价打分。', + ], + 'GetUploadAudioDataParams' => [ + 'summary' => '获取离线质检音频文件相关参数。一般情况下，如果客户在云联络中心中配置了质检功能，则需要离线质检的音频文件和相应的参数会自动传递给智能质检；只有当客户没有在云联络中心中配置质检功能，并且希望自己把云联络中心的录音推送给质检时才需要调用此接口获取推送质检录音的相关参数。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + '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****', + ], + ], + ], + '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" + .'}', + ], + ], + ], + ], + ], + ], + ], + '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' => '获取离线质检音频相关参数', + ], + 'ListFeedbacks' => [ + 'summary' => '查询反馈记录', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + '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"]', + ], + ], + ], + '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****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'NotExist.Instance', + 'errorMessage' => 'Call center instance %s does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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' => '查询反馈记录', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'ccc.cn-shanghai.aliyuncs.com', + ], + ], +]; |