'1.0',
'info' => [
'style' => 'RPC',
'product' => 'CCC',
'version' => '2017-07-05',
],
'directories' => [
[
'id' => 58590,
'title' => '统计',
'type' => 'directory',
'children' => [
'ListVoiceAppraise',
'LaunchAppraise',
'SaveWebRTCStats',
],
],
[
'id' => 58594,
'title' => '联系流程',
'type' => 'directory',
'children' => [
'CreateContactFlow',
'ListContactFlows',
'GetRoutePoint',
'ListIvrTrackingDetail',
'CommitContactFlowVersionModification',
'PublishContactFlowVersion',
],
],
[
'id' => 58601,
'title' => '录音',
'type' => 'directory',
'children' => [
'GetRecordOssUploadParam',
'ListRecordingOfDualTrack',
'ListRecordingsByContactId',
'DownloadAllTypeRecording',
'DownloadRecording',
],
],
[
'id' => 58607,
'title' => '通话',
'type' => 'directory',
'children' => [
'ModifyPrivacyNumberCallDetail',
'StartBack2BackCall',
'ListCallDetailRecords',
'ListCallEventDetailByContactId',
'ListRecentCallRecords',
'GetConversationDetailByContactId',
'DialEx',
'CallOnlinePrivacyNumber',
],
],
[
'id' => 58618,
'title' => '配置',
'type' => 'directory',
'children' => [
'GetConfig',
'ListConfig',
],
],
[
'id' => 58621,
'title' => '标签',
'type' => 'directory',
'children' => [
'AddPhoneTags',
'DeletePhoneTags',
'ModifyPhoneTags',
'ListPhoneTags',
],
],
[
'id' => 58626,
'title' => '号码',
'type' => 'directory',
'children' => [
'AddBulkPhoneNumbers',
'AddPhoneNumber',
'ModifyPhoneNumber',
'GetNumberRegionInfo',
'GetServiceExtensions',
'ListPhoneNumbers',
'CheckNumberAvaliable',
'PickOutboundNumbers',
'RemovePhoneNumber',
'PickGlobalOutboundNumbers',
'PickLocalNumber',
],
],
[
'id' => 58638,
'title' => '实例',
'type' => 'directory',
'children' => [
'CreateInstance',
'CreateVoiceAppraise',
'DeleteInstance',
'GetInstance',
'GetInstanceState',
'ListInstancesOfUser',
],
],
[
'id' => 58649,
'title' => '供应商',
'type' => 'directory',
'children' => [
'DisableTrunkProviders',
'ListTrunkProviders',
],
],
[
'id' => 58652,
'title' => '媒体',
'type' => 'directory',
'children' => [
'CreateMedia',
'DeleteMedia',
'ListMedias',
],
],
[
'id' => 58656,
'title' => 'TURN服务',
'type' => 'directory',
'children' => [
'GetTURNCredentials',
'GetTURNServerList',
],
],
[
'id' => 58659,
'title' => '调查',
'type' => 'directory',
'children' => [
'CreateFault',
],
],
[
'id' => 58667,
'title' => '报表',
'type' => 'directory',
'children' => [
'ListCallMeasureSummaryReports',
'GetCallMeasureSummaryReport',
'GetInstanceSummaryReport',
'GetInstanceSummaryReportByInterval',
'GetInstanceSummaryReportSinceMidnight',
],
],
[
'id' => 58673,
'title' => '客服',
'type' => 'directory',
'children' => [
'CreateUser',
'GetUserByExtension',
'AssignUsers',
'ResetUserStatus',
],
],
[
'id' => 58678,
'title' => '用户',
'type' => 'directory',
'children' => [
'ModifyUser',
'GetUser',
'ListUsers',
'ListRoles',
'FindUsers',
'RemoveUsers',
],
],
[
'id' => 58685,
'title' => '坐席',
'type' => 'directory',
'children' => [
'AddAgentDevice',
'ModifyAgentDevice',
'ListRealTimeAgent',
'ListAgentStateLogs',
'ListAgentStates',
'ListAgentSummaryReports',
'ListAgentSummaryReportsByInterval',
'ListAgentSummaryReportsSinceMidnight',
'GetAgentData',
'ListAgentDevices',
'ListAgentEvents',
'GenerateAgentStatisticReport',
'RefreshToken',
'RequestLoginInfo',
],
],
[
'id' => 58700,
'title' => '短信',
'type' => 'directory',
'children' => [
'GetSmsConfig',
'LaunchShortMessageAppraise',
'SendPredefinedShortMessage',
],
],
[
'id' => 58704,
'title' => '技能组',
'type' => 'directory',
'children' => [
'CreateSkillGroup',
'DeleteSkillGroup',
'ModifyPrimaryTrunksOfSkillGroup',
'ModifySkillGroup',
'ModifySkillGroupOfUser',
'ModifySkillGroupOutboundNumbers',
'ListTrunksOfSkillGroup',
'ListUsersOfSkillGroup',
'ListSkillGroupStates',
'ListSkillGroupSummaryReports',
'ListSkillGroupSummaryReportsByInterval',
'ListSkillGroupSummaryReportsSinceMidnight',
'ListTransferableSkillGroups',
'ListSkillGroups',
'ListSkillGroupsOfUser',
'RemoveUsersFromSkillGroup',
],
],
[
'id' => 190044,
'title' => '其他',
'type' => 'directory',
'children' => [
'ListOutboundPhoneNumberOfUser',
'ListRecordings',
'ModifySkillGroupBasicInfo',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'ListVoiceAppraise' => [
'summary' => '调用ListVoiceAppraise获取实例的语音满意度。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待获取电话号码的呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '0FDB996E-9A04-461C-BE0E-A7F8597526AD',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Notice' => [
'description' => '创建默认满意度提示。'."\n"
."\n"
.'若客户自己配置语音满意度有一定难度,可参考模板创建的语音满意度进行修改。',
'type' => 'string',
'example' => '无',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
'ContactFlow' => [
'description' => '返回的语音满意度的联系流,,包含最新版本信息。',
'type' => 'object',
'properties' => [
'ContactFlowDescription' => [
'description' => '联系流的简单描述。',
'type' => 'string',
'example' => 'SatisfactionSurvey',
],
'Type' => [
'description' => '流程类型。',
'type' => 'string',
'example' => 'Mainflow',
],
'ContactFlowName' => [
'description' => '联系流名称,在一个实例内名称不能重复。',
'type' => 'string',
'example' => 'SatisfactionSurvey',
],
'InstanceId' => [
'description' => '联系流所归属的呼叫中心实例。',
'type' => 'string',
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
'ContactFlowId' => [
'description' => '联系流唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => 'XmRB_0mcsmkj',
],
'AppliedVersion' => [
'description' => '当前正在工作的版本。',
'type' => 'string',
'example' => '20190319160735',
],
'Versions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactFlowVersion' => [
'description' => '联系流文件的所有版本。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '当前状态。',
'type' => 'string',
'example' => 'Published',
],
'LastModified' => [
'description' => '联系流版本的最后修改时间。',
'type' => 'string',
'example' => '2019-03-19 16:07:46',
],
'Version' => [
'description' => '联系流版本信息,一般以日期+时间来表示。',
'type' => 'string',
'example' => '20190319160735',
],
'ContactFlowVersionId' => [
'description' => '联系流版本ID,关联的联系流版本。',
'type' => 'string',
'example' => 'oEUk_1EAbkcn',
],
'ContactFlowVersionDescription' => [
'description' => '联系流版本的说明及注解。',
'type' => 'string',
'example' => 'SatisfactionSurvey-20180531144213',
],
'LastModifiedBy' => [
'description' => '联系流版本最后由何人修改。',
'type' => 'string',
'example' => 'cloudcallcenter',
],
'Content' => [
'description' => '符合ACC需求的流程文件内容。',
'type' => 'string',
'example' => '请见返回示例。',
],
],
],
],
],
],
'PhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PhoneNumber' => [
'description' => '联系流绑定的电话号码列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Trunks' => [
'description' => '电话号码的中继数量,即可同时支持几路通话,数据来源于大于。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'Number' => [
'description' => '电话号码。',
'type' => 'string',
'example' => '02160664656',
],
'RemainingTime' => [
'description' => '测试号码剩余的通话时间。单位为分钟。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'InstanceId' => [
'description' => '电话号码所归属的呼叫中心实例ID。',
'type' => 'string',
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
'PhoneNumberDescription' => [
'description' => '电话号码的简单描述。',
'type' => 'string',
'example' => 'Ali Telecom',
],
'PhoneNumberId' => [
'description' => '电话号码ID。',
'type' => 'string',
'example' => 'cc583e96-6bae-437e-9aeb-bffd5aeddb73',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0FDB996E-9A04-461C-BE0E-A7F8597526AD\\",\\n \\"Success\\": true,\\n \\"Notice\\": \\"无\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"ContactFlow\\": {\\n \\"ContactFlowDescription\\": \\"SatisfactionSurvey\\",\\n \\"Type\\": \\"Mainflow\\",\\n \\"ContactFlowName\\": \\"SatisfactionSurvey\\",\\n \\"InstanceId\\": \\"d278629c-c687-4aa3-b044-4fe9b012e7ef\\",\\n \\"ContactFlowId\\": \\"XmRB_0mcsmkj\\",\\n \\"AppliedVersion\\": \\"20190319160735\\",\\n \\"Versions\\": {\\n \\"ContactFlowVersion\\": [\\n {\\n \\"Status\\": \\"Published\\",\\n \\"LastModified\\": \\"2019-03-19 16:07:46\\",\\n \\"Version\\": \\"20190319160735\\",\\n \\"ContactFlowVersionId\\": \\"oEUk_1EAbkcn\\",\\n \\"ContactFlowVersionDescription\\": \\"SatisfactionSurvey-20180531144213\\",\\n \\"LastModifiedBy\\": \\"cloudcallcenter\\",\\n \\"Content\\": \\"请见返回示例。\\"\\n }\\n ]\\n },\\n \\"PhoneNumbers\\": {\\n \\"PhoneNumber\\": [\\n {\\n \\"Trunks\\": 30,\\n \\"Number\\": \\"02160664656\\",\\n \\"RemainingTime\\": 60,\\n \\"InstanceId\\": \\"d278629c-c687-4aa3-b044-4fe9b012e7ef\\",\\n \\"PhoneNumberDescription\\": \\"Ali Telecom\\",\\n \\"PhoneNumberId\\": \\"cc583e96-6bae-437e-9aeb-bffd5aeddb73\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n \\r\\n SatisfactionSurvey\\r\\n SatisfactionSurvey\\r\\n XmRB_0mcsmkj\\r\\n \\r\\n \\r\\n Published\\r\\n SatisfactionSurvey-20180531144213\\r\\n oEUk_1EAbkcn\\r\\n cloudcallcenter\\r\\n 2019-03-19 16:07:46\\r\\n [{\\"nodeId\\":1,\\"nodeDescript\\":\\"开始\\",\\"nextNodeId\\":2,\\"nodeType\\":\\"start\\",\\"variables\\":[{\\"varDescript\\":\\"\\",\\"varName\\":\\"satisfaction\\",\\"varType\\":\\"string\\",\\"varInitial\\":\\"\\"},{\\"varDescript\\":\\"\\",\\"varName\\":\\"result\\",\\"varType\\":\\"string\\",\\"varInitial\\":\\"\\"},{\\"varDescript\\":\\"\\",\\"varName\\":\\"_press_key\\",\\"varType\\":\\"string\\",\\"varInitial\\":\\"\\"}]},{\\"nodeId\\":2,\\"nodeDescript\\":\\"answer\\",\\"userHangUpOutput\\":999,\\"failureOutput\\":999,\\"nodeType\\":\\"answer\\",\\"answerSuccess\\":3},{\\"individualization\\":false,\\"playSuccess\\":4,\\"selectPlayFile\\":\\"\\",\\"maxLen\\":1,\\"playType\\":\\"value\\",\\"repeat\\":\\"5\\",\\"resultEncryption\\":false,\\"playFile\\":\\"PUBLIC-satisfaction_part1.wav\\",\\"receiveOutputValue\\":\\"satisfaction\\",\\"nodeId\\":3,\\"minLen\\":1,\\"nodeDescript\\":\\"一级收号\\",\\"repeatIntervalTime\\":\\"3\\",\\"inputTimeOut\\":\\"3\\",\\"inputPlayFile\\":\\"\\",\\"userHangUpOutput\\":999,\\"keyTimeOut\\":999,\\"nodeType\\":\\"getdigits\\"},{\\"nodeDescript\\":\\"一级条件判断\\",\\"nodeId\\":4,\\"branchingRules\\":[{\\"name\\":\\"satisfaction = 1\\",\\"descript\\":\\"按1-满意\\",\\"ruleExp\\":\\"${satisfaction}===1\\",\\"output\\":5},{\\"name\\":\\"satisfaction = 2\\",\\"descript\\":\\"按2-一般\\",\\"ruleExp\\":\\"${satisfaction}===2\\",\\"output\\":5},{\\"name\\":\\"satisfaction = 3\\",\\"descript\\":\\"按3-不满意\\",\\"ruleExp\\":\\"${satisfaction}===3\\",\\"output\\":5}],\\"ruleMismatchOutput\\":3,\\"nodeType\\":\\"branching\\"},{\\"nodeDescription\\":\\"一级http\\",\\"nodeId\\":5,\\"timeoutType\\":\\"value\\",\\"successOut\\":998,\\"resultString\\":\\"result\\",\\"failureOutput\\":999,\\"requestType\\":\\"get\\",\\"nodeType\\":\\"http\\",\\"urlType\\":\\"value\\",\\"url\\":\\"http://pre.intermediary.ccc.aliyun.com/callcenter/api.json?input={\\\\\\"pressKey\\\\\\":\\\\\\"${satisfaction}\\\\\\",\\\\\\"acid\\\\\\":\\\\\\"${_JOBID}\\\\\\",\\\\\\"source\\\\\\":\\\\\\"inner\\\\\\",\\\\\\"type\\\\\\":\\\\\\"Appraise\\\\\\",\\\\\\"pressKeyMapping\\\\\\":{\\\\\\"mapping\\\\\\":{\\\\\\"1\\\\\\":\\\\\\"满意\\\\\\",\\\\\\"2\\\\\\":\\\\\\"一般\\\\\\",\\\\\\"3\\\\\\":\\\\\\"不满意\\\\\\"}}}&action=Appraise\\",\\"timeout\\":3},{\\"playSuccess\\":999,\\"individualization\\":false,\\"nodeDescript\\":\\"感谢评价\\",\\"nodeId\\":998,\\"inputPlayFile\\":\\"\\",\\"userHangUpOutput\\":999,\\"selectPlayFile\\":\\"\\",\\"allowInterrupt\\":false,\\"playType\\":\\"value\\",\\"nodeType\\":\\"play\\",\\"playFile\\":\\"PUBLIC-satisfaction_part2.wav\\"},{\\"nodeId\\":999,\\"nodeDescript\\":\\"结束\\",\\"nextNodeId\\":\\"\\",\\"nodeType\\":\\"Hangup\\"}]\\r\\n 20190319160735\\r\\n \\r\\n \\r\\n 20190319160735\\r\\n Mainflow\\r\\n d278629c-c687-4aa3-b044-4fe9b012e7ef\\r\\n \\r\\n \\r\\n \\r\\n 0FDB996E-9A04-461C-BE0E-A7F8597526AD\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '获取实例的语音满意度',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'LaunchAppraise' => [
'summary' => '用来统计满意度发送率。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
'docRequired' => true,
],
],
[
'name' => 'Acid',
'in' => 'query',
'schema' => [
'description' => '通话话务ID。'."\n"
."\n"
.'即contactId,软电话SDK的回调事件中会携带contactId。',
'type' => 'string',
'required' => true,
'example' => '2021372960',
'docRequired' => 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' => 'xxx',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"xxx\\",\\n \\"RequestId\\": \\"678F7002-CA01-4ABF-A112-585AFBDF3A3B\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n 678F7002-CA01-4ABF-A112-585AFBDF3A3B\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '统计满意度发送率',
'description' => '> 点击坐席工作台(软电话SDK)中的发送语音满意度按钮时调用,记录坐席发送了满意度。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveWebRTCStats' => [
'summary' => '保存客服端WebRTC语音传输统计信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待获取用户的呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9f46dde1-207a-46dd-926e-c0f39a124',
],
],
[
'name' => 'RecordTime',
'in' => 'query',
'schema' => [
'description' => '调用此API的时间(客户端电脑的时间)',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '160765543836',
],
],
[
'name' => 'CallId',
'in' => 'query',
'schema' => [
'description' => '通话ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '294834804',
],
],
[
'name' => 'CallerNumber',
'in' => 'query',
'schema' => [
'description' => '主叫号码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '021607806',
],
],
[
'name' => 'CalleeNumber',
'in' => 'query',
'schema' => [
'description' => '被叫号码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '131228450',
],
],
[
'name' => 'CallStartTime',
'in' => 'query',
'schema' => [
'description' => '通话开始时间',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1607655438368',
],
],
[
'name' => 'Stats',
'in' => 'query',
'schema' => [
'description' => '从rtcPeerConnection.getStats(selector)中获取的语音传输统计信息(每隔3秒获取一次)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '[XXX]',
],
],
[
'name' => 'Uid',
'in' => 'query',
'schema' => [
'description' => '客服的RAM ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '247361754012232',
],
],
[
'name' => 'TenantId',
'in' => 'query',
'schema' => [
'description' => '租户ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'acc2626',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
'RowCount' => [
'description' => '存入数据库后返回的行数,一般为1',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"CF1C21B9-2D49-4B54-880F-FBE248C16903\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RowCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\r\\n OK\\r\\n 200\\r\\n CF1C21B9-2D49-4B54-880F-FBE248C16903\\r\\n 1\\r\\n true\\r\\n","errorExample":""}]',
'title' => '保存WebRTC统计信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateContactFlow' => [
'summary' => '调用CreateContactFlow创建联系流。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '联系流名称。',
'type' => 'string',
'required' => true,
'example' => '测试流程',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '描述信息。',
'type' => 'string',
'required' => false,
'example' => '测试',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '流程类型。取值:Mainflow、Subflow、System、Reserved、Navigator。',
'type' => 'string',
'required' => true,
'example' => 'Mainflow',
],
],
[
'name' => 'Canvas',
'in' => 'formData',
'schema' => [
'description' => '画布信息。',
'type' => 'string',
'required' => true,
'example' => '{"lineList":[{"relatedModules":{"begin":1,"end":7},"offsetEndPonit":{"offsetX":12.150491568948121,"offsetY":-4.3527514192484915}},{"relatedModules":{"begin":7,"end":999},"offsetEndPonit":{"offsetX":11.620147014773558,"offsetY":1.633680331939992}}]}',
],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => [
'description' => '结点信息。',
'type' => 'string',
'required' => true,
'example' => '[{"nodeType":"start","nodeDescript":"开始","variables":[{"varDescript":"隐藏参数,用于保存分支模块收号内容","varInitial":"","varName":"_press_key","varType":"string"},{"varDescript":"隐藏参数,智能导航中给出\\"转人工队列\\"的动作指令时,附带的参数","varInitial":"","varName":"_vn_control_queueName","varType":"string"}]}]',
],
],
],
'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' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'ContactFlow' => [
'description' => '联系流对象。',
'type' => 'object',
'properties' => [
'ContactFlowDescription' => [
'description' => '描述信息。',
'type' => 'string',
'example' => '测试',
],
'Type' => [
'description' => '流程类型。',
'type' => 'string',
'example' => 'Mainflow',
],
'ContactFlowName' => [
'description' => '联系流名称。',
'type' => 'string',
'example' => '测试流程',
],
'InstanceId' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802',
],
'ContactFlowId' => [
'description' => '联系流ID。',
'type' => 'string',
'example' => 'nk90_9MIXqop',
],
'AppliedVersion' => [
'description' => '已发布的版本号。',
'type' => 'string',
'example' => '27904327097583',
],
'Versions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactFlowVersion' => [
'description' => '版本信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '联系流当前状态。',
'type' => 'string',
'example' => 'Draft',
],
'LastModified' => [
'description' => '最近修改时间。',
'type' => 'string',
'example' => '2020-12-16 09:40:41',
],
'Canvas' => [
'description' => '画布信息。',
'type' => 'string',
'example' => '无',
],
'LockedBy' => [
'description' => '此版本的锁定者。',
'type' => 'string',
'example' => 'cctest',
],
'Version' => [
'description' => '联系流版本号。',
'type' => 'string',
'example' => '20201216094041',
],
'ContactFlowVersionId' => [
'description' => '版本ID。',
'type' => 'string',
'example' => 'fLXS_2CJPxot',
],
'LastModifiedBy' => [
'description' => '最近修改者。',
'type' => 'string',
'example' => '239999345126843208',
],
'ContactFlowVersionDescription' => [
'description' => '版本描述。',
'type' => 'string',
'example' => '无',
],
'Content' => [
'description' => '结点信息。',
'type' => 'string',
'example' => '无',
],
],
],
],
],
],
'PhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PhoneNumber' => [
'description' => '号码。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TestOnly' => [
'description' => '是否用于测试。',
'type' => 'boolean',
'example' => 'true',
],
'Trunks' => [
'description' => '中继。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RemainingTime' => [
'description' => '可用时间,单位秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '2592000',
],
'Number' => [
'description' => '号码。',
'type' => 'string',
'example' => '6680XXXX083',
],
'InstanceId' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802',
],
'Usage' => [
'description' => '用途。',
'type' => 'string',
'example' => 'Inbound',
],
'AllowOutbound' => [
'description' => '是否可以外呼。',
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumberDescription' => [
'description' => '号码描述。',
'type' => 'string',
'example' => '测试',
],
'PhoneNumberId' => [
'description' => '号码ID。',
'type' => 'string',
'example' => 'kq82ix9f-izbe-7813-a171-334uy290ck3w',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"Success\\": true,\\n \\"ContactFlow\\": {\\n \\"ContactFlowDescription\\": \\"测试\\",\\n \\"Type\\": \\"Mainflow\\",\\n \\"ContactFlowName\\": \\"测试流程\\",\\n \\"InstanceId\\": \\"ef1e71e9-ae9d-487c-96ad-9181d85cf802\\",\\n \\"ContactFlowId\\": \\"nk90_9MIXqop\\",\\n \\"AppliedVersion\\": \\"27904327097583\\",\\n \\"Versions\\": {\\n \\"ContactFlowVersion\\": [\\n {\\n \\"Status\\": \\"Draft\\",\\n \\"LastModified\\": \\"2020-12-16 09:40:41\\",\\n \\"Canvas\\": \\"无\\",\\n \\"LockedBy\\": \\"cctest\\",\\n \\"Version\\": \\"20201216094041\\",\\n \\"ContactFlowVersionId\\": \\"fLXS_2CJPxot\\",\\n \\"LastModifiedBy\\": \\"239999345126843208\\",\\n \\"ContactFlowVersionDescription\\": \\"无\\",\\n \\"Content\\": \\"无\\"\\n }\\n ]\\n },\\n \\"PhoneNumbers\\": {\\n \\"PhoneNumber\\": [\\n {\\n \\"TestOnly\\": true,\\n \\"Trunks\\": 1,\\n \\"RemainingTime\\": 2592000,\\n \\"Number\\": \\"6680XXXX083\\",\\n \\"InstanceId\\": \\"ef1e71e9-ae9d-487c-96ad-9181d85cf802\\",\\n \\"Usage\\": \\"Inbound\\",\\n \\"AllowOutbound\\": true,\\n \\"PhoneNumberDescription\\": \\"测试\\",\\n \\"PhoneNumberId\\": \\"kq82ix9f-izbe-7813-a171-334uy290ck3w\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n2778FA12-EDD6-42AA-9B15-AF855072E5E5\\n200\\nOK\\n\\n \\n \\n Inbound\\n true\\n true\\n 6680XXXX083\\n ef1e71e9-ae9d-487c-96ad-9181d85cf802\\n 2592000\\n 1\\n kq82ix9f-izbe-7813-a171-334uy290ck3w\\n 测试\\n \\n \\n 27904327097583\\n Mainflow\\n \\n \\n Draft\\n 2020-12-16 09:40:41\\n cctest\\n 239999345126843208\\n fLXS_2CJPxot\\n 20201216094041\\n 无\\n \\n 无\\n \\n \\n ef1e71e9-ae9d-487c-96ad-9181d85cf802\\n nk90_9MIXqop\\n 测试流程\\n 测试\\n\\ntrue","errorExample":""}]',
'title' => '创建联系流',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListContactFlows' => [
'summary' => '调用ListContactFlows获取呼叫中心实例中的IVR流程列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
],
'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' => 'F7505505-D727-46E2-9B66-47C5CEBDFCE1',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'ContactFlows' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactFlow' => [
'description' => '联系流列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ContactFlowDescription' => [
'description' => '联系流的简单描述。',
'type' => 'string',
'example' => 'Welcome',
],
'Type' => [
'description' => '流程类型, 定义来自于ContactFlowType。',
'type' => 'string',
'example' => 'Mainflow',
],
'ContactFlowName' => [
'description' => '联系流名称,在一个实例内名称不能重复。',
'type' => 'string',
'example' => 'Welcome',
],
'InstanceId' => [
'description' => '联系流所归属的呼叫中心实例。',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
'ContactFlowId' => [
'description' => '联系流唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => 'dDMD_0mif4hv',
],
'AppliedVersion' => [
'description' => '当前正在工作的版本。',
'type' => 'string',
'example' => '20180704215641',
],
'Versions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ContactFlowVersion' => [
'description' => '联系流文件的所有版本。外表存贮。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '当前状态。',
'type' => 'string',
'example' => 'Published',
],
'LastModified' => [
'description' => '联系流版本的最后修改时间。the number of milliseconds since January 1, 1970, 00:00:00 GMT',
'type' => 'string',
'example' => '2018-07-04 22:00:55',
],
'LockedBy' => [
'description' => '联系流版本被何人锁定。'."\n"
."\n"
.'在开始编辑前必须先将此版本锁定,编辑完成后解锁,这样可以避免多人同时修改一个版本而导致的冲突。在锁定的情况下,只有锁定人才能对其进行操作,其他人无权操作。无人锁定时该属性的值为NULL。',
'type' => 'string',
'example' => 'null',
],
'Version' => [
'description' => '联系流版本信息,一般以日期+时间来表示。',
'type' => 'string',
'example' => '20180704215641',
],
'ContactFlowVersionId' => [
'description' => '联系流版本ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => 'tOMP_0prS2A1',
],
'ContactFlowVersionDescription' => [
'description' => '联系流版本的说明及注解。',
'type' => 'string',
'example' => 'Welcome-20180601142524',
],
'LastModifiedBy' => [
'description' => '联系流版本最后由何人修改。',
'type' => 'string',
'example' => 'cloudcallcenter',
],
],
],
],
],
],
'PhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PhoneNumber' => [
'description' => '联系流所绑定的电话号码列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TestOnly' => [
'description' => '是否是测试号码。',
'type' => 'boolean',
'example' => 'true',
],
'Trunks' => [
'description' => '电话号码的中继数量。即可同时支持几路通话,数据来源于大于。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'RemainingTime' => [
'description' => '测试号码剩余的通话时间。单位为分钟。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'Number' => [
'description' => '电话号码。',
'type' => 'string',
'example' => '178888888888',
],
'InstanceId' => [
'description' => '电话号码所归属的呼叫中心实例ID。',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
'Usage' => [
'description' => '电话号码的用途。取值:呼入(**Inbound**),呼出(**Outbound**),以及同时用于呼入和呼出(**Bidirection**)。上述值由枚举类型PhoneNumberType定义。'."\n"
."\n"
.'该值的结果取决于:'."\n"
."\n"
.'1. 大于的设置,比如400号码不允许外呼'."\n"
.'2. 呼叫中心实例的设置'."\n"
."\n"
.'> 电话号码一般都允许内呼,如果不允许内呼,可以由大于做设置,用户拨打该号码时听到提示音;该号码不连接人和联系流IVR,但是ACC不建议这么做。',
'type' => 'string',
'example' => 'Bidirection',
],
'AllowOutbound' => [
'description' => '是否允许外呼。结果取决于:'."\n"
."\n"
.'1. 大于的设置,比如400号码不允许外呼 '."\n"
.'2. 呼叫中心实例的设置'."\n"
."\n"
.'> 电话号码一般都允许内呼,如果不允许内呼,可以由大于做设置,用户拨打该号码时听到提示音;该号码不绑定联系流IVR,但是ACC不建议这么做。',
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumberDescription' => [
'description' => '电话号码的简单描述。',
'type' => 'string',
'example' => 'xxx',
],
'PhoneNumberId' => [
'description' => '电话号码ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"F7505505-D727-46E2-9B66-47C5CEBDFCE1\\",\\n \\"Success\\": true,\\n \\"ContactFlows\\": {\\n \\"ContactFlow\\": [\\n {\\n \\"ContactFlowDescription\\": \\"Welcome\\",\\n \\"Type\\": \\"Mainflow\\",\\n \\"ContactFlowName\\": \\"Welcome\\",\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\",\\n \\"ContactFlowId\\": \\"dDMD_0mif4hv\\",\\n \\"AppliedVersion\\": \\"20180704215641\\",\\n \\"Versions\\": {\\n \\"ContactFlowVersion\\": [\\n {\\n \\"Status\\": \\"Published\\",\\n \\"LastModified\\": \\"2018-07-04 22:00:55\\",\\n \\"LockedBy\\": \\"null\\",\\n \\"Version\\": \\"20180704215641\\",\\n \\"ContactFlowVersionId\\": \\"tOMP_0prS2A1\\",\\n \\"ContactFlowVersionDescription\\": \\"Welcome-20180601142524\\",\\n \\"LastModifiedBy\\": \\"cloudcallcenter\\"\\n }\\n ]\\n },\\n \\"PhoneNumbers\\": {\\n \\"PhoneNumber\\": [\\n {\\n \\"TestOnly\\": true,\\n \\"Trunks\\": 30,\\n \\"RemainingTime\\": 60,\\n \\"Number\\": \\"178888888888\\",\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"AllowOutbound\\": true,\\n \\"PhoneNumberDescription\\": \\"xxx\\",\\n \\"PhoneNumberId\\": \\"xxx\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n \\r\\n \\r\\n Welcome\\r\\n Welcome\\r\\n dDMD_0mif4hv\\r\\n \\r\\n \\r\\n Published\\r\\n Welcome-20180601142524\\r\\n tOMP_0prS2A1\\r\\n cloudcallcenter\\r\\n 2018-07-04 22:00:55\\r\\n 20180704215641\\r\\n \\r\\n \\r\\n \\r\\n 20180704215641\\r\\n Mainflow\\r\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\r\\n \\r\\n \\r\\n \\r\\n \\r\\n F7505505-D727-46E2-9B66-47C5CEBDFCE1\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '获取呼叫中心实例中的IVR流程列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetRoutePoint' => [
'summary' => '调用GetRoutePoint获取联系流的路由点。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '云呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => [
'description' => '联系流ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dDMD_0mif4hv',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => '响应状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RoutePoint' => [
'description' => '路由点',
'type' => 'string',
'example' => '80206198',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'F81866AD-A125-4D9A-A942-1CD6FBA9E9F5',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RoutePoint\\": \\"80206198\\",\\n \\"RequestId\\": \\"F81866AD-A125-4D9A-A942-1CD6FBA9E9F5\\",\\n \\"Success\\": true,\\n \\"StatusCode\\": \\"无\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"StatusDesc\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t 200\\r\\n\\t F81866AD-A125-4D9A-A942-1CD6FBA9E9F5\\r\\n\\t 80206198\\r\\n\\t true\\r\\n\\t OK\\r\\n","errorExample":""}]',
'title' => '获取联系流的路由点',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListIvrTrackingDetail' => [
'summary' => '获取IVR轨迹,默认查询半个小时之内的数据。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '317a38bf-4883-4e00-b65d-761f4a8b****',
],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => [
'description' => '话务ID',
'type' => 'string',
'required' => false,
'example' => '3433583180',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '开始时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1541732850000',
],
],
[
'name' => 'StopTime',
'in' => 'query',
'schema' => [
'description' => '结束时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1541932850000',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => [
'description' => '主叫号码',
'type' => 'string',
'required' => false,
'example' => '1760031****',
],
],
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => [
'description' => '被叫号码',
'type' => 'string',
'required' => false,
'example' => '05712688****',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页页码',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '20',
],
],
],
'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' => '2a644ab1-7db5-413c-a744-299247f6537e',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'IvrTrackingDetails' => [
'description' => '获取的IVR轨迹',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '当前页码',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '对象总数',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'IvrTrackingDetail' => [
'description' => '对象列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '状态',
'type' => 'string',
'example' => '_tts_success',
],
'DeviceID' => [
'description' => 'IP地址',
'type' => 'string',
'example' => 'null',
],
'InputData' => [
'description' => '传入参数',
'type' => 'string',
'example' => 'nui-I1gxblYz_1_1200_当前时间是11:07:39',
],
'FlowName' => [
'description' => 'IVR名称',
'type' => 'string',
'example' => 'flow/acc2626/xxxx',
],
'CalledNumber' => [
'description' => '被叫号码',
'type' => 'string',
'example' => '05712688****',
],
'StopTime' => [
'description' => '结束时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1541932850000',
],
'StartTime' => [
'description' => '开始时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1541732850000',
],
'NodeType' => [
'description' => '节点类型(nodeType)包含: answer(开始) 、waitevent(等待)、getAssociateData(获取随路数据)、 kvget(解析随路数据)、getdigits(获取收号信息)、assign(输出) 、play(放音)、tts(tts放音) 、branching(分支)、branchitem(分支项) 、requestagent(转人工)、onesteptransfer(转外线) 、http(函数)、subflow(子流程)、exit(退出子流程)、hangup(结束)。',
'type' => 'string',
'example' => 'waitevent',
],
'Description' => [
'description' => '描述信息',
'type' => 'string',
'example' => 'answer',
],
'NodeName' => [
'description' => '节点名称',
'type' => 'string',
'example' => 'node24000',
],
'ContactId' => [
'description' => '通话ID',
'type' => 'string',
'example' => '3433583180',
],
'CallingNumber' => [
'description' => '主叫号码',
'type' => 'string',
'example' => '1760031****',
],
'OutputData' => [
'description' => '传出参数',
'type' => 'string',
'example' => '8020****',
],
'TenantId' => [
'description' => '租户ID',
'type' => 'string',
'example' => 'acc2626',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2a644ab1-7db5-413c-a744-299247f6537e\\",\\n \\"Success\\": true,\\n \\"IvrTrackingDetails\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"List\\": {\\n \\"IvrTrackingDetail\\": [\\n {\\n \\"Status\\": \\"_tts_success\\",\\n \\"DeviceID\\": \\"null\\",\\n \\"InputData\\": \\"nui-I1gxblYz_1_1200_当前时间是11:07:39\\",\\n \\"FlowName\\": \\"flow/acc2626/xxxx\\",\\n \\"CalledNumber\\": \\"05712688****\\",\\n \\"StopTime\\": 1541932850000,\\n \\"StartTime\\": 1541732850000,\\n \\"NodeType\\": \\"waitevent\\",\\n \\"Description\\": \\"answer\\",\\n \\"NodeName\\": \\"node24000\\",\\n \\"ContactId\\": \\"3433583180\\",\\n \\"CallingNumber\\": \\"1760031****\\",\\n \\"OutputData\\": \\"8020****\\",\\n \\"TenantId\\": \\"acc2626\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n2a644ab1-7db5-413c-a744-299247f6537e\\n200\\n\\n 3\\n 10\\n 1\\n \\n \\n _tts_success\\n 05712688****\\n answer\\n node24000\\n null\\n 1541732850000\\n 3433583180\\n 1760031****\\n acc2626\\n flow/acc2626/xxxx\\n 8020****\\n waitevent\\n nui-I1gxblYz_1_1200_当前时间是11:07:39\\n 1541932850000\\n \\n
\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '获取IVR轨迹',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CommitContactFlowVersionModification' => [
'summary' => '提交对联系流版本的改动。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802',
],
],
[
'name' => 'ContactFlowVersionId',
'in' => 'query',
'schema' => [
'description' => '版本ID。',
'type' => 'string',
'required' => true,
'example' => 'fLXS_2CJPxot',
],
],
[
'name' => 'Canvas',
'in' => 'formData',
'schema' => [
'description' => '画布信息。',
'type' => 'string',
'required' => true,
'example' => '无',
],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => [
'description' => 'IVR内容。',
'type' => 'string',
'required' => 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' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'ContactFlowVersion' => [
'description' => '联系流版本对象。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '联系流当前状态。',
'type' => 'string',
'example' => 'Updated',
],
'LastModified' => [
'description' => '最近修改时间。',
'type' => 'string',
'example' => '2020-11-14 17:48:21',
],
'Canvas' => [
'description' => '画布信息。',
'type' => 'string',
'example' => '无',
],
'LockedBy' => [
'description' => '此版本的锁定者。',
'type' => 'string',
'example' => 'cctest',
],
'Version' => [
'description' => '联系流版本号。',
'type' => 'string',
'example' => '20201114174750',
],
'ContactFlowVersionId' => [
'description' => '版本ID。',
'type' => 'string',
'example' => 'fLXS_2CJPxot',
],
'LastModifiedBy' => [
'description' => '最近修改人。',
'type' => 'string',
'example' => 'cctest',
],
'ContactFlowVersionDescription' => [
'description' => '版本描述。',
'type' => 'string',
'example' => 'commitTest-20201114174750',
],
'Content' => [
'description' => 'IVR内容。',
'type' => 'string',
'example' => '无',
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"Success\\": true,\\n \\"ContactFlowVersion\\": {\\n \\"Status\\": \\"Updated\\",\\n \\"LastModified\\": \\"2020-11-14 17:48:21\\",\\n \\"Canvas\\": \\"无\\",\\n \\"LockedBy\\": \\"cctest\\",\\n \\"Version\\": \\"20201114174750\\",\\n \\"ContactFlowVersionId\\": \\"fLXS_2CJPxot\\",\\n \\"LastModifiedBy\\": \\"cctest\\",\\n \\"ContactFlowVersionDescription\\": \\"commitTest-20201114174750\\",\\n \\"Content\\": \\"无\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n2778FA12-EDD6-42AA-9B15-AF855072E5E5\\n\\n Updated\\n 2020-11-14 17:48:21\\n cctest\\n cctest\\n fLXS_2CJPxot\\n 20201114174750\\n 无\\n \\n commitTest-20201114174750\\n\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '提交联系流改动',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PublishContactFlowVersion' => [
'summary' => '调用PublishContactFlowVersion发布IVR流程。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'ContactFlowVersionId',
'in' => 'query',
'schema' => [
'description' => '待发布的流程的版本ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2NWG_1Cl7uWu',
],
],
[
'name' => 'UseTianGong',
'in' => 'query',
'schema' => [
'description' => '是否使用天宫进行发布。调用请传入true。',
'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' => '03C67DAD-EB26-41D8-949D-9B0C470FB716',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n OK\\r\\n 200\\r\\n 03C67DAD-EB26-41D8-949D-9B0C470FB716\\r\\n true\\r\\n xxxx\\r\\n","errorExample":""}]',
'title' => '发布IVR流程',
'description' => '在发布的时候,首先把当前的数据结构转换成IVR引擎所规定的数据库的格式,并填到其指定的数据库表中,然后进行编译并调用发布。因此发布结果不会在当前接口返回,需要查询IVR流程列表查看发布结果。',
],
'GetRecordOssUploadParam' => [
'summary' => '调用GetRecordOssUploadParam获取录音上传参数。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'description' => '录音文件名称',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '155887678809600080315543.wav',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OssAccessKeyId' => [
'description' => 'OSS的AK',
'type' => 'string',
'example' => 'LTAIvKWEr4Doxxxx',
],
'Host' => [
'description' => '上传地址',
'type' => 'string',
'example' => 'https://cloudcallcenter-online.oss-cn-shanghai.aliyuncs.com',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
'OssFileName' => [
'description' => '录音文件名',
'type' => 'string',
'example' => 'gvDE-1KxEtOj_1059803544828509_20190530143725.wav',
],
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Signature' => [
'description' => '签名',
'type' => 'string',
'example' => 'KUwzPbvaHaljLOdrKyrYE+S2gWs=',
],
'Expires' => [
'description' => '过期时间',
'type' => 'string',
'example' => '1559201845',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522',
],
'Policy' => [
'description' => '策略',
'type' => 'string',
'example' => 'eyJleHBpcmF0aW9uIjoiMjAxOS0wNS0zMFQwNzozNzoyNS42NDRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJyZWNvcmQvZDI3ODYyOWMtYzY4Ny00YWEzLWIwNDQtNGZ',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Dir' => [
'description' => '路径',
'type' => 'string',
'example' => 'record/d278629c-c687-4aa3-b044-4fe9b012e7ef/1059803544828509',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OssAccessKeyId\\": \\"LTAIvKWEr4Doxxxx\\",\\n \\"Host\\": \\"https://cloudcallcenter-online.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"无\\",\\n \\"OssFileName\\": \\"gvDE-1KxEtOj_1059803544828509_20190530143725.wav\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Signature\\": \\"KUwzPbvaHaljLOdrKyrYE+S2gWs=\\",\\n \\"Expires\\": \\"1559201845\\",\\n \\"RequestId\\": \\"9F766284-F103-4298-8EC5-19F9F9BE5522\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAxOS0wNS0zMFQwNzozNzoyNS42NDRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJyZWNvcmQvZDI3ODYyOWMtYzY4Ny00YWEzLWIwNDQtNGZ\\",\\n \\"Code\\": \\"OK\\",\\n \\"Dir\\": \\"record/d278629c-c687-4aa3-b044-4fe9b012e7ef/1059803544828509\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n record/d278629c-c687-4aa3-b044-4fe9b012e7ef/1059803544828509\\r\\n gvDE-1KxEtOj_1059803544828509_20190530143725.wav\\r\\n https://cloudcallcenter-online.oss-cn-shanghai.aliyuncs.com\\r\\n eyJleHBpcmF0aW9uIjoiMjAxOS0wNS0zMFQwNzozNzoyNS42NDRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJyZWNvcmQvZDI3ODYyOWMtYzY4Ny00YWEzLWIwNDQtNGZlOWIwMTJlN2VmLzEwNTk4MDM1NDQ4Mjg1MDkiXV19\\r\\n 1559201845\\r\\n 9F766284-F103-4298-8EC5-19F9F9BE5522\\r\\n true\\r\\n LTAIvKWEr4Dxxxx\\r\\n OK\\r\\n KUwzPbvaHaljLOdrKyrYE+S2gWs=\\r\\n","errorExample":""}]',
'title' => '获取录音上传参数',
],
'ListRecordingOfDualTrack' => [
'summary' => '调用ListRecordingOfDualTrack根据通话记录获取通话的双轨录音。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd278629c-c687-4aa3-b044-4fe9b012****',
],
],
[
'name' => 'ConnectId',
'in' => 'query',
'schema' => [
'description' => '话务ID',
'type' => 'string',
'required' => false,
'example' => '1300017658',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '获取的历史数据的开始时间。'."\n"
."\n"
.'缺省为0,代表早于目前的时间半个小时开始。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1542967200000',
],
],
[
'name' => 'StopTime',
'in' => 'query',
'schema' => [
'description' => '获取的历史数据的终止时间。'."\n"
."\n"
.'缺省为0,代表截止到目前的时间。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1542997200000',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => [
'description' => '主叫号码',
'type' => 'string',
'required' => false,
'example' => '0255237****',
],
],
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => [
'description' => '被叫号码',
'type' => 'string',
'required' => false,
'example' => '1573203****',
],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => [
'description' => '坐席ID',
'type' => 'string',
'required' => false,
'example' => '101820677302****',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'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',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'D8135D21-1553-4B18-A876-427D74543841',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Recordings' => [
'description' => '获取到的录音详单',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalCount' => [
'description' => '对象总数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Recording' => [
'description' => '对象列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ContactType' => [
'description' => '通话类型。'."\n"
."\n"
.'参考枚举类型:Inbound(0) 内呼, Outbound(1) 外呼, Internal(2) 内部通话。',
'type' => 'string',
'example' => 'Outbound',
],
'AgentId' => [
'description' => '座席ID。'."\n"
."\n"
.'坐席ID等同于该座席的RAM子账户ID。',
'type' => 'string',
'example' => '101820677302****',
],
'AgentName' => [
'description' => '座席名称',
'type' => 'string',
'example' => '测试',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => 'd278629c-c687-4aa3-b044-4fe9b01****',
],
'FileName' => [
'description' => '录音文件名',
'type' => 'string',
'example' => '4219097556-10-20-49.mkv',
],
'CalledNumber' => [
'description' => '被叫号码',
'type' => 'string',
'example' => '1573203****',
],
'StartTime' => [
'description' => '电话开始时间,内呼从进入IVR开始,外呼从开始接通计算。',
'type' => 'integer',
'format' => 'int64',
'example' => '1542968440000',
],
'FilePath' => [
'description' => '录音文件在OSS中的保存位置',
'type' => 'string',
'example' => 'http://xxx',
],
'ContactId' => [
'description' => '话务ID,全局唯一,对应于ACC的ACID。',
'type' => 'string',
'example' => '1300017658',
],
'CallingNumber' => [
'description' => '主叫号码',
'type' => 'string',
'example' => '0255237****',
],
'Duration' => [
'description' => '通话持续时间,单位为秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '120',
],
'FileDescription' => [
'description' => '录音文件别名',
'type' => 'string',
'example' => 'xxx',
],
'Channel' => [
'description' => '座席所在音轨标示',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"D8135D21-1553-4B18-A876-427D74543841\\",\\n \\"Success\\": true,\\n \\"Recordings\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"List\\": {\\n \\"Recording\\": [\\n {\\n \\"ContactType\\": \\"Outbound\\",\\n \\"AgentId\\": \\"101820677302****\\",\\n \\"AgentName\\": \\"测试\\",\\n \\"InstanceId\\": \\"d278629c-c687-4aa3-b044-4fe9b01****\\",\\n \\"FileName\\": \\"4219097556-10-20-49.mkv\\",\\n \\"CalledNumber\\": \\"1573203****\\",\\n \\"StartTime\\": 1542968440000,\\n \\"FilePath\\": \\"http://xxx\\",\\n \\"ContactId\\": \\"1300017658\\",\\n \\"CallingNumber\\": \\"0255237****\\",\\n \\"Duration\\": 120,\\n \\"FileDescription\\": \\"xxx\\",\\n \\"Channel\\": \\"xxx\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nD8135D21-1553-4B18-A876-427D74543841\\n200\\n\\n 1\\n 20\\n 1\\n \\n \\n http://xxx\\n xxx\\n 1573203****\\n Outbound\\n d278629c-c687-4aa3-b044-4fe9b01****\\n xxx\\n 4219097556-10-20-49.mkv\\n 1542968440000\\n 120\\n 测试\\n 101820677302****\\n 1300017658\\n 0255237****\\n \\n
\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '根据通话记录获取通话的双轨录音',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListRecordingsByContactId' => [
'summary' => '根据话务ID查找相关的录音详细信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => [
'description' => '话务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2020927xxxx',
],
],
],
'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' => '0997CE25-94D3-41DE-8C7A-E6FCFD8C01E0',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Recordings' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Recording' => [
'description' => '录音列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ContactType' => [
'description' => '话务类型',
'type' => 'string',
'example' => 'Outbound',
],
'AgentId' => [
'description' => '坐席ID。'."\n"
."\n"
.'坐席ID等同于该座席的RAM子账户ID。',
'type' => 'string',
'example' => '29393942232031xxxx',
],
'AgentName' => [
'description' => '坐席名称',
'type' => 'string',
'example' => '小芳',
],
'InstanceId' => [
'description' => '已废弃字段',
'type' => 'string',
'example' => '无',
],
'FileName' => [
'description' => '录音文件名称',
'type' => 'string',
'example' => '15312849114340008032xxxx.wav',
],
'QualityCheckTid' => [
'description' => '智能质检文本ID',
'type' => 'string',
'example' => '23A1F0BF-7B30-4918-9424-4DF8B809B9B1',
],
'CalledNumber' => [
'description' => '被叫号码',
'type' => 'string',
'example' => '1558888****',
],
'StartTime' => [
'description' => '通话开始时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1531284911000',
],
'FilePath' => [
'description' => '已废弃字段',
'type' => 'string',
'example' => '无',
],
'ContactId' => [
'description' => '话务ID',
'type' => 'string',
'example' => '202092xxxx',
],
'QualityCheckTaskId' => [
'description' => '智能质检任务ID',
'type' => 'string',
'example' => '1F0BF809-7B30-4918-9424-4DF23A8BB9B1',
],
'CallingNumber' => [
'description' => '主叫号码',
'type' => 'string',
'example' => '8032****',
],
'Duration' => [
'description' => '通话时长',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'FileDescription' => [
'description' => '录音文件描述',
'type' => 'string',
'example' => '20180711125511-小芳',
],
'Channel' => [
'description' => '已废弃字段',
'type' => 'string',
'example' => '无',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0997CE25-94D3-41DE-8C7A-E6FCFD8C01E0\\",\\n \\"Success\\": true,\\n \\"Recordings\\": {\\n \\"Recording\\": [\\n {\\n \\"ContactType\\": \\"Outbound\\",\\n \\"AgentId\\": \\"29393942232031xxxx\\",\\n \\"AgentName\\": \\"小芳\\",\\n \\"InstanceId\\": \\"无\\",\\n \\"FileName\\": \\"15312849114340008032xxxx.wav\\",\\n \\"QualityCheckTid\\": \\"23A1F0BF-7B30-4918-9424-4DF8B809B9B1\\",\\n \\"CalledNumber\\": \\"1558888****\\",\\n \\"StartTime\\": 1531284911000,\\n \\"FilePath\\": \\"无\\",\\n \\"ContactId\\": \\"202092xxxx\\",\\n \\"QualityCheckTaskId\\": \\"1F0BF809-7B30-4918-9424-4DF23A8BB9B1\\",\\n \\"CallingNumber\\": \\"8032****\\",\\n \\"Duration\\": 10,\\n \\"FileDescription\\": \\"20180711125511-小芳\\",\\n \\"Channel\\": \\"无\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n0997CE25-94D3-41DE-8C7A-E6FCFD8C01E0\\n200\\n\\n \\n 无\\n 1558888****\\n Outbound\\n 23A1F0BF-7B30-4918-9424-4DF8B809B9B1\\n 无\\n 无\\n 15312849114340008032xxxx.wav\\n 1531284911000\\n 10\\n 202092xxxx\\n 8032****\\n 20180711125511-小芳\\n 1F0BF809-7B30-4918-9424-4DF23A8BB9B1\\n 小芳\\n 29393942232031xxxx\\n \\n\\nOK\\ntrue","errorExample":""}]',
'title' => '根据话务ID查询录音',
'description' => '有以下两种获取话务ID(**ContactId**)方式:'."\n"
."\n"
.'1. 通过调用**ListCallDetailRecords**,返回参数中包含**ContactId**。'."\n"
.'2. 通过监听软电话SDK中的回调事件(参数表如下),回调事件中会携带每通通话全局唯一的**ContactId**。'."\n"
.'```'."\n"
.'钩子:某些事件触发时的回调函数'."\n"
.'onCallComing //来电,参数表(connid<通话id>,caller<主叫号码>,calee<被叫号码>,contactId<录音id>,skillgroupId<技能组id>)'."\n"
.'onCallDialing //去电,参数表(connid,caller,calee,contactId)'."\n"
.'```',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DownloadAllTypeRecording' => [
'summary' => '通过通话ID来下载原始以及合成录音。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccKYIENB',
],
],
'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' => true,
'docRequired' => true,
'example' => '1272014011',
],
],
[
'name' => 'Channel',
'in' => 'query',
'schema' => [
'description' => '座席所在音轨标示,目前不可用。',
'type' => 'string',
'required' => false,
'example' => 'xxxx',
],
],
],
'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' => '93CDC17E-3E8A-48F2-99E5-FA2E238DE8B4',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'MediaDownloadParamList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MediaDownloadParam' => [
'description' => '获取到的录音文件下载URL列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SignatureUrl' => [
'description' => '录音文件下载URL。'."\n"
."\n\n"
.'此URL被两个引号包裹,例如:“”urlDetail“”,需要您自行处理一下,此URL有效期为1小时。',
'type' => 'string',
'example' => '“”urlDetail“”',
],
'FileName' => [
'description' => '录音文件名',
'type' => 'string',
'example' => '0960005656-03-27-22.mkv',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"93CDC17E-3E8A-48F2-99E5-FA2E238DE8B4\\",\\n \\"Success\\": true,\\n \\"MediaDownloadParamList\\": {\\n \\"MediaDownloadParam\\": [\\n {\\n \\"SignatureUrl\\": \\"“”urlDetail“”\\",\\n \\"FileName\\": \\"0960005656-03-27-22.mkv\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"200\\n93CDC17E-3E8A-48F2-99E5-FA2E238DE8B4\\n\\n \\n http://cloudcallcenter-online.oss-cn-shanghai.aliyuncs.com/accrec/acc2626/190708/0960005656-03-27-22.mkv?Expires=1564059976&OSSAccessKeyId=XXXX&Signature=XXXX\\n 0960005656-03-27-22.mkv\\n \\n \\n http://cloudcallcenter-online.oss-cn-shanghai.aliyuncs.com/record/d278629c-c687-4aa3-b044-4fe9b012e7ef/156255644275000080333360.wav?Expires=1564059976&OSSAccessKeyId=XXXX&Signature=XXXX\\n 156255644275000080333360.wav\\n \\n\\ntrue\\nOK","errorExample":""}]',
'title' => '下载原始或合成录音',
'description' => '> 一通通话如果存在转接,那么会包含多个录音文件。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DownloadRecording' => [
'summary' => '调用DownloadRecording通过录音文件的FileName来下载录音。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccKYIENB',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'description' => '待下载录音文件名',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '15312849114340008032****.wav',
],
],
[
'name' => 'Channel',
'in' => 'query',
'schema' => [
'description' => '音轨信息,默认为null',
'type' => 'string',
'required' => false,
'example' => 'null',
],
],
],
'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' => '03C67DAD-EB26-41D8-949D-9B0C470FB716',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'MediaDownloadParam' => [
'description' => '获取到的录音文件下载url',
'type' => 'object',
'properties' => [
'SignatureUrl' => [
'description' => '录音文件下载url。'."\n"
."\n"
.'此url被两个引号包裹,例如:“”urlDetail“”,需要您自行处理一下,此url有效期为1小时。',
'type' => 'string',
'example' => '""urlDetail""',
],
'FileName' => [
'description' => '录音文件名',
'type' => 'string',
'example' => '15312849114340008032****.wav',
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Success\\": true,\\n \\"MediaDownloadParam\\": {\\n \\"SignatureUrl\\": \\"\\\\\\"\\\\\\"urlDetail\\\\\\"\\\\\\"\\",\\n \\"FileName\\": \\"15312849114340008032****.wav\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 15312849114340008032****.wav\\n \\"\\"urlDetail\\"\\"\\n\\n无\\n03C67DAD-EB26-41D8-949D-9B0C470FB716\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '下载通话录音',
'description' => '有以下两种获取**FileName**的方式:'."\n"
."\n"
.'1. 通过调用[ListCallDetailRecords](https://help.aliyun.com/document_detail/65296.htm?spm=a2c4g.11186623.0.0.25924395RuDWbu),返回参数中包含**FileName**。'."\n"
."\n"
.'2. 通过监听[软电话SDK](https://help.aliyun.com/document_detail/63063.html?spm=a2c4g.11186623.2.19.1ef943b0S1mEAY)中的回调事件(参数表如下),回调事件中会携带每通通话全局唯一的**contactId**,通过**contactId**调用[ListRecordingsByContactId](https://help.aliyun.com/document_detail/198091.html?spm=a2c4g.11186623.0.0.259278c5lhoMmf)获取到录音详细信息,其中包含**FileName**。'."\n"
."\n"
.''."\n"
."\n"
.'> **一通通话如果存在转接,那么会包含多个录音文件。**',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyPrivacyNumberCallDetail' => [
'summary' => '调用ModifyPrivacyNumberCallDetail更新话务ID。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'CallId',
'in' => 'query',
'schema' => [
'description' => '记录外呼虚拟号码操作唯一标识',
'type' => 'string',
'required' => true,
'example' => 'bc984e0a-0dd0-422c-9742-758eff869694',
],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => [
'description' => '话务ID',
'type' => 'string',
'required' => true,
'example' => '2063169340',
],
],
],
'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' => '12CE95DF-C91E-4B97-8B7B-0308F191549B',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"12CE95DF-C91E-4B97-8B7B-0308F191549B\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n OK\\r\\n 200\\r\\n 12CE95DF-C91E-4B97-8B7B-0308F191549B\\r\\n true\\r\\n","errorExample":""}]',
'title' => '更新话务ID',
'description' => '客户使用外显虚拟号码外呼时,首先呼叫中心号码(telA)与虚拟号码(telX)建立连接,然后telX与被叫号码(telB)建立连接,从而完成telA与telB的通话,此过程产生唯一通话标识,需记录到外呼虚拟号码操作表以便用户查看录音文件信息。',
],
'StartBack2BackCall' => [
'summary' => '调用StartBack2BackCall发起双呼。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccBCFPY3',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID。'."\n"
."\n"
.'背靠背代理所用电话号码需要归属于该呼叫中心实例。',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'WorkflowId',
'in' => 'query',
'schema' => [
'description' => '联系流ID。'."\n"
."\n"
.'此联系流用来辅助建立双方通话,该字段是扩展用,请留空。',
'type' => 'string',
'required' => false,
'example' => 'null',
'enum' => [
'twoPartiesCallProd',
'twoPartiesCall',
],
],
],
[
'name' => 'CallCenterNumber',
'in' => 'query',
'schema' => [
'description' => '背靠背代理所用电话号码。'."\n"
."\n"
.'该电话号码需要归属于**instanceId**指定的呼叫中心实例,若不指定,则会随机选一个指定实例下可用于外呼的号码。',
'type' => 'string',
'required' => false,
'example' => '0256604****',
],
],
[
'name' => 'Caller',
'in' => 'query',
'schema' => [
'description' => '主叫号码。',
'type' => 'string',
'required' => true,
'example' => '1760066****',
],
],
[
'name' => 'Callee',
'in' => 'query',
'schema' => [
'description' => '被叫号码。',
'type' => 'string',
'required' => true,
'example' => '1880134****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'StatusCode' => [
'description' => '外呼返回状态码',
'type' => 'string',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
'TimeStamp' => [
'description' => '本次外呼的时间戳',
'type' => 'string',
'example' => '2018-07-13 14:06:08',
],
'TaskId' => [
'description' => '本次外呼产生的contactId(即:通话详单中的通话ID),后续可以据此参数查询话务状态。',
'type' => 'string',
'example' => '15716647696706****',
],
'StatusDesc' => [
'description' => '外呼返回状态描述',
'type' => 'string',
'example' => 'Okay',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"Success\\": true,\\n \\"StatusCode\\": \\"200\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": \\"2018-07-13 14:06:08\\",\\n \\"TaskId\\": \\"15716647696706****\\",\\n \\"StatusDesc\\": \\"Okay\\"\\n}","errorExample":""},{"type":"xml","example":"Okay\\n15716647696706****\\n无\\nDE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\n200\\n200\\nOK\\n2018-07-13 14:06:08\\ntrue","errorExample":""}]',
'title' => '发起双呼',
'description' => '双呼和传统的双方通话不同,主叫并不直接呼叫对方,而是通过一个背靠背代理(Back to Back Agent), 背靠背代理首先呼叫主叫方,接通后,再呼叫被叫方,然后把二者拉进一个会场。在这种方式下,由于每个呼叫的所有消息流经背靠背代理,因此服务提供商可以据此提供增值服务,比如计时、录音、隐藏真实号码等等。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListCallDetailRecords' => [
'summary' => '获取呼叫中心中的通话详单数据。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREccc5HY0NN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => [
'description' => '待获取数据的呼叫中心的电话号码',
'type' => 'string',
'required' => false,
'example' => '1234456****',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '获取的历史数据的起始时间。缺省为0,代表从当天的0时开始。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1532448000000',
],
],
[
'name' => 'StopTime',
'in' => 'query',
'schema' => [
'description' => '获取的历史数据的终止时间。缺省为0,代表截止到目前的时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1532707199000',
],
],
[
'name' => 'Criteria',
'in' => 'query',
'schema' => [
'description' => '搜索条件。'."\n"
."\n"
.'可以根据客户电话、坐席姓名、技能组名称来搜索。',
'type' => 'string',
'required' => false,
'example' => '客服组',
],
],
[
'name' => 'ContactType',
'in' => 'query',
'schema' => [
'description' => '按呼叫类型筛选。'."\n"
."\n"
.'取值:Inbound(呼入),Outbound(呼出),Back2Back(双呼),PredictiveDial(预测试外呼),PrivacyDial(虚拟号码外呼) 多个条件以逗号隔开。',
'type' => 'string',
'required' => false,
'example' => 'Outbound,Inbound',
],
],
[
'name' => 'ContactDisposition',
'in' => 'query',
'schema' => [
'description' => '按挂断类型筛选。'."\n"
."\n"
.'取值:Success(正常),NoAnswer(未接通),AbandonedInContactFlow(IVR中放弃),AbandonedInQueue(排队放弃),AbandonedRing(振铃放弃),QueueOverflow(排队超时),OneStepTransfer(转外线),多个条件以逗号隔开。',
'type' => 'string',
'required' => false,
'example' => 'NoAnswer,AbandonedInContactFlow,AbandonedRing',
],
],
[
'name' => 'WithRecording',
'in' => 'query',
'schema' => [
'description' => '是否需要录音。默认需要,显式的指明不需要可以加快查询速度。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => [
'description' => '通过指定的contactId来查询某一通电话的记录,contactId可以通过软电话SDK发生通话时获取到。',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => [
'description' => '按时间升降序排列。默认升序,取值: ASC/DESC。',
'type' => 'string',
'required' => false,
'example' => 'ASC',
'default' => 'ASC',
'enum' => [
'ASC',
'DESC',
],
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '5000',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小,最大数量为100',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
],
'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' => 'D70B6625-B54F-4831-BDC4-917A7EBBCE77',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'CallDetailRecords' => [
'description' => '获取到的通话详单',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'TotalCount' => [
'description' => '对象总数',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CallDetailRecord' => [
'description' => '对象列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ContactDisposition' => [
'description' => '电话结束原因。'."\n"
."\n"
.'参考枚举值:Success(正常),NoAnswer(未接通),AbandonedInContactFlow(IVR中放弃),AbandonedInQueue(排队放弃),AbandonedRing(振铃放弃),QueueOverflow(排队超时),OneStepTransfer(转外线)。',
'type' => 'string',
'example' => 'Success',
],
'ContactType' => [
'description' => '通话类型。'."\n"
."\n"
.'参考枚举值:Inbound(0) 内呼, Outbound(1) 外呼, Internal(2) 内部通话。',
'type' => 'string',
'example' => 'Outbound',
],
'SkillGroupIdList' => [
'description' => '参与通话的座席所述的技能组ID,多个技能组ID以逗号分隔。',
'type' => 'string',
'example' => '68536c62-9c25-4201-b4fa-cb15a0d6****,68536c62-9c25-4201-b4fa-cb15a0d****',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => '14b32e95-405b-4514-8118-85e64b22****',
],
'CalledNumber' => [
'description' => '被叫号码',
'type' => 'string',
'example' => '1234444****',
],
'AgentNames' => [
'description' => '参与通话的座席,多个座席之间以逗号分隔。',
'type' => 'string',
'example' => '千牛卖家测试',
],
'Satisfaction' => [
'description' => '满意度对应的按键,比如1或者2。'."\n"
."\n"
.'注:只有在发送满意度邀请给客户,并且客户做出评价反馈后,才返回本字段。如果未发送或者发送但未评价,返回内容中不包含本字段。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'StartTime' => [
'description' => '电话开始时间,内呼从进入IVR开始,外呼从开始接通计算。',
'type' => 'integer',
'format' => 'int64',
'example' => '1546575494000',
],
'SatisfactionDesc' => [
'description' => '在发送满意度客户评价的情况下,该字段为满意度按键(Satisfaction)对应的描述,比如满意、非常满意。若为“未发送”,表示未发送满意度评价邀请给客户;若为“未评价”,表示发送满意度邀请给客户,但客户未评价。',
'type' => 'string',
'example' => '不满意',
],
'ContactId' => [
'description' => '话务ID,全局唯一,对应于 ACC的ACID。',
'type' => 'string',
'example' => '2118423213',
],
'CallingNumber' => [
'description' => '主叫号码',
'type' => 'string',
'example' => '07553656****',
],
'Duration' => [
'description' => '通话持续时间,单位为秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'SkillGroupNames' => [
'description' => '参与通话的座席所述的技能组,多个技能组以逗号分隔。',
'type' => 'string',
'example' => '默认技能组',
],
'Feedback' => [
'description' => '不满意度反馈描述',
'type' => 'string',
'example' => '基本技能太差',
],
'Agents' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CallDetailAgent' => [
'description' => '座席列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Satisfaction' => [
'description' => '满意度',
'type' => 'string',
'example' => '不满意',
],
'Feedback' => [
'description' => '不满意情况下二级反馈信息',
'type' => 'string',
'example' => '基本技能太差',
],
'AgentId' => [
'description' => '座席ID,等同于该座席的RAM子账户ID。',
'type' => 'string',
'example' => '101820677302****',
],
],
],
],
],
],
'Recordings' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Recording' => [
'description' => '录音列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StartTime' => [
'description' => '通话开始时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1546575367000',
],
'ContactId' => [
'description' => '通话ID',
'type' => 'string',
'example' => '2118422093',
],
'QualityCheckTaskId' => [
'description' => '智能质检任务ID',
'type' => 'string',
'example' => 'xxx',
],
'AgentId' => [
'description' => '座席ID,等同于该座席的RAM子账户ID。',
'type' => 'string',
'example' => '101820677302****',
],
'FileDescription' => [
'description' => '录音文件别名',
'type' => 'string',
'example' => '20190104121607-千牛卖家测试',
],
'Duration' => [
'description' => '通话时长',
'type' => 'integer',
'format' => 'int32',
'example' => '7',
],
'AgentName' => [
'description' => '座席名称',
'type' => 'string',
'example' => '千牛卖家测试',
],
'FileName' => [
'description' => '录音文件名',
'type' => 'string',
'example' => '154657536797300080308468.wav',
],
'QualityCheckTid' => [
'description' => '智能质检文本ID',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"D70B6625-B54F-4831-BDC4-917A7EBBCE77\\",\\n \\"Success\\": true,\\n \\"CallDetailRecords\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 5,\\n \\"TotalCount\\": 3,\\n \\"List\\": {\\n \\"CallDetailRecord\\": [\\n {\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"Outbound\\",\\n \\"SkillGroupIdList\\": \\"68536c62-9c25-4201-b4fa-cb15a0d6****,68536c62-9c25-4201-b4fa-cb15a0d****\\",\\n \\"InstanceId\\": \\"14b32e95-405b-4514-8118-85e64b22****\\",\\n \\"CalledNumber\\": \\"1234444****\\",\\n \\"AgentNames\\": \\"千牛卖家测试\\",\\n \\"Satisfaction\\": 3,\\n \\"StartTime\\": 1546575494000,\\n \\"SatisfactionDesc\\": \\"不满意\\",\\n \\"ContactId\\": \\"2118423213\\",\\n \\"CallingNumber\\": \\"07553656****\\",\\n \\"Duration\\": 15,\\n \\"SkillGroupNames\\": \\"默认技能组\\",\\n \\"Feedback\\": \\"基本技能太差\\",\\n \\"Agents\\": {\\n \\"CallDetailAgent\\": [\\n {\\n \\"Satisfaction\\": \\"不满意\\",\\n \\"Feedback\\": \\"基本技能太差\\",\\n \\"AgentId\\": \\"101820677302****\\"\\n }\\n ]\\n },\\n \\"Recordings\\": {\\n \\"Recording\\": [\\n {\\n \\"StartTime\\": 1546575367000,\\n \\"ContactId\\": \\"2118422093\\",\\n \\"QualityCheckTaskId\\": \\"xxx\\",\\n \\"AgentId\\": \\"101820677302****\\",\\n \\"FileDescription\\": \\"20190104121607-千牛卖家测试\\",\\n \\"Duration\\": 7,\\n \\"AgentName\\": \\"千牛卖家测试\\",\\n \\"FileName\\": \\"154657536797300080308468.wav\\",\\n \\"QualityCheckTid\\": \\"xxx\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nD70B6625-B54F-4831-BDC4-917A7EBBCE77\\n\\n 3\\n 5\\n 1\\n \\n \\n 1234444****\\n Outbound\\n 14b32e95-405b-4514-8118-85e64b22****\\n Success\\n 3\\n 1546575494000\\n 15\\n 2118423213\\n 不满意\\n 07553656****\\n 基本技能太差\\n 默认技能组\\n 68536c62-9c25-4201-b4fa-cb15a0d6****,68536c62-9c25-4201-b4fa-cb15a0d****\\n 千牛卖家测试\\n \\n \\n 基本技能太差\\n 不满意\\n 101820677302****\\n \\n \\n \\n \\n 20190104121607-千牛卖家测试\\n xxx\\n 154657536797300080308468.wav\\n 1546575367000\\n 7\\n xxx\\n 千牛卖家测试\\n 101820677302****\\n 2118422093\\n \\n \\n \\n
\\n\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '获取通话详单',
'description' => '从系统可靠性角度考虑,目前查询日期区间限制为最大7天。如果业务需要做大量数据的处理,建议您导出数据到自己的系统,做进一步的数据使用。另外页面中的下载报表功能,可以导出1个月的数据。'."\n"
.'**注意**:为了保证查询效率,返回数据中的 **TotalCount** 字段,只会在查询**第一页**时赋值。查询其他页时返回0。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListCallEventDetailByContactId' => [
'summary' => '根据通话ID获取通话的详细操作日志。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => [
'description' => '通过指定的**contactId**来查询某一通电话的记录,contactId可以通过软电话SDK发生通话时获取到。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1096645650',
],
],
],
'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' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '获取到的通话详单',
'type' => 'object',
'properties' => [
'StartTime' => [
'description' => '呼叫时间',
'type' => 'string',
'example' => '1555492246000',
],
'ReleaseReason' => [
'description' => '挂断原因',
'type' => 'string',
'example' => '487-Request Terminated',
],
'CallType' => [
'description' => '呼叫类型',
'type' => 'string',
'example' => 'Outbound',
],
'ReleaseAgent' => [
'description' => '挂断方,customer:用户挂机;agent:坐席挂机,同时提醒,目前有部分数据为兼容,如出现特殊数据请反馈给云呼技术值班同学进行挂断方的定位。',
'type' => 'string',
'example' => 'agent',
],
'Caller' => [
'description' => '主叫号码',
'type' => 'string',
'example' => '8031****',
],
'Callee' => [
'description' => '被叫号码',
'type' => 'string',
'example' => '1350121****',
],
'PrivacyNumber' => [
'description' => '虚拟号码',
'type' => 'string',
'example' => '1234****',
],
'Events' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CallEventDetail' => [
'description' => '对象列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '状态',
'type' => 'string',
'example' => 'Dialing',
],
'CallMode' => [
'description' => '通话类型',
'type' => 'string',
'example' => 'Outbound',
],
'Event' => [
'description' => '事件描述。'."\n"
.'包括:'."\n"
."\n"
.'- **IVR事件**:EnterIVR (进入IVR);'."\n"
.'- **队列事件**:EnterQueue(进入队列)、ACDOverflow(队列溢出)、AbandonedRing(振铃放弃)、NormalEnd(队列中正常结束)、AbandonedInQueue(进入放弃队列)、WaitingInQueue(进入等待队列);'."\n"
.'- **坐席事件**:Ring(振铃)、Talk(通话)、GiveUp(放弃)、End(结束)、Handle(挂断)、CallForHelp(发起求助)、CallForHelpSuccess(求助成功)、SetUpMeeting(会议建立)、Dial(拨号)、LaunchTransfer(转接)。',
'type' => 'string',
'example' => 'Dial',
],
'TimeStamp' => [
'description' => '事件发生时间',
'type' => 'string',
'example' => '1555492246000',
],
'AgentName' => [
'description' => '坐席名',
'type' => 'string',
'example' => 'cloudcallcenter',
],
'Duration' => [
'description' => '持续时间',
'type' => 'integer',
'format' => 'int32',
'example' => '9',
],
'DetailData' => [
'description' => '动态添加所需的详细信息',
'type' => 'object',
'properties' => [
'HangUper' => [
'description' => '被求助者,求助内部坐席,对应坐席名称;求助外部的话,记录外部号码。',
'type' => 'string',
'example' => 'byeSystem',
],
'EventType' => [
'description' => '事件类型 包括:ivr、queue、agent。',
'type' => 'string',
'example' => 'agent',
],
'SkillGroup' => [
'description' => '技能组',
'type' => 'string',
'example' => '测试',
],
'SatisfactionalResearch' => [
'description' => '满意度调查',
'type' => 'string',
'example' => '不满意',
],
'Helper' => [
'description' => '挂机者',
'type' => 'string',
'example' => 'xme',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"StartTime\\": \\"1555492246000\\",\\n \\"ReleaseReason\\": \\"487-Request Terminated\\",\\n \\"CallType\\": \\"Outbound\\",\\n \\"ReleaseAgent\\": \\"agent\\",\\n \\"Caller\\": \\"8031****\\",\\n \\"Callee\\": \\"1350121****\\",\\n \\"PrivacyNumber\\": \\"1234****\\",\\n \\"Events\\": {\\n \\"CallEventDetail\\": [\\n {\\n \\"Status\\": \\"Dialing\\",\\n \\"CallMode\\": \\"Outbound\\",\\n \\"Event\\": \\"Dial\\",\\n \\"TimeStamp\\": \\"1555492246000\\",\\n \\"AgentName\\": \\"cloudcallcenter\\",\\n \\"Duration\\": 9,\\n \\"DetailData\\": {\\n \\"HangUper\\": \\"byeSystem\\",\\n \\"EventType\\": \\"agent\\",\\n \\"SkillGroup\\": \\"测试\\",\\n \\"SatisfactionalResearch\\": \\"不满意\\",\\n \\"Helper\\": \\"xme\\"\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n7BEEA660-A45A-45E3-98CC-AFC65E715C23\\n200\\n\\n 1350121****\\n 487-Request Terminated\\n 8031****\\n 1234****\\n agent\\n 1555492246000\\n Outbound\\n \\n \\n Dialing\\n Dial\\n 9\\n cloudcallcenter\\n Outbound\\n 1555492246000\\n \\n xme\\n 测试\\n byeSystem\\n agent\\n 不满意\\n \\n \\n \\n\\nOK\\ntrue","errorExample":""}]',
'title' => '根据通话ID获取通话操作日志',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListRecentCallRecords' => [
'summary' => '调用ListRecentCallRecords获取呼叫中心当前坐席的最近通话记录。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '获取的历史数据的起始时间。缺省为0,代表从当天的0时开始。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1532448000000',
],
],
[
'name' => 'StopTime',
'in' => 'query',
'schema' => [
'description' => '获取的历史数据的终止时间。缺省为0,代表截止到目前的时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1532707199000',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
[
'name' => 'Criteria',
'in' => 'query',
'schema' => [
'description' => '搜索条件。'."\n"
."\n"
.'可以根据号码(客户电话或坐席号码)来搜索。',
'type' => 'string',
'required' => false,
'example' => '{"phoneNumber": "0411xxxx4588"}',
],
],
],
'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' => '032C73C4-3A6F-4502-872B-4F5B41161C6E',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'CallDetailRecords' => [
'description' => '获取到的通话详单',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '对象总数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CallDetailRecord' => [
'description' => '对象列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ContactDisposition' => [
'description' => '电话结束原因。'."\n"
."\n"
.'参考枚举值:Success(0) 正常, NoAnswer(1) 无应答, Rejected(2)拒绝, Busy(3)忙, AbandonedInContactFlow(4) IVR呼损, AbandonedInQueue(5)队列呼损, AbandonedRing(6) 久振不接, QueueOverflow(7) 等待超时被挂断。',
'type' => 'string',
'example' => 'Success',
],
'ContactType' => [
'description' => '通话类型。'."\n"
."\n"
.'参考枚举值:Inbound(0) 内呼, Outbound(1) 外呼, Internal(2) 内部通话。',
'type' => 'string',
'example' => 'Outbound',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
'CalledNumber' => [
'description' => '被叫号码',
'type' => 'string',
'example' => '0109898****',
],
'AgentNames' => [
'description' => '参与通话的座席,多个座席之间以逗号分隔。',
'type' => 'string',
'example' => 'ccctest',
],
'Satisfaction' => [
'description' => '满意度',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'StartTime' => [
'description' => '电话开始时间,内呼从进入IVR开始,外呼从开始接通计算。',
'type' => 'integer',
'format' => 'int64',
'example' => '1532448000000',
],
'ExtraAttr' => [
'description' => '额外信息',
'type' => 'string',
'example' => '无',
],
'SatisfactionDesc' => [
'description' => '满意度描述',
'type' => 'string',
'example' => '满意',
],
'ContactId' => [
'description' => '话务ID,全局唯一,对应于 ACC的ACID。',
'type' => 'string',
'example' => '20988909',
],
'CallingNumber' => [
'description' => '主叫号码',
'type' => 'string',
'example' => '1930909****',
],
'Duration' => [
'description' => '通话持续时间,单位为秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '39',
],
'SkillGroupNames' => [
'description' => '参与通话的座席所述的技能组,多个技能组以逗号分隔。',
'type' => 'string',
'example' => '技能组1',
],
'Feedback' => [
'description' => '反馈',
'type' => 'string',
'example' => '不满意',
],
'Agents' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CallDetailAgent' => [
'description' => '座席通话参与详情',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AgentId' => [
'description' => '座席ID',
'type' => 'string',
'example' => '105987678892xxxx',
],
'TalkTime' => [
'description' => '通话时间,单位为秒',
'type' => 'integer',
'format' => 'int32',
'example' => '54',
],
'WorkTime' => [
'description' => '话后处理时间,单位为秒',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'AgentName' => [
'description' => '座席名称',
'type' => 'string',
'example' => 'ccctest',
],
'RingTime' => [
'description' => '振铃时间,单位为秒',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Satisfaction' => [
'description' => '满意度',
'type' => 'string',
'example' => '1',
],
'StartTime' => [
'description' => '通话开始时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1532448000000',
],
'ContactId' => [
'description' => '话务ID',
'type' => 'string',
'example' => '123909012',
],
'SkillGroupName' => [
'description' => '技能组名称',
'type' => 'string',
'example' => '技能组1',
],
'HoldTime' => [
'description' => '通话保持时间,单位为秒',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'QueueTime' => [
'description' => '排队时间,单位为秒',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'Feedback' => [
'description' => '反馈',
'type' => 'string',
'example' => '不满意',
],
],
],
],
],
],
'Recordings' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Recording' => [
'description' => '通话录音列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ContactType' => [
'description' => '通话类型',
'type' => 'string',
'example' => 'Outbound',
],
'AgentId' => [
'description' => '座席ID',
'type' => 'string',
'example' => '105987678892xxxx',
],
'AgentName' => [
'description' => '座席名称',
'type' => 'string',
'example' => 'ccctest',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
'FileName' => [
'description' => '录音文件名',
'type' => 'string',
'example' => '0001.wav',
],
'CalledNumber' => [
'description' => '被叫号码',
'type' => 'string',
'example' => '1930909****',
],
'StartTime' => [
'description' => '通话开始时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1532448000000',
],
'FilePath' => [
'description' => '录音文件在OSS中的保存位置',
'type' => 'string',
'example' => 'oss://cloudcall-test/acc123',
],
'ContactId' => [
'description' => '话务ID',
'type' => 'string',
'example' => '123909012',
],
'CallingNumber' => [
'description' => '主叫电话',
'type' => 'string',
'example' => '0109898****',
],
'Duration' => [
'description' => '通话时长',
'type' => 'integer',
'format' => 'int32',
'example' => '38',
],
'FileDescription' => [
'description' => '录音文件别名',
'type' => 'string',
'example' => '无',
],
'Channel' => [
'description' => '座席所在音轨标示',
'type' => 'string',
'example' => '无',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"032C73C4-3A6F-4502-872B-4F5B41161C6E\\",\\n \\"Success\\": true,\\n \\"CallDetailRecords\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": {\\n \\"CallDetailRecord\\": [\\n {\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"Outbound\\",\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3****\\",\\n \\"CalledNumber\\": \\"0109898****\\",\\n \\"AgentNames\\": \\"ccctest\\",\\n \\"Satisfaction\\": 1,\\n \\"StartTime\\": 1532448000000,\\n \\"ExtraAttr\\": \\"无\\",\\n \\"SatisfactionDesc\\": \\"满意\\",\\n \\"ContactId\\": \\"20988909\\",\\n \\"CallingNumber\\": \\"1930909****\\",\\n \\"Duration\\": 39,\\n \\"SkillGroupNames\\": \\"技能组1\\",\\n \\"Feedback\\": \\"不满意\\",\\n \\"Agents\\": {\\n \\"CallDetailAgent\\": [\\n {\\n \\"AgentId\\": \\"105987678892xxxx\\",\\n \\"TalkTime\\": 54,\\n \\"WorkTime\\": 15,\\n \\"AgentName\\": \\"ccctest\\",\\n \\"RingTime\\": 10,\\n \\"Satisfaction\\": \\"1\\",\\n \\"StartTime\\": 1532448000000,\\n \\"ContactId\\": \\"123909012\\",\\n \\"SkillGroupName\\": \\"技能组1\\",\\n \\"HoldTime\\": 30,\\n \\"QueueTime\\": 5,\\n \\"Feedback\\": \\"不满意\\"\\n }\\n ]\\n },\\n \\"Recordings\\": {\\n \\"Recording\\": [\\n {\\n \\"ContactType\\": \\"Outbound\\",\\n \\"AgentId\\": \\"105987678892xxxx\\",\\n \\"AgentName\\": \\"ccctest\\",\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3****\\",\\n \\"FileName\\": \\"0001.wav\\",\\n \\"CalledNumber\\": \\"1930909****\\",\\n \\"StartTime\\": 1532448000000,\\n \\"FilePath\\": \\"oss://cloudcall-test/acc123\\",\\n \\"ContactId\\": \\"123909012\\",\\n \\"CallingNumber\\": \\"0109898****\\",\\n \\"Duration\\": 38,\\n \\"FileDescription\\": \\"无\\",\\n \\"Channel\\": \\"无\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n ccctest\\n \\n 105987678892xxxx\\n ccctest\\n 123909012\\n 不满意\\n 30\\n 10\\n 1\\n 技能组1\\n 1532448000000\\n 54\\n 15\\n \\n 0109898****\\n 1930909****\\n Success\\n 20988909\\n Outbound\\n 39\\n 不满意\\n 9cfad875-6260-4a53-ab6e-b13e3fb3****\\n \\n 105987678892xxxx\\n ccctest\\n 0109898****\\n 1930909****\\n Success\\n 20988909\\n Outbound\\n 39\\n 0001.wav\\n oss://cloudcall-test/acc123\\n 9cfad875-6260-4a53-ab6e-b13e3fb3****\\n 1532448000000\\n \\n 1\\n 满意\\n 技能组1\\n 1532448000000\\n
\\n 1\\n 10\\n 10\\n\\nOK\\n200\\n032C73C4-3A6F-4502-872B-4F5B41161C6E\\ntrue","errorExample":""}]',
'title' => '获取呼叫中心当前坐席的最近通话记录',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetConversationDetailByContactId' => [
'summary' => '根据话务ID(ContactId)获得此次对话的文本信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待获取日常性能数据的呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => [
'description' => '话务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2020927020',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '为扩展预留,目前不生效,请传入1。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '为扩展预留,目前不生效,请传入1-99之间数字。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
],
'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' => 'D5A4E013-09E1-4CDA-B70A-F5D3B75015A3',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'DataList' => [
'description' => '对话结果',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '为扩展预留分页数据',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '为扩展预留分页数据',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalCount' => [
'description' => '对话轮数',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'QualityCheckPhrase' => [
'description' => '对话文本',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'End' => [
'description' => '对话结束偏移量',
'type' => 'integer',
'format' => 'int64',
'example' => '3272',
],
'Words' => [
'description' => '对话文本',
'type' => 'string',
'example' => '您好',
],
'Role' => [
'description' => '角色,客户或者客服。',
'type' => 'string',
'example' => '客服',
],
'Begin' => [
'description' => '对话开始偏移量',
'type' => 'integer',
'format' => 'int64',
'example' => '1317',
],
'Identity' => [
'description' => '身份',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"D5A4E013-09E1-4CDA-B70A-F5D3B75015A3\\",\\n \\"Success\\": true,\\n \\"DataList\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 2,\\n \\"List\\": {\\n \\"QualityCheckPhrase\\": [\\n {\\n \\"End\\": 3272,\\n \\"Words\\": \\"您好\\",\\n \\"Role\\": \\"客服\\",\\n \\"Begin\\": 1317,\\n \\"Identity\\": \\"xxx\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n OK\\r\\n D5A4E013-09E1-4CDA-B70A-F5D3B75015A3\\r\\n true\\r\\n \\r\\n 200\\r\\n","errorExample":""}]',
'title' => '获取通话文本信息',
'description' => '> 此接口依赖于智能对话分析服务,请确保在云呼叫中心中已经开通了智能对话分析,详见:https://help.aliyun.com/document_detail/118820.html, 需要注意的是,智能对话分析服务对转写文本最长保存90天,建议您将数据拉取到本地进行持久化存储。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DialEx' => [
'summary' => '发起后台外呼。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd278629c-c687-4aa3-b044-4fe9b012****',
],
],
[
'name' => 'Caller',
'in' => 'query',
'schema' => [
'description' => '主叫号码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0228519****',
],
],
[
'name' => 'Callee',
'in' => 'query',
'schema' => [
'description' => '被叫号码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1573203****',
],
],
[
'name' => 'RoutPoint',
'in' => 'query',
'schema' => [
'description' => '- 如果AnswerMode是**0**,则传入联系流ID(ContractFlowId);'."\n"
.'- 如果AnwserMode是**1**,则传入接听坐席,格式:ram_id@呼叫中心二级域名;'."\n"
.'- 如果AnwserMode是**2**,则传入接听技能组队列(技能组queue)'."\n"
.'> Q:如何查找呼叫中心二级域名? A: 位置:https://ccc.aliyun.com/workbench/呼叫中心二级域名, *注意:呼叫中心二级域名需要与创建云呼叫中心实例填写的保持一致,此接口会区分二级域名的大小写*',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'paEF_1GAQXXJ',
],
],
[
'name' => 'AnswerMode',
'in' => 'query',
'schema' => [
'description' => '接听方式。三种方式分别为:'."\n"
."\n"
.'- **0**:ivr'."\n"
.'- **1**:agent'."\n"
.'- **2**:skillgroupid',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'Provider',
'in' => 'query',
'schema' => [
'description' => '外呼方式',
'type' => 'string',
'required' => false,
'example' => 'null',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '26D1277F-55BF-453E-A6B2-02B7E6F97699',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'StatusCode' => [
'description' => '外呼返回状态码',
'type' => 'string',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
'TimeStamp' => [
'description' => '本次外呼的时间戳',
'type' => 'string',
'example' => '1554862236398',
],
'TaskId' => [
'description' => '本次外呼产生的任务ID',
'type' => 'string',
'example' => '15548622359772****',
],
'StatusDesc' => [
'description' => '外呼返回状态描述',
'type' => 'string',
'example' => 'Okay',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"26D1277F-55BF-453E-A6B2-02B7E6F97699\\",\\n \\"Success\\": true,\\n \\"StatusCode\\": \\"200\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": \\"1554862236398\\",\\n \\"TaskId\\": \\"15548622359772****\\",\\n \\"StatusDesc\\": \\"Okay\\"\\n}","errorExample":""},{"type":"xml","example":"Okay\\n15548622359772****\\n无\\n26D1277F-55BF-453E-A6B2-02B7E6F97699\\n200\\n200\\nOK\\n1554862236398\\ntrue","errorExample":""}]',
'title' => '后台外呼',
'description' => '云呼叫中心支持客服从电脑客户端发起外呼之外,也支持有业务系统后台发起外呼,接通后转给坐席接听。以支持把呼叫中心功能无缝嵌入您的业务流程。'."\n"
."\n"
.'比如,您的客户可以在您的微信公众号上,输入自己的号码,并点击咨询产品的按钮,由您的后台系统调用本接口,实现呼叫客户手机,接通后播放“我们收到您在公众号上对我们产品的咨询,现在给您转接顾问,请稍等”,并转给合适的客服接听通话。'."\n"
."\n"
.'本接口支持外呼成功后,转坐席/技能组或者IVR流程。'."\n"
."\n"
.'- **转坐席/技能组接听**:AnswerMode设置为1或者2,并指定接听技能组或和坐席。'."\n"
.'- **转IVR接听**:需要先配置相应的IVR并发布,然后将对应的云呼实例ID和联系流ID提供给云呼叫中心-售后技术支持同学或相关技术支持同学审核IVR内容,通过后完成后台设置后,即可调用该接口进行外呼操作。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CallOnlinePrivacyNumber' => [
'summary' => '调用CallOnlinePrivacyNumber使用虚拟号码外呼。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'TelA',
'in' => 'query',
'schema' => [
'description' => '主叫号码',
'type' => 'string',
'required' => true,
'example' => '0256604****',
],
],
[
'name' => 'TelB',
'in' => 'query',
'schema' => [
'description' => '被叫号码',
'type' => 'string',
'required' => true,
'example' => '1880134****',
],
],
],
'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' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回虚拟号码',
'type' => 'object',
'properties' => [
'DateCreated' => [
'description' => '虚拟号码呼叫响应时间',
'type' => 'string',
'example' => '2018/10/27 15:55:55',
],
'Represent' => [
'description' => '虚拟号码呼叫错误描述',
'type' => 'string',
'example' => '无',
],
'TelX' => [
'description' => '虚拟号码',
'type' => 'string',
'example' => '1302015****',
],
'StatusCode' => [
'description' => '虚拟号码呼叫返回状态',
'type' => 'string',
'example' => '000000',
],
'CallId' => [
'description' => '虚拟号码通话唯一标识',
'type' => 'string',
'example' => '5ec64c6b-4b98-4fd6-8ce8-ad07cf84481b',
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"30C7D235-DDCF-4C7F-A462-5E2598252C2B\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DateCreated\\": \\"2018/10/27 15:55:55\\",\\n \\"Represent\\": \\"无\\",\\n \\"TelX\\": \\"1302015****\\",\\n \\"StatusCode\\": \\"000000\\",\\n \\"CallId\\": \\"5ec64c6b-4b98-4fd6-8ce8-ad07cf84481b\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n30C7D235-DDCF-4C7F-A462-5E2598252C2B\\n200\\n\\n 无\\n 5ec64c6b-4b98-4fd6-8ce8-ad07cf84481b\\n 2018/10/27 15:55:55\\n 1302015****\\n 000000\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '使用虚拟号码外呼',
'description' => '呼叫中心号码如果与虚拟号码进行绑定,在外呼的时候可以选择外显虚拟号码进行呼叫。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetConfig' => [
'summary' => '获取单独某一项的配置信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '配置项名称',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'AllowHangup',
],
],
[
'name' => 'ObjectId',
'in' => 'query',
'schema' => [
'description' => '配置维度值。',
'type' => 'string',
'required' => false,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'ObjectType',
'in' => 'query',
'schema' => [
'description' => '配置维度名称,标识该配置作用范围。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'instance',
],
],
],
'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' => 'xxx',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '10A1AD70-E48E-476D-98D9-39BD92193837',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'ConfigItem' => [
'description' => '配置项信息',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '配置项名称',
'type' => 'string',
'example' => 'AllowHangup',
],
'Value' => [
'description' => '配置项的值',
'type' => 'string',
'example' => '1',
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"xxx\\",\\n \\"RequestId\\": \\"10A1AD70-E48E-476D-98D9-39BD92193837\\",\\n \\"Success\\": true,\\n \\"ConfigItem\\": {\\n \\"Name\\": \\"AllowHangup\\",\\n \\"Value\\": \\"1\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 10A1AD70-E48E-476D-98D9-39BD92193837\\n 200\\n \\n AllowHangup\\n 1\\n \\n true\\n OK\\n","errorExample":""}]',
'title' => '获取配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListConfig' => [
'summary' => '获取多个配置信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccTMAX45',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'ConfigItem',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '配置项名称及维度信息。'."\n"
."\n"
.'- AllowHangup 允许坐席呼入挂机 '."\n"
."\n"
.'- ShowCalledID 来电号码显示'."\n"
."\n"
.'- ShowCalleeID 外呼号码显示'."\n"
."\n"
.'- AutoAnswerCall 接听来电'."\n"
."\n"
.'- AudioDownload 录音下载'."\n"
."\n"
.'- AllowChooseSkillGroup 允许坐席选择技能组登录'."\n"
."\n"
.'- enableRecord 坐席侧录音'."\n"
."\n"
.'- SettingWorkbenchLogLevel 工作台日志等级'."\n"
."\n"
.'- SatisfactionSurvey 满意度设置'."\n"
."\n"
.'- SmsSatisfactionSurvey 短信满意度设置'."\n"
."\n\n"
."\n"
.'例如:`{“Name”:”AllowHangup”,”DimensionName”:”instance”}`。其中,**Name**为配置项名称,**DimensionName**为配置维度名称。这里参数名称为**ConfigItem.1**意为只获取1个配置项,如果要获取两个配置项,则需要有**ConfigItem.1**以及**ConfigItem.2**。'."\n",
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '{“Name”:”AllowHangup”,”DimensionName”:”instance”}',
'maxItems' => 99,
],
],
],
'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',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'ConfigItems' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ConfigItem' => [
'description' => '配置项信息列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '配置项名称',
'type' => 'string',
'example' => 'AllowHangup',
],
'Value' => [
'description' => '配置项值',
'type' => 'string',
'example' => '1',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C81FD1A5-4B99-470A-A527-D80150228784\\",\\n \\"Success\\": true,\\n \\"ConfigItems\\": {\\n \\"ConfigItem\\": [\\n {\\n \\"Name\\": \\"AllowHangup\\",\\n \\"Value\\": \\"1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"OK\\n\\n AllowHangup\\n 1\\n\\n\\n ShowCalledID\\n 1\\n\\n\\n ShowCalleeID\\n 1\\n\\n\\n SatisfactionSurvey\\n 1\\n\\n\\n AutoAnswerCall\\n 2\\n\\n\\n SmsSatisfactionSurvey\\n 1\\n\\n\\n enableRecord\\n 1\\n\\n\\n AllowChooseSkillGroup\\n 1\\n\\n\\n SettingWorkbenchLogLevel\\n 3\\n\\n200\\nA42B9532-FC31-4CC0-B8A8-E091FA5E4D6A\\ntrue","errorExample":""}]',
'title' => '批量获取配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => '配置项及返回值说明'."\n"
."\n"
.'- [ ] AllowHangup 1:允许坐席挂机;0:不允许坐席挂机;'."\n"
.'- [ ] ShowCalledID -1:隐藏全部来电号码;0:隐藏部分来电号码;1:显示完整来电号码'."\n"
.'- [ ] ShowCalleeID -1:隐藏全部外呼号码;0:隐藏部分外呼号码;1:显示完整外呼号码'."\n"
.'- [ ] AutoAnswerCall 0:手动接听;n(>0数字):n秒后自动接听'."\n"
.'- [ ] AudioDownload 1:允许坐席下载录音;0:不允许坐席下载录音'."\n"
.'- [ ] AllowChooseSkillGroup 1:坐席选择技能组登录;0:默认全量技能组登录'."\n"
.'- [ ] enableRecord 1:开启坐席侧录音;0:关闭许坐席侧录音'."\n"
.'- [ ] SatisfactionSurvey 1:开启语音满意度功能;0:未开启满意度功能'."\n"
.'- [ ] SmsSatisfactionSurvey 1:开启了短信满意度功能;0:未开启短信满意度功能',
'extraInfo' => ' ',
],
'AddPhoneTags' => [
'summary' => '调用接口:AddPhoneTags 添加号码打标信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'ServiceTag',
'in' => 'query',
'schema' => [
'description' => '业务标签',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'M1',
],
],
[
'name' => 'RegionNameProvince',
'in' => 'query',
'schema' => [
'description' => '归属地省',
'type' => 'string',
'required' => false,
'example' => '北京',
],
],
[
'name' => 'RegionNameCity',
'in' => 'query',
'schema' => [
'description' => '归属地市',
'type' => 'string',
'required' => false,
'example' => '北京',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '号码类型,0:普通号码,1:手机号码',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'Concurrency',
'in' => 'query',
'schema' => [
'description' => '并发量,默认为1',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '15',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'Provider',
'in' => 'query',
'schema' => [
'description' => '运营商',
'type' => 'string',
'required' => false,
'example' => '全国联通',
],
],
[
'name' => 'SipTag',
'in' => 'query',
'schema' => [
'description' => 'SIP打标信息',
'type' => 'string',
'required' => false,
'example' => 'AliTelecom',
],
],
[
'name' => 'PhoneNumberList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '号码集合',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => '01098789876',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码'."\n"
."\n",
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息'."\n"
."\n",
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE',
],
'Success' => [
'description' => '是否成功'."\n"
."\n",
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '为电话号码添加标签',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeletePhoneTags' => [
'summary' => '调用接口:DeletePhoneTags 删除号码打标信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'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' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'PhoneNumberList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '号码集合。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => '01098789876',
'maxItems' => 99,
],
],
],
'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' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"无\\nDE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '删除号码打标信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyPhoneTags' => [
'summary' => '调用接口:ModifyPhoneTags 修改号码打标信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d ',
],
],
[
'name' => 'ServiceTag',
'in' => 'query',
'schema' => [
'description' => '业务标签',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'M1',
],
],
[
'name' => 'SkillGroupIdList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '技能组ID集合',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => 'u8109-6260-4a53-ab6e-b13e3fb31f7d ',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码'."\n"
."\n",
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息'."\n"
."\n",
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '修改号码标签',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListPhoneTags' => [
'summary' => '调用接口:ListPhoneTags查询号码打标信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450"',
],
],
[
'name' => 'OutboundOnly',
'in' => 'query',
'schema' => [
'description' => '是否仅外呼',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'false',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '当前页码',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => [
'description' => '号码',
'type' => 'string',
'required' => false,
'example' => '010989897878',
],
],
[
'name' => 'NumberGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '号码组ID列表',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '121318023891274071',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码'."\n"
."\n",
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息'."\n"
."\n",
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ',
],
'Success' => [
'description' => '是否成功'."\n"
."\n",
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumbers' => [
'description' => '打标号码集合',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总大小',
'type' => 'integer',
'format' => 'int32',
'example' => '29',
],
'List' => [
'description' => '打标号码集合',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '号码类型,0:普通号码,1:手机号码',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ServiceTag' => [
'description' => '业务标签',
'type' => 'string',
'example' => 'M1',
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1554862236398',
],
'City' => [
'description' => '城市',
'type' => 'string',
'example' => '北京',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
'Usage' => [
'description' => '电话号码的用途,呼入,呼出,已经同时用于呼入和呼出。 Inbound, Outbound, Bidirection。',
'type' => 'string',
'example' => 'Bidirection',
],
'PhoneNumberId' => [
'description' => '号码ID',
'type' => 'string',
'example' => '129031-joriew-EIOD',
],
'Provider' => [
'description' => '供应商',
'type' => 'string',
'example' => 'ali Telecom',
],
'Number' => [
'description' => '号码',
'type' => 'string',
'example' => '01009090909',
],
'ContactFlowId' => [
'description' => '联系流ID',
'type' => 'string',
'example' => '1231jfowei-uoer012091i',
],
'PhoneNumberDescription' => [
'description' => '号码描述',
'type' => 'string',
'example' => '无',
],
'Province' => [
'description' => '省份',
'type' => 'string',
'example' => '北京',
],
'Concurrency' => [
'description' => '并发量,默认是1'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SkillGroupIdList' => [
'type' => 'array',
'items' => [
'description' => '技能组ID集合',
'type' => 'string',
'example' => '[]',
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"Success\\": true,\\n \\"PhoneNumbers\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 29,\\n \\"List\\": [\\n {\\n \\"Type\\": 0,\\n \\"ServiceTag\\": \\"M1\\",\\n \\"CreateTime\\": 1554862236398,\\n \\"City\\": \\"北京\\",\\n \\"InstanceId\\": \\"d278629c-c687-4aa3-b044-4fe9b012e7ef\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"PhoneNumberId\\": \\"129031-joriew-EIOD\\",\\n \\"Provider\\": \\"ali Telecom\\",\\n \\"Number\\": \\"01009090909\\",\\n \\"ContactFlowId\\": \\"1231jfowei-uoer012091i\\",\\n \\"PhoneNumberDescription\\": \\"无\\",\\n \\"Province\\": \\"北京\\",\\n \\"Concurrency\\": 1,\\n \\"SkillGroupIdList\\": [\\n \\"[]\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 29\\n 10\\n 1\\n \\n Bidirection\\n 1231jfowei-uoer012091i\\n d278629c-c687-4aa3-b044-4fe9b012e7ef\\n M1\\n 1554862236398\\n 北京\\n 129031-joriew-EIOD\\n 北京\\n ali Telecom\\n 无\\n 0\\n 01009090909\\n 1\\n
\\n \\n []\\n
\\n\\n无\\nDE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\t\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '获取号码标签列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddBulkPhoneNumbers' => [
'summary' => '调用AddBulkPhoneNumbers批量新增号码。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待添加电话号码的呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd278629c-c687-4aa3-b044-4fe9b012****',
],
],
[
'name' => 'Usage',
'in' => 'query',
'schema' => [
'description' => '该电话号码的用途。取值:**Inbound**(呼入),**Outboung**(呼出),**Bidirection**(同时用于呼入和呼出)。'."\n"
."\n"
.'> 如果传入的号码包含400号码,该值只能传入**Inbound**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Bidirection',
],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => [
'description' => '和电话号码绑定的联系流ID。',
'type' => 'string',
'required' => false,
'example' => '8Cvg_0mcsm6K',
],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待添加电话号码。'."\n"
."\n"
.'参数名称为**PhoneNumber.1**表示只获取1个技能组信息,如果要获取多个技能组信息,则需要有PhoneNumber.1以及PhoneNumber.2,以此类推。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => '0216066****',
'maxItems' => 99,
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '和电话号码绑定的技能组ID。'."\n"
."\n"
.'参数名称为**SkillGroupId.1**表示只获取1个技能组信息。如果要获取多个技能组信息,则需要有SkillGroupId.1以及SkillGroupId.2,以此类推。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0',
'maxItems' => 99,
],
],
],
'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' => '943D8EF3-3321-471F-A104-51C96FCA94D6',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'ArrearagePhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ArrearagePhoneNumber' => [
'type' => 'array',
'items' => [
'description' => '欠费号码的信息。',
'type' => 'string',
'example' => '{"ArrearagePhoneNumber":[ ]}',
],
],
],
],
'FailedPhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FailedPhoneNumber' => [
'type' => 'array',
'items' => [
'description' => '添加失败号码的信息。',
'type' => 'string',
'example' => '{"FailedPhoneNumber":[ ]}',
],
],
],
],
'UserdPhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UserdPhoneNumber' => [
'type' => 'array',
'items' => [
'description' => '已经被使用号码的信息。',
'type' => 'string',
'example' => '{"UserdPhoneNumber":[ ]}',
],
],
],
],
'PhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PhoneNumber' => [
'description' => '获取到的呼叫中心实例的所有电话号码列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TestOnly' => [
'description' => '是否是测试号码。',
'type' => 'boolean',
'example' => 'true',
],
'Trunks' => [
'description' => '电话号码的中继数量,即可同时支持几路通话,数据来源于大于。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'RemainingTime' => [
'description' => '测试号码剩余的通话时间。单位为分钟。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'Number' => [
'description' => '电话号码。',
'type' => 'string',
'example' => '1788888****',
],
'InstanceId' => [
'description' => '电话号码所归属的呼叫中心实例ID。',
'type' => 'string',
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
'Usage' => [
'description' => '电话号码的用途,呼入(**Inbound**),呼出(**Outbound**),已经同时用于呼入和呼出(**Bidirection**)。上述值由枚举类型PhoneNumberType定义。'."\n"
."\n"
.'该值的结果取决于:'."\n"
."\n"
.'- 大于的设置,比如400号码不允许外呼'."\n"
.'- 呼叫中心实例的设置'."\n"
."\n"
.'> 电话号码一般都允许内呼,如果不允许内呼,可以1)由大于做设置,用户拨打该号码时听到提示音。2)该号码不连接人和联系流IVR,但是ACC不建议这么做。',
'type' => 'string',
'example' => 'Bidirection',
],
'AllowOutbound' => [
'description' => '是否允许外呼,结果取决于:'."\n"
."\n"
.'- 大于的设置,比如400号码不允许外呼'."\n"
.'- 呼叫中心实例的设置'."\n"
."\n"
.'> 电话号码一般都允许内呼,如果不允许内呼,可以1)由大于做设置,用户拨打该号码时听到提示音 2)该号码不绑定联系流IVR,但是ACC不建议这么做。',
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumberDescription' => [
'description' => '电话号码的简单描述。',
'type' => 'string',
'example' => 'xxx',
],
'PhoneNumberId' => [
'description' => '电话号码ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '125435986',
],
'SkillGroups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillGroup' => [
'description' => '电话号码所关联的技能组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SkillGroupName' => [
'description' => '技能组名称。',
'type' => 'string',
'example' => '预测试外呼技能组',
],
'SkillGroupId' => [
'description' => '技能组ID。',
'type' => 'string',
'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0',
],
],
],
],
],
],
'ContactFlow' => [
'description' => '电话号码所连接的联系流IVR。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '流程类型, 定义来自于ContactFlowType。',
'type' => 'string',
'example' => '0',
],
'ContactFlowDescription' => [
'description' => '联系流的简单描述。',
'type' => 'string',
'example' => 'Welcome',
],
'InstanceId' => [
'description' => '联系流所归属的呼叫中心实例。',
'type' => 'string',
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
'ContactFlowName' => [
'description' => '联系流名称,在一个实例内名称不能重复。',
'type' => 'string',
'example' => 'Welcome',
],
'ContactFlowId' => [
'description' => '联系流唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '2932',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Success\\": true,\\n \\"ArrearagePhoneNumbers\\": {\\n \\"ArrearagePhoneNumber\\": [\\n \\"{\\\\\\"ArrearagePhoneNumber\\\\\\":[ ]}\\"\\n ]\\n },\\n \\"FailedPhoneNumbers\\": {\\n \\"FailedPhoneNumber\\": [\\n \\"{\\\\\\"FailedPhoneNumber\\\\\\":[ ]}\\"\\n ]\\n },\\n \\"UserdPhoneNumbers\\": {\\n \\"UserdPhoneNumber\\": [\\n \\"{\\\\\\"UserdPhoneNumber\\\\\\":[ ]}\\"\\n ]\\n },\\n \\"PhoneNumbers\\": {\\n \\"PhoneNumber\\": [\\n {\\n \\"TestOnly\\": true,\\n \\"Trunks\\": 30,\\n \\"RemainingTime\\": 60,\\n \\"Number\\": \\"1788888****\\",\\n \\"InstanceId\\": \\"d278629c-c687-4aa3-b044-4fe9b012e7ef\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"AllowOutbound\\": true,\\n \\"PhoneNumberDescription\\": \\"xxx\\",\\n \\"PhoneNumberId\\": \\"125435986\\",\\n \\"SkillGroups\\": {\\n \\"SkillGroup\\": [\\n {\\n \\"SkillGroupName\\": \\"预测试外呼技能组\\",\\n \\"SkillGroupId\\": \\"3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0\\"\\n }\\n ]\\n },\\n \\"ContactFlow\\": {\\n \\"Type\\": \\"0\\",\\n \\"ContactFlowDescription\\": \\"Welcome\\",\\n \\"InstanceId\\": \\"d278629c-c687-4aa3-b044-4fe9b012e7ef\\",\\n \\"ContactFlowName\\": \\"Welcome\\",\\n \\"ContactFlowId\\": \\"2932\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n {\\"ArrearagePhoneNumber\\":[ ]}\\n\\n\\n \\n Bidirection\\n true\\n true\\n 1788888****\\n d278629c-c687-4aa3-b044-4fe9b012e7ef\\n 60\\n 30\\n 125435986\\n xxx\\n \\n \\n 预测试外呼技能组\\n 3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0\\n \\n \\n \\n 0\\n d278629c-c687-4aa3-b044-4fe9b012e7ef\\n 2932\\n Welcome\\n Welcome\\n \\n \\n\\n无\\n943D8EF3-3321-471F-A104-51C96FCA94D6\\n200\\n\\n {\\"FailedPhoneNumber\\":[ ]}\\n\\n\\n {\\"UserdPhoneNumber\\":[ ]}\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '批量新增号码',
'description' => '将从云呼控制台购买的电话号码绑定到呼叫中心实例中,并且可以和IVR流程以及技能组进行绑定。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddPhoneNumber' => [
'summary' => '调用AddPhoneNumber新增号码。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREccc1MRAID',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待添加电话号码的呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => [
'description' => '待添加电话号码。',
'type' => 'string',
'required' => true,
'example' => '05316896****',
],
],
[
'name' => 'Usage',
'in' => 'query',
'schema' => [
'description' => '该电话号码的用途。取值:呼入(**Inbound**),呼出(**Outboung**),已经同时用于呼入和呼出(**Bidirection**)。'."\n"
."\n"
.'> 如果传入号码为400号码,该值只能传入**Inbound**。',
'type' => 'string',
'required' => true,
'example' => 'Bidirection',
],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => [
'description' => '和电话号码绑定的联系流ID。',
'type' => 'string',
'required' => false,
'example' => 'dDMD_0mif4hv',
],
],
],
'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' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumber' => [
'description' => '新添加的电话号码的信息',
'type' => 'object',
'properties' => [
'TestOnly' => [
'description' => '是否是测试号码。',
'type' => 'boolean',
'example' => 'true',
],
'Trunks' => [
'description' => '电话号码的中继数量,即可同时支持几路通话,数据来源于大于。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'RemainingTime' => [
'description' => '测试号码剩余的通话时间。单位为分钟。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'Number' => [
'description' => '电话号码。',
'type' => 'string',
'example' => '1788888****',
],
'InstanceId' => [
'description' => '电话号码所归属的呼叫中心实例ID。',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
'Usage' => [
'description' => '电话号码的用途。取值:呼入(Inbound),呼出(Outbound),已经同时用于呼入和呼出(Bidirection)上述值由枚举类型PhoneNumberType定义。'."\n"
."\n"
.'该值的结果取决于:'."\n"
."\n"
.'- 大于的设置,比如400号码不允许外呼'."\n"
.'- 呼叫中心实例的设置'."\n"
."\n"
.'> 电话号码一般都允许内呼,如果不允许内呼,可以1)由大于做设置,用户拨打该号码时听到提示音 2)该号码不连接人和联系流IVR,但是ACC不建议这么做。',
'type' => 'string',
'example' => 'Bidirection',
],
'AllowOutbound' => [
'description' => '是否允许外呼,结果取决于:'."\n"
."\n"
.'- 大于的设置,比如400号码不允许外呼'."\n"
.'- 呼叫中心实例的设置'."\n"
."\n"
.'> 电话号码一般都允许内呼,如果不允许内呼,可以1)由大于做设置,用户拨打该号码时听到提示音 2)该号码不绑定联系流IVR,但是ACC不建议这么做。',
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumberDescription' => [
'description' => '电话号码的简单描述。',
'type' => 'string',
'example' => '无',
],
'PhoneNumberId' => [
'description' => '电话号码ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '9191956d-3464-402b-8017-ea8df5d8****',
],
'ContactFlow' => [
'description' => '电话号码所连接的联系流IVR。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '流程类型, 定义来自于ContactFlowType。',
'type' => 'string',
'example' => '0',
],
'ContactFlowDescription' => [
'description' => '联系流的简单描述。',
'type' => 'string',
'example' => 'Welcome',
],
'InstanceId' => [
'description' => '联系流所归属的呼叫中心实例。',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
'ContactFlowName' => [
'description' => '联系流名称,在一个实例内名称不能重复。',
'type' => 'string',
'example' => 'Welcome',
],
'ContactFlowId' => [
'description' => '联系流唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '2957',
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Success\\": true,\\n \\"PhoneNumber\\": {\\n \\"TestOnly\\": true,\\n \\"Trunks\\": 30,\\n \\"RemainingTime\\": 60,\\n \\"Number\\": \\"1788888****\\",\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3****\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"AllowOutbound\\": true,\\n \\"PhoneNumberDescription\\": \\"无\\",\\n \\"PhoneNumberId\\": \\"9191956d-3464-402b-8017-ea8df5d8****\\",\\n \\"ContactFlow\\": {\\n \\"Type\\": \\"0\\",\\n \\"ContactFlowDescription\\": \\"Welcome\\",\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3****\\",\\n \\"ContactFlowName\\": \\"Welcome\\",\\n \\"ContactFlowId\\": \\"2957\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nBC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\n200\\n\\n Bidirection\\n true\\n true\\n 1788888****\\n 9cfad875-6260-4a53-ab6e-b13e3fb3****\\n 60\\n 30\\n 9191956d-3464-402b-8017-ea8df5d8****\\n 无\\n \\n 0\\n 9cfad875-6260-4a53-ab6e-b13e3fb3****\\n 2957\\n Welcome\\n Welcome\\n \\n\\nOK\\ntrue","errorExample":""}]',
'title' => '新增号码',
'description' => '将从云呼控制台购买的电话号码绑定到呼叫中心实例中,并且可以和IVR流程进行绑定。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyPhoneNumber' => [
'summary' => '比如内呼和外呼属性以及绑定的IVR流程。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
],
[
'name' => 'PhoneNumberId',
'in' => 'query',
'schema' => [
'description' => '待修改的电话号码ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cc583e96-6bae-437e-9aeb-bffd5aeddb73',
],
],
[
'name' => 'Usage',
'in' => 'query',
'schema' => [
'description' => '该电话号码的用途。取值:呼入(**Inbound**),呼出(**Outbound**),已经同时用于呼入和呼出(**Bidirection**)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Bidirection',
],
],
[
'name' => 'ContactFlowId',
'in' => 'query',
'schema' => [
'description' => '和电话号码绑定的联系流ID',
'type' => 'string',
'required' => false,
'example' => '8Cvg_0mcsm6',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '和电话号码绑定的技能组ID。'."\n"
."\n\n"
.'参数名称**SkillGroupId.1**表示只获取1个技能组信息。如果要获取多个技能组信息,则需要有SkillGroupId.1以及SkillGroupId.2。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0',
'maxItems' => 99,
],
],
],
'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' => '54F6A60E-541A-4C3B-8A9D-F69FEA9DD704',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumber' => [
'description' => '电话号码信息',
'type' => 'object',
'properties' => [
'TestOnly' => [
'description' => '是否是测试号码。',
'type' => 'boolean',
'example' => 'false',
],
'Trunks' => [
'description' => '电话号码的中继数量,即可同时支持几路通话,数据来源于大于。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'RemainingTime' => [
'description' => '测试号码剩余的通话时间。单位为分钟。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'Number' => [
'description' => '电话号码。',
'type' => 'string',
'example' => '17788888888',
],
'InstanceId' => [
'description' => '电话号码所归属的呼叫中心实例ID。',
'type' => 'string',
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
'Usage' => [
'description' => '电话号码的用途,呼入(**Inbound**),呼出(**Outbound**),已经同时用于呼入和呼出(**Bidirection**)。上述值由枚举类型PhoneNumberType定义。'."\n"
."\n"
.'该值的结果取决于:'."\n"
."\n"
.'- 大于的设置,比如400号码不允许外呼'."\n"
.'- 呼叫中心实例的设置'."\n"
."\n"
.'> 电话号码一般都允许内呼,如果不允许内呼,可以1)由大于做设置,用户拨打该号码时听到提示音 2)该号码不连接人和联系流IVR,但是ACC不建议这么做。',
'type' => 'string',
'example' => 'Bidirection',
],
'AllowOutbound' => [
'description' => '是否允许外呼,结果取决于:'."\n"
."\n"
.'- 大于的设置,比如400号码不允许外呼'."\n"
.'- 呼叫中心实例的设置'."\n"
."\n"
.'> 电话号码一般都允许内呼,如果不允许内呼,可以1)由大于做设置,用户拨打该号码时听到提示音 2)该号码不绑定联系流IVR,但是ACC不建议这么做。'."\n",
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumberDescription' => [
'description' => '电话号码的简单描述。',
'type' => 'string',
'example' => 'Ali Telecom',
],
'PhoneNumberId' => [
'description' => '电话号码ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '346489',
],
'SkillGroups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillGroup' => [
'description' => '电话号码所关联的技能组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SkillGroupName' => [
'description' => '技能组名称。',
'type' => 'string',
'example' => '预测试外呼技能组',
],
'SkillGroupId' => [
'description' => '技能组ID。',
'type' => 'string',
'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0',
],
],
],
],
],
],
'ContactFlow' => [
'description' => '电话号码所连接的联系流IVR。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '流程类型, 定义来自于ContactFlowType。',
'type' => 'string',
'example' => '0',
],
'ContactFlowDescription' => [
'description' => '联系流的简单描述。',
'type' => 'string',
'example' => 'Welcome',
],
'InstanceId' => [
'description' => '联系流所归属的呼叫中心实例。',
'type' => 'string',
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
'ContactFlowName' => [
'description' => '联系流名称,在一个实例内名称不能重复。',
'type' => 'string',
'example' => 'Welcome',
],
'ContactFlowId' => [
'description' => '联系流唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '2932',
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"54F6A60E-541A-4C3B-8A9D-F69FEA9DD704\\",\\n \\"Success\\": true,\\n \\"PhoneNumber\\": {\\n \\"TestOnly\\": false,\\n \\"Trunks\\": 30,\\n \\"RemainingTime\\": 60,\\n \\"Number\\": \\"17788888888\\",\\n \\"InstanceId\\": \\"d278629c-c687-4aa3-b044-4fe9b012e7ef\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"AllowOutbound\\": true,\\n \\"PhoneNumberDescription\\": \\"Ali Telecom\\",\\n \\"PhoneNumberId\\": \\"346489\\",\\n \\"SkillGroups\\": {\\n \\"SkillGroup\\": [\\n {\\n \\"SkillGroupName\\": \\"预测试外呼技能组\\",\\n \\"SkillGroupId\\": \\"3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0\\"\\n }\\n ]\\n },\\n \\"ContactFlow\\": {\\n \\"Type\\": \\"0\\",\\n \\"ContactFlowDescription\\": \\"Welcome\\",\\n \\"InstanceId\\": \\"d278629c-c687-4aa3-b044-4fe9b012e7ef\\",\\n \\"ContactFlowName\\": \\"Welcome\\",\\n \\"ContactFlowId\\": \\"2932\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n 54F6A60E-541A-4C3B-8A9D-F69FEA9DD704\\r\\n \\r\\n cc583e96-6bae-437e-9aeb-bffd5aeddb73\\r\\n 1\\r\\n \\r\\n Welcome\\r\\n Welcome\\r\\n 2932\\r\\n 0\\r\\n d278629c-c687-4aa3-b044-4fe9b012e7ef\\r\\n \\r\\n true\\r\\n 02160664656\\r\\n \\r\\n \\r\\n 预测试外呼技能组\\r\\n 3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0\\r\\n \\r\\n \\r\\n d278629c-c687-4aa3-b044-4fe9b012e7ef\\r\\n false\\r\\n Ali Telecom\\r\\n Bidirection\\r\\n 0\\r\\n \\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '修改电话号码相关的属性',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetNumberRegionInfo' => [
'summary' => '调用GetNumberRegionInfo获取号码归属地信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREccc8HB4RI',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => [
'description' => '电话号码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1888888****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumber' => [
'description' => '号码及其归属地',
'type' => 'object',
'properties' => [
'Number' => [
'description' => '号码',
'type' => 'string',
'example' => '1888888****',
],
'City' => [
'description' => '号码归属地市',
'type' => 'string',
'example' => '北京',
],
'Province' => [
'description' => '号码归属地省',
'type' => 'string',
'example' => '北京',
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\",\\n \\"Success\\": true,\\n \\"PhoneNumber\\": {\\n \\"Number\\": \\"1888888****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n2263B273-AC1B-44EB-BA98-87F2322C6780\\n\\n 1888888****\\n 北京\\n 北京\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '获取号码归属地信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetServiceExtensions' => [
'summary' => '调用GetServiceExtensions获取服务号码,。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'description' => '需要获取的服务号码的服务类型,比如满意度调查(SatisfactionSurvey)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'SatisfactionSurvey',
],
],
],
'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' => 'C40E28B8-9EDF-421E-8F6B-B77F0E2A82E0',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'ServiceExtensions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ServiceExtension' => [
'description' => '获取到的服务号码列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Number' => [
'description' => '服务号码',
'type' => 'string',
'example' => '80202768',
],
'Name' => [
'description' => '服务名称',
'type' => 'string',
'example' => 'SatisfactionSurvey',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C40E28B8-9EDF-421E-8F6B-B77F0E2A82E0\\",\\n \\"Success\\": true,\\n \\"ServiceExtensions\\": {\\n \\"ServiceExtension\\": [\\n {\\n \\"Number\\": \\"80202768\\",\\n \\"Name\\": \\"SatisfactionSurvey\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n \\r\\n \\r\\n SatisfactionSurvey\\r\\n 80202768\\r\\n \\r\\n \\r\\n C40E28B8-9EDF-421E-8F6B-B77F0E2A82E0\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '获取服务号码',
'description' => '> 目前只可以获取发送语音满意度时所需的分机号码(实际是满意度调查IVR的路由点,当您开启了语音满意度调研功能后,会自动生成)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListPhoneNumbers' => [
'summary' => '获取呼叫中心实例的所有电话号码。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREccc1MRAID',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待获取电话号码的呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'OutboundOnly',
'in' => 'query',
'schema' => [
'description' => '仅包含外呼电话号码',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'false',
],
],
],
'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' => 'D38E508B-5190-4E1A-AA88-709B0BA547A3',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PhoneNumber' => [
'description' => '获取到的呼叫中心实例的所有电话号码列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TestOnly' => [
'description' => '是否是测试号码。',
'type' => 'boolean',
'example' => 'false',
],
'SipTelX' => [
'description' => 'sip虚拟号码',
'type' => 'string',
'example' => '1970169****',
],
'RemainingTime' => [
'description' => '测试号码剩余的通话时间。单位为分钟。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'City' => [
'description' => '电话号码的城市。',
'type' => 'string',
'example' => '杭州',
],
'InstanceId' => [
'description' => '电话号码所归属的呼叫中心实例ID。',
'type' => 'string',
'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d****',
],
'AllowOutbound' => [
'description' => '是否允许外呼,结果取决于:'."\n"
."\n"
.'- 大于的设置,比如400号码不允许外呼'."\n"
.'- 呼叫中心实例的设置'."\n"
."\n"
.'> 电话号码一般都允许内呼,如果不允许内呼,可以1)由大于做设置,用户拨打该号码时听到提示音 2)该号码不绑定联系流IVR,但是ACC不建议这么做。',
'type' => 'boolean',
'example' => 'true',
],
'Usage' => [
'description' => '电话号码的用途,呼入(Inbound),呼出(Outbound),已经同时用于呼入和呼出(Bidirection)。上述值由枚举类型PhoneNumberType定义。'."\n"
."\n"
.'该值的结果取决于:'."\n"
."\n"
.'- 大于的设置,比如400号码不允许外呼'."\n"
.'- 呼叫中心实例的设置'."\n"
."\n"
.'> 电话号码一般都允许内呼,如果不允许内呼,可以1)由大于做设置,用户拨打该号码时听到提示音 2)该号码不连接人和联系流IVR,但是ACC不建议这么做。',
'type' => 'string',
'example' => 'Bidirection',
],
'Assignee' => [
'description' => '号码占用者,如技能组ID',
'type' => 'string',
'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f****',
],
'PhoneNumberId' => [
'description' => '电话号码ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '0010faaa-0c07-4421-8929-9ea6a051****',
],
'Trunks' => [
'description' => '电话号码的中继数量,即可同时支持几路通话,数据来源于大于。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'Number' => [
'description' => '电话号码。',
'type' => 'string',
'example' => '05712823****',
],
'PhoneNumberDescription' => [
'description' => '电话号码的简单描述。',
'type' => 'string',
'example' => 'Ali Telecom',
],
'NumberCommodityStatus' => [
'description' => '号码商品状态 0 正常 1 欠费 2 实例已删除',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Province' => [
'description' => '电话号码的省份。',
'type' => 'string',
'example' => '浙江',
],
'SkillGroups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillGroup' => [
'description' => '电话号码所关联的技能组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SkillGroupName' => [
'description' => '技能组名称。',
'type' => 'string',
'example' => '预测试外呼技能组',
],
'SkillGroupId' => [
'description' => '技能组ID。',
'type' => 'string',
'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f****',
],
],
],
],
],
],
'ContactFlow' => [
'description' => '电话号码所连接的联系流IVR。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '流程类型, 定义来自于ContactFlowType。',
'type' => 'string',
'example' => '0',
],
'ContactFlowDescription' => [
'description' => '联系流的简单描述。',
'type' => 'string',
'example' => 'Welcome',
],
'InstanceId' => [
'description' => '联系流所归属的呼叫中心实例。',
'type' => 'string',
'example' => 'd278629c-c687-4aa3-b044-4fe9b012****',
],
'ContactFlowName' => [
'description' => '联系流名称,在一个实例内名称不能重复。',
'type' => 'string',
'example' => 'Welcome',
],
'ContactFlowId' => [
'description' => '联系流唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '2932',
],
],
],
'PrivacyNumber' => [
'description' => '电话号码所绑定的虚拟号码关系。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '选择绑定虚拟号码的类型,包括**AXN**和**AXB**。',
'type' => 'string',
'example' => 'AXN',
],
'PoolId' => [
'description' => '虚拟号码所在池子ID。',
'type' => 'string',
'example' => '18b74553-484f-40c7-b6f9-81be0cbe****',
],
'SubId' => [
'description' => '类型为AXN,返回的绑定关系唯一标识,若类型为AXB,则此字段为空。',
'type' => 'string',
'example' => '6a5f6c7c2f774fb38b4aaf35c4e7****',
],
'PhoneNumber' => [
'description' => '绑定的呼叫中心号码。',
'type' => 'string',
'example' => '05712823****',
],
'PoolName' => [
'description' => '虚拟号码池名称。',
'type' => 'string',
'example' => '个人虚拟号码',
],
'BizId' => [
'description' => '第三方业务ID。',
'type' => 'string',
'example' => '4b32b62d3aae4d86a6c4bb26c3ee****',
],
'RegionNameCity' => [
'description' => '虚拟号码归属地市。',
'type' => 'string',
'example' => '上海市',
],
'Extra' => [
'description' => '其他参数,以Json字符串存入。',
'type' => 'string',
'example' => '{"name":"amy","cardno":"1****************9"}',
],
'TelX' => [
'description' => '选择AXN模式绑定的虚拟号码,若类型为AXB,则此字段为空。',
'type' => 'string',
'example' => '1302015****',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"D38E508B-5190-4E1A-AA88-709B0BA547A3\\",\\n \\"Success\\": true,\\n \\"PhoneNumbers\\": {\\n \\"PhoneNumber\\": [\\n {\\n \\"TestOnly\\": false,\\n \\"SipTelX\\": \\"1970169****\\",\\n \\"RemainingTime\\": 60,\\n \\"City\\": \\"杭州\\",\\n \\"InstanceId\\": \\"ade80092-03d9-4f4d-ad4f-ab8a247d****\\",\\n \\"AllowOutbound\\": true,\\n \\"Usage\\": \\"Bidirection\\",\\n \\"Assignee\\": \\"3f3ceb0d-d6b6-4c97-af20-f3daf04f****\\",\\n \\"PhoneNumberId\\": \\"0010faaa-0c07-4421-8929-9ea6a051****\\",\\n \\"Trunks\\": 30,\\n \\"Number\\": \\"05712823****\\",\\n \\"PhoneNumberDescription\\": \\"Ali Telecom\\",\\n \\"NumberCommodityStatus\\": 0,\\n \\"Province\\": \\"浙江\\",\\n \\"SkillGroups\\": {\\n \\"SkillGroup\\": [\\n {\\n \\"SkillGroupName\\": \\"预测试外呼技能组\\",\\n \\"SkillGroupId\\": \\"3f3ceb0d-d6b6-4c97-af20-f3daf04f****\\"\\n }\\n ]\\n },\\n \\"ContactFlow\\": {\\n \\"Type\\": \\"0\\",\\n \\"ContactFlowDescription\\": \\"Welcome\\",\\n \\"InstanceId\\": \\"d278629c-c687-4aa3-b044-4fe9b012****\\",\\n \\"ContactFlowName\\": \\"Welcome\\",\\n \\"ContactFlowId\\": \\"2932\\"\\n },\\n \\"PrivacyNumber\\": {\\n \\"Type\\": \\"AXN\\",\\n \\"PoolId\\": \\"18b74553-484f-40c7-b6f9-81be0cbe****\\",\\n \\"SubId\\": \\"6a5f6c7c2f774fb38b4aaf35c4e7****\\",\\n \\"PhoneNumber\\": \\"05712823****\\",\\n \\"PoolName\\": \\"个人虚拟号码\\",\\n \\"BizId\\": \\"4b32b62d3aae4d86a6c4bb26c3ee****\\",\\n \\"RegionNameCity\\": \\"上海市\\",\\n \\"Extra\\": \\"{\\\\\\"name\\\\\\":\\\\\\"amy\\\\\\",\\\\\\"cardno\\\\\\":\\\\\\"1****************9\\\\\\"}\\",\\n \\"TelX\\": \\"1302015****\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 3f3ceb0d-d6b6-4c97-af20-f3daf04f****\\n Bidirection\\n true\\n false\\n ade80092-03d9-4f4d-ad4f-ab8a247d****\\n 60\\n 杭州\\n 30\\n 0010faaa-0c07-4421-8929-9ea6a051****\\n 浙江\\n Ali Telecom\\n 1970169****\\n 05712823****\\n 0\\n \\n \\n 预测试外呼技能组\\n 3f3ceb0d-d6b6-4c97-af20-f3daf04f****\\n \\n \\n \\n 0\\n d278629c-c687-4aa3-b044-4fe9b012****\\n 2932\\n Welcome\\n Welcome\\n \\n \\n 上海市\\n AXN\\n 6a5f6c7c2f774fb38b4aaf35c4e7****\\n {\\"name\\":\\"amy\\",\\"cardno\\":\\"1****************9\\"}\\n 18b74553-484f-40c7-b6f9-81be0cbe****\\n 个人虚拟号码\\n 05712823****\\n 1302015****\\n 4b32b62d3aae4d86a6c4bb26c3ee****\\n \\n \\n\\n无\\nD38E508B-5190-4E1A-AA88-709B0BA547A3\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '电话列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CheckNumberAvaliable' => [
'summary' => '判断主被叫号码是否可用,主要是限制号码外呼频次。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'Callee',
'in' => 'query',
'schema' => [
'description' => '被叫号码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '18801341234',
],
],
[
'name' => 'Caller',
'in' => 'query',
'schema' => [
'description' => '呼叫中心主叫号码',
'type' => 'string',
'required' => false,
'example' => '01012345678',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码'."\n"
."\n",
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID'."\n"
."\n",
'type' => 'string',
'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3',
],
'Success' => [
'description' => '是否成功'."\n"
."\n",
'type' => 'boolean',
'example' => 'true',
],
'CallerAvaliable' => [
'description' => '主叫号码的相关信息',
'type' => 'object',
'properties' => [
'Avaliable' => [
'description' => '是否可用',
'type' => 'boolean',
'example' => 'true',
],
'Reason' => [
'description' => '如果可用不返回,不可用返回原因,例:"Instance Blacklist: Number 18801341234 can not be called from current instance", "System Blacklist: Number 18801341234 can not be called from all ccc users", "System Blacklist: Number 18801341234 can not be called from current ccc user", "Outbound Control: Number 18801341234\'s call times beyonds limit, 3 times/h"',
'type' => 'string',
'example' => 'Instance Blacklist: Number 18801341234 can not be called from current instance',
],
],
],
'CalleeAvaliable' => [
'description' => '被叫号码相关信息',
'type' => 'object',
'properties' => [
'Avaliable' => [
'description' => '是否可用',
'type' => 'boolean',
'example' => 'true',
],
'Reason' => [
'description' => '如果可用不返回,不可用返回原因,例:"Instance Blacklist: Number 18801341234 can not be called from current instance", "System Blacklist: Number 18801341234 can not be called from all ccc users", "System Blacklist: Number 18801341234 can not be called from current ccc user", "Outbound Control: Number 18801341234\'s call times beyonds limit, 3 times/h"',
'type' => 'string',
'example' => 'Instance Blacklist: Number 18801341234 can not be called from current instance',
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0630E5DF-CEB0-445B-8626-D5C7481181C3\\",\\n \\"Success\\": true,\\n \\"CallerAvaliable\\": {\\n \\"Avaliable\\": true,\\n \\"Reason\\": \\"Instance Blacklist: Number 18801341234 can not be called from current instance\\"\\n },\\n \\"CalleeAvaliable\\": {\\n \\"Avaliable\\": true,\\n \\"Reason\\": \\"Instance Blacklist: Number 18801341234 can not be called from current instance\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0630E5DF-CEB0-445B-8626-D5C7481181C3\\n200\\n\\n true\\n\\nOK\\ntrue\\n\\n true\\n","errorExample":""}]',
'title' => '外呼号码校验',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PickOutboundNumbers' => [
'summary' => '调用接口: PickOutboundNumbers 获取外呼号码。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'CalleeNumber',
'in' => 'query',
'schema' => [
'description' => '被叫号码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '16578787****',
],
],
[
'name' => 'Count',
'in' => 'query',
'schema' => [
'description' => '选中的号码个数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'CandidateNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '候选主叫号码',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => '0108976****',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码'."\n"
."\n",
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息'."\n"
."\n",
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'DialNumberPairs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DialNumberPair' => [
'description' => '通话号码信息集合',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Callee' => [
'description' => '被叫号码信息',
'type' => 'object',
'properties' => [
'Number' => [
'description' => '号码',
'type' => 'string',
'example' => '165787876****',
],
'City' => [
'description' => '城市',
'type' => 'string',
'example' => '北京',
],
'Province' => [
'description' => '省份',
'type' => 'string',
'example' => '北京',
],
],
],
'Caller' => [
'description' => '主叫号码信息',
'type' => 'object',
'properties' => [
'Number' => [
'description' => '号码',
'type' => 'string',
'example' => '01089767****',
],
'City' => [
'description' => '城市',
'type' => 'string',
'example' => '北京',
],
'Province' => [
'description' => '省份',
'type' => 'string',
'example' => '北京',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"Success\\": true,\\n \\"DialNumberPairs\\": {\\n \\"DialNumberPair\\": [\\n {\\n \\"Callee\\": {\\n \\"Number\\": \\"165787876****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n },\\n \\"Caller\\": {\\n \\"Number\\": \\"01089767****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nDE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\t\\n200\\nOK\\ntrue\\n\\n \\n \\n 165787876****\\n 北京\\n 北京\\n \\n \\n 01089767****\\n 北京\\n 北京\\n \\n \\n","errorExample":""}]',
'title' => '获取外呼号码',
'description' => '注意:该接口不推荐使用,可使用接口:[pickGlobalOutboundNumbers](https://help.aliyun.com/document_detail/70126.html?spm=5176.11065259.1996646101.searchclickresult.7afa1a8bz0zkZ2)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RemovePhoneNumber' => [
'summary' => '和该电话号码绑定的IVR流程的关系也将被解绑,号码将无法呼入呼出。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREccc1MRAID',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待移除号码的呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'PhoneNumberId',
'in' => 'query',
'schema' => [
'description' => '待移除电话号码ID',
'type' => 'string',
'required' => true,
'example' => '9fee6c73-bd0c-40e7-a012-4b97368bf235',
],
],
],
'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' => 'C7BB5095-7479-4C48-93A7-483C1350B893',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C7BB5095-7479-4C48-93A7-483C1350B893\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n C7BB5095-7479-4C48-93A7-483C1350B893\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '从实例中移除一个电话号码',
],
'PickGlobalOutboundNumbers' => [
'summary' => '调用PickGlobalOutboundNumbers按照被叫归属地自主选择号码。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'CalleeNumber',
'in' => 'query',
'schema' => [
'description' => '被叫号码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1599090****',
],
],
[
'name' => 'Count',
'in' => 'query',
'schema' => [
'description' => '候选号码个数。可不传,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'IsVirtual',
'in' => 'query',
'schema' => [
'description' => '是否使用虚拟号码外呼',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '坐席绑定的技能组。'."\n"
."\n"
.'如果该参数需要传多个,SkillGroupId.1、SkillGroupId.2、SkillGroupId.3,以此类推。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => '5c412119-9e1c-4304-8484-2b2c8f56f9dc',
'maxItems' => 99,
],
],
],
'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' => '5DA0BD19-066E-426D-B75E-65DF434A1A63',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'DialNumberPairs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DialNumberPair' => [
'description' => '包含主叫号码及其归属地,被叫号码及其归属地',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Callee' => [
'description' => '被叫号码',
'type' => 'object',
'properties' => [
'Number' => [
'description' => '号码',
'type' => 'string',
'example' => '1880134****',
],
'City' => [
'description' => '号码归属地市',
'type' => 'string',
'example' => '北京',
],
'Province' => [
'description' => '号码归属地省',
'type' => 'string',
'example' => '北京',
],
],
],
'Caller' => [
'description' => '主叫号码',
'type' => 'object',
'properties' => [
'Number' => [
'description' => '号码',
'type' => 'string',
'example' => '0592329****',
],
'City' => [
'description' => '号码归属地市',
'type' => 'string',
'example' => '厦门',
],
'Province' => [
'description' => '号码归属地省',
'type' => 'string',
'example' => '福建',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"5DA0BD19-066E-426D-B75E-65DF434A1A63\\",\\n \\"Success\\": true,\\n \\"DialNumberPairs\\": {\\n \\"DialNumberPair\\": [\\n {\\n \\"Callee\\": {\\n \\"Number\\": \\"1880134****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n },\\n \\"Caller\\": {\\n \\"Number\\": \\"0592329****\\",\\n \\"City\\": \\"厦门\\",\\n \\"Province\\": \\"福建\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n5DA0BD19-066E-426D-B75E-65DF434A1A63\\n200\\nOK\\ntrue\\n\\n \\n \\n 1880134****\\n 北京\\n 北京\\n \\n \\n 0592329****\\n 厦门\\n 福建\\n \\n \\n","errorExample":""}]',
'title' => '按照被叫归属地自主选择号码',
'description' => '优先选择本地号码,当坐席外呼时,系统会优先从技能组所绑定的外呼号码中选择与被叫号码相同归属地的号码进行外呼;如果不存在省市完全一样的号码,优先选择同省号码,若仍不存在,则随机选择一个号码。'."\n"
."\n"
.'此功能对于业务开展在多个地区的公司非常适合使用,可以通过将购买号码时提交的企业资质,采用**拓展地区**的方式进行拓展,购买诸多城市的号码做外呼使用。然后将所有号码绑定到相同的技能组中,每次外呼时不需要坐席关系使用哪个号码外呼,该API会智能化的选择最合适的号码进行外呼,大大提高外呼接通率。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PickLocalNumber' => [
'summary' => '根据本地号码优先策略选择号码。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccIPHVDY',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'CalleeNumber',
'in' => 'query',
'schema' => [
'description' => '被叫号码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1657865****',
],
],
[
'name' => 'CandidateNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '候选主叫号码',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => '0108989****',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '号码信息',
'type' => 'object',
'properties' => [
'Callee' => [
'description' => '被叫号码信息',
'type' => 'object',
'properties' => [
'Number' => [
'description' => '号码',
'type' => 'string',
'example' => '1657865****',
],
'City' => [
'description' => '城市',
'type' => 'string',
'example' => '北京',
],
'Province' => [
'description' => '省份',
'type' => 'string',
'example' => '北京',
],
],
],
'Caller' => [
'description' => '主叫号码信息',
'type' => 'object',
'properties' => [
'Number' => [
'description' => '号码',
'type' => 'string',
'example' => '0108989****',
],
'City' => [
'description' => '城市',
'type' => 'string',
'example' => '北京',
],
'Province' => [
'description' => '省份',
'type' => 'string',
'example' => '北京',
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Callee\\": {\\n \\"Number\\": \\"1657865****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n },\\n \\"Caller\\": {\\n \\"Number\\": \\"0108989****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nDE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\t\\n\\n \\n 1657865****\\n 北京\\n 北京\\n \\n \\n 0108989****\\n 北京\\n 北京\\n \\n\\nOK\\ntrue","errorExample":""}]',
'title' => '本地号码优先策略',
'description' => '注意:该接口不推荐使用,可使用接口:[pickGlobalOutboundNumbers](https://help.aliyun.com/document_detail/70126.html?spm=5176.11065259.1996646101.searchclickresult.7afa1a8bz0zkZ2)',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateInstance' => [
'summary' => '调用CreateInstance新增呼叫中心实例。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => [
'FEATUREcccTMAX45',
],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '待创建的呼叫中心实例的名称,账号下唯一。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '云呼测试',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '待创建的呼叫中心实例的简单描述。',
'type' => 'string',
'required' => false,
'example' => '测试',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '待创建的呼叫中心实例的二级域名,全局唯一。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cctest',
],
],
[
'name' => 'StorageMaxDays',
'in' => 'query',
'schema' => [
'description' => '录音文件最多存贮天数。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '30',
],
],
[
'name' => 'StorageMaxSize',
'in' => 'query',
'schema' => [
'description' => '录音文件最多存贮容量,单位GB。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1024',
],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'schema' => [
'description' => '目录服务ID,即阿里云UID。',
'type' => 'string',
'required' => false,
'example' => '1028571882648254',
],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => [
'description' => '呼叫中心对外服务的电话号码。',
'type' => 'string',
'required' => false,
'example' => '010xxxx8557',
],
],
[
'name' => 'AdminRamId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待创建的呼叫中心实例管理员ID列表,如果不指定,则默认指定当前执行创建操作的用户为呼叫中心管理员。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '282075438293882116',
'maxItems' => 99,
],
],
[
'name' => 'PhoneNumbers',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要添加到呼叫中心的号码列表。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '无',
'maxItems' => 99,
],
],
[
'name' => 'UserObject',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '创建呼叫中心的同时创建多个用户。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '无',
'maxItems' => 99,
],
],
],
'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' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Instance' => [
'description' => '呼叫中心实例对象。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '实例状态。',
'type' => 'string',
'example' => 'Creating',
],
'Owner' => [
'description' => '呼叫中心系统规格所对应的阿里云账户ID。',
'type' => 'string',
'example' => '1028571882648254',
],
'StorageMaxDays' => [
'description' => '录音文件最多存贮天数。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'StorageMaxSize' => [
'description' => '录音文件最多存贮容量,单位GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '1024',
],
'MaxOnlineAgents' => [
'description' => '呼叫中心实例的最大同时登陆在线的座席数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'InstanceId' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'example' => 'e3jsl2e7-89wu-4d55-9812-80ysec29ueka',
],
'InstanceDescription' => [
'description' => '实例描述信息。',
'type' => 'string',
'example' => '测试',
],
'DomainName' => [
'description' => '呼叫中心的域名,全局唯一。',
'type' => 'string',
'example' => 'cctest',
],
'ConsoleUrl' => [
'description' => '呼叫中心实例的url地址。',
'type' => 'string',
'example' => 'ccc.aliyun.com/workbench/cctest',
],
'InstanceName' => [
'description' => '实例名称。',
'type' => 'string',
'example' => '云呼测试',
],
'StorageBucket' => [
'description' => '录音文件存贮位置,如果不指定,则存放在一个公共的存贮空间。',
'type' => 'string',
'example' => 'cloudcallcenter-online',
],
'CreatedTime' => [
'description' => '实例创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1607181612000',
],
'DirectoryId' => [
'description' => '目录ID,即阿里云UID。',
'type' => 'string',
'example' => '1028571882648254',
],
'TenantId' => [
'description' => 'CC核心服务对应的租户ID。外表存贮。',
'type' => 'string',
'example' => 'acc2722',
],
'Admin' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'User' => [
'description' => '管理员信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'example' => 'e3jsl2e7-89wu-4d55-9812-80ysec29ueka',
],
'RamId' => [
'description' => 'RamId,即访问控制中的用户ID,或者是阿里云UID。',
'type' => 'string',
'example' => '1028571882648254',
],
'UserId' => [
'description' => '云呼UserId。',
'type' => 'string',
'example' => '9d-487c-96ad-9181d85cf802',
],
'Detail' => [
'description' => '详情。',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '姓名。',
'type' => 'string',
'example' => '测试1',
],
'Email' => [
'description' => '电子邮箱地址。',
'type' => 'string',
'example' => 'xxxx@aliyun-inc.com',
],
'LoginName' => [
'description' => '阿里云登录名',
'type' => 'string',
'example' => 'cctest',
],
'Department' => [
'description' => '部门。',
'type' => 'string',
'example' => 'IT',
],
'Phone' => [
'description' => '联系电话。',
'type' => 'string',
'example' => '131xxxx3215',
],
],
],
],
],
],
],
],
'PhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PhoneNumber' => [
'description' => '号码列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TestOnly' => [
'description' => '是否为测试号码。',
'type' => 'boolean',
'example' => 'false',
],
'Trunks' => [
'description' => '电话号码的中继数量,即可同时支持几路通话,数据来源于大于。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RemainingTime' => [
'description' => '测试号码剩余的通话时间。单位为分钟。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Number' => [
'description' => '号码。',
'type' => 'string',
'example' => '010xxxx8557',
],
'InstanceId' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'example' => 'e3jsl2e7-89wu-4d55-9812-80ysec29ueka',
],
'Usage' => [
'description' => '电话号码的用途。',
'type' => 'string',
'example' => 'Outbound',
],
'AllowOutbound' => [
'description' => '是否可以外呼。',
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumberDescription' => [
'description' => '号码描述信息。',
'type' => 'string',
'example' => '无',
],
'PhoneNumberId' => [
'description' => '号码ID。',
'type' => 'string',
'example' => 'd8beaee2-b6c5-407a-b290-54111wsu6aff',
],
],
],
],
],
],
'SuccessPhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SuccessPhoneNumber' => [
'type' => 'array',
'items' => [
'description' => '导入成功的号码列表。',
'type' => 'string',
'example' => '无',
],
],
],
],
'SuccessLoginNames' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SuccessLoginName' => [
'type' => 'array',
'items' => [
'description' => '导入成功的用户列表。',
'type' => 'string',
'example' => '无',
],
],
],
],
'FailPhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FailPhoneNumber' => [
'type' => 'array',
'items' => [
'description' => '添加失败的电话号码。',
'type' => 'string',
'example' => '无',
],
],
],
],
'FailLoginNames' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FailLoginName' => [
'type' => 'array',
'items' => [
'description' => '添加失败的用户名。',
'type' => 'string',
'example' => '无',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"Success\\": true,\\n \\"Instance\\": {\\n \\"Status\\": \\"Creating\\",\\n \\"Owner\\": \\"1028571882648254\\",\\n \\"StorageMaxDays\\": 30,\\n \\"StorageMaxSize\\": 1024,\\n \\"MaxOnlineAgents\\": 100,\\n \\"InstanceId\\": \\"e3jsl2e7-89wu-4d55-9812-80ysec29ueka\\",\\n \\"InstanceDescription\\": \\"测试\\",\\n \\"DomainName\\": \\"cctest\\",\\n \\"ConsoleUrl\\": \\"ccc.aliyun.com/workbench/cctest\\",\\n \\"InstanceName\\": \\"云呼测试\\",\\n \\"StorageBucket\\": \\"cloudcallcenter-online\\",\\n \\"CreatedTime\\": 1607181612000,\\n \\"DirectoryId\\": \\"1028571882648254\\",\\n \\"TenantId\\": \\"acc2722\\",\\n \\"Admin\\": {\\n \\"User\\": [\\n {\\n \\"InstanceId\\": \\"e3jsl2e7-89wu-4d55-9812-80ysec29ueka\\",\\n \\"RamId\\": \\"1028571882648254\\",\\n \\"UserId\\": \\"9d-487c-96ad-9181d85cf802\\",\\n \\"Detail\\": {\\n \\"DisplayName\\": \\"测试1\\",\\n \\"Email\\": \\"xxxx@aliyun-inc.com\\",\\n \\"LoginName\\": \\"cctest\\",\\n \\"Department\\": \\"IT\\",\\n \\"Phone\\": \\"131xxxx3215\\"\\n }\\n }\\n ]\\n },\\n \\"PhoneNumbers\\": {\\n \\"PhoneNumber\\": [\\n {\\n \\"TestOnly\\": false,\\n \\"Trunks\\": 1,\\n \\"RemainingTime\\": 0,\\n \\"Number\\": \\"010xxxx8557\\",\\n \\"InstanceId\\": \\"e3jsl2e7-89wu-4d55-9812-80ysec29ueka\\",\\n \\"Usage\\": \\"Outbound\\",\\n \\"AllowOutbound\\": true,\\n \\"PhoneNumberDescription\\": \\"无\\",\\n \\"PhoneNumberId\\": \\"d8beaee2-b6c5-407a-b290-54111wsu6aff\\"\\n }\\n ]\\n },\\n \\"SuccessPhoneNumbers\\": {\\n \\"SuccessPhoneNumber\\": [\\n \\"无\\"\\n ]\\n },\\n \\"SuccessLoginNames\\": {\\n \\"SuccessLoginName\\": [\\n \\"无\\"\\n ]\\n },\\n \\"FailPhoneNumbers\\": {\\n \\"FailPhoneNumber\\": [\\n \\"无\\"\\n ]\\n },\\n \\"FailLoginNames\\": {\\n \\"FailLoginName\\": [\\n \\"无\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n2778FA12-EDD6-42AA-9B15-AF855072E5E5\\n\\n Creating\\n \\n \\n Outbound\\n true\\n false\\n 010xxxx8557\\n e3jsl2e7-89wu-4d55-9812-80ysec29ueka\\n 0\\n 1\\n d8beaee2-b6c5-407a-b290-54111wsu6aff\\n 无\\n \\n \\n 1028571882648254\\n 1607181612000\\n \\n 无\\n \\n ccc.aliyun.com/workbench/cctest\\n cctest\\n e3jsl2e7-89wu-4d55-9812-80ysec29ueka\\n 1024\\n \\n \\n 1028571882648254\\n e3jsl2e7-89wu-4d55-9812-80ysec29ueka\\n 9d-487c-96ad-9181d85cf802\\n \\n \\n \\n cctest\\n IT\\n xxxx@aliyun-inc.com\\n 131xxxx3215\\n 测试1\\n \\n \\n \\n \\n 无\\n \\n \\n 无\\n \\n 云呼测试\\n 100\\n acc2722\\n 1028571882648254\\n cloudcallcenter-online\\n \\n 无\\n \\n 30\\n 测试\\n\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '实例创建服务',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateVoiceAppraise' => [
'summary' => '调用CreateVoiceAppraise开通实例的语音满意度。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待获取电话号码的呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
],
[
'name' => 'ContactFlowVersionId',
'in' => 'query',
'schema' => [
'description' => '联系流版本ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'EX9Q_1EATgHX',
],
],
[
'name' => 'Content',
'in' => 'formData',
'schema' => [
'description' => '语音满意度内容。'."\n"
."\n"
.'1. Content中需要注意设置的按键信息与提示音要对应。'."\n"
.'2. 按键信息与url.pressKeyMapping中的mapping中的内容要对应。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '[{"nodeId":1,"nodeDescript":"开始","nextNodeId":2,"nodeType":"start","variables":["varDescript":"","varName":"satisfaction","varType":"string","varInitial":""}]',
],
],
[
'name' => 'IsAppraise',
'in' => 'query',
'schema' => [
'description' => '是否开启语音满意度,默认开启(**true**)。',
'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' => 'B06B3244-1B44-481B-90C4-F2F92E59D6B5',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B06B3244-1B44-481B-90C4-F2F92E59D6B5\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n B06B3244-1B44-481B-90C4-F2F92E59D6B5\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '开通实例的语音满意度',
],
'DeleteInstance' => [
'summary' => '调用DeleteInstance通过呼叫中心实例ID删除该实例。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '需要删除的呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802',
],
],
],
'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' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"无\\n2778FA12-EDD6-42AA-9B15-AF855072E5E5\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '删除实例',
'description' => '**删除后不可恢复,请谨慎操作。**',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetInstance' => [
'summary' => '通过呼叫中心实例ID获取该实例相关信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待获取信息的呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802',
],
],
],
'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' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Instance' => [
'description' => '呼叫中心实例信息',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '实例状态。',
'type' => 'string',
'example' => 'Creating',
],
'Owner' => [
'description' => '实例的拥有者。',
'type' => 'string',
'example' => '1059803544828509',
],
'StorageMaxDays' => [
'description' => '录音文件最多存贮多少天。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'StorageMaxSize' => [
'description' => '录音文件最大存贮容量GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'MaxOnlineAgents' => [
'description' => '呼叫中心实例的最大同时登陆在线的座席数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'InstanceId' => [
'description' => '呼叫中心实例ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802',
],
'InstanceDescription' => [
'description' => '实例描述信息。',
'type' => 'string',
'example' => '测试实例',
],
'DomainName' => [
'description' => '呼叫中心实例的二级域名,全局唯一。',
'type' => 'string',
'example' => '111',
],
'ConsoleUrl' => [
'description' => '呼叫中心控制台URL,由阿里云呼叫中心官方URL加呼叫中心实例的域名组成。',
'type' => 'string',
'example' => 'ccc.aliyun.com/workbench/111',
],
'InstanceName' => [
'description' => '呼叫中心实例的名称。',
'type' => 'string',
'example' => '测试11111',
],
'StorageBucket' => [
'description' => '录音文件存贮位置,如果不指定,则存放在一个公共的存贮空间。',
'type' => 'string',
'example' => 'cloudcallcenter-online',
],
'CreatedTime' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1537867125000',
],
'DirectoryId' => [
'description' => '目录ID,即阿里云UID。',
'type' => 'string',
'example' => '无',
],
'TenantId' => [
'description' => '租户ID。',
'type' => 'string',
'example' => 'acc2985',
],
'Admin' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'User' => [
'description' => '呼叫中心实例管理员列表,是用户列表的子集。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '用户所归属的呼叫中心实例。',
'type' => 'string',
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802',
],
'RamId' => [
'description' => '用户所对应的RAM账户ID。',
'type' => 'string',
'example' => '1059803544828509',
],
'UserId' => [
'description' => '用户ID, 全局唯一。',
'type' => 'string',
'example' => '无',
],
'Detail' => [
'description' => '详细信息。',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '用户的全名。',
'type' => 'string',
'example' => '测试test',
],
'Email' => [
'description' => '用户的电子邮件地址。',
'type' => 'string',
'example' => '123@xx.com',
],
'LoginName' => [
'description' => '用户登陆名。',
'type' => 'string',
'example' => 'cctest',
],
'Department' => [
'description' => '部门。',
'type' => 'string',
'example' => 'IT',
],
'Phone' => [
'description' => '用户的电话号码。',
'type' => 'string',
'example' => '131xxxx1234',
],
],
],
],
],
],
],
],
'PhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PhoneNumber' => [
'description' => '呼叫中心对外服务的电话号码列表。'."\n"
."\n"
.'一个呼叫中心可以有多个电话号码对外服务,但是呼入时所有电话号码都对应同一个IVR流程。比如招商银行分别为位于国内和国外的客户分别提供了400和021的电话号码。默认情况下,每一个号码都可以用于呼入呼出。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TestOnly' => [
'description' => '是否是测试号码。',
'type' => 'boolean',
'example' => 'false',
],
'Trunks' => [
'description' => '电话号码的中继数量,即可同时支持几路通话,数据来源于大于。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RemainingTime' => [
'description' => '测试号码剩余的通话时间。单位为分钟。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Number' => [
'description' => '电话号码。',
'type' => 'string',
'example' => '02500000000',
],
'InstanceId' => [
'description' => '电话号码所归属的呼叫中心实例。',
'type' => 'string',
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802',
],
'Usage' => [
'description' => '电话号码的用途。',
'type' => 'string',
'example' => 'Bidirection',
],
'AllowOutbound' => [
'description' => '是否允许外呼。',
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumberDescription' => [
'description' => '该电话号码的简单描述。',
'type' => 'string',
'example' => 'Ali Telecom',
],
'PhoneNumberId' => [
'description' => '电话号码ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '51349d57-e7a1-4dba-bd16-34d93251207d',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"Success\\": true,\\n \\"Instance\\": {\\n \\"Status\\": \\"Creating\\",\\n \\"Owner\\": \\"1059803544828509\\",\\n \\"StorageMaxDays\\": 0,\\n \\"StorageMaxSize\\": 100,\\n \\"MaxOnlineAgents\\": 100,\\n \\"InstanceId\\": \\"ef1e71e9-ae9d-487c-96ad-9181d85cf802\\",\\n \\"InstanceDescription\\": \\"测试实例\\",\\n \\"DomainName\\": \\"111\\",\\n \\"ConsoleUrl\\": \\"ccc.aliyun.com/workbench/111\\",\\n \\"InstanceName\\": \\"测试11111\\",\\n \\"StorageBucket\\": \\"cloudcallcenter-online\\",\\n \\"CreatedTime\\": 1537867125000,\\n \\"DirectoryId\\": \\"无\\",\\n \\"TenantId\\": \\"acc2985\\",\\n \\"Admin\\": {\\n \\"User\\": [\\n {\\n \\"InstanceId\\": \\"ef1e71e9-ae9d-487c-96ad-9181d85cf802\\",\\n \\"RamId\\": \\"1059803544828509\\",\\n \\"UserId\\": \\"无\\",\\n \\"Detail\\": {\\n \\"DisplayName\\": \\"测试test\\",\\n \\"Email\\": \\"123@xx.com\\",\\n \\"LoginName\\": \\"cctest\\",\\n \\"Department\\": \\"IT\\",\\n \\"Phone\\": \\"131xxxx1234\\"\\n }\\n }\\n ]\\n },\\n \\"PhoneNumbers\\": {\\n \\"PhoneNumber\\": [\\n {\\n \\"TestOnly\\": false,\\n \\"Trunks\\": 1,\\n \\"RemainingTime\\": 0,\\n \\"Number\\": \\"02500000000\\",\\n \\"InstanceId\\": \\"ef1e71e9-ae9d-487c-96ad-9181d85cf802\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"AllowOutbound\\": true,\\n \\"PhoneNumberDescription\\": \\"Ali Telecom\\",\\n \\"PhoneNumberId\\": \\"51349d57-e7a1-4dba-bd16-34d93251207d\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n2778FA12-EDD6-42AA-9B15-AF855072E5E5\\n\\n Creating\\n \\n \\n Bidirection\\n true\\n false\\n 02500000000\\n ef1e71e9-ae9d-487c-96ad-9181d85cf802\\n 0\\n 1\\n 51349d57-e7a1-4dba-bd16-34d93251207d\\n Ali Telecom\\n \\n \\n 1059803544828509\\n 1537867125000\\n ccc.aliyun.com/workbench/111\\n 111\\n ef1e71e9-ae9d-487c-96ad-9181d85cf802\\n 100\\n \\n \\n 1059803544828509\\n ef1e71e9-ae9d-487c-96ad-9181d85cf802\\n 无\\n \\n \\n \\n cctest\\n IT\\n 123@xx.com\\n 131xxxx1234\\n 测试test\\n \\n \\n \\n 测试11111\\n 100\\n acc2985\\n 无\\n cloudcallcenter-online\\n 0\\n 测试实例\\n\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '获取实例信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetInstanceState' => [
'summary' => '获取实例下各个状态的坐席数量。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
],
'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' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'RealTimeInstanceState' => [
'description' => '状态统计。',
'type' => 'object',
'properties' => [
'AgentStateDistributions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AgentStateCount' => [
'description' => '坐席状态分布。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'State' => [
'description' => '状态,注意 “未上线” 状态不会计入统计。',
'type' => 'string',
'example' => 'Ready',
],
'Count' => [
'description' => '数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"Success\\": true,\\n \\"RealTimeInstanceState\\": {\\n \\"AgentStateDistributions\\": {\\n \\"AgentStateCount\\": [\\n {\\n \\"State\\": \\"Ready\\",\\n \\"Count\\": 1\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n9FBA26B0-462B-4D77-B78F-AF35560DBC71\\n200\\nOK\\ntrue\\n\\n \\n \\n Ready\\n 1\\n \\n \\n","errorExample":""}]',
'title' => '获取实例状态统计',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListInstancesOfUser' => [
'summary' => '调用接口:ListInstancesOfUser获取用户所属的呼叫中心实例。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccTMAX45',
],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息'."\n"
."\n",
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID'."\n"
."\n",
'type' => 'string',
'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Instances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CallCenterInstance' => [
'description' => '呼叫中心实例列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '实例状态',
'type' => 'string',
'example' => 'Creating',
],
'Owner' => [
'description' => '呼叫中心系统规格所对应的阿里云账户ID。',
'type' => 'string',
'example' => '105980354482xxxx',
],
'StorageMaxDays' => [
'description' => '录音文件最多存贮多少天。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'StorageMaxSize' => [
'description' => '录音文件最大存贮容量GB。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'MaxOnlineAgents' => [
'description' => '呼叫中心实例最大同时在线座席的数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cxxxx',
],
'InstanceDescription' => [
'description' => '呼叫中心实例描述信息',
'type' => 'string',
'example' => '测试11111',
],
'DomainName' => [
'description' => '呼叫中心实例的二级域名,全局唯一。',
'type' => 'string',
'example' => '111',
],
'ConsoleUrl' => [
'description' => '呼叫中心控制台URL,由阿里云呼叫中心官方URL加呼叫中心实例的域名组成',
'type' => 'string',
'example' => 'ccc.aliyun.com/workbench/111',
],
'InstanceName' => [
'description' => '呼叫中心实例名称',
'type' => 'string',
'example' => '测试11111',
],
'StorageBucket' => [
'description' => '录音文件存贮位置,如果不指定,则存放在一个公共的存贮空间。',
'type' => 'string',
'example' => 'cloudcallcenter-online',
],
'CreatedTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1537867125000',
],
'DirectoryId' => [
'description' => '目录服务提供的目录ID。',
'type' => 'string',
'example' => '无',
],
'TenantId' => [
'description' => 'CC核心服务对应的租户ID。外表存贮。',
'type' => 'string',
'example' => 'accxxxx',
],
'Admin' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'User' => [
'description' => '呼叫中心实例管理员列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '用户所归属的呼叫中心实例。',
'type' => 'string',
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cxxxx',
],
'RamId' => [
'description' => '用户所对应的RAM账户ID。',
'type' => 'string',
'example' => '105980354482xxxx',
],
'UserId' => [
'description' => '用户ID, 系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '9d-487c-96ad-9181d85cxxxx',
],
'Detail' => [
'description' => '用户详细信息',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '用户的全名。',
'type' => 'string',
'example' => '云呼测试',
],
'Email' => [
'description' => '用户的电子邮件地址。',
'type' => 'string',
'example' => '123xxxx@123.com',
],
'LoginName' => [
'description' => '用户登录名。',
'type' => 'string',
'example' => '云呼测试',
],
'Department' => [
'description' => '所属部门。',
'type' => 'string',
'example' => '云呼测试',
],
'Phone' => [
'description' => '用户的电话号码。',
'type' => 'string',
'example' => '1320909xxxx',
],
],
],
],
],
],
],
],
'PhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PhoneNumber' => [
'description' => '呼叫中心对外服务的电话号码列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TestOnly' => [
'description' => '是否是测试号码。',
'type' => 'boolean',
'example' => 'false',
],
'Trunks' => [
'description' => '电话号码的中继数量',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'RemainingTime' => [
'description' => '测试号码剩余的通话时间。单位为分钟。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'Number' => [
'description' => '电话号码。',
'type' => 'string',
'example' => '0250000xxxx',
],
'InstanceId' => [
'description' => '电话号码所归属的呼叫中心实例ID。',
'type' => 'string',
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cxxxx',
],
'Usage' => [
'description' => '电话号码的用途,呼入,呼出,已经同时用于呼入和呼出。 Inbound, Outbound, Bidirection',
'type' => 'string',
'example' => 'Bidirection',
],
'AllowOutbound' => [
'description' => '是否允许外呼',
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumberDescription' => [
'description' => '电话号码的简单描述。',
'type' => 'string',
'example' => 'Ali Telecom',
],
'PhoneNumberId' => [
'description' => '电话号码ID',
'type' => 'string',
'example' => '51349d57-e7a1-4dba-bd16-34d93251207d',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"Success\\": true,\\n \\"Instances\\": {\\n \\"CallCenterInstance\\": [\\n {\\n \\"Status\\": \\"Creating\\",\\n \\"Owner\\": \\"105980354482xxxx\\",\\n \\"StorageMaxDays\\": 0,\\n \\"StorageMaxSize\\": 100,\\n \\"MaxOnlineAgents\\": 100,\\n \\"InstanceId\\": \\"ef1e71e9-ae9d-487c-96ad-9181d85cxxxx\\",\\n \\"InstanceDescription\\": \\"测试11111\\",\\n \\"DomainName\\": \\"111\\",\\n \\"ConsoleUrl\\": \\"ccc.aliyun.com/workbench/111\\",\\n \\"InstanceName\\": \\"测试11111\\",\\n \\"StorageBucket\\": \\"cloudcallcenter-online\\",\\n \\"CreatedTime\\": 1537867125000,\\n \\"DirectoryId\\": \\"无\\",\\n \\"TenantId\\": \\"accxxxx\\",\\n \\"Admin\\": {\\n \\"User\\": [\\n {\\n \\"InstanceId\\": \\"ef1e71e9-ae9d-487c-96ad-9181d85cxxxx\\",\\n \\"RamId\\": \\"105980354482xxxx\\",\\n \\"UserId\\": \\"9d-487c-96ad-9181d85cxxxx\\",\\n \\"Detail\\": {\\n \\"DisplayName\\": \\"云呼测试\\",\\n \\"Email\\": \\"123xxxx@123.com\\",\\n \\"LoginName\\": \\"云呼测试\\",\\n \\"Department\\": \\"云呼测试\\",\\n \\"Phone\\": \\"1320909xxxx\\"\\n }\\n }\\n ]\\n },\\n \\"PhoneNumbers\\": {\\n \\"PhoneNumber\\": [\\n {\\n \\"TestOnly\\": false,\\n \\"Trunks\\": 15,\\n \\"RemainingTime\\": 100,\\n \\"Number\\": \\"0250000xxxx\\",\\n \\"InstanceId\\": \\"ef1e71e9-ae9d-487c-96ad-9181d85cxxxx\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"AllowOutbound\\": true,\\n \\"PhoneNumberDescription\\": \\"Ali Telecom\\",\\n \\"PhoneNumberId\\": \\"51349d57-e7a1-4dba-bd16-34d93251207d\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n Creating\\n 105980354482xxxx\\n 1537867125000\\n ccc.aliyun.com/workbench/111\\n 111\\n ef1e71e9-ae9d-487c-96ad-9181d85cxxxx\\n 100\\n 测试11111\\n 100\\n accxxxx\\n 无\\n cloudcallcenter-online\\n 0\\n 测试11111\\n \\n \\n ef1e71e9-ae9d-487c-96ad-9181d85cxxxx\\n 9d-487c-96ad-9181d85cxxxx\\n 105980354482xxxx\\n \\n 云呼测试\\n 云呼测试\\n 123xxxx@123.com\\n 1320909xxxx\\n 云呼测试\\n \\n \\n \\n \\n \\n Bidirection\\n true\\n false\\n 0250000xxxx\\n ef1e71e9-ae9d-487c-96ad-9181d85cxxxx\\n 100\\n 15\\n 51349d57-e7a1-4dba-bd16-34d93251207d\\n Ali Telecom\\n \\n \\n \\n\\n无\\nDE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '获取用户所属的呼叫中心实例',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DisableTrunkProviders' => [
'summary' => '调用接口:DisableTrunkProviders 注销供应商。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'ProviderName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '线路供应商名称集合。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '联通全国',
'maxItems' => 99,
],
],
],
'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' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'UserPermission',
'errorMessage' => 'User \'%s\' has no permission to \'%s\'',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"无\\nDE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '注销供应商',
'description' => '注意:调用该接口前需要提供阿里云UID给云呼服务支持(13148471489)进行加白操作。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListTrunkProviders' => [
'summary' => '调用接口:ListTrunkProviders 查询指定用户下正在使用的供应商信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码'."\n"
."\n",
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息'."\n"
."\n",
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID'."\n"
."\n",
'type' => 'string',
'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE',
],
'Success' => [
'description' => '是否成功'."\n"
."\n",
'type' => 'boolean',
'example' => 'true',
],
'TrunkProviders' => [
'description' => '供应商列表信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '线路供应商使用状态, 默认enable',
'type' => 'string',
'example' => 'enable',
],
'ProviderName' => [
'description' => '线路供应商名称',
'type' => 'string',
'example' => '联通全国',
],
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'UserPermission',
'errorMessage' => 'User \'%s\' has no permission to \'%s\'',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"Success\\": true,\\n \\"TrunkProviders\\": [\\n {\\n \\"Status\\": \\"enable\\",\\n \\"ProviderName\\": \\"联通全国\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\n200\\n\\n enable\\n 联通全国\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '查询指定用户下正在使用的供应商信息',
'description' => '注意:调用该接口前需要提供阿里云UID给云呼服务支持(13148471489)进行加白操作。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateMedia' => [
'summary' => '调用CreateMedia创建语音。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '待创建的音频文件的名字。',
'type' => 'string',
'required' => true,
'example' => '音频测试',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '待创建的音频文件的描述。',
'type' => 'string',
'required' => false,
'example' => '音频测试',
],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'description' => '待创建的音频文件名称。',
'type' => 'string',
'required' => true,
'example' => 'cc-test.wav',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '语音文件类型 Audio-语音文件 TTS-文本文件。',
'type' => 'string',
'required' => true,
'example' => 'Audio',
],
],
[
'name' => 'Content',
'in' => 'query',
'schema' => [
'description' => '待创建的音频文件的文本内容。',
'type' => 'string',
'required' => false,
'example' => '无',
],
],
[
'name' => 'OssFileName',
'in' => 'query',
'schema' => [
'description' => 'OSS文件名。',
'type' => 'string',
'required' => true,
'example' => '0693df6e-3eaf-48ce-bf69-24103f23a25a.wav',
],
],
[
'name' => 'OssFilePath',
'in' => 'query',
'schema' => [
'description' => 'OSS文件路径。',
'type' => 'string',
'required' => true,
'example' => 'oss://ccc-online/media/7082312b-2a31-47c6-b529-e72b3d6354bd',
],
],
[
'name' => 'UploadResult',
'in' => 'query',
'schema' => [
'description' => '上传结果,Success 或 Fail。',
'type' => 'string',
'required' => true,
'example' => 'Success',
],
],
],
'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' => '8707EB29-BAED-4302-B999-40BA61877437',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'MediaUploadParam' => [
'description' => '上传的文件参数。',
'type' => 'object',
'properties' => [
'Instance' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802',
],
'OssFilePath' => [
'description' => 'OSS文件路径。',
'type' => 'string',
'example' => 'oss://ccc-online/media/7082312b-2a31-47c6-b529-e72b3d6354bd',
],
'FileName' => [
'description' => '文件名。',
'type' => 'string',
'example' => 'cc-test.wav',
],
'Name' => [
'description' => '名称。',
'type' => 'string',
'example' => '音频测试',
],
'Id' => [
'description' => 'ID',
'type' => 'string',
'example' => '53211',
],
'OssFileName' => [
'description' => 'OSS文件名。',
'type' => 'string',
'example' => '0693df6e-3eaf-48ce-bf69-24103f23a25a.wav',
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"Success\\": true,\\n \\"MediaUploadParam\\": {\\n \\"Instance\\": \\"ef1e71e9-ae9d-487c-96ad-9181d85cf802\\",\\n \\"OssFilePath\\": \\"oss://ccc-online/media/7082312b-2a31-47c6-b529-e72b3d6354bd\\",\\n \\"FileName\\": \\"cc-test.wav\\",\\n \\"Name\\": \\"音频测试\\",\\n \\"Id\\": \\"53211\\",\\n \\"OssFileName\\": \\"0693df6e-3eaf-48ce-bf69-24103f23a25a.wav\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n ef1e71e9-ae9d-487c-96ad-9181d85cf802\\n cc-test.wav\\n 0693df6e-3eaf-48ce-bf69-24103f23a25a.wav\\n 53211\\n oss://ccc-online/media/7082312b-2a31-47c6-b529-e72b3d6354bd\\n 音频测试\\n\\n无\\n8707EB29-BAED-4302-B999-40BA61877437\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '创建媒体',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteMedia' => [
'summary' => '调用DeleteMedia删除语音。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '待删除的音频文件的名字。',
'type' => 'string',
'required' => 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' => '8707EB29-BAED-4302-B999-40BA61877437',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"无\\n8707EB29-BAED-4302-B999-40BA61877437\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '删除语音',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListMedias' => [
'summary' => '查询语音列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例。',
'type' => 'string',
'required' => true,
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802',
],
],
[
'name' => 'NamePrefix',
'in' => 'query',
'schema' => [
'description' => '音频文件前缀',
'type' => 'string',
'required' => false,
'example' => '809128080',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码'."\n"
."\n",
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息'."\n"
."\n",
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '8707EB29-BAED-4302-B999-40BA61877437',
],
'Success' => [
'description' => '是否成功'."\n"
."\n",
'type' => 'boolean',
'example' => 'true',
],
'Medias' => [
'description' => '音频文件集合',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int32',
'example' => '29',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Media' => [
'description' => '录音文件集合',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '转码状态',
'type' => 'string',
'example' => 'Success',
],
'Type' => [
'description' => '语音文件类型 Audio-语音文件 TTS-文本文件',
'type' => 'string',
'example' => 'TTS',
],
'FilePath' => [
'description' => '文件路径',
'type' => 'string',
'example' => 'OSS://cloudcall-test',
],
'Instance' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
'Description' => [
'description' => '音频文件的简单描述。',
'type' => 'string',
'example' => '测试音频',
],
'FileName' => [
'description' => '文件名',
'type' => 'string',
'example' => '测试音频',
],
'Name' => [
'description' => '文件名称',
'type' => 'string',
'example' => '001.wav',
],
'Content' => [
'description' => '待通过TTS创建的音频文件的文本内容。',
'type' => 'string',
'example' => '云呼TTS测试',
],
'OssFileName' => [
'description' => 'oss文件',
'type' => 'string',
'example' => '001.wav',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"Success\\": true,\\n \\"Medias\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 29,\\n \\"List\\": {\\n \\"Media\\": [\\n {\\n \\"Status\\": \\"Success\\",\\n \\"Type\\": \\"TTS\\",\\n \\"FilePath\\": \\"OSS://cloudcall-test\\",\\n \\"Instance\\": \\"b0eb2742-f37e-4c67-82d4-25c651c1c450\\",\\n \\"Description\\": \\"测试音频\\",\\n \\"FileName\\": \\"测试音频\\",\\n \\"Name\\": \\"001.wav\\",\\n \\"Content\\": \\"云呼TTS测试\\",\\n \\"OssFileName\\": \\"001.wav\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n8707EB29-BAED-4302-B999-40BA61877437\\n200\\n\\n 29\\n 10\\n 1\\n \\n \\n Success\\n OSS://cloudcall-test\\n TTS\\n 测试音频\\n b0eb2742-f37e-4c67-82d4-25c651c1c450\\n 云呼TTS测试\\n 测试音频\\n 001.wav\\n 001.wav\\n \\n
\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '语音列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetTURNCredentials' => [
'summary' => '调用GetTURNCredentials获取TURN服务所需用户名和密码。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '用户的RamId。或者传“0”(服务端自行获取当前用户的RamId)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Password' => [
'description' => '访问Turn服务用的密码',
'type' => 'string',
'example' => 'SMP4FH/BhK3Ffh+LW4OM+7mv0jQ=',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'D39CD25C-2C52-488B-9D9E-DC61F1F69812',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
'Username' => [
'description' => '访问Turn服务用的用户名',
'type' => 'string',
'example' => '1566545336:1059803544828509',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Password\\": \\"SMP4FH/BhK3Ffh+LW4OM+7mv0jQ=\\",\\n \\"RequestId\\": \\"D39CD25C-2C52-488B-9D9E-DC61F1F69812\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Username\\": \\"1566545336:1059803544828509\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n OK\\r\\n 200\\r\\n SMP4FH/BhK3Ffh+LW4OM+7mv0jQ=\\r\\n D39CD25C-2C52-488B-9D9E-DC61F1F69812\\r\\n true\\r\\n 1566545336:1059803544828509\\r\\n","errorExample":""}]',
'title' => '获取TURN服务所需用户名和密码',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetTURNServerList' => [
'summary' => '调用GetTURNServerList获取TURN服务列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '35783199-DB04-40E8-9FCB-C190008AEFA4',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'xxx',
],
'TurnServerListConfig' => [
'description' => 'Turn服务列表',
'type' => 'string',
'example' => '{"region":"shanghai","name":"上海","domain":"turn3.ccc.aliyuncs.com","cidr":"192.1.25.64/28"}',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"35783199-DB04-40E8-9FCB-C190008AEFA4\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"xxx\\",\\n \\"TurnServerListConfig\\": \\"{\\\\\\"region\\\\\\":\\\\\\"shanghai\\\\\\",\\\\\\"name\\\\\\":\\\\\\"上海\\\\\\",\\\\\\"domain\\\\\\":\\\\\\"turn3.ccc.aliyuncs.com\\\\\\",\\\\\\"cidr\\\\\\":\\\\\\"192.1.25.64/28\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n OK\\r\\n 200\\r\\n 35783199-DB04-40E8-9FCB-C190008AEFA4\\r\\n true\\r\\n \\r\\n hangzhou\\r\\n 杭州\\r\\n turn5.ccc.aliyuncs.com\\r\\n 192.1.25.32/28\\r\\n \\r\\n \\r\\n qingdao\\r\\n 青岛\\r\\n turn4.ccc.aliyuncs.com\\r\\n 192.1.25.48/28\\r\\n \\r\\n \\r\\n shanghai\\r\\n 上海\\r\\n turn3.ccc.aliyuncs.com\\r\\n 192.1.25.64/28\\r\\n \\r\\n","errorExample":""}]',
'title' => '获取TURN服务列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateFault' => [
'summary' => '调用CreateFault上报故障信息,。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => [
'description' => '坐席的RAM ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '293285256197663688',
],
],
[
'name' => 'ConnectId',
'in' => 'query',
'schema' => [
'description' => '通话ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1341443161',
],
],
[
'name' => 'AgentOssFileName',
'in' => 'query',
'schema' => [
'description' => '坐席录音文件名',
'type' => 'string',
'required' => false,
'example' => 'xiaofang',
],
],
[
'name' => 'AgentFilePath',
'in' => 'query',
'schema' => [
'description' => '坐席录音地址',
'type' => 'string',
'required' => false,
'example' => 'xxx',
],
],
[
'name' => 'CustomOssFileName',
'in' => 'query',
'schema' => [
'description' => '客户录音文件名',
'type' => 'string',
'required' => false,
'example' => 'xiaohong',
],
],
[
'name' => 'CustomFilePath',
'in' => 'query',
'schema' => [
'description' => '客户录音文件地址',
'type' => 'string',
'required' => false,
'example' => 'xxx',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '报障信息描述',
'type' => 'string',
'required' => false,
'example' => 'xxx',
],
],
[
'name' => 'ClientIp',
'in' => 'query',
'schema' => [
'description' => '客户端IP',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'ClientPort',
'in' => 'query',
'schema' => [
'description' => '客户端端口',
'type' => 'string',
'required' => false,
'example' => '8000',
],
],
[
'name' => 'OperatingSystemVersion',
'in' => 'query',
'schema' => [
'description' => '操作系统版本',
'type' => 'string',
'required' => false,
'example' => 'windows10',
],
],
[
'name' => 'BrowserVersion',
'in' => 'query',
'schema' => [
'description' => '浏览器版本',
'type' => 'string',
'required' => false,
'example' => '浏览器内核类型:chrome,浏览器版本:74.0.3729.169',
],
],
[
'name' => 'MicrophoneList',
'in' => 'query',
'schema' => [
'description' => '麦克风列表',
'type' => 'string',
'required' => false,
'example' => '[]',
],
],
[
'name' => 'MicrophoneEquipment',
'in' => 'query',
'schema' => [
'description' => '当前麦克风设备',
'type' => 'string',
'required' => false,
'example' => '无',
],
],
[
'name' => 'SpeakerList',
'in' => 'query',
'schema' => [
'description' => '扬声器列表',
'type' => 'string',
'required' => false,
'example' => '[]',
],
],
[
'name' => 'SpeakerEquipment',
'in' => 'query',
'schema' => [
'description' => '当前扬声器设备',
'type' => 'string',
'required' => false,
'example' => '无',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '开始时间',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1558439900000',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '结束时间',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1558443508000',
],
],
[
'name' => 'ServiceIp',
'in' => 'query',
'schema' => [
'description' => '服务端IP',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'ServicePort',
'in' => 'query',
'schema' => [
'description' => '服务端端口号',
'type' => 'string',
'required' => false,
'example' => '8000',
],
],
],
'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' => '87107935-A19D-442B-9D94-267A9A518C8E',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"87107935-A19D-442B-9D94-267A9A518C8E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n 87107935-A19D-442B-9D94-267A9A518C8E\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '上报故障信息',
'description' => '可通过**GetRecordOssUploadParam**获取到上传OSS的参数信息,通过********获取坐席设备信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListCallMeasureSummaryReports' => [
'summary' => '调用ListCallMeasureSummaryReports按月或按天查询呼叫计量数据列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'IntervalType',
'in' => 'query',
'schema' => [
'description' => '按月查询或者按天查询(**Monthly**/**Daily**)',
'type' => 'string',
'required' => true,
'example' => 'Monthly',
'docRequired' => 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' => '184F6B94-18EE-42D9-B628-A9A895E804F3',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'CallMeasureSummaryReportList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CallMeasureSummaryReport' => [
'description' => '报表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Day' => [
'description' => '日期',
'type' => 'string',
'example' => '2',
],
'Year' => [
'description' => '年份',
'type' => 'string',
'example' => '2018',
],
'InboundDurationByMinute' => [
'description' => '呼入通话时长/分钟',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'OutboundCount' => [
'description' => '呼出接通次数',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'OutboundDurationByMinute' => [
'description' => '呼出通话时长/分钟',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'InboundCount' => [
'description' => '呼入接通次数',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Month' => [
'description' => '月份',
'type' => 'string',
'example' => '10',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"184F6B94-18EE-42D9-B628-A9A895E804F3\\",\\n \\"Success\\": true,\\n \\"CallMeasureSummaryReportList\\": {\\n \\"CallMeasureSummaryReport\\": [\\n {\\n \\"Day\\": \\"2\\",\\n \\"Year\\": \\"2018\\",\\n \\"InboundDurationByMinute\\": 0,\\n \\"OutboundCount\\": 0,\\n \\"OutboundDurationByMinute\\": 0,\\n \\"InboundCount\\": 0,\\n \\"Month\\": \\"10\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n \\r\\n 2018\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 1\\r\\n 10\\r\\n \\r\\n \\r\\n 2018\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 2\\r\\n 10\\r\\n \\r\\n \\r\\n 200\\r\\n 184F6B94-18EE-42D9-B628-A9A895E804F3\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '按月或按天查询呼叫计量数据列表',
],
'GetCallMeasureSummaryReport' => [
'summary' => '查询某天或某月各个号码的呼叫计量数据列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'IntervalType',
'in' => 'query',
'schema' => [
'description' => '按月查询或者按天查询(**Monthly** | **Daily**)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Monthly',
],
],
[
'name' => 'Year',
'in' => 'query',
'schema' => [
'description' => '年份',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '2019',
],
],
[
'name' => 'Month',
'in' => 'query',
'schema' => [
'description' => '月份',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '12',
],
],
[
'name' => 'Day',
'in' => 'query',
'schema' => [
'description' => '日期',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号,默认1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小,默认50,最大100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '50',
],
],
],
'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' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SummaryReport' => [
'description' => '当天或当月的汇总报表',
'type' => 'object',
'properties' => [
'Day' => [
'description' => '日期',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'Year' => [
'description' => '年份',
'type' => 'integer',
'format' => 'int32',
'example' => '2018',
],
'InboundDurationByMinute' => [
'description' => '呼入通话时长/分钟',
'type' => 'integer',
'format' => 'int64',
'example' => '47',
],
'OutboundCount' => [
'description' => '呼出接通次数',
'type' => 'integer',
'format' => 'int64',
'example' => '65',
],
'OutboundDurationByMinute' => [
'description' => '呼出通话时长/分钟',
'type' => 'integer',
'format' => 'int64',
'example' => '3390',
],
'InboundCount' => [
'description' => '呼入接通次数',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'Month' => [
'description' => '月份',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
'NumberReports' => [
'description' => '号码计量数据报表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'TotalCount' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'example' => '22',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'NumberReport' => [
'description' => '号码报表列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Day' => [
'description' => '日期',
'type' => 'integer',
'format' => 'int32',
'example' => '31',
],
'Year' => [
'description' => '年份',
'type' => 'integer',
'format' => 'int32',
'example' => '2018',
],
'InboundDurationByMinute' => [
'description' => '呼入通话时长/分钟',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'OutboundCount' => [
'description' => '呼出接通次数',
'type' => 'integer',
'format' => 'int64',
'example' => '18',
],
'OutboundDurationByMinute' => [
'description' => '呼出通话时长/分钟',
'type' => 'integer',
'format' => 'int64',
'example' => '2108',
],
'Number' => [
'description' => '号码',
'type' => 'string',
'example' => '07318888****',
],
'InboundCount' => [
'description' => '呼入接通次数',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Month' => [
'description' => '月份',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA633111\\",\\n \\"Success\\": true,\\n \\"SummaryReport\\": {\\n \\"Day\\": 20,\\n \\"Year\\": 2018,\\n \\"InboundDurationByMinute\\": 47,\\n \\"OutboundCount\\": 65,\\n \\"OutboundDurationByMinute\\": 3390,\\n \\"InboundCount\\": 1,\\n \\"Month\\": 10\\n },\\n \\"NumberReports\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 50,\\n \\"TotalCount\\": 22,\\n \\"List\\": {\\n \\"NumberReport\\": [\\n {\\n \\"Day\\": 31,\\n \\"Year\\": 2018,\\n \\"InboundDurationByMinute\\": 0,\\n \\"OutboundCount\\": 18,\\n \\"OutboundDurationByMinute\\": 2108,\\n \\"Number\\": \\"07318888****\\",\\n \\"InboundCount\\": 0,\\n \\"Month\\": 10\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 22\\n 50\\n 1\\n \\n \\n 0\\n 0\\n 10\\n 2108\\n 2018\\n 07318888****\\n 18\\n 31\\n \\n
\\n\\n\\n 1\\n 47\\n 10\\n 3390\\n 2018\\n 65\\n 20\\n\\n无\\nBF268B34-09C2-43FD-BAC4-5D31EA633111\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '查询号码呼叫计量数据列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetInstanceSummaryReport' => [
'summary' => '实例汇总报表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '起始日期,格式yyyy-MM-dd HH:mm:ss,不得早于6个月前的时间点。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2019-09-09 11:11:11',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '终止日期,格式yyyy-MM-dd HH:mm:ss。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2019-09-09 11:11:11',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
],
'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' => '24BE19E8-BF7D-4992-A35E-15EBA874F2E5',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'InstanceSummaryReport' => [
'description' => '报表',
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
'Overall' => [
'description' => '整体指标',
'type' => 'object',
'properties' => [
'TotalLoggedInTime' => [
'description' => '总登录时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '46914',
],
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '109',
],
'OccupancyRate' => [
'description' => '座席利用率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0.003922070376574993',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '75',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '16',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '9',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '13',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxReadyTime' => [
'description' => '最大就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '21194',
],
'AverageReadyTime' => [
'description' => '平均就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1608',
],
'TotalBreakTime' => [
'description' => '总小休时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TotalReadyTime' => [
'description' => '总就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '46644',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '51',
],
'TotalCalls' => [
'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。',
'type' => 'integer',
'format' => 'int64',
'example' => '8',
],
],
],
'Inbound' => [
'description' => '呼入指标',
'type' => 'object',
'properties' => [
'CallsIncomingLine' => [
'description' => '电话进线量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageRingTime' => [
'description' => '平均振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsHandled' => [
'description' => '电话应答数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsAbandonedInIVR' => [
'description' => 'IVR放弃量,即电话进入IVR流程之后在IVR环节放弃。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWaitTime' => [
'description' => '平均等待时长,平均每通电话的坐席接起时等待时长。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsIncomingQueue' => [
'description' => '技能组进线量,即电话进入技能组量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWaitTime' => [
'description' => '总等待时长,等待时长是指来电进入队列开始算到坐席接起之间的耗时。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalRingTime' => [
'description' => '总振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'string',
'example' => '0',
],
'MaxRingTime' => [
'description' => '最大振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsIncomingIVR' => [
'description' => 'IVR进线量,即电话进入IVR流程。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsOffered' => [
'description' => '电话呼入数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWaitTime' => [
'description' => '最大等待时长,所有坐席接起通话里面最大等待时长。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ServiceLevel20' => [
'description' => '服务水平,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HandleRate' => [
'description' => '应答率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsAbandonedInQueue' => [
'description' => '队列放弃量,即电话进入技能组之后在排队环节放弃。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Outbound' => [
'description' => '呼出指标',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '109',
],
'MaxDialingTime' => [
'description' => '最大拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '22',
],
'CallsDialed' => [
'description' => '电话拨号量。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'CallsAnswered' => [
'description' => '电话接通量。',
'type' => 'integer',
'format' => 'int64',
'example' => '8',
],
'AnswerRate' => [
'description' => '接通率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0.800000011920929',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '75',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '16',
],
'TotalDialingTime' => [
'description' => '总拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '135',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '13',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '9',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '51',
],
'AverageDialingTime' => [
'description' => '平均拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '13',
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"24BE19E8-BF7D-4992-A35E-15EBA874F2E5\\",\\n \\"Success\\": true,\\n \\"InstanceSummaryReport\\": {\\n \\"InstanceId\\": \\"b0eb2742-f37e-4c67-82d4-25c651c1c450\\",\\n \\"Overall\\": {\\n \\"TotalLoggedInTime\\": 46914,\\n \\"TotalTalkTime\\": 109,\\n \\"OccupancyRate\\": 0.003922070376574993,\\n \\"TotalWorkTime\\": 75,\\n \\"MaxWorkTime\\": 16,\\n \\"AverageWorkTime\\": 9,\\n \\"AverageTalkTime\\": 13,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 1,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 21194,\\n \\"AverageReadyTime\\": 1608,\\n \\"TotalBreakTime\\": 1,\\n \\"TotalReadyTime\\": 46644,\\n \\"MaxTalkTime\\": 51,\\n \\"TotalCalls\\": 8\\n },\\n \\"Inbound\\": {\\n \\"CallsIncomingLine\\": 0,\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWaitTime\\": 0,\\n \\"CallsIncomingQueue\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"TotalWaitTime\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": \\"0\\",\\n \\"MaxRingTime\\": 0,\\n \\"CallsIncomingIVR\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"MaxWaitTime\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"CallsAbandonedInQueue\\": 0\\n },\\n \\"Outbound\\": {\\n \\"TotalTalkTime\\": 109,\\n \\"MaxDialingTime\\": 22,\\n \\"CallsDialed\\": 10,\\n \\"CallsAnswered\\": 8,\\n \\"AnswerRate\\": 0.800000011920929,\\n \\"TotalWorkTime\\": 75,\\n \\"MaxWorkTime\\": 16,\\n \\"TotalDialingTime\\": 135,\\n \\"AverageTalkTime\\": 13,\\n \\"AverageWorkTime\\": 9,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 1,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxTalkTime\\": 51,\\n \\"AverageDialingTime\\": 13\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"OK\\n24BE19E8-BF7D-4992-A35E-15EBA874F2E5\\ntrue\\n\\n b0eb2742-f37e-4c67-82d4-25c651c1c450\\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 51\\n 13\\n 75\\n 22\\n 10\\n 13\\n 0\\n 0\\n 135\\n 0.800000011920929\\n 8\\n 109\\n 16\\n 9\\n 1\\n \\n \\n 21194\\n 51\\n 13\\n 75\\n 46914\\n 46644\\n 1\\n 0\\n 0\\n 8\\n 1608\\n 109\\n 16\\n 9\\n 0.003922070376574993\\n 1\\n \\n\\n200","errorExample":""}]',
'title' => '实例汇总报表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetInstanceSummaryReportByInterval' => [
'summary' => '调用GetInstanceSummaryReportByInterval汇总实例分段报表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'description' => '间隔类型。'."\n"
."\n"
.'- Daily:天'."\n"
.'- Minute5:5分钟',
'type' => 'string',
'required' => false,
'example' => 'Daily',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '起始日期,格式yyyy-MM-dd HH:mm:ss,不得早于6个月前的时间点',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2019-09-09 11:11:11',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '终止日期,格式yyyy-MM-dd HH:mm:ss',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2019-09-09 11:11:11',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
],
'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' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'InstanceTimeIntervalReport' => [
'description' => '报表',
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
'IntervalList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InstanceSummaryReport' => [
'description' => '分段报表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
'Timestamp' => [
'description' => '分段统计的开始时间。',
'type' => 'string',
'example' => '2020-11-14 10:45:00',
],
'Overall' => [
'description' => '整体指标。',
'type' => 'object',
'properties' => [
'TotalLoggedInTime' => [
'description' => '总登录时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '49',
],
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '6',
],
'OccupancyRate' => [
'description' => '座席利用率。',
'type' => 'number',
'format' => 'float',
'example' => '0.44897958636283275',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '16',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '16',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '16',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '6',
],
'SatisfactionIndex' => [
'description' => '满意度指数。',
'type' => 'number',
'format' => 'float',
'example' => '1',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'MaxReadyTime' => [
'description' => '最大就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '12',
],
'AverageReadyTime' => [
'description' => '平均就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '6',
],
'TotalBreakTime' => [
'description' => '总小休时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalReadyTime' => [
'description' => '总就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '12',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '6',
],
'TotalCalls' => [
'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
'Inbound' => [
'description' => '呼入指标。',
'type' => 'object',
'properties' => [
'CallsIncomingLine' => [
'description' => '电话进线量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageRingTime' => [
'description' => '平均振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsHandled' => [
'description' => '电话应答数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsAbandonedInIVR' => [
'description' => 'IVR放弃量,即电话进入IVR流程之后在IVR环节放弃。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWaitTime' => [
'description' => '平均等待时长(等待时长=振铃时长+队列等待时长),单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsIncomingQueue' => [
'description' => '技能组进线量,即电话进入技能组量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWaitTime' => [
'description' => '总等待时长(等待时长=振铃时长+队列等待时长),单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalRingTime' => [
'description' => '总振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'string',
'example' => '0',
],
'MaxRingTime' => [
'description' => '最大振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsIncomingIVR' => [
'description' => 'IVR进线量,即电话进入IVR流程。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsOffered' => [
'description' => '电话呼入数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWaitTime' => [
'description' => '最大等待时长(等待时长=振铃时长+队列等待时长),单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ServiceLevel20' => [
'description' => '20s应答率。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HandleRate' => [
'description' => '应答率。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsAbandonedInQueue' => [
'description' => '队列放弃量,即电话进入技能组之后在排队环节放弃。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Outbound' => [
'description' => '呼出指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '6',
],
'MaxDialingTime' => [
'description' => '最大拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '15',
],
'CallsDialed' => [
'description' => '电话拨号量。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'CallsAnswered' => [
'description' => '电话接通量。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'AnswerRate' => [
'description' => '接通率。',
'type' => 'number',
'format' => 'float',
'example' => '1',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '16',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '16',
],
'TotalDialingTime' => [
'description' => '总拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '15',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '6',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '16',
],
'SatisfactionIndex' => [
'description' => '满意度指数。',
'type' => 'number',
'format' => 'float',
'example' => '1',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '6',
],
'AverageDialingTime' => [
'description' => '平均拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '15',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"Success\\": true,\\n \\"InstanceTimeIntervalReport\\": {\\n \\"InstanceId\\": \\"b0eb2742-f37e-4c67-82d4-25c651c1c450\\",\\n \\"IntervalList\\": {\\n \\"InstanceSummaryReport\\": [\\n {\\n \\"InstanceId\\": \\"b0eb2742-f37e-4c67-82d4-25c651c1c450\\",\\n \\"Timestamp\\": \\"2020-11-14 10:45:00\\",\\n \\"Overall\\": {\\n \\"TotalLoggedInTime\\": 49,\\n \\"TotalTalkTime\\": 6,\\n \\"OccupancyRate\\": 0.44897958636283275,\\n \\"TotalWorkTime\\": 16,\\n \\"MaxWorkTime\\": 16,\\n \\"AverageWorkTime\\": 16,\\n \\"AverageTalkTime\\": 6,\\n \\"SatisfactionIndex\\": 1,\\n \\"SatisfactionSurveysOffered\\": 1,\\n \\"SatisfactionSurveysResponded\\": 1,\\n \\"MaxReadyTime\\": 12,\\n \\"AverageReadyTime\\": 6,\\n \\"TotalBreakTime\\": 0,\\n \\"TotalReadyTime\\": 12,\\n \\"MaxTalkTime\\": 6,\\n \\"TotalCalls\\": 1\\n },\\n \\"Inbound\\": {\\n \\"CallsIncomingLine\\": 0,\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWaitTime\\": 0,\\n \\"CallsIncomingQueue\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"TotalWaitTime\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": \\"0\\",\\n \\"MaxRingTime\\": 0,\\n \\"CallsIncomingIVR\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"MaxWaitTime\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"CallsAbandonedInQueue\\": 0\\n },\\n \\"Outbound\\": {\\n \\"TotalTalkTime\\": 6,\\n \\"MaxDialingTime\\": 15,\\n \\"CallsDialed\\": 1,\\n \\"CallsAnswered\\": 1,\\n \\"AnswerRate\\": 1,\\n \\"TotalWorkTime\\": 16,\\n \\"MaxWorkTime\\": 16,\\n \\"TotalDialingTime\\": 15,\\n \\"AverageTalkTime\\": 6,\\n \\"AverageWorkTime\\": 16,\\n \\"SatisfactionIndex\\": 1,\\n \\"SatisfactionSurveysOffered\\": 1,\\n \\"SatisfactionSurveysResponded\\": 1,\\n \\"MaxTalkTime\\": 6,\\n \\"AverageDialingTime\\": 15\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n b0eb2742-f37e-4c67-82d4-25c651c1c450\\n \\n \\n b0eb2742-f37e-4c67-82d4-25c651c1c450\\n 2020-11-14 10:45:00\\n \\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n 0\\n 0\\n \\n 0\\n 0\\n \\n \\n 12\\n 0\\n 1\\n 16\\n 1\\n 1\\n 1\\n 6\\n 6\\n 49\\n 6\\n 16\\n 12\\n 16\\n 6\\n 0.44897958636283275\\n \\n \\n 15\\n 16\\n 1\\n 1\\n 1\\n 15\\n 1\\n 6\\n 1\\n 15\\n 6\\n 16\\n 16\\n 6\\n 1\\n \\n \\n \\n\\n无\\n01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '实例分段汇总报表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetInstanceSummaryReportSinceMidnight' => [
'summary' => '实例当日的汇总报表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
],
'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' => '8707EB29-BAED-4302-B999-40BA61877437',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'InstanceSummaryReport' => [
'description' => '报表',
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx',
],
'Timestamp' => [
'description' => '日期,格式yyyy-MM-dd HH:mm:ss',
'type' => 'string',
'example' => '2018-09-13 00:00:00',
],
'Overall' => [
'description' => '整体指标',
'type' => 'object',
'properties' => [
'TotalLoggedInTime' => [
'description' => '总登录时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'OccupancyRate' => [
'description' => '座席利用率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxReadyTime' => [
'description' => '最大就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageReadyTime' => [
'description' => '平均就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalBreakTime' => [
'description' => '总小休时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalReadyTime' => [
'description' => '总就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalCalls' => [
'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Inbound' => [
'description' => '呼入指标',
'type' => 'object',
'properties' => [
'CallsIncomingLine' => [
'description' => '电话进线量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageRingTime' => [
'description' => '平均振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsHandled' => [
'description' => '电话应答数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsAbandonedInIVR' => [
'description' => 'IVR放弃量,即电话进入IVR流程之后在IVR环节放弃。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWaitTime' => [
'description' => '平均等待时长,平均每通电话的坐席接起时等待时长。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsIncomingQueue' => [
'description' => '技能组进线量,即电话进入技能组量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWaitTime' => [
'description' => '总等待时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalRingTime' => [
'description' => '总振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'string',
'example' => '0',
],
'MaxRingTime' => [
'description' => '最大振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsIncomingIVR' => [
'description' => 'IVR进线量,即电话进入IVR流程。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsOffered' => [
'description' => '电话呼入数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWaitTime' => [
'description' => '最大等待时长,所有坐席接起通话里面最大等待时长。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ServiceLevel20' => [
'description' => '服务水平,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HandleRate' => [
'description' => '应答率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsAbandonedInQueue' => [
'description' => '队列放弃量,即电话进入技能组之后在排队环节放弃。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Outbound' => [
'description' => '呼出指标',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxDialingTime' => [
'description' => '最大拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsDialed' => [
'description' => '电话拨号量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsAnswered' => [
'description' => '电话接通量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AnswerRate' => [
'description' => '接通率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalDialingTime' => [
'description' => '总拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageDialingTime' => [
'description' => '平均拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"Success\\": true,\\n \\"InstanceSummaryReport\\": {\\n \\"InstanceId\\": \\"b0eb2742-f37e-4c67-82d4-25c651c1xxxx\\",\\n \\"Timestamp\\": \\"2018-09-13 00:00:00\\",\\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 \\"CallsIncomingLine\\": 0,\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWaitTime\\": 0,\\n \\"CallsIncomingQueue\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"TotalWaitTime\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": \\"0\\",\\n \\"MaxRingTime\\": 0,\\n \\"CallsIncomingIVR\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"MaxWaitTime\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"CallsAbandonedInQueue\\": 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}","errorExample":""},{"type":"xml","example":"无\\n8707EB29-BAED-4302-B999-40BA61877437\\n200\\n\\n b0eb2742-f37e-4c67-82d4-25c651c1xxxx\\n 2018-09-13 00:00:00\\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n\\nOK\\ntrue","errorExample":""}]',
'title' => '实例当日汇总报表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateUser' => [
'summary' => '创建用户。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => [
'description' => '用户的全名',
'type' => 'string',
'required' => true,
'example' => '张先生',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待创建用户的呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'LoginName',
'in' => 'query',
'schema' => [
'description' => '用户登录名',
'type' => 'string',
'required' => true,
'example' => 'yourUserName',
],
],
[
'name' => 'Phone',
'in' => 'query',
'schema' => [
'description' => '用户电话号码',
'type' => 'string',
'required' => false,
'example' => '1886666****',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '用户电子邮件地址。'."\n"
."\n"
.'新建成功后会发送邮件,邮件中包含呼叫中心登录地址,以及用户名密码。',
'type' => 'string',
'required' => true,
'example' => 'username@example.com',
],
],
[
'name' => 'PrivateOutboundNumberId',
'in' => 'query',
'schema' => [
'description' => '个人外呼号码的PhoneNumberId',
'type' => 'string',
'required' => false,
'example' => 'a08d255e-12a5-48f8-93e0-6b8e1b6d****',
],
],
[
'name' => 'RoleId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定待创建用户的角色,需传入角色ID',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => '4c2e158e-ddd9-464a-a3fc-338eca102***',
'maxItems' => 99,
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定待创建用户绑定的技能组ID。'."\n"
."\n"
.'SkillGroupId.1意为只绑定到一个技能组中,如果绑定多个技能组,则需要传多个,例如 SkillGroupId.1、SkillGroupId.2、SkillGroupId.3,以此类推。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18****',
'maxItems' => 99,
],
],
[
'name' => 'SkillLevel',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待创建用户所加入的技能组对应的技能组等级。'."\n"
."\n\n"
.'SkillLevel.1表示为SkillGroupId.1的技能组等级,如果SkillGroupId为多个,则SkillLevel也需要多个,并且数量需要保持一致,具体请参考下方的请求示例。',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int32',
],
'required' => false,
'example' => '4',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '4A2E1761-8C19-4788-BA76-6C8902A6D5E9',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'UserId' => [
'description' => '新创建的用户信息。'."\n"
."\n\n"
.'> 这里是RAM子账号在呼叫中心实例的唯一标识并非RamId,即UUID。',
'type' => 'string',
'example' => '7ed274a5-6351-4dbd-9f13-6ac63c8e****',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"4A2E1761-8C19-4788-BA76-6C8902A6D5E9\\",\\n \\"Success\\": true,\\n \\"UserId\\": \\"7ed274a5-6351-4dbd-9f13-6ac63c8e****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"无\\n4A2E1761-8C19-4788-BA76-6C8902A6D5E9\\n7ed274a5-6351-4dbd-9f13-6ac63c8e****\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '新增客服',
'description' => '创建用户时指定密码场景:1、调用云呼叫中的CreateUser接口创建用户,然后调用RAM的UpdateLoginProfile接口指定用户密码,注意在调用UpdateLoginProfile接口时,参数PasswordResetRequired>接口指定用户密码,注意在调用UpdateLoginProfile接口时,参数PasswordResetRequired 需要设置为false用来指定首次登录不需要修改密码',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetUserByExtension' => [
'summary' => '根据坐席分机号获取用户信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
],
[
'name' => 'Extension',
'in' => 'query',
'schema' => [
'description' => '坐席分机号。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '8037****',
],
],
],
'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' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'User' => [
'description' => '用户信息。',
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '用户所归属的呼叫中心实例ID。',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
'RamId' => [
'description' => '用户所对应的RAM账户ID。',
'type' => 'string',
'example' => '20225462120879xxxx',
],
'UserId' => [
'description' => '用户ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '6f3e7751-fa61-453f-8057-a2fe9741xxxx',
],
'Roles' => [
'description' => '用户的角色列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '用户所归属的呼叫中心实例ID。',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
'RoleName' => [
'description' => '角色名称。',
'type' => 'string',
'example' => 'ADMIN',
],
'RoleDescription' => [
'description' => '角色描述。',
'type' => 'string',
'example' => '管理员',
],
'RoleId' => [
'description' => '角色ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '59a3d864-2f98-4f5e-84ec-c1ea13afxxxx',
],
],
],
],
'SkillLevels' => [
'description' => '用户所归属的技能组及相应等级,一个用户可以不属于任何技能组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SkillLevelId' => [
'description' => '技能级别唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '181792',
],
'Level' => [
'description' => '技能级别。',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'Skill' => [
'description' => '技能组。',
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '技能组所归属的呼叫中心实例。',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
'SkillGroupDescription' => [
'description' => '技能组简单描述。',
'type' => 'string',
'example' => '描述',
],
'SkillGroupId' => [
'description' => '技能组唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => 'a053e6d5-16ee-4283-9c81-631b78aexxxx',
],
'SkillGroupName' => [
'description' => '技能组名字,需要在所归属的呼叫中心实例中唯一。',
'type' => 'string',
'example' => '默认技能组',
],
],
],
],
],
],
'Detail' => [
'description' => '用户详细信息。',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '用户的姓名。',
'type' => 'string',
'example' => 'test',
],
'Extension' => [
'description' => '坐席分机号。',
'type' => 'string',
'example' => '8037****',
],
'LoginName' => [
'description' => '用户登录名(用户名)。',
'type' => 'string',
'example' => 'test123',
],
'Email' => [
'description' => '用户的电子邮件地址。',
'type' => 'string',
'example' => 'test@alibaba-inc.com',
],
'Department' => [
'description' => '用户的部门。',
'type' => 'string',
'example' => 'IT',
],
'Phone' => [
'description' => '用户的电话号码。',
'type' => 'string',
'example' => '1360176****',
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ParameterFormat',
'errorMessage' => 'The format of parameter \'%s\' is incorrect.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"Success\\": true,\\n \\"User\\": {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"RamId\\": \\"20225462120879xxxx\\",\\n \\"UserId\\": \\"6f3e7751-fa61-453f-8057-a2fe9741xxxx\\",\\n \\"Roles\\": [\\n {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"RoleName\\": \\"ADMIN\\",\\n \\"RoleDescription\\": \\"管理员\\",\\n \\"RoleId\\": \\"59a3d864-2f98-4f5e-84ec-c1ea13afxxxx\\"\\n }\\n ],\\n \\"SkillLevels\\": [\\n {\\n \\"SkillLevelId\\": \\"181792\\",\\n \\"Level\\": 4,\\n \\"Skill\\": {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"SkillGroupDescription\\": \\"描述\\",\\n \\"SkillGroupId\\": \\"a053e6d5-16ee-4283-9c81-631b78aexxxx\\",\\n \\"SkillGroupName\\": \\"默认技能组\\"\\n }\\n }\\n ],\\n \\"Detail\\": {\\n \\"DisplayName\\": \\"test\\",\\n \\"Extension\\": \\"8037****\\",\\n \\"LoginName\\": \\"test123\\",\\n \\"Email\\": \\"test@alibaba-inc.com\\",\\n \\"Department\\": \\"IT\\",\\n \\"Phone\\": \\"1360176****\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n 6f3e7751-fa61-453f-8057-a2fe9741xxxx\\n 20225462120879xxxx\\n \\n 181792\\n 4\\n \\n 默认技能组\\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n a053e6d5-16ee-4283-9c81-631b78aexxxx\\n 描述\\n \\n \\n \\n ADMIN\\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n 管理员\\n 59a3d864-2f98-4f5e-84ec-c1ea13afxxxx\\n \\n \\n 8037****\\n test123\\n IT\\n test@alibaba-inc.com\\n 1360176****\\n test\\n \\n\\n无\\n9FBA26B0-462B-4D77-B78F-AF35560DBC71\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '通过分机号获取客服信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AssignUsers' => [
'summary' => '把目录服务中的一组用户添加到一个呼叫中心实例中。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREccc8HB4RI',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待添加用户的呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'UserRamId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待添加的目录服务中的用户RAM ID',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => '6f3e7751-fa61-453f-8057-a2fe9741a387',
'maxItems' => 99,
],
],
[
'name' => 'RoleId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '新添加用户的角色ID',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '4c2e158e-ddd9-464a-a3fc-338eca10277c',
'maxItems' => 99,
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待创建用户所归属的技能组ID',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18ef28',
'maxItems' => 99,
],
],
[
'name' => 'SkillLevel',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待创建用户所具有的技能级别',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int32',
],
'required' => false,
'example' => '4',
'maxItems' => 99,
],
],
],
'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' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'User' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'type' => 'string',
],
'UserId' => [
'type' => 'string',
],
'RamId' => [
'type' => 'string',
],
'Primary' => [
'type' => 'boolean',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n BA03159C-E808-4FF1-B27E-A61B6E888D7F\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '导入客服',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ResetUserStatus' => [
'summary' => '重置异常状态的坐席。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '云呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
],
[
'name' => 'RamIdList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云呼叫中心子账号的RamId,管理员可重置该实例异常坐席的状态信息,技能组组长可用于重置该技能组下异常坐席的状态信息,可通过[ListUsers](https://help.aliyun.com/document_detail/63052.html?spm=a2c4g.11186623.6.669.60a42ec43cAdOk)接口进行查询获取',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int64',
],
'required' => false,
'example' => '12345678',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => '响应状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应提示信息',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID,可用于接口的日志查询',
'type' => 'string',
'example' => '2D4F3E45-96CD-4210-B15B-F27BAC29FE29',
],
'Success' => [
'description' => '是否调用成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2D4F3E45-96CD-4210-B15B-F27BAC29FE29\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 200\\n 2D4F3E45-96CD-4210-B15B-F27BAC29FE29\\n true\\n OK\\n\\n","errorExample":""}]',
'title' => '重置异常坐席状态',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyUser' => [
'summary' => '调用ModifyUser修改用户数据。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREccc8HB4RI',
],
],
'parameters' => [
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => [
'description' => '用户的全名',
'type' => 'string',
'required' => true,
'example' => '张先生',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '待修改的用户ID。'."\n"
."\n\n"
.'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId,即UUID。',
'type' => 'string',
'required' => true,
'example' => '6f3e7751-fa61-453f-8057-a2fe9741****',
],
],
[
'name' => 'Phone',
'in' => 'query',
'schema' => [
'description' => '用户的电话号码',
'type' => 'string',
'required' => true,
'example' => '1886666****',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '用户的电子邮件',
'type' => 'string',
'required' => true,
'example' => 'username@example.com',
],
],
[
'name' => 'PrivateOutboundNumberId',
'in' => 'query',
'schema' => [
'description' => '个人外呼号码的PhoneNumberId',
'type' => 'string',
'required' => false,
'example' => 'a08d255e-12a5-48f8-93e0-6b8e1b6d****',
],
],
[
'name' => 'RoleId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定待创建用户的角色,需传入角色ID',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => '4c2e158e-ddd9-464a-a3fc-338eca10****',
'maxItems' => 99,
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '指定待创建用户绑定的技能组ID。'."\n"
."\n\n"
.'SkillGroupId.1意为只绑定到一个技能组中,如果绑定多个技能组,则需要传多个,例如 SkillGroupId.1、SkillGroupId.2、SkillGroupId.3,以此类推。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18****',
'maxItems' => 99,
],
],
[
'name' => 'SkillLevel',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待创建用户所加入的技能组对应的技能组等级。'."\n"
."\n"
.'**SkillLevel.1**表示为SkillGroupId.1的技能组等级,如果SkillGroupId为多个,则SkillLevel也需要多个,并且数量需要保持一致。',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int32',
],
'required' => false,
'example' => '4',
'maxItems' => 99,
],
],
],
'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',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n BA03159C-E808-4FF1-B27E-A61B6E888D7F\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '修改用户数据',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetUser' => [
'summary' => '调用GetUser根据用户ID获取用户信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '用户ID。'."\n"
."\n"
.'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId,即UUID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '6f3e7751-fa61-453f-8057-a2fe9741xxxx',
],
],
],
'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' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'User' => [
'description' => '用户信息',
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '用户所归属的呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
'RamId' => [
'description' => '用户所对应的RAM账户ID',
'type' => 'string',
'example' => '20225462120879xxxx',
],
'UserId' => [
'description' => '用户ID,系统自动生成的唯一标示符。'."\n"
."\n"
.'> 注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId,即UUID。',
'type' => 'string',
'example' => '6f3e7751-fa61-453f-8057-a2fe9741xxxx',
],
'Roles' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Role' => [
'description' => '用户的角色列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '角色所归属的呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
'RoleName' => [
'description' => '角色名称',
'type' => 'string',
'example' => 'AGENT',
],
'RoleDescription' => [
'description' => '角色描述',
'type' => 'string',
'example' => '坐席',
],
'RoleId' => [
'description' => '角色ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '4c2e158e-ddd9-464a-a3fc-338eca10xxxx',
],
],
],
],
],
],
'SkillLevels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillLevel' => [
'description' => '用户所归属的技能组及相应等级,一个用户可以不属于任何技能组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SkillLevelId' => [
'description' => '技能级别唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '121335',
],
'Level' => [
'description' => '技能级别',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'Skill' => [
'description' => '技能',
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '技能组所归属的呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
'SkillGroupDescription' => [
'description' => '技能组简单描述',
'type' => 'string',
'example' => '售后技术支持人员使用',
],
'SkillGroupId' => [
'description' => '技能组唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx',
],
'SkillGroupName' => [
'description' => '技能组名字,需要在所归属的呼叫中心实例中唯一。',
'type' => 'string',
'example' => '售后技术支持技能组',
],
],
],
],
],
],
],
],
'Detail' => [
'description' => '用户详细信息。@Transient',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '用户的全名',
'type' => 'string',
'example' => '王明',
],
'Email' => [
'description' => '用户的电子邮件地址',
'type' => 'string',
'example' => '1886666****@163.com',
],
'LoginName' => [
'description' => '用户登录名',
'type' => 'string',
'example' => 'user05',
],
'Department' => [
'description' => '所属部门',
'type' => 'string',
'example' => 'IT',
],
'Phone' => [
'description' => '用户的电话号码',
'type' => 'string',
'example' => '1886666****',
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"Success\\": true,\\n \\"User\\": {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"RamId\\": \\"20225462120879xxxx\\",\\n \\"UserId\\": \\"6f3e7751-fa61-453f-8057-a2fe9741xxxx\\",\\n \\"Roles\\": {\\n \\"Role\\": [\\n {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"RoleName\\": \\"AGENT\\",\\n \\"RoleDescription\\": \\"坐席\\",\\n \\"RoleId\\": \\"4c2e158e-ddd9-464a-a3fc-338eca10xxxx\\"\\n }\\n ]\\n },\\n \\"SkillLevels\\": {\\n \\"SkillLevel\\": [\\n {\\n \\"SkillLevelId\\": \\"121335\\",\\n \\"Level\\": 4,\\n \\"Skill\\": {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"SkillGroupDescription\\": \\"售后技术支持人员使用\\",\\n \\"SkillGroupId\\": \\"0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx\\",\\n \\"SkillGroupName\\": \\"售后技术支持技能组\\"\\n }\\n }\\n ]\\n },\\n \\"Detail\\": {\\n \\"DisplayName\\": \\"王明\\",\\n \\"Email\\": \\"1886666****@163.com\\",\\n \\"LoginName\\": \\"user05\\",\\n \\"Department\\": \\"IT\\",\\n \\"Phone\\": \\"1886666****\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n 6f3e7751-fa61-453f-8057-a2fe9741xxxx\\n 20225462120879xxxx\\n \\n \\n 121335\\n 4\\n \\n 售后技术支持技能组\\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n 0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx\\n 售后技术支持人员使用\\n \\n \\n \\n \\n \\n AGENT\\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n 坐席\\n 4c2e158e-ddd9-464a-a3fc-338eca10xxxx\\n \\n \\n \\n user05\\n IT\\n 1886666****@163.com\\n 1886666****\\n 王明\\n \\n\\n无\\n9FBA26B0-462B-4D77-B78F-AF35560DBC71\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '根据用户ID获取用户信息',
'description' => '需要提供角色,技能组,技能级别,以及按需提供用户详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListUsers' => [
'summary' => '调用ListUsers获取呼叫中心实例中的所有用户。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待获取用户的呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '2',
],
],
],
'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' => '707EF054-E614-4A4A-98D4-F4457073F111',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Users' => [
'description' => '获取到的呼叫中心实例中的用户列表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalCount' => [
'description' => '对象总数',
'type' => 'integer',
'format' => 'int32',
'example' => '14',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'User' => [
'description' => '对象列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PrivateOutboundNumberId' => [
'description' => '个人外呼号码的PhoneNumberId',
'type' => 'string',
'example' => 'a08d255e-12a5-48f8-93e0-6b8e1b6dxxxx',
],
'Primary' => [
'description' => '是否为主账户',
'type' => 'boolean',
'example' => 'false',
],
'InstanceId' => [
'description' => '用户所归属的呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
'RamId' => [
'description' => '用户所对应的RAM子账户ID',
'type' => 'string',
'example' => '29303293146891xxxx',
],
'UserId' => [
'description' => '用户ID,系统自动生成的唯一标示符。'."\n"
."\n\n"
.'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId,即UUID。',
'type' => 'string',
'example' => 'b80bd838-a5a5-4ed3-ac9a-30be353dxxxx',
],
'Roles' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Role' => [
'description' => '用户的角色列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '角色所归属的呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
'RoleName' => [
'description' => '角色名称',
'type' => 'string',
'example' => 'AGENT',
],
'RoleDescription' => [
'description' => '角色描述',
'type' => 'string',
'example' => '坐席',
],
'RoleId' => [
'description' => '角色ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '4c2e158e-ddd9-464a-a3fc-338eca10xxxx',
],
],
],
],
],
],
'SkillLevels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillLevel' => [
'description' => '用户所归属的技能组及相应等级,一个用户可以不属于任何技能组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SkillLevelId' => [
'description' => '技能级别唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '121335',
],
'Level' => [
'description' => '技能级别',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'Skill' => [
'description' => '技能',
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '技能组所归属的呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
'SkillGroupDescription' => [
'description' => '技能组简单描述',
'type' => 'string',
'example' => '售后技术支持人员使用',
],
'SkillGroupId' => [
'description' => '技能组唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx',
],
'SkillGroupName' => [
'description' => '技能组名字,需要在所归属的呼叫中心实例中唯一。',
'type' => 'string',
'example' => '售后技术支持技能组',
],
],
],
],
],
],
],
],
'Detail' => [
'description' => '用户详细信息。',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '用户的全名',
'type' => 'string',
'example' => '王明',
],
'Email' => [
'description' => '用户的电子邮件地址',
'type' => 'string',
'example' => '1886666****@163.com',
],
'LoginName' => [
'description' => '用户登录名',
'type' => 'string',
'example' => 'user05',
],
'Department' => [
'description' => '所属部门',
'type' => 'string',
'example' => 'IT',
],
'Phone' => [
'description' => '用户的电话号码',
'type' => 'string',
'example' => '1886666****',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"707EF054-E614-4A4A-98D4-F4457073F111\\",\\n \\"Success\\": true,\\n \\"Users\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 14,\\n \\"List\\": {\\n \\"User\\": [\\n {\\n \\"PrivateOutboundNumberId\\": \\"a08d255e-12a5-48f8-93e0-6b8e1b6dxxxx\\",\\n \\"Primary\\": false,\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"RamId\\": \\"29303293146891xxxx\\",\\n \\"UserId\\": \\"b80bd838-a5a5-4ed3-ac9a-30be353dxxxx\\",\\n \\"Roles\\": {\\n \\"Role\\": [\\n {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"RoleName\\": \\"AGENT\\",\\n \\"RoleDescription\\": \\"坐席\\",\\n \\"RoleId\\": \\"4c2e158e-ddd9-464a-a3fc-338eca10xxxx\\"\\n }\\n ]\\n },\\n \\"SkillLevels\\": {\\n \\"SkillLevel\\": [\\n {\\n \\"SkillLevelId\\": \\"121335\\",\\n \\"Level\\": 4,\\n \\"Skill\\": {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"SkillGroupDescription\\": \\"售后技术支持人员使用\\",\\n \\"SkillGroupId\\": \\"0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx\\",\\n \\"SkillGroupName\\": \\"售后技术支持技能组\\"\\n }\\n }\\n ]\\n },\\n \\"Detail\\": {\\n \\"DisplayName\\": \\"王明\\",\\n \\"Email\\": \\"1886666****@163.com\\",\\n \\"LoginName\\": \\"user05\\",\\n \\"Department\\": \\"IT\\",\\n \\"Phone\\": \\"1886666****\\"\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n707EF054-E614-4A4A-98D4-F4457073F111\\n200\\n\\n 14\\n 2\\n 1\\n \\n \\n a08d255e-12a5-48f8-93e0-6b8e1b6dxxxx\\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n b80bd838-a5a5-4ed3-ac9a-30be353dxxxx\\n false\\n 29303293146891xxxx\\n \\n \\n 121335\\n 4\\n \\n 售后技术支持技能组\\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n 0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx\\n 售后技术支持人员使用\\n \\n \\n \\n \\n \\n AGENT\\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n 坐席\\n 4c2e158e-ddd9-464a-a3fc-338eca10xxxx\\n \\n \\n \\n user05\\n IT\\n 1886666****@163.com\\n 1886666****\\n 王明\\n \\n \\n
\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '获取呼叫中心实例中的所有用户',
'description' => '需要提供角色,技能组,技能级别,以及按需提供用户详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListRoles' => [
'summary' => '获取的账号所能管理的角色。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待获取角色列表的呼叫中心实例的ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
],
'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' => '711D948F-C616-4E23-8573-0F260513CE09',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Roles' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Role' => [
'description' => '一个呼叫中心实例的所有角色列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '角色所归属的呼叫中心实例',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
'RoleName' => [
'description' => '角色名称',
'type' => 'string',
'example' => 'SKILL_GROUP_ADMIN',
],
'RoleDescription' => [
'description' => '角色描述',
'type' => 'string',
'example' => '技能组组长',
],
'RoleId' => [
'description' => '角色ID,系统自动生成的唯一标示符',
'type' => 'string',
'example' => '42d97cec-386b-4770-ad7b-0e6a4e665c74',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"711D948F-C616-4E23-8573-0F260513CE09\\",\\n \\"Success\\": true,\\n \\"Roles\\": {\\n \\"Role\\": [\\n {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\",\\n \\"RoleName\\": \\"SKILL_GROUP_ADMIN\\",\\n \\"RoleDescription\\": \\"技能组组长\\",\\n \\"RoleId\\": \\"42d97cec-386b-4770-ad7b-0e6a4e665c74\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n 711D948F-C616-4E23-8573-0F260513CE09\\r\\n true\\r\\n OK\\r\\n \\r\\n \\r\\n SKILL_GROUP_ADMIN\\r\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\r\\n 技能组组长\\r\\n 42d97cec-386b-4770-ad7b-0e6a4e665c74\\r\\n \\r\\n \\r\\n AGENT\\r\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\r\\n 坐席\\r\\n 4c2e158e-ddd9-464a-a3fc-338eca10277c\\r\\n \\r\\n \\r\\n ADMIN\\r\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\r\\n 管理员\\r\\n 59a3d864-2f98-4f5e-84ec-c1ea13af93f3\\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '获取账号所能管理的角色',
'description' => '> - 管理员角色调用返回:管理员/技能组组长/坐席'."\n"
.'- 技能组组长角色调用返回:技能组组长/坐席'."\n"
.'- 坐席角色调用返回:坐席',
],
'FindUsers' => [
'summary' => '搜索呼叫中心实例中的所有用户。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREccc8HB4RI',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待获取用户的呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'Criteria',
'in' => 'query',
'schema' => [
'description' => '待查询名称,可以传登录名或者展示名称。',
'type' => 'string',
'required' => true,
'example' => 'test',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '2',
],
],
],
'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' => 'EAF3C248-E123-441B-A545-B6CD02E98EED',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Users' => [
'description' => '获取到的呼叫中心实例中的用户列表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '对象总数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'User' => [
'description' => '对象列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PrivateOutboundNumberId' => [
'description' => '个人外呼号码的PhoneNumberId',
'type' => 'string',
'example' => 'a08d255e-12a5-48f8-93e0-6b8e1b6d****',
],
'InstanceId' => [
'description' => '用户所归属的呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
'RamId' => [
'description' => '用户所对应的RAM账户ID',
'type' => 'string',
'example' => '29491103620126****',
],
'UserId' => [
'description' => '用户唯一标识。'."\n"
."\n\n"
.'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId,即UUID。',
'type' => 'string',
'example' => '674a5953-21d5-4ee9-9b42-eb8813d6****',
],
'Roles' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Role' => [
'description' => '用户的角色列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '角色所归属的呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
'RoleName' => [
'description' => '角色名称',
'type' => 'string',
'example' => 'ADMIN',
],
'RoleDescription' => [
'description' => '角色描述',
'type' => 'string',
'example' => '管理员',
],
'RoleId' => [
'description' => '角色ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '59a3d864-2f98-4f5e-84ec-c1ea13af****',
],
],
],
],
],
],
'SkillLevels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillLevel' => [
'description' => '座席用户在一个技能组的等级,一个座席用户可以属于多个技能组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SkillLevelId' => [
'description' => '技能级别唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '181792',
],
'Level' => [
'description' => '技能级别',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'Skill' => [
'description' => '技能组',
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '技能组所归属的呼叫中心实例',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
'SkillGroupDescription' => [
'description' => '技能组简单描述',
'type' => 'string',
'example' => '描述',
],
'SkillGroupId' => [
'description' => '技能组唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => 'a053e6d5-16ee-4283-9c81-631b78ae****',
],
'SkillGroupName' => [
'description' => '技能组名字,需要在所归属的呼叫中心实例中唯一。',
'type' => 'string',
'example' => '默认技能组',
],
],
],
],
],
],
],
],
'Detail' => [
'description' => '用户详细信息',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '用户的全名',
'type' => 'string',
'example' => 'test',
],
'Email' => [
'description' => '用户的电子邮件地址',
'type' => 'string',
'example' => 'test@alibaba-inc.com',
],
'LoginName' => [
'description' => '用户登录名',
'type' => 'string',
'example' => 'test123',
],
'Department' => [
'description' => '用户的部门',
'type' => 'string',
'example' => 'IT',
],
'Phone' => [
'description' => '用户的电话号码',
'type' => 'string',
'example' => '1360176****',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EAF3C248-E123-441B-A545-B6CD02E98EED\\",\\n \\"Success\\": true,\\n \\"Users\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": {\\n \\"User\\": [\\n {\\n \\"PrivateOutboundNumberId\\": \\"a08d255e-12a5-48f8-93e0-6b8e1b6d****\\",\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3****\\",\\n \\"RamId\\": \\"29491103620126****\\",\\n \\"UserId\\": \\"674a5953-21d5-4ee9-9b42-eb8813d6****\\",\\n \\"Roles\\": {\\n \\"Role\\": [\\n {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3****\\",\\n \\"RoleName\\": \\"ADMIN\\",\\n \\"RoleDescription\\": \\"管理员\\",\\n \\"RoleId\\": \\"59a3d864-2f98-4f5e-84ec-c1ea13af****\\"\\n }\\n ]\\n },\\n \\"SkillLevels\\": {\\n \\"SkillLevel\\": [\\n {\\n \\"SkillLevelId\\": \\"181792\\",\\n \\"Level\\": 4,\\n \\"Skill\\": {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3****\\",\\n \\"SkillGroupDescription\\": \\"描述\\",\\n \\"SkillGroupId\\": \\"a053e6d5-16ee-4283-9c81-631b78ae****\\",\\n \\"SkillGroupName\\": \\"默认技能组\\"\\n }\\n }\\n ]\\n },\\n \\"Detail\\": {\\n \\"DisplayName\\": \\"test\\",\\n \\"Email\\": \\"test@alibaba-inc.com\\",\\n \\"LoginName\\": \\"test123\\",\\n \\"Department\\": \\"IT\\",\\n \\"Phone\\": \\"1360176****\\"\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nEAF3C248-E123-441B-A545-B6CD02E98EED\\n200\\n\\n 1\\n 10\\n 1\\n \\n \\n a08d255e-12a5-48f8-93e0-6b8e1b6d****\\n 9cfad875-6260-4a53-ab6e-b13e3fb3****\\n 674a5953-21d5-4ee9-9b42-eb8813d6****\\n 29491103620126****\\n \\n \\n 181792\\n 4\\n \\n 默认技能组\\n 9cfad875-6260-4a53-ab6e-b13e3fb3****\\n a053e6d5-16ee-4283-9c81-631b78ae****\\n 描述\\n \\n \\n \\n \\n \\n ADMIN\\n 9cfad875-6260-4a53-ab6e-b13e3fb3****\\n 管理员\\n 59a3d864-2f98-4f5e-84ec-c1ea13af****\\n \\n \\n \\n test123\\n IT\\n test@alibaba-inc.com\\n 1360176****\\n test\\n \\n \\n
\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '搜索用户列表',
'description' => '需要提供角色,技能组,技能级别,以及按需提供用户详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RemoveUsers' => [
'summary' => '调用RemoveUsers从一个呼叫中心实例中移除一组用户。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREccc8HB4RI',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待移除用户的呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'UserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待移除的呼叫中心实例中的用户ID。'."\n"
."\n\n"
.'**UserId.1**意为只移除一个坐席,如果移除多个,则需要传多个,例如 UserId.1、UserId.2、UserId.3,以此类推,具体请参考下方的请求示例。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => '7ed274a5-6351-4dbd-9f13-6ac63c8ef296',
'maxItems' => 99,
],
],
],
'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' => '1F9834D8-6D09-4A1B-BADB-B019D9D444D8',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"1F9834D8-6D09-4A1B-BADB-B019D9D444D8\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n 1F9834D8-6D09-4A1B-BADB-B019D9D444D8\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '从一个呼叫中心实例中移除一组用户',
],
'AddAgentDevice' => [
'summary' => '当坐席上线时,保存坐席设备的基本信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREccc8HB4RI',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'ClientIp',
'in' => 'query',
'schema' => [
'description' => '客户端IP地址',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '127.0.0.1',
],
],
[
'name' => 'ClientPort',
'in' => 'query',
'schema' => [
'description' => '客户端IP端口',
'type' => 'string',
'required' => false,
'example' => '8080',
],
],
[
'name' => 'BrowserVersion',
'in' => 'formData',
'schema' => [
'description' => '浏览器版本信息',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Chrome/74.0.3729.169',
],
],
[
'name' => 'Remark',
'in' => 'formData',
'schema' => [
'description' => '其他备注信息',
'type' => 'string',
'required' => false,
'example' => '备注',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'AgentDeviceId' => [
'description' => '保存数据的ID。'."\n"
."\n"
.'用于给ModifyAgentDevice提供数据来记录登录是否成功。',
'type' => 'integer',
'format' => 'int64',
'example' => '456',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'A13BB835-94AA-4E55-8D9E-5EA585CE6555"',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"AgentDeviceId\\": 456,\\n \\"RequestId\\": \\"A13BB835-94AA-4E55-8D9E-5EA585CE6555\\\\\\"\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 456\\r\\n 200\\r\\n A13BB835-94AA-4E55-8D9E-5EA585CE6555\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '保存坐席设备信息',
'description' => '可与**ModifyAgentDevice**接口连用来保存更新坐席设备的相关信息。一般为定位双登(坐席账号在多个电脑设备或者浏览器登录)或者网络问题引起的掉线等情况提供参考数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyAgentDevice' => [
'summary' => '当坐席上线成功时,更新坐席设备中的坐席的登录状态。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'IsLogin',
'in' => 'query',
'schema' => [
'description' => '是否签入成功。取值:'."\n"
."\n"
.'- 0(默认):签入失败'."\n"
.'- 1:签入成功',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'AgentDeviceId',
'in' => 'query',
'schema' => [
'description' => '坐席设备唯一标识',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'docRequired' => true,
'example' => '456',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
],
'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' => 'A13BB835-94AA-4E55-8D9E-5EA585CEA98D',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"A13BB835-94AA-4E55-8D9E-5EA585CEA98D\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n A13BB835-94AA-4E55-8D9E-5EA585CEA98D\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '更新坐席登录状态',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListRealTimeAgent' => [
'summary' => '获取呼叫中心实例中的所有可转接的坐席,其中可转接是指坐席处于空闲状态或者坐席存有个人手机号。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待获取用户的呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
],
'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' => '51DE4272-1711-4FF3-805F-7FBD2251AA0D',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'User' => [
'description' => '获取到的呼叫中心实例中的用户列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '坐席展示名',
'type' => 'string',
'example' => '模板导入坐席',
],
'StateDesc' => [
'description' => '坐席状态描述',
'type' => 'string',
'example' => '未上线',
],
'Dn' => [
'description' => '坐席分机号',
'type' => 'string',
'example' => '8031****',
],
'State' => [
'description' => '坐席状态',
'type' => 'string',
'example' => '3',
],
'RamId' => [
'description' => '坐席RAM子账号',
'type' => 'string',
'example' => '21577102482268****',
],
'Phone' => [
'description' => '坐席手机号',
'type' => 'string',
'example' => '1880134****',
],
'SkillLevels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillLevel' => [
'description' => '用户所归属的技能组及相应等级,一个用户可以不属于任何技能组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SkillLevelId' => [
'description' => '技能级别唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '101271',
],
'Level' => [
'description' => '技能级别',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'Skill' => [
'description' => '技能',
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '技能组所归属的呼叫中心实例。',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
'SkillGroupDescription' => [
'description' => '技能组简单描述。',
'type' => 'string',
'example' => '默认技能组',
],
'SkillGroupId' => [
'description' => '技能组唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '0ee27b3b-6765-499a-a741-61b16a90****',
],
'SkillGroupName' => [
'description' => '技能组名字,需要在所归属的呼叫中心实例中唯一。',
'type' => 'string',
'example' => 'Default',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"51DE4272-1711-4FF3-805F-7FBD2251AA0D\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"User\\": [\\n {\\n \\"DisplayName\\": \\"模板导入坐席\\",\\n \\"StateDesc\\": \\"未上线\\",\\n \\"Dn\\": \\"8031****\\",\\n \\"State\\": \\"3\\",\\n \\"RamId\\": \\"21577102482268****\\",\\n \\"Phone\\": \\"1880134****\\",\\n \\"SkillLevels\\": {\\n \\"SkillLevel\\": [\\n {\\n \\"SkillLevelId\\": \\"101271\\",\\n \\"Level\\": 5,\\n \\"Skill\\": {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3****\\",\\n \\"SkillGroupDescription\\": \\"默认技能组\\",\\n \\"SkillGroupId\\": \\"0ee27b3b-6765-499a-a741-61b16a90****\\",\\n \\"SkillGroupName\\": \\"Default\\"\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n51DE4272-1711-4FF3-805F-7FBD2251AA0D\\n200\\n\\n \\n 未上线\\n 3\\n 1880134****\\n 模板导入坐席\\n 21577102482268****\\n 8031****\\n \\n \\n 101271\\n 5\\n \\n Default\\n 9cfad875-6260-4a53-ab6e-b13e3fb3****\\n 0ee27b3b-6765-499a-a741-61b16a90****\\n 默认技能组\\n \\n \\n \\n \\n\\nOK\\ntrue","errorExample":""}]',
'title' => '获取实例中所有可转接坐席',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListAgentStateLogs' => [
'summary' => '获取呼叫中心实例中坐席的状态日志。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待获取用户的呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
],
[
'name' => 'RamId',
'in' => 'query',
'schema' => [
'description' => '坐席的RAM ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '233600862826937630',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '开始时间。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1607911199000',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '结束时间,注意查询时间范围不能大于2小时,否则会报错。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1607918399000',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
],
'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' => 'EAF3C248-E123-441B-A545-B6CD02E98EED',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'AgentStateLogPage' => [
'description' => '坐席状态日志列表。',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '对象总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'description' => '对象列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StateCode' => [
'description' => '坐席子状态。',
'type' => 'string',
'example' => 'StartMonitoring',
],
'ContactId' => [
'description' => '通话ID。',
'type' => 'string',
'example' => '2952482622',
],
'State' => [
'description' => '坐席状态。',
'type' => 'string',
'example' => 'Talking',
],
'ConnectId' => [
'description' => '话务ID。',
'type' => 'string',
'example' => '2952482621',
],
'StateTime' => [
'description' => '状态对应的时刻。',
'type' => 'integer',
'format' => 'int64',
'example' => '1607911119000',
],
'InstanceId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
'RamId' => [
'description' => '坐席的RamId。',
'type' => 'integer',
'format' => 'int64',
'example' => '233600862826937630',
],
'SkillGroupIds' => [
'description' => '坐席所在的技能组列表。',
'type' => 'string',
'example' => 'f762fa1d-d8cb-4d4c-aa0a-b3e0c1f05347,b09c567c-9d74-43e6-9106-86e1bf2da52b',
],
'CounterParty' => [
'description' => '对端:所监听对象的RamId。非监听场景或被监听者不展示此字段。',
'type' => 'string',
'example' => '135600862836930633',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EAF3C248-E123-441B-A545-B6CD02E98EED\\",\\n \\"Success\\": true,\\n \\"AgentStateLogPage\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"StateCode\\": \\"StartMonitoring\\",\\n \\"ContactId\\": \\"2952482622\\",\\n \\"State\\": \\"Talking\\",\\n \\"ConnectId\\": \\"2952482621\\",\\n \\"StateTime\\": 1607911119000,\\n \\"InstanceId\\": \\"d278629c-c687-4aa3-b044-4fe9b012e7ef\\",\\n \\"RamId\\": 233600862826937630,\\n \\"SkillGroupIds\\": \\"f762fa1d-d8cb-4d4c-aa0a-b3e0c1f05347,b09c567c-9d74-43e6-9106-86e1bf2da52b\\",\\n \\"CounterParty\\": \\"135600862836930633\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nEAF3C248-E123-441B-A545-B6CD02E98EED\\n200\\nOK\\ntrue\\n\\n 1\\n 10\\n 1\\n \\n 135600862836930633\\n f762fa1d-d8cb-4d4c-aa0a-b3e0c1f05347,b09c567c-9d74-43e6-9106-86e1bf2da52b\\n 1607911119000\\n d278629c-c687-4aa3-b044-4fe9b012e7ef\\n Talking\\n StartMonitoring\\n 233600862826937630\\n 2952482621\\n 2952482622\\n
\\n","errorExample":""}]',
'title' => '查询坐席状态日志',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListAgentStates' => [
'summary' => '调用ListAgentStates获取坐席状态。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => [
'description' => '技能组ID',
'type' => 'string',
'required' => false,
'example' => 'XXX',
],
],
[
'name' => 'AgentIds',
'in' => 'query',
'schema' => [
'description' => '坐席ID列表。'."\n"
."\n"
.'坐席ID等同于该座席的RAM子账户ID,最多50个坐席;不传则查询全部。',
'type' => 'string',
'required' => false,
'example' => '237432034227828673',
],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'description' => '坐席状态列表。'."\n"
."\n"
.'不传查询全部。枚举值:ACW:话后处理中,Break:小休,Dialing:拨号,Ringing:振铃,Ready:等待,Talking:通话。',
'type' => 'string',
'required' => false,
'example' => 'ACW',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号,默认值为1',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小,默认值为10,最大是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' => '03C67DAD-EB26-41D8-949D-9B0C470FB716',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '报表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalCount' => [
'description' => '总个数',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RealTimeAgentState' => [
'description' => '坐席报表列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LoginName' => [
'description' => '座席登录名',
'type' => 'string',
'example' => 'paige',
],
'Dn' => [
'description' => '分机号码',
'type' => 'string',
'example' => '80301522',
],
'StateDuration' => [
'description' => '坐席状态持续时长',
'type' => 'string',
'example' => '10',
],
'State' => [
'description' => '座席状态描述,会有以下描述:会议、发起求助、处理、小休、拨号、振铃、求助、等待、通话。',
'type' => 'string',
'example' => 'Ready',
],
'AgentId' => [
'description' => '座席ID,等同于该座席的RAM子账户ID。',
'type' => 'string',
'example' => '237432034227828673',
],
'AgentName' => [
'description' => '座席名称',
'type' => 'string',
'example' => '派鸽',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","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\\": 2,\\n \\"TotalCount\\": 2,\\n \\"List\\": {\\n \\"RealTimeAgentState\\": [\\n {\\n \\"LoginName\\": \\"paige\\",\\n \\"Dn\\": \\"80301522\\",\\n \\"StateDuration\\": \\"10\\",\\n \\"State\\": \\"Ready\\",\\n \\"AgentId\\": \\"237432034227828673\\",\\n \\"AgentName\\": \\"派鸽\\",\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"947B7F2A-BD31-4A0B-9CC0-13F8165C65A7\\n200\\n\\n 3\\n 50\\n 1\\n \\n \\n paige\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\n ACW\\n 80301522\\n 237432034227828673\\n 派鸽\\n \\n \\n banshi1\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\n Ready\\n 80322399\\n 243374734951787536\\n 般石\\n \\n \\n mengzhen1234\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\n Ringing\\n 80325610\\n 273570923499439182\\n 孟珍1234\\n \\n
\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '获取坐席状态',
'description' => '坐席瞬时状态列表,统计的范围是截止调用时间4个小时内的,存在活跃坐席的状态信息。'."\n"
."\n"
.'4 个小时内:是指发起统计的当前时间点,往前推 4 个小时。'."\n"
.'活跃坐席:是指在上述时间范围内,状态发生变化的坐席。坐席状态变化包括签入、签出、小休、外呼等。仅登录坐席工作台,而没有签入的情况,不属于活跃坐席。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListAgentSummaryReports' => [
'summary' => '查询坐席指标的某个时间范围汇总报表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => [
'description' => '技能组ID',
'type' => 'string',
'required' => false,
'example' => 'fb654c6-17c6-4501-ba57-f5ddeb919814',
],
],
[
'name' => 'AgentIds',
'in' => 'query',
'schema' => [
'description' => '坐席ID列表(使用“,”隔开),坐席ID等同于该座席的RAM子账户ID,最多50个坐席;不传查询全部。',
'type' => 'string',
'required' => false,
'example' => '2769707711429472695',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '起始日期,格式yyyy-MM-dd HH:mm:ss;需要注意目前仅支持按天维度的查询,参数设置请参考案例。同时时间设置不得早于6个月前的时间点',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2018-08-01 00:00:00',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '终止日期,格式:yyyy-MM-dd HH:mm:ss;需要注意目前仅支持按天维度的查询,参数设置请参考案例。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2018-08-07 00:00:00',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号,默认值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小,默认值为10,最大是100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
],
'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' => '685904F9-C253-49EF-8255-384888B794D2',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'PagedAgentSummaryReport' => [
'description' => '报表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalCount' => [
'description' => '总个数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AgentSummaryReport' => [
'description' => '坐席报表列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LoginName' => [
'description' => '座席登录名',
'type' => 'string',
'example' => 'weichao',
],
'AgentId' => [
'description' => '座席ID,等同于该座席的RAM子账户ID。',
'type' => 'string',
'example' => '2769707711429472695',
],
'AgentName' => [
'description' => '座席显示名称',
'type' => 'string',
'example' => '默默',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
'SkillGroupNames' => [
'description' => '技能组名称',
'type' => 'string',
'example' => '其他服务',
],
'SkillGroupIds' => [
'description' => '技能组ID列表',
'type' => 'string',
'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814',
],
'Overall' => [
'description' => '整体指标',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalLoggedInTime' => [
'description' => '总登录时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'OccupancyRate' => [
'description' => '座席利用率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'LastLogOutTime' => [
'description' => '最后登出时间',
'type' => 'string',
'example' => '2018-08-04 18:00:00',
],
'FirstLogInTime' => [
'description' => '首次登录时间',
'type' => 'string',
'example' => '2018-08-04 09:00:00',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageReadyTime' => [
'description' => '平均就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxReadyTime' => [
'description' => '最大就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'OneTransferCalls' => [
'description' => '总转接量,即坐席发起直接转接的次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalReadyTime' => [
'description' => '总就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalBreakTime' => [
'description' => '总小休时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalCalls' => [
'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Inbound' => [
'description' => '呼入指标',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsOffered' => [
'description' => '电话呼入数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageRingTime' => [
'description' => '平均振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsHandled' => [
'description' => '电话应答数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ServiceLevel20' => [
'description' => '服务水平,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HandleRate' => [
'description' => '应答率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalRingTime' => [
'description' => '总振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxRingTime' => [
'description' => '最大振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Outbound' => [
'description' => '呼出指标',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxDialingTime' => [
'description' => '最大拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsDialed' => [
'description' => '电话拨号量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsAnswered' => [
'description' => '电话接通量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AnswerRate' => [
'description' => '接通率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。总话后处理时长,单位秒。',
'type' => 'string',
'example' => '0',
],
'TotalDialingTime' => [
'description' => '总拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageDialingTime' => [
'description' => '平均拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"685904F9-C253-49EF-8255-384888B794D2\\",\\n \\"Success\\": true,\\n \\"PagedAgentSummaryReport\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 1,\\n \\"List\\": {\\n \\"AgentSummaryReport\\": [\\n {\\n \\"LoginName\\": \\"weichao\\",\\n \\"AgentId\\": \\"2769707711429472695\\",\\n \\"AgentName\\": \\"默默\\",\\n \\"InstanceId\\": \\"b0eb2742-f37e-4c67-82d4-25c651c1c450\\",\\n \\"SkillGroupNames\\": \\"其他服务\\",\\n \\"SkillGroupIds\\": \\"8fb654c6-17c6-4501-ba57-f5ddeb919814\\",\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"LastLogOutTime\\": \\"2018-08-04 18:00:00\\",\\n \\"FirstLogInTime\\": \\"2018-08-04 09:00:00\\",\\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\\": 0,\\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 }\\n}","errorExample":""},{"type":"xml","example":"OK\\n\\n 1\\n 10\\n 1\\n \\n 2769707711429472695\\n b0eb2742-f37e-4c67-82d4-25c651c1c450\\n 其他服务\\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 11\\n 5\\n 15\\n 14\\n 3\\n 11\\n 0\\n 0\\n 34\\n 1\\n 3\\n 15\\n 10\\n 5\\n 0\\n \\n 8fb654c6-17c6-4501-ba57-f5ddeb919814\\n weichao\\n \\n 3282\\n 11\\n 5\\n 15\\n 3648\\n 3583\\n 1\\n 0\\n 0\\n 3\\n 716\\n 15\\n 10\\n 5\\n 0.008223684504628181\\n 0\\n 0\\n \\n 默默\\n
\\n\\n685904F9-C253-49EF-8255-384888B794D2\\ntrue\\n200","errorExample":""}]',
'title' => '坐席汇总报表',
'description' => '比如`2018-08-01 00:00:00 ~ 2018-08-07 00:00:00`范围的坐席指标汇总报表,电话呼入数是发生在这个时间范围的总和、最大通话时长是这个时间范围的最长一次通话时长。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListAgentSummaryReportsByInterval' => [
'summary' => '调用ListAgentSummaryReportsByInterval查询坐席指标的分段汇总报表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => [
'description' => '技能组ID',
'type' => 'string',
'required' => false,
'example' => '8fb654c6-17c6-4501-ba57-f5ddeb91xxxx',
],
],
[
'name' => 'AgentIds',
'in' => 'query',
'schema' => [
'description' => '坐席ID列表(使用“,”隔开),坐席ID等同于该座席的RAM子账户ID,最多50个坐席;不传查询全部。',
'type' => 'string',
'required' => false,
'example' => '276970771142947xxxx',
],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'description' => '间隔类型。'."\n"
.'- Daily:天'."\n"
.'- Minute5:5分钟',
'type' => 'string',
'required' => false,
'example' => 'Daily',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '起始日期,格式yyyy-MM-dd HH:mm:ss,不得早于6个月前的时间点',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2018-09-12 14:45:00',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '终止日期,格式yyyy-MM-dd HH:mm:ss',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2018-09-12 14:45:00',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号,默认值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小,默认值为10,最大是100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
],
'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' => 'DCF128C7-3817-4409-8557-15A0C49DA1B8',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'PagedAgentSummaryReport' => [
'description' => '报表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总个数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AgentTimeIntervalReport' => [
'description' => '坐席报表列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AgentId' => [
'description' => '坐席ID',
'type' => 'string',
'example' => '276970771142947xxxx',
],
'IntervalList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AgentSummaryReport' => [
'description' => '各个时间段的坐席报表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LoginName' => [
'description' => '座席登录名',
'type' => 'string',
'example' => 'weichao',
],
'AgentId' => [
'description' => '座席ID,等同于该座席的RAM子账户ID。',
'type' => 'string',
'example' => '276970771142947xxxx',
],
'AgentName' => [
'description' => '座席显示名称',
'type' => 'string',
'example' => '默默',
],
'SkillGroupNames' => [
'description' => '技能组名称',
'type' => 'string',
'example' => '其他服务',
],
'Timestamp' => [
'description' => '日期,格式yyyy-MM-dd HH:mm:ss',
'type' => 'string',
'example' => '2018-09-12 14:45:00',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxx',
],
'SkillGroupIds' => [
'description' => '技能组ID列表',
'type' => 'string',
'example' => '8fb654c6-17c6-4501-ba57-f5ddeb91981',
],
'Overall' => [
'description' => '整体指标',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalLoggedInTime' => [
'description' => '总登录时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'OccupancyRate' => [
'description' => '座席利用率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'LastLogOutTime' => [
'description' => '最后下线时间。',
'type' => 'string',
'example' => '2018-09-12 14:50:00',
],
'FirstLogInTime' => [
'description' => '首次登录时间。',
'type' => 'string',
'example' => '2018-09-12 14:46:00',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageReadyTime' => [
'description' => '平均就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxReadyTime' => [
'description' => '最大就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'OneTransferCalls' => [
'description' => '总转接量,即坐席发送直接转接的次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalReadyTime' => [
'description' => '总就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalBreakTime' => [
'description' => '总小休时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalCalls' => [
'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Inbound' => [
'description' => '呼入指标',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsOffered' => [
'description' => '电话呼入数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageRingTime' => [
'description' => '平均振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsHandled' => [
'description' => '电话应答数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ServiceLevel20' => [
'description' => '20s应答率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HandleRate' => [
'description' => '应答率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalRingTime' => [
'description' => '总振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxRingTime' => [
'description' => '最大振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Outbound' => [
'description' => '呼出指标',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxDialingTime' => [
'description' => '最大拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsDialed' => [
'description' => '电话拨号量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsAnswered' => [
'description' => '电话接通量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AnswerRate' => [
'description' => '接通率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalDialingTime' => [
'description' => '最大拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageDialingTime' => [
'description' => '平均拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DCF128C7-3817-4409-8557-15A0C49DA1B8\\",\\n \\"Success\\": true,\\n \\"PagedAgentSummaryReport\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": {\\n \\"AgentTimeIntervalReport\\": [\\n {\\n \\"AgentId\\": \\"276970771142947xxxx\\",\\n \\"IntervalList\\": {\\n \\"AgentSummaryReport\\": [\\n {\\n \\"LoginName\\": \\"weichao\\",\\n \\"AgentId\\": \\"276970771142947xxxx\\",\\n \\"AgentName\\": \\"默默\\",\\n \\"SkillGroupNames\\": \\"其他服务\\",\\n \\"Timestamp\\": \\"2018-09-12 14:45:00\\",\\n \\"InstanceId\\": \\"b0eb2742-f37e-4c67-82d4-25c651c1xxx\\",\\n \\"SkillGroupIds\\": \\"8fb654c6-17c6-4501-ba57-f5ddeb91981\\",\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 1,\\n \\"OccupancyRate\\": 0,\\n \\"LastLogOutTime\\": \\"2018-09-12 14:50:00\\",\\n \\"FirstLogInTime\\": \\"2018-09-12 14:46:00\\",\\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\\": 0,\\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 }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nDCF128C7-3817-4409-8557-15A0C49DA1B8\\n\\n 1\\n 10\\n 1\\n \\n \\n 276970771142947xxxx\\n \\n \\n 8fb654c6-17c6-4501-ba57-f5ddeb91981\\n weichao\\n b0eb2742-f37e-4c67-82d4-25c651c1xxx\\n 其他服务\\n 默默\\n 276970771142947xxxx\\n 2018-09-12 14:45:00\\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 2018-09-12 14:50:00\\n 0\\n 0\\n 2018-09-12 14:46:00\\n 1\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n \\n \\n
\\n\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '查询坐席指标的分段汇总报表',
'description' => '****',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListAgentSummaryReportsSinceMidnight' => [
'summary' => '调用ListAgentSummaryReportsSinceMidnight查询坐席指标的当天汇总报表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => [
'description' => '技能组ID',
'type' => 'string',
'required' => false,
'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814',
],
],
[
'name' => 'AgentIds',
'in' => 'query',
'schema' => [
'description' => '坐席ID列表(使用“,”隔开)。'."\n"
."\n"
.'坐席ID等同于该座席的RAM子账户ID,最多50个坐席;不传查询全部.',
'type' => 'string',
'required' => false,
'example' => '2769707711429472695',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号,默认值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小,默认值为10,最大是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' => '27DD30C4-CAE2-481A-97CC-D3C54625341D',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'PagedAgentSummaryReport' => [
'description' => '报表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalCount' => [
'description' => '总个数',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AgentSummaryReport' => [
'description' => '坐席报表列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LoginName' => [
'description' => '座席登录名',
'type' => 'string',
'example' => 'weichao',
],
'AgentId' => [
'description' => '座席ID,等同于该座席的RAM子账户ID。',
'type' => 'string',
'example' => '2769707711429472695',
],
'AgentName' => [
'description' => '座席名称',
'type' => 'string',
'example' => '默默',
],
'SkillGroupNames' => [
'description' => '技能组名称',
'type' => 'string',
'example' => '其他服务',
],
'Timestamp' => [
'description' => '日期,格式yyyy-MM-dd HH:mm:ss',
'type' => 'string',
'example' => '2018-09-13 00:00:00',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
'SkillGroupIds' => [
'description' => '技能组ID列表',
'type' => 'string',
'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814',
],
'Overall' => [
'description' => '整体指标',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalLoggedInTime' => [
'description' => '总登录时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '65',
],
'OccupancyRate' => [
'description' => '座席利用率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageReadyTime' => [
'description' => '平均就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '32',
],
'MaxReadyTime' => [
'description' => '最大就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '37',
],
'OneTransferCalls' => [
'description' => '总转接量,坐席发起直接转接的次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalReadyTime' => [
'description' => '总就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '65',
],
'TotalBreakTime' => [
'description' => '总小休时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalCalls' => [
'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Inbound' => [
'description' => '呼入指标',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsOffered' => [
'description' => '电话呼入数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageRingTime' => [
'description' => '平均振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsHandled' => [
'description' => '电话应答数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ServiceLevel20' => [
'description' => '20s应答率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HandleRate' => [
'description' => '应答率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalRingTime' => [
'description' => '总振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxRingTime' => [
'description' => '最大振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Outbound' => [
'description' => '呼出指标',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxDialingTime' => [
'description' => '最大拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsDialed' => [
'description' => '电话拨号量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsAnswered' => [
'description' => '电话接通量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AnswerRate' => [
'description' => '接通率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'string',
'example' => '0',
],
'TotalDialingTime' => [
'description' => '总拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageDialingTime' => [
'description' => '平均拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","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\\": 2,\\n \\"TotalCount\\": 2,\\n \\"List\\": {\\n \\"AgentSummaryReport\\": [\\n {\\n \\"LoginName\\": \\"weichao\\",\\n \\"AgentId\\": \\"2769707711429472695\\",\\n \\"AgentName\\": \\"默默\\",\\n \\"SkillGroupNames\\": \\"其他服务\\",\\n \\"Timestamp\\": \\"2018-09-13 00:00:00\\",\\n \\"InstanceId\\": \\"b0eb2742-f37e-4c67-82d4-25c651c1c450\\",\\n \\"SkillGroupIds\\": \\"8fb654c6-17c6-4501-ba57-f5ddeb919814\\",\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 65,\\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\\": 32,\\n \\"MaxReadyTime\\": 37,\\n \\"OneTransferCalls\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalReadyTime\\": 65,\\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 }\\n}","errorExample":""},{"type":"xml","example":"OK\\n\\n 1\\n 10\\n 1\\n \\n 2769707711429472695\\n b0eb2742-f37e-4c67-82d4-25c651c1c450\\n 其他服务\\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n 8fb654c6-17c6-4501-ba57-f5ddeb919814\\n weichao\\n \\n 37\\n 0\\n 0\\n 0\\n 65\\n 65\\n 0\\n 0\\n 0\\n 0\\n 32\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n 默默\\n 2018-09-13 00:00:00\\n
\\n\\n27DD30C4-CAE2-481A-97CC-D3C54625341D\\ntrue\\n200","errorExample":""}]',
'title' => '查询坐席指标的当天汇总报表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetAgentData' => [
'summary' => '调用GetAgentData获取单个坐席报表数据。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802',
],
],
[
'name' => 'StartDay',
'in' => 'query',
'schema' => [
'description' => '起始日期,格式yyyy-MM-dd。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2021-01-05',
],
],
[
'name' => 'EndDay',
'in' => 'query',
'schema' => [
'description' => '终止日期,格式yyyy-MM-dd。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2021-01-06',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '阿里云账号的lgoinName。',
'type' => 'string',
'required' => false,
'example' => 'cctest',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号,最大值100。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
],
'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' => '5E4AE8BE-282D-47DD-A9CB-AAC211F95DDB',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'DataList' => [
'description' => '报表数据。',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '对象总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'List' => [
'description' => '对象列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TotalLoggedInTime' => [
'description' => '总登录时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '16225',
],
'OccupancyRate' => [
'description' => '座席利用率。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'LoginName' => [
'description' => '座席登录名。',
'type' => 'string',
'example' => 'cctest',
],
'AgentId' => [
'description' => '座席ID,等同于该座席的RAM子账户ID,或阿里云UID。',
'type' => 'string',
'example' => '233482729826925174',
],
'RecordDate' => [
'description' => '日期。',
'type' => 'string',
'example' => '2021-01-05',
],
'AgentName' => [
'description' => 'Display/姓名。',
'type' => 'string',
'example' => '云呼测试',
],
'InstanceId' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef9',
],
'AverageReadyTime' => [
'description' => '平均就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxReadyTime' => [
'description' => '最大就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SkillGroupNames' => [
'description' => '座席所属技能组名称列表。',
'type' => 'string',
'example' => '默认技能组',
],
'SkillGroupIds' => [
'description' => '座席所属技能组ID列表。',
'type' => 'string',
'example' => '1fa8bb2f-e738-4981-aea8-264e67a175bc',
],
'TotalBreakTime' => [
'description' => '总小休时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '146',
],
'TotalReadyTime' => [
'description' => '总就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Inbound' => [
'description' => '呼入指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '33',
],
'AverageRingTime' => [
'description' => '平均振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsOffered' => [
'description' => '电话呼入数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsHandled' => [
'description' => '电话应答数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxHoldTime' => [
'description' => '最大保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalHoldTime' => [
'description' => '总保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HandleRate' => [
'description' => '应答率。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageHoldTime' => [
'description' => '平均保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalRingTime' => [
'description' => '总振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxRingTime' => [
'description' => '最大振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Outbound' => [
'description' => '呼出指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '260',
],
'MaxDialingTime' => [
'description' => '最大拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsDialed' => [
'description' => '电话拨号量。',
'type' => 'integer',
'format' => 'int64',
'example' => '18',
],
'CallsAnswered' => [
'description' => '电话接通量。',
'type' => 'integer',
'format' => 'int64',
'example' => '9',
],
'AnswerRate' => [
'description' => '接通率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '50',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxHoldTime' => [
'description' => '最大保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalDialingTime' => [
'description' => '总拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalHoldTime' => [
'description' => '总保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageHoldTime' => [
'description' => '平均保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageDialingTime' => [
'description' => '平均拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Overall' => [
'description' => '整体指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '293',
],
'MaxHoldTime' => [
'description' => '最大保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '70',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalHoldTime' => [
'description' => '总保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageHoldTime' => [
'description' => '平均保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalCalls' => [
'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。',
'type' => 'integer',
'format' => 'int64',
'example' => '19',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"5E4AE8BE-282D-47DD-A9CB-AAC211F95DDB\\",\\n \\"Success\\": true,\\n \\"DataList\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"TotalLoggedInTime\\": 16225,\\n \\"OccupancyRate\\": 0,\\n \\"LoginName\\": \\"cctest\\",\\n \\"AgentId\\": \\"233482729826925174\\",\\n \\"RecordDate\\": \\"2021-01-05\\",\\n \\"AgentName\\": \\"云呼测试\\",\\n \\"InstanceId\\": \\"d278629c-c687-4aa3-b044-4fe9b012e7ef9\\",\\n \\"AverageReadyTime\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"SkillGroupNames\\": \\"默认技能组\\",\\n \\"SkillGroupIds\\": \\"1fa8bb2f-e738-4981-aea8-264e67a175bc\\",\\n \\"TotalBreakTime\\": 146,\\n \\"TotalReadyTime\\": 0,\\n \\"Inbound\\": {\\n \\"TotalTalkTime\\": 33,\\n \\"AverageRingTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0\\n },\\n \\"Outbound\\": {\\n \\"TotalTalkTime\\": 260,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsDialed\\": 18,\\n \\"CallsAnswered\\": 9,\\n \\"AnswerRate\\": 50,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 293,\\n \\"MaxHoldTime\\": 0,\\n \\"TotalWorkTime\\": 70,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 19\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n5E4AE8BE-282D-47DD-A9CB-AAC211F95DDB\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '获取单个坐席报表数据',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListAgentDevices' => [
'summary' => '当坐席出现异常下线的情况时,查询坐席的设备信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'RamIds',
'in' => 'query',
'schema' => [
'description' => 'RamID的集合。'."\n"
."\n"
.'如果没有数据则查询当前坐席的设备信息,查询多个ramID信息用“,”分隔。',
'type' => 'string',
'required' => false,
'example' => '123,456',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '开始时间,默认当天时间的0点时刻。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '13465000',
],
],
[
'name' => 'StopTime',
'in' => 'query',
'schema' => [
'description' => '结束时间,默认当前时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1645645700',
],
],
],
'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' => 'A13BB835-94AA-4E55-8D9E-5EA585CEA99Y',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'AgentDeviceList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AgentDevice' => [
'description' => '坐席设备记录数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LoginTime' => [
'description' => '登录时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1559113107000',
],
'ClientPort' => [
'description' => '客户端Port',
'type' => 'string',
'example' => '8080',
],
'Remark' => [
'description' => '备注信息',
'type' => 'string',
'example' => '无',
],
'BrowserVersion' => [
'description' => '客户端浏览器信息',
'type' => 'string',
'example' => '浏览器内核类型:chrome,浏览器版本:74.0.3729.169',
],
'ClientIp' => [
'description' => '客户端IP',
'type' => 'string',
'example' => '30.52.180.90',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
'IsLogin' => [
'description' => '是否签入成功。 '."\n"
."\n"
.'**0**:签入失败;**1**:签入成功;',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RamId' => [
'description' => '座席的RAM子账户ID',
'type' => 'integer',
'format' => 'int64',
'example' => '1059803544828509',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"A13BB835-94AA-4E55-8D9E-5EA585CEA99Y\\",\\n \\"Success\\": true,\\n \\"AgentDeviceList\\": {\\n \\"AgentDevice\\": [\\n {\\n \\"LoginTime\\": 1559113107000,\\n \\"ClientPort\\": \\"8080\\",\\n \\"Remark\\": \\"无\\",\\n \\"BrowserVersion\\": \\"浏览器内核类型:chrome,浏览器版本:74.0.3729.169\\",\\n \\"ClientIp\\": \\"30.52.180.90\\",\\n \\"InstanceId\\": \\"d278629c-c687-4aa3-b044-4fe9b012e7ef\\",\\n \\"IsLogin\\": 1,\\n \\"RamId\\": 1059803544828509\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n A13BB835-94AA-4E55-8D9E-5EA585CEA99Y\\r\\n true\\r\\n OK\\r\\n \\r\\n \\r\\n 1559113107000\\r\\n d278629c-c687-4aa3-b044-4fe9b012e7ef\\r\\n 1\\r\\n 30.52.180.90\\r\\n \\r\\n 1059803544828509\\r\\n 浏览器内核类型:chrome,浏览器版本:74.0.3729.169\\r\\n \\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '查询坐席设备信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListAgentEvents' => [
'summary' => '调用ListAgentEvents获取呼叫中心实例中坐席的事件状态信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待获取用户的呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '开始时间。'."\n"
."\n"
.'默认是当前时间前一小时,注意查询时间范围小于1小时,否则会报错。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1555297200000',
],
],
[
'name' => 'StopTime',
'in' => 'query',
'schema' => [
'description' => '结束时间,默认是当前时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1555300800000',
],
],
[
'name' => 'RamId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '坐席的RAM ID。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => '1059803544828509',
'maxItems' => 99,
],
],
[
'name' => 'Event',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '事件。'."\n"
."\n"
.'包括:”签入”,”签出”,”小休”,”等待”,”振铃”,”通话”,”放弃”,”结束”,”处理”,”发起求助”,”求助成功”,”会议建立”,”会议结束”,”拨号”。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '签入',
'maxItems' => 99,
],
],
],
'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' => 'ADB327AC-6ABF-4FE9-A52E-AAB9894CD0E7',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'AgentEventList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AgentEvent' => [
'description' => '坐席事件状态数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Event' => [
'description' => '座席事件状态描述。',
'type' => 'string',
'example' => '签出',
],
'EventTime' => [
'description' => '事件触发时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1555299918000',
],
'LoginName' => [
'description' => '座席登录名',
'type' => 'string',
'example' => 'ccctest',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef',
],
'RamId' => [
'description' => '座席的RAM子账户ID',
'type' => 'integer',
'format' => 'int64',
'example' => '2059803544828509',
],
'SkillGroupIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillGroup' => [
'description' => '座席关联的技能组列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SkillGroupName' => [
'description' => '技能组名称',
'type' => 'string',
'example' => 'Default',
],
'SkillGroupId' => [
'description' => '技能组ID',
'type' => 'string',
'example' => '014a9696-931d-49db-ae96-111d2098a548',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"ADB327AC-6ABF-4FE9-A52E-AAB9894CD0E7\\",\\n \\"Success\\": true,\\n \\"AgentEventList\\": {\\n \\"AgentEvent\\": [\\n {\\n \\"Event\\": \\"签出\\",\\n \\"EventTime\\": 1555299918000,\\n \\"LoginName\\": \\"ccctest\\",\\n \\"InstanceId\\": \\"d278629c-c687-4aa3-b044-4fe9b012e7ef\\",\\n \\"RamId\\": 2059803544828509,\\n \\"SkillGroupIds\\": {\\n \\"SkillGroup\\": [\\n {\\n \\"SkillGroupName\\": \\"Default\\",\\n \\"SkillGroupId\\": \\"014a9696-931d-49db-ae96-111d2098a548\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n \\r\\n \\r\\n \\r\\n \\r\\n Default\\r\\n 014a9696-931d-49db-ae96-111d2098a548\\r\\n \\r\\n \\r\\n ccctest\\r\\n 1555299917000\\r\\n 等待\\r\\n d278629c-c687-4aa3-b044-4fe9b012e7ef\\r\\n 2059803544828509\\r\\n \\r\\n \\r\\n \\r\\n \\r\\n Default\\r\\n 014a9696-931d-49db-ae96-111d2098a548\\r\\n \\r\\n \\r\\n ccctest\\r\\n 1555299918000\\r\\n 签出\\r\\n d278629c-c687-4aa3-b044-4fe9b012e7ef\\r\\n 2059803544828509\\r\\n \\r\\n \\r\\n ADB327AC-6ABF-4FE9-A52E-AAB9894CD0E7\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '获取呼叫中心实例中坐席的事件状态信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GenerateAgentStatisticReport' => [
'summary' => '调用GenerateAgentStatisticReport返回调用者自己的坐席报表数据,用在坐席工作台-我的工作页面。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef8',
'docRequired' => true,
],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => [
'description' => '座席ID,等同于该座席的RAM子账户ID。',
'type' => 'string',
'required' => false,
'example' => '233482729826925174',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '起始日期,格式yyyy-MM-dd,包括当前日期。',
'type' => 'string',
'required' => true,
'example' => '2018-05-20 11:11:11',
'docRequired' => true,
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '终止日期,格式yyyy-MM-dd,包括当前日期。',
'type' => 'string',
'required' => true,
'example' => '2018-05-20 11:11:11',
'docRequired' => true,
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
'docRequired' => true,
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
'docRequired' => 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' => '03C67DAD-EB26-41D8-949D-9B0C470FB716',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'DataList' => [
'description' => '报表数据。',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalCount' => [
'description' => '对象总数',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'GenerateAgentStatistic' => [
'description' => '对象列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TotalLoggedInTime' => [
'description' => '总登录时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'OccupancyRate' => [
'description' => '座席利用率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'LoginName' => [
'description' => '座席登录名。',
'type' => 'string',
'example' => 'cctest',
],
'AgentId' => [
'description' => '座席ID,等同于该座席的RAM子账户ID。',
'type' => 'string',
'example' => '233482729826925174',
],
'RecordDate' => [
'description' => '日期。',
'type' => 'string',
'example' => '无',
],
'AgentName' => [
'description' => 'Display/姓名。',
'type' => 'string',
'example' => '云呼测试',
],
'InstanceId' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef9',
],
'AverageReadyTime' => [
'description' => '平均就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxReadyTime' => [
'description' => '最大就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SkillGroupNames' => [
'description' => '座席所属技能组名称列表。',
'type' => 'string',
'example' => 'Default,测试技能组',
],
'SkillGroupIds' => [
'description' => '座席所属技能组ID列表。',
'type' => 'string',
'example' => 'b0cc307c-9c74-43e6-4328-86e1bf98272b,f792751d-d4cb-4d4c-ccs4-b0oiw1f05247',
],
'TotalBreakTime' => [
'description' => '总小休时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalReadyTime' => [
'description' => '总就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Inbound' => [
'description' => '呼入指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageRingTime' => [
'description' => '平均振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsOffered' => [
'description' => '电话呼入数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsHandled' => [
'description' => '电话应答数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxHoldTime' => [
'description' => '最大保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalHoldTime' => [
'description' => '总保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HandleRate' => [
'description' => '应答率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageHoldTime' => [
'description' => '平均保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalRingTime' => [
'description' => '总振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxRingTime' => [
'description' => '最大振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Outbound' => [
'description' => '呼出指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxDialingTime' => [
'description' => '最大拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsDialed' => [
'description' => '电话拨号量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsAnswered' => [
'description' => '电话接通量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AnswerRate' => [
'description' => '接通率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxHoldTime' => [
'description' => '最大保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalDialingTime' => [
'description' => '总拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalHoldTime' => [
'description' => '总保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageHoldTime' => [
'description' => '平均保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageDialingTime' => [
'description' => '平均拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Overall' => [
'description' => '整体指标。',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxHoldTime' => [
'description' => '最大保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalHoldTime' => [
'description' => '总保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageHoldTime' => [
'description' => '平均保持时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalCalls' => [
'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Success\\": true,\\n \\"DataList\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 2,\\n \\"List\\": {\\n \\"GenerateAgentStatistic\\": [\\n {\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"LoginName\\": \\"cctest\\",\\n \\"AgentId\\": \\"233482729826925174\\",\\n \\"RecordDate\\": \\"无\\",\\n \\"AgentName\\": \\"云呼测试\\",\\n \\"InstanceId\\": \\"d278629c-c687-4aa3-b044-4fe9b012e7ef9\\",\\n \\"AverageReadyTime\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"SkillGroupNames\\": \\"Default,测试技能组\\",\\n \\"SkillGroupIds\\": \\"b0cc307c-9c74-43e6-4328-86e1bf98272b,f792751d-d4cb-4d4c-ccs4-b0oiw1f05247\\",\\n \\"TotalBreakTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"Inbound\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"AverageRingTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 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 \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n43DF2FD7-BC08-00BE-A679-CA16DDEAN90AE\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '获取坐席报表数据',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RefreshToken' => [
'summary' => '刷新坐席工作台的Token,用来保持坐席工作台有效的登录状态。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
],
'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' => 'EF438794-B498-4559-A536-3CD0BA33A1BF',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Token' => [
'description' => '更新的令牌信息',
'type' => 'object',
'properties' => [
'SignData' => [
'description' => '待签名数据',
'type' => 'string',
'example' => '{"tenantId": "acc2631", "serviceId":"249353919874654122", "dn":"80326034", "source":"aliyun", "timestamp":1531452126, "expireTime":1531453926}',
],
'Signature' => [
'description' => '签名信息。'."\n"
."\n"
.'签名格式:`{“tenantId”: “aliyun-xxx”, “serviceId”:”sam.zhang”, “dn”:”802001”, “source”:”aliyun”, “timestamp”:1423333, “expireTime”:1423933}`。',
'type' => 'string',
'example' => '{“tenantId”: “aliyun-xxx”, “serviceId”:”sam.zhang”, “dn”:”802001”, “source”:”aliyun”, “timestamp”:1423333, “expireTime”:1423933}',
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EF438794-B498-4559-A536-3CD0BA33A1BF\\",\\n \\"Success\\": true,\\n \\"Token\\": {\\n \\"SignData\\": \\"{\\\\\\"tenantId\\\\\\": \\\\\\"acc2631\\\\\\", \\\\\\"serviceId\\\\\\":\\\\\\"249353919874654122\\\\\\", \\\\\\"dn\\\\\\":\\\\\\"80326034\\\\\\", \\\\\\"source\\\\\\":\\\\\\"aliyun\\\\\\", \\\\\\"timestamp\\\\\\":1531452126, \\\\\\"expireTime\\\\\\":1531453926}\\",\\n \\"Signature\\": \\"{“tenantId”: “aliyun-xxx”, “serviceId”:”sam.zhang”, “dn”:”802001”, “source”:”aliyun”, “timestamp”:1423333, “expireTime”:1423933}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n EF438794-B498-4559-A536-3CD0BA33A1BF\\r\\n \\r\\n \\r\\n acc2631\\r\\n 249353919874654122\\r\\n 80326034\\r\\n aliyun\\r\\n 1531452126\\r\\n 1531453926\\r\\n \\r\\n D3RhcvUKPo8kOl/FmAHxw/A2leB29OqaBPRfpJAkSrM0cn4mWzFoj8O075Uahx5LQdIAqmbYn6zAhUeQQAgtUrr1QYWv90VhZkrX3mJhQmccX0VORBm7FlHpqDGoPym8or1eGl9Ud+UhJ5+ZH/JhLfZEFuJ9P5FEBMXHzvaPLw4=\\r\\n \\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '刷新坐席工作台Token',
'description' => '> 该API由软电话SDK主动发起调用,您只需要负责转发请求即可。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RequestLoginInfo' => [
'summary' => '调用RequestLoginInfo获取坐席工作台的登陆信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '用户唯一标识。'."\n"
."\n"
.'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId,即UUID。',
'type' => 'string',
'required' => false,
'example' => '674a5953-21d5-4ee9-9b42-eb8813d6**** ',
],
],
],
'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' => '9D902FCA-FBBA-4888-9F85-4900EE85DA3D',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'LoginInfo' => [
'description' => '获取到的Region信息',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '座席展示名,来源于IMS目录服务',
'type' => 'string',
'example' => '小李',
],
'Signature' => [
'description' => '签名信息',
'type' => 'string',
'example' => '****',
],
'Extension' => [
'description' => '分机号码',
'type' => 'string',
'example' => '8032****',
],
'SignData' => [
'description' => '签名数据',
'type' => 'string',
'example' => '{"tenantId": "acc2631", "serviceId":"24935391987465****", "dn":"8032****", "source":"aliyun", "timestamp":1531454246, "expireTime":1531456046}',
],
'PhoneNumber' => [
'description' => '手机号码',
'type' => 'string',
'example' => '1766666****',
],
'Region' => [
'description' => '区域信息',
'type' => 'string',
'example' => 'aliyunccc',
],
'AgentServerUrl' => [
'description' => 'Agent Server集群VIP地址',
'type' => 'string',
'example' => 'as.ccc.aliyuncs.com:80',
],
'UserName' => [
'description' => '座席登录名(用户名),来源于IMS目录服务',
'type' => 'string',
'example' => '4935391987465****@hotCallCenter2',
],
'WebRtcUrl' => [
'description' => 'WebRTC2SIP服务器地址',
'type' => 'string',
'example' => 'sip.ccc.aliyuncs.com:9443',
],
'TenantId' => [
'description' => '租户ID',
'type' => 'string',
'example' => 'acc2631',
],
'Roles' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Role' => [
'description' => '用户的角色列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '角色所归属的呼叫中心实例',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
'RoleName' => [
'description' => '角色名称',
'type' => 'string',
'example' => 'AGENT',
],
'RoleDescription' => [
'description' => '角色描述',
'type' => 'string',
'example' => '坐席',
],
'RoleId' => [
'description' => '角色ID,系统自动生成的唯一标示符',
'type' => 'string',
'example' => '4c2e158e-ddd9-464a-a3fc-338eca10277c',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"9D902FCA-FBBA-4888-9F85-4900EE85DA3D\\",\\n \\"Success\\": true,\\n \\"LoginInfo\\": {\\n \\"DisplayName\\": \\"小李\\",\\n \\"Signature\\": \\"****\\",\\n \\"Extension\\": \\"8032****\\",\\n \\"SignData\\": \\"{\\\\\\"tenantId\\\\\\": \\\\\\"acc2631\\\\\\", \\\\\\"serviceId\\\\\\":\\\\\\"24935391987465****\\\\\\", \\\\\\"dn\\\\\\":\\\\\\"8032****\\\\\\", \\\\\\"source\\\\\\":\\\\\\"aliyun\\\\\\", \\\\\\"timestamp\\\\\\":1531454246, \\\\\\"expireTime\\\\\\":1531456046}\\",\\n \\"PhoneNumber\\": \\"1766666****\\",\\n \\"Region\\": \\"aliyunccc\\",\\n \\"AgentServerUrl\\": \\"as.ccc.aliyuncs.com:80\\",\\n \\"UserName\\": \\"4935391987465****@hotCallCenter2\\",\\n \\"WebRtcUrl\\": \\"sip.ccc.aliyuncs.com:9443\\",\\n \\"TenantId\\": \\"acc2631\\",\\n \\"Roles\\": {\\n \\"Role\\": [\\n {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\",\\n \\"RoleName\\": \\"AGENT\\",\\n \\"RoleDescription\\": \\"坐席\\",\\n \\"RoleId\\": \\"4c2e158e-ddd9-464a-a3fc-338eca10277c\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\n9D902FCA-FBBA-4888-9F85-4900EE85DA3D\\n\\n 8032****\\n as.ccc.aliyuncs.com:80\\n acc2631\\n 4935391987465****@hotCallCenter2\\n {\\"tenantId\\": \\"acc2631\\", \\"serviceId\\":\\"24935391987465****\\", \\"dn\\":\\"8032****\\", \\"source\\":\\"aliyun\\", \\"timestamp\\":1531454246, \\"expireTime\\":1531456046}\\n ****\\n 小李\\n aliyunccc\\n 1766666****\\n sip.ccc.aliyuncs.com:9443\\n \\n \\n AGENT\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\n 坐席\\n 4c2e158e-ddd9-464a-a3fc-338eca10277c\\n \\n \\n\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '获取坐席工作台的登陆信息',
'description' => '****',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetSmsConfig' => [
'summary' => '获取短信配置信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREccc1MRAID',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'Scenario',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '场景,1:短信满意度;2:IVR流程中使用;3:漏话短信。'."\n"
."\n"
.'参数名称**Scenario.1**表示只获取1个场景下的短信配置信息,如果要获取多个场景的短信配置信息,则需要有Scenario.1以及Scenario.2,以此类推,请参考下方的请求示例。',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int32',
],
'required' => true,
'example' => '2',
'maxItems' => 99,
],
],
],
'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' => 'E993D7CD-D546-4F88-9B04-62DFB05ED7E1',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SmsConfigs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SmsConfig' => [
'description' => '配置列表,没有则不返回。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Instance' => [
'description' => '实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
'Description' => [
'description' => '短信模板内容',
'type' => 'string',
'example' => '验证码${code},您正在进行身份验证,不要告诉别人哦!',
],
'TemplateCode' => [
'description' => '短信模板CODE',
'type' => 'string',
'example' => 'SMS_96955021',
],
'GmtCreate' => [
'description' => '创建时间',
'type' => 'string',
'example' => '无',
],
'Scenario' => [
'description' => '场景',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'GmtModified' => [
'description' => '更新时间',
'type' => 'string',
'example' => '无',
],
'Name' => [
'description' => '名称',
'type' => 'string',
'example' => '身份验证',
],
'Extra' => [
'description' => '额外参数,与具体场景有关',
'type' => 'string',
'example' => '无',
],
'SignName' => [
'description' => '短信签名名称',
'type' => 'string',
'example' => '阿里大于测试专用',
],
'Id' => [
'description' => '短信配置ID',
'type' => 'integer',
'format' => 'int64',
'example' => '36230',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E993D7CD-D546-4F88-9B04-62DFB05ED7E1\\",\\n \\"Success\\": true,\\n \\"SmsConfigs\\": {\\n \\"SmsConfig\\": [\\n {\\n \\"Instance\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3****\\",\\n \\"Description\\": \\"验证码${code},您正在进行身份验证,不要告诉别人哦!\\",\\n \\"TemplateCode\\": \\"SMS_96955021\\",\\n \\"GmtCreate\\": \\"无\\",\\n \\"Scenario\\": 2,\\n \\"GmtModified\\": \\"无\\",\\n \\"Name\\": \\"身份验证\\",\\n \\"Extra\\": \\"无\\",\\n \\"SignName\\": \\"阿里大于测试专用\\",\\n \\"Id\\": 36230\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nE993D7CD-D546-4F88-9B04-62DFB05ED7E1\\n200\\n\\n \\n SMS_96955021\\n 无\\n 验证码${code},您正在进行身份验证,不要告诉别人哦!\\n 无\\n 9cfad875-6260-4a53-ab6e-b13e3fb3****\\n 无\\n 36230\\n 阿里大于测试专用\\n 身份验证\\n 2\\n \\n\\nOK\\ntrue","errorExample":""}]',
'title' => '获取短信配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'LaunchShortMessageAppraise' => [
'summary' => '调用LaunchShortMessageAppraise统计短信满意度发送率。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'Acid',
'in' => 'query',
'schema' => [
'description' => '通话话务ID。'."\n"
."\n"
.'即contactId,软电话SDK的回调事件中会携带contactId。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2029401778',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => [
'description' => '技能组ID',
'type' => 'string',
'required' => false,
'example' => 'xxx',
],
],
[
'name' => 'ContactType',
'in' => 'query',
'schema' => [
'description' => '呼入还是呼出。取值:'."\n"
."\n"
.'- 0:呼入'."\n"
.'- 1:呼出',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PhoneNumbers',
'in' => 'query',
'schema' => [
'description' => '要发送短信的手机号码,多个号码以逗号分隔',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1763333****',
],
],
],
'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' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"678F7002-CA01-4ABF-A112-585AFBDF3A3B\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"无\\n678F7002-CA01-4ABF-A112-585AFBDF3A3B\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '统计短信满意度发送率',
'description' => '> 点击坐席工作台(软电话SDK)中的发送短信满意度按钮时调用,用来发送短信,记录坐席发送了满意度,统计满意度发送率。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SendPredefinedShortMessage' => [
'summary' => '根据预告定义的短信模板发送短信,例如发送漏话短信。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'PhoneNumbers',
'in' => 'query',
'schema' => [
'description' => '手机号码',
'type' => 'string',
'required' => true,
'example' => '1760066****',
],
],
[
'name' => 'ConfigId',
'in' => 'query',
'schema' => [
'description' => '短信配置项ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23',
],
],
[
'name' => 'TemplateParam',
'in' => 'query',
'schema' => [
'description' => '短信模板变量替换JSON串。'."\n"
."\n"
.'> 如果JSON中需要带换行符,请参照标准的JSON协议。',
'type' => 'string',
'required' => false,
'example' => '{"totalSum":"13422","minutes":"3423","outBound":"1333","inBound":"2333"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '28349E33-294F-4413-A9F3-EE828F4C2FE7',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
'BizId' => [
'description' => '短信服务返回的Bizid',
'type' => 'string',
'example' => '35681823605595****',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"28349E33-294F-4413-A9F3-EE828F4C2FE7\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"BizId\\": \\"35681823605595****\\"\\n}","errorExample":""},{"type":"xml","example":"无\\n28349E33-294F-4413-A9F3-EE828F4C2FE7\\n200\\n35681823605595****\\nOK\\ntrue","errorExample":""}]',
'title' => '根据短信模板发送短信',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateSkillGroup' => [
'summary' => '调用CreateSkillGroup创建技能组。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccPBOQGO',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待创建的技能组所归属的呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '待创建的技能组名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '售前技能组',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '待创建的技能组的描述。',
'type' => 'string',
'required' => false,
'example' => '售前坐席使用',
],
],
[
'name' => 'RoutingStrategy',
'in' => 'query',
'schema' => [
'description' => '匹配方式。取值:default(默认模式)、acquaintance(熟人模式)。',
'type' => 'string',
'required' => false,
'example' => 'default',
],
],
[
'name' => 'AllowPrivateOutboundNumber',
'in' => 'query',
'schema' => [
'description' => '是否允许使用个人外呼号码。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'OutboundPhoneNumberId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要绑定到技能组的外呼号码的号码ID。'."\n"
."\n\n"
.'参数名称为**OutboundPhoneNumberId.1**意为只绑定一个外呼号码,如果绑定多个号码,则需要传多个,例如 OutboundPhoneNumberId.1、OutboundPhoneNumberId.2、OutboundPhoneNumberId.3,以此类推。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '2ead4b47-db37-43b3-8e32-ae71d81620af',
'maxItems' => 99,
],
],
[
'name' => 'UserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要加入到技能组中的坐席ID。'."\n"
."\n"
.'**UserId.1**意为只绑定一个坐席,如果绑定多个,则需要传多个,例如 UserId.1、UserId.2、UserId.3,以此类推。注意UserId指RAM子账号在呼叫中心实例的唯一标识UserId,并非RAM子账号的RamId。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '8b33d247-128c-4013-b79d-ec11a6a8f108',
'maxItems' => 99,
],
],
[
'name' => 'SkillLevel',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '技能级别。表示该坐席在技能组的等级,等级区间为1-10,来电后优先分配给等级高的坐席。'."\n"
."\n"
.'**SkillLevel.1**代表为上面的**UserId.1**设置技能组等级,如果userId为多个,则SkillLevel也需要多个,并且数量需要保持一致。',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int32',
],
'required' => false,
'example' => '5',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '05B8C64B-008A-427B-8B27-84E372A291D6',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SkillGroupId' => [
'description' => '新创建的技能组ID',
'type' => 'string',
'example' => '8fc24faa-4e15-43af-9c94-5bb9ee568bb2',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => '无',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"05B8C64B-008A-427B-8B27-84E372A291D6\\",\\n \\"Success\\": true,\\n \\"SkillGroupId\\": \\"8fc24faa-4e15-43af-9c94-5bb9ee568bb2\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"无\\n05B8C64B-008A-427B-8B27-84E372A291D6\\n200\\n8fc24faa-4e15-43af-9c94-5bb9ee568bb2\\nOK\\ntrue","errorExample":""}]',
'title' => '创建技能组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteSkillGroup' => [
'summary' => '调用DeleteSkillGroup删除技能组。',
'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' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => [
'description' => '待删除的技能组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '8fc24faa-4e15-43af-9c94-5bb9ee568bb2',
],
],
],
'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',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"A450574A-337F-43E2-BC59-9C6594C994C6\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n A450574A-337F-43E2-BC59-9C6594C994C6\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '删除技能组',
'description' => '> 如果该技能组中仍有座席,则座席首先会被移出技能组,然后技能组被删除。',
],
'ModifyPrimaryTrunksOfSkillGroup' => [
'summary' => '调用接口:ModifyPrimaryTrunksOfSkillGroup 修改技能组线路中继配置信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => [
'description' => '技能组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '809wer75-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'PrimaryProviderName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '主线路名称',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '联通全国',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码'."\n"
."\n",
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息'."\n"
."\n",
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'UserPermission',
'errorMessage' => 'User \'%s\' has no permission to \'%s\'',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"无\\nDE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\t\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '修改技能组线路中继配置信息',
'description' => '注意:调用该接口前需要提供阿里云UID给云呼服务支持(13148471489)进行加白操作。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifySkillGroup' => [
'summary' => '修改技能组的名称、描述、外呼号码以及组内坐席。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待编辑技能组所属呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => [
'description' => '待修改的技能组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18ef28',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '技能组的新名称',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '售后技术支持技能组',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '技能组的新的简单描述',
'type' => 'string',
'required' => false,
'example' => '售后技术支持人员使用',
],
],
[
'name' => 'RoutingStrategy',
'in' => 'query',
'schema' => [
'description' => '匹配方式',
'type' => 'string',
'required' => false,
'example' => 'default',
],
],
[
'name' => 'AllowPrivateOutboundNumber',
'in' => 'query',
'schema' => [
'description' => '是否允许使用个人外呼号码',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'OutboundPhoneNumberId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要绑定到技能组的外呼号码的号码ID。'."\n"
."\n\n"
.'参数名称**OutboundPhoneNumberId.1**意为只绑定一个外呼号码,如果绑定多个号码,则需要传多个,例如 OutboundPhoneNumberId.1、OutboundPhoneNumberId.2、OutboundPhoneNumberId.3,以此类推。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '2ead4b47-db37-43b3-8e32-ae71d81620af',
'maxItems' => 99,
],
],
[
'name' => 'UserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要加入到技能组中的坐席ID。'."\n"
."\n"
.'**UserId.1**意为只绑定一个坐席,如果绑定多个,则需要传多个,例如 UserId.1、UserId.2、UserId.3,以此类推。注意UserId指RAM子账号在呼叫中心实例的唯一标识UserId,并非RAM子账号的RamId。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '8b33d247-128c-4013-b79d-ec11a6a8f108',
'maxItems' => 99,
],
],
[
'name' => 'SkillLevel',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '技能级别。'."\n"
."\n"
.'**SkillLevel.1**代表为**UserId.1**设置技能组等级,如果userId为多个,则SkillLevel也需要多个,并且数量需要保持一致。',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int32',
],
'required' => false,
'example' => '5',
'maxItems' => 99,
],
],
],
'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' => 'E49E170E-4481-40A2-BC33-3D789263F50E',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E49E170E-4481-40A2-BC33-3D789263F50E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n E49E170E-4481-40A2-BC33-3D789263F50E\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '修改技能组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifySkillGroupOfUser' => [
'summary' => '调用ModifySkillGroupOfUser修改坐席从属的技能组。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccPBOQGO',
],
],
'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',
'type' => 'string',
'required' => true,
'example' => 'b394cf26-8d5c-4494-8f40-68a2aba8ba64',
],
],
[
'name' => 'RoleId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '用户所具有的角色ID',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => '4c2e158e-ddd9-464a-a3fc-338eca10277c',
'maxItems' => 99,
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待创建用户所归属的技能组ID',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18ef28',
'maxItems' => 99,
],
],
[
'name' => 'SkillLevel',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '修改后的技能级别',
'type' => 'array',
'items' => [
'type' => 'integer',
'format' => 'int32',
],
'required' => false,
'example' => '4',
'maxItems' => 99,
],
],
],
'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' => '4A2E1761-8C19-4788-BA76-6C8902A6D5E9',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"4A2E1761-8C19-4788-BA76-6C8902A6D5E9\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n 4A2E1761-8C19-4788-BA76-6C8902A6D5E9\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '修改坐席从属的技能组',
],
'ModifySkillGroupOutboundNumbers' => [
'summary' => '调用ModifySkillGroupOutboundNumbers修改技能组的外呼电话列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待编辑技能组所属呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => [
'description' => '待修改的技能组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c6010943-c0f6-44e5-8f94-60a85a647178',
],
],
[
'name' => 'OperationType',
'in' => 'query',
'schema' => [
'description' => '支持新增、删除、重置。'."\n"
."\n"
.'- 1 = 新增,把传入的所有号码添加到当前的外呼列表中,'."\n"
.'- 2 = 删除,把传入的所有号码从当前的外呼列表中删除'."\n"
.'- 3 = 重置,把当前外呼号码列表中的号码情况,把传入的所有号码增加到外呼号码列表中。'."\n"
.'- 其他值无效,返回错误。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'OutboundPhoneNumberId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要绑定到技能组的外呼号码的号码ID。400号码不支持外呼,传入的400号码,会被自动过滤。'."\n"
."\n"
.'参数名称**OutboundPhoneNumberId.1**意为只绑定一个外呼号码,如果绑定多个号码,则需要传多个,例如 OutboundPhoneNumberId.1、OutboundPhoneNumberId.2、OutboundPhoneNumberId.3,以此类推。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => '2ead4b47-db37-43b3-8e32-ae71d81620af',
'maxItems' => 99,
],
],
],
'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' => '05B8C64B-008A-427B-8B27-84E372A291D6',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"05B8C64B-008A-427B-8B27-84E372A291D6\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n 05B8C64B-008A-427B-8B27-84E372A291D6\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '修改技能组的外呼电话列表',
],
'ListTrunksOfSkillGroup' => [
'summary' => '调用接口:ListTrunksOfSkillGroup 查询用户技能组下中继线路配置信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => [
'description' => '技能组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'sdiuwd875-6260-4a53-ab6e-b13e3fb31f',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码'."\n"
."\n",
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息'."\n"
."\n",
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID'."\n"
."\n",
'type' => 'string',
'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE',
],
'Success' => [
'description' => '是否成功'."\n"
."\n",
'type' => 'boolean',
'example' => 'true',
],
'TrunkConfigs' => [
'description' => '中继线路配置信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ProviderName' => [
'description' => '线路供应商名称',
'type' => 'string',
'example' => '联通全国',
],
'Primary' => [
'description' => '线路供应商使用状态',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'UserPermission',
'errorMessage' => 'User \'%s\' has no permission to \'%s\'',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"Success\\": true,\\n \\"TrunkConfigs\\": [\\n {\\n \\"ProviderName\\": \\"联通全国\\",\\n \\"Primary\\": false\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\n200\\n\\n 联通全国\\n false\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '查询用户技能组下中继线路配置信息',
'description' => '调用接口:ListTrunksOfSkillGroup 查询用户技能组下中继线路配置信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListUsersOfSkillGroup' => [
'summary' => '调用ListUsersOfSkillGroup获取一个技能组的用户列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待获取用户列表的技能组所属呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => [
'description' => '待获取用户列表的技能组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '5',
],
],
],
'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' => 'C0628E65-1D39-4C26-9AF8-E64775D4BE0F',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Users' => [
'description' => '获取到的一个技能组的所有用户',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'TotalCount' => [
'description' => '对象总数',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'User' => [
'description' => '对象列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '用户所归属的呼叫中心实ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
'RamId' => [
'description' => '用户所对应的RAM账户ID',
'type' => 'string',
'example' => '20643462717516xxxx',
],
'UserId' => [
'description' => '用户ID,系统自动生成的唯一标示符。'."\n"
."\n"
.'注意这里是RAM子账号在呼叫中心实例的唯一标示符并非RamId,即UUID。',
'type' => 'string',
'example' => '8b33d247-128c-4013-b79d-ec11a6a8xxxx',
],
'Roles' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Role' => [
'description' => '用户的角色列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UserCount' => [
'description' => '拥有该角色的用户的数量',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'RoleName' => [
'description' => '角色名称',
'type' => 'string',
'example' => 'AGENT',
],
'InstanceId' => [
'description' => '角色所归属的呼叫中心实例',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
'RoleDescription' => [
'description' => '角色描述',
'type' => 'string',
'example' => '坐席',
],
'RoleId' => [
'description' => '角色ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '4c2e158e-ddd9-464a-a3fc-338eca10xxxx',
],
'Privileges' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Privilege' => [
'description' => '角色权限列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PrivilegeName' => [
'description' => '权限名称,需要唯一。',
'type' => 'string',
'example' => 'xxx',
],
'PrivilegeId' => [
'description' => '权限ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => 'xxx',
],
'PrivilegeDescription' => [
'description' => '权限描述',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
],
],
],
],
],
],
],
'SkillLevels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillLevel' => [
'description' => '用户所归属的技能组及相应等级,一个用户可以不属于任何技能组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SkillLevelId' => [
'description' => '技能级别唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '121131',
],
'Level' => [
'description' => '技能级别',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'Skill' => [
'description' => '技能',
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '技能组所归属的呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
'SkillGroupDescription' => [
'description' => '技能组简单描述',
'type' => 'string',
'example' => '售后技术支持人员使用',
],
'SkillGroupId' => [
'description' => '技能组唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx',
],
'SkillGroupName' => [
'description' => '技能组名字,需要在所归属的呼叫中心实例中唯一。',
'type' => 'string',
'example' => '售后技术支持技能组',
],
],
],
],
],
],
],
],
'Detail' => [
'description' => '用户详细信息',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '用户的全名',
'type' => 'string',
'example' => '馨言',
],
'Email' => [
'description' => '用户的电子邮件地址',
'type' => 'string',
'example' => '1783922****@163.com',
],
'LoginName' => [
'description' => '用户登录名',
'type' => 'string',
'example' => 'xinyan',
],
'Department' => [
'description' => '所属部门',
'type' => 'string',
'example' => 'IT',
],
'Phone' => [
'description' => '用户的电话号码',
'type' => 'string',
'example' => '12345****',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C0628E65-1D39-4C26-9AF8-E64775D4BE0F\\",\\n \\"Success\\": true,\\n \\"Users\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 5,\\n \\"TotalCount\\": 2,\\n \\"List\\": {\\n \\"User\\": [\\n {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"RamId\\": \\"20643462717516xxxx\\",\\n \\"UserId\\": \\"8b33d247-128c-4013-b79d-ec11a6a8xxxx\\",\\n \\"Roles\\": {\\n \\"Role\\": [\\n {\\n \\"UserCount\\": 0,\\n \\"RoleName\\": \\"AGENT\\",\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"RoleDescription\\": \\"坐席\\",\\n \\"RoleId\\": \\"4c2e158e-ddd9-464a-a3fc-338eca10xxxx\\",\\n \\"Privileges\\": {\\n \\"Privilege\\": [\\n {\\n \\"PrivilegeName\\": \\"xxx\\",\\n \\"PrivilegeId\\": \\"xxx\\",\\n \\"PrivilegeDescription\\": \\"xxx\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"SkillLevels\\": {\\n \\"SkillLevel\\": [\\n {\\n \\"SkillLevelId\\": \\"121131\\",\\n \\"Level\\": 4,\\n \\"Skill\\": {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"SkillGroupDescription\\": \\"售后技术支持人员使用\\",\\n \\"SkillGroupId\\": \\"0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx\\",\\n \\"SkillGroupName\\": \\"售后技术支持技能组\\"\\n }\\n }\\n ]\\n },\\n \\"Detail\\": {\\n \\"DisplayName\\": \\"馨言\\",\\n \\"Email\\": \\"1783922****@163.com\\",\\n \\"LoginName\\": \\"xinyan\\",\\n \\"Department\\": \\"IT\\",\\n \\"Phone\\": \\"12345****\\"\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nC0628E65-1D39-4C26-9AF8-E64775D4BE0F\\n200\\n\\n 2\\n 5\\n 1\\n \\n \\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n 8b33d247-128c-4013-b79d-ec11a6a8xxxx\\n 20643462717516xxxx\\n \\n \\n 121131\\n 4\\n \\n 售后技术支持技能组\\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n 0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx\\n 售后技术支持人员使用\\n \\n \\n \\n \\n \\n AGENT\\n 9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\n 0\\n 坐席\\n 4c2e158e-ddd9-464a-a3fc-338eca10xxxx\\n \\n \\n xxx\\n xxx\\n xxx\\n \\n \\n \\n \\n \\n xinyan\\n IT\\n 1783922****@163.com\\n 12345****\\n 馨言\\n \\n \\n
\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '获取一个技能组的用户列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListSkillGroupStates' => [
'summary' => '技能组瞬时状态列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
'docRequired' => true,
],
],
[
'name' => 'SkillGroupIds',
'in' => 'query',
'schema' => [
'description' => '技能组ID列表,使用’,’隔开,最多50个技能组;不传查询全部。',
'type' => 'string',
'required' => false,
'example' => '{"SkillGroup":[{"SkillGroupName":"Default","SkillGroupId":"014a9696-931d-49db-ae96-111d2098a548"}]}',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号,默认值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小,默认值为10,最大是100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'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' => '66BD5D25-3785-46D1-BAE7-F81920E501F2',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '报表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalCount' => [
'description' => '总个数',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RealTimeSkillGroupState' => [
'description' => '列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'WorkingAgents' => [
'description' => '话后处理坐席数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'LoggedInAgents' => [
'description' => '在线坐席数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'BreakingAgents' => [
'description' => '小休坐席数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'LongestCall' => [
'description' => '最大等待时长。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'WaitingCalls' => [
'description' => '当前排队电话个数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TalkingAgents' => [
'description' => '正在通话坐席数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SkillGroupName' => [
'description' => '技能组展示名。',
'type' => 'string',
'example' => '其他服务',
],
'SkillGroupId' => [
'description' => '技能组ID。',
'type' => 'string',
'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814',
],
'ReadyAgents' => [
'description' => '空闲坐席数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'InstanceId' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"66BD5D25-3785-46D1-BAE7-F81920E501F2\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 2,\\n \\"List\\": {\\n \\"RealTimeSkillGroupState\\": [\\n {\\n \\"WorkingAgents\\": 0,\\n \\"LoggedInAgents\\": 0,\\n \\"BreakingAgents\\": 0,\\n \\"LongestCall\\": 0,\\n \\"WaitingCalls\\": 0,\\n \\"TalkingAgents\\": 0,\\n \\"SkillGroupName\\": \\"其他服务\\",\\n \\"SkillGroupId\\": \\"8fb654c6-17c6-4501-ba57-f5ddeb919814\\",\\n \\"ReadyAgents\\": 1,\\n \\"InstanceId\\": \\"b0eb2742-f37e-4c67-82d4-25c651c1c450\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n OK\\r\\n \\r\\n 1\\r\\n 10\\r\\n 1\\r\\n \\r\\n 0\\r\\n 0\\r\\n b0eb2742-f37e-4c67-82d4-25c651c1c450\\r\\n 1\\r\\n 0\\r\\n 其他服务\\r\\n 0\\r\\n 1\\r\\n 8fb654c6-17c6-4501-ba57-f5ddeb919814\\r\\n 0\\r\\n
\\r\\n \\r\\n 66BD5D25-3785-46D1-BAE7-F81920E501F2\\r\\n true\\r\\n 200\\r\\n","errorExample":""}]',
'title' => '技能组瞬时状态列表',
'description' => '技能组瞬时状态列表,统计的范围是截止调用时间4个小时内的,存在活跃坐席的技能组的状态信息。'."\n"
."\n"
.'- 4 个小时内:是指发起统计的当前时间点,往前推 4 个小时。'."\n"
.'- 活跃坐席:是指在上述时间范围内,状态发生变化的坐席。坐席状态变化包括签入、签出、小休、外呼等。仅登录坐席工作台,而没有签入的情况,不属于活跃坐席。'."\n"
."\n"
.'因此,返回的技能组同时满足上述 2 个条件,即过去 4 小时能,该技能组内有坐席的状态发送过变化,才返回。特别的,如果某技能组,过去 4 小时内,没有坐席状态发生变化,就不会返回该技能组瞬时状态信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListSkillGroupSummaryReports' => [
'summary' => '调用接口:ListSkillGroupSummaryReports获取技能组汇总报表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
],
[
'name' => 'SkillGroupIds',
'in' => 'query',
'schema' => [
'description' => '技能组ID列表,使用“,”隔开,最多50个;不传查询全部.',
'type' => 'string',
'required' => false,
'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '起始日期,格式yyyy-MM-dd HH:mm:ss,;需要注意目前仅支持按天维度的查询,参数设置请参考案例,同时不得早于31天前的时间点。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2018-01-10 00:00:00',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '终止日期,格式yyyy-MM-dd HH:mm:ss;需要注意目前仅支持按天维度的查询,参数设置请参考案例。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2018-01-10 00:00:00',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号,默认值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小,默认值为10,最大是100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
],
'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' => '11C37A88-C5D4-4538-A768-AFFFC2397896',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'PagedSkillGroupSummaryReport' => [
'description' => '报表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalCount' => [
'description' => '总个数',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillGroupSummaryReport' => [
'description' => '列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
'SkillGroupId' => [
'description' => '技能组ID',
'type' => 'string',
'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814',
],
'SkillGroupName' => [
'description' => '技能组名称',
'type' => 'string',
'example' => '其他服务',
],
'Overall' => [
'description' => '整体指标',
'type' => 'object',
'properties' => [
'TotalLoggedInTime' => [
'description' => '总登录时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1158',
],
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'OccupancyRate' => [
'description' => '座席利用率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0.0025906735099852085',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'MaxWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxReadyTime' => [
'description' => '最大就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '480',
],
'AverageReadyTime' => [
'description' => '平均就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '225',
],
'TotalBreakTime' => [
'description' => '总小休时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TotalReadyTime' => [
'description' => '总就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1126',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'TotalCalls' => [
'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
'Inbound' => [
'description' => '呼入指标',
'type' => 'object',
'properties' => [
'AverageRingTime' => [
'description' => '平均振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsHandled' => [
'description' => '电话应答数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'QueueMaxWaitTimeDuration' => [
'description' => '队列最大等待时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'AnsweredByAgentOfQueueWaitTimeDuration' => [
'description' => '坐席接起时队列等待时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalRingTime' => [
'description' => '总振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'InComingQueueOfQueueCount' => [
'description' => '技能组呼入次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'string',
'example' => '0',
],
'MaxRingTime' => [
'description' => '最大振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsOffered' => [
'description' => '分配到坐席并振铃的次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AbandonedInQueueOfQueueCount' => [
'description' => '技能组排队放弃次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'OverFlowInQueueOfQueueCount' => [
'description' => '技能组排队超时次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AnsweredByAgentOfQueueMaxWaitTimeDuration' => [
'description' => '坐席接起时队列最大等待时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ServiceLevel20' => [
'description' => '服务水平即20s应答率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AnsweredByAgentOfQueueCount' => [
'description' => '技能组人工接起次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HandleRate' => [
'description' => '应答率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'GiveUpByAgentOfQueueCount' => [
'description' => '技能组振铃放弃次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'QueueWaitTimeDuration' => [
'description' => '队列等待时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Outbound' => [
'description' => '呼出指标',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'MaxDialingTime' => [
'description' => '最大拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '14',
],
'CallsDialed' => [
'description' => '电话拨号量。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'CallsAnswered' => [
'description' => '电话接通量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AnswerRate' => [
'description' => '接通率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0.5',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'MaxWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'TotalDialingTime' => [
'description' => '总拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '28',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'AverageDialingTime' => [
'description' => '平均拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '14',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"11C37A88-C5D4-4538-A768-AFFFC2397896\\",\\n \\"Success\\": true,\\n \\"PagedSkillGroupSummaryReport\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 2,\\n \\"List\\": {\\n \\"SkillGroupSummaryReport\\": [\\n {\\n \\"InstanceId\\": \\"b0eb2742-f37e-4c67-82d4-25c651c1c450\\",\\n \\"SkillGroupId\\": \\"8fb654c6-17c6-4501-ba57-f5ddeb919814\\",\\n \\"SkillGroupName\\": \\"其他服务\\",\\n \\"Overall\\": {\\n \\"TotalLoggedInTime\\": 1158,\\n \\"TotalTalkTime\\": 2,\\n \\"OccupancyRate\\": 0.0025906735099852085,\\n \\"TotalWorkTime\\": 1,\\n \\"MaxWorkTime\\": 1,\\n \\"AverageWorkTime\\": 1,\\n \\"AverageTalkTime\\": 2,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 480,\\n \\"AverageReadyTime\\": 225,\\n \\"TotalBreakTime\\": 1,\\n \\"TotalReadyTime\\": 1126,\\n \\"MaxTalkTime\\": 2,\\n \\"TotalCalls\\": 1\\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 },\\n \\"Outbound\\": {\\n \\"TotalTalkTime\\": 2,\\n \\"MaxDialingTime\\": 14,\\n \\"CallsDialed\\": 2,\\n \\"CallsAnswered\\": 0,\\n \\"AnswerRate\\": 0.5,\\n \\"TotalWorkTime\\": 1,\\n \\"MaxWorkTime\\": 1,\\n \\"TotalDialingTime\\": 28,\\n \\"AverageTalkTime\\": 2,\\n \\"AverageWorkTime\\": 1,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxTalkTime\\": 2,\\n \\"AverageDialingTime\\": 14\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n 1\\r\\n 10\\r\\n 1\\r\\n \\r\\n b0eb2742-f37e-4c67-82d4-25c651c1c450\\r\\n \\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n \\r\\n \\r\\n 2\\r\\n 2\\r\\n 1\\r\\n 14\\r\\n 2\\r\\n 14\\r\\n 0\\r\\n 0\\r\\n 28\\r\\n 0.5\\r\\n 1\\r\\n 2\\r\\n 1\\r\\n 1\\r\\n 0\\r\\n \\r\\n \\r\\n 480\\r\\n 2\\r\\n 2\\r\\n 1\\r\\n 1158\\r\\n 1126\\r\\n 1\\r\\n 0\\r\\n 0\\r\\n 1\\r\\n 225\\r\\n 2\\r\\n 1\\r\\n 1\\r\\n 0.0025906735099852085\\r\\n 0\\r\\n \\r\\n 其他服务\\r\\n 8fb654c6-17c6-4501-ba57-f5ddeb919814\\r\\n
\\r\\n \\r\\n OK\\r\\n 11C37A88-C5D4-4538-A768-AFFFC2397896\\r\\n true\\r\\n 200\\r\\n","errorExample":""}]',
'title' => '获取技能组汇总报表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListSkillGroupSummaryReportsByInterval' => [
'summary' => '技能组的分段汇总报表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccOQKOLI',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
],
[
'name' => 'SkillGroupIds',
'in' => 'query',
'schema' => [
'description' => '技能组ID列表,使用“,”隔开,最多50个;不传查询全部。',
'type' => 'string',
'required' => false,
'example' => '3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0',
],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'description' => '间隔类型。'."\n"
."\n"
.'- Daily:天'."\n"
.'- Minute5:5分钟',
'type' => 'string',
'required' => false,
'example' => 'Daily',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '起始日期,格式yyyy-MM-dd HH:mm:ss,不得早于6个月前的时间点',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2018-10-20 00:00:00',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '终止日期,格式yyyy-MM-dd HH:mm:ss',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2018-10-20 00:00:00',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号,默认值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小,默认值为10,最大是100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
],
'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' => '943D8EF3-3321-471F-A104-51C96FCA94D6',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'PagedSkillGroupSummaryReport' => [
'description' => '报表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalCount' => [
'description' => '总个数',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillGroupTimeIntervalReport' => [
'description' => '列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SkillGroupId' => [
'description' => '技能组ID',
'type' => 'string',
'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814',
],
'IntervalList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillGroupSummaryReport' => [
'description' => '列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Timestamp' => [
'description' => '日期,格式yyyy-MM-dd HH:mm:ss',
'type' => 'string',
'example' => '2018-09-12 15:45:00',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
'SkillGroupName' => [
'description' => '技能组名称',
'type' => 'string',
'example' => '其他服务',
],
'SkillGroupId' => [
'description' => '技能组ID',
'type' => 'string',
'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814',
],
'Overall' => [
'description' => '整体指标',
'type' => 'object',
'properties' => [
'TotalLoggedInTime' => [
'description' => '总登录时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'OccupancyRate' => [
'description' => '座席利用率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxReadyTime' => [
'description' => '最大就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageReadyTime' => [
'description' => '平均就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalBreakTime' => [
'description' => '总小休时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalReadyTime' => [
'description' => '总就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalCalls' => [
'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Inbound' => [
'description' => '呼入指标',
'type' => 'object',
'properties' => [
'AverageRingTime' => [
'description' => '平均振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsHandled' => [
'description' => '电话应答数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'QueueMaxWaitTimeDuration' => [
'description' => '队列最大等待时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'AnsweredByAgentOfQueueWaitTimeDuration' => [
'description' => '坐席接起时队列等待时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalRingTime' => [
'description' => '总振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'InComingQueueOfQueueCount' => [
'description' => '技能组呼入次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxRingTime' => [
'description' => '最大振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsOffered' => [
'description' => '电话呼入数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AbandonedInQueueOfQueueCount' => [
'description' => '技能组排队放弃次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'OverFlowInQueueOfQueueCount' => [
'description' => '技能组排队超时次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AnsweredByAgentOfQueueMaxWaitTimeDuration' => [
'description' => '坐席接起时队列最大等待时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ServiceLevel20' => [
'description' => '20s应答率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AnsweredByAgentOfQueueCount' => [
'description' => '技能组人工接起次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HandleRate' => [
'description' => '应答率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'GiveUpByAgentOfQueueCount' => [
'description' => '技能组振铃放弃次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'QueueWaitTimeDuration' => [
'description' => '队列等待时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Outbound' => [
'description' => '呼出指标',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '11',
],
'MaxDialingTime' => [
'description' => '最大拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '9',
],
'CallsDialed' => [
'description' => '电话拨号量。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'CallsAnswered' => [
'description' => '电话接通量。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'AnswerRate' => [
'description' => '接通率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0.5',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '4',
],
'MaxWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '4',
],
'TotalDialingTime' => [
'description' => '总拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '9',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '11',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '4',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '11',
],
'AverageDialingTime' => [
'description' => '平均拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '4',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Success\\": true,\\n \\"PagedSkillGroupSummaryReport\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 2,\\n \\"List\\": {\\n \\"SkillGroupTimeIntervalReport\\": [\\n {\\n \\"SkillGroupId\\": \\"8fb654c6-17c6-4501-ba57-f5ddeb919814\\",\\n \\"IntervalList\\": {\\n \\"SkillGroupSummaryReport\\": [\\n {\\n \\"Timestamp\\": \\"2018-09-12 15:45:00\\",\\n \\"InstanceId\\": \\"b0eb2742-f37e-4c67-82d4-25c651c1c450\\",\\n \\"SkillGroupName\\": \\"其他服务\\",\\n \\"SkillGroupId\\": \\"8fb654c6-17c6-4501-ba57-f5ddeb919814\\",\\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 },\\n \\"Outbound\\": {\\n \\"TotalTalkTime\\": 11,\\n \\"MaxDialingTime\\": 9,\\n \\"CallsDialed\\": 2,\\n \\"CallsAnswered\\": 1,\\n \\"AnswerRate\\": 0.5,\\n \\"TotalWorkTime\\": 4,\\n \\"MaxWorkTime\\": 4,\\n \\"TotalDialingTime\\": 9,\\n \\"AverageTalkTime\\": 11,\\n \\"AverageWorkTime\\": 4,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxTalkTime\\": 11,\\n \\"AverageDialingTime\\": 4\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n 1\\r\\n 10\\r\\n 1\\r\\n \\r\\n \\r\\n b0eb2742-f37e-4c67-82d4-25c651c1c450\\r\\n \\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n \\r\\n \\r\\n 11\\r\\n 11\\r\\n 4\\r\\n 9\\r\\n 2\\r\\n 4\\r\\n 0\\r\\n 0\\r\\n 9\\r\\n 0.5\\r\\n 1\\r\\n 11\\r\\n 4\\r\\n 4\\r\\n 0\\r\\n \\r\\n \\r\\n 3282\\r\\n 11\\r\\n 11\\r\\n 4\\r\\n 3360\\r\\n 3336\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 1\\r\\n 1112\\r\\n 11\\r\\n 4\\r\\n 4\\r\\n 0.004464285913854837\\r\\n 0\\r\\n \\r\\n 其他服务\\r\\n 8fb654c6-17c6-4501-ba57-f5ddeb919814\\r\\n 2018-09-12 15:45:00\\r\\n \\r\\n 8fb654c6-17c6-4501-ba57-f5ddeb919814\\r\\n
\\r\\n \\r\\n OK\\r\\n 9B28CADE-B821-42B7-BB9E-1F6090F0888D\\r\\n true\\r\\n 200\\r\\n","errorExample":""}]',
'title' => '技能组的分段汇总报表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListSkillGroupSummaryReportsSinceMidnight' => [
'summary' => '技能组当天汇总报表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
],
[
'name' => 'SkillGroups',
'in' => 'query',
'schema' => [
'description' => '技能组ID列表,使用“,”隔开,最多50个坐席;不传查询全部。',
'type' => 'string',
'required' => false,
'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号,默认值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小,默认值为10,最大是100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
],
'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' => '19D09CCC-F298-4124-849A-AFA217819011',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'PagedSkillGroupSummaryReport' => [
'description' => '报表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总个数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillGroupSummaryReport' => [
'description' => '列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Timestamp' => [
'description' => '日期'."\n"
."\n"
.'格式yyyy-MM-dd HH:mm:ss',
'type' => 'string',
'example' => '2018-09-13 00:00:00',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450',
],
'SkillGroupName' => [
'description' => '技能组名称',
'type' => 'string',
'example' => '其他服务',
],
'SkillGroupId' => [
'description' => '技能组ID',
'type' => 'string',
'example' => '8fb654c6-17c6-4501-ba57-f5ddeb919814',
],
'Overall' => [
'description' => '整体指标',
'type' => 'object',
'properties' => [
'TotalLoggedInTime' => [
'description' => '总登录时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '516',
],
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'OccupancyRate' => [
'description' => '座席利用率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxReadyTime' => [
'description' => '最大就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '398',
],
'AverageReadyTime' => [
'description' => '平均就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '51',
],
'TotalBreakTime' => [
'description' => '总小休时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalReadyTime' => [
'description' => '总就绪时长,单位为秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '515',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalCalls' => [
'description' => '总电话接待量。包括应答的呼入电话和接通的呼出电话。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Inbound' => [
'description' => '呼入指标',
'type' => 'object',
'properties' => [
'AverageRingTime' => [
'description' => '平均振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsHandled' => [
'description' => '电话应答数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'QueueMaxWaitTimeDuration' => [
'description' => '队列最大等待时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'AnsweredByAgentOfQueueWaitTimeDuration' => [
'description' => '坐席接起时队列等待时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalRingTime' => [
'description' => '总振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'InComingQueueOfQueueCount' => [
'description' => '技能组呼入次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'string',
'example' => '0',
],
'MaxRingTime' => [
'description' => '最大振铃时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsOffered' => [
'description' => '分配到坐席并振铃的次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AbandonedInQueueOfQueueCount' => [
'description' => '技能组排队放弃次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'OverFlowInQueueOfQueueCount' => [
'description' => '技能组排队超时次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AnsweredByAgentOfQueueMaxWaitTimeDuration' => [
'description' => '坐席接起时队列最大等待时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ServiceLevel20' => [
'description' => '20s应答率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AnsweredByAgentOfQueueCount' => [
'description' => '技能组人工接起次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HandleRate' => [
'description' => '应答率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'GiveUpByAgentOfQueueCount' => [
'description' => '技能组振铃放弃次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'QueueWaitTimeDuration' => [
'description' => '队列等待时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsServiceLevel20' => [
'description' => '等待20s内坐席接起次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsServiceLevel30' => [
'description' => '等待30s内坐席接起次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
'Outbound' => [
'description' => '呼出指标',
'type' => 'object',
'properties' => [
'TotalTalkTime' => [
'description' => '总通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxDialingTime' => [
'description' => '最大拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsDialed' => [
'description' => '电话拨号量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'CallsAnswered' => [
'description' => '电话接通量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AnswerRate' => [
'description' => '接通率,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'TotalWorkTime' => [
'description' => '总话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxWorkTime' => [
'description' => '最大话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalDialingTime' => [
'description' => '总拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageTalkTime' => [
'description' => '平均通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageWorkTime' => [
'description' => '平均话后处理时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionIndex' => [
'description' => '满意度指数,单位%。',
'type' => 'number',
'format' => 'float',
'example' => '0',
],
'SatisfactionSurveysOffered' => [
'description' => '满意度调查发送次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SatisfactionSurveysResponded' => [
'description' => '满意度调查响应次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'MaxTalkTime' => [
'description' => '最大通话时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AverageDialingTime' => [
'description' => '平均拨号时长,单位秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"19D09CCC-F298-4124-849A-AFA217819011\\",\\n \\"Success\\": true,\\n \\"PagedSkillGroupSummaryReport\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": {\\n \\"SkillGroupSummaryReport\\": [\\n {\\n \\"Timestamp\\": \\"2018-09-13 00:00:00\\",\\n \\"InstanceId\\": \\"b0eb2742-f37e-4c67-82d4-25c651c1c450\\",\\n \\"SkillGroupId\\": \\"8fb654c6-17c6-4501-ba57-f5ddeb919814\\",\\n \\"SkillGroupName\\": \\"其他服务\\",\\n \\"Overall\\": {\\n \\"TotalLoggedInTime\\": 516,\\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\\": 398,\\n \\"AverageReadyTime\\": 51,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalReadyTime\\": 515,\\n \\"TotalBreakTime\\": 0,\\n \\"TotalCalls\\": 0\\n },\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"CallsServiceLevel20\\": 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 \\"CallsServiceLevel30\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"GiveUpByAgentOfQueueCount\\": 0,\\n \\"QueueWaitTimeDuration\\": 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 }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n \\r\\n 1\\r\\n 10\\r\\n 1\\r\\n \\r\\n b0eb2742-f37e-4c67-82d4-25c651c1c450\\r\\n \\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n \\r\\n \\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n \\r\\n \\r\\n 398\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 516\\r\\n 515\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 51\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n 0\\r\\n \\r\\n 其他服务\\r\\n 8fb654c6-17c6-4501-ba57-f5ddeb919814\\r\\n 2018-09-13 00:00:00\\r\\n
\\r\\n \\r\\n OK\\r\\n AF01C793-2983-48BB-8F2C-1A33A3BD0B94\\r\\n true\\r\\n 200\\r\\n","errorExample":""}]',
'title' => '技能组当天汇总报表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListTransferableSkillGroups' => [
'summary' => '调用接口:ListTransferableSkillGroups 获取呼叫中心实例的可转接技能组。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息'."\n"
."\n",
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID'."\n"
."\n",
'type' => 'string',
'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE',
],
'Success' => [
'description' => '是否成功'."\n"
."\n",
'type' => 'boolean',
'example' => 'true',
],
'SkillGroups' => [
'description' => '待转接技能组信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AllowPrivateOutboundNumber' => [
'description' => '是否允许技能组内用户使用个人外呼号码',
'type' => 'boolean',
'example' => 'false',
],
'RoutingStrategy' => [
'description' => '路由策略',
'type' => 'string',
'example' => '无',
],
'SkillGroupName' => [
'description' => '技能组名称',
'type' => 'string',
'example' => 'test',
],
'SkillGroupId' => [
'description' => '技能组ID',
'type' => 'string',
'example' => '223048-9cf-4a53-ab6e-b13e3fb31f7d ',
],
'UserCount' => [
'description' => '归属于该技能组的座席数量',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'AccQueueName' => [
'description' => 'acc队列名字',
'type' => 'string',
'example' => '无',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d ',
],
'SkillGroupDescription' => [
'description' => '技能组描述信息',
'type' => 'string',
'example' => 'test',
],
'AccSkillGroupName' => [
'description' => 'acc技能组名字',
'type' => 'string',
'example' => '无',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ParameterNull',
'errorMessage' => 'Parameter \'%s\' can not be null or empty.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"Success\\": true,\\n \\"SkillGroups\\": [\\n {\\n \\"AllowPrivateOutboundNumber\\": false,\\n \\"RoutingStrategy\\": \\"无\\",\\n \\"SkillGroupName\\": \\"test\\",\\n \\"SkillGroupId\\": \\"223048-9cf-4a53-ab6e-b13e3fb31f7d\\\\t\\",\\n \\"UserCount\\": 10,\\n \\"AccQueueName\\": \\"无\\",\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\\\t\\",\\n \\"SkillGroupDescription\\": \\"test\\",\\n \\"AccSkillGroupName\\": \\"无\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\n200\\n\\n false\\n test\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\n 10\\n 223048-9cf-4a53-ab6e-b13e3fb31f7d\\n test\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '获取呼叫中心实例的可转接技能组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListSkillGroups' => [
'summary' => '调用ListSkillGroups获取呼叫中心实例的所有技能组。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccPBOQGO',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待获取技能组的呼叫中心实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '技能组ID。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '0ee27b3b-6765-499a-a741-61b16a901e51',
'maxItems' => 500,
],
],
[
'name' => 'SkillGroupName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '技能组名称。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'example' => '售前技能组',
'maxItems' => 500,
],
],
],
'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' => '19D09CCC-F298-4124-849A-AFA217819011',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SkillGroups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillGroup' => [
'description' => '获取的呼叫中心实例的技能组列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RoutingStrategy' => [
'description' => '匹配方式',
'type' => 'string',
'example' => 'default',
],
'SkillGroupId' => [
'description' => '技能组唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '0ee27b3b-6765-499a-a741-61b16a901e51',
],
'SkillGroupName' => [
'description' => '技能组名字,需要在所归属的呼叫中心实例中唯一。',
'type' => 'string',
'example' => 'Default',
],
'UserCount' => [
'description' => '归属于该技能组的座席数量',
'type' => 'integer',
'format' => 'int32',
'example' => '14',
],
'InstanceId' => [
'description' => '技能组所归属的呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
'AccQueueName' => [
'description' => 'acc队列名字',
'type' => 'string',
'example' => 'AliQ_acc2631_0ee27b3b-6765-499a-a741-61b16a901e51',
],
'AccSkillGroupName' => [
'description' => 'acc技能组名字',
'type' => 'string',
'example' => 'AliS_acc2631_0ee27b3b-6765-499a-a741-61b16a901e51',
],
'SkillGroupDescription' => [
'description' => '技能组简单描述',
'type' => 'string',
'example' => '默认技能组',
],
'OutboundPhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PhoneNumber' => [
'description' => '技能组能否拨打外线以及拨打外线时所使用的电话号码',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TestOnly' => [
'description' => '是否是测试号码',
'type' => 'boolean',
'example' => 'false',
],
'Trunks' => [
'description' => '电话号码的中继数量,即可同时支持几路通话,数据来源于大于。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RemainingTime' => [
'description' => '测试号码剩余的通话时间。单位为分钟。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Number' => [
'description' => '电话号码',
'type' => 'string',
'example' => '02566040852',
],
'InstanceId' => [
'description' => '电话号码所归属的呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
'Usage' => [
'description' => '电话号码的用途,呼入(Inbound),呼出(Outbound),以及同时用于呼入和呼出(Bidirection)。',
'type' => 'string',
'example' => 'Inbound',
],
'AllowOutbound' => [
'description' => '是否允许外呼。',
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumberDescription' => [
'description' => '电话号码的简单描述',
'type' => 'string',
'example' => 'Ali Telecom',
],
'PhoneNumberId' => [
'description' => '电话号码ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => 'f49392e1-9714-42b1-a15a-9a2f0cd88ef1',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"19D09CCC-F298-4124-849A-AFA217819011\\",\\n \\"Success\\": true,\\n \\"SkillGroups\\": {\\n \\"SkillGroup\\": [\\n {\\n \\"RoutingStrategy\\": \\"default\\",\\n \\"SkillGroupId\\": \\"0ee27b3b-6765-499a-a741-61b16a901e51\\",\\n \\"SkillGroupName\\": \\"Default\\",\\n \\"UserCount\\": 14,\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\",\\n \\"AccQueueName\\": \\"AliQ_acc2631_0ee27b3b-6765-499a-a741-61b16a901e51\\",\\n \\"SkillGroupDescription\\": \\"默认技能组\\",\\n \\"AccSkillGroupName\\": \\"AliS_acc2631_0ee27b3b-6765-499a-a741-61b16a901e51\\",\\n \\"OutboundPhoneNumbers\\": {\\n \\"PhoneNumber\\": [\\n {\\n \\"TestOnly\\": false,\\n \\"Trunks\\": 1,\\n \\"Number\\": \\"02566040852\\",\\n \\"RemainingTime\\": 0,\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\",\\n \\"PhoneNumberDescription\\": \\"Ali Telecom\\",\\n \\"AllowOutbound\\": true,\\n \\"Usage\\": \\"Inbound\\",\\n \\"PhoneNumberId\\": \\"f49392e1-9714-42b1-a15a-9a2f0cd88ef1\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n 19D09CCC-F298-4124-849A-AFA217819011\\r\\n \\r\\n \\r\\n 4\\r\\n AliS_acc2631_bb009681-b660-49fa-8ae3-3b84899f46b0\\r\\n \\r\\n \\r\\n \\r\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\r\\n 售前技能组\\r\\n AliQ_acc2631_bb009681-b660-49fa-8ae3-3b84899f46b0\\r\\n bb009681-b660-49fa-8ae3-3b84899f46b0\\r\\n \\r\\n \\r\\n 14\\r\\n AliS_acc2631_0ee27b3b-6765-499a-a741-61b16a901e51\\r\\n \\r\\n \\r\\n f49392e1-9714-42b1-a15a-9a2f0cd88ef1\\r\\n 1\\r\\n true\\r\\n 02566040852\\r\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\r\\n false\\r\\n Ali Telecom\\r\\n Bidirection\\r\\n 0\\r\\n \\r\\n \\r\\n 默认技能组\\r\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\r\\n Default\\r\\n AliQ_acc2631_0ee27b3b-6765-499a-a741-61b16a901e51\\r\\n 0ee27b3b-6765-499a-a741-61b16a901e51\\r\\n \\r\\n \\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '获取呼叫中心实例的所有技能组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListSkillGroupsOfUser' => [
'summary' => '调用ListSkillGroupsOfUser获取坐席所归属的技能组列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccPBOQGO',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '待获取技能组列表的用户ID。'."\n"
."\n"
.'注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId,即UUID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c8b21767-bd0e-4a6e-937e-c46cd07fxxxx',
],
],
],
'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' => 'E35B41EA-C06C-44D6-8BE9-9FE8960641FD',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'SkillLevels' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SkillLevel' => [
'description' => '用户所属的技能组列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SkillLevelId' => [
'description' => '技能级别唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '116786',
],
'Level' => [
'description' => '技能级别',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'Skill' => [
'description' => '技能',
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '技能组所归属的呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx',
],
'RoutingStrategy' => [
'description' => '匹配方式',
'type' => 'string',
'example' => 'default',
],
'SkillGroupDescription' => [
'description' => '技能组简单描述',
'type' => 'string',
'example' => '售后技术支持人员使用',
],
'SkillGroupName' => [
'description' => '技能组名字,需要在所归属的呼叫中心实例中唯一。',
'type' => 'string',
'example' => '售后技术支持技能组',
],
'SkillGroupId' => [
'description' => '技能组唯一ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx',
],
'OutboundPhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PhoneNumber' => [
'description' => '技能组能否拨打外线以及拨打外线时所使用的电话号码',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TestOnly' => [
'description' => '是否是测试号码',
'type' => 'boolean',
'example' => 'false',
],
'Trunks' => [
'description' => '电话号码的中继数量,即可同时支持几路通话,数据来源于大于。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RemainingTime' => [
'description' => '测试号码剩余的通话时间。单位为分钟。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Number' => [
'description' => '电话号码',
'type' => 'string',
'example' => '0108648xxxx',
],
'City' => [
'description' => '号码归属地市。',
'type' => 'string',
'example' => '北京',
],
'InstanceId' => [
'description' => '电话号码所归属的呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
'Usage' => [
'description' => '电话号码的用途,呼入,呼出,已经同时用于呼入和呼出。 Inbound, Outbound, Bidirection。上述值由枚举类型PhoneNumberType定义。该值的结果取决于1)大于的设置,比如400号码不允许外呼 2)呼叫中心实例的设置。电话号码一般都允许内呼,如果不允许内呼,可以1)由大于做设置,用户拨打该号码时听到提示音 2)该号码不连接人和联系流IVR,但是ACC不建议这么做。',
'type' => 'string',
'example' => 'Bidirection',
],
'AllowOutbound' => [
'description' => '是否允许外呼,结果取决于1)大于的设置,比如400号码不允许外呼 2)呼叫中心实例的设置。电话号码一般都允许内呼,如果不允许内呼,可以1)由大于做设置,用户拨打该号码时听到提示音 2)该号码不绑定联系流IVR,但是ACC不建议这么做。',
'type' => 'boolean',
'example' => 'true',
],
'PhoneNumberDescription' => [
'description' => '电话号码的简单描述',
'type' => 'string',
'example' => 'Ali Telecom',
],
'Province' => [
'description' => '号码归属地省。',
'type' => 'string',
'example' => '北京',
],
'PhoneNumberId' => [
'description' => '电话号码ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '2ead4b47-db37-43b3-8e32-ae71d81620af',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E35B41EA-C06C-44D6-8BE9-9FE8960641FD\\",\\n \\"Success\\": true,\\n \\"SkillLevels\\": {\\n \\"SkillLevel\\": [\\n {\\n \\"SkillLevelId\\": \\"116786\\",\\n \\"Level\\": 5,\\n \\"Skill\\": {\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb3xxxx\\",\\n \\"RoutingStrategy\\": \\"default\\",\\n \\"SkillGroupDescription\\": \\"售后技术支持人员使用\\",\\n \\"SkillGroupName\\": \\"售后技术支持技能组\\",\\n \\"SkillGroupId\\": \\"0ead7334-83e7-42a0-a5bd-c2ef9f18xxxx\\",\\n \\"OutboundPhoneNumbers\\": {\\n \\"PhoneNumber\\": [\\n {\\n \\"TestOnly\\": false,\\n \\"Trunks\\": 1,\\n \\"RemainingTime\\": 0,\\n \\"Number\\": \\"0108648xxxx\\",\\n \\"City\\": \\"北京\\",\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"AllowOutbound\\": true,\\n \\"PhoneNumberDescription\\": \\"Ali Telecom\\",\\n \\"Province\\": \\"北京\\",\\n \\"PhoneNumberId\\": \\"2ead4b47-db37-43b3-8e32-ae71d81620af\\"\\n }\\n ]\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n E35B41EA-C06C-44D6-8BE9-9FE8960641FD\\r\\n true\\r\\n OK\\r\\n \\r\\n \\r\\n 121145\\r\\n \\r\\n \\r\\n \\r\\n 2ead4b47-db37-43b3-8e32-ae71d81620af\\r\\n 1\\r\\n true\\r\\n 01086486105\\r\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\r\\n false\\r\\n Ali Telecom\\r\\n 北京\\r\\n 北京\\r\\n Bidirection\\r\\n 0\\r\\n \\r\\n \\r\\n 售后技术支持人员使用\\r\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\r\\n 售后技术支持技能组\\r\\n 0ead7334-83e7-42a0-a5bd-c2ef9f18ef28\\r\\n \\r\\n 5\\r\\n \\r\\n \\r\\n 116786\\r\\n \\r\\n \\r\\n \\r\\n f49392e1-9714-42b1-a15a-9a2f0cd88ef1\\r\\n 1\\r\\n true\\r\\n 02566040852\\r\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\r\\n false\\r\\n Ali Telecom\\r\\n Bidirection\\r\\n 0\\r\\n \\r\\n \\r\\n 默认技能组\\r\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\r\\n Default\\r\\n 0ee27b3b-6765-499a-a741-61b16a901e51\\r\\n \\r\\n 5\\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '获取坐席所归属的技能组列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RemoveUsersFromSkillGroup' => [
'summary' => '调用RemoveUsersFromSkillGroup从一个技能组中移除用户。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '待移除用户的呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '18b4f6bd-12f7-4ab6-91d1-bf43b854f35c',
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => [
'description' => '待移除用户的技能组ID',
'type' => 'string',
'required' => true,
'example' => 'b9458ffa-b3aa-4747-acb0-f0c8acbabe95',
],
],
[
'name' => 'UserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待移除的技能组中的用户ID。'."\n"
."\n"
.'**UserId.1**意为只移除一个坐席,如果移除多个,则需要传多个,例如 UserId.1、UserId.2、UserId.3,以此类推。注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId,即UUID。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => 'ad7dea7f-c735-4f00-a725-7278d7e802dd',
'maxItems' => 99,
],
],
],
'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' => 'AF9834D8-6D09-4A1B-BADB-B019D9D444C8',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"AF9834D8-6D09-4A1B-BADB-B019D9D444C8\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 200\\r\\n AF9834D8-6D09-4A1B-BADB-B019D9D444C8\\r\\n true\\r\\n OK\\r\\n","errorExample":""}]',
'title' => '从一个技能组中移除用户',
],
'ListOutboundPhoneNumberOfUser' => [
'summary' => '调用ListOutboundPhoneNumberOfUser获取坐席的所有外呼电话列表,包含个人外呼号码及所属技能组外呼号码。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3****',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '待获取外呼号码列表的用户ID。'."\n"
."\n"
.'> 这里是RAM子账号在呼叫中心实例的唯一标识并非RamId,即UUID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c8b21767-bd0e-4a6e-937e-c46cd07f****',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'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' => 'DB6F6562-C76A-4A4D-892A-F33F638C058D',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'NumberList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Number' => [
'type' => 'array',
'items' => [
'description' => '真实外呼号码列表。',
'type' => 'string',
'example' => '["05712823****"]',
],
],
],
],
'OutboundPhoneNumbers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PhoneNumber' => [
'description' => '获取到的坐席拨打外线时电话号码',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PrivateFlag' => [
'description' => '标识该号码是否为个人外呼号码。',
'type' => 'boolean',
'example' => 'true',
],
'TestOnly' => [
'description' => '是否是测试号码。',
'type' => 'boolean',
'example' => 'false',
],
'SipTelX' => [
'description' => 'sip虚拟号码',
'type' => 'string',
'example' => '1302015****',
],
'RemainingTime' => [
'description' => '测试号码剩余的通话时间。单位为分钟。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'City' => [
'description' => '号码归属地市。',
'type' => 'string',
'example' => '北京',
],
'InstanceId' => [
'description' => '电话号码所归属的呼叫中心实例ID。',
'type' => 'string',
'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d****',
],
'AllowOutbound' => [
'description' => '是否允许外呼,结果取决于:'."\n"
."\n"
.'- 大于的设置,比如400号码不允许外呼'."\n"
.'- 呼叫中心实例的设置'."\n"
."\n"
.'> 电话号码一般都允许内呼,如果不允许内呼,可以1)由大于做设置,用户拨打该号码时听到提示音 2)该号码不绑定联系流IVR,但是ACC不建议这么做。',
'type' => 'boolean',
'example' => 'true',
],
'Usage' => [
'description' => '电话号码的用途,呼入(Inbound),呼出(Outbound),已经同时用于呼入和呼出(Bidirection)。上述值由枚举类型PhoneNumberType定义。'."\n"
."\n"
.'该值的结果取决于:'."\n"
."\n"
.'- 大于的设置,比如400号码不允许外呼'."\n"
.'- 呼叫中心实例的设置'."\n"
."\n\n"
.'> 电话号码一般都允许内呼,如果不允许内呼,可以1)由大于做设置,用户拨打该号码时听到提示音 2)该号码不连接人和联系流IVR,但是ACC不建议这么做。',
'type' => 'string',
'example' => 'Bidirection',
],
'PhoneNumberId' => [
'description' => '电话号码ID,系统自动生成的唯一标示符。',
'type' => 'string',
'example' => '0010faaa-0c07-4421-8929-9ea6a051****',
],
'Trunks' => [
'description' => '电话号码的中继数量,即可同时支持几路通话,数据来源于大于。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'Number' => [
'description' => '电话号码。',
'type' => 'string',
'example' => '05712823****',
],
'PhoneNumberDescription' => [
'description' => '电话号码的简单描述。',
'type' => 'string',
'example' => 'Ali Telecom',
],
'Province' => [
'description' => '号码归属地省。',
'type' => 'string',
'example' => '北京',
],
'PrivacyNumber' => [
'description' => '电话号码所绑定的虚拟号码关系。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '选择绑定虚拟号码的类型,包括**AXN**和**AXB**。',
'type' => 'string',
'example' => 'AXN',
],
'PoolId' => [
'description' => '虚拟号码所在池子ID。',
'type' => 'string',
'example' => '18b74553-484f-40c7-b6f9-81be0cbe****',
],
'SubId' => [
'description' => '类型为AXN,返回的绑定关系唯一标识,若类型为AXB,则此字段为空。',
'type' => 'string',
'example' => '6a5f6c7c2f774fb38b4aaf35c4e7****',
],
'PhoneNumber' => [
'description' => '绑定的呼叫中心号码。',
'type' => 'string',
'example' => '05712823****',
],
'PoolName' => [
'description' => '虚拟号码池名称。',
'type' => 'string',
'example' => '个人虚拟号码',
],
'BizId' => [
'description' => '第三方业务ID。',
'type' => 'string',
'example' => '4b32b62d3aae4d86a6c4bb26c3ee****',
],
'RegionNameCity' => [
'description' => '虚拟号码归属地市。',
'type' => 'string',
'example' => '上海市',
],
'Extra' => [
'description' => '其他参数,以Json字符串存入。',
'type' => 'string',
'example' => '{"name":"amy","cardno":"130226198001110819"}',
],
'TelX' => [
'description' => '选择AXN模式绑定的虚拟号码,若类型为AXB,则此字段为空。',
'type' => 'string',
'example' => '1302015****',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DB6F6562-C76A-4A4D-892A-F33F638C058D\\",\\n \\"Success\\": true,\\n \\"NumberList\\": {\\n \\"Number\\": [\\n \\"[\\\\\\"05712823****\\\\\\"]\\"\\n ]\\n },\\n \\"OutboundPhoneNumbers\\": {\\n \\"PhoneNumber\\": [\\n {\\n \\"PrivateFlag\\": true,\\n \\"TestOnly\\": false,\\n \\"SipTelX\\": \\"1302015****\\",\\n \\"RemainingTime\\": 60,\\n \\"City\\": \\"北京\\",\\n \\"InstanceId\\": \\"ade80092-03d9-4f4d-ad4f-ab8a247d****\\",\\n \\"AllowOutbound\\": true,\\n \\"Usage\\": \\"Bidirection\\",\\n \\"PhoneNumberId\\": \\"0010faaa-0c07-4421-8929-9ea6a051****\\",\\n \\"Trunks\\": 30,\\n \\"Number\\": \\"05712823****\\",\\n \\"PhoneNumberDescription\\": \\"Ali Telecom\\",\\n \\"Province\\": \\"北京\\",\\n \\"PrivacyNumber\\": {\\n \\"Type\\": \\"AXN\\",\\n \\"PoolId\\": \\"18b74553-484f-40c7-b6f9-81be0cbe****\\",\\n \\"SubId\\": \\"6a5f6c7c2f774fb38b4aaf35c4e7****\\",\\n \\"PhoneNumber\\": \\"05712823****\\",\\n \\"PoolName\\": \\"个人虚拟号码\\",\\n \\"BizId\\": \\"4b32b62d3aae4d86a6c4bb26c3ee****\\",\\n \\"RegionNameCity\\": \\"上海市\\",\\n \\"Extra\\": \\"{\\\\\\"name\\\\\\":\\\\\\"amy\\\\\\",\\\\\\"cardno\\\\\\":\\\\\\"130226198001110819\\\\\\"}\\",\\n \\"TelX\\": \\"1302015****\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nDB6F6562-C76A-4A4D-892A-F33F638C058D\\n200\\n\\n [\\"05712823****\\"]\\n\\nOK\\n\\n \\n Bidirection\\n 1302015****\\n true\\n false\\n 05712823****\\n ade80092-03d9-4f4d-ad4f-ab8a247d****\\n true\\n 60\\n 北京\\n 30\\n 0010faaa-0c07-4421-8929-9ea6a051****\\n 北京\\n Ali Telecom\\n \\n 上海市\\n AXN\\n 6a5f6c7c2f774fb38b4aaf35c4e7****\\n {\\"name\\":\\"amy\\",\\"cardno\\":\\"130226198001110819\\"}\\n 18b74553-484f-40c7-b6f9-81be0cbe****\\n 个人虚拟号码\\n 05712823****\\n 1302015****\\n 4b32b62d3aae4d86a6c4bb26c3ee****\\n \\n \\n\\ntrue","errorExample":""}]',
'title' => '获取坐席外呼号码',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListRecordings' => [
'summary' => '调用接口:ListRecordings 获取录音列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccD5GAHN',
],
],
'parameters' => [
[
'name' => 'StopTime',
'in' => 'query',
'schema' => [
'description' => '获取的历史数据的终止时间。缺省为0,代表截止到目前的时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'required' => true,
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d ',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '获取的历史数据的起始时间。缺省为0,代表从当天的0时开始。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => [
'description' => '待获取数据的呼叫中心的电话号码',
'type' => 'string',
'required' => false,
'example' => '01099998888',
],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => [
'description' => '座席ID,对应于RamId',
'type' => 'string',
'required' => false,
'example' => '2384025204570273452',
],
],
[
'name' => 'Criteria',
'in' => 'query',
'schema' => [
'description' => '搜索条件',
'type' => 'string',
'required' => false,
'example' => '01099998888',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码'."\n"
."\n",
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息'."\n"
."\n",
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID'."\n"
."\n",
'type' => 'string',
'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE',
],
'Success' => [
'description' => '是否成功'."\n"
."\n",
'type' => 'boolean',
'example' => 'true',
],
'Recordings' => [
'description' => '录音信息集合',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int32',
'example' => '29',
],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Recording' => [
'description' => '录音信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ContactType' => [
'description' => '通话类型, 参考枚举类型 ContactType,Inbound 内呼, Outbound 外呼',
'type' => 'string',
'example' => 'Outbound',
],
'AgentId' => [
'description' => '座席ID,对应于RamId',
'type' => 'string',
'example' => '2384025204570273452',
],
'AgentName' => [
'description' => '座席名称',
'type' => 'string',
'example' => 'ccctest1',
],
'InstanceId' => [
'description' => '呼叫中心实例ID',
'type' => 'string',
'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d',
],
'FileName' => [
'description' => '录音文件名',
'type' => 'string',
'example' => '8420398402-45937.wav',
],
'CalledNumber' => [
'description' => '被叫电话',
'type' => 'string',
'example' => '1870169190889',
],
'StartTime' => [
'description' => '通话开始时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1576295278000',
],
'FilePath' => [
'description' => '录音文件在OSS中的保存位置',
'type' => 'string',
'example' => 'oss://cloudcall-test/',
],
'ContactId' => [
'description' => '通话ID',
'type' => 'string',
'example' => '209887678',
],
'CallingNumber' => [
'description' => '主叫电话',
'type' => 'string',
'example' => '01099998888',
],
'Duration' => [
'description' => '通话时长',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'FileDescription' => [
'description' => '录音文件别名',
'type' => 'string',
'example' => '无',
],
'Channel' => [
'description' => '座席所在音轨标示',
'type' => 'string',
'example' => '无',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"Success\\": true,\\n \\"Recordings\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 29,\\n \\"List\\": {\\n \\"Recording\\": [\\n {\\n \\"ContactType\\": \\"Outbound\\",\\n \\"AgentId\\": \\"2384025204570273452\\",\\n \\"AgentName\\": \\"ccctest1\\",\\n \\"InstanceId\\": \\"9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\",\\n \\"FileName\\": \\"8420398402-45937.wav\\",\\n \\"CalledNumber\\": \\"1870169190889\\",\\n \\"StartTime\\": 1576295278000,\\n \\"FilePath\\": \\"oss://cloudcall-test/\\",\\n \\"ContactId\\": \\"209887678\\",\\n \\"CallingNumber\\": \\"01099998888\\",\\n \\"Duration\\": 50,\\n \\"FileDescription\\": \\"无\\",\\n \\"Channel\\": \\"无\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"无\\nDE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\n200\\n\\n 29\\n 10\\n 1\\n \\n \\n oss://cloudcall-test/\\n 1870169190889\\n Outbound\\n 9cfad875-6260-4a53-ab6e-b13e3fb31f7d\\n 8420398402-45937.wav\\n 1576295278000\\n 50\\n 209887678\\n 1099998888\\n ccctest1\\n 2384025204570273300\\n \\n
\\n\\nOK\\ntrue","errorExample":""}]',
'title' => '获取录音列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifySkillGroupBasicInfo' => [
'summary' => '修改技能组基础信息,包括技能组名称、技能组描述、匹配模式、个人外呼号码标识等基础信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREcccPBOQGO',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'SkillGroupId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'RoutingStrategy',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AllowPrivateOutboundNumber',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'type' => 'integer',
'format' => 'int32',
],
'Code' => [
'type' => 'string',
],
'Message' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
],
],
],
],
],
],
'endpoints' => [
[
'regionId' => 'cn-shanghai',
'endpoint' => 'ccc.cn-shanghai.aliyuncs.com',
],
],
];