'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'aiccs', 'version' => '2019-10-15', ], 'directories' => [ [ 'id' => 208943, 'title' => '通信智能体', 'type' => 'directory', 'children' => [ 'QueryConversationDetailInfoNew', 'ImportOneTaskPhoneNumber', 'QueryAiVoiceAgentDetail', 'PageQueryAgentList', 'QueryConversationDetailInfo', 'QueryAiCallDetailPage', 'StopAiCallTask', 'CancelAiCallDetails', 'StartAiCallTask', 'UpdateAiCallTask', 'QueryAiCallTaskPage', 'QueryAiCallTaskDetail', 'ImportTaskNumberDatas', 'CreateAiCallTask', ], ], [ 'id' => 200032, 'title' => '通信智能引擎', 'type' => 'directory', 'children' => [ 'LlmSmartCall', 'LlmSmartCallEncrypt', 'HangupOperate', 'ListAvailableTts', 'GetCallDialogContent', ], ], [ 'id' => 164279, 'title' => '热线监控数据', 'type' => 'directory', 'children' => [ 'GetHotlineServiceStatistics', 'GetSkillGroupAndAgentStatusSummary', 'GetDepartmentalLatitudeAgentStatus', 'GetSkillGroupLatitudeState', 'GetAgentBasisStatus', 'GetAgentStatistics', ], ], [ 'id' => 164286, 'title' => '在线监控数据', 'type' => 'directory', 'children' => [ 'GetOnlineServiceVolume', 'GetSeatInformation', 'GetSkillGroupServiceCapability', 'GetSkillGroupAgentStatusDetails', 'GetOnlineSeatInformation', 'GetQueueInformation', ], ], [ 'id' => 164293, 'title' => '热线报表数据', 'type' => 'directory', 'children' => [ 'GetSkillGroupStatusTotal', 'GetAgentDetailReport', ], ], [ 'id' => 164296, 'title' => '在线报表数据', 'type' => 'directory', 'children' => [ 'GetSkillGroupServiceStatus', 'GetAgentServiceStatus', ], ], [ 'id' => 164299, 'title' => '坐席管理', 'type' => 'directory', 'children' => [ 'CreateAgent', 'DeleteAgent', 'UpdateAgent', 'GetAgent', 'ListAgentBySkillGroupId', 'GetHotlineAgentStatus', 'RemoveAgentFromSkillGroup', 'GetHotlineAgentDetail', ], ], [ 'id' => 164308, 'title' => '技能组管理', 'type' => 'directory', 'children' => [ 'CreateSkillGroup', 'UpdateSkillGroup', 'RemoveSkillGroup', 'QuerySkillGroups', 'ListSkillGroup', 'GetDepGroupTreeData', ], ], [ 'id' => 164315, 'title' => '部门管理', 'type' => 'directory', 'children' => [ 'CreateDepartment', 'GetAllDepartment', 'DeleteDepartment', 'UpdateDepartment', ], ], [ 'id' => 164333, 'title' => '通道', 'type' => 'directory', 'children' => [ 'GenerateWebSocketSign', ], ], [ 'id' => 164335, 'title' => '通话详情', 'type' => 'directory', 'children' => [ 'HotlineSessionQuery', 'GetRecordData', 'GetRecordUrl', 'DescribeRecordData', ], ], [ 'id' => 164340, 'title' => '数据统计', 'type' => 'directory', 'children' => [ 'GetIndexCurrentValue', 'GetAgentIndexRealTime', 'GetHotlineAgentDetailReport', 'GetHotlineGroupDetailReport', ], ], [ 'id' => 164345, 'title' => '会话数据', 'type' => 'directory', 'children' => [ 'QueryTouchList', 'GetCustomerInfo', 'GetHotlineMessageLog', 'GetHotlineCallAction', ], ], [ 'id' => 164350, 'title' => '机器人外呼', 'type' => 'directory', 'children' => [ 'RobotCall', 'ListRobotCallDialog', 'ListAiccsRobot', 'ListRobotParams', 'GetCallSoundRecord', 'ListRobotNode', ], ], [ 'id' => 164357, 'title' => '机器人外呼任务', 'type' => 'directory', 'children' => [ 'CreateTask', 'AttachTask', 'StartTask', 'StopTask', 'CancelTask', 'ListTask', 'ListTaskDetail', 'ListDialog', ], ], [ 'id' => 164366, 'title' => '智能语音交互', 'type' => 'directory', 'children' => [ 'SendCcoSmartCall', 'SendCcoSmartCallOperate', ], ], [ 'id' => 164370, 'title' => '智能外呼任务', 'type' => 'directory', 'children' => [ 'CreateAiOutboundTask', 'CreateAiOutboundTaskBatch', 'DeleteAiOutboundTask', 'GetAiOutboundTaskBizData', 'GetAiOutboundTaskExecDetail', 'GetAiOutboundTaskDetail', 'UpdateAiOutboundTask', 'InsertAiOutboundPhoneNums', 'GetAiOutboundTaskProgress', 'StopAiOutboundTask', 'TerminateAiOutboundTask', 'GetAiOutboundTaskList', 'StartAiOutboundTask', ], ], [ 'id' => 164384, 'title' => '号码管理', 'type' => 'directory', 'children' => [ 'AddHotlineNumber', 'DeleteHotlineNumber', 'ResetHotlineNumber', 'QueryHotlineNumber', 'GetConfigNumList', ], ], [ 'id' => 164813, 'title' => '话务管理', 'type' => 'directory', 'children' => [ 'AnswerCall', 'FinishHotlineService', 'GetNumLocation', 'GetRtcToken', 'HangupCall', 'ListHotlineRecord', 'ListOutboundPhoneNumber', 'MakeDoubleCall', 'SendHotlineHeartBeat', 'StartCall', 'StartHotlineService', 'SuspendHotlineService', ], ], [ 'id' => 165936, 'title' => '其他', 'type' => 'directory', 'children' => [ 'AddOuterAccount', 'AiccsSmartCall', 'AiccsSmartCallOperate', 'BatchCreateQualityProjects', 'ChangeChatAgentStatus', 'ChangeQualityProjectStatus', 'CreateOutboundTask', 'CreateQualityProject', 'CreateQualityRule', 'CreateThirdSsoAgent', 'DeleteOutboundTask', 'DeleteOuterAccount', 'DeleteQualityProject', 'DeleteQualityRule', 'EditQualityProject', 'EditQualityRule', 'EditQualityRuleTag', 'EncryptPhoneNum', 'FetchCall', 'GetAgentById', 'GetHotlineRuntimeInfo', 'GetHotlineWaitingNumber', 'GetInstanceList', 'GetMcuLvsIp', 'GetOutbounNumList', 'GetQualityProjectDetail', 'GetQualityProjectList', 'GetQualityProjectLog', 'GetQualityResult', 'GetQualityRuleDetail', 'GetQualityRuleList', 'GetQualityRuleTagList', 'HangUpDoubleCall', 'HangupThirdCall', 'HoldCall', 'InsertTaskDetail', 'JoinThirdCall', 'ListChatRecordDetail', 'ListHotlineRecordDetail', 'ListRoles', 'MakeCall', 'QueryHotlineInQueue', 'QueryOutboundTask', 'QueryTaskDetail', 'QueryTickets', 'RestartOutboundTask', 'StartCallV2', 'StartChatWork', 'StartMicroOutbound', 'SuspendOutboundTask', 'UpdateOuterAccount', 'TransferCallToSkillGroup', 'AddSkillGroup', 'DeleteSkillGroup', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'QueryConversationDetailInfoNew' => [ 'summary' => '查询通信智能体呼叫任务明细信息和通话详情信息。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)界面查看任务ID或通过[QueryAiCallTaskPage](~~2926799~~)接口获取任务ID。', 'type' => 'string', 'required' => true, 'example' => '138************', ], ], [ 'name' => 'DetailId', 'in' => 'query', 'schema' => [ 'description' => '任务明细ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面左上角查看任务明细ID或通过[QueryAiCallDetailPage](~~2926853~~)接口获取任务明细ID。', 'type' => 'string', 'required' => false, 'example' => '9662*************', ], ], [ 'name' => 'CallId', 'in' => 'query', 'schema' => [ 'description' => '通话唯一 ID。', 'type' => 'string', 'required' => false, 'example' => '1552********^1420********', ], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => [ 'description' => '预留给外部传入的业务流水号,可用唯一 ID 做业务关联。', 'type' => 'string', 'required' => false, 'example' => '123******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => '状态码描述。 ', 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Data' => [ 'description' => '返回结果数据。', 'type' => 'object', 'properties' => [ 'CallerPhone' => [ 'description' => '主叫号码', 'type' => 'string', 'example' => '0571*******', ], 'Options' => [ 'description' => '运行时用到的变量信息,会以Key-Value的形式存储在该字段中。', 'type' => 'string', 'example' => '{'."\n" .' "date": "666",'."\n" .' "phoneNumber": "777",'."\n" .' "distance": "555",'."\n" .' "mendian": "444",'."\n" .' "sex": "男",'."\n" .' "name": "111",'."\n" .' "age": "222"'."\n" .'}', ], 'CallResult' => [ 'description' => '外呼结果。取值:'."\n" .'- CALL_FORWARDING:呼叫转移。'."\n" .'- INCOMING_CALL_BARRED:限制呼入。'."\n" .'- CALL_REJECTED:拒接。'."\n" .'- ANSWERED:用户接通。'."\n" .'- USER_BUSY:被叫忙。'."\n" .'- POWERED_OFF:关机。'."\n" .'- NO_USER_RESPONSE:不在服务区。'."\n" .'- OPERATOR_BLOCK:运营商拦截。'."\n" .'- OTHERS:其他状态。'."\n" .'- SUSPEND:停机。'."\n" .'- CANCEL:主叫取消。'."\n" .'- INVALID_NUMBER:空号。'."\n" .'- UNAVAILABLE:暂时无法接通。'."\n" .'- NETWORK_BUSY:网络忙。'."\n" .'- NO_ANSWER:无应答。', 'type' => 'string', 'example' => 'ANSWERED', ], 'StatusMsg' => [ 'description' => '运营商返回的呼叫状态信息。', 'type' => 'string', 'example' => '呼叫结束(双呼)', ], 'ConversationTurnCount' => [ 'description' => '对话轮次。', 'type' => 'integer', 'format' => 'int64', 'example' => '23', ], 'TaskId' => [ 'description' => '任务ID。', 'type' => 'string', 'example' => '138************', ], 'StartCallTime' => [ 'description' => '开始呼叫时间,时间戳,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1286987391', ], 'StatusCode' => [ 'description' => '呼叫状态码。在语音服务[呼叫状态码](~~112804~~)中查看。', 'type' => 'string', 'example' => '200005', ], 'CalledPhone' => [ 'description' => '被叫号码', 'type' => 'string', 'example' => '130********', ], 'Variables' => [ 'description' => '通话变量信息。', 'type' => 'array', 'items' => [ 'description' => '通话变量信息。', 'type' => 'object', 'properties' => [ 'Required' => [ 'description' => '是否必填', 'type' => 'boolean', 'example' => 'false', ], 'Value' => [ 'description' => '变量值', 'type' => 'string', 'example' => 'mike', ], 'Id' => [ 'description' => '变量ID', 'type' => 'string', 'example' => '123', ], 'Key' => [ 'description' => '变量Key', 'type' => 'string', 'example' => 'name', ], 'Source' => [ 'description' => '来源', 'type' => 'string', 'example' => 'source', ], 'Name' => [ 'description' => '变量名称。', 'type' => 'string', 'example' => 'user name', ], ], ], 'example' => '', ], 'RecordingFileDownloadUrl' => [ 'description' => '录音文件下载地址,只有生成录音文件后才有该字段。', 'type' => 'string', 'example' => 'recording.oss.file', ], 'PickUpTime' => [ 'description' => '电话接听时间,时间戳格式,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '12349732441', ], 'ConversationRecord' => [ 'description' => '聊天记录信息。结构为JSON数组,聊天记录时按照时间顺序已经排序好了。具体如下:'."\n" .'```json'."\n" .'['."\n" .' {'."\n" .' "content":"聊天内容",'."\n" .' "role":"角色",//可取值:user(用户)、assistant(机器人)'."\n" .' }'."\n" .']'."\n" .'```', 'type' => 'string', 'example' => '['."\n" .' {'."\n" .' "content": "111您好,年龄222,性别男,我这边是**汽车的官方顾问,我们新出了一款车型为**;**已经上市了,售价**万元起,**分钟破*台,您看要不了解一下?",'."\n" .' "role": "assistant"'."\n" .' },'."\n" .' {'."\n" .' "content": "<客户打断>哎,你是谁?",'."\n" .' "role": "user"'."\n" .' },'."\n" .' {'."\n" .' "content": "<客户打断>你再说一遍。",'."\n" .' "role": "user"'."\n" .' }]', ], 'Status' => [ 'description' => '智能体状态。', 'type' => 'integer', 'format' => 'int64', 'example' => '72', ], 'ImportedTime' => [ 'description' => '导入时间,时间戳,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '43', ], 'EncryptionType' => [ 'type' => 'integer', 'format' => 'int64', 'example' => '28', ], 'MajorIntent' => [ 'description' => '主意图', 'type' => 'string', 'example' => 'A', ], 'CallId' => [ 'description' => '通话唯一ID。', 'type' => 'string', 'example' => '123*******^213******', ], 'BatchId' => [ 'description' => '批次号ID。', 'type' => 'string', 'example' => '1234******', ], 'FailedReason' => [ 'description' => '失败原因', 'type' => 'string', 'example' => '主动取消', ], 'Duration' => [ 'description' => '通话时长,未打通情况下为0,单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '30', ], 'HangupDirection' => [ 'description' => '挂断方向。取值:'."\n" ."\n" .'- **0**:用户。'."\n" .'- **1**:机器人。', 'type' => 'string', 'example' => '0', ], 'DetailId' => [ 'description' => '任务明细ID。', 'type' => 'string', 'example' => '1234*******', ], 'ReleaseTime' => [ 'description' => '通话结束时间,时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '7', ], 'OutId' => [ 'description' => '外部传入的业务流水号,可用唯一ID做业务关联。', 'type' => 'string', 'example' => '123***', ], 'OutputTags' => [ 'description' => '输出标签信息。', 'type' => 'array', 'items' => [ 'description' => '输出标签信息。', 'type' => 'object', 'properties' => [ 'OutputTagDescription' => [ 'description' => '标签描述信息', 'type' => 'string', 'example' => '评估客户对车型的兴趣和购买可能性', ], 'OutputTagName' => [ 'description' => '标签名称。', 'type' => 'string', 'example' => '客户意向度', ], 'OutputTagValue' => [ 'description' => '标签值。', 'type' => 'string', 'example' => '["高(非常积极,大概率转化)"]', ], 'Id' => [ 'description' => '标签ID。', 'type' => 'string', 'example' => '12', ], ], ], 'example' => '', ], ], 'example' => '', ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'false', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Data\\": {\\n \\"CallerPhone\\": \\"0571*******\\",\\n \\"Options\\": \\"{\\\\n \\\\\\"date\\\\\\": \\\\\\"666\\\\\\",\\\\n \\\\\\"phoneNumber\\\\\\": \\\\\\"777\\\\\\",\\\\n \\\\\\"distance\\\\\\": \\\\\\"555\\\\\\",\\\\n \\\\\\"mendian\\\\\\": \\\\\\"444\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"111\\\\\\",\\\\n \\\\\\"age\\\\\\": \\\\\\"222\\\\\\"\\\\n}\\",\\n \\"CallResult\\": \\"ANSWERED\\",\\n \\"StatusMsg\\": \\"呼叫结束(双呼)\\",\\n \\"ConversationTurnCount\\": 23,\\n \\"TaskId\\": \\"138************\\",\\n \\"StartCallTime\\": 1286987391,\\n \\"StatusCode\\": \\"200005\\",\\n \\"CalledPhone\\": \\"130********\\",\\n \\"Variables\\": [\\n {\\n \\"Required\\": false,\\n \\"Value\\": \\"mike\\",\\n \\"Id\\": \\"123\\",\\n \\"Key\\": \\"name\\",\\n \\"Source\\": \\"source\\",\\n \\"Name\\": \\"user name\\"\\n }\\n ],\\n \\"RecordingFileDownloadUrl\\": \\"recording.oss.file\\",\\n \\"PickUpTime\\": 12349732441,\\n \\"ConversationRecord\\": \\"[\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"111您好,年龄222,性别男,我这边是**汽车的官方顾问,我们新出了一款车型为**;**已经上市了,售价**万元起,**分钟破*台,您看要不了解一下?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎,你是谁?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>你再说一遍。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n }]\\",\\n \\"Status\\": 72,\\n \\"ImportedTime\\": 43,\\n \\"EncryptionType\\": 28,\\n \\"MajorIntent\\": \\"A\\",\\n \\"CallId\\": \\"123*******^213******\\",\\n \\"BatchId\\": \\"1234******\\",\\n \\"FailedReason\\": \\"主动取消\\",\\n \\"Duration\\": 30,\\n \\"HangupDirection\\": \\"0\\",\\n \\"DetailId\\": \\"1234*******\\",\\n \\"ReleaseTime\\": 7,\\n \\"OutId\\": \\"123***\\",\\n \\"OutputTags\\": [\\n {\\n \\"OutputTagDescription\\": \\"评估客户对车型的兴趣和购买可能性\\",\\n \\"OutputTagName\\": \\"客户意向度\\",\\n \\"OutputTagValue\\": \\"[\\\\\\"高(非常积极,大概率转化)\\\\\\"]\\",\\n \\"Id\\": \\"12\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => '通信智能体呼叫任务明细及通话详情', 'description' => '- 您可通过此接口查询通信智能体通话详细,也可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面查看通话详情。'."\n" ."\n" .'- 在调用此接口前,请确保您已创建呼叫任务且已导入被叫数据。'."\n" ."\n" .'- 若您没有已创建的呼叫任务,可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)界面创建呼叫任务并导入被叫数据,或通过[CreateAiCallTask](~~2926796~~)、[ImportTaskNumberDatas](~~2926815~~)接口创建呼叫任务并导入被叫数据。', ], 'ImportOneTaskPhoneNumber' => [ 'summary' => '导入单个号码数据。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1231231212****', ], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => [ 'description' => '外部流水号,建议使用唯一ID。不能超过128个字符。', 'type' => 'string', 'required' => false, 'example' => '94ba739b-xxxx-ef91-335d-4be006c34899', ], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => [ 'description' => '被叫手机号。', 'type' => 'string', 'required' => true, 'example' => '180******', ], ], [ 'name' => 'EncryptionType', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '81', ], ], [ 'name' => 'Variables', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '变量列表。Map格式。', 'type' => 'object', 'required' => false, 'example' => '{"变量key1":"变量值1","变量key2":"变量值2"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => '成功', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D', ], 'Data' => [ 'description' => '返回结果', 'type' => 'object', 'properties' => [ 'DetailId' => [ 'description' => '任务明细ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '92304322323*****', ], ], 'example' => '', ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'false', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"D6A51251-F7C4-596A-9F45-3C3219A5450D\\",\\n \\"Data\\": {\\n \\"DetailId\\": 0\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => '导入单个号码数据', ], 'QueryAiVoiceAgentDetail' => [ 'summary' => '查询通信智能体详情信息。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'AgentId', 'in' => 'query', 'schema' => [ 'description' => '智能体ID。', 'type' => 'string', 'required' => false, 'example' => '123123********', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => '成功', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '742C9243-2870-B8D6-0C68-C60BEB2DF09A', ], 'Data' => [ 'description' => '智能体详情数据', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '智能体状态。', 'type' => 'integer', 'format' => 'int64', 'enumValueTitles' => [ 1 => '已上线', '已下线', '审核中', '审核失败', '构建中', '调试中', '可上线', '构建失败', ], 'example' => '7', ], 'BusinessTypeName' => [ 'description' => '业务场景名称', 'type' => 'string', 'example' => '个人线索转化', ], 'Description' => [ 'description' => '智能体说明。', 'type' => 'string', 'example' => '日常测试使用。', ], 'AiVoiceAgentModelConfig' => [ 'description' => '智能体模型配置。', 'type' => 'object', 'properties' => [ 'BasicTaskDescription' => [ 'description' => '基础任务配置。', 'type' => 'string', 'example' => '任务描述。', ], 'MainPurpose' => [ 'description' => '主意图配置。', 'type' => 'object', 'properties' => [ 'MainPurposeEnum' => [ 'description' => '主意图可取值列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => '可取值说明。', 'type' => 'string', 'example' => '意向强烈。', ], 'Value' => [ 'description' => '可取值。', 'type' => 'string', 'example' => 'A', ], 'Id' => [ 'description' => '可取值唯一ID。', 'type' => 'string', 'example' => 'd5606d80-7625-dcea-xxxx-17f66fbb564a', ], ], ], 'example' => '', ], 'MainPurposeName' => [ 'description' => '主意图名称。', 'type' => 'string', 'example' => '通话效果评级', ], 'MainPurposeType' => [ 'description' => '主意图取值类型。目前只有ENUM类型。', 'type' => 'string', 'example' => 'ENUM', ], 'MainPurposeDescription' => [ 'description' => '主意图说明。', 'type' => 'string', 'example' => '通话效果评级:A、B、C、D,(A最好)', ], 'Id' => [ 'description' => '主意图ID。', 'type' => 'string', 'example' => '1ee6e994-08e0-xxxx-f662-1659cc54d409', ], ], 'example' => '', ], 'ChildTaskList' => [ 'description' => '子任务配置列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ChildTaskName' => [ 'description' => '子任务名称。', 'type' => 'string', 'example' => '开场与邀约', ], 'ChildTaskDescription' => [ 'description' => '子任务描述。', 'type' => 'string', 'example' => '新用户邀约: \\"喂,家长您好!我是*****的王老师,我们现在有**课程100个试听名额,想帮宝贝安排一下体验,您看什么时候比较方便呢?\\', ], 'Id' => [ 'description' => '子任务唯一ID。', 'type' => 'string', 'example' => '280cd4bf-*******df472c', ], ], ], 'example' => '', ], 'CustomExceptionFileName' => [ 'description' => '自定义异常文件名称。', 'type' => 'string', 'example' => '异常测试文件.xlsx', ], 'StartWordType' => [ 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'BusinessType' => [ 'description' => '业务场景。', 'type' => 'integer', 'format' => 'int64', 'enumValueTitles' => [ 1 => '个人客户线索转化', '企业客户线索转化', '会员提醒-续费/复购场景', '会员提醒-促销/赠券场景', '简单客服-答疑类客服场景', '其他', ], 'example' => '1', ], 'CustomExceptionUrlPath' => [ 'description' => '废弃字段,后续会下掉。', 'type' => 'string', 'example' => '-', ], 'KnowledgeId' => [ 'description' => '知识库ID。', 'type' => 'string', 'example' => '1232131*******', ], 'KnowledgeDocOriginalNameList' => [ 'description' => '知识库文档原始文件名列表。', 'type' => 'array', 'items' => [ 'description' => '文件名。', 'type' => 'string', 'example' => '**会话引擎测试.xlsx', ], 'example' => '', ], 'KnowledgeEnable' => [ 'description' => '是否关联知识库。', 'type' => 'boolean', 'example' => 'false', ], 'CustomExceptionEnable' => [ 'description' => '是否开启自定义异常处理。', 'type' => 'boolean', 'example' => 'false', ], 'Prologue' => [ 'description' => '开场白。', 'type' => 'string', 'example' => '你好,这里是******。', ], 'CustomExceptionFileId' => [ 'description' => '自定义异常文件ID。', 'type' => 'string', 'example' => 'OSS文件ID', ], 'PhoneTagConfig' => [ 'description' => '通话变量配置。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PhoneTagType' => [ 'description' => '变量值类型。', 'type' => 'string', 'enumValueTitles' => [ 'ENUM' => '枚举类型', 'TEXT' => '文本类型', ], 'example' => 'ENUM', ], 'PhoneTagName' => [ 'description' => '变量中文名称。', 'type' => 'string', 'example' => '意向车系', ], 'PhoneTagRequired' => [ 'description' => '是否必填。', 'type' => 'boolean', 'example' => 'true', ], 'Id' => [ 'description' => '变量唯一ID。', 'type' => 'string', 'example' => '280cd4bf-*******df472c'."\n", ], 'PhoneTagSource' => [ 'type' => 'string', 'example' => '示例值', ], 'PhoneTagDescription' => [ 'description' => '变量描述。', 'type' => 'string', 'example' => '用户感兴趣的车系。', ], 'PhoneTagEnum' => [ 'description' => '变量枚举值列表。只有变量值类型为ENUM时才有该字段。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => '枚举值描述。', 'type' => 'string', 'example' => '客户完全不接受挽留', ], 'Value' => [ 'description' => '枚举值。', 'type' => 'string', 'example' => '完全不接受', ], 'Id' => [ 'description' => '枚举值唯一ID。', 'type' => 'string', 'example' => 'c3d4ff4e-*********bc26dc044682', ], ], ], 'example' => '', ], 'PhoneTagKey' => [ 'description' => '变量键名。', 'type' => 'string', 'example' => 'testParam', ], ], ], 'example' => '', ], 'FlowDesc' => [ 'description' => '高级任务流程描述。', 'type' => 'string', 'example' => '这次外呼通过三个核心步骤与家长沟通,........ 3. 用户需求 > 主动介绍', ], 'UserRole' => [ 'description' => '用户角色。', 'type' => 'string', 'example' => '急需课程的新用户', ], 'TaskType' => [ 'description' => '任务类型。', 'type' => 'string', 'enumValueTitles' => [ 'BASIC' => '基础任务', 'ADVANCED' => '高级任务', ], 'example' => 'ADVANCED', ], 'SysRole' => [ 'description' => '系统角色。', 'type' => 'string', 'example' => '课程销售', ], 'OutputTagConfig' => [ 'description' => '输出标签配置。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OutputTagDescription' => [ 'description' => '标签描述信息。', 'type' => 'string', 'example' => '记录本次通话的最终状态', ], 'OutputTagType' => [ 'description' => '标签值类型。', 'type' => 'string', 'enumValueTitles' => [ 'ENUM' => '枚举类型', 'TEXT' => '文本类型', ], 'example' => 'ENUM', ], 'OutputTagEnum' => [ 'description' => '标签枚举值,只有标签值类型为ENUM时才有该字段。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => '标签枚举值描述。', 'type' => 'string', 'example' => '高(非常积极,大概率转化)', ], 'Value' => [ 'description' => '标签枚举值。', 'type' => 'string', 'example' => '高', ], 'Id' => [ 'description' => '标签枚举值唯一ID。', 'type' => 'string', 'example' => '8757************2c499fa', ], ], ], 'example' => '', ], 'OutputTagName' => [ 'description' => '标签名称。', 'type' => 'string', 'example' => '客户意向度', ], 'Id' => [ 'description' => '标签唯一ID。', 'type' => 'string', 'example' => '8757************2c499fa'."\n", ], ], ], 'example' => '', ], 'CustomExceptionVoiceStyle' => [ 'description' => '语言风格。', 'type' => 'integer', 'format' => 'int64', 'enumValueTitles' => [ 1 => '平实', '亲切', '专业', '严肃', ], 'example' => '2', ], 'RecordingFile' => [ 'type' => 'string', 'example' => '示例值', ], 'CustomExceptionList' => [ 'description' => '废弃字段,后续会下掉。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ExceptionType' => [ 'description' => '异常类型', 'type' => 'string', 'example' => '-', ], 'SupportBreak' => [ 'description' => '是否支持打断。', 'type' => 'boolean', 'example' => 'false', ], 'Reply' => [ 'description' => '回复内容。', 'type' => 'string', 'example' => '-', ], 'ExceptionSign' => [ 'description' => '是否作为异常标签输出。', 'type' => 'boolean', 'example' => 'true', ], ], ], 'example' => '', ], 'KnowledgeDocNameList' => [ 'description' => '知识文档名列表。', 'type' => 'array', 'items' => [ 'description' => '文件名。', 'type' => 'string', 'example' => '117d2********388f2a615be5c0d3546e.xlsx', ], 'example' => '', ], 'KnowledgeDocIdList' => [ 'description' => '知识文档ID列表。', 'type' => 'array', 'items' => [ 'description' => '知识文档ID。', 'type' => 'string', 'example' => '12213******', ], 'example' => '', ], ], 'example' => '', ], 'KnowledgeName' => [ 'description' => '知识库名称。', 'type' => 'string', 'example' => '测试知识库', ], 'VoiceStyleName' => [ 'description' => '语言风格名称。', 'type' => 'string', 'example' => '亲切', ], 'AgentId' => [ 'description' => '智能体ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12311212******', ], 'AgentName' => [ 'description' => '智能体名称。', 'type' => 'string', 'example' => '测试智能体', ], 'AiVoiceAgentCallConfig' => [ 'description' => '智能外呼语音配置。', 'type' => 'object', 'properties' => [ 'VocabId' => [ 'description' => '热词ID', 'type' => 'string', 'example' => 'afb2c43**********83e6df30551c11f7', ], 'TtsConfig' => [ 'description' => 'TTS配置。', 'type' => 'object', 'properties' => [ 'VoiceCode' => [ 'type' => 'string', 'example' => '示例值', ], 'MixingTemplate' => [ 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'BackgroundEnabled' => [ 'type' => 'boolean', 'example' => 'true', ], 'TtsVolume' => [ 'description' => 'TTS 播放的音量。'."\n" .'> '."\n" .'> - 取值范围:0~100,默认值为0。'."\n" .'> - 不设置值时,默认取大模型应用配置的音量。', 'type' => 'integer', 'format' => 'int64', 'example' => '72', ], 'TtsStyle' => [ 'description' => '音色风格。', 'type' => 'string', 'example' => 'longxiaoxia_v2p1', ], 'VoiceType' => [ 'type' => 'string', 'example' => '示例值', ], 'MixingEnabled' => [ 'type' => 'boolean', 'example' => 'true', ], 'TtsSpeed' => [ 'description' => 'TTS 播放时的声音速度。'."\n" ."\n" .'> '."\n" .'> - 取值范围:-200~200,默认值为 0;'."\n" .'> - 不设置值时,默认取大模型应用配置的声音速度;', 'type' => 'integer', 'format' => 'int64', 'example' => '34', ], 'BackgroundSound' => [ 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'BackgroundVolume' => [ 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], 'example' => '', ], 'EventConfig' => [ 'description' => '通话事件配置。', 'type' => 'object', 'properties' => [ 'MuteActive' => [ 'description' => '第一个静音是否唤起模型。', 'type' => 'boolean', 'example' => 'false', ], 'SessionTimeout' => [ 'description' => '最大通话时长,超时后自动挂断。单位:秒。'."\n" .'>'."\n" .'>- 最大取值:3600s。'."\n" .'>- 最小取值:600s。', 'type' => 'integer', 'format' => 'int64', 'example' => '600', ], 'CallAssistantHangup' => [ 'description' => '识别到智能接听是否挂断。', 'type' => 'boolean', 'example' => 'false', ], 'CallAssistantRecognize' => [ 'description' => '智能接听识别是否开启。', 'type' => 'boolean', 'example' => 'true', ], 'MuteDuration' => [ 'description' => '静音时长。'."\n" .'>'."\n" .'>- 最大取值:15s。'."\n" .'>- 最小取值:3s。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'MuteHangupNum' => [ 'description' => '连续多少个静音事件主动挂机。'."\n" .'>'."\n" .'>- 最大取值:5。'."\n" .'>- 最小取值:1。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'false', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"742C9243-2870-B8D6-0C68-C60BEB2DF09A\\",\\n \\"Data\\": {\\n \\"Status\\": 7,\\n \\"BusinessTypeName\\": \\"个人线索转化\\",\\n \\"Description\\": \\"日常测试使用。\\",\\n \\"AiVoiceAgentModelConfig\\": {\\n \\"BasicTaskDescription\\": \\"任务描述。\\",\\n \\"MainPurpose\\": {\\n \\"MainPurposeEnum\\": [\\n {\\n \\"Description\\": \\"意向强烈。\\",\\n \\"Value\\": \\"A\\",\\n \\"Id\\": \\"d5606d80-7625-dcea-xxxx-17f66fbb564a\\"\\n }\\n ],\\n \\"MainPurposeName\\": \\"通话效果评级\\",\\n \\"MainPurposeType\\": \\"ENUM\\",\\n \\"MainPurposeDescription\\": \\"通话效果评级:A、B、C、D,(A最好)\\",\\n \\"Id\\": \\"1ee6e994-08e0-xxxx-f662-1659cc54d409\\"\\n },\\n \\"ChildTaskList\\": [\\n {\\n \\"ChildTaskName\\": \\"开场与邀约\\",\\n \\"ChildTaskDescription\\": \\"新用户邀约: \\\\\\\\\\\\\\"喂,家长您好!我是*****的王老师,我们现在有**课程100个试听名额,想帮宝贝安排一下体验,您看什么时候比较方便呢?\\\\\\\\\\",\\n \\"Id\\": \\"280cd4bf-*******df472c\\"\\n }\\n ],\\n \\"CustomExceptionFileName\\": \\"异常测试文件.xlsx\\",\\n \\"StartWordType\\": 1,\\n \\"BusinessType\\": 1,\\n \\"CustomExceptionUrlPath\\": \\"-\\",\\n \\"KnowledgeId\\": \\"1232131*******\\",\\n \\"KnowledgeDocOriginalNameList\\": [\\n \\"**会话引擎测试.xlsx\\"\\n ],\\n \\"KnowledgeEnable\\": false,\\n \\"CustomExceptionEnable\\": false,\\n \\"Prologue\\": \\"你好,这里是******。\\",\\n \\"CustomExceptionFileId\\": \\"OSS文件ID\\",\\n \\"PhoneTagConfig\\": [\\n {\\n \\"PhoneTagType\\": \\"ENUM\\",\\n \\"PhoneTagName\\": \\"意向车系\\",\\n \\"PhoneTagRequired\\": true,\\n \\"Id\\": \\"280cd4bf-*******df472c\\\\n\\",\\n \\"PhoneTagSource\\": \\"示例值\\",\\n \\"PhoneTagDescription\\": \\"用户感兴趣的车系。\\",\\n \\"PhoneTagEnum\\": [\\n {\\n \\"Description\\": \\"客户完全不接受挽留\\",\\n \\"Value\\": \\"完全不接受\\",\\n \\"Id\\": \\"c3d4ff4e-*********bc26dc044682\\"\\n }\\n ],\\n \\"PhoneTagKey\\": \\"testParam\\"\\n }\\n ],\\n \\"FlowDesc\\": \\"这次外呼通过三个核心步骤与家长沟通,........ 3. 用户需求 > 主动介绍\\",\\n \\"UserRole\\": \\"急需课程的新用户\\",\\n \\"TaskType\\": \\"ADVANCED\\",\\n \\"SysRole\\": \\"课程销售\\",\\n \\"OutputTagConfig\\": [\\n {\\n \\"OutputTagDescription\\": \\"记录本次通话的最终状态\\",\\n \\"OutputTagType\\": \\"ENUM\\",\\n \\"OutputTagEnum\\": [\\n {\\n \\"Description\\": \\"高(非常积极,大概率转化)\\",\\n \\"Value\\": \\"高\\",\\n \\"Id\\": \\"8757************2c499fa\\"\\n }\\n ],\\n \\"OutputTagName\\": \\"客户意向度\\",\\n \\"Id\\": \\"8757************2c499fa\\\\n\\"\\n }\\n ],\\n \\"CustomExceptionVoiceStyle\\": 2,\\n \\"RecordingFile\\": \\"示例值\\",\\n \\"CustomExceptionList\\": [\\n {\\n \\"ExceptionType\\": \\"-\\",\\n \\"SupportBreak\\": false,\\n \\"Reply\\": \\"-\\",\\n \\"ExceptionSign\\": true\\n }\\n ],\\n \\"KnowledgeDocNameList\\": [\\n \\"117d2********388f2a615be5c0d3546e.xlsx\\"\\n ],\\n \\"KnowledgeDocIdList\\": [\\n \\"12213******\\"\\n ]\\n },\\n \\"KnowledgeName\\": \\"测试知识库\\",\\n \\"VoiceStyleName\\": \\"亲切\\",\\n \\"AgentId\\": 0,\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"AiVoiceAgentCallConfig\\": {\\n \\"VocabId\\": \\"afb2c43**********83e6df30551c11f7\\",\\n \\"TtsConfig\\": {\\n \\"VoiceCode\\": \\"示例值\\",\\n \\"MixingTemplate\\": 1,\\n \\"BackgroundEnabled\\": true,\\n \\"TtsVolume\\": 72,\\n \\"TtsStyle\\": \\"longxiaoxia_v2p1\\",\\n \\"VoiceType\\": \\"示例值\\",\\n \\"MixingEnabled\\": true,\\n \\"TtsSpeed\\": 34,\\n \\"BackgroundSound\\": 1,\\n \\"BackgroundVolume\\": 1\\n },\\n \\"EventConfig\\": {\\n \\"MuteActive\\": false,\\n \\"SessionTimeout\\": 600,\\n \\"CallAssistantHangup\\": false,\\n \\"CallAssistantRecognize\\": true,\\n \\"MuteDuration\\": 10,\\n \\"MuteHangupNum\\": 1\\n }\\n }\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => '查询通信智能体详情信息', ], 'PageQueryAgentList' => [ 'summary' => '分页查询智能体列表。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'AgentId', 'in' => 'query', 'schema' => [ 'description' => '智能体ID。', 'type' => 'string', 'required' => false, 'example' => '1231*******', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '页大小,默认10。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'description' => '页编号,从1开始,默认1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AgentName', 'in' => 'query', 'schema' => [ 'description' => '智能体名称。', 'type' => 'string', 'required' => false, 'example' => '测试智能体', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '智能体状态。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'enumValueTitles' => [ 1 => '已上线', '已下线', '审核中', '审核失败', '构建中', '调试中', '可上线', '构建失败', ], 'example' => '7', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'Access Denied', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => '成功', ], 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => '742C9243-2870-B8D6-0C68-C60BEB2DF09A', ], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'Total' => [ 'description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '14', ], 'List' => [ 'description' => '智能体数据列表。', 'type' => 'array', 'items' => [ 'description' => '数据', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '智能体状态', 'type' => 'integer', 'format' => 'int64', 'enumValueTitles' => [ 1 => '已上线', '已下线', '审核中', '审核失败', '构建中', '调试中', '可上线', '构建失败', ], 'example' => '7', ], 'LastOnlineTime' => [ 'description' => '最近一次上线时间。', 'type' => 'string', 'example' => '2025-10-28 14:38:15', ], 'ModifyTime' => [ 'description' => '最近一次修改时间。', 'type' => 'string', 'example' => '2025-10-28 17:10:17', ], 'Description' => [ 'description' => '智能体说明。', 'type' => 'string', 'example' => '用于日常测试', ], 'CreateTime' => [ 'description' => '创建时间。', 'type' => 'string', 'example' => '2025-10-28 17:10:17', ], 'AuditReason' => [ 'description' => '审核失败原因。', 'type' => 'string', 'example' => '请补充流程说明', ], 'BuildFailReason' => [ 'description' => '构建失败原因', 'type' => 'string', 'example' => '系统错误', ], 'ApplicationCode' => [ 'description' => '应用Code', 'type' => 'string', 'example' => 'DFAS*****', ], 'BusinessTypeName' => [ 'description' => '业务场景名称', 'type' => 'string', 'example' => '个人客户线索转化', ], 'WithConfig' => [ 'description' => '智能体是否已经配置过。', 'type' => 'boolean', 'example' => 'false', ], 'AgentName' => [ 'description' => '智能体名称。', 'type' => 'string', 'example' => '测试智能体', ], 'AgentId' => [ 'description' => '智能体ID。', 'type' => 'string', 'example' => '121312*******', ], 'WithActivePrompt' => [ 'type' => 'boolean', 'example' => 'false', ], ], ], 'example' => '', ], 'PageNo' => [ 'description' => '页面编号。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], 'example' => '', ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'false', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"Access Denied\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"742C9243-2870-B8D6-0C68-C60BEB2DF09A\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 14,\\n \\"List\\": [\\n {\\n \\"Status\\": 7,\\n \\"LastOnlineTime\\": \\"2025-10-28 14:38:15\\",\\n \\"ModifyTime\\": \\"2025-10-28 17:10:17\\",\\n \\"Description\\": \\"用于日常测试\\",\\n \\"CreateTime\\": \\"2025-10-28 17:10:17\\",\\n \\"AuditReason\\": \\"请补充流程说明\\",\\n \\"BuildFailReason\\": \\"系统错误\\",\\n \\"ApplicationCode\\": \\"DFAS*****\\",\\n \\"BusinessTypeName\\": \\"个人客户线索转化\\",\\n \\"WithConfig\\": false,\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"AgentId\\": \\"121312*******\\",\\n \\"WithActivePrompt\\": false\\n }\\n ],\\n \\"PageNo\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => '查询通信智能体列表', ], 'QueryConversationDetailInfo' => [ 'summary' => '查询通信智能体呼叫通话详情信息。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)界面查看任务ID或通过[QueryAiCallTaskPage](~~2926799~~)接口获取任务ID。', 'type' => 'string', 'required' => true, 'example' => '138************', ], ], [ 'name' => 'DetailId', 'in' => 'query', 'schema' => [ 'description' => '任务明细ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面左上角查看任务明细ID或通过[QueryAiCallDetailPage](~~2926853~~)接口获取任务明细ID。', 'type' => 'string', 'required' => true, 'example' => '9662*************', ], ], [ 'name' => 'BatchId', 'in' => 'query', 'schema' => [ 'description' => '任务批次ID。即为导入被叫数据时返回的批次ID,在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**界面查看任务批次ID或通过[ImportTaskNumberDatas](~~2926815~~)接口导入被叫数据时返回的导入批次ID。', 'type' => 'string', 'required' => true, 'example' => '139*********216', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => '成功', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'F2051E18-FF3F-5C08-8D24-6F150D2AF757', ], 'Data' => [ 'description' => '返回结果数据。', 'type' => 'object', 'properties' => [ 'CallerPhone' => [ 'description' => '主叫号码', 'type' => 'string', 'example' => '0571*******', ], 'EncryptionType' => [ 'type' => 'string', 'example' => '示例值', ], 'CallResult' => [ 'description' => '外呼结果。取值:'."\n" .'- CALL_FORWARDING:呼叫转移。'."\n" .'- INCOMING_CALL_BARRED:限制呼入。'."\n" .'- CALL_REJECTED:拒接。'."\n" .'- ANSWERED:用户接通。'."\n" .'- USER_BUSY:被叫忙。'."\n" .'- POWERED_OFF:关机。'."\n" .'- NO_USER_RESPONSE:不在服务区。'."\n" .'- OPERATOR_BLOCK:运营商拦截。'."\n" .'- OTHERS:其他状态。'."\n" .'- SUSPEND:停机。'."\n" .'- CANCEL:主叫取消。'."\n" .'- INVALID_NUMBER:空号。'."\n" .'- UNAVAILABLE:暂时无法接通。'."\n" .'- NETWORK_BUSY:网络忙。'."\n" .'- NO_ANSWER:无应答。', 'type' => 'string', 'example' => 'ANSWERED', ], 'StatusMsg' => [ 'description' => '运营商返回的呼叫状态信息。', 'type' => 'string', 'example' => '呼叫结束(双呼)', ], 'StartCallTime' => [ 'description' => '开始呼叫时间,时间戳,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '123123123123123', ], 'MajorIntent' => [ 'description' => '主意图', 'type' => 'string', 'example' => 'D', ], 'CallId' => [ 'description' => '通话唯一ID。', 'type' => 'string', 'example' => '1231231231213^11231231231', ], 'FailedReason' => [ 'description' => '失败原因', 'type' => 'string', 'example' => '主动取消', ], 'Duration' => [ 'description' => '通话时长,未打通情况下为0,单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16', ], 'HangupDirection' => [ 'description' => '挂断方向。取值:'."\n" ."\n" .'- **0**:用户。'."\n" .'- **1**:机器人。', 'type' => 'string', 'example' => '用户', ], 'StatusCode' => [ 'description' => '呼叫状态码。在语音服务[呼叫状态码](~~112804~~)中查看。', 'type' => 'string', 'example' => '200005', ], 'CalledPhone' => [ 'description' => '被叫号码', 'type' => 'string', 'example' => '186******', ], 'Variables' => [ 'description' => '通话变量列表。即为您创建的呼叫任务所关联的通信智能体中配置的通话变量。', 'type' => 'array', 'items' => [ 'description' => '通话变量信息。', 'type' => 'object', 'properties' => [ 'Required' => [ 'description' => '是否必填。取值:'."\n" ."\n" .'- true:是。'."\n" ."\n" .'- false:否。', 'type' => 'boolean', 'example' => 'false', ], 'Value' => [ 'description' => '变量值。', 'type' => 'string', 'example' => '张三', ], 'Id' => [ 'description' => '变量ID。', 'type' => 'string', 'example' => '22', ], 'Key' => [ 'description' => '变量Key。', 'type' => 'string', 'example' => 'name', ], 'Source' => [ 'type' => 'string', 'example' => '示例值', ], 'Name' => [ 'description' => '变量名称。', 'type' => 'string', 'example' => '姓名', ], ], ], 'example' => '', ], 'RecordingFileDownloadUrl' => [ 'description' => '录音文件下载地址,只有生成录音文件后才有该字段。', 'type' => 'string', 'example' => 'https://********', ], 'ReleaseTime' => [ 'description' => '通话结束时间,时间戳,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '98', ], 'PickUpTime' => [ 'description' => '电话接听时间。时间戳格式,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1754617273000', ], 'OutId' => [ 'description' => '外部传入的业务流水号,可用唯一ID做业务关联。', 'type' => 'string', 'example' => 'bb3bc32d-54b8-49c4-80d3-61583417d22e'."\n", ], 'ConversationRecord' => [ 'description' => '聊天记录信息。结构为JSON数组,聊天记录时按照时间顺序已经排序好了。具体如下:'."\n" .'```json'."\n" .'['."\n" .' {'."\n" .' "content":"聊天内容",'."\n" .' "role":"角色",//可取值:user(用户)、assistant(机器人)'."\n" .' }'."\n" .']'."\n" .'```', 'type' => 'string', 'example' => '['."\n" .' {'."\n" .' "content": "111您好,年龄222,性别男,我这边是**汽车的官方顾问,我们新出了一款车型为**;**已经上市了,售价**万元起,**分钟破*台,您看要不了解一下?",'."\n" .' "role": "assistant"'."\n" .' },'."\n" .' {'."\n" .' "content": "<客户打断>哎,你是谁?",'."\n" .' "role": "user"'."\n" .' },'."\n" .' {'."\n" .' "content": "<客户打断>你再说一遍。",'."\n" .' "role": "user"'."\n" .' },'."\n" .' {'."\n" .' "content": "哎,我没听清。",'."\n" .' "role": "user"'."\n" .' },'."\n" .' {'."\n" .' "content": "你在说什么?",'."\n" .' "role": "user"'."\n" .' },'."\n" .' {'."\n" .' "content": "您好,",'."\n" .' "role": "assistant"'."\n" .' },'."\n" .' {'."\n" .' "content": "我是**汽车总部销售服务顾问。",'."\n" .' "role": "assistant"'."\n" .' },'."\n" .' {'."\n" .' "content": "我们最近推出了一款新车**,想了解一下您是否对这款车型感兴趣?",'."\n" .' "role": "assistant"'."\n" .' },'."\n" .' {'."\n" .' "content": "<客户打断>哎,那我是谁?",'."\n" .' "role": "user"'."\n" .' },'."\n" .' {'."\n" .' "content": "你在说什么呢?",'."\n" .' "role": "user"'."\n" .' },'."\n" .' {'."\n" .' "content": "抱歉打扰了,111先生。",'."\n" .' "role": "assistant"'."\n" .' },'."\n" .' {'."\n" .' "content": "祝您生活愉快!再见!",'."\n" .' "role": "assistant"'."\n" .' }'."\n" .']', ], 'OutputTags' => [ 'description' => '输出标签列表。', 'type' => 'array', 'items' => [ 'description' => '输出标签信息。', 'type' => 'object', 'properties' => [ 'OutputTagDescription' => [ 'description' => '标签描述信息。', 'type' => 'string', 'example' => '评估客户对车型的兴趣和购买可能性', ], 'OutputTagName' => [ 'description' => '标签名称。', 'type' => 'string', 'example' => '客户意向度', ], 'OutputTagValue' => [ 'description' => '标签值。', 'type' => 'string', 'example' => '["高(非常积极,大概率转化)"]', ], 'Id' => [ 'description' => '标签ID。', 'type' => 'string', 'example' => '9ca2*****************************', ], ], ], 'example' => '', ], ], 'example' => '', ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"F2051E18-FF3F-5C08-8D24-6F150D2AF757\\",\\n \\"Data\\": {\\n \\"CallerPhone\\": \\"0571*******\\",\\n \\"EncryptionType\\": \\"示例值\\",\\n \\"CallResult\\": \\"ANSWERED\\",\\n \\"StatusMsg\\": \\"呼叫结束(双呼)\\",\\n \\"StartCallTime\\": 123123123123123,\\n \\"MajorIntent\\": \\"D\\",\\n \\"CallId\\": \\"1231231231213^11231231231\\",\\n \\"FailedReason\\": \\"主动取消\\",\\n \\"Duration\\": 16,\\n \\"HangupDirection\\": \\"用户\\",\\n \\"StatusCode\\": \\"200005\\",\\n \\"CalledPhone\\": \\"186******\\",\\n \\"Variables\\": [\\n {\\n \\"Required\\": false,\\n \\"Value\\": \\"张三\\",\\n \\"Id\\": \\"22\\",\\n \\"Key\\": \\"name\\",\\n \\"Source\\": \\"示例值\\",\\n \\"Name\\": \\"姓名\\"\\n }\\n ],\\n \\"RecordingFileDownloadUrl\\": \\"https://********\\",\\n \\"ReleaseTime\\": 98,\\n \\"PickUpTime\\": 1754617273000,\\n \\"OutId\\": \\"bb3bc32d-54b8-49c4-80d3-61583417d22e\\\\n\\",\\n \\"ConversationRecord\\": \\"[\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"111您好,年龄222,性别男,我这边是**汽车的官方顾问,我们新出了一款车型为**;**已经上市了,售价**万元起,**分钟破*台,您看要不了解一下?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎,你是谁?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>你再说一遍。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"哎,我没听清。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"您好,\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我是**汽车总部销售服务顾问。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我们最近推出了一款新车**,想了解一下您是否对这款车型感兴趣?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎,那我是谁?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么呢?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"抱歉打扰了,111先生。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"祝您生活愉快!再见!\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n }\\\\n]\\",\\n \\"OutputTags\\": [\\n {\\n \\"OutputTagDescription\\": \\"评估客户对车型的兴趣和购买可能性\\",\\n \\"OutputTagName\\": \\"客户意向度\\",\\n \\"OutputTagValue\\": \\"[\\\\\\"高(非常积极,大概率转化)\\\\\\"]\\",\\n \\"Id\\": \\"9ca2*****************************\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '通信智能体呼叫通话详情', 'description' => '- 您可通过此接口查询通信智能体通话详细,也可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面查看通话详情。'."\n" ."\n" .'- 在调用此接口前,请确保您已创建呼叫任务且已导入被叫数据。'."\n" ."\n" .'- 若您没有已创建的呼叫任务,可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)界面创建呼叫任务并导入被叫数据,或通过[CreateAiCallTask](~~2926796~~)、[ImportTaskNumberDatas](~~2926815~~)接口创建呼叫任务并导入被叫数据。', ], 'QueryAiCallDetailPage' => [ 'summary' => '分页查询通信智能体外呼任务明细。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '269272', 'abilityTreeNodes' => [ 'FEATUREaiccsTY5M4L', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => '1187**************', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '任务状态。取值:'."\n" ."\n" .'- 0:待完成。'."\n" ."\n" .'- 1:已完成。'."\n" ."\n" .'- 2:失败。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'enumValueTitles' => [], 'example' => '0', ], ], [ 'name' => 'BatchId', 'in' => 'query', 'schema' => [ 'description' => '批次号ID。在[外呼任务管理](https://aiccs.console.aliyun.com/agent/task)界面单击详情查看批次号ID。', 'type' => 'string', 'required' => false, 'example' => '1183**************'."\n", ], ], [ 'name' => 'CalledNumber', 'in' => 'query', 'schema' => [ 'description' => '被叫号码。', 'type' => 'string', 'required' => false, 'example' => '053714454****', ], ], [ 'name' => 'EncryptionType', 'in' => 'query', 'schema' => [ 'description' => '加密方式。0: 不加密;1: MD5;2: SHA256;3: SM3;', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'CallResult', 'in' => 'query', 'schema' => [ 'description' => '外呼结果。取值:'."\n" .'- CALL_FORWARDING:呼叫转移。'."\n" .'- INCOMING_CALL_BARRED:限制呼入。'."\n" .'- CALL_REJECTED:拒接。'."\n" .'- ANSWERED:用户接通。'."\n" .'- USER_BUSY:被叫忙。'."\n" .'- POWERED_OFF:关机。'."\n" .'- NO_USER_RESPONSE:不在服务区。'."\n" .'- OPERATOR_BLOCK:运营商拦截。'."\n" .'- OTHERS:其他状态。'."\n" .'- SUSPEND:停机。'."\n" .'- CANCEL:主叫取消。'."\n" .'- INVALID_NUMBER:空号。'."\n" .'- UNAVAILABLE:暂时无法接通。'."\n" .'- NETWORK_BUSY:网络忙。'."\n" .'- NO_ANSWER:无应答。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'ANSWERED', ], ], [ 'name' => 'MajorIntent', 'in' => 'query', 'schema' => [ 'description' => '主意图。在[通信智能体管理](https://aiccs.console.aliyun.com/agent/customize)界面单击智能体详情查看主意图。', 'type' => 'string', 'required' => false, 'example' => 'A', ], ], [ 'name' => 'MinConversationDuration', 'in' => 'query', 'schema' => [ 'description' => '通话时长下限。单位:分钟。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', ], ], [ 'name' => 'MaxConversationDuration', 'in' => 'query', 'schema' => [ 'description' => '通话时长上限。单位:分钟。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'StartImportedTime', 'in' => 'query', 'schema' => [ 'description' => '起始导入时间,时间戳,单位:ms。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748948749000', ], ], [ 'name' => 'EndImportedTime', 'in' => 'query', 'schema' => [ 'description' => '结束导入时间,时间戳,单位:ms。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748948749000', ], ], [ 'name' => 'StartCallingTime', 'in' => 'query', 'schema' => [ 'description' => '起始外呼时间,时间戳,单位:ms。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748948749000', ], ], [ 'name' => 'EndCallingTime', 'in' => 'query', 'schema' => [ 'description' => '结束外呼时间,时间戳,单位:ms。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748948749000', ], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => [ 'description' => '预留给调用方使用的ID。最终会通过在回执消息中将此ID带回给调用方。', 'type' => 'string', 'required' => false, 'example' => '94ba739b-c01a-ef91-335d-4be006c34899', ], ], [ 'name' => 'DetailIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '任务明细ID列表,最多不能超过100个。', 'type' => 'array', 'items' => [ 'description' => '明细ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '992913231****', ], 'required' => false, 'example' => '示例值示例值', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页数量。默认值:**10**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'default' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => '成功', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A57441B2-8EB6-5B93-9F37-0A51B8E2C9F5', ], 'Data' => [ 'description' => '返回结果数据。', 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'Total' => [ 'description' => '总共记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'PageNo' => [ 'description' => '当前页。', 'type' => 'integer', 'format' => 'int64', 'example' => '60', ], 'List' => [ 'description' => '任务明细数据列表。', 'type' => 'array', 'items' => [ 'description' => '任务明细数据。', 'type' => 'object', 'properties' => [ 'ImportedTime' => [ 'description' => '导入时间,时间戳,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1748948749000', ], 'Status' => [ 'description' => '任务明细状态。'."\n" .'- 0:初始化'."\n" .'- 1:等待外呼中'."\n" .'- 2:等待重试中'."\n" .'- 3:外呼中'."\n" .'- 4:外呼结束'."\n" .'- 5:外呼失败'."\n" ."\n" .'只有4和5属于终态。', 'type' => 'integer', 'format' => 'int64', 'example' => '4', ], 'Options' => [ 'description' => '运行时用到的变量信息,会以Key-Value的形式存储在该字段中。', 'type' => 'string', 'example' => '{'."\n" .' "date": "666",'."\n" .' "phoneNumber": "777",'."\n" .' "distance": "555",'."\n" .' "mendian": "444",'."\n" .' "sex": "男",'."\n" .' "name": "111",'."\n" .' "age": "222"'."\n" .'}', ], 'EncryptionType' => [ 'description' => '加密方式:0-不加密;1-MD5;2-SHA256;3-SM3', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'CalledNumber' => [ 'description' => '被叫号码。', 'type' => 'string', 'example' => '0537101****', ], 'CallResult' => [ 'description' => '呼叫结果。', 'type' => 'string', 'example' => '用户接通', ], 'ConversationTurnCount' => [ 'description' => '对话轮次。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'TaskId' => [ 'description' => '任务ID。', 'type' => 'string', 'example' => '1187**************', ], 'BatchId' => [ 'description' => '批次号ID。', 'type' => 'string', 'example' => '1183**************', ], 'MajorIntent' => [ 'description' => '主意图。', 'type' => 'string', 'example' => 'A', ], 'FailedReason' => [ 'description' => '呼叫失败原因,只有呼叫失败时才会有。', 'type' => 'string', 'example' => '账户停机', ], 'BranchId' => [ 'type' => 'integer', 'format' => 'int64', 'example' => '49', ], 'RecordingFilePath' => [ 'description' => '录音文件下载路径,只有录音文件生成后才有该字段。', 'type' => 'string', 'example' => 'https://*******', ], 'CallingTime' => [ 'description' => '呼叫时间,时间戳,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1748948749000', ], 'DetailId' => [ 'description' => '任务明细ID。', 'type' => 'string', 'example' => '9662*************', ], 'OutId' => [ 'type' => 'string', 'example' => 'outId', ], 'BranchVersionId' => [ 'type' => 'integer', 'format' => 'int64', 'example' => '9', ], 'ConversationRecord' => [ 'description' => '聊天记录信息。结构为JSON数组,聊天记录时按照时间顺序已经排序好了。具体如下:'."\n" .'```json'."\n" .'['."\n" .' {'."\n" .' "content":"聊天内容",'."\n" .' "role":"角色",//可取值:user(用户)、assistant(机器人)'."\n" .' }'."\n" .']'."\n" .'```', 'type' => 'string', 'example' => '['."\n" .' {'."\n" .' "content": "111您好,年龄222,性别男,我这边是**汽车的官方顾问,我们新出了一款车型为**;**已经上市了,售价**万元起,**分钟破*台,您看要不了解一下?",'."\n" .' "role": "assistant"'."\n" .' },'."\n" .' {'."\n" .' "content": "<客户打断>哎,你是谁?",'."\n" .' "role": "user",'."\n" .' },'."\n" .' {'."\n" .' "content": "<客户打断>你再说一遍。",'."\n" .' "role": "user",'."\n" .' },'."\n" .' {'."\n" .' "content": "哎,我没听清。",'."\n" .' "role": "user",'."\n" .' },'."\n" .' {'."\n" .' "content": "你在说什么?",'."\n" .' "role": "user",'."\n" .' },'."\n" .' {'."\n" .' "content": "您好,",'."\n" .' "role": "assistant",'."\n" .' },'."\n" .' {'."\n" .' "content": "我是**汽车总部销售服务顾问。",'."\n" .' "role": "assistant",'."\n" .' },'."\n" .' {'."\n" .' "content": "我们最近推出了一款新车**,想了解一下您是否对这款车型感兴趣?",'."\n" .' "role": "assistant",'."\n" .' },'."\n" .' {'."\n" .' "content": "<客户打断>哎,那我是谁?",'."\n" .' "role": "user",'."\n" .' },'."\n" .' {'."\n" .' "content": "你在说什么呢?",'."\n" .' "role": "user",'."\n" .' },'."\n" .' {'."\n" .' "content": "抱歉打扰了,111先生。",'."\n" .' "role": "assistant",'."\n" .' },'."\n" .' {'."\n" .' "content": "祝您生活愉快!再见!",'."\n" .' "role": "assistant",'."\n" .' }'."\n" .']', ], 'ConversationDuration' => [ 'description' => '通话时长,单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], ], 'example' => '', ], ], ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"A57441B2-8EB6-5B93-9F37-0A51B8E2C9F5\\",\\n \\"Data\\": {\\n \\"PageSize\\": 5,\\n \\"Total\\": 2,\\n \\"PageNo\\": 60,\\n \\"List\\": [\\n {\\n \\"ImportedTime\\": 1748948749000,\\n \\"Status\\": 4,\\n \\"Options\\": \\"{\\\\n \\\\\\"date\\\\\\": \\\\\\"666\\\\\\",\\\\n \\\\\\"phoneNumber\\\\\\": \\\\\\"777\\\\\\",\\\\n \\\\\\"distance\\\\\\": \\\\\\"555\\\\\\",\\\\n \\\\\\"mendian\\\\\\": \\\\\\"444\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"111\\\\\\",\\\\n \\\\\\"age\\\\\\": \\\\\\"222\\\\\\"\\\\n}\\",\\n \\"EncryptionType\\": 1,\\n \\"CalledNumber\\": \\"0537101****\\",\\n \\"CallResult\\": \\"用户接通\\",\\n \\"ConversationTurnCount\\": 10,\\n \\"TaskId\\": \\"1187**************\\",\\n \\"BatchId\\": \\"1183**************\\",\\n \\"MajorIntent\\": \\"A\\",\\n \\"FailedReason\\": \\"账户停机\\",\\n \\"BranchId\\": 49,\\n \\"RecordingFilePath\\": \\"https://*******\\",\\n \\"CallingTime\\": 1748948749000,\\n \\"DetailId\\": \\"9662*************\\",\\n \\"OutId\\": \\"outId\\",\\n \\"BranchVersionId\\": 9,\\n \\"ConversationRecord\\": \\"[\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"111您好,年龄222,性别男,我这边是**汽车的官方顾问,我们新出了一款车型为**;**已经上市了,售价**万元起,**分钟破*台,您看要不了解一下?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎,你是谁?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>你再说一遍。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"哎,我没听清。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"您好,\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我是**汽车总部销售服务顾问。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我们最近推出了一款新车**,想了解一下您是否对这款车型感兴趣?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎,那我是谁?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么呢?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"抱歉打扰了,111先生。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"祝您生活愉快!再见!\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n }\\\\n]\\",\\n \\"ConversationDuration\\": 100\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '查询通信智能体外呼任务明细', 'description' => '- 在查询通信智能体外呼任务明细之前,请确保您已创建外呼任务。'."\n" ."\n" .'- 若您没有创建外呼任务,可在[外呼任务管理](https://aiccs.console.aliyun.com/agent/task)界面创建外呼任务或者通过[CreateAiCallTask](~~2926796~~)接口创建外呼任务。', ], 'StopAiCallTask' => [ 'summary' => '停止通信智能体呼出任务。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => '1187**************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => '成功', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '7124F972-BAB8-5D1E-90FC-01CB10713B29', ], 'Data' => [ 'description' => '返回数据结果。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'true', ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"7124F972-BAB8-5D1E-90FC-01CB10713B29\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '停止通信智能体呼出任务', 'description' => '- 在停止通信智能体呼出任务之前,请确保您已创建呼出任务且任务状态为运行中。'."\n" ."\n" .'- 若您没有已创建的呼出任务,请先在[呼出任务管理](https://aiccs.console.aliyun.com/agent/task)界面创建呼出任务或通过[CreateAiCallTask](~~2926796~~)接口创建呼出任务。', ], 'CancelAiCallDetails' => [ 'summary' => '通信智能体呼叫任务取消呼叫,如明细记录已经进入待呼队列或者正在呼叫,则无法取消。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。在[呼叫任务管理](https://aiccs.console.aliyun.com/agent/task)界面查看任务ID或通过[QueryAiCallTaskPage](~~2926799~~)接口获取任务ID。', 'type' => 'string', 'required' => true, 'example' => '138************'."\n", ], ], [ 'name' => 'DetailIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '任务明细ID列表,如果指定了该参数,则以该参数为准,BatchId和PhoneNumbers无效。', 'type' => 'array', 'items' => [ 'description' => '任务明细ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面左上角查看任务明细ID或通过[QueryAiCallDetailPage](~~2926853~~)接口获取任务明细ID。', 'type' => 'string', 'required' => false, 'example' => '12131231*****', ], 'required' => false, ], ], [ 'name' => 'BatchId', 'in' => 'query', 'schema' => [ 'description' => '批次ID。即为导入被叫数据时返回的批次ID,在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**界面查看任务批次ID或通过[ImportTaskNumberDatas](~~2926815~~)接口导入被叫数据时返回的导入批次ID,如果指定了DetailIdList,则该参数无效。', 'type' => 'string', 'required' => false, 'example' => '4253331213*****', ], ], [ 'name' => 'PhoneNumbers', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '手机号列表,如果需要使用该参数,则必须指定BatchId,否则认为参数无效。', 'type' => 'array', 'items' => [ 'description' => '手机号。即为需要取消呼叫任务的手机号码,为导入被叫数据时传入的手机号码。', 'type' => 'string', 'required' => false, 'example' => '180*******', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'EncryptionType', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '36', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => '成功', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '46C98E28-9239-5D95-AC76-648B8FD4889A', ], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => '总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'FailedDetails' => [ 'description' => '失败明细情况。是个Map,Key为失败的明细ID或者手机号码,Value为失败原因。', 'type' => 'object', 'example' => '{'."\n" .' "176********": "明细记录当前状态不可取消"'."\n" .'}', ], 'FailedCount' => [ 'description' => '未成功取消是数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '75', ], 'SucceedCount' => [ 'description' => '成功取消的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '81', ], 'ResultCode' => [ 'description' => '取消结果。取值:'."\n" .'- ALL_FAILED:全部取消失败。'."\n" .'- ALL_SUCCEED:全部取消成功。'."\n" .'- PART_FAILED:部分取消失败。', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'PART_FAILED', ], ], 'example' => '', ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。'."\n", 'type' => 'boolean', 'example' => 'false', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"46C98E28-9239-5D95-AC76-648B8FD4889A\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 50,\\n \\"FailedDetails\\": {\\n \\"176********\\": \\"明细记录当前状态不可取消\\"\\n },\\n \\"FailedCount\\": 75,\\n \\"SucceedCount\\": 81,\\n \\"ResultCode\\": \\"PART_FAILED\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => '通信智能体呼叫任务取消呼叫', 'description' => '- 您可调用此接口取消通信智能体呼叫任务,也可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**管理**>**执行记录**>**待完成**界面手动取消通信智能体呼叫任务。'."\n" ."\n" .'- 调用此接口之前,请确保您已创建呼叫任务且已导入被叫数据。'."\n" ."\n" .'- 若您没有已创建的呼叫任务,可在呼叫任务管理界面创建呼叫任务并导入被叫数据,或通过[CreateAiCallTask](~~2926796~~)、[ImportTaskNumberDatas](~~2926815~~)接口创建呼叫任务并导入被叫数据。'."\n" ."\n" .'- 通信智能体呼叫任务取消呼叫后,可能会对您的业务造成影响,请谨慎操作。', ], 'StartAiCallTask' => [ 'summary' => '启动通信智能体外呼任务。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => '1187**************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => '成功', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '58A32FFF-86EE-5CF0-B365-97E8C574C7F4', ], 'Data' => [ 'description' => '启动结果。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'false', ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'false', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"58A32FFF-86EE-5CF0-B365-97E8C574C7F4\\",\\n \\"Data\\": false,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => '启动通信智能体外呼任务', 'description' => '- 在启动通信智能体呼出任务之前,请确保您的呼出任务状态为已停止。'."\n" ."\n" .'- 若您没有已创建的呼叫任务,请先在[呼叫任务管理](https://aiccs.console.aliyun.com/agent/task)界面创建呼叫任务或通过[CreateAiCallTask](~~2926796~~)接口创建呼叫任务。', ], 'UpdateAiCallTask' => [ 'summary' => '更新通信智能体外呼任务配置。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => '任务名称,同一个账号下不允许重复。', 'type' => 'string', 'required' => true, 'example' => '测试任务', ], ], [ 'name' => 'VirtualNumber', 'in' => 'query', 'schema' => [ 'description' => '呼出使用的服务实例。', 'type' => 'string', 'required' => false, 'example' => '0537022*****', ], ], [ 'name' => 'StartType', 'in' => 'query', 'schema' => [ 'description' => '启动方式。取值:'."\n" ."\n" .'- IMMEDIATE:立即启动。'."\n" ."\n" .'- SCHEDULE:定时启动。', 'type' => 'string', 'required' => true, 'example' => 'IMMEDIATE', ], ], [ 'name' => 'MissCallRetry', 'in' => 'query', 'schema' => [ 'description' => '是否开启重试。取值:'."\n" ."\n" .'- true:是。'."\n" ."\n" .'- false(默认):否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'CallRetryReason', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '失败重试原因。', 'type' => 'array', 'items' => [ 'description' => '具体重试原因。取值:'."\n" ."\n" .'- CALL_REJECTED:拒接。'."\n" ."\n" .'- USER_BUSY:被叫忙。'."\n" ."\n" .'- SUSPEND:停机。'."\n" ."\n" .'- INVALID_NUMBER:空号。'."\n" ."\n" .'- POWERED_OFF:关机。'."\n" ."\n" .'- NETWORK_BUSY:网络忙。'."\n" ."\n" .'- NO_ANSWER:无应答。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'CALL_REJECTED', ], 'required' => false, ], ], [ 'name' => 'CallRetryTimes', 'in' => 'query', 'schema' => [ 'description' => '重试次数,最大不能超过3次。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', ], ], [ 'name' => 'CallRetryInterval', 'in' => 'query', 'schema' => [ 'description' => '重试间隔,单位:分钟,最大不能超过120分钟。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25', ], ], [ 'name' => 'CallTime', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '可呼叫时间。', 'type' => 'array', 'items' => [ 'description' => '呼叫时间段,格式如下:'."\n" .'```json'."\n" .'{"startTime":"09:00:00","endTime":"10:00:00"}'."\n" .'```'."\n" .'`startTime`代表开始时间,`endTime`代表结束时间,仅处于这个时间段内的时刻才会发起呼出调度,否则将等待下一个可调度是间段到来。', 'type' => 'string', 'required' => false, 'example' => '{"startTime":"09:00:00","endTime":"10:00:00"}', ], 'required' => true, ], ], [ 'name' => 'CallDay', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '可外呼日。', 'type' => 'array', 'items' => [ 'description' => '可外呼日。取值:'."\n" ."\n" .'- MONDAY:周一。'."\n" ."\n" .'- TUESDAY:周二。'."\n" ."\n" .'- WEDNESDAY:周三。'."\n" ."\n" .'- THURSDAY:周四。'."\n" ."\n" .'- FRIDAY:周五。'."\n" ."\n" .'- SATURDAY:周六。'."\n" ."\n" .'- SUNDAY:周天。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'WEDNESDAY' => '周三', 'MONDAY' => '周一', 'THURSDAY' => '周四', 'SUNDAY' => '周天', 'TUESDAY' => '周二', 'FRIDAY' => '周五', 'SATURDAY' => '周六', ], 'example' => 'MONDAY', ], 'required' => true, ], ], [ 'name' => 'TaskStartTime', 'in' => 'query', 'schema' => [ 'description' => '任务预设的启动时间,时间戳,单位毫秒。StarType字段为SCHEDULE时该字段有效且必填,任务将在该字段设置的时间进行自动启动。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748923429000', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '待更新的任务ID。', 'type' => 'string', 'required' => true, 'example' => '1187**************', ], ], [ 'name' => 'TaskCps', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '57', 'default' => '', ], ], [ 'name' => 'PhoneType', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '53', ], ], [ 'name' => 'LineEncoding', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'example' => '示例值示例值示例值', ], ], [ 'name' => 'LinePhoneNum', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'example' => '示例值示例值', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '31', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => '错误信息。仅当返回异常时显示。', 'type' => 'string', 'example' => '参数不合法', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'FCD94A7F-316D-54D1-9BFC-814006CB1C34', ], 'Data' => [ 'description' => '更新结果。取值:'."\n" ."\n" .'- **true**:更新成功。'."\n" ."\n" .'- **false**:更新失败。', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口调用是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'false', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"参数不合法\\",\\n \\"RequestId\\": \\"FCD94A7F-316D-54D1-9BFC-814006CB1C34\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => '更新通信智能体外呼任务配置', 'description' => '在更新通信智能体外呼任务配置前,请先确保外呼任务的状态为已停止。', ], 'QueryAiCallTaskPage' => [ 'summary' => '查询通信智能体外呼任务列表。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页查询时设置的每页行数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'default' => '10', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '任务状态。取值:'."\n" .'- INIT:初始化(未启动)。'."\n" .'- FAILED:启动失败。'."\n" .'- RUNNING:运行中。'."\n" .'- STOPPED:已停止。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'INIT', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => '任务名称,系统根据任务名称模糊检索。', 'type' => 'string', 'required' => false, 'example' => '测试任务', ], ], [ 'name' => 'AgentName', 'in' => 'query', 'schema' => [ 'description' => '智能体名称,系统根据智能体名称模糊检索。', 'type' => 'string', 'required' => false, 'example' => '测试智能体', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。', 'type' => 'string', 'required' => false, 'example' => '1187**************'."\n", ], ], [ 'name' => 'ApplicationCode', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'example' => '示例值', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '68', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => '错误信息,正常调用时,不会返回该参数。', 'type' => 'string', 'example' => '参数不合法', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'B99C5955-5664-573D-97BE-A7CC1AFD8401', ], 'Data' => [ 'description' => '任务详细信息。', 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => '每页的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '74', ], 'Total' => [ 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '72', ], 'PageNo' => [ 'description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '37', ], 'List' => [ 'description' => '任务数据。', 'type' => 'array', 'items' => [ 'description' => '任务数据列表。', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '任务状态。', 'type' => 'integer', 'format' => 'int64', 'enumValueTitles' => [ '初始化', '运行中', '已停止', '启动失败', ], 'example' => '1', ], 'TaskId' => [ 'description' => '任务ID。', 'type' => 'string', 'enumValueTitles' => [], 'example' => '1187**************', ], 'CompleteRate' => [ 'description' => '任务完成率。', 'type' => 'string', 'example' => '70%', ], 'ApplicationName' => [ 'type' => 'string', 'example' => '示例值', ], 'CreateTime' => [ 'description' => '创建时间,时间戳,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1748932499000', ], 'StartTime' => [ 'description' => '任务计划启动时间,时间戳,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1748932499000', ], 'RealStartTime' => [ 'description' => '任务真实启动时间,时间戳,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1748932499000', ], 'TotalCallCount' => [ 'description' => '任务累计呼叫量。', 'type' => 'integer', 'format' => 'int64', 'example' => '58', ], 'DayCallCount' => [ 'description' => '当天的呼叫量。', 'type' => 'integer', 'format' => 'int64', 'example' => '22', ], 'ApplicationCode' => [ 'type' => 'string', 'example' => '示例值', ], 'TotalCount' => [ 'description' => '任务总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '71', ], 'TaskName' => [ 'description' => '任务名称。', 'type' => 'string', 'example' => '测试任务', ], 'StartFailedReason' => [ 'description' => '启动失败原因。', 'type' => 'string', 'example' => '智能体不在线', ], 'FailedCount' => [ 'description' => '任务运行失败总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '61', ], 'AgentName' => [ 'description' => '智能体名称。', 'type' => 'string', 'example' => '测试智能体', ], 'CallingCount' => [ 'description' => '正在通话量。', 'type' => 'integer', 'format' => 'int64', 'example' => '72', ], 'AgentId' => [ 'description' => '智能体编码。', 'type' => 'string', 'example' => '1180**************'."\n", ], 'SucceedCount' => [ 'description' => '任务运行成功总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '36', ], 'DayImportCount' => [ 'description' => '当天导入数据量。', 'type' => 'integer', 'format' => 'int64', 'example' => '400', ], 'ConcurrentCount' => [ 'description' => '任务并发。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'HistoryConnectRate' => [ 'description' => '历史接通率。历史接通率=历史接通数量➗累计呼叫量(TotalCallCount)。', 'type' => 'string', 'example' => '95.89%', ], 'DayConnectRate' => [ 'description' => '当天接通率。当天接通率=当天接通数➗当天呼叫量(DayCallCount)。', 'type' => 'string', 'example' => '74.14%', ], ], ], 'example' => '', ], ], ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"参数不合法\\",\\n \\"RequestId\\": \\"B99C5955-5664-573D-97BE-A7CC1AFD8401\\",\\n \\"Data\\": {\\n \\"PageSize\\": 74,\\n \\"Total\\": 72,\\n \\"PageNo\\": 37,\\n \\"List\\": [\\n {\\n \\"Status\\": 1,\\n \\"TaskId\\": \\"1187**************\\",\\n \\"CompleteRate\\": \\"70%\\",\\n \\"ApplicationName\\": \\"示例值\\",\\n \\"CreateTime\\": 1748932499000,\\n \\"StartTime\\": 1748932499000,\\n \\"RealStartTime\\": 1748932499000,\\n \\"TotalCallCount\\": 58,\\n \\"DayCallCount\\": 22,\\n \\"ApplicationCode\\": \\"示例值\\",\\n \\"TotalCount\\": 71,\\n \\"TaskName\\": \\"测试任务\\",\\n \\"StartFailedReason\\": \\"智能体不在线\\",\\n \\"FailedCount\\": 61,\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"CallingCount\\": 72,\\n \\"AgentId\\": \\"1180**************\\\\n\\",\\n \\"SucceedCount\\": 36,\\n \\"DayImportCount\\": 400,\\n \\"ConcurrentCount\\": 10,\\n \\"HistoryConnectRate\\": \\"95.89%\\",\\n \\"DayConnectRate\\": \\"74.14%\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '查询通信智能体外呼任务列表', ], 'QueryAiCallTaskDetail' => [ 'summary' => '查询通信智能体外呼任务基础信息。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => '1187**************', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。', 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => '错误信息,正常调用时,不会返回该参数。', 'type' => 'string', 'example' => '参数无效', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '23822ECB-8CAA-5C52-9C9E-807FD82A5A7F', ], 'Data' => [ 'description' => '返回结果数据。', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => '任务ID。', 'type' => 'string', 'example' => '1187**************'."\n", ], 'ApplicationName' => [ 'type' => 'string', 'example' => '示例值', ], 'RetryEnable' => [ 'description' => '是否开启外呼重试。取值:'."\n" .'- true:开启。'."\n" .'- false:未开启。', 'type' => 'boolean', 'enumValueTitles' => [], 'example' => 'true', ], 'StartTime' => [ 'description' => '任务预设启动时间,时间戳,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1748932499000', ], 'RealStartTime' => [ 'description' => '任务真实启动时间,时间戳,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1748932499000', ], 'LinePhoneNum' => [ 'type' => 'string', 'example' => '示例值', ], 'ApplicationCode' => [ 'type' => 'string', 'example' => '示例值', ], 'CallerNumber' => [ 'description' => '主叫号码。', 'type' => 'string', 'example' => '05370124****', ], 'CallTimes' => [ 'description' => '允许外呼时间。', 'type' => 'array', 'items' => [ 'description' => '允许呼叫时间段配置。', 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => '结束时间。', 'type' => 'string', 'example' => '09:00:00', ], 'StartTime' => [ 'description' => '开始时间。', 'type' => 'string', 'example' => '12:00:00', ], ], ], 'example' => '', ], 'RetryReasons' => [ 'description' => '允许失败重呼的原因列表。', 'type' => 'array', 'items' => [ 'description' => '具体重试原因。取值:'."\n" ."\n" .'- CALL_REJECTED:拒接。'."\n" ."\n" .'- USER_BUSY:被叫忙。'."\n" ."\n" .'- SUSPEND:停机。'."\n" ."\n" .'- INVALID_NUMBER:空号。'."\n" ."\n" .'- POWERED_OFF:关机。'."\n" ."\n" .'- NETWORK_BUSY:网络忙。'."\n" ."\n" .'- NO_ANSWER:无应答。', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'CALL_REJECTED', ], 'example' => '', ], 'RetryCount' => [ 'description' => '重呼次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'PhoneType' => [ 'type' => 'integer', 'format' => 'int64', 'example' => '17', ], 'TaskName' => [ 'description' => '任务名称。', 'type' => 'string', 'example' => '测试任务', ], 'LineEncoding' => [ 'type' => 'string', 'example' => '示例值', ], 'StartType' => [ 'description' => '启动方式。取值:'."\n" ."\n" .'- IMMEDIATE:立即启动。'."\n" ."\n" .'- SCHEDULE:定时启动。', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'IMMEDIATE', ], 'AgentName' => [ 'description' => '智能体名称。', 'type' => 'string', 'example' => '测试智能体', ], 'AgentId' => [ 'description' => '已上线的智能体编码。', 'type' => 'string', 'example' => '1180**************'."\n", ], 'RetryInterval' => [ 'description' => '重试间隔。单位:分钟。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'CallDays' => [ 'description' => '可外呼日列表。', 'type' => 'array', 'items' => [ 'description' => '可外呼日。取值:'."\n" ."\n" .'- MONDAY:周一。'."\n" ."\n" .'- TUESDAY:周二。'."\n" ."\n" .'- WEDNESDAY:周三。'."\n" ."\n" .'- THURSDAY:周四。'."\n" ."\n" .'- FRIDAY:周五。'."\n" ."\n" .'- SATURDAY:周六。'."\n" ."\n" .'- SUNDAY:周天。', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'MONDAY', ], 'example' => '', ], 'ConcurrentCount' => [ 'description' => '任务并发。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], ], 'example' => '', ], 'Code' => [ 'description' => '错误编码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'false', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"参数无效\\",\\n \\"RequestId\\": \\"23822ECB-8CAA-5C52-9C9E-807FD82A5A7F\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"1187**************\\\\n\\",\\n \\"ApplicationName\\": \\"示例值\\",\\n \\"RetryEnable\\": true,\\n \\"StartTime\\": 1748932499000,\\n \\"RealStartTime\\": 1748932499000,\\n \\"LinePhoneNum\\": \\"示例值\\",\\n \\"ApplicationCode\\": \\"示例值\\",\\n \\"CallerNumber\\": \\"05370124****\\",\\n \\"CallTimes\\": [\\n {\\n \\"EndTime\\": \\"09:00:00\\",\\n \\"StartTime\\": \\"12:00:00\\"\\n }\\n ],\\n \\"RetryReasons\\": [\\n \\"CALL_REJECTED\\"\\n ],\\n \\"RetryCount\\": 2,\\n \\"PhoneType\\": 17,\\n \\"TaskName\\": \\"测试任务\\",\\n \\"LineEncoding\\": \\"示例值\\",\\n \\"StartType\\": \\"IMMEDIATE\\",\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"AgentId\\": \\"1180**************\\\\n\\",\\n \\"RetryInterval\\": 1,\\n \\"CallDays\\": [\\n \\"MONDAY\\"\\n ],\\n \\"ConcurrentCount\\": 10\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => '查询通信智能体外呼任务基础信息', ], 'ImportTaskNumberDatas' => [ 'summary' => '通信智能体呼叫任务导入被叫数据。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '268865', 'abilityTreeNodes' => [ 'FEATUREaiccsTY5M4L', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'OssFileName', 'in' => 'query', 'schema' => [ 'description' => 'OSS文件路径,非必填。'."\n" .'> API调用暂时不支持Excel数据类型。因此上传OSS文件路径的方式暂不可用。', 'type' => 'string', 'required' => false, 'example' => '123dsdfsdfsdf.xlsx', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。', 'type' => 'string', 'required' => true, 'example' => '119181071278******', ], ], [ 'name' => 'PhoneNumberList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '如果DataType采用JSON列表,则需要通过该字段上传数据,且单次不能超过1000条。', 'type' => 'array', 'items' => [ 'description' => '数据结构如下:'."\n" .'```json'."\n" .'{'."\n" .' "calleeNumber":"被叫号码",'."\n" .' "outId":"保留key,该字段可用于携带外部流水唯一ID,回执内容中会将该字段携带回来,可以用这个作为唯一呼叫记录,方便关联回执,限制长度128",'."\n" .' "variable1":"value",'."\n" .' "variable2":"value",//如果智能体中有用到通话变量,则这里variable1、variable2代表每个变量的key,value就是变量的值。'."\n" .' }'."\n" .'```'."\n" .'> 通话变量在[**通信智能体管理**](https://aiccs.console.aliyun.com/agent/customize)>**详情**>**通话变量配置**界面查看。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "calleeNumber": "0534556****",'."\n" .' "outId": "CFC2F07E-F763-7C48-1A32-6EFFB6EA344E",'."\n" .' "name": "Tom",'."\n" .' "age": "18"'."\n" .'}', ], 'required' => false, ], ], [ 'name' => 'DataType', 'in' => 'query', 'schema' => [ 'description' => '数据类型。取值:'."\n" .'- EXCEL'."\n" .'- JSON'."\n" .'>API调用暂时仅支持JSON数据类型。>', 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'JSON', 'enum' => [ 'EXCEL', 'JSON', ], ], ], [ 'name' => 'EncryptionType', 'in' => 'query', 'schema' => [ 'description' => '加密方式:0-不加密;1-MD5;2-SHA256;3-SM3', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'CFC2F07E-F763-7C48-1A32-6EFFB6EA344E', ], 'Data' => [ 'description' => '导入批次ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123497836486******'."\n", ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"CFC2F07E-F763-7C48-1A32-6EFFB6EA344E\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '导入被叫数据', 'description' => '- 您可调用此接口导入被叫数据,也可在[呼叫任务管理](https://aiccs.console.aliyun.com/agent/task)界面单击导入被叫数据,下载模板并上传文件的方式导入被叫数据。'."\n" ."\n" .'- 此接口在导入被叫数据时,暂仅支持JSON数据类型导入。'."\n" ."\n" .'- 在调用此接口之前,请确保您已有创建成功的呼叫任务。'."\n" ."\n" .'- 若您没有已创建成功的呼叫任务,可在[呼叫任务管理](https://aiccs.console.aliyun.com/agent/task)界面点击创建呼叫任务或通过[CreateAiCallTask](~~2926796~~)接口创建呼叫任务。', ], 'CreateAiCallTask' => [ 'summary' => '创建通信智能体外呼任务。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '268866', 'abilityTreeNodes' => [ 'FEATUREaiccsTY5M4L', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => '任务名称,同一个账号下不允许重复。', 'type' => 'string', 'required' => true, 'example' => '测试任务', ], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => [ 'description' => '已上线的智能体编码。', 'type' => 'string', 'required' => false, 'example' => '1180**************'."\n", ], ], [ 'name' => 'VirtualNumber', 'in' => 'query', 'schema' => [ 'description' => '呼出使用的服务实例。', 'type' => 'string', 'required' => false, 'example' => '032712122*****', ], ], [ 'name' => 'StartType', 'in' => 'query', 'schema' => [ 'description' => '启动方式。取值:'."\n" ."\n" .'- IMMEDIATE:立即启动。'."\n" ."\n" .'- SCHEDULE:定时启动。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'SCHEDULE', ], ], [ 'name' => 'MissCallRetry', 'in' => 'query', 'schema' => [ 'description' => '是否开启重试。取值:'."\n" ."\n" .'- true:是。'."\n" ."\n" .'- false(默认):否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], [ 'name' => 'CallRetryReason', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '失败重试原因列表。', 'type' => 'array', 'items' => [ 'description' => '具体重试原因。取值:'."\n" .'- CALL_REJECTED:拒接。'."\n" .'- USER_BUSY:被叫忙。'."\n" .'- SUSPEND:停机。'."\n" .'- INVALID_NUMBER:空号。'."\n" .'- POWERED_OFF:关机。'."\n" .'- NETWORK_BUSY:网络忙。'."\n" .'- NO_ANSWER:无应答。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'CALL_REJECTED', ], 'required' => false, ], ], [ 'name' => 'CallRetryTimes', 'in' => 'query', 'schema' => [ 'description' => '重试次数,最大不能超过3次。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', ], ], [ 'name' => 'CallRetryInterval', 'in' => 'query', 'schema' => [ 'description' => '重试间隔,单位:分钟,最大不能超过720分钟。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '32', ], ], [ 'name' => 'CallTime', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '可呼叫时间段列表。', 'type' => 'array', 'items' => [ 'description' => '呼叫时间段,格式如下:'."\n" .'```json'."\n" .'{"startTime":"09:00:00","endTime":"10:00:00"}'."\n" .'```'."\n" .'`startTime`代表开始时间,`endTime`代表结束时间,仅处于这个时间段内的时刻才会发起呼出调度,否则将等待下一个可调度是间段到来。', 'type' => 'string', 'required' => false, 'example' => '{"startTime":"09:00:00","endTime":"10:00:00"}'."\n", ], 'required' => true, ], ], [ 'name' => 'CallDay', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '可外呼日列表。', 'type' => 'array', 'items' => [ 'description' => '可外呼日。取值:'."\n" ."\n" .'- MONDAY:周一。'."\n" .'- TUESDAY:周二。'."\n" .'- WEDNESDAY:周三。'."\n" .'- THURSDAY:周四。'."\n" .'- FRIDAY:周五。'."\n" .'- SATURDAY:周六。'."\n" .'- SUNDAY:周天。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'MONDAY', ], 'required' => true, ], ], [ 'name' => 'TaskStartTime', 'in' => 'query', 'schema' => [ 'description' => '任务预设的启动时间,时间戳,单位毫秒。StarType字段为SCHEDULE时该字段有效且必填,任务将在该字段设置的时间进行自动启动。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12313123133', ], ], [ 'name' => 'TaskCps', 'in' => 'query', 'schema' => [ 'description' => '任务并发,最大不超过500。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '75', ], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '92', ], ], [ 'name' => 'ApplicationCode', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'example' => '示例值示例值', ], ], [ 'name' => 'ApplicationName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'example' => '示例值示例值', ], ], [ 'name' => 'PhoneType', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '54', ], ], [ 'name' => 'LineEncoding', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'example' => '示例值示例值', ], ], [ 'name' => 'LinePhoneNum', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'example' => '示例值示例值', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => '成功', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '8C93B345-F702-5449-BA7E-7D110D4BF798', ], 'Data' => [ 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1213123123*****', ], 'Code' => [ 'description' => '请求状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8C93B345-F702-5449-BA7E-7D110D4BF798\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '创建通信智能体外呼任务', 'description' => '在创建外呼任务之前,请先使用智能体进行拨测以确认效果符合您的要求。', ], 'LlmSmartCall' => [ 'summary' => '基于大模型的智能外呼。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '256802', 'abilityTreeNodes' => [ 'FEATUREaiccsA3JJUR', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'CalledNumber', 'in' => 'query', 'schema' => [ 'description' => '接收智能外呼的被叫号码。', 'type' => 'string', 'required' => true, 'example' => '137****0000', ], ], [ 'name' => 'CallerNumber', 'in' => 'query', 'schema' => [ 'description' => '主叫号码,为必填参数,仅支持中国内地号码。请前往语音服务[真实号管理](https://dyvmsnext.console.aliyun.com/number/list/normal)界面查看号码。', 'type' => 'string', 'required' => false, 'example' => '132****2054', ], ], [ 'name' => 'ApplicationCode', 'in' => 'query', 'schema' => [ 'description' => '大模型应用编码。在[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面查看。', 'type' => 'string', 'required' => true, 'example' => 'F32******', ], ], [ 'name' => 'StartWordParam', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '开场白变量。请前往[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面单击详情查看您创建的大模型开场白变量。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "name": "小明",'."\n" .' "address": "浙江省杭州市"'."\n" .'}', ], ], [ 'name' => 'PromptParam', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Prompt提示词变量。请前往[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面单击详情查看您创建的Prompt提示词变量。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "style": "温柔"'."\n" .'}', ], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => [ 'description' => '预留给调用方使用的 ID,最终会通过回执消息将此ID带回给调用方,长度为1~15个字节。', 'type' => 'string', 'required' => false, 'example' => '222356****', 'maxLength' => 32, ], ], [ 'name' => 'BizParam', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '业务参数,请求客户模型时,会将此参数带入给客户模型。', 'type' => 'object', 'required' => false, 'example' => '{\\"testKey\\":\\"test\\"}', ], ], [ 'name' => 'Extension', 'in' => 'query', 'schema' => [ 'description' => 'X号码的分机号码,不超过5位。'."\n" ."\n" .'>仅在AXN分机号模式下需要填写,如果不存在分机号,请务必不要填写。>', 'type' => 'string', 'required' => false, 'example' => '123', 'maxLength' => 5, ], ], [ 'name' => 'SessionTimeout', 'in' => 'query', 'schema' => [ 'description' => '最大通话时长,超时后自动挂断。单位:秒。'."\n" .'>'."\n" .'>- 最大取值:3600s。'."\n" .'>- 最小取值:600s。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '300', 'example' => '1200', ], ], [ 'name' => 'TtsVoiceCode', 'in' => 'query', 'schema' => [ 'description' => 'TTS 播放时的音色编码。'."\n" ."\n" .'> '."\n" .'> - 不设置值时,默认取大模型应用配置的音色编码。'."\n" .'> - 支持通过[ListAvailableTts](~~2926668~~)接口查看全部音色编码。', 'type' => 'string', 'required' => false, 'example' => 'V65******', ], ], [ 'name' => 'TtsSpeed', 'in' => 'query', 'schema' => [ 'description' => 'TTS 播放时的声音速度。'."\n" ."\n" .'> '."\n" .'> - 取值范围:-200~200,默认值为0。'."\n" .'> - 不设置值时,默认取大模型应用配置的声音速度。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', ], ], [ 'name' => 'TtsVolume', 'in' => 'query', 'schema' => [ 'description' => 'TTS 播放的音量。'."\n" .'> '."\n" .'> - 取值范围:0~100,默认值为0。'."\n" .'> - 不设置值时,默认取大模型应用配置的音量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'CustomerLineCode', 'in' => 'query', 'schema' => [ 'description' => '用户自带线路编码。'."\n" .'> '."\n" .'> - 若使用客户自带线路,请联系小二开通此功能;'."\n" .'> - 线路编码由小二给出,若无,请不要设置值。', 'type' => 'string', 'required' => false, 'example' => 'SELF_xxxxx_A_NET', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D', ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Message' => [ 'description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', ], 'CallId' => [ 'description' => '此次通话的唯一回执ID。', 'type' => 'string', 'example' => '125165515***^11195613****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'ModelStatus.Invalid', 'errorMessage' => 'Model state invalid.', ], [ 'errorCode' => 'MissingParameter.CallerNumber', 'errorMessage' => 'Parameter "CallerNumber" which is mandatory for the request is not provided.', ], [ 'errorCode' => 'InvalidParameter.ApplicationCode', 'errorMessage' => 'The specified parameter "ApplicationCode" is invalid.', ], [ 'errorCode' => 'ModelNotExist', 'errorMessage' => 'The model does not exist.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6A51251-F7C4-596A-9F45-3C3219A5450D\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"CallId\\": \\"125165515***^11195613****\\"\\n}","type":"json"}]', 'title' => '大模型智能呼叫', 'description' => '- 调用一次接口仅支持添加一个被叫号码。如果有多个被叫号码,可以多次调用。'."\n" ."\n" .'- 在基于大模型发起智能呼叫之前,请确保您在[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面已创建大模型应用;在语音服务[真实号管理](https://dyvmsnext.console.aliyun.com/number/list/normal)界面已有申请成功的真实号码。', ], 'LlmSmartCallEncrypt' => [ 'summary' => '基于大模型加密号码智能呼叫。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '270332', 'abilityTreeNodes' => [ 'FEATUREaiccs6AMUI3', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'EncryptCalledNumber', 'in' => 'query', 'schema' => [ 'description' => '加密被叫号码。', 'type' => 'string', 'required' => true, 'example' => '140*********243', ], ], [ 'name' => 'PromptParam', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '大模型应用prompt参数。', 'type' => 'object', 'required' => false, 'example' => '{"prompt":"推荐一部电影"}', ], ], [ 'name' => 'StartWordParam', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '大模型应用开场白参数。', 'type' => 'object', 'required' => false, 'example' => '{"name":"小明","address":"浙江省杭州市"}', ], ], [ 'name' => 'ApplicationCode', 'in' => 'query', 'schema' => [ 'description' => '大模型应用编码。', 'type' => 'string', 'required' => true, 'example' => 'AD******45', ], ], [ 'name' => 'CallerNumber', 'in' => 'query', 'schema' => [ 'description' => '主叫号码。', 'type' => 'string', 'required' => true, 'example' => '132******65', ], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => [ 'description' => '客户自定义outId。', 'type' => 'string', 'required' => false, 'example' => 'dsa*******sad', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None', ], 'Message' => [ 'description' => '状态码的描述。', 'type' => 'string', 'example' => '成功', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'F92F9749-105E-518F-8B08-CF16EF36A0E2', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'CallId' => [ 'description' => '呼叫ID。', 'type' => 'string', 'example' => '149******206', ], ], ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'ok', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"F92F9749-105E-518F-8B08-CF16EF36A0E2\\",\\n \\"Data\\": {\\n \\"CallId\\": \\"149******206\\"\\n },\\n \\"Code\\": \\"ok\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '大模型加密号智能外呼', ], 'HangupOperate' => [ 'summary' => '通信智能引擎中主动挂断通话。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '259150', 'abilityTreeNodes' => [ 'FEATUREaiccsA3JJUR', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'CallId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'description' => '通话回执ID。您可通过[LlmSmartCall](~~2862828~~)或[LlmSmartCallEncrypt](~~2881065~~)接口获取通话回执ID。', 'type' => 'string', 'required' => true, 'example' => '14777672****^13452272****', ], ], [ 'name' => 'ImmediateHangup', 'in' => 'query', 'schema' => [ 'description' => '是否立刻挂断。取值:'."\n" ."\n" .'- true(默认值):立刻挂断。'."\n" ."\n" .'- false:前正在播放的内容播放完再挂断。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EFD543DD-E087-54A2-AC0B-54E0656511D7', ], 'Code' => [ 'description' => '请求状态码。返回OK表示请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Mesage' => [ 'description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', ], 'Result' => [ 'description' => '返回结果。取值:'."\n" ."\n" .'- **true**:挂断成功。'."\n" ."\n" .'- **false**:挂断失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter.CallId', 'errorMessage' => 'The parameter CallId is invalid.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFD543DD-E087-54A2-AC0B-54E0656511D7\\",\\n \\"Code\\": \\"OK\\",\\n \\"Mesage\\": \\"OK\\",\\n \\"Result\\": true\\n}","type":"json"}]', 'title' => '通信智能引擎主动挂断通话', 'description' => '- 在通信智能引擎主动挂断通话之前,请先确保已有基于大模型发起的通话。'."\n" ."\n" .'- 若没有基于大模型发起的通话,您可以通过[LlmSmartCall](~~2862828~~)或[LlmSmartCallEncrypt](~~2881065~~)接口发起通话。', ], 'ListAvailableTts' => [ 'summary' => '获取大模型外呼支持的TTS音色列表,包括系统预置音色和个性化音色。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '273987', 'abilityTreeNodes' => [ 'FEATUREaiccsTY5M4L', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TtsVoiceCode', 'in' => 'query', 'schema' => [ 'title' => '复刻音色编码', 'description' => '个性化音色编码,在[个性化音色](https://aiccs.console.aliyun.com/engine/voiceprint)界面查看音色编码。', 'type' => 'string', 'required' => false, 'example' => 'V9A******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝详细信息;只有RAM校验失败才会返回此字段。', 'type' => 'string', 'example' => 'None', ], 'RequestId' => [ 'title' => '', 'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。', 'type' => 'string', 'example' => '5EBAEBE6-0E77-5E1F-99E4-7B20512F22222', ], 'Message' => [ 'title' => '', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'title' => '', 'description' => '返回结果。', 'type' => 'array', 'items' => [ 'description' => '音色列表。', 'type' => 'object', 'properties' => [ 'TtsVoiceName' => [ 'title' => '音色名称', 'description' => '音色名称。', 'type' => 'string', 'example' => '龙小夏', ], 'TtsEngine' => [ 'title' => '音色平台CosyVoice/Volcano', 'description' => '音色平台。取值:'."\n" ."\n" .'- CosyVoice:个性化音色或系统预置音色。'."\n" ."\n" .'- Volcano:豆包音色。', 'type' => 'string', 'example' => 'CosyVoice', ], 'TtsStyle' => [ 'title' => '音色cosy类型 cosyvoice-v2-XXXX-XXXX', 'description' => '音色风格。', 'type' => 'string', 'example' => 'cosyvoice-v2-*********-*******', ], 'TtsAuditionFileUrl' => [ 'title' => '音色试听文件', 'description' => '音色试听文件。', 'type' => 'string', 'example' => 'https://*******/longxiaoxia.mp3', ], 'TtsVoiceCode' => [ 'title' => '音色编码', 'description' => '音色编码。', 'type' => 'string', 'example' => 'V9A******'."\n", ], ], 'enumValueTitles' => [], ], 'example' => '', ], 'Code' => [ 'title' => '', 'description' => '状态码。返回OK表示调用成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'title' => '', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"5EBAEBE6-0E77-5E1F-99E4-7B20512F22222\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"TtsVoiceName\\": \\"龙小夏\\",\\n \\"TtsEngine\\": \\"CosyVoice\\",\\n \\"TtsStyle\\": \\"cosyvoice-v2-*********-*******\\",\\n \\"TtsAuditionFileUrl\\": \\"https://*******/longxiaoxia.mp3\\",\\n \\"TtsVoiceCode\\": \\"V9A******\\\\n\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '获取大模型呼叫支持的TTS音色列表', 'description' => '若您在[个性化音色](https://aiccs.console.aliyun.com/engine/voiceprint)界面没有已创建且上线的音色,则只能查到系统预置的音色。', ], 'GetCallDialogContent' => [ 'summary' => '通过CallId查询对话内容,只支持查询近一个月通话已结束的通话对话内容。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '275547', 'abilityTreeNodes' => [ 'FEATUREaiccsA3JJUR', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CallDate', 'in' => 'query', 'schema' => [ 'description' => '外呼日期,只可查询最近30天的日期,格式:yyyy-MM-dd。', 'type' => 'string', 'required' => true, 'example' => '2025-06-06', ], ], [ 'name' => 'CallId', 'in' => 'query', 'schema' => [ 'description' => '呼叫记录ID,用于标识一条通话记录。'."\n" ."\n" .'> 在调用大模型外呼接口LlmSmartCall是,会返回此呼叫记录ID,即CallId。', 'type' => 'string', 'required' => true, 'example' => '123456^123478', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'description' => '访问被拒绝详细信息;只有RAM校验失败才会返回此字段。', 'type' => 'string', 'example' => 'Access Denied', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'FB0B0481-F13E-16E0-8A7A-1AD2FXXXEF55', ], 'Message' => [ 'description' => '返回消息', 'type' => 'string', 'example' => '成功', ], 'Data' => [ 'description' => '返回数据结果。', 'type' => 'object', 'properties' => [ 'DialogContent' => [ 'description' => '对话内容', 'type' => 'string', 'example' => '[{\\"content\\":\\"您好。\\",\\"role\\":\\"assistant\\"},{\\"content\\":\\"不用了。\\",\\"role\\":\\"user\\"},{\\"content\\":\\"呃,不用了,再见,谢谢。\\",\\"role\\":\\"user\\"}]', ], 'CallId' => [ 'description' => '呼叫ID', 'type' => 'string', 'example' => '123456^123478'."\n", ], 'CallStatus' => [ 'description' => '呼叫状态 '."\n" .'> 呼叫状态返回值描述'."\n" .'> - 0:未接通;'."\n" .'> - 1:已接通;'."\n" .'> - 2:已挂断;', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], ], ], 'Code' => [ 'description' => '请求返回Code。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'false', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter.CallId', 'errorMessage' => 'The parameter CallId is invalid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"Access Denied\\",\\n \\"RequestId\\": \\"FB0B0481-F13E-16E0-8A7A-1AD2FXXXEF55\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"DialogContent\\": \\"[{\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"您好。\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"role\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"assistant\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"不用了。\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"role\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"user\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"呃,不用了,再见,谢谢。\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"role\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"user\\\\\\\\\\\\\\"}]\\",\\n \\"CallId\\": \\"123456^123478\\\\n\\",\\n \\"CallStatus\\": 2\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => '通过CallId查询近一个月通话已结束的通话对话内容', ], 'GetHotlineServiceStatistics' => [ 'summary' => '获取热线监控下服务统计量。支持实例、时间纬度、坐席、部门、技能组分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '坐席id列表', 'description' => '坐席ID列表。', 'type' => 'array', 'items' => [ 'description' => '坐席ID。'."\n" ."\n" .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口,查看返回参数的**AgentId**,即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', ], 'required' => false, ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], 'required' => false, ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '技能组id列表', 'description' => '技能组ID列表。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, ], ], [ 'name' => 'TimeLatitudeType', 'in' => 'query', 'schema' => [ 'title' => '时间纬度类型', 'description' => '时间纬度类型分组查询。取值:'."\n" .'- **minute**:分钟。'."\n" .'- **hour**:小时。', 'type' => 'string', 'required' => false, 'example' => 'minute', ], ], [ 'name' => 'ExistAgentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据坐席分组', 'description' => '是否根据坐席分组查询。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误描述', 'description' => '状态描述。', 'type' => 'string', 'example' => 'message', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"tenant_id":"905","n_resttype_now":0,"tenant_name":"非单元测试化BU","n_resttype1_now":0,"group_name":"-1","department_id":"-1","department_name":"-1","n_resttype98_now":0,"n_online_now":0,"date_id":"20210401","n_resttype3_now":0,"n_resttype5_now":0,"n_busy_now":0,"n_resttype2_now":0,"group_id":"-1","n_idle_now":0,"n_resttype4_now":0,"n_ack_now":0,"n_resttype99_now":0}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态编码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"message\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"n_resttype_now\\\\\\":0,\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"n_resttype1_now\\\\\\":0,\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_resttype98_now\\\\\\":0,\\\\\\"n_online_now\\\\\\":0,\\\\\\"date_id\\\\\\":\\\\\\"20210401\\\\\\",\\\\\\"n_resttype3_now\\\\\\":0,\\\\\\"n_resttype5_now\\\\\\":0,\\\\\\"n_busy_now\\\\\\":0,\\\\\\"n_resttype2_now\\\\\\":0,\\\\\\"group_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_idle_now\\\\\\":0,\\\\\\"n_resttype4_now\\\\\\":0,\\\\\\"n_ack_now\\\\\\":0,\\\\\\"n_resttype99_now\\\\\\":0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n xxxx\\n 200\\n true\\n \\n 1\\n 2000\\n 4\\n {\\"tenant_id\\":\\"905\\",\\"n_resttype_now\\":0,\\"tenant_name\\":\\"非单元测试化BU\\",\\"n_resttype1_now\\":0,\\"group_name\\":\\"-1\\",\\"department_id\\":\\"-1\\",\\"department_name\\":\\"-1\\",\\"n_resttype98_now\\":0,\\"n_online_now\\":0,\\"date_id\\":\\"20210401\\",\\"n_resttype3_now\\":0,\\"n_resttype5_now\\":0,\\"n_busy_now\\":0,\\"n_resttype2_now\\":0,\\"group_id\\":\\"-1\\",\\"n_idle_now\\":0,\\"n_resttype4_now\\":0,\\"n_ack_now\\":0,\\"n_resttype99_now\\":0}\\n \\n","errorExample":""}]', 'title' => '获取热线监控下服务统计量', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写坐席、部门、技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" ."\n" .' n_idle_now:当前空闲坐席数'."\n" .' n_resttype_now:当前小休坐席数'."\n" .' n_resttype1_now:当前普通小休坐席数'."\n" .' n_resttype2_now:当前就餐小休坐席数'."\n" .' n_resttype3_now:当前会议小休坐席数'."\n" .' n_resttype4_now:当前辅导小休坐席数'."\n" .' n_resttype5_now:当前培训小休坐席数'."\n" .' n_resttype98_now:当前强制小休坐席数'."\n" .' n_resttype99_now:当前签入小休坐席数'."\n" .' n_ack_now:当前后处理坐席数'."\n" .' n_online_now:当前在线坐席数'."\n" .' n_busy_now:通话坐席数'."\n" .' group_name:技能组名称'."\n" .' group_id:技能组ID'."\n" .' department_id:部门ID'."\n" .' department_name:部门名称'."\n" .' date_id:日期'."\n" .' tenant_id:租户ID'."\n" .' tenant_name:租户名称'."\n" .' '."\n" .' '."\n" .' ', ], 'GetSkillGroupAndAgentStatusSummary' => [ 'summary' => '获取热线监控下技能组坐席汇总状态量。支持实例、时间区间、部门、技能组分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], 'required' => false, ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '技能组id列表', 'description' => '技能组ID列表。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。'."\n" ."\n\n" .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, ], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值:**false**。取值:'."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'message', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '每页的数量', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"tenant_id":"905","n_resttype_now":0,"tenant_name":"非单元测试化BU","n_resttype1_now":0,"group_name":"-1","department_id":"-1","department_name":"-1","n_resttype98_now":0,"n_online_now":0,"date_id":"20210401","n_resttype3_now":0,"n_resttype5_now":0,"n_busy_now":0,"n_resttype2_now":0,"group_id":"-1","n_idle_now":0,"n_resttype4_now":0,"n_ack_now":0,"n_resttype99_now":0}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态编码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '接口调用是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"message\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"n_resttype_now\\\\\\":0,\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"n_resttype1_now\\\\\\":0,\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_resttype98_now\\\\\\":0,\\\\\\"n_online_now\\\\\\":0,\\\\\\"date_id\\\\\\":\\\\\\"20210401\\\\\\",\\\\\\"n_resttype3_now\\\\\\":0,\\\\\\"n_resttype5_now\\\\\\":0,\\\\\\"n_busy_now\\\\\\":0,\\\\\\"n_resttype2_now\\\\\\":0,\\\\\\"group_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_idle_now\\\\\\":0,\\\\\\"n_resttype4_now\\\\\\":0,\\\\\\"n_ack_now\\\\\\":0,\\\\\\"n_resttype99_now\\\\\\":0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n message\\n 200\\n true\\n \\n 1\\n 2000\\n 4\\n {\\"tenant_id\\":\\"905\\",\\"n_resttype_now\\":0,\\"tenant_name\\":\\"非单元测试化BU\\",\\"n_resttype1_now\\":0,\\"group_name\\":\\"-1\\",\\"department_id\\":\\"-1\\",\\"department_name\\":\\"-1\\",\\"n_resttype98_now\\":0,\\"n_online_now\\":0,\\"date_id\\":\\"20210401\\",\\"n_resttype3_now\\":0,\\"n_resttype5_now\\":0,\\"n_busy_now\\":0,\\"n_resttype2_now\\":0,\\"group_id\\":\\"-1\\",\\"n_idle_now\\":0,\\"n_resttype4_now\\":0,\\"n_ack_now\\":0,\\"n_resttype99_now\\":0}\\n \\n","errorExample":""}]', 'title' => '获取热线监控下技能组坐席汇总状态量', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写部门、技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" ."\n" .' n_idle_now:当前空闲坐席数'."\n" .' n_resttype_now:当前小休坐席数'."\n" .' n_resttype1_now:当前普通小休坐席数'."\n" .' n_resttype2_now:当前就餐小休坐席数'."\n" .' n_resttype3_now:当前会议小休坐席数'."\n" .' n_resttype4_now:当前辅导小休坐席数'."\n" .' n_resttype5_now:当前培训小休坐席数'."\n" .' n_resttype98_now:当前强制小休坐席数'."\n" .' n_resttype99_now:当前签入小休坐席数'."\n" .' n_ack_now:当前后处理坐席数'."\n" .' n_online_now:当前在线坐席数'."\n" .' n_busy_now:通话坐席数'."\n" .' tenant_id:租户ID'."\n" .' tenant_name:租户名称'."\n" .' group_id:技能组ID'."\n" .' group_name:技能组名称'."\n" .' department_id:部门ID'."\n" .' department_name:部门名称'."\n" .' date_id:日期', ], 'GetDepartmentalLatitudeAgentStatus' => [ 'summary' => '获取热线监控下部门纬度状态量。支持实例、时间区间、部门分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '技能组分组id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], 'required' => false, ], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据技能组分组id分组显示', 'description' => '是否根据部门分组查询。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'message', ], 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'title' => '数据', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总共记录数', 'description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '每页的数量', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"tenant_id":905,"n_resttype_now":0,"tenant_name":"非单元测试化BU","n_resttype1_now":0,"department_id":-1,"department_name":-1,"n_resttype98_now":0,"n_online_now":0,"date_id":20210329,"n_resttype3_now":0,"n_resttype5_now":0,"n_busy_now":0,"n_resttype2_now":0,"n_idle_now":0,"n_resttype4_now":0,"n_ack_now":0,"n_resttype99_now":0}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态码。返回200代表请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '接口调用是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"message\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":905,\\\\\\"n_resttype_now\\\\\\":0,\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"n_resttype1_now\\\\\\":0,\\\\\\"department_id\\\\\\":-1,\\\\\\"department_name\\\\\\":-1,\\\\\\"n_resttype98_now\\\\\\":0,\\\\\\"n_online_now\\\\\\":0,\\\\\\"date_id\\\\\\":20210329,\\\\\\"n_resttype3_now\\\\\\":0,\\\\\\"n_resttype5_now\\\\\\":0,\\\\\\"n_busy_now\\\\\\":0,\\\\\\"n_resttype2_now\\\\\\":0,\\\\\\"n_idle_now\\\\\\":0,\\\\\\"n_resttype4_now\\\\\\":0,\\\\\\"n_ack_now\\\\\\":0,\\\\\\"n_resttype99_now\\\\\\":0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nxxxx\\nEE338D98-9BD3-4413-B165\\n\\n 1\\n 2000\\n 4\\n \\n <0>\\n 905\\n 0\\n 非单元测试化BU\\n 0\\n -1\\n -1\\n 0\\n 0\\n 20210329\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n <1>\\n 905\\n 0\\n 非单元测试化BU\\n 0\\n -1\\n -1\\n 0\\n 0\\n 0\\n 20210401\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n\\n200\\ntrue\\n","errorExample":""}]', 'title' => '获取热线监控下部门纬度状态量', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写部门信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" ."\n" .' n_idle_now:当前空闲坐席数'."\n" .' n_resttype_now:当前小休坐席数'."\n" .' n_resttype1_now:当前普通小休坐席数'."\n" .' n_resttype2_now:当前就餐小休坐席数'."\n" .' n_resttype3_now:当前会议小休坐席数'."\n" .' n_resttype4_now:当前辅导小休坐席数'."\n" .' n_resttype5_now:当前培训小休坐席数'."\n" .' n_resttype98_now:当前强制小休坐席数'."\n" .' n_resttype99_now:当前签入小休坐席数'."\n" .' n_ack_now:当前后处理坐席数'."\n" .' n_online_now:当前在线坐席数'."\n" .' n_busy_now:通话坐席数'."\n" .' tenant_id:租户ID'."\n" .' tenant_name:租户名称'."\n" .' department_id:部门ID'."\n" .' department_name:部门名称'."\n" .' date_id:日期'."\n" .' n_inqueue_now:排队中会员数'."\n" .' n_inservice_now:服务中会员数'."\n" .' time_value:时间戳'."\n" .' fst_assign_time:该队列最早的时间,排队中的分配时间', ], 'GetSkillGroupLatitudeState' => [ 'summary' => '获取热线下监控技能组纬度状态量。支持实例、时间区间、部门、技能组分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], 'required' => false, ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '技能组id列表', 'description' => '技能组ID列表。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, ], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据部门分组', 'description' => '是否根据部门分组。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据技能组分组', 'description' => '是否根据技能组分组。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总共记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '每页的数量', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"tenant_id":"905","n_resttype_now":0,"tenant_name":"非单元测试化BU","n_resttype1_now":0,"group_name":"-1","department_id":"-1","department_name":"-1","n_resttype98_now":0,"n_online_now":0,"date_id":"20210329","n_resttype3_now":0,"n_resttype5_now":0,"n_busy_now":0,"n_resttype2_now":0,"group_id":"-1","n_idle_now":0,"n_resttype4_now":0,"n_ack_now":0,"n_resttype99_now":0,"maximumqueuingtime":-1}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态编码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '接口调用是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"n_resttype_now\\\\\\":0,\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"n_resttype1_now\\\\\\":0,\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_resttype98_now\\\\\\":0,\\\\\\"n_online_now\\\\\\":0,\\\\\\"date_id\\\\\\":\\\\\\"20210329\\\\\\",\\\\\\"n_resttype3_now\\\\\\":0,\\\\\\"n_resttype5_now\\\\\\":0,\\\\\\"n_busy_now\\\\\\":0,\\\\\\"n_resttype2_now\\\\\\":0,\\\\\\"group_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_idle_now\\\\\\":0,\\\\\\"n_resttype4_now\\\\\\":0,\\\\\\"n_ack_now\\\\\\":0,\\\\\\"n_resttype99_now\\\\\\":0,\\\\\\"maximumqueuingtime\\\\\\":-1}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n200\\n\\n 1\\n 2000\\n \\n 905\\n 0\\n 非单元测试化BU\\n 0\\n -1\\n -1\\n -1\\n 0\\n 0\\n 20210329\\n 0\\n 0\\n 0\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n -1\\n \\n \\n 905\\n 0\\n 非单元测试化BU\\n 0\\n -1\\n -1\\n -1\\n 0\\n 0\\n 20210330\\n 0\\n 0\\n 0\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n -1\\n \\n \\n 905\\n 0\\n 非单元测试化BU\\n 0\\n -1\\n -1\\n -1\\n 0\\n 0\\n 0\\n 20210401\\n 0\\n 0\\n 0\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n \\n 905\\n 0\\n 非单元测试化BU\\n 0\\n -1\\n -1\\n -1\\n 0\\n 0\\n 0\\n 20210331\\n 0\\n 0\\n 0\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n 4\\n\\n200\\nsuccessful\\n197C2792-E080-48BD-BDC7-F4A02852052E\\ntrue\\n","errorExample":""}]', 'title' => '获取热线下监控技能组纬度状态量', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写部门、技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" ."\n" .' n_idle_now:当前空闲坐席数'."\n" .' n_resttype_now:当前小休坐席数'."\n" .' n_resttype1_now:当前普通小休坐席数'."\n" .' n_resttype2_now:当前就餐小休坐席数'."\n" .' n_resttype3_now:当前会议小休坐席数'."\n" .' n_resttype4_now:当前辅导小休坐席数'."\n" .' n_resttype5_now:当前培训小休坐席数'."\n" .' n_resttype98_now:当前强制小休坐席数'."\n" .' n_resttype99_now:当前签入小休坐席数'."\n" .' n_ack_now:当前后处理坐席数'."\n" .' tenant_id:租户ID'."\n" .' tenant_name:租户名称'."\n" .' group_id:技能组ID'."\n" .' group_name:技能组名称'."\n" .' department_id:部门ID'."\n" .' department_name:部门名称'."\n" .' n_online_now:当前在线坐席数'."\n" .' n_inqueue_now:排队中会员数'."\n" .' n_inservice_now:服务中会员数'."\n" .' time_value:时间戳'."\n" .' fst_assign_time:该队列最早的时间,排队中的分配时间'."\n", ], 'GetAgentBasisStatus' => [ 'summary' => '获取热线监控下坐席纬度状态量。支持实例、时间区间、坐席、部门分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '坐席id列表', 'description' => '坐席ID列表。', 'type' => 'array', 'items' => [ 'description' => '坐席ID。'."\n" ."\n" .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口,查看返回参数的**AgentId**,即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '["2256****","2257****"]', ], 'required' => false, ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '["6083****","6084****"]', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"tenant_id":"905","servicer_id":"73****","tenant_name":"测试","recordgmtmodified":"2021-04-01 11:36:50","pk_id":"7320372021****","statusstarttime":"2021-04-01 11:36:50","recordgmtcreate":"2021-04-01 10:06:24","department_id":"94****","department_name":"测试技能组","lstlogintime":"2021-04-01 10:06:24","date_id":"20210401","triggerreason":"3","servicer_status":"D","assignstatus":"1","servicerreal_name":"xx","servicerstatusname":"签出","fstlogintime":"2021-04-01 10:06:24","servicer_name":"xx"}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"servicer_id\\\\\\":\\\\\\"73****\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"测试\\\\\\",\\\\\\"recordgmtmodified\\\\\\":\\\\\\"2021-04-01 11:36:50\\\\\\",\\\\\\"pk_id\\\\\\":\\\\\\"7320372021****\\\\\\",\\\\\\"statusstarttime\\\\\\":\\\\\\"2021-04-01 11:36:50\\\\\\",\\\\\\"recordgmtcreate\\\\\\":\\\\\\"2021-04-01 10:06:24\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"94****\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"测试技能组\\\\\\",\\\\\\"lstlogintime\\\\\\":\\\\\\"2021-04-01 10:06:24\\\\\\",\\\\\\"date_id\\\\\\":\\\\\\"20210401\\\\\\",\\\\\\"triggerreason\\\\\\":\\\\\\"3\\\\\\",\\\\\\"servicer_status\\\\\\":\\\\\\"D\\\\\\",\\\\\\"assignstatus\\\\\\":\\\\\\"1\\\\\\",\\\\\\"servicerreal_name\\\\\\":\\\\\\"xx\\\\\\",\\\\\\"servicerstatusname\\\\\\":\\\\\\"签出\\\\\\",\\\\\\"fstlogintime\\\\\\":\\\\\\"2021-04-01 10:06:24\\\\\\",\\\\\\"servicer_name\\\\\\":\\\\\\"xx\\\\\\"}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n OK\\n 200\\n true\\n \\n 1\\n 2000\\n 4\\n \\n 905\\n 732037\\n 测试\\n 2021-04-01 11:36:50\\n 73203720210401\\n 2021-04-01 11:36:50\\n 2021-04-01 10:06:24\\n 945044\\n 测试技能组\\n 2021-04-01 10:06:24\\n 20210401\\n 3\\n D\\n 1\\n xx\\n 签出\\n 2021-04-01 10:06:24\\n xx\\n \\n \\n 905\\n 674154\\n 测试\\n 2021-04-01 10:02:44\\n 67415420210401\\n 2021-04-01 10:02:44\\n 2021-04-01 09:41:08\\n 10\\n default\\n 2021-04-01 09:41:08\\n 20210401\\n 3\\n D\\n 1\\n xx\\n 签出\\n 2021-04-01 09:24:39\\n xx\\n \\n \\n","errorExample":""}]', 'title' => '获取热线监控下坐席纬度状态量', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写坐席、部门信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" .' '."\n" .' servicer_id:坐席ID'."\n" .' servicer_name:坐席名称'."\n" .' servicer_real_name:坐席真实姓名'."\n" .' department_id:部门ID'."\n" .' department_name:部门名称'."\n" .' servicer_status:热线坐席状态'."\n" .' servicer_status_name:热线坐席名称'."\n" .' status_start_time:状态开始时间'."\n" .' assign_status:分配状态'."\n" .' rest_type:小休类型', ], 'GetAgentStatistics' => [ 'summary' => '获取热线监控下坐席纬度统计量。支持实例、时间区间、坐席、部门分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束日期时间戳。单位:毫秒。 ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '坐席id列表', 'description' => '坐席ID列表。', 'type' => 'array', 'items' => [ 'description' => '坐席ID。'."\n" ."\n" .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口,查看返回参数的**AgentId**,即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], 'required' => false, ], ], [ 'name' => 'TimeLatitudeType', 'in' => 'query', 'schema' => [ 'title' => '时间纬度类型', 'description' => '时间纬度类型。取值:'."\n" ."\n" .'- **minute**:分钟。'."\n" .'- **hour**:小时。', 'type' => 'string', 'required' => false, 'example' => 'minute', ], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ExistAgentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据坐席分组', 'description' => '是否根据坐席分组查询。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"n_resttype_1":15,"t_outcall_speak":829747,"average_incoming_time":"8451.29","n_resttype_3":0,"minute_id":"-1","n_conference_speak":0,"n_resttype_2":0,"n_resttype_5":0,"n_resttype_4":0,"n_resttype_7":0,"n_resttype_6":0,"n_resttype_9":0,"n_resttype_8":0,"n_outcall_dial":25,"total_break_time":"58555","n_internal_speak":0,"n_send_step_transfer":7,"n_consulted_internal_speak":0}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。'."\n", 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"n_resttype_1\\\\\\":15,\\\\\\"t_outcall_speak\\\\\\":829747,\\\\\\"average_incoming_time\\\\\\":\\\\\\"8451.29\\\\\\",\\\\\\"n_resttype_3\\\\\\":0,\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_conference_speak\\\\\\":0,\\\\\\"n_resttype_2\\\\\\":0,\\\\\\"n_resttype_5\\\\\\":0,\\\\\\"n_resttype_4\\\\\\":0,\\\\\\"n_resttype_7\\\\\\":0,\\\\\\"n_resttype_6\\\\\\":0,\\\\\\"n_resttype_9\\\\\\":0,\\\\\\"n_resttype_8\\\\\\":0,\\\\\\"n_outcall_dial\\\\\\":25,\\\\\\"total_break_time\\\\\\":\\\\\\"58555\\\\\\",\\\\\\"n_internal_speak\\\\\\":0,\\\\\\"n_send_step_transfer\\\\\\":7,\\\\\\"n_consulted_internal_speak\\\\\\":0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\nEE338D98-9BD3-4413-B165\\nxxxx\\n200\\ntrue\\n\\n 1\\n 2000\\n 4\\n \\n 15\\n 829747\\n 8451.29\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 25\\n 58555\\n 0\\n 7\\n 0\\n 0\\n 0\\n -1\\n 0\\n 149082\\n 0\\n -1\\n 0\\n 7\\n 非单元测试化BU\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 16080\\n 0\\n 42475\\n 0\\n 0\\n 0\\n 0\\n 0\\n -1\\n 19\\n 0\\n 905\\n 3354042\\n 0\\n 0\\n 20210401\\n 24351698\\n 0\\n -1\\n 0\\n 0\\n 0\\n 1\\n 119787.21\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 14.02%\\n 33\\n 0\\n 59159\\n 7\\n 13479337\\n -1\\n 0\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n 32143\\n 0\\n 0\\n 10272\\n 0\\n 0\\n 0\\n 28\\n \\n \\n 37\\n 1488093\\n 33735.46\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 55\\n 12864720.00\\n 0\\n 18\\n 0\\n 0\\n 0\\n -1\\n 0\\n 239446\\n 0\\n -1\\n 0\\n 19\\n 非单元测试化BU\\n 0\\n 0\\n 0\\n 0\\n 0\\n 12335654\\n 0\\n 0\\n 31206\\n 0\\n 497860\\n 0\\n 0\\n 0\\n 0\\n 0\\n -1\\n 44\\n 0\\n 905\\n 7312000\\n 0\\n 0\\n 20210331\\n 89671620\\n 0\\n -1\\n 0\\n 0\\n 0\\n 19\\n 110787.88\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 8.64%\\n 78\\n 0\\n 438561\\n 13\\n 35241392\\n -1\\n 0\\n 0\\n -1\\n 0\\n 1\\n 0\\n 0\\n 108450\\n 0\\n 0\\n 155824\\n 0\\n 0\\n 0\\n 66\\n \\n \\n 2\\n 522649\\n 18256.25\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 16\\n 9691903.00\\n 0\\n 6\\n 0\\n 0\\n 0\\n -1\\n 0\\n 58753\\n 0\\n -1\\n 0\\n 8\\n 非单元测试化BU\\n 0\\n 0\\n 0\\n 0\\n 0\\n 9651198\\n 0\\n 0\\n 0\\n 0\\n 40705\\n 0\\n 0\\n 0\\n 0\\n 0\\n -1\\n 15\\n 0\\n 905\\n 6827000\\n 0\\n 0\\n 20210330\\n 51739230\\n 0\\n -1\\n 0\\n 0\\n 0\\n 15\\n 341350\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 13.34%\\n 13\\n 0\\n 73025\\n 4\\n 14771327\\n -1\\n 0\\n 0\\n -1\\n 0\\n 2\\n 0\\n 0\\n 111221\\n 0\\n 0\\n 244633\\n 0\\n 0\\n 0\\n 20\\n \\n \\n 1\\n 1820512\\n 45884\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 33\\n 1519362\\n 0\\n 0\\n 0\\n 0\\n 0\\n -1\\n 0\\n 146820\\n 0\\n -1\\n 0\\n 4\\n 非单元测试化BU\\n 0\\n 0\\n 0\\n 0\\n 0\\n 1517714\\n 0\\n 0\\n 1000\\n 0\\n 648\\n 0\\n 0\\n 0\\n 0\\n 0\\n -1\\n 30\\n 0\\n 905\\n 1865504\\n 0\\n 0\\n 20210329\\n 32107726\\n 0\\n -1\\n 0\\n 0\\n 0\\n 6\\n 60177.55\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 5.95%\\n 21\\n 0\\n 45884\\n 1\\n 17206386\\n -1\\n 0\\n 0\\n -1\\n 0\\n 1\\n 0\\n 0\\n 69951\\n 0\\n 0\\n 222646\\n 0\\n 0\\n 0\\n 31\\n \\n \\n 1\\n 0\\n 0\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 1104\\n 0\\n 0\\n 0\\n 0\\n 0\\n -1\\n 0\\n 0\\n 0\\n -1\\n 0\\n 0\\n 非单元测试化BU\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 1104\\n 0\\n 0\\n 0\\n 0\\n 0\\n -1\\n 0\\n 0\\n 905\\n 0\\n 0\\n 0\\n 20210328\\n 38104\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0.00%\\n 1\\n 0\\n 0\\n 0\\n 22000\\n -1\\n 0\\n 0\\n -1\\n 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 1\\n 2631\\n 5190\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 2\\n 12264\\n 0\\n 0\\n 0\\n 0\\n 0\\n -1\\n 0\\n 58169\\n 0\\n -1\\n 0\\n 2\\n 非单元测试化BU\\n 0\\n 0\\n 0\\n 0\\n 0\\n 9831\\n 0\\n 0\\n 1000\\n 0\\n 1433\\n 0\\n 0\\n 0\\n 0\\n 0\\n -1\\n 1\\n 0\\n 905\\n 18000\\n 0\\n 0\\n 20210326\\n 12557584\\n 0\\n -1\\n 0\\n 0\\n 0\\n 1\\n 6000\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0.18%\\n 2\\n 0\\n 5190\\n 1\\n 445320\\n -1\\n 0\\n 0\\n -1\\n 0\\n 1\\n 0\\n 0\\n 32202\\n 0\\n 0\\n 21478\\n 0\\n 0\\n 0\\n 3\\n \\n \\n 0\\n -1\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n -1\\n 0\\n -1\\n 0\\n 非单元测试化BU\\n -1\\n 0\\n 0\\n 905\\n 0\\n 0\\n 20210325\\n 2098898\\n -1\\n 0\\n 0\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n 0\\n -1\\n 0\\n 0\\n 0\\n 2098898\\n -1\\n 0\\n 0\\n -1\\n 0\\n 0\\n 0\\n 0\\n 0\\n 0\\n \\n\\n","errorExample":""}]', 'title' => '获取热线监控下坐席纬度统计量', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写坐席、部门信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明: '."\n" .' '."\n" .' t_incall_ring:呼入振铃时长'."\n" .' t_incall_speak:呼入时长'."\n" .' t_outcall_dial:拨号时长-外部'."\n" .' t_outcall_speak:呼出时长'."\n" .' t_internal_dial:内部拨号时长'."\n" .' t_internal_speak:内部通话时长'."\n" .' t_internal_ring:内部振铃时长'."\n" .' t_consult_internal_speak:求助时长(内部)'."\n" .' t_consulted_internal_ring:求助振铃时长(内部)'."\n" .' t_consulted_internal_speak:被求助时长(内部)'."\n" .' t_consult_external_speak:求助时长(外部)'."\n" .' t_conference_speak:会议时长'."\n" .' t_hold:保持时长'."\n" .' t_held:被保持时长'."\n" .' t_login:登录时长'."\n" .' t_resttype_1:普通小休时长'."\n" .' t_resttype_2:就餐小休时长'."\n" .' t_resttype_3:会议小休时长'."\n" .' t_resttype_4:辅导小休时长'."\n" .' t_resttype_5:培训小休时长'."\n" .' t_resttype_98:系统强制小休时长'."\n" .' t_resttype_99:坐席签入小休时长'."\n" .' t_idle:空闲时长'."\n" .' t_acw:后处理时长(外呼)'."\n" .' t_outcall_acw_end:外呼后处理'."\n" .' t_incall_acw_end:呼入后处理'."\n" .' n_incall_ring:呼入振铃次数'."\n" .' n_incall_speak:呼入量'."\n" .' n_outcall_dial:拨号量--外部'."\n" .' n_outcall_speak:呼出量'."\n" .' n_internal_dial:内部拨号次数'."\n" .' n_internal_speak:内部通话次数'."\n" .' n_internal_ring:内部振铃次数'."\n" .' n_consult_internal_dial:求助发起次数(内部)'."\n" .' n_consult_internal_speak:求助次数(内部)'."\n" .' n_consulted_internal_ring:被求助振铃次数(内部)'."\n" .' n_consulted_internal_speak:被求助次数(内部)'."\n" .' n_consult_external_dial:发起求助次数(外部)'."\n" .' n_consult_external_speak:求助次数(外部)'."\n" .' n_send_conference:发起会议次数'."\n" .' n_conference_speak:会议次数'."\n" .' n_send_step_transfer:单步转接发起次数'."\n" .' n_send_finish_transfer:双步转接次数'."\n" .' n_send_monitor_error:监听失败次数'."\n" .' n_hold:保持次数'."\n" .' n_held:被保持次数'."\n" .' n_resttype_1:普通小休次数'."\n" .' n_resttype_2:就餐小休次数'."\n" .' n_resttype_3:会议小休次数'."\n" .' n_resttype_4:辅导小休次数'."\n" .' n_resttype_5:培训小休次数'."\n" .' n_resttype_98:系统强制小休次数'."\n" .' n_resttype_99:坐席签入小休次数'."\n" .' n_acw:后处理次数'."\n" .' n_outcall_acw_end:后处理次数-呼出'."\n" .' n_incall_acw_end:后处理次数-呼入', ], 'GetOnlineServiceVolume' => [ 'summary' => '获取在线监控下在线服务量。支持实例、时间区间、坐席、部门、技能组分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '坐席id列表', 'description' => '坐席ID列表。', 'type' => 'array', 'items' => [ 'description' => '坐席ID。'."\n" ."\n" .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口,查看返回参数的**AgentId**,即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], 'required' => false, ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '技能组id列表', 'description' => '技能组ID列表。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', ], 'required' => false, ], ], [ 'name' => 'TimeLatitudeType', 'in' => 'query', 'schema' => [ 'title' => '时间纬度类型', 'description' => '时间纬度类型。取值:'."\n" .'- **minute**:分钟。'."\n" .'- **hour**:小时。'."\n" .'- **day**:天。', 'type' => 'string', 'required' => false, 'example' => 'minute', ], ], [ 'name' => 'ExistAgentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据坐席分组', 'description' => '是否根据坐席分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '服务数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"tenant_id":"905","online_40s_transfer_ready_cnt":109,"minute_id":"-1","wait_time_len":1215,"pickup_rate":"63.09%","thirty_seconds_to_pickUp":"2560","date_id":"-1","online_over_out_cnt":0,"online_20s_transfer_ready_cnt":109,"thirty_seconds_response_rate":"63.09%","abandonment_rate":"63.09%","service_time_len":68378,"service_pickup":"2560","hour_id":"-1","online_10s_transfer_ready_cnt":109}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"online_40s_transfer_ready_cnt\\\\\\":109,\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"wait_time_len\\\\\\":1215,\\\\\\"pickup_rate\\\\\\":\\\\\\"63.09%\\\\\\",\\\\\\"thirty_seconds_to_pickUp\\\\\\":\\\\\\"2560\\\\\\",\\\\\\"date_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_over_out_cnt\\\\\\":0,\\\\\\"online_20s_transfer_ready_cnt\\\\\\":109,\\\\\\"thirty_seconds_response_rate\\\\\\":\\\\\\"63.09%\\\\\\",\\\\\\"abandonment_rate\\\\\\":\\\\\\"63.09%\\\\\\",\\\\\\"service_time_len\\\\\\":68378,\\\\\\"service_pickup\\\\\\":\\\\\\"2560\\\\\\",\\\\\\"hour_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_10s_transfer_ready_cnt\\\\\\":109}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\nxxxx\\n200\\ntrue\\n\\n 1\\n 2000\\n 4\\n \\n <0>\\n 905\\n 109\\n -1\\n 1215\\n 63.09%\\n 2560\\n -1\\n 0\\n 109\\n 63.09%\\n 63.09%\\n 68378\\n 2560\\n -1\\n 109\\n 3843\\n 109\\n 4058\\n --\\n 88\\n 2451\\n 0\\n 26\\n -1\\n 2451\\n 非单元测试化BU\\n 2451\\n 2450\\n -1\\n -1\\n -1\\n 109\\n 100.00%\\n 109\\n 1\\n 1392\\n -1\\n 215\\n 0\\n --\\n 2451\\n 2451\\n 0\\n \\n \\n\\nEE338D98-9BD3-4413-B165\\n","errorExample":""}]', 'title' => '获取在线监控下在线服务量', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写坐席、部门、技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" .' '."\n" .' online_direct_request_cnt:直连请求量'."\n" .' online_transfer_request_cnt:转交请求量(转交代表是别人转交给该小二的)'."\n" .' online_direct_giveup_cnt:直连放弃量'."\n" .' online_transfer_giveup_cnt:转交放弃量'."\n" .' online_direct_ready_cnt:直连接起量'."\n" .' online_transfer_ready_cnt:转交接起量'."\n" .' online_10s_direct_ready_cnt:直连10s接起量'."\n" .' online_10s_transfer_ready_cnt:转交10s接起量'."\n" .' online_20s_direct_ready_cnt:直连20s接起量'."\n" .' online_20s_transfer_ready_cnt:转交20s接起量'."\n" .' online_30s_direct_ready_cnt:直连30s接起量'."\n" .' online_30s_transfer_ready_cnt:转交30s接起量'."\n" .' online_40s_direct_ready_cnt:直连40s接起量'."\n" .' online_40s_transfer_ready_cnt:转交40s接起量'."\n" .' online_60s_direct_ready_cnt:直连60s接起量'."\n" .' online_60s_transfer_ready_cnt:转交60s接起量'."\n" .' online_over_out_cnt:技能组溢出量'."\n" .' online_over_in_cnt:技能组溢入量'."\n" .' online_sat_cnt:满意数'."\n" .' online_normal_cnt:一般数'."\n" .' online_unsat_cnt:不满意数'."\n" .' service_time_len:总服务时长'."\n" .' wait_time_len:总等待时长', ], 'GetSeatInformation' => [ 'summary' => '获取在线监控下部门坐席服务能力数据。支持实例、时间区间、部门分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'startDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'endDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'currentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'depIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', ], 'required' => false, ], ], [ 'name' => 'existDepartmentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'Rowr' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"tenant_id": "905", "tenant_name": "非单元测试化BU", "department_id": "-1", "svc_avai_capacity": 7, "svc_current_capacity": 0, "department_name": "-1", "svc_online_cnt": 3, "svc_ask_offline_servicer_num": 0, "date_id": "20210401", "svc_max_capacity": 7, "svc_rest_cnt": 0, "current_speci_ability_num": 0, "servicer_rest_cnt": 122, "max_speci_ability_num": 3, "svc_offline_cnt": 0, "svc_no_client_cnt": 3, "svc_ask_rest_servicer_num": 0}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rowr\\": \\"{\\\\\\"tenant_id\\\\\\": \\\\\\"905\\\\\\", \\\\\\"tenant_name\\\\\\": \\\\\\"非单元测试化BU\\\\\\", \\\\\\"department_id\\\\\\": \\\\\\"-1\\\\\\", \\\\\\"svc_avai_capacity\\\\\\": 7, \\\\\\"svc_current_capacity\\\\\\": 0, \\\\\\"department_name\\\\\\": \\\\\\"-1\\\\\\", \\\\\\"svc_online_cnt\\\\\\": 3, \\\\\\"svc_ask_offline_servicer_num\\\\\\": 0, \\\\\\"date_id\\\\\\": \\\\\\"20210401\\\\\\", \\\\\\"svc_max_capacity\\\\\\": 7, \\\\\\"svc_rest_cnt\\\\\\": 0, \\\\\\"current_speci_ability_num\\\\\\": 0, \\\\\\"servicer_rest_cnt\\\\\\": 122, \\\\\\"max_speci_ability_num\\\\\\": 3, \\\\\\"svc_offline_cnt\\\\\\": 0, \\\\\\"svc_no_client_cnt\\\\\\": 3, \\\\\\"svc_ask_rest_servicer_num\\\\\\": 0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n successful\\n 200\\n true\\n \\n 1\\n 2000\\n 4\\n {\\"tenant_id\\": \\"905\\", \\"tenant_name\\": \\"非单元测试化BU\\", \\"department_id\\": \\"-1\\", \\"svc_avai_capacity\\": 7, \\"svc_current_capacity\\": 0, \\"department_name\\": \\"-1\\", \\"svc_online_cnt\\": 3, \\"svc_ask_offline_servicer_num\\": 0, \\"date_id\\": \\"20210401\\", \\"svc_max_capacity\\": 7, \\"svc_rest_cnt\\": 0, \\"current_speci_ability_num\\": 0, \\"servicer_rest_cnt\\": 122, \\"max_speci_ability_num\\": 3, \\"svc_offline_cnt\\": 0, \\"svc_no_client_cnt\\": 3, \\"svc_ask_rest_servicer_num\\": 0}\\n \\n","errorExample":""}]', 'title' => '获取在线监控下部门坐席服务能力数据', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写部门信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" ."\n" .' svc_no_client_cnt:空闲座席数'."\n" .' svc_rest_cnt:小休座席数'."\n" .' svc_online_cnt:在线中的座席'."\n" .' svc_avai_capacity:当前空余服务能力'."\n" .' svc_ask_rest_servicer_num:申请小休的座席'."\n" .' svc_ask_offline_servicer_num:申请离线的座席'."\n" .' svc_offline_cnt:离线座席'."\n" .' svc_max_capacity:最大服务能力'."\n" .' svc_current_capacity:当前最大服务能力'."\n" .' max_speci_ability_num:最大的鲸吞加1能力服务量'."\n" .' current_speci_ability_num:当前的鲸吞加1能力服务量'."\n" .' special_ability_num:当前可分配的鲸吞加1的服务量'."\n" .' servicer_rest_cnt:小休次数', ], 'GetSkillGroupServiceCapability' => [ 'summary' => '获取在线监控下技能组纬度服务能力数据。支持实例、时间区间、部门、技能组分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。'."\n", 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], 'required' => false, ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '技能组id列表', 'description' => '技能组ID列表。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', ], 'required' => false, ], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{'."\n" .' "tenant_id": "905",'."\n" .' "tenant_name": "非单元测试化BU",'."\n" .' "group_name": "-1",'."\n" .' "department_id": "-1",'."\n" .' "department_name": "-1",'."\n" .' "svc_online_cnt": 0,'."\n" .' "svc_ask_offline_servicer_num": 0,'."\n" .' "date_id": "20210326",'."\n" .' "group_id": "-1",'."\n" .' "svc_rest_cnt": 0,'."\n" .' "servicer_rest_cnt": 234,'."\n" .' "svc_offline_cnt": 0,'."\n" .' "svc_no_client_cnt": 0,'."\n" .' "svc_ask_rest_servicer_num": 0'."\n" .'}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\n \\\\\\"tenant_id\\\\\\": \\\\\\"905\\\\\\",\\\\n \\\\\\"tenant_name\\\\\\": \\\\\\"非单元测试化BU\\\\\\",\\\\n \\\\\\"group_name\\\\\\": \\\\\\"-1\\\\\\",\\\\n \\\\\\"department_id\\\\\\": \\\\\\"-1\\\\\\",\\\\n \\\\\\"department_name\\\\\\": \\\\\\"-1\\\\\\",\\\\n \\\\\\"svc_online_cnt\\\\\\": 0,\\\\n \\\\\\"svc_ask_offline_servicer_num\\\\\\": 0,\\\\n \\\\\\"date_id\\\\\\": \\\\\\"20210326\\\\\\",\\\\n \\\\\\"group_id\\\\\\": \\\\\\"-1\\\\\\",\\\\n \\\\\\"svc_rest_cnt\\\\\\": 0,\\\\n \\\\\\"servicer_rest_cnt\\\\\\": 234,\\\\n \\\\\\"svc_offline_cnt\\\\\\": 0,\\\\n \\\\\\"svc_no_client_cnt\\\\\\": 0,\\\\n \\\\\\"svc_ask_rest_servicer_num\\\\\\": 0\\\\n}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n successful\\n 200\\n true\\n \\n 1\\n 2000\\n 4\\n {\\n \\"tenant_id\\": \\"905\\",\\n \\"tenant_name\\": \\"非单元测试化BU\\",\\n \\"group_name\\": \\"-1\\",\\n \\"department_id\\": \\"-1\\",\\n \\"department_name\\": \\"-1\\",\\n \\"svc_online_cnt\\": 0,\\n \\"svc_ask_offline_servicer_num\\": 0,\\n \\"date_id\\": \\"20210326\\",\\n \\"group_id\\": \\"-1\\",\\n \\"svc_rest_cnt\\": 0,\\n \\"servicer_rest_cnt\\": 234,\\n \\"svc_offline_cnt\\": 0,\\n \\"svc_no_client_cnt\\": 0,\\n \\"svc_ask_rest_servicer_num\\": 0\\n}\\n \\n","errorExample":""}]', 'title' => '获取在线监控下技能组纬度服务能力数据', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写部门、技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" ."\n" .' tenant_id:租户ID'."\n" .' tenant_name:租户名称'."\n" .' group_name:技能组名称'."\n" .' department_id:部门ID'."\n" .' department_name:部门名称'."\n" .' svc_no_client_cnt:空闲座席数'."\n" .' svc_rest_cnt:小休座席数'."\n" .' svc_online_cnt:在线中的座席'."\n" .' svc_avai_capacity:当前空余服务能力'."\n" .' svc_ask_rest_servicer_num:申请小休的座席'."\n" .' svc_ask_offline_servicer_num:申请离线的座席'."\n" .' svc_offline_cnt:离线座席'."\n" .' svc_max_capacity:最大服务能力'."\n" .' svc_current_capacity:当前最大服务能力'."\n" .' max_speci_ability_num:最大的鲸吞加1能力服务量'."\n" .' current_speci_ability_num:当前的鲸吞加1能力服务量'."\n" .' special_ability_num:当前可分配的鲸吞加1的服务量 '."\n" .' servicer_rest_cnt:小休次数'."\n" .' pk_id:主键', ], 'GetSkillGroupAgentStatusDetails' => [ 'summary' => '获取技能组服务状态量。支持实例、时间区间、部门、技能组分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614824872', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614824972', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', ], 'required' => false, ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '技能组id列表', 'description' => '技能组ID列表。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, ], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'title' => '每页的数量', 'description' => '每页的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"tenant_id": "905", "tenant_name": "非单元测试化BU", "department_id": "-1", "svc_avai_capacity": 7, "svc_current_capacity": 0, "department_name": "-1", "svc_online_cnt": 3, "svc_ask_offline_servicer_num": 0, "date_id": "20210401", "svc_max_capacity": 7, "svc_rest_cnt": 0, "current_speci_ability_num": 0, "servicer_rest_cnt": 122, "max_speci_ability_num": 3, "svc_offline_cnt": 0, "svc_no_client_cnt": 3, "svc_ask_rest_servicer_num": 0}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '接口调用是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\": \\\\\\"905\\\\\\", \\\\\\"tenant_name\\\\\\": \\\\\\"非单元测试化BU\\\\\\", \\\\\\"department_id\\\\\\": \\\\\\"-1\\\\\\", \\\\\\"svc_avai_capacity\\\\\\": 7, \\\\\\"svc_current_capacity\\\\\\": 0, \\\\\\"department_name\\\\\\": \\\\\\"-1\\\\\\", \\\\\\"svc_online_cnt\\\\\\": 3, \\\\\\"svc_ask_offline_servicer_num\\\\\\": 0, \\\\\\"date_id\\\\\\": \\\\\\"20210401\\\\\\", \\\\\\"svc_max_capacity\\\\\\": 7, \\\\\\"svc_rest_cnt\\\\\\": 0, \\\\\\"current_speci_ability_num\\\\\\": 0, \\\\\\"servicer_rest_cnt\\\\\\": 122, \\\\\\"max_speci_ability_num\\\\\\": 3, \\\\\\"svc_offline_cnt\\\\\\": 0, \\\\\\"svc_no_client_cnt\\\\\\": 3, \\\\\\"svc_ask_rest_servicer_num\\\\\\": 0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n successful\\n 200\\n true\\n \\n 1\\n 2000\\n 4\\n {\\"tenant_id\\": \\"905\\", \\"tenant_name\\": \\"非单元测试化BU\\", \\"department_id\\": \\"-1\\", \\"svc_avai_capacity\\": 7, \\"svc_current_capacity\\": 0, \\"department_name\\": \\"-1\\", \\"svc_online_cnt\\": 3, \\"svc_ask_offline_servicer_num\\": 0, \\"date_id\\": \\"20210401\\", \\"svc_max_capacity\\": 7, \\"svc_rest_cnt\\": 0, \\"current_speci_ability_num\\": 0, \\"servicer_rest_cnt\\": 122, \\"max_speci_ability_num\\": 3, \\"svc_offline_cnt\\": 0, \\"svc_no_client_cnt\\": 3, \\"svc_ask_rest_servicer_num\\": 0}\\n \\n","errorExample":""}]', 'title' => '获取技能组服务状态量', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写部门、技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" ."\n" .' group_name:技能组名称'."\n" .' department_id:部门ID'."\n" .' department_name:部门名称'."\n" .' tenant_id:租户ID'."\n" .' tenant_name:租户名称'."\n" .' svc_no_client_cnt:空闲座席数'."\n" .' svc_rest_cnt:小休座席数'."\n" .' svc_online_cnt:在线中的座席'."\n" .' svc_avai_capacity:当前空余服务能力'."\n" .' svc_ask_rest_servicer_num:申请小休的座席'."\n" .' svc_ask_offline_servicer_num:申请离线的座席'."\n" .' svc_offline_cnt:离线座席'."\n" .' svc_max_capacity:最大服务能力'."\n" .' svc_current_capacity:当前最大服务能力'."\n" .' max_speci_ability_num:最大的鲸吞加1能力服务量'."\n" .' current_speci_ability_num:当前的鲸吞加1能力服务量'."\n" .' special_ability_num:当前可分配的鲸吞加1的服务量', ], 'GetOnlineSeatInformation' => [ 'summary' => '获取在线监控下在线坐席信息数据。支持实例、时间区间、坐席、部门分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '坐席id列表', 'description' => '坐席ID列表。', 'type' => 'array', 'items' => [ 'description' => '坐席ID。'."\n" ."\n" .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口,查看返回参数的**AgentId**,即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', ], 'required' => false, ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误描述', 'description' => '状态码描述。 ', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"tenant_id":"905","max_service_num":"3","servicer_id":"36****","tenant_name":"非单元测试化BU","record_gmt_modified":"2021-04-01 23:20:03","pk_id":"3690012021****","record_gmt_create":"2021-04-01 23:19:55","department_id":"10****"}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。'."\n", 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"max_service_num\\\\\\":\\\\\\"3\\\\\\",\\\\\\"servicer_id\\\\\\":\\\\\\"36****\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"record_gmt_modified\\\\\\":\\\\\\"2021-04-01 23:20:03\\\\\\",\\\\\\"pk_id\\\\\\":\\\\\\"3690012021****\\\\\\",\\\\\\"record_gmt_create\\\\\\":\\\\\\"2021-04-01 23:19:55\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"10****\\\\\\"}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\nEE338D98-9BD3-4413-B165\\nxxxx\\n200\\ntrue\\n\\n 1\\n 2000\\n 4\\n \\n <0>\\n 905\\n 3\\n 369001\\n 非单元测试化BU\\n 2021-04-01 23:20:03\\n 36900120210401\\n 2021-04-01 23:19:55\\n 10\\n 107621101\\n default\\n 2021-04-01 23:20:00\\n 20210401\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试003\\n 0\\n 离线\\n 2021-04-01 00:18:32\\n 商业化阿里云自动化测试003\\n 48\\n 1\\n 2021-04-01 23:59:59\\n \\n <1>\\n 905\\n 3\\n 369003\\n 非单元测试化BU\\n 2021-04-02 23:18:36\\n 36900320210402\\n 2021-04-02 23:18:30\\n 10\\n 107633801\\n default\\n 2021-04-02 23:18:35\\n 20210402\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试005\\n 0\\n 离线\\n 2021-04-02 00:18:44\\n 商业化阿里云自动化测试005\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <2>\\n 905\\n 3\\n 353026\\n 非单元测试化BU\\n 2021-04-01 23:20:01\\n 35302620210401\\n 2021-04-01 23:19:56\\n 10\\n 107421301\\n default\\n 2021-04-01 23:20:00\\n 20210401\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试002\\n 0\\n 离线\\n 2021-04-01 00:19:54\\n 商业化阿里云自动化测试002\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <3>\\n 905\\n 3\\n 369009\\n 非单元测试化BU\\n 2021-04-01 16:24:57\\n 36900920210401\\n 2021-04-01 16:21:01\\n 10\\n 1080001\\n default\\n 2021-04-01 16:21:03\\n 20210401\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试011\\n 0\\n 离线\\n 2021-04-01 02:08:15\\n 商业化阿里云自动化测试011\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <4>\\n 905\\n 3\\n 353026\\n 非单元测试化BU\\n 2021-04-02 23:18:36\\n 35302620210402\\n 2021-04-02 23:18:31\\n 10\\n 107342801\\n default\\n 2021-04-02 23:18:36\\n 20210402\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试002\\n 0\\n 离线\\n 2021-04-02 00:18:45\\n 商业化阿里云自动化测试002\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <5>\\n 905\\n 3\\n 223001\\n 非单元测试化BU\\n 2021-04-01 15:43:10\\n 22300120210401\\n 2021-04-01 14:19:49\\n 10\\n 1080025\\n default\\n 2021-04-01 15:23:04\\n 20210401\\n 0\\n 0\\n D\\n 李步挺\\n 0\\n 离线\\n 2021-04-01 09:57:48\\n 李步挺\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <6>\\n 905\\n 3\\n 369008\\n 非单元测试化BU\\n 2021-04-01 23:20:00\\n 36900820210401\\n 2021-04-01 23:19:55\\n 10\\n 107621001\\n default\\n 2021-04-01 23:20:00\\n 20210401\\n 0\\n 0\\n 0\\n 商业化阿里云自动化测试010\\n 0\\n 离线\\n 2021-04-01 00:18:12\\n 商业化阿里云自动化测试010\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <7>\\n 905\\n 1\\n 369002\\n 非单元测试化BU\\n 2021-04-02 23:22:05\\n 36900220210402\\n 2021-04-02 23:18:30\\n 10\\n 107342601\\n default\\n 2021-04-02 23:22:00\\n 20210402\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试004\\n 0\\n 离线\\n 2021-04-02 00:18:44\\n 商业化阿里云自动化测试004\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <8>\\n 905\\n 3\\n 386018\\n 非单元测试化BU\\n 2021-04-02 23:18:39\\n 38601820210402\\n 2021-04-02 23:18:30\\n 10\\n 107717801\\n default\\n 2021-04-02 23:18:39\\n 20210402\\n 0\\n 0\\n D\\n 17000000098\\n 0\\n 离线\\n 2021-04-02 00:18:44\\n 17000000098\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <9>\\n 905\\n 3\\n 83001\\n 非单元测试化BU\\n 2021-04-02 16:42:07\\n 8300120210402\\n 2021-04-02 16:41:09\\n 10\\n 1086003\\n default\\n 2021-04-02 16:42:07\\n 20210402\\n 0\\n 0\\n D\\n 英如\\n 0\\n 离线\\n 2021-04-02 16:41:09\\n 英如\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <10>\\n 905\\n 3\\n 288074\\n 非单元测试化BU\\n 2021-04-01 11:30:19\\n 28807420210401\\n 2021-04-01 10:56:48\\n 862009\\n -288074\\n 冯相\\n 20210401\\n 0\\n 1\\n D\\n 冯相\\n 0\\n 离线\\n 言恒\\n 0\\n 1\\n 2021-04-02 00:00:00\\n \\n <11>\\n 905\\n 3\\n 317004\\n 非单元测试化BU\\n 2021-04-01 23:20:04\\n 31700420210401\\n 2021-04-01 23:19:54\\n 10\\n 107331201\\n default\\n 2021-04-01 23:20:04\\n 20210401\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试001\\n 0\\n 离线\\n 2021-04-01 00:18:11\\n 商业化阿里云自动化测试001\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <12>\\n 905\\n 3\\n 759020\\n 非单元测试化BU\\n 2021-04-01 19:18:51\\n 75902020210401\\n 2021-04-01 19:12:51\\n 10\\n 106600248\\n default\\n 2021-04-01 19:12:51\\n 20210401\\n 0\\n 0\\n D\\n 13291408908\\n 0\\n 离线\\n 2021-04-01 10:10:43\\n 13291408908\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <13>\\n 905\\n 3\\n 317004\\n 非单元测试化BU\\n 2021-04-02 23:18:38\\n 31700420210402\\n 2021-04-02 23:18:36\\n 10\\n 107431601\\n default\\n 2021-04-02 23:18:38\\n 20210402\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试001\\n 0\\n 离线\\n 2021-04-02 00:18:43\\n 商业化阿里云自动化测试001\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <14>\\n 905\\n 3\\n 369004\\n 非单元测试化BU\\n 2021-04-02 23:18:36\\n 36900420210402\\n 2021-04-02 23:18:30\\n 10\\n 107633701\\n default\\n 2021-04-02 23:18:35\\n 20210402\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试006\\n 0\\n 离线\\n 2021-04-02 00:18:44\\n 商业化阿里云自动化测试006\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <15>\\n 905\\n 5\\n 110002\\n 非单元测试化BU\\n 2021-04-01 23:19:56\\n 11000220210401\\n 2021-04-01 23:19:54\\n 10\\n 107620901\\n default\\n 2021-04-01 23:19:56\\n 20210401\\n 0\\n 0\\n D\\n 念茹\\n 0\\n 离线\\n 2021-04-01 00:18:11\\n 念茹\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <16>\\n 905\\n 3\\n 369003\\n 非单元测试化BU\\n 2021-04-01 23:20:00\\n 36900320210401\\n 2021-04-01 23:19:55\\n 10\\n 107421201\\n default\\n 2021-04-01 23:20:00\\n 20210401\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试005\\n 0\\n 离线\\n 2021-04-01 00:19:53\\n 商业化阿里云自动化测试005\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <17>\\n 905\\n 3\\n 369013\\n 非单元测试化BU\\n 2021-04-01 23:20:01\\n 36901320210401\\n 2021-04-01 23:19:55\\n 10\\n 107421001\\n default\\n 2021-04-01 23:20:01\\n 20210401\\n 0\\n 0\\n 1\\n 商业化阿里云自动化测试015\\n 0\\n 在线\\n 2021-04-01 00:18:22\\n 商业化阿里云自动化测试015\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <18>\\n 905\\n 3\\n 369004\\n 非单元测试化BU\\n 2021-04-01 23:20:00\\n 36900420210401\\n 2021-04-01 23:19:55\\n 10\\n 107519701\\n default\\n 2021-04-01 23:20:00\\n 20210401\\n 0\\n 0\\n 0\\n 商业化阿里云自动化测试006\\n 0\\n 离线\\n 2021-04-01 00:19:48\\n 商业化阿里云自动化测试006\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <19>\\n 905\\n 3\\n 369007\\n 非单元测试化BU\\n 2021-04-02 23:18:36\\n 36900720210402\\n 2021-04-02 23:18:30\\n 10\\n 107342701\\n default\\n 2021-04-02 23:18:36\\n 20210402\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试009\\n 0\\n 离线\\n 2021-04-02 00:18:44\\n 商业化阿里云自动化测试009\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <20>\\n 905\\n 3\\n 386018\\n 非单元测试化BU\\n 2021-04-01 23:20:04\\n 38601820210401\\n 2021-04-01 23:19:55\\n 10\\n 107331301\\n default\\n 2021-04-01 23:20:04\\n 20210401\\n 0\\n 0\\n 0\\n 17000000098\\n 0\\n 离线\\n 2021-04-01 00:19:23\\n 17000000098\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <21>\\n 905\\n 3\\n 369009\\n 非单元测试化BU\\n 2021-04-02 10:28:45\\n 36900920210402\\n 2021-04-02 10:25:15\\n 10\\n 1085002\\n default\\n 2021-04-02 10:25:17\\n 20210402\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试011\\n 0\\n 离线\\n 2021-04-02 02:12:15\\n 商业化阿里云自动化测试011\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <22>\\n 905\\n 3\\n 362137\\n 非单元测试化BU\\n 2021-04-01 00:32:10\\n 36213720210401\\n 2021-04-01 00:24:51\\n 10\\n 106600229\\n default\\n 2021-04-01 00:32:09\\n 20210401\\n 0\\n 0\\n D\\n 15700089356\\n 0\\n 离线\\n 2021-04-01 00:24:51\\n 15700089356\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <23>\\n 905\\n 3\\n 721093\\n 非单元测试化BU\\n 2021-04-01 18:42:13\\n 72109320210401\\n 2021-04-01 18:20:38\\n 10\\n 1083002\\n default\\n 2021-04-01 18:22:16\\n 20210401\\n 0\\n 0\\n D\\n 马珍4号\\n 0\\n 离线\\n 2021-04-01 18:20:38\\n 马珍4号\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <24>\\n 905\\n 2\\n 219005\\n 非单元测试化BU\\n 2021-04-02 19:01:22\\n 21900520210402\\n 2021-04-02 17:24:02\\n 10\\n 1086002\\n default\\n 2021-04-02 17:24:02\\n 20210402\\n 0\\n 0\\n D\\n 云殊\\n 0\\n 离线\\n 2021-04-02 15:59:02\\n 云殊\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <25>\\n 905\\n 3\\n 772041\\n 2021-04-02 11:05:59\\n 77204120210402\\n 2021-04-02 10:57:17\\n 10\\n -772041\\n 20210402\\n 0\\n 1\\n D\\n 0\\n 离线\\n 易南\\n 0\\n 1\\n 2021-04-03 00:00:00\\n \\n <26>\\n 905\\n 3\\n 195002\\n 非单元测试化BU\\n 2021-04-01 10:42:27\\n 19500220210401\\n 2021-04-01 10:25:45\\n 83002\\n 107336201\\n 百富旅行\\n 2021-04-01 10:25:45\\n 20210401\\n 0\\n 0\\n D\\n 翰怀real\\n 0\\n 离线\\n 2021-04-01 10:25:45\\n 翰怀show\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <27>\\n 905\\n 2\\n 219005\\n 非单元测试化BU\\n 2021-04-01 19:11:41\\n 21900520210401\\n 2021-04-01 00:33:37\\n 10\\n 106600230\\n default\\n 2021-04-01 00:33:37\\n 20210401\\n 0\\n 0\\n D\\n 云殊\\n 0\\n 离线\\n 2021-04-01 00:33:37\\n 云殊\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <28>\\n 905\\n 3\\n 369007\\n 非单元测试化BU\\n 2021-04-01 23:20:00\\n 36900720210401\\n 2021-04-01 23:19:55\\n 10\\n 107621201\\n default\\n 2021-04-01 23:20:00\\n 20210401\\n 0\\n 0\\n 0\\n 商业化阿里云自动化测试009\\n 0\\n 离线\\n 2021-04-01 00:20:02\\n 商业化阿里云自动化测试009\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <29>\\n 905\\n 3\\n 549011\\n 非单元测试化BU\\n 2021-04-01 15:06:17\\n 54901120210401\\n 2021-04-01 14:55:04\\n 10\\n -549011\\n default\\n 20210401\\n 0\\n 0\\n 0\\n 18818262279\\n 0\\n 离线\\n 18818262279\\n 0\\n 1\\n 2021-04-02 00:00:00\\n \\n <30>\\n 905\\n 5\\n 110002\\n 非单元测试化BU\\n 2021-04-02 23:18:32\\n 11000220210402\\n 2021-04-02 23:18:30\\n 10\\n 107527601\\n default\\n 2021-04-02 23:18:31\\n 20210402\\n 0\\n 0\\n D\\n 念茹\\n 0\\n 离线\\n 2021-04-02 00:18:44\\n 念茹\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <31>\\n 905\\n 3\\n 369001\\n 非单元测试化BU\\n 2021-04-02 23:18:38\\n 36900120210402\\n 2021-04-02 23:18:30\\n 10\\n 107342401\\n default\\n 2021-04-02 23:18:36\\n 20210402\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试003\\n 0\\n 离线\\n 2021-04-02 00:18:44\\n 商业化阿里云自动化测试003\\n 48\\n 1\\n 2021-04-02 23:59:59\\n \\n <32>\\n 905\\n 3\\n 369013\\n 非单元测试化BU\\n 2021-04-02 23:18:37\\n 36901320210402\\n 2021-04-02 23:18:30\\n 10\\n 107527801\\n default\\n 2021-04-02 23:18:37\\n 20210402\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试015\\n 0\\n 离线\\n 2021-04-02 00:18:44\\n 商业化阿里云自动化测试015\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <33>\\n 905\\n 3\\n 411009\\n 非单元测试化BU\\n 2021-04-02 18:03:19\\n 41100920210402\\n 2021-04-02 15:42:29\\n 10\\n -411009\\n default\\n 20210402\\n 0\\n 0\\n D\\n 陈宇1\\n 0\\n 离线\\n 陈宇1\\n 0\\n 1\\n 2021-04-03 00:00:00\\n \\n <34>\\n 905\\n 3\\n 335002\\n 非单元测试化BU\\n 2021-04-01 23:19:57\\n 33500220210401\\n 2020-09-08 14:08:06\\n 10\\n -335002\\n default\\n 20210401\\n 0\\n 0\\n 99\\n 班务自动化账号001\\n 0\\n 培训\\n 班务自动化账号001\\n 0\\n 1\\n 2020-09-09 00:00:00\\n \\n <35>\\n 905\\n 3\\n 369014\\n 非单元测试化BU\\n 2021-04-01 23:20:01\\n 36901420210401\\n 2021-04-01 23:19:55\\n 10\\n 107708101\\n default\\n 2021-04-01 23:20:01\\n 20210401\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试016\\n 0\\n 离线\\n 2021-04-01 00:18:41\\n 商业化阿里云自动化测试016\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <36>\\n 905\\n 3\\n 679089\\n 非单元测试化BU\\n 2021-04-01 23:22:46\\n 67908920210401\\n 2021-04-01 23:15:27\\n 10\\n 1083001\\n default\\n 2021-04-01 23:15:27\\n 20210401\\n 0\\n 0\\n D\\n 马珍\\n 0\\n 离线\\n 2021-04-01 18:07:47\\n 马珍\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <37>\\n 905\\n 3\\n 86001\\n 非单元测试化BU\\n 2021-04-01 16:13:36\\n 8600120210401\\n 2021-04-01 16:02:01\\n 112005\\n 107429901\\n 苗硕测试专用部门(勿加)\\n 2021-04-01 16:02:16\\n 20210401\\n 0\\n 0\\n D\\n 苗硕\\n 0\\n 离线\\n 2021-04-01 16:02:01\\n 苗硕\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <38>\\n 905\\n 3\\n 679089\\n 非单元测试化BU\\n 2021-04-02 11:01:53\\n 67908920210402\\n 2021-04-02 09:43:32\\n 10\\n 107346101\\n default\\n 2021-04-02 10:57:33\\n 20210402\\n 0\\n 0\\n D\\n 马珍\\n 0\\n 离线\\n 2021-04-02 09:43:32\\n 马珍\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <39>\\n 905\\n 1\\n 369002\\n 非单元测试化BU\\n 2021-04-01 23:23:29\\n 36900220210401\\n 2021-04-01 23:19:55\\n 10\\n 107708201\\n default\\n 2021-04-01 23:23:29\\n 20210401\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试004\\n 0\\n 离线\\n 2021-04-01 00:19:52\\n 商业化阿里云自动化测试004\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <40>\\n 905\\n 3\\n 335002\\n 非单元测试化BU\\n 2021-04-02 23:18:33\\n 33500220210402\\n 2020-09-08 14:08:06\\n 10\\n -335002\\n default\\n 20210402\\n 0\\n 0\\n 99\\n 班务自动化账号001\\n 0\\n 培训\\n 班务自动化账号001\\n 0\\n 1\\n 2020-09-09 00:00:00\\n \\n <41>\\n 905\\n 3\\n 369008\\n 非单元测试化BU\\n 2021-04-02 23:18:36\\n 36900820210402\\n 2021-04-02 23:18:30\\n 10\\n 107342501\\n default\\n 2021-04-02 23:18:35\\n 20210402\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试010\\n 0\\n 离线\\n 2021-04-02 00:18:44\\n 商业化阿里云自动化测试010\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <42>\\n 905\\n 3\\n 369005\\n 非单元测试化BU\\n 2021-04-01 23:20:01\\n 36900520210401\\n 2021-04-01 23:19:55\\n 10\\n 107421101\\n default\\n 2021-04-01 23:20:01\\n 20210401\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试007\\n 0\\n 离线\\n 2021-04-01 00:19:53\\n 商业化阿里云自动化测试007\\n 0\\n 1\\n 2021-04-01 23:59:59\\n \\n <43>\\n 905\\n 3\\n 411009\\n 非单元测试化BU\\n 2021-04-01 19:11:40\\n 41100920210401\\n 2021-03-31 10:31:44\\n 10\\n -411009\\n default\\n 20210401\\n 0\\n 0\\n D\\n 陈宇1\\n 0\\n 离线\\n 陈宇1\\n 0\\n 1\\n 2021-04-01 00:00:00\\n \\n <44>\\n 905\\n 3\\n 369005\\n 非单元测试化BU\\n 2021-04-02 23:18:37\\n 36900520210402\\n 2021-04-02 23:18:30\\n 10\\n 107527701\\n default\\n 2021-04-02 23:18:36\\n 20210402\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试007\\n 0\\n 离线\\n 2021-04-02 00:18:44\\n 商业化阿里云自动化测试007\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n <45>\\n 905\\n 3\\n 369014\\n 非单元测试化BU\\n 2021-04-02 23:18:35\\n 36901420210402\\n 2021-04-02 23:18:30\\n 10\\n 107342301\\n default\\n 2021-04-02 23:18:35\\n 20210402\\n 0\\n 0\\n D\\n 商业化阿里云自动化测试016\\n 0\\n 离线\\n 2021-04-02 00:18:44\\n 商业化阿里云自动化测试016\\n 0\\n 1\\n 2021-04-02 23:59:59\\n \\n \\n\\n","errorExample":""}]', 'title' => '获取在线监控下在线坐席信息数据', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写坐席、部门信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" ."\n" .' department_id:部门ID'."\n" .' tenant_id:租户ID'."\n" .' tenant_name:租户名称'."\n" .' current_service_num:当前服务能力'."\n" .' max_service_num:最大服务能力'."\n" .' max_speci_ability_num:鲸吞加1,当前的最大使用能力'."\n" .' current_speci_ability_num:鲸吞加1,当前的已经使用能力'."\n" .' speci_ability_status:鲸吞加1。当前的状态,n0:暂停分配状态,n1:可分配状态'."\n" .' servicer_status_name:热线坐席名称'."\n" .' fst_login_time:当天最早的登录时间'."\n" .' lst_login_time:当天最晚的登录时间'."\n" .' servicer_rest_cnt:小休次数 ', ], 'GetQueueInformation' => [ 'summary' => '获取在线监控下技能组纬度队列信息。支持实例、时间区间、部门、技能组分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '技能组id列表', 'description' => '技能组ID列表。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', ], 'required' => false, ], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误描述', 'description' => '状态码的描述。', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"tenant_id":"905","tenant_name":"非单元测试化BU","group_id":"-1","group_name":"-1","department_id":"-1","department_name":"-1","current_session_wait_cnt":0,"current_session_service_cnt":0,"date_id":"20210327","maximum_queuing_time":-1}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '请求状态码。返回200代表请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"group_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"current_session_wait_cnt\\\\\\":0,\\\\\\"current_session_service_cnt\\\\\\":0,\\\\\\"date_id\\\\\\":\\\\\\"20210327\\\\\\",\\\\\\"maximum_queuing_time\\\\\\":-1}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n xxxx\\n 200\\n true\\n \\n 1\\n 2000\\n 4\\n {\\"tenant_id\\":\\"905\\",\\"tenant_name\\":\\"非单元测试化BU\\",\\"group_id\\":\\"-1\\",\\"group_name\\":\\"-1\\",\\"department_id\\":\\"-1\\",\\"department_name\\":\\"-1\\",\\"current_session_wait_cnt\\":0,\\"current_session_service_cnt\\":0,\\"date_id\\":\\"20210327\\",\\"maximum_queuing_time\\":-1}\\n \\n","errorExample":""}]', 'title' => '获取在线监控下技能组纬度队列信息', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写部门、技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" ."\n" .' group_name:技能组名称'."\n" .' group_id:技能组ID'."\n" .' department_id:部门ID'."\n" .' department_name:部门名称'."\n" .' date_id:日期'."\n" .' tenant_id:租户ID'."\n" .' tenant_name:租户名称'."\n" .' current_session_wait_cnt:排队会员'."\n" .' current_session_service_cnt:服务中会员'."\n" .' eventide:事件时间'."\n" .' fst_assign_time:该队列最早的时间,排队中的分配时间'."\n" .' ', ], 'GetSkillGroupStatusTotal' => [ 'summary' => '获取热线报表下技能组状态总量。支持实例、时间区间、坐席、部门、技能组分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '坐席id列表', 'description' => '坐席ID列表。', 'type' => 'array', 'items' => [ 'description' => '坐席ID。'."\n" ."\n" .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口,查看返回参数的**AgentId**,即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', ], 'required' => false, ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '技能组id列表', 'description' => '技能组ID列表。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], 'required' => false, ], ], [ 'name' => 'TimeLatitudeType', 'in' => 'query', 'schema' => [ 'title' => '时间纬度类型', 'description' => '时间纬度类型。取值:'."\n" ."\n" .'- **minute**:分钟。'."\n" .'- **hour**:小时。'."\n" .'- **day**:天。', 'type' => 'string', 'required' => false, 'example' => 'minute', ], ], [ 'name' => 'ExistAgentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据坐席分组', 'description' => '是否根据坐席分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"minute_id":"-1","call_out_intervene_servicer_cnt":26,"call_out_servicer_cnt":35,"call_out_intervene_60s_cnt":155,"servicer_real_name":"--","call_in_sep_normal_cnt":0,"call_out_intervene_30s_cnt":235,"servicer_id":"-1","tenant_name":"非单元测试化BU","call_out_sep_sat_cnt":1}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '接口调用是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。'."\n", 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"call_out_intervene_servicer_cnt\\\\\\":26,\\\\\\"call_out_servicer_cnt\\\\\\":35,\\\\\\"call_out_intervene_60s_cnt\\\\\\":155,\\\\\\"servicer_real_name\\\\\\":\\\\\\"--\\\\\\",\\\\\\"call_in_sep_normal_cnt\\\\\\":0,\\\\\\"call_out_intervene_30s_cnt\\\\\\":235,\\\\\\"servicer_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"call_out_sep_sat_cnt\\\\\\":1}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\nEE338D98-9BD3-4413-B165\\nxxxx\\n200\\ntrue\\n\\n 1\\n 2000\\n 4\\n \\n <0>\\n -1\\n 26\\n 35\\n 155\\n --\\n 0\\n 235\\n -1\\n 非单元测试化BU\\n 1\\n -1\\n 0\\n 2\\n 2\\n 42885\\n 0\\n 555\\n 6\\n --\\n 29081\\n 1187\\n 905\\n 0\\n 0\\n 0\\n 2\\n 0\\n -1\\n 0.00%\\n 93\\n -1\\n 0.00%\\n 1187\\n 2\\n 5\\n 555\\n 0\\n -1\\n -1\\n 42885\\n 1\\n 2\\n 3\\n -1\\n 100%\\n 0\\n 0\\n 283\\n 2\\n \\n \\n\\n","errorExample":""}]', 'title' => '获取热线报表下技能组状态总量', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写坐席、部门、技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" ."\n" .' date_id:日期 '."\n" .' hour_id:小时'."\n" .' minute_id:分钟'."\n" .' servicer_id:小二ID'."\n" .' servicer_name:小二名称'."\n" .' servicer_real_name :小二姓名'."\n" .' group_id:技能组ID '."\n" .' group_name:技能组名称'."\n" .' department_id:部门ID'."\n" .' department_name:部门名称'."\n" .' tenant_id :租户ID'."\n" .' tenant_name:租户名称 '."\n" .' inline_cnt:进线量'."\n" .' request_cnt:请求量(进行量-重新分配量) '."\n" .' ready_cnt:接起量 '."\n" .' reassign_cnt:重新分配量 '."\n" .' ready_cnt_60s:60秒接起量 '."\n" .' ringqueue_len :进入队列到振铃 '."\n" .' ringtime_len:振铃到接起 '."\n" .' queue_len:进入队列到接起 '."\n" .' service_time_len:接起到结束,服务时长'."\n" .' give_up_len:进入队列到结束,放弃总时长 '."\n" .' call_out_cnt:外呼量 '."\n" .' call_out_intervene_cnt:外呼振铃总时长-结束-振铃'."\n" .' call_out_sep_sat_cnt:呼出-热线评价满意量 '."\n" .' call_out_sep_normal_cnt:呼出-热线评价一般量'."\n" .' call_out_sep_unsat_cnt:呼出-热线评价不满意量 '."\n" .' call_out_unsep_cnt:呼出-热线参评但未评价量 '."\n" .' call_in_unsep_cnt:呼入-热线参评但未评价量 '."\n" .' call_in_sep_sat_cnt:呼入-热线评价满意量 '."\n" .' call_in_sep_normal_cnt:呼入-热线评价一般量 '."\n" .' call_in_sep_unsat_cnt:呼入-热线评价不满意量 '."\n" .' call_out_intervene_20s_cnt:呼出-通话>20s的接通量'."\n" .' call_out_intervene_30s_cnt:呼出-通话>30s的接通量'."\n" .' call_out_intervene_60s_cnt:呼出-通话>60s的接通量'."\n" .' call_in_intervene_20s_cnt:呼入-通话>20s的接通量'."\n" .' call_in_intervene_30s_cnt:呼入-通话>30s的接通量'."\n" .' call_in_intervene_60s_cnt:呼入-通话>60s的接通量'."\n", ], 'GetAgentDetailReport' => [ 'summary' => '获取热线报表下热线坐席详情汇总数据。支持实例、时间区间、坐席、部门分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。'."\n", 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '坐席id列表', 'description' => '坐席ID列表。', 'type' => 'array', 'items' => [ 'description' => '坐席ID。'."\n" ."\n" .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口,查看返回参数的**AgentId**,即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', ], 'required' => false, ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], 'required' => false, ], ], [ 'name' => 'TimeLatitudeType', 'in' => 'query', 'schema' => [ 'title' => '时间纬度类型', 'description' => '时间纬度类型。取值:'."\n" ."\n" .'- **minute**:分钟。'."\n" .'- **hour**:小时。'."\n" .'- **day**:天。', 'type' => 'string', 'required' => false, 'example' => 'day', ], ], [ 'name' => 'ExistAgentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据坐席分组显示', 'description' => '是否根据坐席分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据部门分组显示', 'description' => '是否根据部门分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"t_wait":379322.0,"hotline_time_outcall_avg":"32.00","n_ringing":0,"t_outbound_40":0.0,"hotline_time_incall_avg":-1,"t_calldialing":0.0,"n_inbound":276,"servicer_id":"-1","call_in_sep_sat_cnt":13,"request_cnt":231,"n_not_ready_99":811,"t_work_outbound":49338.0,"hotline_rate_handle_in_60s":"96%","n_not_ready_login":811,"t_not_ready_login":0.0,"n_work_inbound":176,"}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"t_wait\\\\\\":379322.0,\\\\\\"hotline_time_outcall_avg\\\\\\":\\\\\\"32.00\\\\\\",\\\\\\"n_ringing\\\\\\":0,\\\\\\"t_outbound_40\\\\\\":0.0,\\\\\\"hotline_time_incall_avg\\\\\\":-1,\\\\\\"t_calldialing\\\\\\":0.0,\\\\\\"n_inbound\\\\\\":276,\\\\\\"servicer_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"call_in_sep_sat_cnt\\\\\\":13,\\\\\\"request_cnt\\\\\\":231,\\\\\\"n_not_ready_99\\\\\\":811,\\\\\\"t_work_outbound\\\\\\":49338.0,\\\\\\"hotline_rate_handle_in_60s\\\\\\":\\\\\\"96%\\\\\\",\\\\\\"n_not_ready_login\\\\\\":811,\\\\\\"t_not_ready_login\\\\\\":0.0,\\\\\\"n_work_inbound\\\\\\":176,\\\\\\"}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"EE338D98-9BD3-4413-B165\\nxxxx\\n200\\ntrue\\n\\n 1\\n 2000\\n 4\\n \\n 379322\\n 32.00\\n 0\\n 0\\n -1\\n 0\\n 276\\n -1\\n 13\\n 231\\n 811\\n 49338\\n 96%\\n 811\\n 0\\n 176\\n 0\\n 21210\\n 0\\n 905\\n 4.91\\n 864\\n 120.93\\n 0\\n 20281\\n 0\\n -1\\n 720474\\n 11.92%\\n 62\\n 451\\n 0\\n 0\\n -1\\n 641\\n -1\\n 33539\\n 0\\n 50\\n 5\\n 185\\n 5\\n 1558\\n 387\\n 0\\n 0\\n 0\\n 1\\n 2\\n -1\\n 1047\\n 128\\n -1\\n 408\\n 1\\n 66844\\n 5\\n 0\\n 0\\n 184\\n 非单元测试化BU\\n 0\\n 0\\n 276\\n 0\\n 33539\\n 0\\n 0\\n 2257\\n 3484\\n 0\\n 1232\\n -1\\n 0\\n 4349\\n 14\\n 0\\n 23\\n 0\\n 0\\n 193\\n 6784\\n 0\\n 0\\n 268\\n 0\\n 0\\n 1048\\n 0\\n 6784\\n 984\\n 30\\n 0\\n 3181\\n 0\\n 0\\n 0\\n 0\\n 45\\n 224\\n 670\\n 0\\n 5987\\n \\n","errorExample":""}]', 'title' => '获取热线报表下热线坐席详情汇总数据', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写坐席、部门信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" ."\n" .' date_id:日期'."\n" .' servicer_id:服务小二ID'."\n" .' servicer_name:小二名称'."\n" .' servicer_real_name:小二真实姓名'."\n" .' department_id:部门ID'."\n" .' department_name:部门名称'."\n" .' tenant_id:租户ID'."\n" .' tenant_name:租户名称'."\n" .' n_consult:咨询处理'."\n" .' n_consult_made:发起咨询次数'."\n" .' n_consult_take:接受咨询次数'."\n" .' n_dialing:拨号次数'."\n" .' n_hold:保持次数'."\n" .' n_inbound:呼入次数'."\n" .' n_internal:内部呼叫量'."\n" .' n_internal_in:内部呼入呼叫量'."\n" .' n_internal_out:内部呼出呼叫量'."\n" .' n_not_ready:小休总次数'."\n" .' n_not_ready_login:软电话登录小休次数'."\n" .' n_outbound:呼出电话次数--拨出并且进行通话'."\n" .' n_ringing:振铃总次数'."\n" .' n_talk:总通话次数'."\n" .' n_wait:等待次数'."\n" .' n_work:总后处理次数(ACW)'."\n" .' n_work_inbound:总后处理次数-呼入'."\n" .' n_work_outbound:总后处理次数-呼出'."\n" .' t_calldialing:拨号总时长'."\n" .' t_consult:咨询处理时长'."\n" .' t_consult_made:发起咨询时长'."\n" .' t_consult_taken:接受咨询次数'."\n" .' t_hold:呼叫保持时长'."\n" .' t_inbound:呼入时长'."\n" .' t_internal:内部呼叫时长'."\n" .' t_internal_in:内部呼入时长'."\n" .' t_internal_out:内部呼出时长'."\n" .' t_login:总登录时长'."\n" .' t_not_ready_login登录小休时长'."\n" .' t_outbound:外呼总时长--拨出并且进行通话'."\n" .' t_ringing:振铃时长'."\n" .' t_talk:通话总时长'."\n" .' t_wait:空闲总时长'."\n" .' t_work话:后处理总时长'."\n" .' t_work_inbound:话后时长(呼入)'."\n" .' t_work_outbound:话后时长(呼出)'."\n" .' t_not_ready:小休总时长'."\n" .' t_not_ready_1:普通小休时长'."\n" .' t_not_ready_2:就餐小休时长'."\n" .' t_not_ready_3:会议小休时长'."\n" .' t_not_ready_4:辅导小休时长'."\n" .' t_not_ready_5:培训小休时长'."\n" .' t_not_ready_99:坐席签入小休时长'."\n" .' n_not_ready_1:普通小休次数'."\n" .' n_not_ready_2:就餐小休次数'."\n" .' n_not_ready_3:会议小休次数'."\n" .' n_not_ready_4:辅导小休次数'."\n" .' n_not_ready_5:培训小休次数'."\n" .' n_not_ready_99:坐席签入小休次数'."\n" .' n_inbound_40:呼入通话时长大于40s电话量'."\n" .' t_inbound_40:呼入时长,每个大于40秒的呼入总时长'."\n" .' n_outbound_40:呼出通话时长大于40s电话量'."\n" .' t_outbound_40:呼出时长,每个大于40秒的呼入总时长'."\n" .' n_outbound_dial:呼出拨打量-即外呼拨打就统计'."\n" .' t_not_ready_sr:小休做工单时长'."\n" .' n_not_ready_sr:小休做工单次数'."\n" .' inline_cnt:进线量'."\n" .' request_cnt:请求量(进行量-重新分配量)'."\n" .' ready_cnt接起量'."\n" .' reassign_cnt:重新分配量'."\n" .' ready_cnt_60s:60秒接起量'."\n" .' ringqueue_len:进入队列到振铃'."\n" .' ringtime_len:振铃到接起'."\n" .' queue_len:进入队列到接起'."\n" .' service_time_len:接起到结束,服务时长'."\n" .' give_up_len进入队列到结束,放弃总时长'."\n" .' call_out_cnt:外呼量'."\n" .' call_out_intervene_cnt:外呼接通量'."\n" .' call_out_ring_len:外呼振铃总时长-结束-振铃'."\n" .' call_out_all_len:外呼总时长-结束-开始'."\n" .' call_out_intervene_len:外呼接通时长-结束-接起'."\n" .' call_out_sep_sat_cnt:呼出-热线评价满意量'."\n" .' call_out_sep_normal_cnt:呼出-热线评价一般量'."\n" .' call_out_sep_unsat_cnt:呼出-热线评价不满意量'."\n" .' call_out_unsep_cnt:呼出-热线参评但未评价量'."\n" .' call_in_unsep_cnt:呼入-热线参评但未评价量'."\n" .' call_in_sep_sat_cnt:呼入-热线评价满意量'."\n" .' call_in_sep_normal_cnt:呼入-热线评价一般量'."\n" .' call_in_sep_unsat_cnt:呼入-热线评价不满意量'."\n" .' call_out_intervene_20s_cnt:呼出-通话>20s的接通量'."\n" .' call_out_intervene_30s_cnt:呼出-通话>30s的接通量'."\n" .' call_out_intervene_60s_cnt:呼出-通话>60s的接通量'."\n" .' call_in_intervene_20s_cnt:呼入-通话>20s的接通量'."\n" .' call_in_intervene_30s_cnt:呼入-通话>30s的接通量'."\n" .' call_in_intervene_60s_cnt:呼入-通话>60s的接通量', ], 'GetSkillGroupServiceStatus' => [ 'summary' => '获取在线报表下技能组服务状态量。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '技能组id列表', 'description' => '坐席ID列表。', 'type' => 'array', 'items' => [ 'description' => '坐席ID。'."\n" ."\n" .'可调用[GetAgent](~~2717961~~)接口,查看返回参数的**AgentId**,即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](~~2717975~~)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', ], 'required' => false, ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '技能组id列表', 'description' => '技能组ID列表。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](~~2717970~~)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', ], 'required' => false, ], ], [ 'name' => 'TimeLatitudeType', 'in' => 'query', 'schema' => [ 'title' => '时间纬度类型', 'description' => '时间纬度类型。取值:'."\n" .'- **minute**:分钟。'."\n" .'- **hour**:小时。'."\n" .'- **day**:天。', 'type' => 'string', 'required' => false, 'example' => 'minute', ], ], [ 'name' => 'ExistAgentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据技能组分组', 'description' => '是否根据技能组分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ExistRobotInstanceGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据机器实例分组', 'description' => '是否根据机器实例分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'ExistChannelInstanceGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据渠道实例分组', 'description' => '是否根据渠道实例分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PageSize' => [ 'title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"online_40s_transfer_ready_cnt":382,"minute_id":"-1","online_unsatis_cnt":0,"online_simple_cnt":0,"average_queue_time":"0.39","service_pickup":"7752","online_service_time_len":220753,"online_direct_give_up_len":1187,"channel_instance_name":"-1","servicer_id":"-1","tenant_name":"非单元测试化BU","group_name":"-1","online_30s_transfer_ready_cnt":382}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageSize\\": 2000,\\n \\"PageNum\\": 1,\\n \\"Rows\\": \\"{\\\\\\"online_40s_transfer_ready_cnt\\\\\\":382,\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_unsatis_cnt\\\\\\":0,\\\\\\"online_simple_cnt\\\\\\":0,\\\\\\"average_queue_time\\\\\\":\\\\\\"0.39\\\\\\",\\\\\\"service_pickup\\\\\\":\\\\\\"7752\\\\\\",\\\\\\"online_service_time_len\\\\\\":220753,\\\\\\"online_direct_give_up_len\\\\\\":1187,\\\\\\"channel_instance_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"servicer_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_30s_transfer_ready_cnt\\\\\\":382}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\nEE338D98-9BD3-4413-B165\\nxxxx\\n200\\ntrue\\n\\n 1\\n 2000\\n 4\\n \\n 382\\n -1\\n 0\\n 0\\n 0.39\\n 7752\\n 220753\\n 1187\\n -1\\n -1\\n 非单元测试化BU\\n -1\\n 382\\n 551\\n 2242\\n -1\\n 177\\n 马珍4号\\n -1\\n 905\\n 2\\n <_30_seconds_pick_up_rate>75.21%\\n 2\\n 75.21%\\n -1\\n 382\\n 313\\n -1\\n 382\\n 9612\\n 382\\n 10307\\n -1\\n 0.00%\\n 7370\\n 695\\n 313\\n 9\\n 7370\\n 7370\\n <_30_seconds_to_pick_up>7752\\n 7367\\n 3852\\n -1\\n -1\\n -1\\n 382\\n 3907\\n 4.84\\n 2667\\n -1\\n 695\\n 2555\\n 2\\n 7370\\n 7370\\n 0.49\\n \\n\\n","errorExample":""}]', 'title' => '获取在线报表下技能组服务状态量', 'description' => '### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" ."\n" .' date_id:日期'."\n" .' hour_id:小时'."\n" .' minute_id:分钟-5分钟,如:05,10,00,15'."\n" .' servicer_id:小二ID'."\n" .' servicer_name:小二名称'."\n" .' group_id:技能组ID'."\n" .' group_name:技能组名称'."\n" .' department_id:部门ID'."\n" .' department_name:部门名称'."\n" .' tenant_id:租户ID'."\n" .' tenant_name:租户名称'."\n" .' robot_instance_id:机器人ID'."\n" .' robot_instance_name:机器人名称'."\n" .' channel_instance_id:渠道实例ID'."\n" .' channel_instance_name:渠道实例名称'."\n" .' online_direct_request_cnt:用户直接请求的服务量(直连)'."\n" .' online_transfer_request_cnt:被转入的用户服务请求量'."\n" .' online_direct_ready_cnt:用户直接接起的服务量(直连)'."\n" .' online_transfer_ready_cnt:被转入的用户接起服务量'."\n" .' online_transfer_in_give_up_cnt:转交后用户放弃量(未接起量)'."\n" .' online_transfer_out_cnt:转出的总量(建议通过产品上落标记动作直接取数)'."\n" .' online_direct_give_up_cnt:放弃量(直连)直接请求放弃的量'."\n" .' online_transfer_give_up_cnt:放弃量(转入)转入后放弃的量'."\n" .' online_10s_direct_ready_cnt:10秒接起量(直连)'."\n" .' online_10s_transfer_ready_cnt:10秒接起量(转入)'."\n" .' online_20s_direct_ready_cnt:20秒接起量(直连)'."\n" .' online_20s_transfer_ready_cnt:20秒接起量(转入)'."\n" .' online_30s_direct_ready_cnt:30秒接起量(直连)'."\n" .' online_30s_transfer_ready_cnt:30秒接起量(转入)'."\n" .' online_40s_direct_ready_cnt:40秒接起量(直连)'."\n" .' online_40s_transfer_ready_cnt:40秒接起量(转入)'."\n" .' online_60s_direct_ready_cnt:60秒接起量(直连)'."\n" .' online_60s_transfer_ready_cnt:60秒接起量(转入)'."\n" .' online_service_time_len:服务总时长对应技能组中,小二开始服务的时间到小二服务结束时间(如果发生转交,服务结束时间=转交时间)'."\n" .' online_direct_wait_len:等待总时长(直连)直连接起量的进入队列到接起待时长'."\n" .' online_transfer_wait_len:等待总时长(转入)转入接起量的进入队列到接起待时长'."\n" .' online_direct_give_up_len:放弃总时长(直连)直连接起量的进入队列到放弃时长'."\n" .' online_transfer_give_up_len:放弃总时长(转入)转入接起量的进入队列到放弃的时长(如果有放弃的,其时长算在最后一个目标技能组)'."\n" .' online_direct_response_len:响应时长(直连)会员发出对话到小二回复的平均间隔时长'."\n" .' online_transfer_response_len:响应时长(转入)会员发出对话到小二回复的平均间隔时长'."\n" .' online_direct_response_times:响应次数(直连)会员发出对话到小二回复的间隔次数'."\n" .' online_transfer_response_times:响应次数(转入)会员发出对话到小二回复的间隔次数'."\n" .' online_satis_cnt:满意数-touch的评价'."\n" .' online_simple_cnt:一般数-touch的评价'."\n" .' online_unsatis_cnt:不满意数-touch的评价', ], 'GetAgentServiceStatus' => [ 'summary' => '获取在线报表下坐席服务状态量。支持实例、时间区间、坐席、部门分组查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'title' => '开始日期时间戳(毫秒)', 'description' => '开始时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'title' => '结束日期时间戳(毫秒)', 'description' => '结束时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小(默认为10)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页(默认为1)', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '坐席id列表', 'description' => '坐席ID列表。', 'type' => 'array', 'items' => [ 'description' => '坐席ID。'."\n" ."\n" .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口,查看返回参数的**AgentId**,即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', ], 'required' => false, ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '部门id列表', 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], 'required' => false, ], ], [ 'name' => 'TimeLatitudeType', 'in' => 'query', 'schema' => [ 'title' => '时间纬度类型', 'description' => '时间纬度类型。取值:'."\n" ."\n" .'- **minute**:分钟。'."\n" .'- **hour**:小时。'."\n" .'- **day**:天。', 'type' => 'string', 'required' => false, 'example' => 'minute', ], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据部门分组', 'description' => '是否根据部门分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ExistAgentGrouping', 'in' => 'query', 'schema' => [ 'title' => '是否根据坐席分组', 'description' => '是否根据坐席分组查询。默认值:**false**。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => '错误描述', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'title' => '请求ID,用于跟踪错误原因', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'title' => 'data', 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'title' => '总记录数', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4', ], 'PageNum' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'title' => '页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', ], 'Rows' => [ 'title' => '信息为list类型的json字符串', 'description' => '信息为List类型的JSON字符串。', 'type' => 'string', 'example' => '{"online_40s_transfer_ready_cnt":81,"minute_id":"-1","online_unsatis_cnt":0,"online_simple_cnt":0,"average_queue_time":-1,"service_pickup":"2086","total_waiting_time":"981","online_service_time_len":58208,"online_direct_give_up_len":0,"break_ratio":"2%"}', ], ], ], 'Code' => [ 'title' => '错误编码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '调用接口是否成功', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"online_40s_transfer_ready_cnt\\\\\\":81,\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_unsatis_cnt\\\\\\":0,\\\\\\"online_simple_cnt\\\\\\":0,\\\\\\"average_queue_time\\\\\\":-1,\\\\\\"service_pickup\\\\\\":\\\\\\"2086\\\\\\",\\\\\\"total_waiting_time\\\\\\":\\\\\\"981\\\\\\",\\\\\\"online_service_time_len\\\\\\":58208,\\\\\\"online_direct_give_up_len\\\\\\":0,\\\\\\"break_ratio\\\\\\":\\\\\\"2%\\\\\\"}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nxxxx\\nEE338D98-9BD3-4413-B165\\n\\n 1\\n 2000\\n 4\\n \\n <0>\\n 81\\n -1\\n 0\\n 0\\n -1\\n 2086\\n 981\\n 58208\\n 0\\n 2%\\n --\\n 27.90\\n -1\\n 非单元测试化BU\\n 81\\n 119\\n 0\\n 33\\n --\\n 905\\n 1\\n <_30_seconds_pick_up_rate>-1\\n 0\\n -1\\n -1\\n 17605\\n 81\\n 0\\n -1\\n 81\\n 81\\n 0.00%\\n 2005\\n 151\\n 305\\n 0\\n 0\\n 2005\\n 2005\\n <_30_seconds_to_pick_up>2086\\n 2004\\n 948\\n -1\\n -1\\n -1\\n 81\\n 0\\n 5.76\\n 685\\n -1\\n 1\\n 2005\\n 426.56\\n 2005\\n -1\\n \\n \\n\\n200\\ntrue\\n","errorExample":""}]', 'title' => '获取在线报表下坐席服务状态量', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写坐席、部门信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '返回参数Rows参数说明:'."\n" ."\n" .' date_id:日期'."\n" .' hour_id:小时'."\n" .' minute_id:分钟-5分钟,如:05,10,00,15'."\n" .' servicer_id:小二ID'."\n" .' servicer_name:小二名称'."\n" .' servicer_real_name:小二真实名称'."\n" .' department_id:部门ID'."\n" .' department_name:部门名称'."\n" .' tenant_id:租户ID'."\n" .' tenant_name:租户名称'."\n" .' online_direct_ready_cnt:用户直接接起的服务量(直连)'."\n" .' online_transfer_ready_cnt:被转入的用户接起服务量'."\n" .' online_transfer_in_give_up_cnt:转交后用户放弃量(未接起量)'."\n" .' online_transfer_out_cnt:转出的总量(建议通过产品上落标记动作直接取数)'."\n" .' online_direct_give_up_cnt:放弃量(直连)直接请求放弃的量'."\n" .' online_transfer_give_up_cnt:放弃量(转入)转入后放弃的量'."\n" .' online_10s_direct_ready_cnt:10秒接起量(直连)'."\n" .' online_10s_transfer_ready_cnt:10秒接起量(转入)'."\n" .' online_20s_direct_ready_cnt:20秒接起量(直连)'."\n" .' online_20s_transfer_ready_cnt:20秒接起量(转入)'."\n" .' online_30s_direct_ready_cnt:30秒接起量(直连)'."\n" .' online_30s_transfer_ready_cnt:30秒接起量(转入)'."\n" .' online_40s_direct_ready_cn:40秒接起量(直连)'."\n" .' online_40s_transfer_ready_cnt:40秒接起量(转入)'."\n" .' online_60s_direct_ready_cnt:60秒接起量(直连)'."\n" .' online_60s_transfer_ready_cnt:60秒接起量(转入)'."\n" .' online_service_time_len:服务总时长对应技能组中,小二开始服务的时间到小二服务结束时间(如果发生转交,服务结束时间=转交时间)'."\n" .' online_direct_wait_len:等待总时长(直连)直连接起量的进入队列到接起待时长'."\n" .' online_transfer_wait_len:等待总时长(转入)转入接起量的进入队列到接起待时长'."\n" .' online_direct_give_up_len:放弃总时长(直连)直连接起量的进入队列到放弃时长'."\n" .' online_transfer_give_up_len:放弃总时长(转入)转入接起量的进入队列到放弃的时长(如果有放弃的,其时长算在最后一个目标技能组)'."\n" .' online_direct_response_len:响应时长(直连)会员发出对话到小二回复的平均间隔时长'."\n" .' online_transfer_response_len:响应时长(转入)会员发出对话到小二回复的平均间隔时长'."\n" .' online_direct_response_times:响应次数(直连)会员发出对话到小二回复的间隔次数'."\n" .' online_transfer_response_times:响应次数(转入)会员发出对话到小二回复的间隔次数'."\n" .' online_satis_cnt:满意数-touch的评价'."\n" .' online_simple_cnt:一般数-touch的评价'."\n" .' online_unsatis_cnt:不满意数-touch的评价'."\n" .' t_login:总登录时长'."\n" .' t_rest:小休总时长', ], 'CreateAgent' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '15515', 'abilityTreeNodes' => [ 'FEATUREaiccsDTMAFT', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'title' => 'js sdk中自动生成的鉴权token', 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', ], ], [ 'name' => 'DisplayName', 'in' => 'formData', 'schema' => [ 'description' => '坐席对外显示名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'XX测试', ], ], [ 'name' => 'SkillGroupId', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => '坐席所属技能组ID。', 'type' => 'array', 'format' => 'int64', 'items' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234****', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'SkillGroupIdList', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => '坐席所属技能组ID列表。', 'type' => 'array', 'format' => 'int64', 'items' => [ 'description' => '技能组ID列表。'."\n" ."\n" .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1223****,1456****', ], 'required' => false, 'maxItems' => 200, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Data' => [ 'description' => '坐席ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2578****', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'NoSkillGroupSetFound', 'errorMessage' => 'The specified skill group set does not exist.', ], [ 'errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', ], [ 'errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 0,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n EE338D98-9BD3-4413-B165\\n Success\\n true\\n 200\\n","errorExample":""}]', 'title' => '创建坐席', 'summary' => '创建悉犀客服工作台坐席账号,并返回坐席ID。', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" .'- 您可以调用[DeleteAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-deleteagent)删除坐席,或者调用[UpdateAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-updateagent)更新坐席数据对坐席进行管理。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'DeleteAgent' => [ 'summary' => '根据实例ID及坐席账号名称,删除悉犀客服工作台坐席账号。', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '15536', 'abilityTreeNodes' => [ 'FEATUREaiccsTY5M4L', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'title' => 'js sdk中自动生成的鉴权token', 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298****', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', ], [ 'errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', ], [ 'errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n EE338D98-9BD3-4413-B165\\n Success\\n true\\n 200\\n","errorExample":""}]', 'title' => '删除坐席', 'description' => '- 删除前,建议您确认需删除的坐席账号名称及实例ID,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" .'- 若误操作删除坐席,可以调用[CreateAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-createagent)接口,重新创建坐席。'."\n" ."\n" .'> 账号删除后重新添加,坐席ID不变。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'UpdateAgent' => [ 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。'."\n" .'> 不支持更新。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', ], ], [ 'name' => 'DisplayName', 'in' => 'formData', 'schema' => [ 'description' => '坐席对外显示名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'XX测试', ], ], [ 'name' => 'SkillGroupId', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '坐席所属技能组。', 'type' => 'array', 'items' => [ 'description' => '技能组。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2345****', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'SkillGroupIdList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '坐席所属技能组列表。', 'type' => 'array', 'items' => [ 'description' => '技能组列表。多个技能组用半角逗号(,)分隔。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2321****,4567****', ], 'required' => false, 'maxItems' => 200, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Code' => [ 'description' => '状态码。返回Success表示调用成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The operation is invalid.', 'errorCode' => 'InvalidOperation', ], [ 'errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', ], [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n Success\\n OK\\n EE338D98-9BD3-4413-B165\\n true\\n","errorExample":""}]', 'title' => '更新坐席数据', 'summary' => '根据实例ID、坐席账号名称修改悉犀客服工作台坐席信息。支持修改坐席对外显示名称、坐席所属技能组。', 'description' => '- 调用前,建议您确认AICCS实例ID,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" .'- 更新后,您可调用[GetAgent](~~2717961~~)接口,确认更新是否符合预期。'."\n" ."\n" .'> 目前仅支持修改对外显示名称和所属技能组。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetAgent' => [ 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'title' => 'js sdk中自动生成的鉴权token', 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Data' => [ 'description' => '坐席数据。', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '坐席状态。取值:'."\n" ."\n" .'- **0**:正常'."\n" .'- **1**:冻结'."\n" .'- **2**:删除'."\n" ."\n" .'> 只有正常的状态,才可进行业务活动。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'TenantId' => [ 'description' => '坐席所属的租户ID,与请求参数中的实例ID相对应。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'GroupList' => [ 'description' => '坐席所属技能组信息。', 'type' => 'array', 'items' => [ 'description' => '技能组信息。', 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => '技能组描述', 'type' => 'string', 'example' => '自动化技能组', ], 'DisplayName' => [ 'description' => '技能组对外显示名称。', 'type' => 'string', 'example' => '自动化技能组', ], 'SkillGroupId' => [ 'description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', ], 'ChannelType' => [ 'description' => '技能组渠道类型', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Name' => [ 'description' => '技能组名称。', 'type' => 'string', 'example' => '自动化技能组', ], ], ], ], 'DisplayName' => [ 'description' => '坐席对外显示名称。', 'type' => 'string', 'example' => 'XX测试', ], 'AgentId' => [ 'description' => '坐席ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '222222', ], 'AccountName' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'example' => 'username@example.com', ], ], ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', ], [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"TenantId\\": 0,\\n \\"GroupList\\": [\\n {\\n \\"Description\\": \\"自动化技能组\\",\\n \\"DisplayName\\": \\"自动化技能组\\",\\n \\"SkillGroupId\\": 123456,\\n \\"ChannelType\\": 1,\\n \\"Name\\": \\"自动化技能组\\"\\n }\\n ],\\n \\"DisplayName\\": \\"XX测试\\",\\n \\"AgentId\\": 222222,\\n \\"AccountName\\": \\"username@example.com\\"\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n \\n 0\\n 刘测试\\n 222222\\n \\n 自动化技能组\\n 自动化技能组\\n 1\\n 123456\\n 自动化技能组\\n \\n 123@123.com\\n 0\\n \\n Success\\n true\\n 200\\n","errorExample":""}]', 'title' => '获取坐席信息', 'summary' => '根据实例ID、坐席账号名称查询悉犀客服工作台坐席信息,如坐席ID等。', 'description' => '- 调用此接口前,请您确认AICCS的实例信息及坐席账号名称,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" .'- 已删除的坐席也支持查询,请您查看返回参数中的**Status**参数值,若取值为2,则表示该坐席已删除。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'ListAgentBySkillGroupId' => [ 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => ' '."\n" .'客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '666666', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '坐席信息。', 'type' => 'array', 'items' => [ 'description' => '数据信息。', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '坐席状态。只有正常的状态,才可进行业务活动。取值:'."\n" .'- **0**:正常'."\n" .'- **1**:冻结'."\n" .'- **2**:删除', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'TenantId' => [ 'description' => '坐席所属的租户ID。与入参中的实例ID对应。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'DisplayName' => [ 'description' => '坐席对外显示名称。', 'type' => 'string', 'example' => '刘测试', ], 'AgentId' => [ 'description' => '坐席ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '666666', ], 'AccountName' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'example' => 'username@example.com', ], ], ], ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n {\\n \\"Status\\": 0,\\n \\"TenantId\\": 0,\\n \\"DisplayName\\": \\"刘测试\\",\\n \\"AgentId\\": 666666,\\n \\"AccountName\\": \\"username@example.com\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n \\n 0\\n 刘测试\\n 666666\\n username@example.com\\n 0\\n \\n Success\\n true\\n","errorExample":""}]', 'title' => '获取技能组下坐席信息', 'summary' => '根据AICCS实例ID、技能组ID查询悉犀客服工作台坐席列表。', 'description' => '- 调用此接口前,请您确认AICCS的实例信息及技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" .'- 若坐席没有设置所属的技能组,可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)查询坐席信息。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetHotlineAgentStatus' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Data' => [ 'description' => '坐席状态。取值:'."\n" .'- **离线**'."\n" .'- **空闲**'."\n" .'- **话后处理**'."\n" .'- **通话中**'."\n" .'- **小休-休息**'."\n" .'- **小休-就餐**'."\n" .'- **小休-会议**'."\n" .'- **小休-培训**'."\n" .'- **小休-辅导**', 'type' => 'string', 'example' => '通话中', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"通话中\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n EE338D98-9BD3-4413-B165\\n 通话中\\n Success\\n true\\n 200\\n","errorExample":""}]', 'title' => '获取热线坐席状态', 'summary' => '根据AICCS实例ID、坐席账号名称查询悉犀客服工作台热线坐席状态。', 'description' => '- 调用此接口前,请您确认AICCS的实例信息及坐席账号名称,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" .'- 若需获取热线坐席详情,可调用[GetHotlineAgentDetail](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-gethotlineagentdetail)接口。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:200次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'RemoveAgentFromSkillGroup' => [ 'summary' => '通过指定技能组及坐席ID,从技能组移除坐席账号。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-78v1gnp97002', ], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => [ 'title' => '技能组id', 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1146****', ], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '坐席列表', 'description' => '坐席ID列表。', 'type' => 'array', 'items' => [ 'description' => '坐席ID。'."\n" ."\n" .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口,查看返回参数的**AgentId**,即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '["6083****","6084****"]', ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'title' => '结果信息', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'SuccessCount' => [ 'title' => '成功移除的坐席数', 'description' => '成功移除的坐席数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"SuccessCount\\": 2\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n OK\\n Success\\n true\\n \\n 2\\n \\n","errorExample":""}]', 'title' => '从技能组移除坐席账号', 'description' => '- 若您需要填写坐席、技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" .'- 您可以调用[ListAgentBySkillGroupId](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-listagentbyskillgroupid)获取技能组下坐席信息,判断移除是否符合预期。'."\n" .'- 若误操作移除,您可以调用[UpdateAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-updateagent)更新坐席数据,重新设置坐席的技能组。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:50次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetHotlineAgentDetail' => [ 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d****', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Data' => [ 'description' => '坐席服务数据。', 'type' => 'object', 'properties' => [ 'Assigned' => [ 'description' => '是否被分配。取值:'."\n" .'**false**:未分配(无通话)。'."\n" .'**true**:已分配(有通话)。', 'type' => 'boolean', 'example' => 'false', ], 'TenantId' => [ 'description' => '坐席所属的租户ID,与入参中的实例ID相对应。', 'type' => 'integer', 'format' => 'int64', 'example' => 'ccc_xp_pre-cn-***', ], 'RestType' => [ 'description' => '小休类型。取值: '."\n" ."\n" .'- **1**:小休。'."\n" .'- **2**:就餐。'."\n" .'- **3**:会议。'."\n" .'- **4**:辅导。'."\n" .'- **5**:培训。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AgentStatus' => [ 'description' => '坐席状态。取值范围:**1~6**。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AgentStatusCode' => [ 'description' => '坐席状态编码。取值:'."\n" ."\n" .'- **AgentCheckout**:坐席下班。'."\n" .'- **AgentReady**:坐席空闲。'."\n" .'- **AgentBreak**:坐席小休。'."\n" .'- **AgentAcw**:话后处理。'."\n" .'- **AgentBusyForCall**:通话中。', 'type' => 'string', 'example' => 'AgentCheckout', ], 'Token' => [ 'description' => '心跳签名。', 'type' => 'string', 'example' => 'dnthF_oinHg7JMJDmKqex3Ux****', ], 'AgentId' => [ 'description' => '坐席ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2235****', ], ], ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', ], [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Assigned\\": false,\\n \\"TenantId\\": 0,\\n \\"RestType\\": 1,\\n \\"AgentStatus\\": 1,\\n \\"AgentStatusCode\\": \\"AgentCheckout\\",\\n \\"Token\\": \\"dnthF_oinHg7JMJDmKqex3Ux****\\",\\n \\"AgentId\\": 0\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n EE338D98-9BD3-4413-B165\\n \\n AgentCheckout\\n dnthF_oinHg7JMJDmKqex3Ux****\\n false\\n 1\\n 1\\n \\n Success\\n true\\n 200\\n","errorExample":""}]', 'title' => '获取热线坐席详情', 'summary' => '根据实例ID、坐席账号名称获取热线坐席当前服务详情。', 'description' => '热线坐席详情包含坐姿状态、坐席ID、心跳签名等信息,具体参见[返回参数](#api-detail-40)。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'CreateSkillGroup' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'SkillGroupName', 'in' => 'formData', 'schema' => [ 'description' => '技能组名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '在线自动化技能组', ], ], [ 'name' => 'Description', 'in' => 'formData', 'schema' => [ 'description' => '技能组描述。', 'type' => 'string', 'required' => false, 'example' => '在线自动化技能组', ], ], [ 'name' => 'DisplayName', 'in' => 'formData', 'schema' => [ 'description' => '技能组对外显示名。', 'type' => 'string', 'required' => false, 'example' => '在线自动化技能组', ], ], [ 'name' => 'ChannelType', 'in' => 'formData', 'schema' => [ 'description' => '技能组类型。取值:'."\n" ."\n" .'- **1**:热线。'."\n" .'- **2**:在线。'."\n" .'- **3**:工单。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '7', 'minimum' => '0', 'example' => '2', ], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-****-70b6a298d94d', ], ], [ 'name' => 'DepartmentId', 'in' => 'formData', 'schema' => [ 'title' => '部门ID', 'description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '创建成功的技能组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'errorCode' => 'InvalidInstanceId', ], [ 'errorMessage' => 'The specified department is unavailable or does not exist.', 'errorCode' => 'Department.NotFound', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 123456,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nxxxx\\nEE338D98-9BD3-4413-B165\\n123456\\nSuccess\\ntrue\\n","errorExample":""}]', 'title' => '创建技能组', 'summary' => '根据技能组名称和渠道类型创建技能组。', 'description' => '- 此接口可定义技能组的对外显示名、描述等信息,具体请参见[请求参数](#api-detail-35)。'."\n" .'- 此接口返回的**Data**参数即为创建成功的技能组ID。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:1000次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'UpdateSkillGroup' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。'."\n" ."\n" .'> 不支持更新。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123456', ], ], [ 'name' => 'SkillGroupName', 'in' => 'query', 'schema' => [ 'description' => '技能组名称。'."\n" .'> 不支持更新。', 'type' => 'string', 'required' => false, 'example' => '自动化测试', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '技能组描述。'."\n" .'> 此参数支持更新。', 'type' => 'string', 'required' => false, 'example' => '自动化测试', ], ], [ 'name' => 'DisplayName', 'in' => 'query', 'schema' => [ 'description' => '技能组对外显示名称。'."\n" .'> 此参数支持更新。', 'type' => 'string', 'required' => false, 'example' => '自动化测试', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-****-70b6a298d94d', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'errorCode' => 'InvalidInstanceId', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nxxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue\\n","errorExample":""}]', 'title' => '修改技能组', 'summary' => '根据AICCS实例ID、技能组ID更新悉犀客服工作台技能组信息。支持更新技能组描述、技能组对外显示名称。', 'description' => '- 此接口不支持更新技能组ID、技能组名称。'."\n" .'- 更新后,您可以调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口查询技能组信息。'."\n" .'- 若您需要填写AICCS实例ID、技能组ID,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:1000次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'RemoveSkillGroup' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'SkillGroupId', 'in' => 'formData', 'schema' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456', ], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-****-70b6a298d94d', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'errorCode' => 'InvalidInstanceId', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nxxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue\\n","errorExample":""}]', 'title' => '删除技能组', 'summary' => '根据AICCS实例ID、技能组ID删除悉犀客服工作台技能组。', 'description' => '- 删除为敏感操作,请您谨慎操作。'."\n" .'- 删除前,建议您确认AICCS实例ID、需删除的技能组ID,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" .'- 删除后,可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口查询技能组确认。'."\n" .'- 若误操作删除,可调用[CreateSkillGroup](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-createskillgroup)接口重新创建技能组。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:1000次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'QuerySkillGroups' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '20', ], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-****-70b6a298d94d', ], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => [ 'title' => '技能组类型(1:热线,2:在线,4:工单)', 'description' => '技能组渠道类型。取值:'."\n" ."\n" .'- **0**:返回所有技能组。'."\n" .'- **1**:热线技能组。'."\n" .'- **2**:在线技能组。'."\n" .'- **3**:在线+热线技能组。'."\n" .'- **4**:工单技能组。'."\n" .'- **5**:热线+工单节能组。'."\n" .'- **6**:在线+工单技能组。'."\n" .'- **7**:在线+热线+工单技能组。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '1', '2', '4', ], ], ], [ 'name' => 'DepartmentId', 'in' => 'query', 'schema' => [ 'title' => '部门ID', 'description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1023****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'OnePageSize' => [ 'description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalPage' => [ 'description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'CurrentPage' => [ 'description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalResults' => [ 'description' => '总共记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '76', ], 'Data' => [ 'description' => '数据。', 'type' => 'array', 'items' => [ 'description' => '数据信息。', 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => '技能组描述。', 'type' => 'string', 'example' => '自动化技能组', ], 'SkillGroupName' => [ 'description' => '技能组名称。', 'type' => 'string', 'example' => '自动化技能组', ], 'DisplayName' => [ 'description' => '技能组对外显示名称。', 'type' => 'string', 'example' => '自动化技能组', ], 'SkillGroupId' => [ 'description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', ], 'ChannelType' => [ 'description' => '技能组渠道类型。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'errorCode' => 'InvalidInstanceId', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"OnePageSize\\": 20,\\n \\"TotalPage\\": 4,\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"CurrentPage\\": 1,\\n \\"TotalResults\\": 76,\\n \\"Data\\": [\\n {\\n \\"Description\\": \\"自动化技能组\\",\\n \\"SkillGroupName\\": \\"自动化技能组\\",\\n \\"DisplayName\\": \\"自动化技能组\\",\\n \\"SkillGroupId\\": 123456,\\n \\"ChannelType\\": 2\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n20\\n4\\nEE338D98-9BD3-4413-B165\\n1\\n76\\n\\n 自动化技能组\\n 自动化技能组\\n 2\\n 自动化技能组\\n 123456\\n\\n","errorExample":""}]', 'title' => '查询技能组', 'summary' => '根据实例ID查询悉犀客服工作台技能组列表。', 'description' => '此接口可查询技能组的对外显示名称、描述、渠道类型、ID等信息,具体参见[返回参数](#api-detail-40)。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:1000次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'ListSkillGroup' => [ 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-****-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => [ 'description' => '技能组渠道类型。取值:'."\n" .'- **0**:返回所有技能组。'."\n" .'- **1**:热线技能组。'."\n" .'- **2**:在线技能组。'."\n" .'- **3**:在线+热线技能组。'."\n" .'- **4**:工单技能组。'."\n" .'- **5**:热线+工单节能组。'."\n" .'- **6**:在线+工单技能组。'."\n" .'- **7**:在线+热线+工单技能组。'."\n" ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '7', 'minimum' => '0', 'example' => '2', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '技能组信息。', 'type' => 'array', 'items' => [ 'description' => '数据信息。', 'type' => 'object', 'properties' => [ 'Description' => [ 'description' => '技能组描述。', 'type' => 'string', 'example' => '自动化技能组', ], 'DisplayName' => [ 'description' => '技能组对外显示名称。', 'type' => 'string', 'example' => '自动化技能组', ], 'SkillGroupId' => [ 'description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', ], 'ChannelType' => [ 'description' => '技能组渠道类型。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Name' => [ 'description' => '技能组名称。', 'type' => 'string', 'example' => '自动化技能组', ], ], ], ], 'Code' => [ 'description' => '状态码。返回Success表示调用成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n {\\n \\"Description\\": \\"自动化技能组\\",\\n \\"DisplayName\\": \\"自动化技能组\\",\\n \\"SkillGroupId\\": 123456,\\n \\"ChannelType\\": 2,\\n \\"Name\\": \\"自动化技能组\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nxxxx\\nEE338D98-9BD3-4413-B165\\n\\n 自动化技能组\\n 自动化技能组\\n 2\\n 123456\\n 自动化技能组\\n\\nSuccess\\ntrue\\n","errorExample":""}]', 'title' => '查询技能组', 'summary' => '根据实例ID、技能组渠道类型查询悉犀客服工作台技能组。', 'description' => '### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetDepGroupTreeData' => [ 'summary' => '根据AICCS实例ID、坐席ID查询技能组分组和技能组列表。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '租户实例ID', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => [ 'title' => '坐席ID', 'description' => '坐席ID。'."\n" ."\n" .'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口,查看返回参数的**AgentId**,即坐席ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'result', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => 'Message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => 'Data', 'description' => '部门信息。', 'type' => 'array', 'items' => [ 'description' => '部门信息。', 'type' => 'object', 'properties' => [ 'DepGroupId' => [ 'title' => 'depGroupId', 'description' => '部门ID。', 'type' => 'string', 'example' => '10****', ], 'GroupDTOS' => [ 'title' => 'groupDTOS', 'description' => '技能组数据。', 'type' => 'array', 'items' => [ 'description' => '技能组信息。', 'type' => 'object', 'properties' => [ 'SkillGroupId' => [ 'title' => 'skillGroupId', 'description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '55****', ], 'Name' => [ 'title' => 'name', 'description' => '技能组名称。', 'type' => 'string', 'example' => '自动化技能组', ], ], ], ], 'DepGroupName' => [ 'title' => 'depGroupName', 'description' => '部门名称。', 'type' => 'string', 'example' => '部门A', ], ], ], ], 'Code' => [ 'title' => 'Code', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'title' => 'Success', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"DepGroupId\\": \\"10****\\",\\n \\"GroupDTOS\\": [\\n {\\n \\"SkillGroupId\\": 0,\\n \\"Name\\": \\"自动化技能组\\"\\n }\\n ],\\n \\"DepGroupName\\": \\"部门A\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n xxxx\\n Success\\n true\\n \\n 部门A\\n 10\\n \\n 555555\\n 自动化技能组\\n \\n \\n","errorExample":""}]', 'title' => '查询技能组分组和技能组列表', 'description' => '- 此接口查询的技能组以部门ID分组,部门ID可在[创建技能组](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-createskillgroup)时填写。'."\n" .'- 若需查询详细技能组信息,可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口。'."\n" .'- 调用前,建议您确认AICCS实例ID、坐席ID,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:1000次/秒。'."\n" .'- API频率:1000次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'CreateDepartment' => [ 'summary' => '根据AICCS实例ID、部门名称创建部门信息,创建成功后会返回部门ID。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例id', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'DepartmentName', 'in' => 'query', 'schema' => [ 'title' => '部门名称', 'description' => '部门名称。', 'type' => 'string', 'required' => true, 'example' => '部门A', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'HttpStatusCode' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123456,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 98B032F5-6473-4EAC-8BA8-C28993513A1F\\n true\\n 200\\n successful\\n 200\\n 123456\\n","errorExample":""}]', 'title' => '创建部门信息', 'description' => '- 若您需要更新部门信息,可调用[UpdateDepartment](~~2717977~~)接口。'."\n" .'- 调用此接口创建部门信息成功后,返回参数的**Data**即为部门ID,若您后续还需查询部门ID,可调用[GetAllDepartment](~~2717975~~)接口。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetAllDepartment' => [ 'summary' => '根据AICCS实例ID获取所有部门信息,可获取部门ID、部门名称。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例id', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => 'message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', ], 'HttpStatusCode' => [ 'title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'title' => 'data', 'description' => '部门信息。', 'type' => 'array', 'items' => [ 'description' => '部门信息。', 'type' => 'object', 'properties' => [ 'DepartmentName' => [ 'description' => '部门名称。', 'type' => 'string', 'example' => '部门A', ], 'DepartmentId' => [ 'description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], ], ], ], 'Code' => [ 'title' => 'code', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => 'success', 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n {\\n \\"DepartmentName\\": \\"部门A\\",\\n \\"DepartmentId\\": 10\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n successful\\n 98B032F5-6473-4EAC-8BA8-C28993513A1F\\n 200\\n \\n 10\\n 部门A\\n \\n 200\\n true\\n","errorExample":""}]', 'title' => '获取所有部门信息', 'description' => '- 您可以调用此接口获取部门ID,用于支持部分查询数据的接口(例如[GetHotlineServiceStatistics](~~2717938~~))的部门分组查询。'."\n" .'- 创建、删除、更新部门信息后,您可以调用此接口确认部门信息是否符合预期。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'DeleteDepartment' => [ 'summary' => '根据AICCS实例ID、部门ID删除部门信息。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例id', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'DepartmentId', 'in' => 'query', 'schema' => [ 'title' => '部门id', 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](~~2717975~~)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'seccessful', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Data' => [ 'description' => '是否成功。取值:'."\n" .'- **true**:成功'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'The specified department does not exist.', 'errorCode' => 'Department.NotFound', ], ], 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"Message\\": \\"seccessful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 98B032F5-6473-4EAC-8BA8-C28993513A1F\\n true\\n 200\\n seccessful\\n 200\\n true\\n","errorExample":""}]', 'title' => '删除部门信息', 'description' => '- 删除为敏感操作,请您谨慎操作。'."\n" ."\n" .'- 调用此接口前,建议您确认AICCS实例ID及部门ID,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" .'- 若误删除部门信息,您可以调用[CreateDepartment](~~2717974~~)接口重新创建。'."\n" ."\n\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'UpdateDepartment' => [ 'summary' => '根据AICCS实例ID、部门ID更新部门名称。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例id', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'DepartmentName', 'in' => 'query', 'schema' => [ 'title' => '部门名称', 'description' => '部门名称。'."\n" ."\n" .'> 支持更新该参数。', 'type' => 'string', 'required' => true, 'example' => '部门A', ], ], [ 'name' => 'DepartmentId', 'in' => 'query', 'schema' => [ 'title' => '部门id', 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](~~2717975~~)接口,查看返回参数的**DepartmentId**,即部门ID。'."\n" ."\n" .'> 不支持更新。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Data' => [ 'description' => '是否成功。取值:'."\n" .'- **true**:成功'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 98B032F5-6473-4EAC-8BA8-C28993513A1\\n true\\n 200\\n successful\\n 200\\n true\\n","errorExample":""}]', 'title' => '更新部门信息', 'description' => '- 此接口仅支持更新部门名称,不支持更新部门ID。'."\n" .'- 调用此接口前,建议您确认AICCS实例ID及部门ID,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" .'- 更新完成后,您可以调用[GetAllDepartment](~~2717975~~)接口,确认部门信息是否符合预期。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GenerateWebSocketSign' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-****-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Data' => [ 'description' => 'MessageBox消息通道签名码。', 'type' => 'string', 'example' => 'dnthF_oinHg7JMJDmKqex3UxDD7', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', ], [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"dnthF_oinHg7JMJDmKqex3UxDD7\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n EE338D98-9BD3-4413-B165\\n dnthF_oinHg7JMJDmKqex3UxDD7\\n Success\\n true\\n 200\\n","errorExample":""}]', 'title' => '生成MessageBox通道签名', 'summary' => '根据AICCS实例ID和坐席账号名称,生成消息通道访问签名。', 'description' => '- 您可以通过此接口生成消息通道访问签名,返回参数的**Data**即为MessageBox消息通道签名码。 '."\n" ."\n" .'- 调用前建议您确认AICCS实例ID,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'HotlineSessionQuery' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'Acid', 'in' => 'query', 'schema' => [ 'description' => '会话ID。入呼后,websocket中的acid。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '7719786****', ], ], [ 'name' => 'CallType', 'in' => 'query', 'schema' => [ 'description' => '电话类型。取值:'."\n" .'- **1**:外呼。'."\n" .'- **2**:入呼。'."\n" .'- **3**:转交。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'CalledNumber', 'in' => 'query', 'schema' => [ 'description' => '发起方号码。例如用户手机号码、客服坐席号码、机器号码等。', 'type' => 'string', 'required' => false, 'example' => '135615****', ], ], [ 'name' => 'CallingNumber', 'in' => 'query', 'schema' => [ 'description' => '接听方号码。例如用户手机号码、客服坐席号码、机器号码等。', 'type' => 'string', 'required' => false, 'example' => '057177****', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => [ 'description' => '技能组名称。', 'type' => 'string', 'required' => false, 'example' => '自动化技能组', ], ], [ 'name' => 'MemberId', 'in' => 'query', 'schema' => [ 'description' => '会员ID。', 'type' => 'string', 'required' => false, 'example' => '7856****', ], ], [ 'name' => 'MemberName', 'in' => 'query', 'schema' => [ 'description' => '会员名称。', 'type' => 'string', 'required' => false, 'example' => '匿名会员', ], ], [ 'name' => 'QueryEndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614829721', ], ], [ 'name' => 'QueryStartTime', 'in' => 'query', 'schema' => [ 'description' => '开始时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614828721', ], ], [ 'name' => 'RequestId', 'in' => 'query', 'schema' => [ 'description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => 'EE338D98-9BD3-4413-B165', ], ], [ 'name' => 'ServicerName', 'in' => 'query', 'schema' => [ 'description' => '坐席名称。', 'type' => 'string', 'required' => false, 'example' => '刘测试', ], ], [ 'name' => 'ServicerId', 'in' => 'query', 'schema' => [ 'description' => '坐席ID。', 'type' => 'string', 'required' => false, 'example' => '555555', ], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => [ 'description' => '扩展参数。', 'type' => 'string', 'required' => false, 'example' => 'xxxx', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'CallResult', 'in' => 'query', 'schema' => [ 'description' => '呼叫结果。取值:'."\n" ."\n" .'- **normal**:正常挂机。'."\n" .'- **touchRouteError**:队列挂机。'."\n" .'- **touchInQueue**:队列挂机。'."\n" .'- **touchInLoss**:队列挂机。'."\n" .'- **userHangup**:用户挂机,IVR挂机。'."\n" .'- **sysHangup**:系统挂机,IVR挂机。'."\n" .'- **transferAgent**:用户挂机,IVR挂机。'."\n" .'- **dailing**:客服挂机,振铃挂机。'."\n" .'- **TouchRingCallLoss**:队列挂机,振铃挂机。', 'type' => 'string', 'required' => false, 'example' => 'normal', 'enum' => [ 'normal', 'queueClose', 'dailingClose', 'ivrClose', ], ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '通话详情全局唯一ID。', 'type' => 'string', 'required' => false, 'example' => 'acc1c58dab4a4****0e3813c66', ], ], [ 'name' => 'AcidList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '会话ID列表。', 'type' => 'array', 'items' => [ 'description' => '入呼后,websocket中的acid。', 'type' => 'string', 'required' => false, 'example' => '7719786', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'CallTypeList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '呼叫类型列表。', 'type' => 'array', 'items' => [ 'description' => '呼叫类型。取值:'."\n" .'- **1**:外呼。'."\n" .'- **2**:入呼。'."\n" .'- **3**:转交。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 5, ], ], [ 'name' => 'GroupIdList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '技能组ID列表。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'CallingNumberList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '主叫号码列表。', 'type' => 'array', 'items' => [ 'description' => '主叫号码。', 'type' => 'string', 'required' => false, 'example' => '0571773****', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'CalledNumberList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '被叫号码列表。', 'type' => 'array', 'items' => [ 'description' => '被叫号码。', 'type' => 'string', 'required' => false, 'example' => '135615****', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'MemberIdList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '会员列表。', 'type' => 'array', 'items' => [ 'description' => '会员ID。', 'type' => 'string', 'required' => false, 'example' => '7856876', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'ServicerIdList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '坐席列表。', 'type' => 'array', 'items' => [ 'description' => '坐席ID。', 'type' => 'string', 'required' => false, 'example' => '555555', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'CallResultList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '呼叫结果列表。', 'type' => 'array', 'items' => [ 'description' => '呼叫结果。取值: '."\n" ."\n" .'- **normal**:正常通话结束 。'."\n" .'- **queueClose**: 队列挂机 。'."\n" .'- **dailingClose**:振铃挂机 。'."\n" .'- **ivrClose**:IVR挂机。', 'type' => 'string', 'required' => false, 'example' => 'normal', ], 'required' => false, 'maxItems' => 200, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE339D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '通话数据。', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => '总共记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '26', ], 'PageSize' => [ 'description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PageNumber' => [ 'description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CallDetailRecord' => [ 'description' => '通话记录。', 'type' => 'array', 'items' => [ 'description' => '通话记录信息。', 'type' => 'object', 'properties' => [ 'GroupName' => [ 'description' => '技能组名称。'."\n" .'> 当CallType取值为**1**时,外呼场景无技能组信息。', 'type' => 'string', 'example' => '自动化技能组', ], 'CallResult' => [ 'description' => '呼叫结果。取值:'."\n" ."\n" .'- **normal**:正常挂机。'."\n" .'- **touchRouteError**:队列挂机。'."\n" .'- **touchInQueue**:队列挂机。'."\n" .'- **touchInLoss**:队列挂机。'."\n" .'- **userHangup**:用户挂机,IVR挂机。'."\n" .'- **sysHangup**:系统挂机,IVR挂机。'."\n" .'- **transferAgent**:用户挂机,IVR挂机。'."\n" .'- **dailing**:客服挂机,振铃挂机。'."\n" .'- **TouchRingCallLoss**:队列挂机,振铃挂机。', 'type' => 'string', 'example' => 'normal', ], 'CalledNumber' => [ 'description' => '被叫号码。', 'type' => 'string', 'example' => '135615*****', ], 'Acid' => [ 'description' => '会话ID。入呼后,websocket中的acid。', 'type' => 'string', 'example' => '7719786', ], 'CallType' => [ 'description' => '呼叫类型。取值:'."\n" .'- **1**:外呼'."\n" .'- **2**:入呼'."\n" .'- **3**:转交', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'QueueUpContinueTime' => [ 'description' => '排队时长。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PassiveTransferId' => [ 'description' => '坐席ID。转交电话号码。'."\n" .'> 非转交场景数据为Null。', 'type' => 'string', 'example' => '12', ], 'CallingNumber' => [ 'description' => '发起方号码。例如用户手机号码、客服坐席号码、机器号码等。', 'type' => 'string', 'example' => '0571773', ], 'MemberId' => [ 'description' => '会员ID。', 'type' => 'string', 'example' => '7856876', ], 'ServicerName' => [ 'description' => '坐席名称。'."\n" .'> 呼入场景未分配到到坐席之前无坐席信息。', 'type' => 'string', 'example' => '刘测试', ], 'OutQueueTime' => [ 'description' => '热线分配出队时间。'."\n" ."\n" .'> 外呼场景无出队时间。', 'type' => 'string', 'example' => '2020-10-02 22:32:59', ], 'RingEndTime' => [ 'description' => '振铃结束时间。'."\n" ."\n" .'> 外呼场景无振铃结束时间。', 'type' => 'string', 'example' => '2020-10-02 22:33:09', ], 'PickUpTime' => [ 'description' => '接起时间。', 'type' => 'string', 'example' => '2020-10-02 22:33:09', ], 'EvaluationLevel' => [ 'description' => '满意度,评价星级。取值:'."\n" ."\n" .'- **2**:二级满意度'."\n" .'- **3**:三级满意度'."\n" .'- **4**:四级满意度'."\n" .'- **5**:五级满意度'."\n" ."\n" .'> 外呼场景和未接通场景无数据。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'RingContinueTime' => [ 'description' => '振铃时长。单位:秒。'."\n" ."\n" .'> 外呼场景无振铃时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'PassiveTransferIdType' => [ 'description' => '会话被转交方。取值:'."\n" .'- **1**:坐席ID。'."\n" .'- **2**:转交电话号码。'."\n" ."\n" .'> 非转交场景数据为Null', 'type' => 'string', 'example' => '1', ], 'EvaluationScore' => [ 'description' => '满意度-评价得分。取值:'."\n" .'- **1**:非常不满意'."\n" .'- **2**:不满意'."\n" .'- **3**:一般'."\n" .'- **4**:满意'."\n" .'- **5**:非常满意'."\n" ."\n" .'> 外呼场景和未接通场景无数据。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'CreateTime' => [ 'description' => '通话创建时间。'."\n" ."\n" .'> - 外呼场景为外呼发起时间。'."\n" .'- 入呼场景为通话进入ACC系统时间。', 'type' => 'string', 'example' => '2020-10-02 22:32:55', ], 'HangUpTime' => [ 'description' => '挂断时间。', 'type' => 'string', 'example' => '2020-10-02 22:33:46', ], 'GroupId' => [ 'description' => '技能组ID。'."\n" ."\n" .'> 当CallType取值为**1**时,外呼场景无技能组信息。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', ], 'InQueueTime' => [ 'description' => '热线分配-入队时间。'."\n" .'> 外呼场景无入队时间。', 'type' => 'string', 'example' => '2020-10-02 22:32:55', ], 'RingStartTime' => [ 'description' => '振铃开始时间。'."\n" ."\n" .'> 外呼场景无振铃开始时间。', 'type' => 'string', 'example' => '2020-10-02 22:32:59', ], 'CallContinueTime' => [ 'description' => '通话时长。单位:秒。'."\n" ."\n" .'> 未接通场景无通话时长。', 'type' => 'integer', 'format' => 'int32', 'example' => '37', ], 'ActiveTransferId' => [ 'description' => '坐席ID。'."\n" .'> 非转交场景数据为Null。', 'type' => 'string', 'example' => '12', ], 'HangUpRole' => [ 'description' => '挂机方。取值:'."\n" ."\n" .'- **1**:系统挂机'."\n" .'- **2**:客户挂机'."\n" .'- **3**:客服挂机'."\n" .'- **null**:未知', 'type' => 'string', 'example' => '2', ], 'MemberName' => [ 'description' => '会员名称。', 'type' => 'string', 'example' => '匿名会员', ], 'Id' => [ 'description' => '通话详情全局唯一ID。', 'type' => 'string', 'example' => 'acc1c58dab4a4dd280e3813c66', ], 'ServicerId' => [ 'description' => '坐席ID。'."\n" .'> 呼入场景未分配到到坐席之前无坐席信息。', 'type' => 'string', 'example' => '555555', ], 'TrunkCall' => [ 'description' => '长途电话。', 'type' => 'string', 'example' => '1861111****', ], ], ], ], ], ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 26,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"CallDetailRecord\\": [\\n {\\n \\"GroupName\\": \\"自动化技能组\\",\\n \\"CallResult\\": \\"normal\\",\\n \\"CalledNumber\\": \\"135615*****\\",\\n \\"Acid\\": \\"7719786\\",\\n \\"CallType\\": 1,\\n \\"QueueUpContinueTime\\": 4,\\n \\"PassiveTransferId\\": \\"12\\",\\n \\"CallingNumber\\": \\"0571773\\",\\n \\"MemberId\\": \\"7856876\\",\\n \\"ServicerName\\": \\"刘测试\\",\\n \\"OutQueueTime\\": \\"2020-10-02 22:32:59\\",\\n \\"RingEndTime\\": \\"2020-10-02 22:33:09\\",\\n \\"PickUpTime\\": \\"2020-10-02 22:33:09\\",\\n \\"EvaluationLevel\\": 4,\\n \\"RingContinueTime\\": 10,\\n \\"PassiveTransferIdType\\": \\"1\\",\\n \\"EvaluationScore\\": 4,\\n \\"CreateTime\\": \\"2020-10-02 22:32:55\\",\\n \\"HangUpTime\\": \\"2020-10-02 22:33:46\\",\\n \\"GroupId\\": 123456,\\n \\"InQueueTime\\": \\"2020-10-02 22:32:55\\",\\n \\"RingStartTime\\": \\"2020-10-02 22:32:59\\",\\n \\"CallContinueTime\\": 37,\\n \\"ActiveTransferId\\": \\"12\\",\\n \\"HangUpRole\\": \\"2\\",\\n \\"MemberName\\": \\"匿名会员\\",\\n \\"Id\\": \\"acc1c58dab4a4dd280e3813c66\\",\\n \\"ServicerId\\": \\"555555\\",\\n \\"TrunkCall\\": \\"1861111****\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE339D98-9BD3-4413-B165\\n \\n \\n normal\\n 1861111****\\n 刘测试\\n 2020-10-02 22:32:59\\n 37\\n 2020-10-02 22:32:55\\n 2020-10-02 22:33:09\\n 10\\n 135615*****\\n 555555\\n 2020-10-02 22:33:46\\n 4\\n 12\\n 12\\n 2\\n 1\\n 匿名会员\\n 4\\n 7719786\\n 2020-10-02 22:32:59\\n 1\\n 自动化技能组\\n 123456\\n 2020-10-02 22:33:09\\n 0571773\\n 2020-10-02 22:32:55\\n 7856876\\n acc1c58dab4a4dd280e3813c66\\n 4\\n \\n 10\\n 1\\n 26\\n \\n Success\\n true\\n","errorExample":""}]', 'title' => '批量查询通话详情', 'summary' => '根据实例ID查询通话详情。', 'description' => '通话详情包含总共记录数、呼叫结果、坐席名称、通话时间等信息。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:80次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetRecordData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。'."\n" ."\n" .'请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview),在**实例管理**中查看实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'Acid', 'in' => 'query', 'schema' => [ 'description' => '会话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1001067****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Data' => [ 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'Acid' => [ 'description' => '会话ID。', 'type' => 'string', 'example' => '1001067****', ], 'OssLink' => [ 'description' => '录音文件地址。', 'type' => 'string', 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***', ], ], ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '调用接口是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Acid\\": \\"1001067****\\",\\n \\"OssLink\\": \\"http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n EE338D98-9BD3-4413-B165\\n \\n http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***\\n 1001067****\\n \\n 200\\n true\\n 200\\n","errorExample":""}]', 'title' => '获取录音文件', 'summary' => '调用GetRecordData接口获取录音文件。', ], 'GetRecordUrl' => [ 'summary' => '调用GetRecordUrl接口获取语音双呼录音链接。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。可在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)>实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-****', ], ], [ 'name' => 'Acid', 'in' => 'query', 'schema' => [ 'description' => '会话ID。', 'type' => 'string', 'required' => true, 'example' => '1001067****', ], ], [ 'name' => 'RecordType', 'in' => 'query', 'schema' => [ 'description' => '呼叫类型。取值:'."\n" ."\n" .'- **DUP_CALL**:双呼。'."\n" .'- **IVR_CALL**:IVR外呼。'."\n" .'- **SMART_CALL**:智能外呼。', 'type' => 'string', 'required' => true, 'example' => 'DUP_CALL', 'enum' => [ 'DUP_CALL', 'IVR_CALL', 'SMART_CALL', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'Acid' => [ 'title' => '会话id', 'description' => '会话ID。', 'type' => 'string', 'example' => '1001067****', ], 'OssLink' => [ 'title' => '录音链接', 'description' => '录音链接。', 'type' => 'string', 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***', ], ], ], 'Success' => [ 'description' => '调用接口是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Acid\\": \\"1001067****\\",\\n \\"OssLink\\": \\"http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n true\\n OK\\n \\n 1001067****\\n http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***\\n \\n","errorExample":""}]', 'title' => '获取语音双呼录音链接', ], 'DescribeRecordData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '15566', 'abilityTreeNodes' => [ 'FEATUREaiccsA3JJUR', ], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProdCode', 'in' => 'query', 'schema' => [ 'description' => '产品名称。默认取值:**aiccs**。', 'type' => 'string', 'required' => false, 'example' => 'aiccs', 'default' => 'aiccs', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '帐户类型。', 'type' => 'string', 'required' => false, 'example' => 'BUC_TYPE', ], ], [ 'name' => 'AccountId', 'in' => 'query', 'schema' => [ 'description' => '帐户ID。', 'type' => 'string', 'required' => false, 'example' => '2235****', ], ], [ 'name' => 'Acid', 'in' => 'query', 'schema' => [ 'description' => '会话ID。', 'type' => 'string', 'required' => false, 'example' => '1004849****', ], ], [ 'name' => 'SecLevel', 'in' => 'query', 'schema' => [ 'description' => '录音脱敏等级。取值范围:**1-4**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Acid' => [ 'description' => '会话ID。', 'type' => 'string', 'example' => '1004849****', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'OssLink' => [ 'description' => '录音文件链接。', 'type' => 'string', 'example' => 'https://****', ], 'AgentId' => [ 'description' => '坐席ID。', 'type' => 'string', 'example' => '1212****', ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', ], [ 'errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Acid\\": \\"1004849****\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"OssLink\\": \\"https://****\\",\\n \\"AgentId\\": \\"1212****\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1004849****\\n EE338D98-9BD3-4413-B165\\n OK\\n https://****\\n 1212****\\n 200\\n","errorExample":""}]', 'title' => '获取通话记录', 'summary' => '调用DescribeRecordData接口获取通话信息。', ], 'GetIndexCurrentValue' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'DepIds', 'in' => 'query', 'schema' => [ 'description' => '部门ID列表。多个ID以半角逗号(,)分隔。'."\n" ."\n" .'可调用[GetAllDepartment](~~2717975~~)接口,查看返回参数的**DepartmentId**,即部门ID。'."\n" ."\n" .'> 当该参数不为空时:'."\n" .'> - 若GroupIds不为空,则优先以GroupIds参数对应技能组列表查询。'."\n" .'> - 若GroupIds为空,则优先以该参数对应部门列表查询。', 'type' => 'string', 'required' => false, 'example' => '2332****,2334****', ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'schema' => [ 'description' => '技能组ID列表。多个ID以半角逗号(,)分隔。'."\n" ."\n" .'可调用[QuerySkillGroups](~~2717970~~)接口,查看返回参数的**SkillGroupId**,即技能组ID。'."\n" ."\n" .'> 当该参数不为空时,优先以参数对应技能组列表查询。', 'type' => 'string', 'required' => false, 'example' => '2323****,2324****', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。'."\n" ."\n" .'> AICCS实例ID必填。', 'type' => 'string', 'required' => false, 'example' => 'ccc_xp_pre-cn-***', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '数据列表。', 'type' => 'array', 'items' => [ 'description' => '存放键值对数据列表。', 'type' => 'object', 'example' => '[{"indexName":"hotlineRateRateSati","canAcc":"true","indexValue":"100%","indexNameShow":"hotlineRateRateSati","desc":"热线即时满意度(当天收到的满意评价数 / 参评数)"}]', ], ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n [\\n {\\n \\"indexName\\": \\"hotlineRateRateSati\\",\\n \\"canAcc\\": \\"true\\",\\n \\"indexValue\\": \\"100%\\",\\n \\"indexNameShow\\": \\"hotlineRateRateSati\\",\\n \\"desc\\": \\"热线即时满意度(当天收到的满意评价数 / 参评数)\\"\\n }\\n ]\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n09CD5EE1-F54D-4777-9CC5-6C171B7C7E46\\nsuccessful\\n\\n hotlineRateRateSati\\n true\\n 100%\\n hotlineRateRateSati\\n 热线即时满意度(当天收到的满意评价数 / 参评数)\\n\\n\\n hotline_rate_service_level\\n true\\n 100%\\n 服务水平\\n 服务水平\\n\\n\\n punctual\\n false\\n 100%\\n 遵时度\\n 遵时度\\n\\n\\n n_incall\\n true\\n 0\\n n_incall\\n 客户电话请求量(包含被接起和未接起)\\n\\n\\n n_normal_answer\\n true\\n 0\\n n_normal_answer\\n 客户电话请求中被客服接起的量\\n\\n\\n n_overflow_in\\n true\\n 0\\n n_overflow_in\\n 溢入量\\n\\n\\n n_overflow_out\\n true\\n 0\\n n_overflow_out\\n 溢出量\\n\\n\\n n_inqueue\\n false\\n 0\\n n_inqueue\\n 当前排队量\\n\\n\\n t_inqueue_max\\n false\\n 0\\n t_inqueue_max\\n 所有排队电话中,最长的等待时长(单位:秒)\\n\\n\\n give_rate\\n true\\n 0.00%\\n give_rate\\n (进线量 - 接听量)/ 进线量\\n\\n\\n pickup_rate_20s\\n true\\n 0.00%\\n pickup_rate_20s\\n 20s被接起的电话量 / 进线量\\n\\n\\n pickup_rate_60s\\n true\\n 0.00%\\n pickup_rate_60s\\n 60s被接起的电话量 / 进线量\\n\\n\\n n_online_now\\n false\\n 2\\n n_online_now\\n 当前在线的坐席数(包含通话、空闲、小休、后处理)\\n\\n\\n n_busy_now\\n false\\n 0\\n n_busy_now\\n 通话中状态的坐席数(包含入呼、外呼)\\n\\n\\n n_idle_now\\n false\\n 2\\n n_idle_now\\n 空闲状态中的坐席数(正常情况下代表该坐席可以接听、外呼电话)\\n\\n\\n n_acw_now\\n false\\n 0\\n n_acw_now\\n 后处理状态中的坐席数\\n\\n\\n n_resttype_now\\n false\\n 0\\n n_resttype_now\\n 小休状态中的坐席数(包含签入小休、普通小休、就餐小休、培训等一切小休状态)\\n\\n\\n n_resttype1_now\\n false\\n 0\\n n_resttype1_now\\n 普通小休状态中的坐席数\\n\\n\\n n_resttype2_now\\n false\\n 0\\n n_resttype2_now\\n 就餐小休状态中的坐席数\\n\\n\\n n_resttype3_now\\n false\\n 0\\n n_resttype3_now\\n 会议小休状态中的坐席数\\n\\n\\n n_resttype4_now\\n false\\n 0\\n n_resttype4_now\\n 辅导小休状态中的坐席数\\n\\n\\n n_resttype5_now\\n false\\n 0\\n n_resttype5_now\\n 培训小休状态中的坐席数\\n\\n\\n n_resttype98_now\\n false\\n 0\\n n_resttype98_now\\n 系统强制小休状态中的坐席数\\n\\n\\n n_resttype99_now\\n false\\n 0\\n n_resttype99_now\\n 坐席签入小休状态中的坐席数\\n\\n\\n n_resttype97_now\\n false\\n 0\\n n_resttype97_now\\n 暂无指标说明\\n\\n\\n hotlineNumRateSati\\n true\\n 0\\n hotlineNumRateSati\\n 热线即时满意评价数(当天收到的满意评价数)\\n\\n\\n hotlineNumRateUnSati\\n true\\n 0\\n hotlineNumRateUnSati\\n 热线即时不满意评价数(当天收到的不满意评价数)\\n\\n\\n hotlineNumRateNormal\\n true\\n 0\\n hotlineNumRateNormal\\n 热线即时一般评价数(当天收到的一般评价数)\\n\\n\\n ATT\\n true\\n 0\\n ATT\\n 平均入呼通话时长\\n\\n\\n ACW\\n true\\n 10\\n ACW\\n 平均后处理时长\\n\\n\\n INCALL ACW\\n true\\n 0\\n INCALL ACW\\n 呼入平均后处理时长\\n\\n\\n OUTCALL ACW\\n true\\n 0\\n OUTCALL ACW\\n 呼出平均后处理时长\\n\\n\\n hotline_rate_value_data\\n true\\n 0.00%\\n 即时问卷满意度\\n\\n\\n hotline_rate_accumulate_data\\n true\\n 0\\n 参评量\\n\\n200\\ntrue\\n","errorExample":""}]', 'title' => '获取当前数据统计指标', 'summary' => '获取当前数据统计指标(实时数据),支持实例ID、部门、技能组分组查询。', 'description' => '- 当前数据统计指标为当日累计指标和当前指标。'."\n" .'- 若您需要填写部门、技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'> 查询逻辑优先级:'."\n" .'> - 若GroupIds不为空,则查询对应技能组列表下数据指标。'."\n" .'> - 否则,若DepIds不为空,则查询对应部门列表下数据指标。'."\n" .'> - 否则,查询AICCS实例下数据指标。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'responseParamsDescription' => '### Data数据说明'."\n" .'| 字段 | 类型 | 描述 |'."\n" .'| ------------- |------------ | ----- |'."\n" .'| indexName | String | 指标code | '."\n" .'| canAcc | Boolean | 是否可累加(false表示为瞬时数据指标) | '."\n" .'| indexValue | String | 指标值 | '."\n" .'| indexShowName | String | 指标展示名 | '."\n" .'| desc | String | 指标描述 | '."\n" ."\n" .'### 已有指标说明'."\n" .'| IndexName | IndexShowName |'."\n" .'| ------------- |------------ | '."\n" .'| hotlineRateRateSati | 热线即时满意度(当天收到的满意评价数 / 参评数) | '."\n" .'| hotline_rate_service_level | 服务水平 | '."\n" .'| punctual | 遵时度 | '."\n" .'| n_incall | 客户电话请求量(包含被接起和未接起) | '."\n" .'| n_normal_answer | 客户电话请求中被客服接起的量 | '."\n" .'| n_overflow_in | 溢入量 | '."\n" .'| n_overflow_out | 溢出量 | '."\n" .'| n_inqueue | 当前排队量 | '."\n" .'| t_inqueue_max | 所有排队电话中,最长的等待时长(单位:秒) | '."\n" .'| tgive_rate | (进线量-接听量)/进线量 | '."\n" .'| pickup_rate_20s | 20s被接起的电话量/进线量 | '."\n" .'| pickup_rate_60s | 60s被接起的电话量/进线量 | '."\n" .'| n_online_now | 当前在线的坐席数(包含通话、空闲、小休、后处理) | '."\n" .'| n_busy_now | 通话中状态的坐席数(包含入呼、外呼) | '."\n" .'| n_idle_now | 空闲状态中的坐席数(正常情况下代表该坐席可以接听、外呼电话) | '."\n" .'| n_acw_now | 后处理状态中的坐席数 | '."\n" .'| n_resttype_now | 小休状态中的坐席数(包含签入小休、普通小休、就餐小休、培训等一切小休状态) | '."\n" .'| n_resttype1_now | 普通小休状态中的坐席数 | '."\n" .'| n_resttype2_now | 就餐小休状态中的坐席数 | '."\n" .'| n_resttype3_now | 会议小休状态中的坐席数 | '."\n" .'| n_resttype4_now | 辅导小休状态中的坐席数 | '."\n" .'| n_resttype5_now | 培训小休状态中的坐席数 | '."\n" .'| n_resttype98_now | 系统强制小休状态中的坐席数 | '."\n" .'| n_resttype99_now | 坐席签入小休状态中的坐席数 | '."\n" .'| hotlineNumRateSati | 热线即时满意评价数(当天收到的满意评价数) | '."\n" .'| hotlineNumRateUnSati | 热线即时不满意评价数(当天收到的不满意评价数) | '."\n" .'| hotlineNumRateNormal | 热线即时一般评价数(当天收到的一般评价数) | '."\n" .'| ATT | 平均入呼通话时长 | '."\n" .'| ACW | 平均后处理时长 | '."\n" .'| INCALL ACW | 呼入平均后处理时长 | '."\n" .'| OUTCALL ACW | 呼出平均后处理时长 | '."\n" .'| hotline_rate_value_data | 呼即时问卷满意度 | '."\n" .'| hotline_rate_accumulate_data | 参评量 | ', ], 'GetAgentIndexRealTime' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '20', 'default' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => '当前页。取值大于**0**,默认值:**1**。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](~~2717975~~)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '技能组ID列表。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](~~2717970~~)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****', ], 'required' => false, 'maxItems' => 200, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'Total' => [ 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'Columns' => [ 'description' => '返回列描述。', 'type' => 'array', 'items' => [ 'description' => '指标数据。', 'type' => 'object', 'properties' => [ 'Title' => [ 'description' => '指标说明。', 'type' => 'string', 'example' => 'servicerId', ], 'Key' => [ 'description' => '指标。', 'type' => 'string', 'example' => '客服ID', ], ], ], ], 'Page' => [ 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Rows' => [ 'description' => '返回数据结果。', 'type' => 'array', 'items' => [ 'description' => '查询结果数据。', 'type' => 'object', ], ], ], ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"PageSize\\": 20,\\n \\"Total\\": 4,\\n \\"Columns\\": [\\n {\\n \\"Title\\": \\"servicerId\\",\\n \\"Key\\": \\"客服ID\\"\\n }\\n ],\\n \\"Page\\": 1,\\n \\"Rows\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '获取热线坐席实时数据详情', 'summary' => '根据实例、部门、技能组分组获取坐席详情实时数据(实时数据)。', 'description' => '- 调用此接口前,请确保您已[开通服务](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH),并[创建实例](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn)。'."\n" .'- 若您需要填写部门、技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:10次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetHotlineAgentDetailReport' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '20', 'default' => '10', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'description' => '开始日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1614824872', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'description' => '结束日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1614824972', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](~~2717975~~)接口,查看返回参数的**DepartmentId**,即部门ID。'."\n" ."\n" .'> 当该参数不为空时:'."\n" .'> - 若GroupIds不为空,则优先以GroupIds参数对应技能组列表查询。'."\n" .'> - 若GroupIds为空,则优先以该参数对应部门列表查询。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5623***', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '技能组ID列表。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](~~2717970~~)接口,查看返回参数的**SkillGroupId**,即技能组ID。'."\n" ."\n" .'> 当该参数不为空时,优先以参数对应技能组列表查询。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1232****', ], 'required' => false, 'maxItems' => 200, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Data' => [ 'description' => '查询结果数据。', 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Total' => [ 'description' => '总共记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'Columns' => [ 'description' => '返回列描述。', 'type' => 'array', 'items' => [ 'description' => '指标数据。', 'type' => 'object', 'properties' => [ 'Title' => [ 'description' => '指标说明。', 'type' => 'string', 'example' => '客服姓名', ], 'Key' => [ 'description' => '指标。', 'type' => 'string', 'example' => 'realName', ], ], ], ], 'Page' => [ 'description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Rows' => [ 'description' => '返回数据结果。', 'type' => 'array', 'items' => [ 'description' => '返回数据。', 'type' => 'object', 'example' => '[{"hotline_time_acw_incall":"2.56","hotline_time_acw_outcall":"5.78","hotline_time_outcall_avg":"14.89","hotline_num_incall_answer":12,"servicerId":36****,"hotline_time_login":"1s","hotline_rate_handle_in_60s":"100.00%","hotline_time_agent_idle":"1s","hotline_time_agent_rest":"1s","servicerName":"testAccount","hotline_time_incall_avg":"1.23","hotline_num_to_rest_cnt":4,"call_out_cnt":10,"call_out_intervene_cnt":3,"call_out_all_len":"1s","call_out_ring_len":"1s","call_out_intervene_len":"1s","evaluate_rate":"0.00%"}]', ], ], ], ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 7,\\n \\"Columns\\": [\\n {\\n \\"Title\\": \\"客服姓名\\",\\n \\"Key\\": \\"realName\\"\\n }\\n ],\\n \\"Page\\": 1,\\n \\"Rows\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\nsuccessful\\n24D9F55F-064E-48D2-851C-5C6ABC654C9E\\n\\n 2\\n 40\\n \\n 客服名称\\n servicerName\\n \\n \\n 服务接起量\\n hotline_num_incall_answer\\n \\n \\n 60s响应率\\n hotline_rate_handle_in_60s\\n \\n \\n 登录时长\\n hotline_time_login\\n \\n \\n 入呼平均接听时长\\n hotline_time_incall_avg\\n \\n \\n 呼入平均后处理时长\\n hotline_time_acw_incall\\n \\n \\n 小休总时长\\n hotline_time_agent_rest\\n \\n \\n 小休总次数\\n hotline_num_to_rest_cnt\\n \\n \\n 空闲总时长\\n hotline_time_agent_idle\\n \\n \\n 外呼量\\n call_out_cnt\\n \\n \\n 外呼接通量\\n call_out_intervene_cnt\\n \\n \\n 外呼总时长\\n call_out_all_len\\n \\n \\n 外呼振铃总时长\\n call_out_ring_len\\n \\n \\n 外呼接通总时长\\n call_out_intervene_len\\n \\n \\n 外呼平均时长\\n hotline_time_outcall_avg\\n \\n \\n 外呼平均后处理时长\\n hotline_time_acw_outcall\\n \\n \\n 参评量\\n evaluate_cnt\\n \\n \\n 参评率\\n evaluate_rate\\n \\n 1\\n \\n 2.56\\n 5.78\\n 14.89\\n 12\\n 366001\\n 1s\\n 100.00%\\n 1s\\n 1s\\n testAccount\\n 1.23\\n 4\\n 10\\n 3\\n 1s\\n 1s\\n 1s\\n 0.00%\\n \\n\\n200\\ntrue\\n","errorExample":""}]', 'title' => '获取热线坐席维度(T+1)数据详情', 'summary' => '获取热线坐席维度(T+1)数据详情。支持实例、时间区间、部门、技能组分组查询。', 'description' => '- 调用此接口前,请确保您已[开通服务](~~276009~~),并[创建实例](~~276011~~)。'."\n" .'- 若您需要填写部门、技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n\n" .'> 查询逻辑优先级:'."\n" .'> - 若GroupIds不为空,则查询对应技能组列表下数据指标。'."\n" .'> - 否则,若DepIds不为空,则查询对应技能组分组下数据指标。'."\n" .'> - 否则,查询AICCS实例下数据指标。'."\n" ."\n\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:10次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetHotlineGroupDetailReport' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '20', 'default' => '10', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'description' => '开始日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1614824872', 'default' => '', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'description' => '结束日期时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1614824972', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '部门ID列表。', 'type' => 'array', 'items' => [ 'description' => '部门ID。'."\n" ."\n" .'可调用[GetAllDepartment](~~2717975~~)接口,查看返回参数的**DepartmentId**,即部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '56****', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => '技能组ID列表。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。'."\n" ."\n" .'可调用[QuerySkillGroups](~~2717970~~)接口,查看返回参数的**SkillGroupId**,即技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****', ], 'required' => false, 'maxItems' => 200, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '查询结果数据。', 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Total' => [ 'description' => '总共记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '9', ], 'Columns' => [ 'description' => '返回列描述。', 'type' => 'array', 'items' => [ 'description' => '返回列描述。', 'type' => 'object', 'properties' => [ 'Title' => [ 'description' => '指标说明。', 'type' => 'string', 'example' => '技能组名称', ], 'Key' => [ 'description' => '指标。', 'type' => 'string', 'example' => 'skillGroupName', ], ], ], ], 'Page' => [ 'description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Rows' => [ 'description' => '返回数据结果。', 'type' => 'array', 'items' => [ 'description' => '返回数据结果。', 'type' => 'object', 'example' => '{"online_40s_transfer_ready_cnt":81,"minute_id":"-1","online_unsatis_cnt":0,"online_simple_cnt":0,"average_queue_time":-1,"service_pickup":"2086","total_waiting_time":"981","online_service_time_len":58208,"online_direct_give_up_len":0,"break_ratio":"2%"}', ], ], ], ], 'Code' => [ 'description' => '状态吗。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'string', 'example' => 'Public', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 9,\\n \\"Columns\\": [\\n {\\n \\"Title\\": \\"技能组名称\\",\\n \\"Key\\": \\"skillGroupName\\"\\n }\\n ],\\n \\"Page\\": 1,\\n \\"Rows\\": [\\n {\\n \\"online_40s_transfer_ready_cnt\\": 81,\\n \\"minute_id\\": \\"-1\\",\\n \\"online_unsatis_cnt\\": 0,\\n \\"online_simple_cnt\\": 0,\\n \\"average_queue_time\\": -1,\\n \\"service_pickup\\": \\"2086\\",\\n \\"total_waiting_time\\": \\"981\\",\\n \\"online_service_time_len\\": 58208,\\n \\"online_direct_give_up_len\\": 0,\\n \\"break_ratio\\": \\"2%\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"Public\\"\\n}","type":"json"}]', 'title' => '获取热线技能组维度T+1数据详情', 'summary' => '获取热线技能组维度(T+1)数据详情。支持实例、时间区间、部门、技能组分组获取。', 'description' => '- 调用此接口前,请确保您已[开通服务](~~276009~~),并[创建实例](~~276011~~)。'."\n" .'- 若您需要填写坐席、部门、技能组信息,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:10次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'QueryTouchList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], [ 'PrivateKey' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'TouchId', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '要精确查询的接触ID列表。', 'type' => 'array', 'items' => [ 'description' => '接触ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10****', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'ChannelId', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '要精确查询的会话ID列表。', 'type' => 'array', 'items' => [ 'description' => '会话ID。', 'type' => 'string', 'required' => false, 'example' => '846a7a4aa2524186b899a6ba02****', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'ChannelType', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '渠道类型。', 'type' => 'array', 'items' => [ 'description' => '渠道类型。取值:'."\n" .'- **1**:热线。'."\n" .'- **2**:在线。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'required' => false, 'maxItems' => 10, 'enum' => [ '1', '2', ], ], ], [ 'name' => 'TouchType', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '接触类型。', 'type' => 'array', 'items' => [ 'description' => '接触类型。取值:'."\n" .'- **1**:主动接触(外呼)。'."\n" .'- **2**:被动接触(咨询)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], 'required' => false, 'maxItems' => 10, 'enum' => [ '1', '2', ], ], ], [ 'name' => 'MemberId', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '要查询的会员ID列表。', 'type' => 'array', 'items' => [ 'description' => '会员ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'MemberName', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '要查询的会员名称列表。', 'type' => 'array', 'items' => [ 'description' => '会员名称。', 'type' => 'string', 'required' => false, 'example' => 'zhangsan', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'ServicerId', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '要查询的客服ID列表。', 'type' => 'array', 'items' => [ 'description' => '客服ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '70020', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'ServicerName', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '要查询的客服名称列表。', 'type' => 'array', 'items' => [ 'description' => '客服名称。', 'type' => 'string', 'required' => false, 'example' => 'lisi', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'QueueId', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '进线技能组ID列表。', 'type' => 'array', 'items' => [ 'description' => '进线技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', ], 'required' => false, 'maxItems' => 200, ], ], [ 'name' => 'EvaluationStatus', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '评价状态。', 'type' => 'array', 'items' => [ 'description' => '评价状态。取值:'."\n" .'- **-1**:未发起评价。'."\n" .'- **0**:未评价。'."\n" .'- **1**:已评价。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'required' => false, 'maxItems' => 10, 'enum' => [ '-1', '0', '1', ], ], ], [ 'name' => 'EvaluationLevel', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '满意度等级。', 'type' => 'array', 'items' => [ 'description' => '满意度等级。取值:'."\n" .'- **2**:二级满意度。'."\n" .'- **3**:三级满意度。'."\n" .'- **4**:四级满意度。'."\n" .'- **5**:五级满意度。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], 'required' => false, 'maxItems' => 10, 'enum' => [ '2', '3', '4', '5', ], ], ], [ 'name' => 'EvaluationScore', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'description' => '满意度评分。', 'type' => 'array', 'items' => [ 'description' => '满意度评分。取值:'."\n" .'- **1**:很不满。'."\n" .'- **2**:不满。'."\n" .'- **3**:一般。'."\n" .'- **4**:满意。'."\n" .'- **5**:很满意。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], 'required' => false, 'maxItems' => 10, 'enum' => [ '1', '2', '3', '4', '5', ], ], ], [ 'name' => 'FirstTimeStart', 'in' => 'formData', 'schema' => [ 'description' => '会话开始的时间范围左区间。时间戳格式(单位:毫秒)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614596400000', ], ], [ 'name' => 'FirstTimeEnd', 'in' => 'formData', 'schema' => [ 'description' => '会话开始的时间范围右区间。时间戳格式(单位:毫秒)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614599400000', ], ], [ 'name' => 'CloseTimeStart', 'in' => 'formData', 'schema' => [ 'description' => '会话结束的时间范围左区间。时间戳格式(单位:毫秒)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614600400000', ], ], [ 'name' => 'CloseTimeEnd', 'in' => 'formData', 'schema' => [ 'description' => '会话结束的时间范围右区间。时间戳格式(单位:毫秒)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614600500000', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '20', 'default' => '50', ], ], [ 'name' => 'CurrentPage', 'in' => 'formData', 'schema' => [ 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'ResultData' => [ 'description' => '数据结果。', 'type' => 'object', 'properties' => [ 'Empty' => [ 'description' => '是否为空。', 'type' => 'boolean', 'example' => 'false', ], 'OnePageSize' => [ 'description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'TotalPage' => [ 'description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'CurrentPage' => [ 'description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PreviousPage' => [ 'description' => '上一页页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'TotalResults' => [ 'description' => '查询总量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Data' => [ 'description' => '数据。', 'type' => 'array', 'items' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'ParentTouchId' => [ 'description' => '父接触ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'DepId' => [ 'description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'GmtModified' => [ 'description' => '更新时间。时间戳格式(单位:毫秒)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1611207979000', ], 'UserTouchId' => [ 'description' => '用户接触ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1386****', ], 'CommonQueueName' => [ 'description' => '技能组名称。', 'type' => 'string', 'example' => '测试1', ], 'ChannelId' => [ 'description' => '会话ID。', 'type' => 'string', 'example' => '4f8807a9de024507a3090b5b66a8****', ], 'TouchId' => [ 'description' => '接触ID。', 'type' => 'string', 'example' => '1386****', ], 'MemberId' => [ 'description' => '会员ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '6400665****', ], 'ServicerName' => [ 'description' => '客服名称。', 'type' => 'string', 'example' => '1390000****', ], 'Feedback' => [ 'description' => '反馈。', 'type' => 'string', 'example' => 'xxxx', ], 'TouchType' => [ 'description' => '接触类型。取值:'."\n" .'- **1**:主动接触。'."\n" .'- **2**:被动接触。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Status' => [ 'description' => '接触状态。取值:'."\n" .'- **1**:已进线。'."\n" .'- **2**:小二已接入。'."\n" .'- **3**:通话中。'."\n" .'- **4**:已结束。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SwitchUser' => [ 'description' => '转交列表。', 'type' => 'string', 'example' => 'null', ], 'FirstTime' => [ 'description' => '会话接起时间。时间戳格式(单位:毫秒)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1611209971000', ], 'FromId' => [ 'description' => '会话发起者。', 'type' => 'integer', 'format' => 'int64', 'example' => '6400665****', ], 'QueueId' => [ 'description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '111', ], 'ExtAttrsString' => [ 'description' => '大字段。', 'type' => 'object', ], 'TouchTime' => [ 'description' => '会话时长(单位:秒)。', 'type' => 'string', 'example' => '111', ], 'ToId' => [ 'description' => '会话接受者。', 'type' => 'integer', 'format' => 'int64', 'example' => '67****', ], 'BuId' => [ 'description' => '租户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '905', ], 'GmtCreate' => [ 'description' => '创建时间。时间戳格式(单位:毫秒)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1611209971000', ], 'CloseTime' => [ 'description' => '会话结束时间。时间戳格式(单位:毫秒)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1611207976000', ], 'ExtAttrs' => [ 'description' => '扩展字段。', 'type' => 'object', 'properties' => [ 'EvaluationScore' => [ 'description' => '满意度评分。取值:'."\n" .'- **1**:很不满。'."\n" .'- **2**:不满。'."\n" .'- **3**:一般。'."\n" .'- **4**:满意。'."\n" .'- **5**:很满意。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'OnlineJoinRespInterval' => [ 'description' => '首次响应时长(单位:秒)。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Dnis' => [ 'description' => '外呼为被叫号码,入呼为被叫号码。', 'type' => 'string', 'example' => '05712688****', ], 'OnlineSessionSource' => [ 'description' => '线上会话源。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'EvaluationStatus' => [ 'description' => '评价状态。取值:'."\n" .'- **-1**:未发起评价。'."\n" .'- **0**:未评价。'."\n" .'- **1**:已评价。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'EvaluationLevel' => [ 'description' => '满意度等级。取值:'."\n" .'- **2**:二级满意度。'."\n" .'- **3**:三级满意度。'."\n" .'- **4**:四级满意度。'."\n" .'- **5**:五级满意度。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'OutCallRouteNumber' => [ 'description' => '外呼为主叫号码。', 'type' => 'string', 'example' => '05712688****', ], 'Ani' => [ 'description' => '入呼为主叫号码。', 'type' => 'string', 'example' => '187****0000', ], 'EvaluationSolution' => [ 'description' => '评估解决方案。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], ], ], 'TouchEndReason' => [ 'description' => '结束原因。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'MemberName' => [ 'description' => '会员名称。', 'type' => 'string', 'example' => '访客', ], 'ServicerId' => [ 'description' => '客服ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '67****', ], 'ChannelType' => [ 'description' => '接触渠道。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TouchContent' => [ 'description' => '会话结束原因。取值:'."\n" .'- **0**:未知。'."\n" .'- **1**:接触未成功。'."\n" .'- **2**:客户终止。'."\n" .'- **3**:坐席终止。'."\n" .'- **4**:通话异常中断。'."\n" .'- **5**:转交终止。'."\n" .'- **6**:系统终止。', 'type' => 'string', 'example' => '1', ], ], ], ], 'NextPage' => [ 'description' => '下一页页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '865658FD-80DE-5D49-ABEB-F3CC9863F4F1', ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultData\\": {\\n \\"Empty\\": false,\\n \\"OnePageSize\\": 2,\\n \\"TotalPage\\": 4,\\n \\"CurrentPage\\": 1,\\n \\"PreviousPage\\": 2,\\n \\"TotalResults\\": 100,\\n \\"Data\\": [\\n {\\n \\"ParentTouchId\\": 0,\\n \\"DepId\\": 100,\\n \\"GmtModified\\": 1611207979000,\\n \\"UserTouchId\\": 0,\\n \\"CommonQueueName\\": \\"测试1\\",\\n \\"ChannelId\\": \\"4f8807a9de024507a3090b5b66a8****\\",\\n \\"TouchId\\": \\"1386****\\",\\n \\"MemberId\\": 0,\\n \\"ServicerName\\": \\"1390000****\\",\\n \\"Feedback\\": \\"xxxx\\",\\n \\"TouchType\\": 2,\\n \\"Status\\": 1,\\n \\"SwitchUser\\": \\"null\\",\\n \\"FirstTime\\": 1611209971000,\\n \\"FromId\\": 0,\\n \\"QueueId\\": 111,\\n \\"ExtAttrsString\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"TouchTime\\": \\"111\\",\\n \\"ToId\\": 0,\\n \\"BuId\\": 905,\\n \\"GmtCreate\\": 1611209971000,\\n \\"CloseTime\\": 1611207976000,\\n \\"ExtAttrs\\": {\\n \\"EvaluationScore\\": 1,\\n \\"OnlineJoinRespInterval\\": 1,\\n \\"Dnis\\": \\"05712688****\\",\\n \\"OnlineSessionSource\\": 0,\\n \\"EvaluationStatus\\": 1,\\n \\"EvaluationLevel\\": 2,\\n \\"OutCallRouteNumber\\": \\"05712688****\\",\\n \\"Ani\\": \\"187****0000\\",\\n \\"EvaluationSolution\\": 0\\n },\\n \\"TouchEndReason\\": 2,\\n \\"MemberName\\": \\"访客\\",\\n \\"ServicerId\\": 0,\\n \\"ChannelType\\": 1,\\n \\"TouchContent\\": \\"1\\"\\n }\\n ],\\n \\"NextPage\\": 2\\n },\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"865658FD-80DE-5D49-ABEB-F3CC9863F4F1\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n Success\\n 865658FD-80DE-5D49-ABEB-F3CC9863F4F1\\n true\\n \\n 100\\n 2\\n 1\\n 4\\n 2\\n 2\\n false\\n \\n 1\\n 678026\\n 0\\n 13900001234\\n 1\\n 1611207976000\\n 1611207979000\\n null\\n 905\\n 111\\n 1\\n xxxx\\n 1386****\\n 111\\n 100\\n 2\\n 访客\\n 测试1\\n 1611209971000\\n 2\\n 1611209971000\\n 4f8807a9de024507a3090b5b66a8****\\n \\n 1\\n 2\\n 0\\n 187****0000\\n 1\\n 0\\n 1\\n 05712688****\\n 05712688****\\n \\n \\n \\n","errorExample":""}]', 'title' => '查询接触数据', 'summary' => '根据实例、接触ID列表、会话ID列表等查询接触数据。', 'description' => '此接口可查询接触状态、会话接受者、客服名称、接触渠道、满意度评分、评价状态等接触数据,详情可查看[返回参数](#api-detail-40)。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:50次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetCustomerInfo' => [ 'summary' => '调用GetCustomerInfo接口根据工作台会员ID获取会员详情。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'MemberId', 'in' => 'query', 'schema' => [ 'title' => '会员ID', 'description' => '会员ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'exclusiveMaximum' => true, 'minimum' => '1', 'example' => '82345678****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DF6A3FB7-A5AA-43BE-A65B', ], 'Message' => [ 'title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'title' => '会员信息', 'description' => '会员信息。', 'type' => 'object', 'properties' => [ 'OuterId' => [ 'title' => '外部ID', 'description' => '外部ID。', 'type' => 'string', 'example' => '6666666', ], 'Nick' => [ 'title' => '昵称', 'description' => '昵称。', 'type' => 'string', 'example' => '测试会员', ], 'UserId' => [ 'title' => '会员ID', 'description' => '会员ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '823456789023', ], 'CustomizeFields' => [ 'title' => '自定义字段', 'description' => '自定义字段。', 'type' => 'object', ], 'Photo' => [ 'title' => '头像', 'description' => '头像。', 'type' => 'string', 'example' => 'https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLSW7XPFlJDwVunXP8pr84TvltwtLlNqTlOVSFeM3bCgn57mAB4JuZZmvMW0qicqW0PyzyUdZpxiaFQ', ], 'RealName' => [ 'title' => '真实姓名', 'description' => '真实姓名。', 'type' => 'string', 'example' => '刘测试', ], ], ], 'Code' => [ 'title' => '错误码', 'description' => '状态码。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '是否请求成功', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DF6A3FB7-A5AA-43BE-A65B\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"OuterId\\": \\"6666666\\",\\n \\"Nick\\": \\"测试会员\\",\\n \\"UserId\\": 823456789023,\\n \\"CustomizeFields\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Photo\\": \\"https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLSW7XPFlJDwVunXP8pr84TvltwtLlNqTlOVSFeM3bCgn57mAB4JuZZmvMW0qicqW0PyzyUdZpxiaFQ\\",\\n \\"RealName\\": \\"刘测试\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nDF6A3FB7-A5AA-43BE-A65B\\nsuccessful\\n200\\ntrue\\n\\n 测试会员\\n https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLSW7XPFlJDwVunXP8pr84TvltwtLlNqTlOVSFeM3bCgn57mAB4JuZZmvMW0qicqW0PyzyUdZpxiaFQ\\n 823456789023\\n 刘测试\\n 6666666\\n\\n","errorExample":""}]', 'title' => '获取会员信息', ], 'GetHotlineMessageLog' => [ 'summary' => '调用GetHotlineMessageLog接口获取热线消息记录。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'Acid', 'in' => 'query', 'schema' => [ 'title' => '会话id', 'description' => '会话ID。', 'type' => 'string', 'required' => true, 'example' => '100****2077', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Rusult', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'Data' => [ 'description' => '语音信息。', 'type' => 'array', 'items' => [ 'description' => '语音信息。', 'type' => 'object', 'properties' => [ 'Acid' => [ 'title' => '会话ID', 'description' => '会话ID。', 'type' => 'string', 'example' => '100****2077', ], 'EndTime' => [ 'title' => '结束时间', 'description' => '结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1623738027480', ], 'Content' => [ 'title' => '会话内容', 'description' => '会话内容。', 'type' => 'string', 'example' => '您好。', ], 'SenderType' => [ 'title' => '发送方类型(1:会员,2:坐席)', 'description' => '发送方类型。取值:'."\n" .'- **1**:会员'."\n" .'- **2**:坐席', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'StartTime' => [ 'title' => '开始时间', 'description' => '开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1623738026460', ], 'Mid' => [ 'title' => '记录id', 'description' => '记录ID。', 'type' => 'string', 'example' => '11deca999****', ], ], ], ], 'Code' => [ 'title' => '错误码', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'title' => '调用是否成功', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": [\\n {\\n \\"Acid\\": \\"100****2077\\",\\n \\"SenderType\\": 1,\\n \\"StartTime\\": 1623738026460,\\n \\"EndTime\\": 1623738027480,\\n \\"Mid\\": \\"11deca999****\\",\\n \\"Content\\": \\"您好。\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n true\\n Success\\n xxxx\\n \\n 100****2077\\n 1\\n 1623738026460\\n 1623738027480\\n 11deca999****\\n 您好。\\n \\n","errorExample":""}]', 'title' => '获取热线消息记录', ], 'GetHotlineCallAction' => [ 'summary' => '调用GetHotlineCallAction接口查询话务动作结果数据。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d9****', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'username@example.com', ], ], [ 'name' => 'Act', 'in' => 'formData', 'schema' => [ 'description' => '操作类型。取值:'."\n" .'- **1**:热线。'."\n" .'- **2**:在线。'."\n" .'- **3**:工单。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1', 'default' => '0', ], ], [ 'name' => 'FromSource', 'in' => 'formData', 'schema' => [ 'description' => '来源类型。取值:'."\n" ."\n" .'- **hotlinebs_out**:热线。'."\n" .'- **ticket_out**:工单。'."\n" .'- **other_system_out**:其他系统。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hotlinebs_out', ], ], [ 'name' => 'Biz', 'in' => 'formData', 'schema' => [ 'title' => '业务自定义参数', 'description' => '业务自定义参数,格式为JSON。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"name":123}', ], ], [ 'name' => 'Acc', 'in' => 'formData', 'schema' => [ 'title' => '热线自定义参数', 'description' => '热线自定义参数,格式为JSON。', 'type' => 'string', 'required' => false, 'example' => '{"time":1}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => ' '."\n" .'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE339D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => '任务编号。', 'type' => 'integer', 'format' => 'int64', 'example' => '12345****', ], 'SubTouchId' => [ 'description' => '次接触ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '3423****', ], 'MemberList' => [ 'description' => '会员列表。', 'type' => 'string', 'example' => '8900****', ], 'DepId' => [ 'description' => '部门编号。', 'type' => 'integer', 'format' => 'int64', 'example' => '1223****', ], 'CaseId' => [ 'description' => '工单编号。', 'type' => 'integer', 'format' => 'int64', 'example' => '1138902****', ], 'ChannelId' => [ 'description' => '渠道编号。', 'type' => 'string', 'example' => '2377****', ], 'TouchId' => [ 'description' => '接触ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2235****', ], 'BuId' => [ 'description' => '租户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2367****', ], 'CalloutId' => [ 'description' => '呼叫编号', 'type' => 'integer', 'format' => 'int64', 'example' => '1122****', ], 'MemberId' => [ 'description' => '会员ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '7856876****', ], 'ActionId' => [ 'description' => '客户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '8999****', ], 'ServicerName' => [ 'description' => '客服名称。', 'type' => 'string', 'example' => 'XX测试', ], 'CalloutName' => [ 'description' => '呼叫名称。', 'type' => 'string', 'example' => '王XX', ], 'IsTransfer' => [ 'description' => '是否转移。', 'type' => 'string', 'example' => 'true', ], 'MemberName' => [ 'description' => '会员名称。', 'type' => 'string', 'example' => '匿名会员', ], 'ServicerId' => [ 'description' => '坐席ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1332****', ], 'ChannelType' => [ 'description' => '渠道类型。取值:'."\n" ."\n" .'- **1**:热线。'."\n" .'- **2**:在线。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], ], ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0,\\n \\"SubTouchId\\": 0,\\n \\"MemberList\\": \\"8900****\\",\\n \\"DepId\\": 0,\\n \\"CaseId\\": 0,\\n \\"ChannelId\\": \\"2377****\\",\\n \\"TouchId\\": 0,\\n \\"BuId\\": 0,\\n \\"CalloutId\\": 0,\\n \\"MemberId\\": 0,\\n \\"ActionId\\": 0,\\n \\"ServicerName\\": \\"XX测试\\",\\n \\"CalloutName\\": \\"王XX\\",\\n \\"IsTransfer\\": \\"true\\",\\n \\"MemberName\\": \\"匿名会员\\",\\n \\"ServicerId\\": 0,\\n \\"ChannelType\\": 2\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n OK\\n EE339D98-9BD3-4413-B165\\n true\\n \\n XX测试\\n 匿名会员\\n 2\\n 王XX\\n 2377****\\n true\\n 8900****\\n \\n","errorExample":""}]', 'title' => '查询话务动作结果数据', 'description' => '### QPS限制'."\n" .'- 单用户调用频率:50次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'RobotCall' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CalledShowNumber', 'in' => 'query', 'schema' => [ 'description' => '呼出主叫号码。在语音服务[真实号管理](https://dyvmsnext.console.aliyun.com/number/list/normal)界面查看。', 'type' => 'string', 'required' => true, 'example' => '132****0849', ], ], [ 'name' => 'CalledNumber', 'in' => 'query', 'schema' => [ 'description' => '被叫号码。', 'type' => 'string', 'required' => true, 'example' => '131****2204', ], ], [ 'name' => 'RobotId', 'in' => 'query', 'schema' => [ 'description' => '机器人ID,即话术ID。在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面查看审核通过的话术ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1000035******', ], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => [ 'description' => '预留给调用方使用的 ID,最终会通过回执消息将此 ID 带回给调用方,长度为 1~15 个字节。', 'type' => 'string', 'required' => false, 'example' => '222356****', ], ], [ 'name' => 'RecordFlag', 'in' => 'query', 'schema' => [ 'description' => '通话过程是否录音。取值:'."\n" ."\n" .'- **false**(默认值):不录音。'."\n" .'- **true**:录音。'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'EarlyMediaAsr', 'in' => 'query', 'schema' => [ 'description' => '是否启用号码状态识别标识。取值:'."\n" ."\n" .'- **false**(默认值):不启用。'."\n" .'- **true**:启用。'."\n" .'>启用后会记录通话未接听的原因。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => [ 'description' => '机器人的参数列表。JSON格式。总长度不要超过512个字节。在[话术管理](https://aiccs.console.aliyun.com/patter/list)>**详情**>**输出输入参数**中查看或通过[ListRobotParams](~~2717999~~)接口查看。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "name": "张三",'."\n" .' "age": "25"'."\n" .'}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', ], 'Data' => [ 'description' => '此次通话的唯一回执ID,即呼叫唯一ID。', 'type' => 'string', 'example' => '1160128*****^10281427*****', ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', ], [ 'errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"1160128*****^10281427*****\\",\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n A90E4451-FED7-49D2-87C8-00700A8C4D0D\\n 116012854210^10281427*****\\n OK\\n","errorExample":""}]', 'title' => '智能联络机器人呼出', 'summary' => '发起智能联络机器人呼出。', 'description' => '- 在发起智能联络机器人呼出之前,请先确保您在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面已有审核通过的话术;在语音服务[真实号管理](https://dyvmsnext.console.aliyun.com/number/list/normal)界面已有申请成功的真实号码。'."\n" ."\n" .'- 呼叫的创建时间可从此接口调用后的**Response Header**中的**date**参数获取。'."\n" .'> 例如,**date**参数为:"date": "Mon, 24 Jun 2024 03:40:31 GMT",则呼叫的创建时间为:"2024-06-24 03:40:31"。'."\n" ."\n\n" ."\n\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:1000次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'ListRobotCallDialog' => [ 'summary' => '查询智能联络机器人通话记录。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CallId', 'in' => 'query', 'schema' => [ 'description' => '呼叫唯一ID。可调用[RobotCall](~~2717996~~)接口,查看返回参数的**Data**获取。', 'type' => 'string', 'required' => true, 'example' => '12516551****^11195613****', ], ], [ 'name' => 'CreateTime', 'in' => 'query', 'schema' => [ 'description' => '创建时间。格式:YYYY-MM-DD hh:mm:ss,需要精确到时间。可调用[RobotCall](~~2717996~~)接口,查看调用后的**Response Header**中的**date**参数获取。', 'type' => 'string', 'required' => true, 'example' => '2021-05-20 00:00:00', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'description' => '对话记录。', 'type' => 'array', 'items' => [ 'description' => '对话记录列表。', 'type' => 'object', 'properties' => [ 'Role' => [ 'description' => '对话内容角色。', 'type' => 'string', 'example' => 'robot', ], 'Content' => [ 'description' => '话术内容。', 'type' => 'string', 'example' => '我是某某的客服,看您之前在我们家找过工作,做个回访,现在工作怎么样?', ], 'NodeType' => [ 'description' => '节点类型。', 'type' => 'string', 'example' => '开场白', ], 'Time' => [ 'description' => '开始时间。时间戳格式,单位:毫秒。', 'type' => 'string', 'example' => '1621483557000', ], 'Tag' => [ 'description' => '意图标签。', 'type' => 'string', 'example' => '拒绝', ], ], ], ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', ], [ 'errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"Role\\": \\"robot\\",\\n \\"Content\\": \\"我是某某的客服,看您之前在我们家找过工作,做个回访,现在工作怎么样?\\",\\n \\"NodeType\\": \\"开场白\\",\\n \\"Time\\": \\"1621483557000\\",\\n \\"Tag\\": \\"拒绝\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n \\n robot\\n 您好\\n normal\\n \\n 意图标签\\n \\n OK\\n OK\\n true\\n","errorExample":""}]', 'title' => '查询通话记录', 'description' => '- 在调用此接口之前,请确保您已使用智能联络机器人发起过呼出任务。'."\n" ."\n" .'- 若您还没有使用智能联络机器人发起呼出任务,可以调用[RobotCall](~~2717996~~)接口发起呼出任务。'."\n" ."\n\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:500次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'ListAiccsRobot' => [ 'summary' => '获取机器人话术列表。包含机器人类型、机器人名称、机器人ID、所属业务、行业信息。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RobotName', 'in' => 'query', 'schema' => [ 'description' => '机器人名称。在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面查看机器人名称。', 'type' => 'string', 'required' => false, 'example' => '测试机器人', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'description' => '机器人话术。', 'type' => 'array', 'items' => [ 'description' => '话术列表。', 'type' => 'object', 'properties' => [ 'RobotType' => [ 'description' => '机器人类型。', 'type' => 'string', 'example' => 'CUSTOM', ], 'AtSence' => [ 'description' => '所属业务。', 'type' => 'string', 'example' => '新房销售', ], 'AtProfession' => [ 'description' => '所属行业。', 'type' => 'string', 'example' => '房地产', ], 'RobotName' => [ 'description' => '机器人名称。', 'type' => 'string', 'example' => '测试机器人', ], 'Id' => [ 'description' => '机器人ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12****', ], ], ], ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', ], [ 'errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"RobotType\\": \\"CUSTOM\\",\\n \\"AtSence\\": \\"新房销售\\",\\n \\"AtProfession\\": \\"房地产\\",\\n \\"RobotName\\": \\"测试机器人\\",\\n \\"Id\\": 0\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n \\n CUSTOM\\n 新房销售\\n 房地产\\n 机器人\\n 123456\\n \\n OK\\n successful\\n true\\n","errorExample":""}]', 'title' => '获取话术列表', 'description' => '- 在调用此接口之前,请确保您已有审核通过的话术。'."\n" ."\n" .'- 若您没有已审核通过的话术,请先在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面添加话术并提交审核。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:500次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'ListRobotParams' => [ 'summary' => '根据机器人ID,即话术ID,查询机器人参数列表。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RobotId', 'in' => 'query', 'schema' => [ 'description' => '机器人ID,即话术ID。在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面查看或通过[ListAiccsRobot](~~2717998~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '12****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FF67D4D5-4E90-1DF5-BB8F-060BBFAD72DB', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful', ], 'Data' => [ 'description' => '参数信息。', 'type' => 'array', 'items' => [ 'description' => '参数列表。', 'type' => 'object', 'properties' => [ 'IsEmpty' => [ 'description' => '是否必填。取值:'."\n" ."\n" .'- 0:非必填。'."\n" ."\n" .'- 1:必填。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ParamCode' => [ 'description' => '参数ID。', 'type' => 'string', 'example' => '1', ], 'ParamName' => [ 'description' => '参数名称。', 'type' => 'string', 'example' => '名称', ], ], ], ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', ], [ 'errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FF67D4D5-4E90-1DF5-BB8F-060BBFAD72DB\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"IsEmpty\\": 0,\\n \\"ParamCode\\": \\"1\\",\\n \\"ParamName\\": \\"名称\\"\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n FF67D4D5-4E90-1DF5-BB8F-060BBFAD72DB\\n \\n 0\\n name\\n 名称\\n \\n 200\\n successful\\n true\\n","errorExample":""}]', 'title' => '查询机器人参数列表', 'description' => '- 在调用此接口之前,请确保您已有新增的机器人输入参数。'."\n" ."\n" .'- 若您的机器人没有新增输入参数,请在[**话术管理**](https://aiccs.console.aliyun.com/patter/list)>**配置**>**输入输出参数**界面单击新增输入参数。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:500次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetCallSoundRecord' => [ 'summary' => '根据呼叫创建时间、呼叫唯一ID获取通话录音文件URL,根据URL获取通话录音文件。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'CreateTime', 'in' => 'query', 'schema' => [ 'description' => '呼叫创建时间。格式:YYYY-MM-DD hh:mm:ss。'."\n" ."\n\n" .'可调用[RobotCall](~~2717996~~)接口,查看调用后的**Response Header**中的**date**参数获取。', 'type' => 'string', 'required' => true, 'example' => '2021-10-15 08:56:23', ], ], [ 'name' => 'CallId', 'in' => 'query', 'schema' => [ 'description' => '呼叫唯一ID。'."\n" ."\n\n" .'可调用[RobotCall](~~2717996~~)接口,查看返回参数的**Data**获取。', 'type' => 'string', 'required' => true, 'example' => '125165515022^11195613****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'description' => '通话录音文件URL。', 'type' => 'string', 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/1001067****.wav', ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', ], [ 'errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/1001067****.wav\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n String\\tD9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/1001067****.wav\\n OK\\n OK\\n true\\n","errorExample":""}]', 'title' => '获取通话录音文件', 'description' => '### 前提条件'."\n" .'调用本接口前,请您确保调用[RobotCall](~~223270~~)接口过程中,已开启通话过程录音,且成功获取录音回执,即录音文件已生成,否则会返回无效的URL链接。'."\n" ."\n" .'### 使用说明'."\n" .'本接口为录音回执的补充接口。当录音回执消息中的URL链接超过有效期后,可以通过本接口获取新的录音地址,默认录音回执URL有效期为三天。'."\n" ."\n" .'> 建议您通过录音回执URL直接下载录音内容,进行本地保存,不依赖回执的URL,以解决有效期问题。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:500次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'ListRobotNode' => [ 'summary' => '根据机器人ID,即话术ID,获取机器人节点信息列表。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RobotId', 'in' => 'query', 'schema' => [ 'description' => '机器人ID,即话术ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的智能外呼机器人>话术管理中获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '100002674****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码的描述。', 'type' => 'string', 'example' => 'Ok', ], 'Data' => [ 'description' => '机器人节点列表。', 'type' => 'array', 'items' => [ 'description' => '机器人节点列表。', 'type' => 'object', 'properties' => [ 'ProcessName' => [ 'description' => '流程名称。', 'type' => 'string', 'example' => '开场白', ], 'ModelName' => [ 'description' => '模型名称。', 'type' => 'string', 'example' => '模型一', ], 'IsOutput' => [ 'description' => '是否输出。取值:'."\n" ."\n" .'- **1**:是。'."\n" .'- **0**:否。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'NodeName' => [ 'description' => '节点名称。', 'type' => 'string', 'example' => '理财', ], 'NodeIdentifier' => [ 'description' => '输出ID。', 'type' => 'string', 'example' => '12****', ], ], ], ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'Ok', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', ], [ 'errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"Ok\\",\\n \\"Data\\": [\\n {\\n \\"ProcessName\\": \\"开场白\\",\\n \\"ModelName\\": \\"模型一\\",\\n \\"IsOutput\\": 1,\\n \\"NodeName\\": \\"理财\\",\\n \\"NodeIdentifier\\": \\"12****\\"\\n }\\n ],\\n \\"Code\\": \\"Ok\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n \\n 开场白\\n 模型一\\n 理财\\n 1\\n 123456\\n \\n Ok\\n Ok\\n true\\n","errorExample":""}]', 'title' => '获取机器人节点信息列表', 'description' => '- 机器人节点信息包括流程名称、模型名称、节点名称、是否输出、输出ID。'."\n" .'- 调用前,建议您确认机器人ID,即话术ID,请参考[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:500次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'CreateTask' => [ 'summary' => '创建智能联络机器人呼叫任务。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => '任务名称。支持中文和英文,0~30个字符。', 'type' => 'string', 'required' => true, 'example' => '测试任务', ], ], [ 'name' => 'RobotId', 'in' => 'query', 'schema' => [ 'description' => '指定机器人ID(话术ID)。表示选择哪个机器人话术发起呼叫。'."\n" ."\n" .'您可在控制台的[话术管理](https://aiccs.console.aliyun.com/patter/list)页面,获取话术ID。', 'type' => 'string', 'required' => true, 'example' => '12****', ], ], [ 'name' => 'Caller', 'in' => 'query', 'schema' => [ 'description' => '外呼主叫号码。'."\n" ."\n" .'> 必须是已购买的号码,多个号码用英文逗号(,)隔开。', 'type' => 'string', 'required' => true, 'example' => '0571****5678,0571****5679', ], ], [ 'name' => 'CallString', 'in' => 'query', 'schema' => [ 'description' => '呼叫字符(被叫信息和参数列表)。取值:'."\n" ."\n" .'- **LIST**:`05715678****,05715679****`'."\n" .'- **JSON**:`{"ParamNames":["name","age"],"CalleeList":[{"Callee":"1810000****","Params":["张三","20"]},{"Callee":"1810001****","Params":["李四","21"]}]}`。其中ParamNames代表参数名称列表;Params代表参数值列表。'."\n" ."\n" .'> - 参数名称列表和参数值列表顺序需要对应。 '."\n" .'- 最多1000个被叫号码。'."\n" ."\n\n" ."\n", 'type' => 'string', 'required' => false, 'example' => '{"ParamNames":["name","age"],"CalleeList":[{"Callee":"1810000****","Params":["张三","20"]},{"Callee":"1810001****","Params":["李四","21"]}]}', ], ], [ 'name' => 'CallStringType', 'in' => 'query', 'schema' => [ 'description' => '呼叫字符串类型。取值:'."\n" ."\n" .'- **LIST**'."\n" .'- **JSON**', 'type' => 'string', 'required' => true, 'example' => 'JSON', ], ], [ 'name' => 'RetryFlag', 'in' => 'query', 'schema' => [ 'description' => '是否自动重拨。取值:'."\n" ."\n" .'- **1**:重拨。'."\n" .'- **0**:不重拨。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'RetryCount', 'in' => 'query', 'schema' => [ 'description' => '重拨次数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'RetryInterval', 'in' => 'query', 'schema' => [ 'description' => '重拨间隔。单位:分钟,必须大于1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'RetryStatusCode', 'in' => 'query', 'schema' => [ 'description' => '需要重拨的通话状态。多个状态使用英文逗号(,)分隔。取值:'."\n" ."\n" .'- **200010**:关机。'."\n" .'- **200011**:停机。'."\n" .'- **200002**:占线。'."\n" .'- **200012**:呼损。'."\n" .'- **200005**:无法接通。'."\n" .'- **200003**:无应答。', 'type' => 'string', 'required' => false, 'example' => '200010,200011', ], ], [ 'name' => 'StartNow', 'in' => 'query', 'schema' => [ 'description' => '是否立即启动。'."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => '是', 'default' => 'false', ], ], [ 'name' => 'WorkTimeList', 'in' => 'query', 'schema' => [ 'description' => '工作时间列表(精确到分钟)。', 'type' => 'string', 'required' => true, 'example' => '10:00-12:00,13:00-14:00', ], ], [ 'name' => 'WorkDay', 'in' => 'query', 'schema' => [ 'description' => '工作日期。取值:'."\n" ."\n" .'- **1**:星期一。'."\n" .'- **2**:星期二。'."\n" .'- **3**:星期三。'."\n" .'- **4**:星期四。'."\n" .'- **5**:星期五。'."\n" .'- **6**:星期六。'."\n" .'- **7**:星期天。'."\n", 'type' => 'string', 'required' => true, 'example' => '1', ], ], [ 'name' => 'SeatCount', 'in' => 'query', 'schema' => [ 'description' => '并发数量(坐席数量)。', 'type' => 'string', 'required' => true, 'example' => '3', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'description' => '机器人呼叫任务的唯一任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12****', ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', ], [ 'errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n 123456\\n OK\\n OK\\n true\\n","errorExample":""}]', 'title' => '创建任务', 'description' => '- 您可以调用此接口创建任务,也可以在**智能联络中心控制台**>**智能外呼机器人(标准版)**>[任务管理](https://aiccs.console.aliyun.com/job/list)>单击**创建任务**进行创建。'."\n" .'- 调用此接口后,返回参数的**Data**为机器人呼叫任务的唯一任务ID。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:500次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'AttachTask' => [ 'summary' => '追加任务明细。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面获取任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '12****', ], ], [ 'name' => 'CallString', 'in' => 'query', 'schema' => [ 'description' => '呼叫字符(被叫信息和参数列表)。取值:'."\n" ."\n" .'- **LIST**:话术没有输入变量时,则使用LIST类型参数,只需传入呼叫号码。如:`0571****5678,0571****5679`。'."\n" .'- **JSON**:话术有输入变量时,则使用JSON类型参数。需要传入变量名称、呼叫号码、变量值。如:`{"ParamNames":["name","age"],"CalleeList":[{"Callee":"181****0000","Params":["张三","20"]},{"Callee":"181****0001","Params":["李四","21"]}]}`。**ParamNames**代表参数名称列表;**Params**代表参数值列表。'."\n" .'> 话术输入变量在[**话术管理**](https://aiccs.console.aliyun.com/patter/list)>**查看**>**输入输出参数**界面查看', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "ParamNames": ['."\n" .' "name",'."\n" .' "age"'."\n" .' ],'."\n" .' "CalleeList": ['."\n" .' {'."\n" .' "Callee": "181****0000",'."\n" .' "Params": ['."\n" .' "张三",'."\n" .' "20"'."\n" .' ]'."\n" .' },'."\n" .' {'."\n" .' "Callee": "181****0001",'."\n" .' "Params": ['."\n" .' "李四",'."\n" .' "21"'."\n" .' ]'."\n" .' }'."\n" .' ]'."\n" .'}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'description' => '追加成功的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口调用是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', ], [ 'errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 10,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n 10\\n OK\\n OK\\n true\\n","errorExample":""}]', 'title' => '追加明细', 'description' => '- 您在创建智能联络机器人呼叫任务后,可调用此接口追加任务明细。'."\n" ."\n" .'- 在调用此接口之前,请确保您已有创建成功的智能联络机器人呼叫任务。'."\n" ."\n" .'- 若您没有已创建成功的智能联络机器人呼叫任务,您可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面单击创建任务或通过[CreateTask](~~2718003~~)接口创建任务。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:500次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'StartTask' => [ 'summary' => '启动已创建成功的智能联络机器人呼叫任务。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)页面查看或通过[CreateTask](~~223556~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12****', ], ], [ 'name' => 'StartNow', 'in' => 'query', 'schema' => [ 'description' => '是否立即启动。取值:'."\n" .'- **true**:是。'."\n" .'- **false**:否。代表不启动任务。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'description' => '是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口调用是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', ], [ 'errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n true\\n OK\\n OK\\n true\\n","errorExample":""}]', 'title' => '启动任务', 'description' => '- 您可调用此接口启动已创建成功的智能联络机器人呼叫任务,也可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面手动启动任务。'."\n" ."\n" .'- 在调用此接口之前,请确保您已有创建成功的智能联络机器人呼叫任务。'."\n" ."\n" .'- 若您没有已创建成功的智能联络机器人呼出任务,可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面单击创建任务或通过[CreateTask](~~2718003~~)接口创建任务。'."\n" ."\n\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:500次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'StopTask' => [ 'summary' => '暂停已成功启动的智能联络机器人呼叫任务。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)页面查看或通过[CreateTask](~~223556~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'description' => '是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口调用是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', ], [ 'errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n true\\n Ok\\n OK\\n true\\n","errorExample":""}]', 'title' => '暂停任务', 'description' => '- 你可通过此接口暂停已成功启动的智能联络机器人呼叫任务,也可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面手动暂停任务。'."\n" ."\n" .'- 在调用此接口之前,请确保您已有成功启动的智能联络机器人呼叫任务。'."\n" ."\n" .'- 若您没有已成功启动的智能联络机器人呼叫任务,请在[任务管理](https://aiccs.console.aliyun.com/job/list)界面点击启动或通过[StartTask](~~2718005~~)接口启动任务。'."\n" ."\n\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:500次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'CancelTask' => [ 'summary' => '取消智能联络机器人呼叫任务。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面查看或通过[CreateTask](~~223556~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'description' => '是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口是否调用成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', ], [ 'errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n true\\n OK\\n Ok\\n true\\n","errorExample":""}]', 'title' => '取消任务', 'description' => '- 您可调用此接口取消智能联络机器人呼叫任务,也可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面手动取消任务。'."\n" ."\n" .'- 智能联络机器人呼叫任务被取消后,将无法再次启动,请谨慎操作。'."\n" ."\n" .'- 若您想暂停任务之后再次开启任务,可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面手动暂停任务或通过[StopTask](~~2718006~~)接口暂停任务。'."\n" ."\n\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:500次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'ListTask' => [ 'summary' => '分页查询智能联络机器人呼叫任务列表。包含任务总数、任务信息。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'description' => '任务名称。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面查看已创建的任务名称。', 'type' => 'string', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '任务测试', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页数量。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '任务状态。取值:'."\n" ."\n" .'- **INIT**:未开始。'."\n" .'- **RELEASE**:解析中。'."\n" .'- **RUNNING**:执行中。'."\n" .'- **STOP**:手动暂停。'."\n" .'- **SYSTEM_STOP**:系统暂停。'."\n" .'- **READY**:待执行。'."\n" .'- **CANCEL**:手动终止。'."\n" .'- **SYSTEM_CANCEL**:系统终止。'."\n" .'- **DONE**:已完成。', 'type' => 'string', 'required' => false, 'example' => 'STOP', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面查看或通过[CreateTask](~~223556~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****', ], ], [ 'name' => 'RobotName', 'in' => 'query', 'schema' => [ 'description' => '机器人名称。即为话术名称,在[话术管理](https://aiccs.console.aliyun.com/patter/list)界面查看已经通过审核的话术名称。', 'type' => 'string', 'required' => false, 'example' => '机器人', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'description' => '任务数据列表。', 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => '每页个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'Total' => [ 'description' => '任务总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'PageNo' => [ 'description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Record' => [ 'description' => '任务信息列表。', 'type' => 'array', 'items' => [ 'description' => '任务信息。', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '任务状态。', 'type' => 'string', 'example' => 'RELEASE', ], 'GmtCreate' => [ 'description' => '任务创建时间。时间戳格式,单位:毫秒。', 'type' => 'string', 'example' => '1618477232000', ], 'TotalCount' => [ 'description' => '处理通话总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'FireTime' => [ 'description' => '任务启动时间。时间戳格式,单位:毫秒。', 'type' => 'string', 'example' => '1618477232000', ], 'TaskName' => [ 'description' => '任务名称。', 'type' => 'string', 'example' => '测试任务', ], 'RobotId' => [ 'description' => '指定机器人ID。即为话术ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12****', ], 'RobotName' => [ 'description' => '机器人名称。', 'type' => 'string', 'example' => '机器人', ], 'Id' => [ 'description' => '机器人呼叫任务的唯一任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12****', ], 'CompleteCount' => [ 'description' => '完成通话个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', ], [ 'errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageSize\\": 20,\\n \\"Total\\": 50,\\n \\"PageNo\\": 1,\\n \\"Record\\": [\\n {\\n \\"Status\\": \\"RELEASE\\",\\n \\"GmtCreate\\": \\"1618477232000\\",\\n \\"TotalCount\\": 1,\\n \\"FireTime\\": \\"1618477232000\\",\\n \\"TaskName\\": \\"测试任务\\",\\n \\"RobotId\\": 0,\\n \\"RobotName\\": \\"机器人\\",\\n \\"Id\\": 0,\\n \\"CompleteCount\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n \\n 1\\n 20\\n 50\\n \\n RELEASE\\n 1618477232000\\n 1\\n 1618477232000\\n 测试任务\\n 123456\\n 机器人\\n 123456\\n 1\\n \\n \\n OK\\n OK\\n true\\n","errorExample":""}]', 'title' => '获取任务列表', 'description' => '- 您可以通过此接口获取智能联络机器人呼叫任务列表,也可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面获取任务列表。'."\n" ."\n" .'- 若您没有已创建的智能联络机器人呼叫任务,可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面单击创建任务或通过[CreateTask](~~2718003~~)接口创建任务。'."\n" ."\n" .'- 此接口的非必填参数为智能联络机器人呼叫任务列表的筛选条件,若不填写,则查询全部任务列表。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:500次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'ListTaskDetail' => [ 'summary' => '获取智能联络机器人呼叫任务明细信息。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'StatusCode', 'in' => 'query', 'schema' => [ 'description' => '呼叫状态码。在语音服务[呼叫状态码](~~112804~~)中查看。', 'type' => 'string', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '200100', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '明细状态。取值:'."\n" ."\n" .'- **SUCCESS**:外呼成功。'."\n" .'- **FAIL**:外呼失败。'."\n" .'- **INIT**:未外呼。', 'type' => 'string', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => 'SUCCESS', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Called', 'in' => 'query', 'schema' => [ 'description' => '被叫号码。在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**界面查看被叫号码。', 'type' => 'string', 'required' => false, 'example' => '186****0000', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)页面查看任务ID或通过[ListTask](~~2718008~~)接口获取任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '12****', ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '明细ID。在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**界面查看明细ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'description' => '任务详细信息。', 'type' => 'object', 'properties' => [ 'PageSize' => [ 'description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Total' => [ 'description' => '任务总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'PageNo' => [ 'description' => '每页个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'Record' => [ 'description' => '任务信息列表。', 'type' => 'array', 'items' => [ 'description' => '任务信息。', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '明细状态。', 'type' => 'string', 'example' => 'SUCCESS', ], 'Called' => [ 'description' => '被叫号码。', 'type' => 'string', 'example' => '186****0000', ], 'EndTime' => [ 'description' => '结束时间。', 'type' => 'string', 'example' => '2021-05-20 00:03:00', ], 'StartTime' => [ 'description' => '开始时间。', 'type' => 'string', 'example' => '2021-05-20 00:00:00', ], 'Duration' => [ 'description' => '通话时长。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'StatusCode' => [ 'description' => '呼叫状态码。', 'type' => 'string', 'example' => '200100', ], 'StatusCodeDesc' => [ 'description' => '呼叫状态码描述。', 'type' => 'string', 'example' => '呼叫成功', ], 'Direction' => [ 'description' => '挂断方向。取值:'."\n" ."\n" .'- **用户**。'."\n" .'- **机器**。', 'type' => 'string', 'example' => '用户', ], 'RetryCurTimes' => [ 'description' => '当前重试次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Caller' => [ 'description' => '主叫号码。', 'type' => 'string', 'example' => '136****0000', ], 'Id' => [ 'description' => '明细ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12****', ], 'RetryTimes' => [ 'description' => '重试次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Tags' => [ 'description' => '意图标签。', 'type' => 'string', 'example' => '肯定', ], ], ], ], ], ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', ], [ 'errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageSize\\": 1,\\n \\"Total\\": 50,\\n \\"PageNo\\": 20,\\n \\"Record\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Called\\": \\"186****0000\\",\\n \\"EndTime\\": \\"2021-05-20 00:03:00\\",\\n \\"StartTime\\": \\"2021-05-20 00:00:00\\",\\n \\"Duration\\": 30,\\n \\"StatusCode\\": \\"200100\\",\\n \\"StatusCodeDesc\\": \\"呼叫成功\\",\\n \\"Direction\\": \\"用户\\",\\n \\"RetryCurTimes\\": 1,\\n \\"Caller\\": \\"136****0000\\",\\n \\"Id\\": 0,\\n \\"RetryTimes\\": 1,\\n \\"Tags\\": \\"肯定\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n \\n 20\\n 1\\n 50\\n \\n SUCCESS\\n 1\\n 186****0000\\n 136****0000\\n 30\\n 123456\\n 00001\\n 呼叫成功\\n 1\\n 2021-05-20 00:00:00\\n 2021-05-20 00:03:00\\n 用户\\n 标签\\n \\n \\n OK\\n Ok\\n true\\n","errorExample":""}]', 'title' => '获取任务明细信息', 'description' => '- 您可调用此接口获取智能联络机器人呼叫任务明细信息,也可在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**界面查看智能联络机器人呼叫任务明细信息。'."\n" ."\n" .'- 在调用此接口前,请确保您创建成功的智能联络机器人已成功启动任务。'."\n" ."\n" .'- 若您没有已创建成功的智能联络机器人呼叫任务,可以在[任务管理](https://aiccs.console.aliyun.com/job/list)界面创建并启动任务或通过[CreateTask](~~2718003~~)、[StartTask](~~2718005~~)接口创建并启动任务。'."\n" ."\n" .'- 此接口中的非必填参数为智能联络机器人呼叫任务明细信息的筛选条件,若不填写,则查询全部任务明细信息。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:500次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'ListDialog' => [ 'summary' => '查询智能联络机器人对话记录。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'description' => '机器人呼叫任务的唯一任务ID。在[任务管理](https://aiccs.console.aliyun.com/job/list)界面查看或通过[CreateTask](~~223556~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '12****', ], ], [ 'name' => 'Called', 'in' => 'query', 'schema' => [ 'description' => '被叫号码。在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**界面查看被叫号码或通过[ListTaskDetail](~~2718009~~)接口获取被叫号码,接口返回的参数**Called**即为被叫号码。', 'type' => 'string', 'required' => true, 'example' => '130****0000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'description' => '通话交互内容。', 'type' => 'array', 'items' => [ 'description' => '通话交互内容列表。', 'type' => 'object', 'properties' => [ 'Role' => [ 'description' => '说话的角色。取值:'."\n" ."\n" .'- robot:机器人。'."\n" ."\n" .'- user:用户。', 'type' => 'string', 'example' => 'robot', ], 'Content' => [ 'description' => '话术内容。', 'type' => 'string', 'example' => '您好', ], 'NodeType' => [ 'description' => '节点类型。', 'type' => 'string', 'example' => 'normal', ], 'Time' => [ 'description' => '开始时间。时间戳格式,单位:毫秒。', 'type' => 'string', 'example' => '1619763900718', ], 'Tag' => [ 'description' => '意图标签。', 'type' => 'string', 'example' => '肯定', ], ], ], ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', ], [ 'errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"Role\\": \\"robot\\",\\n \\"Content\\": \\"您好\\",\\n \\"NodeType\\": \\"normal\\",\\n \\"Time\\": \\"1619763900718\\",\\n \\"Tag\\": \\"肯定\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n \\n robot\\n 您好\\n normal\\n \\n 意图标签\\n \\n OK\\n OK\\n true\\n","errorExample":""}]', 'title' => '查询对话记录', 'description' => '- 您可调用此接口查询智能联络机器人对话记录,也可在[**任务管理**](https://aiccs.console.aliyun.com/job/list)>**详情**>**查看对话记录**界面查看智能联络机器人对话记录。'."\n" ."\n" .'- 在调用此接口前,请确保您创建的智能联络机器人呼叫任务已有成功拨通的号码。'."\n" ."\n" .'- 若您没有已创建的智能联络机器人呼叫任务,可在[任务管理](https://aiccs.console.aliyun.com/job/list)界面创建并启动任务或通过[CreateTask](~~2718003~~)、[StartTask](~~2718005~~)接口创建并启动任务。'."\n" ."\n\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:500次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'SendCcoSmartCall' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProdCode', 'in' => 'query', 'schema' => [ 'description' => '产品名称。默认取值:**aiccs**。', 'type' => 'string', 'required' => false, 'example' => 'aiccs', 'default' => 'aiccs', ], ], [ 'name' => 'CalledShowNumber', 'in' => 'query', 'schema' => [ 'description' => '被叫显号,必须是已购买的号码。'."\n" ."\n" .'您可以登录[联络中心控制台](https://aiccs.console.aliyun.com/overview?spm=a2c4g.11186623.0.0.7f9bf9658X6jte),查看已购买的号码。', 'type' => 'string', 'required' => true, 'example' => '0571****0000', ], ], [ 'name' => 'CalledNumber', 'in' => 'query', 'schema' => [ 'description' => '被叫号码。仅支持中国内地号码。', 'type' => 'string', 'required' => true, 'example' => '137****0000', ], ], [ 'name' => 'VoiceCode', 'in' => 'query', 'schema' => [ 'description' => '智能外呼放音文件,支持网络文件和TTS方式。其中,支持使用多个文件和TTS参数混播,之间用英文逗号(,)分隔。TTS参数的替换值在**VoiceCodeParam**中指定。'."\n" ."\n" .'- 放音文件为网络文件时:参数VoiceCode指定为可被公网访问的语音文件URL,建议您使用采样频率为8000Hz或16000Hz且为wav格式的语音文件。'."\n" .'- 放音文件为TTS时:参数VoiceCode指定为变量名称如$name$,需要在VoiceCodeParam中设置变量对应的内容。', 'type' => 'string', 'required' => true, 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$', ], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => [ 'description' => '预留给调用方使用的ID,最终会通过在回执消息中将此ID带回给调用方。'."\n" .'字符串类型,长度为1~15个字节。', 'type' => 'string', 'required' => false, 'example' => '222356****', ], ], [ 'name' => 'PlayTimes', 'in' => 'query', 'schema' => [ 'description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Volume', 'in' => 'query', 'schema' => [ 'description' => '播放用户音频的音量,取值范围为:-4~4,建议设置为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Speed', 'in' => 'query', 'schema' => [ 'description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AsrModelId', 'in' => 'query', 'schema' => [ 'description' => 'ASR模型ID。请在[ASR模型管理页面](https://aiccs.console.aliyun.com/sentence/model/private?spm=a2c4g.11186623.0.0.7f9b2964fYSGv4)查看ASR模型ID。', 'type' => 'string', 'required' => false, 'example' => 'bf71664d30d2478fb8cb8c39c6b6****', ], ], [ 'name' => 'AsrBaseId', 'in' => 'query', 'schema' => [ 'description' => 'SR基础模型。'."\n" ."\n" .'- **customer_service_8k**:普通话。'."\n" .'- **dialect_customer_service_8k**:重口音。'."\n" .'- 如果仅设置**asrModelId**,表示使用指定的ASR模型。'."\n" .'- 如果仅设置**AsrBaseId**,表示使用指定的ASR基础模型。'."\n" .'- 如果二者均未设置,则使用默认的ASR基础模型,即参数**AsrBaseId**默认为**customer_service_8k**,表示使用ASR普通话基础模型。'."\n" .'- 如果二者同时设置,请确认二者是正确对应的。 '."\n" ."\n" .'> 调用接口**SendCcoSmartCall**时,需要指定使用的ASR模型,建议参数**asrModelId**和**AsrBaseId**二者选填一个。', 'type' => 'string', 'required' => false, 'example' => 'customer_service_8k', ], ], [ 'name' => 'AsrAlsAmId', 'in' => 'query', 'schema' => [ 'description' => '声学模型ID。', 'type' => 'string', 'required' => false, 'example' => '123456', ], ], [ 'name' => 'AsrVocabularyId', 'in' => 'query', 'schema' => [ 'description' => '热词ID。请在[ASR热词管理页面](https://aiccs.console.aliyun.com/sentence/vocab?spm=a2c4g.11186623.0.0.7f9bf965IKBpsi)查看ASR热词ID。', 'type' => 'string', 'required' => false, 'example' => '123456', ], ], [ 'name' => 'RecordFlag', 'in' => 'query', 'schema' => [ 'description' => '通话过程中是否录音。'."\n" .'- **true**:是。'."\n" .'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'PauseTime', 'in' => 'query', 'schema' => [ 'description' => '停顿时长。用于设置用户停顿多久表示一句话结束。单位为毫秒。取值范围为**300~1200**,如果指定值不在参数范围中,则默认PauseTime为**800**。'."\n" ."\n" .'> 首次设置有效,后续设置无效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '800', ], ], [ 'name' => 'MuteTime', 'in' => 'query', 'schema' => [ 'description' => '静音时长,用于设置用户多久不说话通话结束。单位为:毫秒,取值范围为**1000~20000**。'."\n" ."\n" .'- 如果指定值不在参数范围中,则默认MuteTime为**10000**。'."\n" .'- 通话过程中可动态设置,以最后一次设置为准。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000', ], ], [ 'name' => 'ActionCodeBreak', 'in' => 'query', 'schema' => [ 'description' => '开场放音文件是否可打断。默认为**true**,即开场放音文件可打断。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'DynamicId', 'in' => 'query', 'schema' => [ 'description' => '预留给调用方使用的动态扩展ID,在回调地址中带回,用于客户的开发标识。', 'type' => 'string', 'required' => false, 'example' => '123456', ], ], [ 'name' => 'EarlyMediaAsr', 'in' => 'query', 'schema' => [ 'description' => '早媒体语音识别标识。设为true会记录通话未接听的原因。默认为**false**,即关闭状态。'."\n" ."\n" .'> 如果需要启用早媒体语音识别标识,请手动设为**true**。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'VoiceCodeParam', 'in' => 'query', 'schema' => [ 'description' => 'TTS参数传递字符串,格式为JSON。必须与VoiceCode的TTS参数对应。', 'type' => 'string', 'required' => false, 'example' => '{"name":"喂,你好"}', ], ], [ 'name' => 'SessionTimeout', 'in' => 'query', 'schema' => [ 'description' => '最大通话时长,单位为秒,超时后自动挂断。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', ], ], [ 'name' => 'ActionCodeTimeBreak', 'in' => 'query', 'schema' => [ 'description' => '基于用户持续说话时长打断,在ActionCodeBreak为**true**时生效。单位为毫秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', ], ], [ 'name' => 'TtsConf', 'in' => 'query', 'schema' => [ 'description' => '是否设置TTS声音参数。'."\n" .'- 指定为**true**:需要通过TtsStyle、TtsVolume、TtsSpeed三个参数来设置声音风格。'."\n" .'- 定为**false**:不需要设置相关参数,即便设置了也不生效。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'TtsStyle', 'in' => 'query', 'schema' => [ 'description' => 'TTS变量播放时的声音风格,默认为**xiaoyun**,具体风格请参见声音风格列表。', 'type' => 'string', 'required' => false, 'example' => 'xiaoyun', ], ], [ 'name' => 'TtsVolume', 'in' => 'query', 'schema' => [ 'description' => 'TTS变量播放的音量,取值范围为**0~100**,默认为**0**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'TtsSpeed', 'in' => 'query', 'schema' => [ 'description' => 'TTS变量播放时的声音速度,取值范围为:-200~200,默认为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'BackgroundFileCode', 'in' => 'query', 'schema' => [ 'description' => '用户和机器人对话时播放的背景语音文件ID。您可以登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview),选择**智能交互 > 语音文件管理**,单击**详情**,查看对应的语音ID。', 'type' => 'string', 'required' => false, 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', ], ], [ 'name' => 'BackgroundVolume', 'in' => 'query', 'schema' => [ 'description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '4', 'minimum' => '-4', 'example' => '1', ], ], [ 'name' => 'BackgroundSpeed', 'in' => 'query', 'schema' => [ 'description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'EnableITN', 'in' => 'query', 'schema' => [ 'description' => '是否在后处理中执行ITN。'."\n" ."\n" .'> 设置为**true**时,中文数字将转为阿拉伯数字输出,默认为**false**。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', ], 'Data' => [ 'description' => '此次通话的唯一回执ID。', 'type' => 'string', 'example' => '16012854210^10281427****', ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', ], [ 'errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"16012854210^10281427****\\",\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n A90E4451-FED7-49D2-87C8-00700A8C4D0D\\n OK\\n 116012854210^10281427****\\n","errorExample":""}]', 'title' => '发起智能外呼', 'summary' => '根据被叫显号、被叫号码、智能外呼放音文件发起智能语音交互通话。', 'description' => '- 以下字符不可以在智能语音交互SendCcoSmartCall回调中出现:`@ = : "" $ { } ^ * ¥`。'."\n" .'- 调用此接口后,返回参数的**Data**为此次通话的唯一回执ID,可以用于调用[SendCcoSmartCallOperate](~~2718013~~)接口。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', 'requestParamsDescription' => '### 声音风格列表'."\n" ."\n" .'- 小云标准女声:xiaoyun'."\n" .'- 小刚标准男声:xiaogang'."\n" .'- 若兮温柔女声:ruoxi'."\n" .'- 小梦标准女声:xiaomeng'."\n" .'- 小威标准男声:xiaowei'."\n" .'- 阿美甜美女声:amei'."\n" .'- 小雪温柔女声:xiaoxue'."\n" .'- 思琪温柔女声:siqi'."\n" .'- 思佳标准女声:sijia'."\n" .'- 思诚标准男声:sicheng'."\n" .'- 思悦温柔女声:siyue'."\n" .'- 小美甜美女声:xiaomei'."\n" .'- 思彤标准童声:sitong'."\n" .'- 宁儿标准女声:ninger'."\n" .'- 小北萝莉女声:xiaobei'."\n" .'- 伊娜浙普女声:yina'."\n", ], 'SendCcoSmartCallOperate' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProdCode', 'in' => 'query', 'schema' => [ 'description' => '产品名称。默认取值:**aiccs**。', 'type' => 'string', 'required' => false, 'example' => 'aiccs', 'default' => 'aiccs', ], ], [ 'name' => 'CallId', 'in' => 'query', 'schema' => [ 'description' => '通话的唯一回执ID。可以通过[SendCcoSmartCall](~~311247~~)返回。', 'type' => 'string', 'required' => true, 'example' => '116012854210^102814279****', ], ], [ 'name' => 'Command', 'in' => 'query', 'schema' => [ 'description' => '在智能外呼通话中,指定被叫号码发起的动作。'."\n" ."\n" .'> 当前仅支持参数**parallelBridge**,表示指定动作为被叫号码与呼叫中心坐席桥接。', 'type' => 'string', 'required' => true, 'example' => 'parallelBridge', ], ], [ 'name' => 'Param', 'in' => 'query', 'schema' => [ 'description' => '扩展字段。', 'type' => 'string', 'required' => false, 'example' => 'Param', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', ], 'Data' => [ 'description' => '命令执行的结果。'."\n" .'- **true**:命令执行成功。'."\n" .'- **false**:命令执行失败。', 'type' => 'string', 'example' => 'true', ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', ], [ 'errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n A90E4451-FED7-49D2-87C8-00700A8C4D0D\\n true\\n OK\\n","errorExample":""}]', 'title' => '发起智能外呼', 'summary' => '在智能外呼通话中,发起指定动作,仅用于并行转人工,人工坐席可旁听人机对话等场景。', 'description' => '- 此接口仅可在智能外呼通话过程中调用成功,调用时请注意:请求参数的**CallId**需要填写正在通话的通话唯一回执ID。'."\n" .'- **CallId**为调用[SendCcoSmartCall](~~2718012~~)接口时,返回参数的**Data**参数。', ], 'CreateAiOutboundTask' => [ 'summary' => '创建智能外呼任务。支持创建时设置任务类型、任务名、外呼主叫号码、被叫号码重复策略等。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'cc_xp_pre-cn-***', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'title' => '任务类型(2:预测式外呼3:自动外呼)', 'description' => '任务类型。取值:'."\n" .'- **2**:预测式外呼。'."\n" .'- **3**:自动外呼。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', 'enum' => [ '2', '3', ], ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'title' => '任务名(1~15字符)', 'description' => '任务名。1~15字符。', 'type' => 'string', 'required' => true, 'example' => '测试任务', 'maxLength' => 15, 'minLength' => 1, ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'title' => '任务描述(0~100字符)', 'description' => '任务描述。0~100字符。', 'type' => 'string', 'required' => false, 'example' => '房产销售', 'maxLength' => 100, ], ], [ 'name' => 'OutboundNums', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '外呼主叫号码', 'description' => '外呼主叫号码。'."\n" ."\n" .'> 必须是已购买的号码,多个号码用半角逗号(,)隔开。', 'type' => 'array', 'items' => [ 'description' => '外呼主叫号码。'."\n" .'> 必须是已购买的号码,多个号码用半角逗号(,)隔开。', 'type' => 'string', 'required' => true, 'example' => '["0571****5678","0571****5678"]', ], 'required' => true, ], ], [ 'name' => 'NumRepeated', 'in' => 'query', 'schema' => [ 'title' => '被叫号码重复策略(0任务内去重,1不去重)', 'description' => '被叫号码重复策略。取值:'."\n" .'- **0**:任务内去重。'."\n" .'- **1**:不去重。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'enum' => [ '0', '1', ], ], ], [ 'name' => 'HandlerId', 'in' => 'query', 'schema' => [ 'title' => '技能组id(预测式外呼)或者ivr id(自动外呼)', 'description' => '对应的技能组ID(预测式外呼)或者IVR ID(自动外呼)。请您在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)获取信息。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', ], ], [ 'name' => 'ExecutionTime', 'in' => 'query', 'schema' => [ 'title' => '任务执行时间', 'description' => '任务执行时间。JSON格式。'."\n" ."\n" .'> 结束时间(end)需晚于开始时间(start)。', 'type' => 'string', 'required' => true, 'example' => '{"TUESDAY":[{"start":"06:00","end":"06:05"}],"MONDAY":[{"start":"09:00","end":"18:00"},{"start":"20:30","end":"21:45"},{"start":"22:30","end":"22:50"}],"WEDNESDAY":[{"start":"09:00","end":"18:00"}],"THURSDAY":[{"start":"09:00","end":"18:00"}],"FRIDAY":[{"start":"09:00","end":"18:00"}],"SATURDAY":[{"start":"09:00","end":"18:00"}],"SUNDAY":[{"start":"17:00","end":"23:45"}]}', ], ], [ 'name' => 'ConcurrentRate', 'in' => 'query', 'schema' => [ 'title' => '自动外呼的呼叫并发', 'description' => '自动外呼的呼叫并发。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'RecallRule', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '失败重呼策略(为空则不重呼)', 'description' => '失败重呼策略。'."\n" ."\n" .'> 取值为空则不重呼。', 'type' => 'object', 'properties' => [ 'Count' => [ 'title' => '重呼次数(1~3)', 'description' => '重呼次数。取值范围:**1~3**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3', 'minimum' => '1', 'example' => '1', ], 'Interval' => [ 'title' => '重呼间隔时间(1~60分钟)', 'description' => '重呼间隔时间。取值范围:**1~60**,单位:分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '60', 'minimum' => '1', 'example' => '1', ], ], 'required' => false, ], ], [ 'name' => 'ForecastCallRate', 'in' => 'query', 'schema' => [ 'title' => '预测式外呼固定外呼比例(>=1)', 'description' => '预测式外呼固定外呼比例。取值范围:**≥1**。', 'type' => 'number', 'format' => 'float', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '1.5', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'title' => '任务id', 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', ], 'Code' => [ 'description' => '请求状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 123456,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n OK\\n OK\\n true\\n 123456\\n","errorExample":""}]', 'title' => '创建智能外呼任务', 'description' => '- 此接口返回参数中的**Data**即是任务ID。'."\n" .'- 创建智能外呼任务后,若有更新需要,您可以调用[UpdateAiOutboundTask](~~2718021~~)接口更新外呼任务。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:20次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'CreateAiOutboundTaskBatch' => [ 'summary' => '根据实例ID、任务ID创建智能外呼任务的任务批次,使得任务下的数据可以按批次查询。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_***', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务id', 'description' => '任务ID。'."\n" ."\n" .'可调用[CreateAiOutboundTask](~~312260~~)接口,查看返回参数中的**Data**,或者调用[GetAiOutboundTaskList](~~2718026~~)接口,查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'title' => '新建的任务批次版本id', 'description' => '新建的任务批次版本ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '123456', ], 'Code' => [ 'description' => '请求状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '调用接口是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 123456,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n OK\\n OK\\n true\\n 123456\\n","errorExample":""}]', 'title' => '创建智能外呼任务的任务批次', 'description' => '调用前,建议您确认实例ID、任务ID,请参见[请求参数](#api-detail-35)描述中的指引获取。'."\n" ."\n\n" .'### QPS限制'."\n" .'- 单用户调用频率:20次/秒。'."\n" .'- API频率:20次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'DeleteAiOutboundTask' => [ 'summary' => '根据实例ID、任务ID删除智能外呼任务。删除后,获取外呼任务列表时无法获取到该任务。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例id', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_***', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务id', 'description' => '任务ID。'."\n" ."\n" .'可调用[CreateAiOutboundTask](~~312260~~)接口,查看返回参数中的**Data**,或者调用[GetAiOutboundTaskList](~~2718026~~)接口,查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Code' => [ 'description' => '请求状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n OK\\n OK\\n true\\n","errorExample":""}]', 'title' => '删除智能外呼任务', 'description' => '>删除为敏感操作,请谨慎操作。>'."\n" ."\n" .'- 删除前,建议您确认需删除的任务ID及信息,您可以调用[GetAiOutboundTaskList](~~2718026~~)接口查看外呼任务列表,确认任务名称、描述及对应的任务ID。'."\n" .'- 若需重新创建智能外呼任务,您可以调用[CreateAiOutboundTask](~~312260~~)接口。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:20次/秒。'."\n" .'- API频率:20次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetAiOutboundTaskBizData' => [ 'summary' => '根据实例ID、会话ID查询本次呼叫关联的业务信息。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_***', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'title' => '入呼channelId', 'description' => '会话ID。', 'type' => 'string', 'required' => true, 'example' => '123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'title' => '本次呼叫关联的业务信息', 'description' => '本次呼叫关联的业务信息。', 'type' => 'object', 'properties' => [ 'BizData' => [ 'title' => '业务自定义信息', 'description' => '业务自定义信息。', 'type' => 'string', 'example' => '{"customer":123}', ], 'TaskId' => [ 'title' => '任务ID', 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', ], 'PhoneNum' => [ 'title' => '外呼号码', 'description' => '外呼号码。', 'type' => 'string', 'example' => '158****0000', ], 'CaseId' => [ 'title' => 'id', 'description' => '本次外呼关联的活动ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], ], ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"BizData\\": \\"{\\\\\\"customer\\\\\\":123}\\",\\n \\"TaskId\\": 123456,\\n \\"PhoneNum\\": \\"158****0000\\",\\n \\"CaseId\\": 123\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n OK\\n OK\\n true\\n \\n 123\\n 158****0000\\n {\\"customer\\":123}\\n 123456\\n \\n","errorExample":""}]', 'title' => '查询本次呼叫关联的业务信息', 'description' => '### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetAiOutboundTaskExecDetail' => [ 'summary' => '根据实例ID、任务ID获取任务执行详情。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。'."\n", 'type' => 'string', 'required' => true, 'example' => 'agent_***', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务id', 'description' => '任务ID。'."\n" ."\n" .'可调用[CreateAiOutboundTask](~~312260~~)接口,查看返回参数中的**Data**,或者调用[GetAiOutboundTaskList](~~2718026~~)接口,查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', ], ], [ 'name' => 'BatchVersion', 'in' => 'query', 'schema' => [ 'title' => '任务批次', 'description' => '任务批次。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PhoneNum', 'in' => 'query', 'schema' => [ 'title' => '手机号', 'description' => '外呼号码。', 'type' => 'string', 'required' => false, 'example' => '150****000', ], ], [ 'name' => 'CaseStatus', 'in' => 'query', 'schema' => [ 'title' => '单条号码任务执行状态(1:待呼叫,2:呼叫中,3:已完成,4:已终止,5:待重呼)', 'description' => '单条号码任务执行状态。取值:'."\n" ."\n" .'- **1**:待呼叫。'."\n" .'- **2**:呼叫中。'."\n" .'- **3**:已完成。'."\n" .'- **4**:已终止。'."\n" .'- **5**:待重呼。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'CreateTimeStart', 'in' => 'query', 'schema' => [ 'title' => '号码导入起始时间戳(毫秒)', 'description' => '号码导入起始时间。时间戳格式,单位戳:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1632289999000', ], ], [ 'name' => 'CreateTimeEnd', 'in' => 'query', 'schema' => [ 'title' => '号码导入结束时间戳(毫秒)', 'description' => '号码导入结束时间。时间戳格式,单位戳:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1632290119000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '分页大小(<=50)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页数', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'CaseId', 'in' => 'query', 'schema' => [ 'title' => '单条外呼id', 'description' => '本次外呼关联的活动ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'title' => '任务执行列表', 'description' => '任务执行列表。', 'type' => 'object', 'properties' => [ 'PageSize' => [ 'title' => '分页大小', 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'CurrentPage' => [ 'title' => '当前页数', 'description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalResults' => [ 'title' => '总数', 'description' => '任务总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '199', ], 'List' => [ 'title' => '外呼号码执行列表', 'description' => '外呼号码执行列表。', 'type' => 'array', 'items' => [ 'description' => '外呼号码详情。', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '执行状态(1:待呼叫,2:呼叫中,3:已完成,4:已终止,5:待重呼)', 'description' => '执行状态。取值:'."\n" ."\n" .'- **1**:待呼叫。'."\n" .'- **2**:呼叫中。'."\n" .'- **3**:已完成。'."\n" .'- **4**:已终止。'."\n" .'- **5**:待重呼。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'StatusDesc' => [ 'title' => '执行状态描述', 'description' => '执行状态描述。', 'type' => 'integer', 'format' => 'int32', 'example' => '待呼叫', ], 'BizData' => [ 'title' => '业务自定义信息', 'description' => '业务自定义信息', 'type' => 'string', 'example' => '123', ], 'BatchVersion' => [ 'title' => '任务批次', 'description' => '任务批次。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PhoneNum' => [ 'title' => '手机号', 'description' => '外呼号码。', 'type' => 'string', 'example' => '150****0000', ], 'LastCallResult' => [ 'title' => '最后一次外呼结果', 'description' => '最后一次外呼结果。', 'type' => 'string', 'example' => '未接通', ], 'CreateTime' => [ 'title' => '号码导入时间戳(毫秒)', 'description' => '号码导入时间。时间戳格式,单位戳:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1632289999000', ], 'CaseId' => [ 'title' => 'id', 'description' => '本次外呼关联的活动ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', ], 'CallCount' => [ 'title' => '外呼次数', 'description' => '外呼次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'HasNextPage' => [ 'title' => '是否有下一页', 'description' => '是否有下一页。', 'type' => 'boolean', 'example' => 'true', ], ], ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口是否调用成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalResults\\": 199,\\n \\"List\\": [\\n {\\n \\"Status\\": 1,\\n \\"StatusDesc\\": 0,\\n \\"BizData\\": \\"123\\",\\n \\"BatchVersion\\": 1,\\n \\"PhoneNum\\": \\"150****0000\\",\\n \\"LastCallResult\\": \\"未接通\\",\\n \\"CreateTime\\": 1632289999000,\\n \\"CaseId\\": 123456,\\n \\"CallCount\\": 1\\n }\\n ],\\n \\"HasNextPage\\": true\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n OK\\n OK\\n true\\n \\n 10\\n true\\n 199\\n 1\\n \\n 123456\\n 1\\n 123\\n 150****0000\\n 1\\n 1\\n 未接通\\n 1632289999000\\n \\n \\n","errorExample":""}]', 'title' => '获取任务执行详情', 'description' => '任务执行详情包含任务总数、任务批次、外呼号码及对应的外呼次数、执行状态等信息。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetAiOutboundTaskDetail' => [ 'summary' => '根据实例ID、任务ID获取外呼任务详情。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。'."\n", 'type' => 'string', 'required' => true, 'example' => 'agent_***', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务id', 'description' => '任务ID。'."\n" ."\n" .'可调用[CreateAiOutboundTask](~~312260~~)接口,查看返回参数中的**Data**,或者调用[GetAiOutboundTaskList](~~2718026~~)接口,查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'title' => '任务详情', 'description' => '外呼任务详情。', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '任务状态(0:未开始,1:进行中,2:系统暂停,3:手动暂停,4:已完成,5:已终止)', 'description' => '任务状态。取值:'."\n" ."\n" .'- **0**:未开始。'."\n" .'- **1**:进行中。'."\n" .'- **2**:系统暂停。'."\n" .'- **3**:手动暂停。'."\n" .'- **4**:已完成。'."\n" .'- **5**:已终止。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'HandlerId' => [ 'title' => '技能组id(预测式外呼)或者ivr id(自动外呼)', 'description' => '技能组ID(预测式外呼)或IVR ID(自动外呼)。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', ], 'TaskId' => [ 'title' => '任务id', 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'Description' => [ 'title' => '任务描述', 'description' => '任务描述。', 'type' => 'string', 'example' => '房产销售', ], 'Name' => [ 'title' => '任务名', 'description' => '任务名称。', 'type' => 'string', 'example' => 'xxxxx外呼', ], 'StatusDesc' => [ 'title' => '任务状态描述', 'description' => '任务状态描述。', 'type' => 'string', 'example' => '未开始', ], 'ExecutionTime' => [ 'title' => '任务执行时间', 'description' => '任务执行时间。', 'type' => 'string', 'example' => '{"TUESDAY":[{"start":"06:00","end":"06:05"}],"MONDAY":[{"start":"09:00","end":"18:00"},{"start":"20:30","end":"21:45"},{"start":"22:30","end":"22:50"}],"WEDNESDAY":[{"start":"09:00","end":"18:00"}],"THURSDAY":[{"start":"09:00","end":"18:00"}],"FRIDAY":[{"start":"09:00","end":"18:00"}],"SATURDAY":[{"start":"09:00","end":"18:00"}],"SUNDAY":[{"start":"17:00","end":"23:45"}]}', ], 'Type' => [ 'title' => '任务类型(2:预测式外呼,3:自动外呼)', 'description' => '任务类型。取值:'."\n" ."\n" .'- **2**:预测式外呼。'."\n" .'- **3**:自动外呼。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ConcurrentRate' => [ 'title' => '自动外呼的并发', 'description' => '自动外呼的并发。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'NumRepeated' => [ 'title' => '被叫号码重复策略(0去重,1不去重)', 'description' => '被叫号码重复策略。'."\n" ."\n" .'- **0**:去重。'."\n" .'- **1**:不去重。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'OutboundNums' => [ 'title' => '外呼主叫号码', 'description' => '外呼主叫号码。', 'type' => 'array', 'items' => [ 'description' => '外呼主叫号码。', 'type' => 'string', 'example' => '150****0000', ], ], 'RecallRule' => [ 'title' => '失败重呼策略', 'description' => '失败重呼策略。', 'type' => 'object', 'properties' => [ 'Count' => [ 'title' => '重呼次数', 'description' => '重呼次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Interval' => [ 'title' => '重呼间隔时间(分钟)', 'description' => '重呼间隔时间。单位:分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], 'HandlerName' => [ 'title' => '技能组名称或ivr名称', 'description' => '技能组名称或IVR名称。', 'type' => 'string', 'example' => '热线技能组', ], 'ForecastCallRate' => [ 'title' => '预测式外呼固定外呼比例', 'description' => '预测式外呼固定外呼比例。', 'type' => 'number', 'format' => 'float', 'example' => '1.2', ], ], ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口是否调用成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Status\\": 1,\\n \\"HandlerId\\": 123456,\\n \\"TaskId\\": 123,\\n \\"Description\\": \\"房产销售\\",\\n \\"Name\\": \\"xxxxx外呼\\",\\n \\"StatusDesc\\": \\"未开始\\",\\n \\"ExecutionTime\\": \\"{\\\\\\"TUESDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"06:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"06:05\\\\\\"}],\\\\\\"MONDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"},{\\\\\\"start\\\\\\":\\\\\\"20:30\\\\\\",\\\\\\"end\\\\\\":\\\\\\"21:45\\\\\\"},{\\\\\\"start\\\\\\":\\\\\\"22:30\\\\\\",\\\\\\"end\\\\\\":\\\\\\"22:50\\\\\\"}],\\\\\\"WEDNESDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"}],\\\\\\"THURSDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"}],\\\\\\"FRIDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"}],\\\\\\"SATURDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"}],\\\\\\"SUNDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"17:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"23:45\\\\\\"}]}\\",\\n \\"Type\\": 2,\\n \\"ConcurrentRate\\": 10,\\n \\"NumRepeated\\": 0,\\n \\"OutboundNums\\": [\\n \\"150****0000\\"\\n ],\\n \\"RecallRule\\": {\\n \\"Count\\": 2,\\n \\"Interval\\": 2\\n },\\n \\"HandlerName\\": \\"热线技能组\\",\\n \\"ForecastCallRate\\": 1.2\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n OK\\n OK\\n true\\n \\n 123\\n 1\\n 未开始\\n 2\\n xxxxx外呼\\n 房产销售\\n 150****0000\\n 0\\n 123456\\n 热线技能组\\n {\\"TUESDAY\\":[{\\"start\\":\\"06:00\\",\\"end\\":\\"06:05\\"}],\\"MONDAY\\":[{\\"start\\":\\"09:00\\",\\"end\\":\\"18:00\\"},{\\"start\\":\\"20:30\\",\\"end\\":\\"21:45\\"},{\\"start\\":\\"22:30\\",\\"end\\":\\"22:50\\"}],\\"WEDNESDAY\\":[{\\"start\\":\\"09:00\\",\\"end\\":\\"18:00\\"}],\\"THURSDAY\\":[{\\"start\\":\\"09:00\\",\\"end\\":\\"18:00\\"}],\\"FRIDAY\\":[{\\"start\\":\\"09:00\\",\\"end\\":\\"18:00\\"}],\\"SATURDAY\\":[{\\"start\\":\\"09:00\\",\\"end\\":\\"18:00\\"}],\\"SUNDAY\\":[{\\"start\\":\\"17:00\\",\\"end\\":\\"23:45\\"}]}\\n 10\\n \\n 2\\n 2\\n \\n 1.2\\n \\n","errorExample":""}]', 'title' => '获取外呼任务详情', 'description' => '外呼任务详情包含任务ID、任务状态、任务类型、外呼主叫号码、被叫号码重复策略等信息,具体参见[返回参数](#api-detail-40)。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'UpdateAiOutboundTask' => [ 'summary' => '根据实例ID、任务ID更新外呼任务。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。'."\n", 'type' => 'string', 'required' => true, 'example' => 'agent_***', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务id', 'description' => '任务ID。'."\n" ."\n" .'可调用[CreateAiOutboundTask](~~312260~~)接口,查看返回参数中的**Data**,或者调用[GetAiOutboundTaskList](~~2718026~~)接口,查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'title' => '任务名(1~15字符)', 'description' => '任务名称。1~15字符。', 'type' => 'string', 'required' => true, 'example' => 'xxxx外呼', 'maxLength' => 15, 'minLength' => 1, ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'title' => '任务描述(0~100字符)', 'description' => '任务描述。0~100字符。', 'type' => 'string', 'required' => false, 'example' => '房产销售', 'maxLength' => 100, ], ], [ 'name' => 'OutboundNums', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '外呼主叫号码', 'description' => '外呼主叫号码。', 'type' => 'array', 'items' => [ 'description' => '外呼主叫号码。', 'type' => 'string', 'required' => true, 'example' => '150****0000', ], 'required' => true, ], ], [ 'name' => 'NumRepeated', 'in' => 'query', 'schema' => [ 'title' => '被叫号码重复策略(0:任务内去重,1:任务内不去重)', 'description' => '被叫号码重复策略。'."\n" .'- **0**:任务内去重。'."\n" .'- **1**:任务内不去重。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'enum' => [ '0', '1', ], ], ], [ 'name' => 'HandlerId', 'in' => 'query', 'schema' => [ 'title' => '技能组id(预测式外呼)或者ivr id(自动外呼)', 'description' => '技能组ID(预测式外呼)或者IVR ID(自动外呼)。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], [ 'name' => 'ExecutionTime', 'in' => 'query', 'schema' => [ 'title' => '任务执行时间', 'description' => '任务执行时间。'."\n" ."\n" .'> 结束时间(end)需晚于开始时间(start)。', 'type' => 'string', 'required' => true, 'example' => '{"TUESDAY":[{"start":"06:00","end":"06:05"}],"MONDAY":[{"start":"09:00","end":"18:00"},{"start":"20:30","end":"21:45"},{"start":"22:30","end":"22:50"}],"WEDNESDAY":[{"start":"09:00","end":"18:00"}],"THURSDAY":[{"start":"09:00","end":"18:00"}],"FRIDAY":[{"start":"09:00","end":"18:00"}],"SATURDAY":[{"start":"09:00","end":"18:00"}],"SUNDAY":[{"start":"17:00","end":"23:45"}]}', ], ], [ 'name' => 'ConcurrentRate', 'in' => 'query', 'schema' => [ 'title' => '自动外呼的并发', 'description' => '自动外呼的并发。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'RecallRule', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '失败重呼策略', 'description' => '失败重呼策略。'."\n" ."\n" .'> 为空则外呼失败时不重呼。', 'type' => 'object', 'properties' => [ 'Count' => [ 'title' => '失败重呼次数(1~3次)', 'description' => '失败重呼次数。取值范围:**1~3**次。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3', 'minimum' => '1', 'example' => '2', ], 'Interval' => [ 'title' => '失败重呼间隔时间(1~60分钟)', 'description' => '失败重呼间隔时间。取值范围:**1~60**,单位:分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '60', 'minimum' => '1', 'example' => '5', ], ], 'required' => false, ], ], [ 'name' => 'ForecastCallRate', 'in' => 'query', 'schema' => [ 'title' => '预测式外呼固定外呼比例(>=1)', 'description' => '预测式外呼固定外呼比例。取值范围:**≥1**。', 'type' => 'number', 'format' => 'float', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '1.2', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'ok', ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'ok', ], 'Success' => [ 'description' => '调用接口是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"ok\\",\\n \\"Code\\": \\"ok\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n ok\\n ok\\n true\\n","errorExample":""}]', 'title' => '更新外呼任务', 'description' => '此接口支持更新任务名称、任务描述、外呼主叫号码、技能组ID等信息,具体参见[请求参数](#api-detail-35)。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:20次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'InsertAiOutboundPhoneNums' => [ 'summary' => '根据实例ID、任务ID导入外呼被叫号码。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。'."\n", 'type' => 'string', 'required' => true, 'example' => 'agent_***', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务id', 'description' => '任务ID。'."\n" ."\n" .'可调用[CreateAiOutboundTask](~~312260~~)接口,查看返回参数中的**Data**,或者调用[GetAiOutboundTaskList](~~2718026~~)接口,查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', ], ], [ 'name' => 'BatchVersion', 'in' => 'query', 'schema' => [ 'title' => '任务批次号(不填则导入到默认批次)', 'description' => '任务批次号。'."\n" ."\n" .'> 不填则导入到默认批次。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], ], [ 'name' => 'Details', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '号码详情(至多30条)', 'description' => '号码详情。'."\n" .'> 最多30条。', 'type' => 'array', 'items' => [ 'description' => '号码详情。', 'type' => 'object', 'properties' => [ 'BizData' => [ 'title' => '自定义信息', 'description' => '业务自定义信息。', 'type' => 'string', 'required' => false, 'example' => 'xxxx', ], 'PhoneNum' => [ 'title' => '手机号', 'description' => '外呼被叫号码。', 'type' => 'string', 'required' => false, 'example' => '150****0000', ], ], 'required' => false, ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'title' => '导入结果', 'description' => '导入结果。', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '导入总数', 'description' => '导入总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'SuccessCount' => [ 'title' => '导入成功数量', 'description' => '导入成功数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'FailInfo' => [ 'title' => '失败号码详情', 'description' => '失败号码详情。', 'type' => 'array', 'items' => [ 'description' => '失败号码详情。', 'type' => 'object', 'properties' => [ 'Msg' => [ 'title' => '失败原因描述', 'description' => '失败原因描述。', 'type' => 'string', 'example' => '号码格式异常', ], 'BizData' => [ 'title' => '自定义信息', 'description' => '业务自定义信息。', 'type' => 'string', 'example' => 'xxxx', ], 'PhoneNum' => [ 'title' => '外呼被叫号码', 'description' => '外呼被叫号码。', 'type' => 'string', 'example' => '150****0000', ], ], ], ], ], ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口是否调用成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"SuccessCount\\": 7,\\n \\"FailInfo\\": [\\n {\\n \\"Msg\\": \\"号码格式异常\\",\\n \\"BizData\\": \\"xxxx\\",\\n \\"PhoneNum\\": \\"150****0000\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n OK\\n true\\n \\n 10\\n 7\\n \\n xxxx\\n 150****0000\\n 号码格式异常\\n \\n \\n","errorExample":""}]', 'title' => '导入外呼被叫号码', 'description' => '- 导入外呼被叫号码后,外呼任务才可以正常外呼。'."\n" .'- 调用此接口前,建议您确认实例ID、任务ID信息,具体请参见[请求参数](#api-detail-35)。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:20次/秒。'."\n" .'- API频率:50次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetAiOutboundTaskProgress' => [ 'summary' => '根据实例ID、任务ID获取外呼任务进展。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_***', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务id', 'description' => '任务ID。'."\n" ."\n" .'可调用[CreateAiOutboundTask](~~312260~~)接口,查看返回参数中的**Data**,或者调用[GetAiOutboundTaskList](~~2718026~~)接口,查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', ], ], [ 'name' => 'BatchVersion', 'in' => 'query', 'schema' => [ 'title' => '任务批次(为空则查询任务下所有数据)', 'description' => '任务批次。'."\n" ."\n" .'> 为空则查询任务下所有数据。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'ok', ], 'Data' => [ 'title' => '任务进展', 'description' => '任务进展。', 'type' => 'object', 'properties' => [ 'Type' => [ 'title' => '任务类型(2:预测式3:自动)', 'description' => '任务类型。取值:'."\n" .'- **2**:预测式。'."\n" .'- **3**:自动。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'TaskId' => [ 'title' => '任务id', 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', ], 'CalloutProgress' => [ 'title' => '外呼维度进展', 'description' => '外呼维度进展。', 'type' => 'object', 'properties' => [ 'CallOutCount' => [ 'title' => '外呼次数', 'description' => '外呼次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'CallOutConnectCount' => [ 'title' => '外呼接通次数(自动外呼特有)', 'description' => '外呼接通次数。'."\n" .'> 自动外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'CallOutUserPickupCount' => [ 'title' => '客户接起量(预测式外呼特有)', 'description' => '客户接起量。'."\n" .'> 预测式外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'CallOutUserPickupRate' => [ 'title' => '客户接起率(预测式外呼特有)', 'description' => '客户接起率。'."\n" .'> 预测式外呼特有参数。', 'type' => 'number', 'format' => 'float', 'example' => '0.5', ], 'CallLossRate' => [ 'title' => '呼损率(预测式外呼特有)', 'description' => '呼损率。'."\n" .'> 预测式外呼特有参数。', 'type' => 'number', 'format' => 'float', 'example' => '0.01', ], 'CallOutConnectRate' => [ 'title' => '外呼接通次率(自动外呼特有)', 'description' => '外呼接通次率。'."\n" .'> 自动外呼特有参数。', 'type' => 'number', 'format' => 'float', 'example' => '0.5', ], 'CallOutServicerPickupCount' => [ 'title' => '坐席接通量(预测式外呼特有)', 'description' => '坐席接通量。'."\n" .'> 预测式外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'CallLossCount' => [ 'title' => '呼损量(预测式外呼特有)', 'description' => '呼损量。'."\n" .'> 预测式外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CallOutServicerPickupRate' => [ 'title' => '坐席接通率(预测式外呼特有)', 'description' => '坐席接通率。'."\n" .'> 预测式外呼特有参数。', 'type' => 'number', 'format' => 'float', 'example' => '0.4', ], ], ], 'TaskProgress' => [ 'title' => '任务维度进展', 'description' => '任务维度进展。', 'type' => 'object', 'properties' => [ 'FinishRate' => [ 'title' => '任务完成率', 'description' => '任务完成率。', 'type' => 'number', 'format' => 'float', 'example' => '0.20', ], 'ConnectRate' => [ 'title' => '任务接通率(自动外呼特有)', 'description' => '任务接通率。'."\n" .'> 自动外呼特有参数。', 'type' => 'number', 'format' => 'float', 'example' => '0.2', ], 'WaitingCallCount' => [ 'title' => '待呼叫任务数', 'description' => '待呼叫任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'FinishCount' => [ 'title' => '任务完成数', 'description' => '任务完成数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ConnectCount' => [ 'title' => '任务接通量(自动外呼特有)', 'description' => '任务接通量。'."\n" ."\n" .'> 自动外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'TotalCount' => [ 'title' => '总任务数', 'description' => '总任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'WaitingRecallCount' => [ 'title' => '待重呼任务数', 'description' => '待重呼任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'TerminateCount' => [ 'title' => '已终止任务数', 'description' => '已终止任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ServicerPickupCount' => [ 'title' => '坐席接通数(预测式外呼特有)', 'description' => '坐席接通数。'."\n" ."\n" .'> 预测式外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'UserPickupCount' => [ 'title' => '客户接起数(预测式外呼特有)', 'description' => '客户接起数。'."\n" ."\n" .'> 预测式外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'CallingCount' => [ 'title' => '呼叫中任务数', 'description' => '呼叫中任务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ServicerPickupRate' => [ 'title' => '坐席接通率(预测式外呼特有)', 'description' => '坐席接通率。'."\n" ."\n" .'> 预测式外呼特有参数。', 'type' => 'number', 'format' => 'float', 'example' => '0.2', ], 'UserPickupRate' => [ 'title' => '客户接起率(预测式外呼特有)', 'description' => '客户接起率。'."\n" .'> 预测式外呼特有参数。', 'type' => 'number', 'format' => 'float', 'example' => '0.2', ], ], ], ], ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'ok', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"Type\\": 2,\\n \\"TaskId\\": 123456,\\n \\"CalloutProgress\\": {\\n \\"CallOutCount\\": 10,\\n \\"CallOutConnectCount\\": 5,\\n \\"CallOutUserPickupCount\\": 5,\\n \\"CallOutUserPickupRate\\": 0.5,\\n \\"CallLossRate\\": 0.01,\\n \\"CallOutConnectRate\\": 0.5,\\n \\"CallOutServicerPickupCount\\": 4,\\n \\"CallLossCount\\": 1,\\n \\"CallOutServicerPickupRate\\": 0.4\\n },\\n \\"TaskProgress\\": {\\n \\"FinishRate\\": 0.2,\\n \\"ConnectRate\\": 0.2,\\n \\"WaitingCallCount\\": 2,\\n \\"FinishCount\\": 2,\\n \\"ConnectCount\\": 2,\\n \\"TotalCount\\": 10,\\n \\"WaitingRecallCount\\": 2,\\n \\"TerminateCount\\": 2,\\n \\"ServicerPickupCount\\": 2,\\n \\"UserPickupCount\\": 2,\\n \\"CallingCount\\": 2,\\n \\"ServicerPickupRate\\": 0.2,\\n \\"UserPickupRate\\": 0.2\\n }\\n },\\n \\"Code\\": \\"ok\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\n ok\\n ok\\n true\\n \\n 123456\\n 2\\n \\n 10\\n 2\\n 2\\n 2\\n 2\\n 2\\n 0.2\\n 2\\n 2\\n 0.2\\n 0.2\\n 2\\n 0.2\\n \\n \\n 10\\n 5\\n 0.5\\n 1\\n 0.01\\n 4\\n 5\\n 0.4\\n 0.5\\n \\n \\n","errorExample":""}]', 'title' => '获取外呼任务进展', 'description' => '- 调用此接口前,建议您确认实例ID、任务ID信息,具体请参见[请求参数](#api-detail-35)。'."\n" .'- 外呼任务进展包括任务ID、任务类型、任务完成率、坐席接通率、客户接通率等信息,具体参见[返回参数](#api-detail-40)。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'StopAiOutboundTask' => [ 'summary' => '根据实例ID、任务ID暂停外呼任务。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_***', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务id', 'description' => '任务ID。'."\n" ."\n" .'可调用[CreateAiOutboundTask](~~312260~~)接口,查看返回参数中的**Data**,或者调用[GetAiOutboundTaskList](~~2718026~~)接口,查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n OK\\n OK\\n true\\n","errorExample":""}]', 'title' => '暂停外呼任务', 'description' => '暂停外呼任务后,若需要重新启动外呼任务,可调用[StartAiOutboundTask](~~2718027~~)接口。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:20次/秒。'."\n" .'- API频率:20次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'TerminateAiOutboundTask' => [ 'summary' => '根据实例ID、任务ID终止外呼任务。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例id', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_****', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务id', 'description' => '任务ID。'."\n" ."\n" .'可调用[CreateAiOutboundTask](~~312260~~)接口,查看返回参数中的**Data**,或者调用[GetAiOutboundTaskList](~~2718026~~)接口,查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1763****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n OK\\n OK\\n true\\n","errorExample":""}]', 'title' => '终止外呼任务', 'description' => '- 此接口支持终止外呼任务,终止后,任务无法重新启动。'."\n" .'- 若需要暂时停止外呼任务,可调用[StopAiOutboundTask](~~2718024~~)接口。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:20次/秒。'."\n" .'- API频率:20次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetAiOutboundTaskList' => [ 'summary' => '根据实例ID、任务类型获取外呼任务列表。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_****', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'title' => '任务类型(2:预测式外呼,3:自动外呼)', 'description' => '任务类型。取值:'."\n" ."\n" .'- **2**:预测式外呼。'."\n" .'- **3**:自动外呼。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', ], ], [ 'name' => 'CreateTimeStart', 'in' => 'query', 'schema' => [ 'title' => '任务创建起始时间戳(毫秒)', 'description' => '任务创建起始时间。时间戳格式,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000', ], ], [ 'name' => 'CreateTimeEnd', 'in' => 'query', 'schema' => [ 'title' => '任务创建截止时间戳(毫秒)', 'description' => '任务创建截止时间。时间戳格式,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'title' => '任务状态(0:未开始,1:进行中,2:系统暂停,3:手动暂停,4:已完成,5:已终止)', 'description' => '任务状态。取值:'."\n" ."\n" .'- **0**:未开始。'."\n" .'- **1**:进行中。'."\n" .'- **2**:系统暂停。'."\n" .'- **3**:手动暂停。'."\n" .'- **4**:已完成。'."\n" .'- **5**:已终止。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '分页大小(<=50)', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '查询第几页', 'description' => '查询第几页。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'SearchKey', 'in' => 'query', 'schema' => [ 'title' => '过滤条件:匹配任务ID或者模糊匹配任务名', 'description' => '过滤条件。'."\n" ."\n" .'> 匹配任务ID或模糊匹配任务名称。', 'type' => 'string', 'required' => false, 'example' => '1763****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求id', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'title' => '任务列表', 'description' => '任务列表。', 'type' => 'object', 'properties' => [ 'PageSize' => [ 'title' => '分页大小', 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'CurrentPage' => [ 'title' => '当前页数', 'description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalResults' => [ 'title' => '数据总量', 'description' => '数据总量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'List' => [ 'title' => '任务信息', 'description' => '任务信息。', 'type' => 'array', 'items' => [ 'description' => '任务信息。', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '任务状态(0:未开始,1:进行中,2:系统暂停,3:手动暂停,4:已完成,5:已终止)', 'description' => '任务状态。取值:'."\n" ."\n" .'- **0**:未开始。'."\n" .'- **1**:进行中。'."\n" .'- **2**:系统暂停。'."\n" .'- **3**:手动暂停。'."\n" .'- **4**:已完成。'."\n" .'- **5**:已终止。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'FinishRate' => [ 'title' => '任务完成率', 'description' => '任务完成率。', 'type' => 'number', 'format' => 'float', 'example' => '0.7', ], 'StatusDesc' => [ 'title' => '任务状态描述', 'description' => '任务状态描述。', 'type' => 'string', 'example' => '未开始', ], 'HandlerId' => [ 'title' => '技能组id(预测式)或者ivr id(自动外呼)', 'description' => '技能组ID(预测式)或者IVR ID(自动外呼)。', 'type' => 'integer', 'format' => 'int64', 'example' => '2468****', ], 'ConcurrentRate' => [ 'title' => '自动外呼的并发', 'description' => '外呼并发。'."\n" ."\n" .'> 自动外呼特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalCount' => [ 'title' => '任务总量', 'description' => '任务总量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'TaskId' => [ 'title' => '任务id', 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1763****', ], 'Description' => [ 'title' => '任务描述', 'description' => '任务描述。', 'type' => 'string', 'example' => '房产销售', ], 'CreateTime' => [ 'title' => '任务创建时间毫秒时间戳', 'description' => '任务创建截止时间。时间戳格式,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1615083365000', ], 'FinishCount' => [ 'title' => '任务已完成量', 'description' => '任务已完成量。', 'type' => 'integer', 'format' => 'int32', 'example' => '70', ], 'HandlerName' => [ 'title' => '技能组名称或ivr名称', 'description' => '技能组名称或IVR名称。', 'type' => 'string', 'example' => '热线技能组', ], 'Name' => [ 'title' => '任务名称', 'description' => '任务名称。', 'type' => 'string', 'example' => 'xxxx外呼任务', ], ], ], ], 'HasNextPage' => [ 'title' => '是否有下一页', 'description' => '是否有下一页。取值:'."\n" ."\n" .'- **true**:是。'."\n" .'- **false**:否。'."\n", 'type' => 'boolean', 'example' => 'false', ], ], ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalResults\\": 10,\\n \\"List\\": [\\n {\\n \\"Status\\": 0,\\n \\"FinishRate\\": 0.7,\\n \\"StatusDesc\\": \\"未开始\\",\\n \\"HandlerId\\": 0,\\n \\"ConcurrentRate\\": 1,\\n \\"TotalCount\\": 100,\\n \\"TaskId\\": 0,\\n \\"Description\\": \\"房产销售\\",\\n \\"CreateTime\\": 1615083365000,\\n \\"FinishCount\\": 70,\\n \\"HandlerName\\": \\"热线技能组\\",\\n \\"Name\\": \\"xxxx外呼任务\\"\\n }\\n ],\\n \\"HasNextPage\\": false\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n OK\\n OK\\n true\\n \\n 10\\n false\\n 10\\n 1\\n \\n 0\\n 未开始\\n xxxx外呼任务\\n 房产销售\\n 热线技能组\\n 1\\n 100\\n 70\\n 0.7\\n 1615083365000\\n \\n \\n","errorExample":""}]', 'title' => '获取外呼任务列表', 'description' => '- 任务列表为任务信息列表,任务信息包含任务ID、任务状态、任务名称、任务完成率等信息,具体参见[返回参数](#api-detail-40)。'."\n" .'- 若您需要更新任务信息,可调用[UpdateAiOutboundTask](~~2718021~~)接口。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'StartAiOutboundTask' => [ 'summary' => '根据实例ID、任务ID启动外呼任务。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_****', ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'title' => '任务id', 'description' => '任务ID。'."\n" ."\n" .'可调用[CreateAiOutboundTask](~~312260~~)接口,查看返回参数中的**Data**,或者调用[GetAiOutboundTaskList](~~2718026~~)接口,查看返回参数中的**TaskId**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1763****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'OK', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n OK\\n OK\\n true\\n","errorExample":""}]', 'title' => '启动外呼任务', 'description' => '- 调用此接口,可启动暂停状态的外呼任务。'."\n" .'- 终止状态的外呼任务无法再次被启动。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:20次/秒。'."\n" .'- API频率:20次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'AddHotlineNumber' => [ 'summary' => '调用AddHotlineNumber接口新增热线号码。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'title' => '实例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'HotlineNumber', 'in' => 'formData', 'schema' => [ 'title' => '号码', 'description' => '热线号码。', 'type' => 'string', 'required' => true, 'example' => '05710000****', 'pattern' => '^\\d+$', ], ], [ 'name' => 'Description', 'in' => 'formData', 'schema' => [ 'title' => '号码描述', 'description' => '号码描述。', 'type' => 'string', 'required' => true, 'example' => '热线号码', ], ], [ 'name' => 'EnableInbound', 'in' => 'formData', 'schema' => [ 'title' => '是否用于入呼', 'description' => '是否用于入呼。', 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], [ 'name' => 'InboundFlowId', 'in' => 'formData', 'schema' => [ 'title' => '入呼ivr流程id', 'description' => '入呼IVR流程ID。可通过SaaS工作台热线>渠道接入>IVR流程管理页面获取。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', ], ], [ 'name' => 'EnableOutbound', 'in' => 'formData', 'schema' => [ 'title' => '是否用于外呼', 'description' => '是否用于外呼。', 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], [ 'name' => 'OutboundAllDepart', 'in' => 'formData', 'schema' => [ 'title' => '外呼是否对所有部门生效', 'description' => '外呼是否对实例下所有部门生效。', 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], [ 'name' => 'EnableInboundEvaluation', 'in' => 'formData', 'schema' => [ 'title' => '是否开启入呼满意度', 'description' => '是否开启入呼满意度。', 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], [ 'name' => 'EnableOutboundEvaluation', 'in' => 'formData', 'schema' => [ 'title' => '是否开启外呼满意度', 'description' => '是否开启外呼满意度。', 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], [ 'name' => 'EvaluationLevel', 'in' => 'formData', 'schema' => [ 'title' => '满意度等级', 'description' => '满意度等级。取值:'."\n" ."\n" .'- **2**:二级(满意,不满意)'."\n" .'- **3**:三级(满意,一般,不满意)'."\n" .'- **4**:四级(很满意,满意,一般,不满意)'."\n" .'- **5**:五级(很满意,满意,一般,不满意,非常差)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '2', '3', '4', '5', ], ], ], [ 'name' => 'OutboundRangeList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '外呼生效范围', 'description' => '外呼生效范围。', 'type' => 'array', 'items' => [ 'description' => '外呼生效范围。', 'type' => 'object', 'properties' => [ 'GroupIdList' => [ 'title' => '生效技能组列表(部门123下)', 'description' => '生效技能组列表。'."\n" .'> 技能组列表为空则对整个部门生效,否则针对部门下指定技能组列表生效。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', ], 'required' => false, ], 'DepartmentId' => [ 'title' => '生效部门id', 'description' => '生效部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE339D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'HttpStatusCode' => [ 'title' => 'http状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Code' => [ 'title' => '错误码', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'title' => '接口调用是否成功', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n EE339D98-9BD3-4413-B165\\n true\\n Success\\n OK\\n 200\\n","errorExample":""}]', 'title' => '新增热线号码', 'description' => '> 热线号码仅供呼入、呼出使用。', ], 'DeleteHotlineNumber' => [ 'summary' => '调用DeleteHotlineNumber接口删除配置的热线号码。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'title' => '实例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'HotlineNumber', 'in' => 'formData', 'schema' => [ 'title' => '号码', 'description' => '热线号码。', 'type' => 'string', 'required' => true, 'example' => '05710000****', 'pattern' => '^\\d+$', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', ], 'Message' => [ 'title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'HttpStatusCode' => [ 'title' => 'http状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Code' => [ 'title' => '错误码', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'title' => '接口调用是否成功', 'description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n 98B032F5-6473-4EAC-8BA8-C28993513A1F\\n true\\n Success\\n OK\\n 200\\n","errorExample":""}]', 'title' => '删除配置的热线号码', ], 'ResetHotlineNumber' => [ 'summary' => '调用ResetHotlineNumber接口重置热线号码的呼入(IVR流程)、呼出(生效范围)配置信息。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'title' => '实例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'HotlineNumber', 'in' => 'formData', 'schema' => [ 'title' => '号码', 'description' => '热线号码。', 'type' => 'string', 'required' => true, 'example' => '0571********', 'pattern' => '^\\d+$', ], ], [ 'name' => 'Description', 'in' => 'formData', 'schema' => [ 'title' => '号码描述', 'description' => '号码描述。', 'type' => 'string', 'required' => true, 'example' => '热线号码', ], ], [ 'name' => 'EnableInbound', 'in' => 'formData', 'schema' => [ 'title' => '是否用于入呼', 'description' => '是否用于入呼。', 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], [ 'name' => 'InboundFlowId', 'in' => 'formData', 'schema' => [ 'title' => '入呼ivr流程id', 'description' => '入呼IVR流程ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', ], ], [ 'name' => 'EnableOutbound', 'in' => 'formData', 'schema' => [ 'title' => '是否用于外呼', 'description' => '是否用于外呼。', 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], [ 'name' => 'OutboundAllDepart', 'in' => 'formData', 'schema' => [ 'title' => '外呼是否对所有部门生效', 'description' => '外呼是否对所有部门生效。', 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], [ 'name' => 'EnableInboundEvaluation', 'in' => 'formData', 'schema' => [ 'title' => '是否开启入呼满意度', 'description' => '是否开启入呼满意度。', 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], [ 'name' => 'EnableOutboundEvaluation', 'in' => 'formData', 'schema' => [ 'title' => '是否开启外呼满意度', 'description' => '是否开启外呼满意度。', 'type' => 'boolean', 'required' => true, 'example' => 'true', ], ], [ 'name' => 'EvaluationLevel', 'in' => 'formData', 'schema' => [ 'title' => '满意度等级', 'description' => '满意度等级。取值:'."\n" ."\n" .'- **2**:二级(满意,不满意)'."\n" .'- **3**:三级(满意,一般,不满意)'."\n" .'- **4**:四级(很满意,满意,一般,不满意)'."\n" .'- **5**:五级(很满意,满意,一般,不满意,非常差)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'enum' => [ '2', '3', '4', '5', ], ], ], [ 'name' => 'OutboundRangeList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '外呼生效范围', 'description' => '外呼生效范围。', 'type' => 'array', 'items' => [ 'description' => '外呼生效范围。', 'type' => 'object', 'properties' => [ 'GroupIdList' => [ 'title' => '生效技能组列表(部门123下)', 'description' => '生效技能组列表。'."\n" ."\n" .'> 技能组列表为空则对整个部门生效,否则针对部门下指定技能组列表生效。'."\n", 'type' => 'array', 'items' => [ 'description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', ], 'required' => false, ], 'DepartmentId' => [ 'title' => '生效部门id', 'description' => '生效部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxx', ], 'HttpStatusCode' => [ 'title' => 'http状态码', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Code' => [ 'title' => '错误码', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'title' => '接口调用是否成功', 'description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"xxx\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n true\\n Success\\n xxx\\n 200\\n","errorExample":""}]', 'title' => '重置热线号码', ], 'QueryHotlineNumber' => [ 'summary' => '根据实例ID查询热线号码配置列表,支持通过热线号码模糊查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例id', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页码', 'description' => '当前页。取值大于**0**,默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小', 'description' => '每页大小。取值大于**0**,默认值:**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '20', 'minimum' => '1', 'example' => '10', ], ], [ 'name' => 'HotlineNumber', 'in' => 'query', 'schema' => [ 'title' => '号码(支持模糊查询)', 'description' => '热线号码。支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => '0571****2211', ], ], [ 'name' => 'DepartmentId', 'in' => 'query', 'schema' => [ 'title' => '部门id(技能组分组)', 'description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2256****', ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '技能组列表', 'description' => '技能组列表。', 'type' => 'array', 'items' => [ 'description' => '技能组ID。结合技能组分组ID使用。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '["6083****","6084****"]', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE339D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'title' => '返回结果数据', 'description' => '热线号码配置信息。', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '数据总量', 'description' => '数据总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '123', ], 'PageSize' => [ 'title' => '每页大小', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'CurrentPage' => [ 'title' => '当前页面', 'description' => '当前页面。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'HotlineNumList' => [ 'title' => '号码列表', 'description' => '号码列表。', 'type' => 'array', 'items' => [ 'description' => '号码列表。', 'type' => 'object', 'properties' => [ 'FlowId' => [ 'title' => '入呼流程id', 'description' => '入呼流程ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12', ], 'Description' => [ 'title' => '号码描述', 'description' => '号码描述。', 'type' => 'string', 'example' => '测试', ], 'OutboundEnabled' => [ 'title' => '是否用于外呼', 'description' => '是否用于外呼。', 'type' => 'boolean', 'example' => 'true', ], 'CalloutAllDepartment' => [ 'title' => '外呼针对所有部门生效', 'description' => '外呼针对所有部门生效。', 'type' => 'boolean', 'example' => 'true', ], 'FlowName' => [ 'title' => '入呼流程名称', 'description' => '入呼流程名称。', 'type' => 'string', 'example' => '测试流程', ], 'CalloutRangeList' => [ 'title' => '外呼生效列表', 'description' => '外呼生效列表。', 'type' => 'array', 'items' => [ 'description' => '外呼生效列表。', 'type' => 'object', 'properties' => [ 'GroupDOList' => [ 'title' => '技能组列表', 'description' => '技能组列表。', 'type' => 'array', 'items' => [ 'description' => '技能组列表。', 'type' => 'object', 'properties' => [ 'GroupName' => [ 'title' => '技能组名称', 'description' => '技能组名称。', 'type' => 'string', 'example' => '技能组A', ], 'GroupId' => [ 'title' => '技能组id', 'description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '6083****', ], ], ], ], 'DepartmentName' => [ 'title' => '部门名称', 'description' => '部门名称。', 'type' => 'string', 'example' => '部门A', ], 'DepartmentId' => [ 'title' => '部门id', 'description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2256****', ], ], ], ], 'HotlineNumber' => [ 'title' => '号码', 'description' => '热线号码。', 'type' => 'string', 'example' => '0571****2211', ], 'EvaluationStatus' => [ 'title' => '满意度状态', 'description' => '满意度状态。取值:'."\n" .'- **0**:入呼外呼均不开启。'."\n" .'- **1**:入呼开启。'."\n" .'- **2**:外呼开启。'."\n" .'- **3**:入呼外呼均开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Sp' => [ 'title' => '运营商', 'description' => '运营商。', 'type' => 'string', 'example' => '电信', ], 'Location' => [ 'title' => '归属地', 'description' => '号码归属地。', 'type' => 'string', 'example' => '浙江杭州', ], 'InBoundEnabled' => [ 'title' => '是否用于入呼', 'description' => '是否用于入呼。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], ], 'Code' => [ 'title' => '错误码', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'title' => '是否成功', 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 123,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"HotlineNumList\\": [\\n {\\n \\"FlowId\\": 12,\\n \\"Description\\": \\"测试\\",\\n \\"OutboundEnabled\\": true,\\n \\"CalloutAllDepartment\\": true,\\n \\"FlowName\\": \\"测试流程\\",\\n \\"CalloutRangeList\\": [\\n {\\n \\"GroupDOList\\": [\\n {\\n \\"GroupName\\": \\"技能组A\\",\\n \\"GroupId\\": 0\\n }\\n ],\\n \\"DepartmentName\\": \\"部门A\\",\\n \\"DepartmentId\\": 0\\n }\\n ],\\n \\"HotlineNumber\\": \\"0571****2211\\",\\n \\"EvaluationStatus\\": 0,\\n \\"Sp\\": \\"电信\\",\\n \\"Location\\": \\"浙江杭州\\",\\n \\"InBoundEnabled\\": true\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE339D98-9BD3-4413-B165\\n true\\n Success\\n xxx\\n \\n 123\\n 1\\n 10\\n \\n 05710000****\\n 测试\\n 浙江杭州\\n 电信\\n true\\n 12\\n 测试流程\\n true\\n true\\n \\n 123456\\n 部门A\\n \\n 123456\\n 技能组A\\n \\n \\n 0\\n \\n \\n","errorExample":""}]', 'title' => '查询热线号码配置列表', 'description' => '热线号码配置包含热线号码、号码归属地、运营商、是否用于入呼等信息,具体参见[返回参数](#api-detail-40)。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:100次/秒。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetConfigNumList' => [ 'summary' => '调用GetConfigNumList接口获取热线设置号码列表。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'DepartmentId', 'in' => 'query', 'schema' => [ 'title' => '部门ID', 'description' => '部门ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'title' => '账号名称', 'description' => '坐席账号名称。实例内唯一(登录名)。', 'type' => 'string', 'required' => false, 'example' => '123@123.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE339D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'Data' => [ 'title' => '号码列表', 'description' => '号码列表。', 'type' => 'array', 'items' => [ 'description' => '号码列表。', 'type' => 'string', 'example' => '0:"057****890" 1:"057****506" 2:"057****507" 3:"057****417" 4:"057****090" 5:"057****888"', ], ], 'Code' => [ 'title' => '错误码', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'title' => '接口调用是否成功', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', ], [ 'errorMessage' => 'The specified department does not exist.', 'errorCode' => 'Department.NotFound', ], ], 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": [\\n \\"0:\\\\\\"057****890\\\\\\" 1:\\\\\\"057****506\\\\\\" 2:\\\\\\"057****507\\\\\\" 3:\\\\\\"057****417\\\\\\" 4:\\\\\\"057****090\\\\\\" 5:\\\\\\"057****888\\\\\\"\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n EE339D98-9BD3-4413-B165\\n true\\n Success\\n xxxx\\n 0:\\"057****890\\" 1:\\"057****506\\" 2:\\"057****507\\" 3:\\"057****417\\" 4:\\"057****090\\" 5:\\"057****888\\"\\n","errorExample":""}]', 'title' => '获取热线设置号码列表', ], 'AnswerCall' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称(坐席登录名)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', ], ], [ 'name' => 'CallId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的acid。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', ], ], [ 'name' => 'JobId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的jobId。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', ], ], [ 'name' => 'ConnectionId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的connId。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nxxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue\\n","errorExample":""}]', 'title' => '接听来电', 'summary' => '调用AnswerCall接听来电。', ], 'FinishHotlineService' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n EE338D98-9BD3-4413-B165\\n Success\\n true\\n 200\\n","errorExample":""}]', 'title' => '结束热线服务', 'summary' => '根据实例ID、坐席账号名称结束热线服务。', 'description' => '### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetNumLocation' => [ 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'PhoneNum', 'in' => 'query', 'schema' => [ 'description' => '需要查询的电话号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1360987****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '号码归属地。', 'type' => 'string', 'example' => '杭州', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"杭州\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '获取号码归属地', 'summary' => '根据实例ID、电话号码获取该号码的归属地信息。', 'description' => '### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'GetRtcToken' => [ 'summary' => '调用GetRtcToken获取移动坐席Token。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_***', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'title' => '账号名称', 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => true, 'example' => 'username@example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'Successful', ], 'Data' => [ 'title' => 'data', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'RtcId' => [ 'title' => 'rtcId', 'description' => '通过互联网域接入的终端身份标识。', 'type' => 'string', 'example' => '200000000*******', ], 'Token' => [ 'title' => 'token信息', 'description' => 'Token信息。', 'type' => 'string', 'enumValueTitles' => [], 'example' => '{“cleansession”:true,”clientId”:”GID_VOIP@@@ClientId_****”,”conferenceTopic”:”cs_alicom_voip_conference”,”host”:”mqtt-cn-4590mdhb901.mqtt.aliyuncs.com”,”meetingEventKeepAliveInterval”:0,”phoneTopic”:”alicom_voip_phone”,”port”:0,”reconnectTimeout”:2000,”registerTime”:0,”sdkClientPort”:8883,”serverId”:”GID_VOIP@@@MTEuMTMuMTM2LjExOA==”,”sgwServerTopic”:”alicom_voip_server_pre”,”tlsport”:443,”tokenData”:”abcdef”,”useTLS”:false}', ], 'AccountName' => [ 'title' => '账号名', 'description' => '账号名称。', 'type' => 'string', 'example' => '139000000', ], ], 'example' => '{"cleansession":true,"clientId":"GID_VOIP@@@ClientId_2000000001271771_100685295007","conferenceTopic":"cs_alicom_voip_conference_pre","dataTopic":"alicom_voip_data_pre","host":"mqtt-cn-4590mdhb901.mqtt.aliyuncs.com","meetingEventKeepAliveInterval":0,"phoneTopic":"alicom_voip_phone","port":0,"reconnectTimeout":2000,"registerTime":0,"sdkClientPort":8883,"serverId":"GID_VOIP@@@MTEuMjIuMTQ1Ljgy","sgwServerTopic":"alicom_voip_server_pre","tlsport":443,"tokenData":"LzMT+XLFl5s/YWJ/MlDz4t/Lq5HC1iGU1P28HAMaxYzmBSHQsWXgdISJ1ZJ+2cxaU0jwYsoyG8Q8cCIbLZTwwaFHf7gc7pPXbJGYgJWUr5ooKsoHaVvvG34cww7W8woWE1OsmZGFDODvooOIjF1CZSorVrR8OwRdprW99yqhMhkJKh7r5f3HfiQgoJWL8b3A85RrRGCSP057skgQ5rIqVAlx7jDFrOTdLtz+krken8qYvpaVBO9wRfFyWQLvxAgNJNx3Oql/hpzc2o3+xbKGTA/P2siLn6Nee1FYk5ClpXcnvfSTM4BAauuWR+oES10VblKEKTU5R/pfjXj3UKOlZ1+OdGO93WA16BR/l1uRb3cOLqya5pjWM+oSmo0sOR7B0ATLz6K1xA0Pc+p6Mu8hZl+OdGO93WA1kj1L0h9Z6CAZG4ol/BNdIg9z6noy7yFmX450Y73dYDWSPUvSH1noIBkbiiX8E10iT0a6ypXxupQdyyrhh8j1yw6otqnw5AT5Tj5VsVWVfflXeZ8nPt1ydXC9nWeHX7K80O6vtOU9M8Qn5VrhkP0F1umbOoYs3NfM+WYZIQx4pkViQo6qqkxgbEg1l6oHJbmOVzrxYRrDTIxqgE/pb0YVJQ==","useTLS":false,"username":"LTAI27GqAW1VrcQA"}', ], 'Code' => [ 'title' => '错误码', 'description' => '状态码。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '是否成功', 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"RtcId\\": \\"200000000*******\\",\\n \\"Token\\": \\"{“cleansession”:true,”clientId”:”GID_VOIP@@@ClientId_****”,”conferenceTopic”:”cs_alicom_voip_conference”,”host”:”mqtt-cn-4590mdhb901.mqtt.aliyuncs.com”,”meetingEventKeepAliveInterval”:0,”phoneTopic”:”alicom_voip_phone”,”port”:0,”reconnectTimeout”:2000,”registerTime”:0,”sdkClientPort”:8883,”serverId”:”GID_VOIP@@@MTEuMTMuMTM2LjExOA==”,”sgwServerTopic”:”alicom_voip_server_pre”,”tlsport”:443,”tokenData”:”abcdef”,”useTLS”:false}\\",\\n \\"AccountName\\": \\"139000000\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n true\\n 200\\n Successful\\n \\n {“cleansession”:true,”clientId”:”GID_VOIP@@@ClientId_2000000000000009_100648480015”,”conferenceTopic”:”cs_alicom_voip_conference”,”host”:”mqtt-cn-4590mdhb901.mqtt.aliyuncs.com”,”meetingEventKeepAliveInterval”:0,”phoneTopic”:”alicom_voip_phone”,”port”:0,”reconnectTimeout”:2000,”registerTime”:0,”sdkClientPort”:8883,”serverId”:”GID_VOIP@@@MTEuMTMuMTM2LjExOA==”,”sgwServerTopic”:”alicom_voip_server_pre”,”tlsport”:443,”tokenData”:”abcdef”,”useTLS”:false}\\n 2000000001271771\\n 150****5678\\n \\n","errorExample":""}]', 'title' => '获取移动坐席Token', ], 'HangupCall' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称(坐席登录名)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', ], ], [ 'name' => 'CallId', 'in' => 'formData', 'schema' => [ 'description' => '热线会话ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', ], ], [ 'name' => 'JobId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的jobId。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', ], ], [ 'name' => 'ConnectionId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的connId。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nxxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue\\n","errorExample":""}]', 'title' => '挂断电话', 'summary' => '调用HangupCall执行坐席挂机操作。', ], 'ListHotlineRecord' => [ 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'CallId', 'in' => 'query', 'schema' => [ 'description' => '会话ID。入呼后,websocket中的acid。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '100365558', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '热线会话信息。', 'type' => 'array', 'items' => [ 'description' => '热线会话录音信息。', 'type' => 'object', 'properties' => [ 'ConnectionId' => [ 'description' => '连接ID。', 'type' => 'string', 'example' => '100365548', ], 'EndTime' => [ 'description' => '录音结束时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16128694810', ], 'CallId' => [ 'description' => '会话ID。入呼后,websocket中的acid。', 'type' => 'string', 'example' => '100365558', ], 'StartTime' => [ 'description' => '录音开始时间戳。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '16128694110', ], 'Url' => [ 'description' => '录音文件URL。', 'type' => 'string', 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com', ], ], ], ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n {\\n \\"ConnectionId\\": \\"100365548\\",\\n \\"EndTime\\": 16128694810,\\n \\"CallId\\": \\"100365558\\",\\n \\"StartTime\\": 16128694110,\\n \\"Url\\": \\"http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nxxxx\\nEE338D98-9BD3-4413-B165\\n\\n 16128694810\\n 16128694110\\n 100365548\\n 100365558\\n http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com\\n\\nSuccess\\ntrue\\n","errorExample":""}]', 'title' => '获取热线录音列表', 'summary' => '调用ListHotlineRecord根据热线会话ID查询热线录音列表。', ], 'ListOutboundPhoneNumber' => [ 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d****', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'username@example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Data' => [ 'description' => '主叫外呼电话号码。', 'type' => 'array', 'items' => [ 'description' => '主叫外呼电话号码。', 'type' => 'string', 'example' => '{906****}', ], ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', ], [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n \\"{906****}\\"\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n EE338D98-9BD3-4413-B165\\n {906****}\\n Success\\n true\\n 200\\n","errorExample":""}]', 'title' => '获取外呼号码信息', 'summary' => '根据实例ID、坐席账号名称获取指定坐席下的主叫外呼电话号码。', 'description' => '### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'MakeDoubleCall' => [ 'summary' => '调用MakeDoubleCall通过服务端SDK发起呼叫。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'agent_***', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'title' => '账号名称', 'description' => '账号名称。', 'type' => 'string', 'required' => true, 'example' => '12345', ], ], [ 'name' => 'ServicerPhone', 'in' => 'query', 'schema' => [ 'title' => '坐席手机号(需要通过坐席手机呼叫才需要填写)', 'description' => '坐席手机号。'."\n" .'> 需要通过坐席手机呼叫才需要填写', 'type' => 'string', 'required' => false, 'example' => '150****1234', ], ], [ 'name' => 'MemberPhone', 'in' => 'query', 'schema' => [ 'title' => '用户手机号', 'description' => '用户手机号。', 'type' => 'string', 'required' => true, 'example' => '1502123****', ], ], [ 'name' => 'OutboundCallNumber', 'in' => 'query', 'schema' => [ 'title' => '外呼主叫号码', 'description' => '外呼主叫号码。', 'type' => 'string', 'required' => true, 'example' => '0571000****', ], ], [ 'name' => 'BizData', 'in' => 'query', 'schema' => [ 'title' => '业务携带数据(JsonString)', 'description' => '业务携带数据。JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{"bizId": 123456}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'Successful', ], 'Data' => [ 'title' => '返回数据', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Acid' => [ 'title' => '会话id', 'description' => '会话ID。', 'type' => 'string', 'example' => '68255155365620598', ], ], ], 'Code' => [ 'title' => '错误码', 'description' => '状态码。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '调用是否成功', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Acid\\": \\"68255155365620598\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nEE338D98-9BD3-4413-B165\\ntrue\\n200\\nSuccessful\\n\\n 68255155365620598\\n\\n","errorExample":""}]', 'title' => '通过服务端SDK发起呼叫', ], 'SendHotlineHeartBeat' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', ], ], [ 'name' => 'Token', 'in' => 'formData', 'schema' => [ 'description' => '心跳签名。'."\n" ."\n" .'可调用[StartHotlineService](~~2718045~~)接口获取Token。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0079e7a845e373****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', ], [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nxxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue\\n","errorExample":""}]', 'title' => '发送热线心跳', 'summary' => '根据实例ID、坐席账号名称、心跳签名发送热线心跳请求。', 'description' => '### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'StartCall' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', ], ], [ 'name' => 'Caller', 'in' => 'formData', 'schema' => [ 'description' => '热线外呼主叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '906****', ], ], [ 'name' => 'Callee', 'in' => 'formData', 'schema' => [ 'description' => '热线外呼被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1360987****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nxxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue\\n","errorExample":""}]', 'title' => '坐席发起外呼', 'summary' => '根据实例ID、坐席账号名称、热线外呼主叫号码、被叫号码发起外呼。', 'description' => '### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'StartHotlineService' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'title' => 'js sdk中自动生成的鉴权token', 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Data' => [ 'description' => '请求调用成功后返回,发起心跳所需的Token。', 'type' => 'string', 'example' => '0079e7a845e373****', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"0079e7a845e373****\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n EE338D98-9BD3-4413-B165\\n 0079e7a845e37334ff\\n Success\\n true\\n 200\\n","errorExample":""}]', 'title' => '开始热线服务', 'summary' => '根据实例ID、坐席账号名称进行热线坐席签入,开始热线服务。', 'description' => '- 此接口返回的**Data**参数为发起心跳所需的Token。'."\n" .'- 若坐席小休,需暂停热线服务,可调用[SuspendHotlineService](~~2718046~~)接口。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'SuspendHotlineService' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。 ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', ], ], [ 'name' => 'Type', 'in' => 'formData', 'schema' => [ 'description' => '小休原因。取值:'."\n" .'- **1**:小休(默认值)。'."\n" .'- **2**:就餐。'."\n" .'- **3**:会议。'."\n" .'- **4**:辅导 。'."\n" .'- **5**:培训。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '5', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功。'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。'."\n", 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nxxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue\\n","errorExample":""}]', 'title' => '暂停热线服务', 'summary' => '在热线坐席小休时,暂停热线服务。', 'description' => '若休息结束,需要开始热线服务,可调用[StartHotlineService](~~2718045~~)接口。'."\n" ."\n" .'### QPS限制'."\n" .'- 单用户调用频率:不限流。'."\n" .'- API频率:100次/秒。'."\n" ."\n" .'> 如果多个用户的总调用超过API频率也会触发流控。', ], 'AddOuterAccount' => [ 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'OuterAccountId', 'in' => 'query', 'schema' => [ 'description' => '外部账号ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1212', ], ], [ 'name' => 'OuterAccountType', 'in' => 'query', 'schema' => [ 'description' => '外部账号类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alipay', ], ], [ 'name' => 'OuterAccountName', 'in' => 'query', 'schema' => [ 'description' => '外部账号名称。', 'type' => 'string', 'required' => false, 'example' => '测试', ], ], [ 'name' => 'Avatar', 'in' => 'query', 'schema' => [ 'description' => '头像。', 'type' => 'string', 'required' => false, 'example' => 'http://****', ], ], [ 'name' => 'RealName', 'in' => 'query', 'schema' => [ 'description' => '账号真实姓名。', 'type' => 'string', 'required' => false, 'example' => '张三', ], ], [ 'name' => 'OuterDepartmentId', 'in' => 'query', 'schema' => [ 'description' => '外部部门ID。', 'type' => 'string', 'required' => false, 'example' => '3', ], ], [ 'name' => 'OuterGroupIds', 'in' => 'query', 'schema' => [ 'description' => '外部技能组ID列表。多个ID用英文逗号(,)分隔。', 'type' => 'string', 'required' => false, 'example' => '["222","333","444"]', ], ], [ 'name' => 'Ext', 'in' => 'query', 'schema' => [ 'description' => '扩展字段,JSON字符串。', 'type' => 'string', 'required' => false, 'example' => '{"备注":"临时技能组"}', ], ], [ 'name' => 'OuterDepartmentType', 'in' => 'query', 'schema' => [ 'description' => '外部部门类型:无效部门类型。', 'type' => 'string', 'required' => false, 'example' => 'type_invalid', ], ], [ 'name' => 'OuterGroupType', 'in' => 'query', 'schema' => [ 'description' => '技能组类型。', 'type' => 'string', 'required' => false, 'example' => 'mybank', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '创建账号ID。', 'type' => 'string', 'example' => '123456', ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"123456\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n 123456\\n 200\\n true\\n","errorExample":""}]', 'title' => '添加外部关联账户', 'summary' => '调用AddOuterAccount添加外部账号。', ], 'AiccsSmartCall' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProdCode', 'in' => 'query', 'schema' => [ 'description' => '产品名称。默认取值:**aiccs**。', 'type' => 'string', 'required' => false, 'example' => 'aiccs', 'default' => 'aiccs', ], ], [ 'name' => 'CalledShowNumber', 'in' => 'query', 'schema' => [ 'description' => '被叫显号,必须是已购买的号码。'."\n" ."\n" .'您可以登录[联络中心控制台](https://aiccs.console.aliyun.com/overview?spm=a2c4g.11186623.0.0.7f9bf9658X6jte),查看已购买的号码。', 'type' => 'string', 'required' => true, 'example' => '0571000****', ], ], [ 'name' => 'CalledNumber', 'in' => 'query', 'schema' => [ 'description' => '被叫号码。仅支持中国内地号码。', 'type' => 'string', 'required' => true, 'example' => '1862222****', ], ], [ 'name' => 'VoiceCode', 'in' => 'query', 'schema' => [ 'description' => '智能外呼放音文件,支持网络文件和TTS方式。其中,支持使用多个文件和TTS参数混播,之间用英文逗号(,)分隔。TTS参数的替换值在**VoiceCodeParam**中指定。'."\n" ."\n" .'- 放音文件为网络文件时:参数VoiceCode指定为可被公网访问的语音文件URL,建议您使用采样频率为8000Hz或16000Hz且为wav格式的语音文件。'."\n" .'- 放音文件为TTS时:参数VoiceCode指定为变量名称如$name$,需要在VoiceCodeParam中设置变量对应的内容。', 'type' => 'string', 'required' => true, 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$', ], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => [ 'description' => '预留给调用方使用的ID,最终会通过在回执消息中将此ID带回给调用方。'."\n" .'字符串类型,长度为1~15个字节。', 'type' => 'string', 'required' => false, 'example' => '222356****', ], ], [ 'name' => 'PlayTimes', 'in' => 'query', 'schema' => [ 'description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Volume', 'in' => 'query', 'schema' => [ 'description' => '播放用户音频的音量,取值范围为**-4~4**,建议设置为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Speed', 'in' => 'query', 'schema' => [ 'description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'AsrModelId', 'in' => 'query', 'schema' => [ 'description' => 'ASR模型ID。请在[ASR模型管理页面](https://aiccs.console.aliyun.com/sentence/model/private?spm=a2c4g.11186623.0.0.7f9b2964fYSGv4)查看ASR模型ID。', 'type' => 'string', 'required' => false, 'example' => 'bf71664d30d2478fb8cb8c39c6b6****', ], ], [ 'name' => 'AsrBaseId', 'in' => 'query', 'schema' => [ 'description' => 'SR基础模型。'."\n" ."\n" .'- **customer_service_8k**:普通话。'."\n" .'- **dialect_customer_service_8k**:重口音。'."\n" ."\n" .'> - 调用接口**SendCcoSmartCall**时,需要指定使用的ASR模型,建议参数**asrModelId**和**AsrBaseId**二者选填一个。'."\n" .'- 如果仅设置**asrModelId**,表示使用指定的ASR模型。'."\n" .'- 如果仅设置**AsrBaseId**,表示使用指定的ASR基础模型。'."\n" .'- 如果二者均未设置,则使用默认的ASR基础模型,即参数**AsrBaseId**默认为**customer_service_8k**,表示使用ASR普通话基础模型。'."\n" .'- 如果二者同时设置,请确认二者是正确对应的。'."\n", 'type' => 'string', 'required' => false, 'example' => 'customer_service_8k', ], ], [ 'name' => 'AsrAlsAmId', 'in' => 'query', 'schema' => [ 'description' => '声学模型ID。', 'type' => 'string', 'required' => false, 'example' => '23387****', ], ], [ 'name' => 'AsrVocabularyId', 'in' => 'query', 'schema' => [ 'description' => '热词ID。请在[ASR热词管理页面](https://aiccs.console.aliyun.com/sentence/vocab?spm=a2c4g.11186623.0.0.7f9bf965IKBpsi)查看ASR热词ID。', 'type' => 'string', 'required' => false, 'example' => '6689****', ], ], [ 'name' => 'RecordFlag', 'in' => 'query', 'schema' => [ 'description' => '通话过程中是否录音。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'PauseTime', 'in' => 'query', 'schema' => [ 'description' => '停顿时长。用于设置用户停顿多久,表示一句话结束。单位为毫秒,取值范围为**300~1200**。'."\n" ."\n" .'- 如果指定值不在参数范围中,则默认PauseTime为**800**。'."\n" .'- 首次设置有效,后续设置无效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '800', ], ], [ 'name' => 'MuteTime', 'in' => 'query', 'schema' => [ 'description' => '静音时长。用于设置用户多久不说话通话结束。单位为毫秒,取值范围为**1000~20000**。'."\n" ."\n" .'- 如果指定值不在参数范围中,则默认MuteTime为**10000**。'."\n" .'- 通话过程中可动态设置,以最后一次设置为准。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000', ], ], [ 'name' => 'ActionCodeBreak', 'in' => 'query', 'schema' => [ 'description' => '开场放音文件是否可打断。默认为**true**,即开场放音文件可打断。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'DynamicId', 'in' => 'query', 'schema' => [ 'description' => '预留给调用方使用的动态扩展ID,在回调地址中带回,用于客户的开发标识。', 'type' => 'string', 'required' => false, 'example' => '2234****', ], ], [ 'name' => 'EarlyMediaAsr', 'in' => 'query', 'schema' => [ 'description' => '早媒体语音识别标识。设为**true**会记录通话未接听的原因。默认为**fasle**,即关闭状态。'."\n" ."\n" .'> 如果需要启用早媒体语音识别标识,请手动设为**true**。', 'type' => 'boolean', 'required' => false, 'example' => 'fasle', ], ], [ 'name' => 'VoiceCodeParam', 'in' => 'query', 'schema' => [ 'description' => 'TTS参数传递字符串,格式为JSON。必须与VoiceCode的TTS参数对应。', 'type' => 'string', 'required' => false, 'example' => '“{\\”name\\”:\\”喂,你好\\”}”', ], ], [ 'name' => 'SessionTimeout', 'in' => 'query', 'schema' => [ 'description' => '最大通话时长,单位为秒,超时后自动挂断。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', ], ], [ 'name' => 'ActionCodeTimeBreak', 'in' => 'query', 'schema' => [ 'description' => '基于用户持续说话时长打断,在ActionCodeBreak为**true**时生效。单位为毫秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', ], ], [ 'name' => 'TtsConf', 'in' => 'query', 'schema' => [ 'description' => '是否设置TTS声音参数。'."\n" .'- 指定为**true**:需要通过TtsStyle、TtsColume、TtsSpeed三个参数来设置声音风格。'."\n" .'- 定为**false**:不需要设置相关参数,即便设置了也不生效。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'TtsStyle', 'in' => 'query', 'schema' => [ 'description' => 'TTS变量播放时的声音风格,默认为**xiaoyun**,具体风格请参见声音风格列表。', 'type' => 'string', 'required' => false, 'example' => 'xiaoyun', ], ], [ 'name' => 'TtsVolume', 'in' => 'query', 'schema' => [ 'description' => 'TTS变量播放的音量,取值范围为**0~100**,默认为**0**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], [ 'name' => 'TtsSpeed', 'in' => 'query', 'schema' => [ 'description' => 'TTS变量播放时的声音速度,取值范围为**-200~200**,默认为**0**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'EnableITN', 'in' => 'query', 'schema' => [ 'description' => '是否在后处理中执行ITN。'."\n" ."\n" .'> 设置为**true**时,中文数字将转为阿拉伯数字输出,默认为**false**。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', ], ], [ 'name' => 'BackgroundFileCode', 'in' => 'query', 'schema' => [ 'description' => '用户和机器人对话时播放的背景语音文件ID。'."\n" ."\n" .'您可以登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview),选择**智能交互 > 语音文件管理**,单击**详情**,查看对应的语音ID。', 'type' => 'string', 'required' => false, 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', ], ], [ 'name' => 'BackgroundVolume', 'in' => 'query', 'schema' => [ 'description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '4', 'minimum' => '-4', 'example' => '1', ], ], [ 'name' => 'BackgroundSpeed', 'in' => 'query', 'schema' => [ 'description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', ], 'Data' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], 'Code' => [ 'description' => '此次通话的唯一回执ID。', 'type' => 'string', 'example' => '116012854210^10281427****', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', ], [ 'errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"OK\\",\\n \\"Code\\": \\"116012854210^10281427****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n A90E4451-FED7-49D2-87C8-00700A8C4D0D\\n OK\\n 116012854210^10281427****\\n","errorExample":""}]', 'title' => '发起智能语音交互通话', 'summary' => '调用AiccsSmartCall接口发起智能语音交互通话。', 'requestParamsDescription' => '### 声音风格列表'."\n" ."\n" .'- 小云标准女声:xiaoyun'."\n" .'- 小刚标准男声:xiaogang'."\n" .'- 若兮温柔女声:ruoxi'."\n" .'- 小梦标准女声:xiaomeng'."\n" .'- 小威标准男声:xiaowei'."\n" .'- 阿美甜美女声:amei'."\n" .'- 小雪温柔女声:xiaoxue'."\n" .'- 思琪温柔女声:siqi'."\n" .'- 思佳标准女声:sijia'."\n" .'- 思诚标准男声:sicheng'."\n" .'- 思悦温柔女声:siyue'."\n" .'- 小美甜美女声:xiaomei'."\n" .'- 思彤标准童声:sitong'."\n" .'- 宁儿标准女声:ninger'."\n" .'- 小北萝莉女声:xiaobei'."\n" .'- 伊娜浙普女声:yina'."\n", ], 'AiccsSmartCallOperate' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProdCode', 'in' => 'query', 'schema' => [ 'description' => '产品名称。默认取值:**aiccs**。', 'type' => 'string', 'required' => false, 'example' => 'aiccs', 'default' => 'aiccs', ], ], [ 'name' => 'CallId', 'in' => 'query', 'schema' => [ 'description' => '通话的唯一回执ID。可以通过[SendCcoSmartCall](~~311247~~)获取。', 'type' => 'string', 'required' => false, 'example' => '116012854210^102814279****', ], ], [ 'name' => 'Command', 'in' => 'query', 'schema' => [ 'description' => '在智能外呼通话中,指定被叫号码发起的动作。'."\n" ."\n" .'> 当前仅支持参数**parallelBridge**,表示指定动作为被叫号码与呼叫中心坐席桥接。', 'type' => 'string', 'required' => false, 'example' => 'parallelBridge', ], ], [ 'name' => 'Param', 'in' => 'query', 'schema' => [ 'description' => '扩展字段。', 'type' => 'string', 'required' => false, 'example' => 'Param', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', ], 'Data' => [ 'description' => '命令执行的结果。'."\n" .'- **true**:命令执行成功。'."\n" .'- **false**:命令执行失败。', 'type' => 'string', 'example' => 'true', ], 'Code' => [ 'description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', ], [ 'errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n A90E4451-FED7-49D2-87C8-00700A8C4D0D\\n true\\n OK\\n","errorExample":""}]', 'title' => '发起智能语音指定动作', 'summary' => '调用AiccsSmartCallOperate接口在智能外呼通话中,发起指定动作,仅用于并行转人工,人工坐席可旁听人机对话等场景。', ], 'BatchCreateQualityProjects' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'CheckFreqType', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', ], ], [ 'name' => 'TimeRangeStart', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'TimeRangeEnd', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'AnalysisIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int64', ], 'required' => true, 'maxItems' => 3, ], ], [ 'name' => 'InstanceList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => true, 'maxItems' => 3, ], ], [ 'name' => 'ChannelTouchType', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int32', ], 'required' => false, 'maxItems' => 3, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'type' => 'string', ], 'Version' => [ 'type' => 'integer', 'format' => 'int32', ], 'ProjectId' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'ChangeChatAgentStatus' => [ 'summary' => '调用ChangeChatAgentStatus修改在线客服状态。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'title' => 'clientToken', 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'title' => '示例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'title' => '账户名称', 'description' => '坐席账号。', 'type' => 'string', 'required' => true, 'example' => 'account1', ], ], [ 'name' => 'Method', 'in' => 'formData', 'schema' => [ 'title' => '修改到的状态类型', 'description' => '想要切换到的在线状态。目前支持**requestLogout** (申请离线)。', 'type' => 'string', 'required' => true, 'example' => 'requestLogout', 'enum' => [ 'requestRest', 'requestLogout', 'restToWork', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => 'message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'success', ], 'RequestId' => [ 'title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DF6A3FB7-A5AA-43BE-A65B', ], 'HttpStatusCode' => [ 'title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'title' => 'data', 'description' => '当前客服状态。取值:'."\n" .'- **0**:下班'."\n" .'- **3**:小休', 'type' => 'string', 'example' => '0', ], 'Code' => [ 'title' => 'code', 'description' => '状态码。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'title' => 'success', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'errorCode' => 'IdempotentParameterMismatch', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"DF6A3FB7-A5AA-43BE-A65B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"0\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n DF6A3FB7-A5AA-43BE-A65B\\n 200\\n 0\\n Success\\n true\\n","errorExample":""}]', 'title' => '修改在线客服状态', 'description' => '> 目前仅支持将在线客服状态修改为下班状态。', ], 'ChangeQualityProjectStatus' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'string', ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'CreateOutboundTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10', 'minimum' => '0', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'RetryTime', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '3', 'minimum' => '0', 'default' => '0', ], ], [ 'name' => 'RetryInterval', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '2880', 'minimum' => '0', 'default' => '0', ], ], [ 'name' => 'SkillGroup', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0', ], ], [ 'name' => 'Ani', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Model', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '10', 'minimum' => '0', ], ], [ 'name' => 'DepartmentId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0', ], ], [ 'name' => 'ExtAttrs', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'CallInfos', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'string', ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'CreateQualityProject' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'CheckFreqType', 'in' => 'formData', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', ], ], [ 'name' => 'ScopeType', 'in' => 'formData', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', ], ], [ 'name' => 'TimeRangeStart', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'TimeRangeEnd', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'ChannelTouchType', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int32', ], 'required' => false, 'maxItems' => 3, ], ], [ 'name' => 'DepList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int64', ], 'required' => false, 'maxItems' => 3, ], ], [ 'name' => 'GroupList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int64', ], 'required' => false, 'maxItems' => 3, ], ], [ 'name' => 'ServicerList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => false, 'maxItems' => 3, ], ], [ 'name' => 'AnalysisIds', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int64', ], 'required' => true, 'maxItems' => 3, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'type' => 'string', ], 'Version' => [ 'type' => 'integer', 'format' => 'int32', ], 'ProjectId' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified parameter is invalid.', 'errorCode' => 'InvalidParameter', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'CreateQualityRule' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'Name', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'RuleTag', 'in' => 'formData', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'MatchType', 'in' => 'formData', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'KeyWords', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => true, 'maxItems' => 3, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified parameter is invalid.', 'errorCode' => 'InvalidParameter', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'CreateThirdSsoAgent' => [ 'summary' => '根据用户账号创建免登到客服工作台的坐席。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'title' => 'clientToken', 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'title' => 'param1', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre***', ], ], [ 'name' => 'ClientId', 'in' => 'formData', 'schema' => [ 'title' => 'param2', 'description' => '颁发给租户实例的clientId。', 'type' => 'string', 'required' => true, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'AccountId', 'in' => 'formData', 'schema' => [ 'title' => 'param3', 'description' => '要同步的账号ID。', 'type' => 'string', 'required' => true, 'example' => 'accountId1', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'title' => 'param4', 'description' => '要同步的账号名称。', 'type' => 'string', 'required' => true, 'example' => 'accountName1', ], ], [ 'name' => 'DisplayName', 'in' => 'formData', 'schema' => [ 'title' => 'param5', 'description' => '坐席显示名称。', 'type' => 'string', 'required' => false, 'example' => '张三', ], ], [ 'name' => 'SkillGroupIds', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'title' => 'param6', 'description' => '技能组ID列表。'."\n" ."\n", 'type' => 'array', 'items' => [ 'description' => '技能组ID。'."\n" .'> 所传技能组必须属于同一个技能组分组。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'required' => false, ], ], [ 'name' => 'RoleIds', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'title' => 'param7', 'description' => '角色ID列表。', 'type' => 'array', 'items' => [ 'description' => '角色ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => 'message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'Success', ], 'RequestId' => [ 'title' => 'requestId', 'description' => 'requestId', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Data' => [ 'title' => '新创建的坐席id', 'description' => '创建的坐席ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', ], 'Code' => [ 'title' => 'code', 'description' => '状态码。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => 'success', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'errorCode' => 'IdempotentParameterMismatch', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123456,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n Success\\n EE338D98-9BD3-4413-B165\\n 200\\n 123456\\n 200\\n true\\n","errorExample":""}]', 'title' => '创建免登到客服工作台的坐席', ], 'DeleteOutboundTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'OutboundTaskId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'string', ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'DeleteOuterAccount' => [ 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'OuterAccountId', 'in' => 'query', 'schema' => [ 'description' => '外部账号ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456', ], ], [ 'name' => 'OuterAccountType', 'in' => 'query', 'schema' => [ 'description' => '外部账号类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aliyun', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '是否成功。取值:'."\n" .'- **true**:成功'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n true\\n 200\\n true\\n","errorExample":""}]', 'title' => '删除外部账号', 'summary' => '调用DeleteOuterAccount根据外部账号ID删除外部账号。', ], 'DeleteQualityProject' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'string', ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'DeleteQualityRule' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'string', ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'EditQualityProject' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', ], ], [ 'name' => 'ProjectName', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'CheckFreqType', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', ], ], [ 'name' => 'ProjectVersion', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', ], ], [ 'name' => 'ScopeType', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', ], ], [ 'name' => 'TimeRangeStart', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'TimeRangeEnd', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'AnalysisIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int64', ], 'required' => true, 'maxItems' => 3, ], ], [ 'name' => 'DepList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int64', ], 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'maxItems' => 3, ], ], [ 'name' => 'GroupList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int64', ], 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'maxItems' => 3, ], ], [ 'name' => 'ServicerList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => false, 'maxItems' => 3, ], ], [ 'name' => 'ChannelTouchType', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int32', ], 'required' => true, 'maxItems' => 3, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'type' => 'string', ], 'Version' => [ 'type' => 'integer', 'format' => 'int32', ], 'ProjectId' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'EditQualityRule' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'Name', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'RuleTag', 'in' => 'formData', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'MatchType', 'in' => 'formData', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', ], ], [ 'name' => 'QualityRuleId', 'in' => 'formData', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'KeyWords', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => true, 'maxItems' => 3, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified parameter is invalid.', 'errorCode' => 'InvalidParameter', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'EditQualityRuleTag' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'AnalysisTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, ], 'Name' => [ 'type' => 'string', 'required' => false, ], ], ], 'required' => true, 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'string', ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'EncryptPhoneNum' => [ 'summary' => '调用EncryptPhoneNum将用户手机号码进行加密。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例Id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre***', ], ], [ 'name' => 'PhoneNum', 'in' => 'query', 'schema' => [ 'title' => '号码明文', 'description' => '号码明文。', 'type' => 'string', 'required' => true, 'example' => '130****0000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'Data' => [ 'title' => '加密后密文', 'description' => '加密后密文。', 'type' => 'string', 'example' => '20nJ****/9Fl/kxx/***7', ], 'Code' => [ 'title' => '错误码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '接口调用是否成功', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": \\"20nJ****/9Fl/kxx/***7\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n true\\n 200\\n xxxx\\n 20nJ****/9Fl/kxx/***7\\n","errorExample":""}]', 'title' => '将用户手机号码进行加密', ], 'FetchCall' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一id,用于幂等校验,可以用uuid生成', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称(坐席登录名)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', ], ], [ 'name' => 'CallId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的acid', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', ], ], [ 'name' => 'JobId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的jobId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', ], ], [ 'name' => 'ConnectionId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的connId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', ], ], [ 'name' => 'HoldConnectionId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的holdConnId( 仅在双步转时传入)', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误描述', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID,用于跟踪错误原因', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Code' => [ 'description' => '错误编码', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', ], [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', 'title' => '取回通话信息', 'summary' => '取回\\恢复通话。', ], 'GetAgentById' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'AgentId', 'in' => 'formData', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'properties' => [ 'ForeignNick' => [ 'type' => 'string', ], 'ServicerType' => [ 'type' => 'integer', 'format' => 'int32', ], 'RealName' => [ 'type' => 'string', ], 'AgentId' => [ 'type' => 'integer', 'format' => 'int32', ], 'ForeignKey' => [ 'type' => 'string', ], 'ShowName' => [ 'type' => 'string', ], 'CreateUserName' => [ 'type' => 'string', ], ], ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'GetHotlineRuntimeInfo' => [ 'summary' => '调用GetHotlineRuntimeInfo接口查询热线运行信息。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => '实例ID。'."\n" ."\n" .'请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview),在**实例管理**中查看实例ID。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'title' => '账号名', 'description' => '坐席账号名称。实例内唯一(登录名)。', 'type' => 'string', 'required' => true, 'example' => '123@****.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'Data' => [ 'title' => '数据结果', 'description' => '热线运行信息。', 'type' => 'object', 'example' => '{"buId":905,"phoneToken":"roESVzzgD1ytmG0W6nMkWinI6fbpKovm14fBhA0NsYPyi/srX/G0SvNB2z96AYiqy1vxQHiaFOdZSxtsAubdgr2kjs2yas7COO5dukQpsOLq9iNI4U6sKlcvaBi8xsyUr/hyqCdTVZDcYCOq0lH6eeNIQK/f7/gWqIw****=","isNeedWorkShift":false,"servicerId":741018,"accConfigUrl":"pre-acc-cs-public.alibaba-inc.com","agentBasicCode":"AgentCheckout","startWorkToReady":true,"servicerDn":"2000000001904123","isMaster":"1","tenantId":2001,"depId":1139139,"accTenantId":2001,"phoneData":"{\\"timeStamp\\":164240****,\\"expireTime\\":164257****,\\"dn\\":\\"200000000190****\\",\\"source\\":\\"xspace\\",\\"serviceId\\":741018}","agentBasicDesc":"坐席签出状态"}', ], 'Code' => [ 'title' => '错误码', 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '接口调用是否成功', 'description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"buId\\": 905,\\n \\"phoneToken\\": \\"roESVzzgD1ytmG0W6nMkWinI6fbpKovm14fBhA0NsYPyi/srX/G0SvNB2z96AYiqy1vxQHiaFOdZSxtsAubdgr2kjs2yas7COO5dukQpsOLq9iNI4U6sKlcvaBi8xsyUr/hyqCdTVZDcYCOq0lH6eeNIQK/f7/gWqIw****=\\",\\n \\"isNeedWorkShift\\": false,\\n \\"servicerId\\": 741018,\\n \\"accConfigUrl\\": \\"pre-acc-cs-public.alibaba-inc.com\\",\\n \\"agentBasicCode\\": \\"AgentCheckout\\",\\n \\"startWorkToReady\\": true,\\n \\"servicerDn\\": \\"2000000001904123\\",\\n \\"isMaster\\": \\"1\\",\\n \\"tenantId\\": 2001,\\n \\"depId\\": 1139139,\\n \\"accTenantId\\": 2001,\\n \\"phoneData\\": \\"{\\\\\\"timeStamp\\\\\\":164240****,\\\\\\"expireTime\\\\\\":164257****,\\\\\\"dn\\\\\\":\\\\\\"200000000190****\\\\\\",\\\\\\"source\\\\\\":\\\\\\"xspace\\\\\\",\\\\\\"serviceId\\\\\\":741018}\\",\\n \\"agentBasicDesc\\": \\"坐席签出状态\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 905\\n roESVzzgD1ytmG0W6nMkWinI6fbpKovm14fBhA0NsYPyi/srX/G0SvNB2z96AYiqy1vxQHiaFOdZSxtsAubdgr2kjs2yas7COO5dukQpsOLq9iNI4U6sKlcvaBi8xsyUr/hyqCdTVZDcYCOq0lH6eeNIQK/f7/gWqIwDXiWfN2g=\\n false\\n 741018\\n pre-acc-cs-public.alibaba-inc.com\\n AgentCheckout\\n true\\n 2000000001904123\\n 1\\n 2001\\n 1139139\\n 2001\\n {\\"timeStamp\\":1642402907,\\"expireTime\\":1642575707,\\"dn\\":\\"2000000001904123\\",\\"source\\":\\"xspace\\",\\"serviceId\\":741018}\\n 坐席签出状态\\n \\n true\\n","errorExample":""}]', 'title' => '查询热线运行信息', ], 'GetHotlineWaitingNumber' => [ 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'description' => ' '."\n" .'客户请求唯一id,用于幂等校验,可以用uuid生成', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => ' '."\n" .'AICCS实例ID,在智能联络中心控制台上可以看到', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => [ 'description' => ' '."\n" .'坐席账号名称(坐席登录名)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => ' '."\n" .'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误描述', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID,用于跟踪错误原因', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '热线会员排队数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'Code' => [ 'description' => '错误编码', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => ' '."\n" .'接口调用是否成功', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', ], [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 2,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\n2\\nSuccess\\ntrue","errorExample":""}]', 'title' => '查看当前坐席所在技能组热线排队数量', 'summary' => '获取热线会员排队数。', ], 'GetInstanceList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '20', ], ], [ 'name' => 'Name', 'in' => 'formData', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'type' => 'integer', 'format' => 'int32', ], 'RequestId' => [ 'type' => 'string', ], 'Message' => [ 'type' => 'string', ], 'PageSize' => [ 'type' => 'integer', 'format' => 'int32', ], 'PageNumber' => [ 'type' => 'integer', 'format' => 'int32', ], 'HttpStatusCode' => [ 'type' => 'integer', 'format' => 'int32', ], 'CommodityInstances' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'type' => 'string', ], 'Name' => [ 'type' => 'string', ], ], ], ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified parameter is invalid.', 'errorCode' => 'InvalidParameter', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'GetMcuLvsIp' => [ 'summary' => '调用GetMcuLvsIp查询热线服务器IP。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre***', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => 'error message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'Data' => [ 'title' => 'result data', 'description' => 'IP信息。格式为List类型的JSON字符串。', 'type' => 'string', 'example' => '{ "xmculvs":[ 0:{ "port":00 "ip":"0.0.0.0" "name":"lvs1" } ]}', ], 'Code' => [ 'title' => 'error code', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => 'success', 'description' => '调用接口是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": \\"{ \\\\\\"xmculvs\\\\\\":[ 0:{ \\\\\\"port\\\\\\":00 \\\\\\"ip\\\\\\":\\\\\\"0.0.0.0\\\\\\" \\\\\\"name\\\\\\":\\\\\\"lvs1\\\\\\" } ]}\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n true\\n 200\\n xxxx\\n { \\"xmculvs\\":[ 0:{ \\"port\\":00 \\"ip\\":\\"0.0.0.0\\" \\"name\\":\\"lvs1\\" } ]}\\n","errorExample":""}]', 'title' => '查询热线服务器IP', ], 'GetOutbounNumList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d****', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => "\n" .'实例ID。'."\n" ."\n" .'请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview),在**实例管理**中查看实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-****', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称(坐席登录名)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@****.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'Data' => [ 'description' => '号码列表信息。', 'type' => 'object', 'properties' => [ 'Num' => [ 'description' => '主叫号码信息。', 'type' => 'array', 'items' => [ 'description' => '主叫号码信息。', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => '主叫号码类型。取值:'."\n" ."\n" .'- **1**:号码。'."\n" .'- **2**:号码组。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Description' => [ 'description' => '主叫号码描述(归属地信息)。', 'type' => 'string', 'example' => '浙江省杭州市', ], 'Value' => [ 'description' => '主叫号码。', 'type' => 'string', 'example' => '07512234****', ], ], ], ], 'NumGroup' => [ 'description' => '号码组信息。', 'type' => 'array', 'items' => [ 'description' => '号码组信息。', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => '号码组类型。取值:'."\n" ."\n" .'- **1**:号码。'."\n" .'- **2**:号码组。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Description' => [ 'description' => '号码组描述(号码组名称)。', 'type' => 'string', 'example' => 'Jella', ], 'Value' => [ 'description' => '号码组ID。', 'type' => 'string', 'example' => '7688****', ], ], ], ], ], ], 'Code' => [ 'description' => '状态码。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], [ 'errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', ], [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Num\\": [\\n {\\n \\"Type\\": 1,\\n \\"Description\\": \\"浙江省杭州市\\",\\n \\"Value\\": \\"07512234****\\"\\n }\\n ],\\n \\"NumGroup\\": [\\n {\\n \\"Type\\": 2,\\n \\"Description\\": \\"Jella\\",\\n \\"Value\\": \\"7688****\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n EE338D98-9BD3-4413-B165\\n \\n \\n 2\\n 7688****\\n Jella\\n \\n \\n 1\\n 07512234****\\n 浙江省杭州市\\n \\n \\n Success\\n true\\n 200\\n","errorExample":""}]', 'title' => '获取外呼号码列表', 'summary' => '获取外部热线号码列表。', ], 'GetQualityProjectDetail' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '租户实例ID', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre***', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '质检任务ID', 'description' => '质检任务ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '15977801', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => 'Message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'title' => 'RequestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'title' => 'Data', 'description' => '质检任务信息。', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '质检任务状态', 'description' => '质检任务状态。取值:'."\n" ."\n" .'- **0**:启动'."\n" .'- **1**:关闭', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ServicerList' => [ 'title' => '坐席列表', 'description' => '质检抽样范围。', 'type' => 'array', 'items' => [ 'description' => '质检抽样范围:客服登录名。', 'type' => 'integer', 'format' => 'int64', 'example' => '0:55555', ], ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间。', 'type' => 'string', 'example' => '2021-04-07 18:07:19', ], 'QualityType' => [ 'title' => '质检类型', 'description' => '质检类型 。固定取值为**1**(咨询类)。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'DepList' => [ 'title' => '技能组分组', 'description' => '质检抽样范围。', 'type' => 'array', 'items' => [ 'description' => '部门列表:部门列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '0:10', ], ], 'GroupList' => [ 'title' => '技能组列表', 'description' => '质检抽样范围。', 'type' => 'array', 'items' => [ 'description' => '质检抽样范围:技能组列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '0:123456', ], ], 'ProjectName' => [ 'title' => '质检任务名称', 'description' => '质检任务名称', 'type' => 'string', 'example' => '自动化质检任务', ], 'Version' => [ 'title' => 'Version', 'description' => '质检任务版本号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-04-07 18:07:18', ], 'Id' => [ 'title' => '质检任务ID', 'description' => '质检任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '15977801', ], 'QualityRuleIds' => [ 'title' => '质检规则ID', 'description' => '质检项规则ID。', 'type' => 'array', 'items' => [ 'description' => '质检规则数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '5369', ], ], 'CheckFreqType' => [ 'title' => '质检周期', 'description' => '检查频次类型。取值:'."\n" ."\n" .'- **1**:周期质检'."\n" .'- **4**:临时质检', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'Code' => [ 'title' => 'Code', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => 'Success', 'description' => '接口调用是否成功。', 'type' => 'string', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"ServicerList\\": [\\n 0\\n ],\\n \\"ModifyTime\\": \\"2021-04-07 18:07:19\\",\\n \\"QualityType\\": 1,\\n \\"DepList\\": [\\n 0\\n ],\\n \\"GroupList\\": [\\n 0\\n ],\\n \\"ProjectName\\": \\"自动化质检任务\\",\\n \\"Version\\": 1,\\n \\"CreateTime\\": \\"2021-04-07 18:07:18\\",\\n \\"Id\\": 15977801,\\n \\"QualityRuleIds\\": [\\n 5369\\n ],\\n \\"CheckFreqType\\": 1\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n \\n 0\\n 1\\n 5369\\n 2021-04-07 18:07:18\\n 自动化质检任务\\n 1\\n 1\\n 15977801\\n 2021-04-07 18:07:19\\n \\n 200\\n true\\n","errorExample":""}]', 'title' => '获取质检任务详情', 'summary' => '调用GetQualityProjectDetail获取质检任务详情。', ], 'GetQualityProjectList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre***', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '质检项ID', 'description' => '质检任务ID(支持模糊搜索)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '15', 'default' => '1', ], ], [ 'name' => 'ProjectName', 'in' => 'query', 'schema' => [ 'title' => '质检项名称', 'description' => '质检任务名(支持模糊搜索)。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '质检', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'title' => '质检项状态', 'description' => '质检任务状态。取值:'."\n" ."\n" .'- **0**:启动'."\n" .'- **1**:关闭'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '0', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'title' => 'PageNo', 'description' => '当前页。默认为:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => 'PageSize', 'description' => '每页大小。默认为:**10**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10', ], ], [ 'name' => 'checkFreqType', 'in' => 'query', 'schema' => [ 'title' => '质检频率', 'description' => '检查频次类型。取值:'."\n" ."\n" .'- **1**:周期质检'."\n" .'- **4**:临时质检', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => 'Message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'title' => 'RequestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'title' => 'Data', 'description' => '质检任务信息。', 'type' => 'object', 'properties' => [ 'PageSize' => [ 'title' => 'PageSize', 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'QualityProjectList' => [ 'title' => '质检项列表', 'description' => '质检任务列表。', 'type' => 'array', 'items' => [ 'description' => '质检任务数据。', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '质检任务状态', 'description' => '质检任务状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ServicerList' => [ 'title' => '坐席列表', 'description' => '质检抽样范围。', 'type' => 'array', 'items' => [ 'description' => '质检抽样范围:客服登录名。', 'type' => 'integer', 'format' => 'int64', 'example' => '0:555555', ], ], 'ModifyTime' => [ 'title' => '修改时间', 'description' => '修改时间。', 'type' => 'string', 'example' => '2021-04-07 18:07:19', ], 'QualityType' => [ 'title' => '质检任务类型', 'description' => '质检类型 。固定取值为**1**(咨询类)。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'DepList' => [ 'title' => '技能组分组列表', 'description' => '质检抽样范围。', 'type' => 'array', 'items' => [ 'description' => '质检抽样范围:部门列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '0:10', ], ], 'GroupList' => [ 'title' => '技能组列表', 'description' => '质检抽样范围。', 'type' => 'array', 'items' => [ 'description' => '质检抽样范围:技能组列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '0:123456', ], ], 'ProjectName' => [ 'title' => '质检任务名称', 'description' => '质检任务名称。', 'type' => 'string', 'example' => '自动化质检任务', ], 'Version' => [ 'title' => '版本', 'description' => '质检任务版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'CreateTime' => [ 'title' => 'CreateTime', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-04-07 18:07:18', ], 'Id' => [ 'title' => '质检任务Id', 'description' => '质检任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '15977801', ], 'QualityRuleIds' => [ 'title' => '质检规则列表', 'description' => '质检项规则ID。', 'type' => 'array', 'items' => [ 'description' => '质检规则数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '5369', ], ], 'CheckFreqType' => [ 'title' => '质检任务频率', 'description' => '质检任务频率。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 'Total' => [ 'title' => 'Total', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '35', ], 'PageNo' => [ 'title' => 'PageNo', 'description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], 'Code' => [ 'title' => 'Code', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => 'Success', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"QualityProjectList\\": [\\n {\\n \\"Status\\": 0,\\n \\"ServicerList\\": [\\n 0\\n ],\\n \\"ModifyTime\\": \\"2021-04-07 18:07:19\\",\\n \\"QualityType\\": 1,\\n \\"DepList\\": [\\n 0\\n ],\\n \\"GroupList\\": [\\n 0\\n ],\\n \\"ProjectName\\": \\"自动化质检任务\\",\\n \\"Version\\": 1,\\n \\"CreateTime\\": \\"2021-04-07 18:07:18\\",\\n \\"Id\\": 15977801,\\n \\"QualityRuleIds\\": [\\n 5369\\n ],\\n \\"CheckFreqType\\": 1\\n }\\n ],\\n \\"Total\\": 35,\\n \\"PageNo\\": 1\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n \\n \\n 0\\n 1\\n 5369\\n 2021-04-07 18:07:18\\n 自动化质检任务\\n 1\\n 1\\n 15977801\\n 2021-04-07 18:07:19\\n \\n 1\\n 10\\n 35\\n \\n 200\\n true\\n","errorExample":""}]', 'title' => '获取质检任务列表', 'summary' => '调用GetQualityProjectList获取质检任务列表。', ], 'GetQualityProjectLog' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ActionTime' => [ 'type' => 'string', ], 'ActionType' => [ 'type' => 'string', ], 'ProjectCreateTime' => [ 'type' => 'string', ], 'ProjectId' => [ 'type' => 'integer', 'format' => 'int64', ], 'ActionData' => [ 'type' => 'string', ], ], ], ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'GetQualityResult' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'default' => '', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', ], ], [ 'name' => 'TouchStartTime', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'TouchEndTime', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'HitStatus', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', ], ], [ 'name' => 'GroupIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int64', ], 'required' => false, 'maxItems' => 1, ], ], [ 'name' => 'QualityRuleIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int64', ], 'required' => false, 'maxItems' => 1, ], ], [ 'name' => 'ProjectIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'integer', 'format' => 'int64', ], 'required' => false, 'maxItems' => 1, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'properties' => [ 'TotalNum' => [ 'type' => 'integer', 'format' => 'int32', ], 'PageSize' => [ 'type' => 'integer', 'format' => 'int32', ], 'QualityResultResponseList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GroupName' => [ 'type' => 'string', ], 'ProjectName' => [ 'type' => 'string', ], 'TouchStartTime' => [ 'type' => 'string', ], 'HitStatus' => [ 'type' => 'boolean', ], 'RuleId' => [ 'type' => 'string', ], 'ProjectId' => [ 'type' => 'string', ], 'TouchId' => [ 'type' => 'string', ], 'ChannelTypeName' => [ 'type' => 'string', ], 'GroupId' => [ 'type' => 'string', ], 'InstanceName' => [ 'type' => 'string', ], 'ServicerName' => [ 'type' => 'string', ], 'HitDetail' => [ 'type' => 'string', ], 'MemberName' => [ 'type' => 'string', ], 'ServicerId' => [ 'type' => 'string', ], 'ChannelType' => [ 'type' => 'string', ], 'RuleName' => [ 'type' => 'string', ], ], ], ], 'PageNo' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], 'Code' => [ 'type' => 'string', ], 'ChannelTypeName' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified parameter is invalid.', 'errorCode' => 'InvalidParameter', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'GetQualityRuleDetail' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'QualityRuleId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'properties' => [ 'RuleCreateTime' => [ 'type' => 'string', ], 'MatchType' => [ 'type' => 'integer', 'format' => 'int32', ], 'RuleId' => [ 'type' => 'integer', 'format' => 'int64', ], 'RuleTag' => [ 'type' => 'integer', 'format' => 'int32', ], 'KeyWords' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], 'Name' => [ 'type' => 'string', ], ], ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'GetQualityRuleList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'properties' => [ 'PageSize' => [ 'type' => 'integer', 'format' => 'int32', ], 'Total' => [ 'type' => 'integer', 'format' => 'int64', ], 'PageNo' => [ 'type' => 'integer', 'format' => 'int32', ], 'QualityRuleList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RuleCreateTime' => [ 'type' => 'string', ], 'MatchType' => [ 'type' => 'integer', 'format' => 'int32', ], 'RuleId' => [ 'type' => 'integer', 'format' => 'int64', ], 'RuleTag' => [ 'type' => 'integer', 'format' => 'int32', ], 'KeyWords' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], 'Name' => [ 'type' => 'string', ], ], ], ], ], ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'GetQualityRuleTagList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RuleTagName' => [ 'type' => 'string', ], 'RuleTagId' => [ 'type' => 'integer', 'format' => 'int64', ], ], ], ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'HangUpDoubleCall' => [ 'summary' => '取消双呼。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => false, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'Acid', 'in' => 'query', 'schema' => [ 'title' => '会话ID', 'description' => '会话ID。', 'type' => 'string', 'required' => false, 'example' => '68255155****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'title' => '错误信息', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'Code' => [ 'title' => '错误码', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => '是否调用成功', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n true\\n 200\\n xxxx\\n","errorExample":""}]', 'title' => '取消双呼', ], 'HangupThirdCall' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一id,用于幂等校验,可以用uuid生成', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称(坐席登录名)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', ], ], [ 'name' => 'CallId', 'in' => 'formData', 'schema' => [ 'description' => ' '."\n" .'入呼后,websocket中的acid', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', ], ], [ 'name' => 'JobId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的jobId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', ], ], [ 'name' => 'ConnectionId', 'in' => 'formData', 'schema' => [ 'description' => "\n" .'入呼后,websocket中的connId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误描述', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => ' '."\n" .'请求ID,用于跟踪错误原因', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Code' => [ 'description' => '错误编码', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', ], [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', 'title' => '挂断三方通话', 'summary' => '挂断第三方通话。', ], 'HoldCall' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一id,用于幂等校验,可以用uuid生成', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称(坐席登录名)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', ], ], [ 'name' => 'CallId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的acid', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', ], ], [ 'name' => 'JobId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的jobId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', ], ], [ 'name' => 'ConnectionId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的connId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误描述', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID,用于跟踪错误原因', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Code' => [ 'description' => '错误编码', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], [ 'errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', ], [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', 'title' => '通话保持', 'summary' => '保持通话。', ], 'InsertTaskDetail' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'OutboundTaskId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0', ], ], [ 'name' => 'CallInfos', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'string', ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'JoinThirdCall' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一id,用于幂等校验,可以用uuid生成', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID,在智能联络中心控制台上可以看到', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称(坐席登录名)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', ], ], [ 'name' => 'CallId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的acid', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', ], ], [ 'name' => 'JobId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的jobId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', ], ], [ 'name' => 'ConnectionId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的connId', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', ], ], [ 'name' => 'HoldConnectionId', 'in' => 'formData', 'schema' => [ 'description' => '入呼后,websocket中的holdConnId( 仅在双步转时传入)', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误描述', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID,用于跟踪错误原因', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Code' => [ 'description' => '错误编码', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', ], [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', 'title' => '加入三方通话', 'summary' => '将第三方加入到通话中。', ], 'ListChatRecordDetail' => [ 'summary' => '调用ListChatRecordDetail根据时间段查询在线会话详情。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'title' => 'clientToken', 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre***', ], ], [ 'name' => 'CloseTimeEnd', 'in' => 'query', 'schema' => [ 'title' => '在线挂断的时间范围', 'description' => '会话结束的时间范围右区间。时间戳格式,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614582000000', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页', 'description' => '当前页。默认为:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页数据量', 'description' => '每页大小。默认为:**500**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'default' => '500', ], ], [ 'name' => 'CloseTimeStart', 'in' => 'query', 'schema' => [ 'title' => '在线挂断的时间范围', 'description' => '会话结束的时间范围左区间。时间戳格式,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614578400000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'ResultData' => [ 'title' => 'data', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'OnePageSize' => [ 'description' => '每页大小', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'TotalPage' => [ 'description' => '总页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'CurrentPage' => [ 'description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'TotalResults' => [ 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'Data' => [ 'description' => '查询数据结果。', 'type' => 'array', 'items' => [ 'description' => '会话列表数据对象。', 'type' => 'object', 'properties' => [ 'ServicerName' => [ 'description' => '客服账号', 'type' => 'string', 'example' => '123@123.com', ], 'EndTime' => [ 'title' => '在线结束时间', 'description' => '在线结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614578410000', ], 'StartTime' => [ 'title' => '在线开始时间', 'description' => '在线开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614578400000', ], 'MessageList' => [ 'title' => '在线会话详细信息', 'description' => '在线会话详细信息列表。', 'type' => 'array', 'items' => [ 'description' => '一个会话详情。', 'type' => 'object', 'properties' => [ 'SenderName' => [ 'description' => '发送信息的账号。', 'type' => 'string', 'example' => 'account1', ], 'Content' => [ 'description' => '发送的对话内容', 'type' => 'string', 'example' => '你好', ], 'CreateTime' => [ 'description' => '信息发送时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614578400000', ], 'SenderType' => [ 'description' => '发送信息类型。取值:'."\n" .'- **1**:会员'."\n" .'- **2**:客服', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'MsgType' => [ 'description' => '信息类型。', 'type' => 'string', 'example' => 'MSG', ], ], ], ], ], ], ], ], ], 'Message' => [ 'title' => 'message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => 'code', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => 'success', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'errorCode' => 'IdempotentParameterMismatch', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultData\\": {\\n \\"OnePageSize\\": 10,\\n \\"TotalPage\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalResults\\": 100,\\n \\"Data\\": [\\n {\\n \\"ServicerName\\": \\"123@123.com\\",\\n \\"EndTime\\": 1614578410000,\\n \\"StartTime\\": 1614578400000,\\n \\"MessageList\\": [\\n {\\n \\"SenderName\\": \\"account1\\",\\n \\"Content\\": \\"你好\\",\\n \\"CreateTime\\": 1614578400000,\\n \\"SenderType\\": 2,\\n \\"MsgType\\": \\"MSG\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n 200\\n \\n 1\\n 100\\n 10\\n 10\\n \\n 123@123.com\\n 1614578400000\\n 1614578410000\\n \\n account1\\n 你好\\n 2\\n 1614578400000\\n MSG\\n \\n \\n \\n 200\\n true\\n","errorExample":""}]', 'title' => '根据时间段查询在线会话详情', 'description' => '此接口查询在某个时间段范围内完成的在线会话信息,包含会话内容。查询规则如下:'."\n" .'- 查询时间段跨度最大为1天。'."\n" .'- 如果只传了查询结束时间,则查询起始时间为结束时间前1小时。'."\n" .'- 如果只传了查询起始时间,则结束时间为起始时间后1小时。'."\n" .'- 如果都没传,则认为结束时间为当前时间,起始时间为结束时间前1小时。'."\n" .'- 如果都传了但是时间跨度大于1天,返回异常信息。', ], 'ListHotlineRecordDetail' => [ 'summary' => '根据时间段查询热线详情列表。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'title' => 'clientToken', 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre***', ], ], [ 'name' => 'CloseTimeEnd', 'in' => 'query', 'schema' => [ 'title' => '热线挂断的时间范围', 'description' => '热线挂断的开始时间。时间戳格式,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614582000000', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'title' => '当前页', 'description' => '当前页。默认为:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页数据量', 'description' => '每页大小。默认为:**100**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'default' => '100', ], ], [ 'name' => 'CloseTimeStart', 'in' => 'query', 'schema' => [ 'title' => '热线挂断的时间范围', 'description' => '热线挂断的结束时间。时间戳格式,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1614578400000', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'ResultData' => [ 'title' => 'data', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'OnePageSize' => [ 'description' => '每页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'TotalPage' => [ 'description' => '总页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'CurrentPage' => [ 'description' => '当前页。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'TotalResults' => [ 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '945', ], 'Data' => [ 'description' => '查询数据结果。', 'type' => 'array', 'items' => [ 'description' => '会话列表数据对象。', 'type' => 'object', 'properties' => [ 'ServicerName' => [ 'description' => '客服账号。', 'type' => 'string', 'example' => '123@123.com', ], 'EndTime' => [ 'title' => '热线结束时间', 'description' => '热线结束时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614578410000', ], 'StartTime' => [ 'title' => '热线开始时间', 'description' => '热线开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1614578400000', ], 'OssUrl' => [ 'title' => '热线通话录音地址', 'description' => '热线通话录音地址。', 'type' => 'string', 'example' => 'http://xxx.xxxxx/xx.wav', ], ], ], ], ], ], 'Message' => [ 'title' => 'message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Code' => [ 'title' => 'code', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => 'success', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'errorCode' => 'IdempotentParameterMismatch', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultData\\": {\\n \\"OnePageSize\\": 100,\\n \\"TotalPage\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalResults\\": 945,\\n \\"Data\\": [\\n {\\n \\"ServicerName\\": \\"123@123.com\\",\\n \\"EndTime\\": 1614578410000,\\n \\"StartTime\\": 1614578400000,\\n \\"OssUrl\\": \\"http://xxx.xxxxx/xx.wav\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n 200\\n \\n 1\\n 945\\n 10\\n 100\\n \\n 123@123.com\\n 1614578400000\\n 1614578410000\\n http://xxx.xxxxx/xx.wav\\n \\n \\n 200\\n true\\n","errorExample":""}]', 'title' => '查询热线详情列表', 'description' => '此接口查询在某个时间段范围内查询热线详细信息,包含热线通话信息。查询规则如下:'."\n" .'- 查询时间段跨度最大为1天。'."\n" .'- 如果只传了查询结束时间,则查询起始时间为结束时间前1小时。'."\n" .'- 如果只传了查询起始时间,则结束时间为起始时间后1小时。'."\n" .'- 如果都没传,则认为结束时间为当前时间,起始时间为结束时间前1小时。'."\n" .'- 如果都传了但是时间跨度大于1天,返回异常。'."\n" ."\n", ], 'ListRoles' => [ 'summary' => '调用ListRoles获取一个租户下的所有角色列表。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => [ 'title' => 'clientToken', 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'title' => '租户实例id', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => 'message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'title' => 'httpStatusCode', 'description' => '状态码。返回200表示请求成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'title' => 'data', 'description' => '角色信息。', 'type' => 'array', 'items' => [ 'description' => '数据列表。', 'type' => 'object', 'properties' => [ 'RoleGroupId' => [ 'title' => '所属角色组id', 'description' => '所属角色组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'BuId' => [ 'title' => '租户id', 'description' => '租户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Description' => [ 'title' => '角色描述', 'description' => '角色描述。', 'type' => 'string', 'example' => 'Admin', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。', 'type' => 'string', 'example' => '2020-01-03T20:25:33Z', ], 'Title' => [ 'title' => '角色名称', 'description' => '角色名称。', 'type' => 'string', 'example' => '企业管理员', ], 'RoleGroupName' => [ 'title' => '所属角色组名称', 'description' => '所属角色组名称。', 'type' => 'string', 'example' => '角色组名称', ], 'RoleId' => [ 'title' => '角色id', 'description' => '角色ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Code' => [ 'title' => '角色code', 'description' => '角色Code。', 'type' => 'string', 'example' => 'admin', ], ], ], ], 'Success' => [ 'title' => 'success', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'errorCode' => 'IdempotentParameterMismatch', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n {\\n \\"RoleGroupId\\": 0,\\n \\"BuId\\": 1,\\n \\"Description\\": \\"Admin\\",\\n \\"CreateTime\\": \\"2020-01-03T20:25:33Z\\",\\n \\"Title\\": \\"企业管理员\\",\\n \\"RoleGroupName\\": \\"角色组名称\\",\\n \\"RoleId\\": 1,\\n \\"Code\\": \\"admin\\"\\n }\\n ],\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n 200\\n \\n 1\\n 2020-01-03T20:25:33Z\\n 1\\n 企业管理员\\n admin\\n Admin\\n 0\\n 角色组名称\\n \\n true\\n","errorExample":""}]', 'title' => '获取角色列表', ], 'MakeCall' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'OuterAccountId', 'in' => 'query', 'schema' => [ 'description' => '外部账户ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456', ], ], [ 'name' => 'OuterAccountType', 'in' => 'query', 'schema' => [ 'description' => '外部账户类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ALIPAY', ], ], [ 'name' => 'CommandCode', 'in' => 'query', 'schema' => [ 'description' => '操作码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'outBound_Call', ], ], [ 'name' => 'CallingNumber', 'in' => 'query', 'schema' => [ 'description' => '主叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0571456****', ], ], [ 'name' => 'CalledNumber', 'in' => 'query', 'schema' => [ 'description' => '被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '130****0000', ], ], [ 'name' => 'ExtInfo', 'in' => 'query', 'schema' => [ 'description' => '透传业务信息。', 'type' => 'string', 'required' => false, 'example' => '{"bizId": 23323}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '是否成功。取值:'."\n" .'- **true**(成功)'."\n" .'- **false**(失败)', 'type' => 'string', 'example' => 'true', ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n true\\n 200\\n true\\n","errorExample":""}]', 'title' => '发起热线呼叫', 'summary' => '调用MakeCall发起呼叫。', ], 'QueryHotlineInQueue' => [ 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'OuterGroupId', 'in' => 'query', 'schema' => [ 'description' => '外部技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456', ], ], [ 'name' => 'OuterGroupType', 'in' => 'query', 'schema' => [ 'description' => '外部技能组类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mybank', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '热线坐席数据。', 'type' => 'string', 'example' => '{"n_online_now":10,"n_idle_now":3,"n_resttype_now":3,"n_acw_now":1}', ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"{\\\\\\"n_online_now\\\\\\":10,\\\\\\"n_idle_now\\\\\\":3,\\\\\\"n_resttype_now\\\\\\":3,\\\\\\"n_acw_now\\\\\\":1}\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n {\\"n_online_now\\":10,\\"n_idle_now\\":3,\\"n_resttype_now\\":3,\\"n_acw_now\\":1}\\n 200\\n true\\n","errorExample":""}]', 'title' => '查询队列中热线', 'summary' => '调用QueryHotlineInQueue根据技能组ID获取热线技能组坐席数据。', 'responseParamsDescription' => 'n_online_now : 在线客服量'."\n" .'n_idle_now : 空闲客服量'."\n" .'n_resttype_now: 小休客服量'."\n" .'n_acw_now : 话后处理客服量', ], 'QueryOutboundTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775700', 'minimum' => '0', 'default' => '', ], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', ], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'SkillGroup', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775700', 'minimum' => '0', ], ], [ 'name' => 'Ani', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'DepartmentId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'default' => '20', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'HttpStatusCode' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'properties' => [ 'PageSize' => [ 'type' => 'string', ], 'CurrentPage' => [ 'type' => 'string', ], 'TotalResults' => [ 'type' => 'string', ], 'List' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'type' => 'integer', 'format' => 'int32', ], 'GroupName' => [ 'type' => 'string', ], 'SkillGroup' => [ 'type' => 'integer', 'format' => 'int64', ], 'Description' => [ 'type' => 'string', ], 'EndTime' => [ 'type' => 'string', ], 'GmtModified' => [ 'type' => 'integer', 'format' => 'int64', ], 'StartTime' => [ 'type' => 'string', ], 'Creator' => [ 'type' => 'string', ], 'EndDate' => [ 'type' => 'string', ], 'Name' => [ 'type' => 'string', ], 'StartDate' => [ 'type' => 'string', ], 'CallerNum' => [ 'type' => 'string', ], 'BuId' => [ 'type' => 'integer', 'format' => 'int64', ], 'Type' => [ 'type' => 'integer', 'format' => 'int32', ], 'GmtCreate' => [ 'type' => 'integer', 'format' => 'int64', ], 'Model' => [ 'type' => 'integer', 'format' => 'int32', ], 'ExtAttrs' => [ 'type' => 'string', ], 'RetryInterval' => [ 'type' => 'integer', 'format' => 'int32', ], 'RetryTime' => [ 'type' => 'integer', 'format' => 'int32', ], 'DepartmentId' => [ 'type' => 'integer', 'format' => 'int64', ], 'Id' => [ 'type' => 'integer', 'format' => 'int64', ], 'Modifier' => [ 'type' => 'string', ], ], ], ], ], ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'string', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'QueryTaskDetail' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'OutboundTaskId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'StatusList', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'EndReasonList', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'SkillGroup', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ServicerName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ServicerId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'PriorityList', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775700', 'minimum' => '0', ], ], [ 'name' => 'Ani', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Dnis', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Sid', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'DepartmentIdList', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '1', ], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '0', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'HttpStatusCode' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'properties' => [ 'PageSize' => [ 'type' => 'string', ], 'CurrentPage' => [ 'type' => 'string', ], 'TotalResults' => [ 'type' => 'string', ], 'List' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'type' => 'integer', 'format' => 'int32', ], 'OutboundTaskId' => [ 'type' => 'integer', 'format' => 'int64', ], 'SkillGroup' => [ 'type' => 'integer', 'format' => 'int32', ], 'OutboundNum' => [ 'type' => 'integer', 'format' => 'int32', ], 'Priority' => [ 'type' => 'integer', 'format' => 'int32', ], 'GmtModified' => [ 'type' => 'integer', 'format' => 'int64', ], 'BuId' => [ 'type' => 'integer', 'format' => 'int64', ], 'MemberId' => [ 'type' => 'integer', 'format' => 'int64', ], 'GmtCreate' => [ 'type' => 'integer', 'format' => 'int64', ], 'ServicerName' => [ 'type' => 'string', ], 'EndReason' => [ 'type' => 'integer', 'format' => 'int32', ], 'Dnis' => [ 'type' => 'string', ], 'ExtAttrs' => [ 'type' => 'string', ], 'MemberName' => [ 'type' => 'string', ], 'RetryTime' => [ 'type' => 'string', ], 'DepartmentId' => [ 'type' => 'integer', 'format' => 'int64', ], 'Id' => [ 'type' => 'integer', 'format' => 'int32', ], 'ServicerId' => [ 'type' => 'integer', 'format' => 'int64', ], 'Ani' => [ 'type' => 'string', ], ], ], ], ], ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'string', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'QueryTickets' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => '实例ID。'."\n" ."\n" .'请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview),在**实例管理**中查看实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'CaseId', 'in' => 'formData', 'schema' => [ 'description' => '工单ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '223468****', ], ], [ 'name' => 'CaseType', 'in' => 'formData', 'schema' => [ 'description' => '工单类型编号(系统自动分配)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '1223', ], ], [ 'name' => 'CaseStatus', 'in' => 'formData', 'schema' => [ 'description' => '工单状态编号。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-100000', 'example' => '2', ], ], [ 'name' => 'SrType', 'in' => 'formData', 'schema' => [ 'description' => '工单模板ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '29506', ], ], [ 'name' => 'TaskStatus', 'in' => 'formData', 'schema' => [ 'description' => '任务状态。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-10000000', 'example' => '3', ], ], [ 'name' => 'ChannelId', 'in' => 'formData', 'schema' => [ 'description' => '渠道ID。', 'type' => 'string', 'required' => false, 'example' => '02acfefd3fa14049826ac1a89e1xxxxx', ], ], [ 'name' => 'ChannelType', 'in' => 'formData', 'schema' => [ 'description' => '渠道类型。取值:'."\n" .'- **0**:未填写'."\n" .'- **1**:热线'."\n" .'- **2**:在线', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-10000000', 'example' => '1', ], ], [ 'name' => 'TouchId', 'in' => 'formData', 'schema' => [ 'description' => '接触ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '15030609', ], ], [ 'name' => 'DealId', 'in' => 'formData', 'schema' => [ 'description' => '处理人ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123456', ], ], [ 'name' => 'Extra', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => '附加信息。', 'type' => 'object', 'required' => false, 'example' => '无', ], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => [ 'description' => '页大小。默认值为:**10**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'CurrentPage', 'in' => 'formData', 'schema' => [ 'description' => '当前页。默认值:**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '5000', 'minimum' => '0', 'example' => '1', 'default' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '工单信息。', 'type' => 'string', 'example' => '{ "totalResults":1 "previousPage":1 "data":[ 0:{ "serviceType":1 "lastUrgeTime":0 "queueId":0 "sopCateId":252011 "totalUrgeMemo":"" "taskGmtModified":0 "departmentId":10 "groupId":0 "channelType":1 "questionInfo":"" "templateId":0 "deadLine":0 "srType":30701 "caseId":2000000001165962}', ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"{ \\\\\\"totalResults\\\\\\":1 \\\\\\"previousPage\\\\\\":1 \\\\\\"data\\\\\\":[ 0:{ \\\\\\"serviceType\\\\\\":1 \\\\\\"lastUrgeTime\\\\\\":0 \\\\\\"queueId\\\\\\":0 \\\\\\"sopCateId\\\\\\":252011 \\\\\\"totalUrgeMemo\\\\\\":\\\\\\"\\\\\\" \\\\\\"taskGmtModified\\\\\\":0 \\\\\\"departmentId\\\\\\":10 \\\\\\"groupId\\\\\\":0 \\\\\\"channelType\\\\\\":1 \\\\\\"questionInfo\\\\\\":\\\\\\"\\\\\\" \\\\\\"templateId\\\\\\":0 \\\\\\"deadLine\\\\\\":0 \\\\\\"srType\\\\\\":30701 \\\\\\"caseId\\\\\\":2000000001165962}\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n xxxx\\n { \\"totalResults\\":1 \\"previousPage\\":1 \\"data\\":[ 0:{ \\"serviceType\\":1 \\"lastUrgeTime\\":0 \\"queueId\\":0 \\"sopCateId\\":252011 \\"totalUrgeMemo\\":\\"\\" \\"taskGmtModified\\":0 \\"departmentId\\":10 \\"groupId\\":0 \\"channelType\\":1 \\"questionInfo\\":\\"\\" \\"templateId\\":0 \\"deadLine\\":0 \\"srType\\":30701 \\"caseId\\":2000000001165962}\\n EE338D98-9BD3-4413-B165\\n true\\n","errorExample":""}]', 'title' => '查询工单', 'summary' => '调用QueryTickets接口查询工单信息。', ], 'RestartOutboundTask' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'OutboundTaskId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'string', ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'StartCallV2' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称(坐席登录名)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', ], ], [ 'name' => 'Caller', 'in' => 'formData', 'schema' => [ 'description' => '热线外呼主叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9065****', ], ], [ 'name' => 'CallerType', 'in' => 'formData', 'schema' => [ 'description' => '呼叫类型。取值:'."\n" ."\n" .'- **1**:呼入'."\n" .'- **2**:呼出', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'enum' => [ '1', '2', ], ], ], [ 'name' => 'Callee', 'in' => 'formData', 'schema' => [ 'description' => '热线外呼被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '136****1111', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Code' => [ 'description' => '状态码。返回Success表示请求成功。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n Success\\n true\\n","errorExample":""}]', 'title' => '坐席发起外呼', 'summary' => '调用StartCallV2发起外呼V2。', ], 'StartChatWork' => [ 'summary' => '调用StartChatWork设置在线坐席为上班状态。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'title' => 'instanceId', 'description' => 'AICCS实例ID。可在智能联络中心控制台上获取。', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'title' => 'accountName', 'description' => '坐席登录名。', 'type' => 'string', 'required' => true, 'example' => '123@123.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'result', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'title' => 'message', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'title' => 'requestId', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'HttpStatusCode' => [ 'title' => 'httpStatusCode', 'description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'Data' => [ 'title' => 'data', 'description' => '值为**1**代表用户切换为上班状态。', 'type' => 'string', 'example' => '1', ], 'Code' => [ 'title' => 'code', 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'title' => 'success', 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'errorCode' => 'IdempotentParameterMismatch', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"1\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n 200\\n 1\\n 200\\n true\\n","errorExample":""}]', 'title' => '设置在线坐席为上班状态', ], 'StartMicroOutbound' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ProdCode', 'in' => 'query', 'schema' => [ 'description' => '产品名称。默认取值:**aiccs**。', 'type' => 'string', 'required' => false, 'example' => 'aiccs', 'default' => 'aiccs', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '账户类型。', 'type' => 'string', 'required' => false, 'example' => 'BUC_TYPE', ], ], [ 'name' => 'AccountId', 'in' => 'query', 'schema' => [ 'description' => '账户ID。', 'type' => 'string', 'required' => false, 'example' => '223457****', ], ], [ 'name' => 'CommandCode', 'in' => 'query', 'schema' => [ 'description' => '指令Code。', 'type' => 'string', 'required' => false, 'example' => 'outBound_Call', ], ], [ 'name' => 'CallingNumber', 'in' => 'query', 'schema' => [ 'description' => '主叫号码。', 'type' => 'string', 'required' => false, 'example' => '1367123****', ], ], [ 'name' => 'CalledNumber', 'in' => 'query', 'schema' => [ 'description' => '被叫号码。', 'type' => 'string', 'required' => false, 'example' => '0571456****', ], ], [ 'name' => 'ExtInfo', 'in' => 'query', 'schema' => [ 'description' => '业务信息。', 'type' => 'string', 'required' => false, 'example' => '{"caseId":23232****}', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => '业务自定义AppName。', 'type' => 'string', 'required' => false, 'example' => 'aliyun', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'InvokeCreateTime' => [ 'description' => '发起创建时间', 'type' => 'string', 'example' => '2019-05-23 17:30:32.525', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK', ], 'InvokeCmdId' => [ 'description' => '发起命令ID。', 'type' => 'string', 'example' => '8883f165-4a0d-4da2-a2d2', ], 'CustomerInfo' => [ 'description' => '客户信息。', 'type' => 'string', 'example' => '{\\"caseId\\":2323****}', ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', ], [ 'errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"InvokeCreateTime\\": \\"2019-05-23 17:30:32.525\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"InvokeCmdId\\": \\"8883f165-4a0d-4da2-a2d2\\",\\n \\"CustomerInfo\\": \\"{\\\\\\\\\\\\\\"caseId\\\\\\\\\\\\\\":2323****}\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2019-05-23 17:30:32.525\\n EE338D98-9BD3-4413-B165\\n OK\\n 8883f165-4a0d-4da2-a2d2\\n {\\\\\\"caseId\\\\\\":2323****}\\n 200\\n","errorExample":""}]', 'title' => '发起呼叫', 'summary' => '调用StartMicroOutbound接口发起外呼请求。', ], 'SuspendOutboundTask' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'OutboundTaskId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'string', ], 'Code' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '', ], 'UpdateOuterAccount' => [ 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'OuterAccountId', 'in' => 'query', 'schema' => [ 'description' => '外部账号ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456', ], ], [ 'name' => 'OuterAccountType', 'in' => 'query', 'schema' => [ 'description' => '外部账号类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alipay', ], ], [ 'name' => 'OuterAccountName', 'in' => 'query', 'schema' => [ 'description' => '外部账号名称。', 'type' => 'string', 'required' => false, 'example' => '测试', ], ], [ 'name' => 'Avatar', 'in' => 'query', 'schema' => [ 'description' => '头像。', 'type' => 'string', 'required' => false, 'example' => 'http://****', ], ], [ 'name' => 'RealName', 'in' => 'query', 'schema' => [ 'description' => '账号真实姓名。', 'type' => 'string', 'required' => false, 'example' => '张三', ], ], [ 'name' => 'OuterDepartmentId', 'in' => 'query', 'schema' => [ 'description' => '外部部门ID', 'type' => 'string', 'required' => false, 'example' => '3', ], ], [ 'name' => 'OuterGroupIds', 'in' => 'query', 'schema' => [ 'description' => '外部技能组ID列表。多个ID用英文逗号(,)分隔。', 'type' => 'string', 'required' => false, 'example' => '["222","333","444"]', ], ], [ 'name' => 'Ext', 'in' => 'query', 'schema' => [ 'description' => '扩展字段。JSON字符串。', 'type' => 'string', 'required' => false, 'example' => '{"备注":"临时技能组"}', ], ], [ 'name' => 'OuterGroupType', 'in' => 'query', 'schema' => [ 'description' => '技能组类型。', 'type' => 'string', 'required' => false, 'example' => 'mybank', ], ], [ 'name' => 'OuterDepartmentType', 'in' => 'query', 'schema' => [ 'description' => '外部部门类型:无效部门类型。', 'type' => 'string', 'required' => false, 'example' => 'type_invalid', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '是否成功。取值:'."\n" ."\n" .'- **true**:成功'."\n" .'- **false**:失败', 'type' => 'string', 'example' => 'true', ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n true\\n 200\\n true\\n","errorExample":""}]', 'title' => '更新外部账号信息', 'summary' => '调用UpdateOuterAccount根据外部账号ID更新外部账号。', ], 'TransferCallToSkillGroup' => [ 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => [ 'description' => '客户请求唯一ID。用于幂等校验,可以用UUID生成。', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', ], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => [ 'description' => 'AICCS实例ID。'."\n" .'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的实例管理中获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', ], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => [ 'description' => '坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', ], ], [ 'name' => 'SkillGroupId', 'in' => 'formData', 'schema' => [ 'description' => '技能组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '356543', ], ], [ 'name' => 'CallId', 'in' => 'formData', 'schema' => [ 'description' => '热线会话ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', ], ], [ 'name' => 'JobId', 'in' => 'formData', 'schema' => [ 'description' => '呼入后,websocket中的jobId。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', ], ], [ 'name' => 'ConnectionId', 'in' => 'formData', 'schema' => [ 'description' => '呼入后,websocket中的connId。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', ], ], [ 'name' => 'HoldConnectionId', 'in' => 'formData', 'schema' => [ 'description' => '呼入后,websocket中的holdConnId(仅在双步转时传入)。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0', ], ], [ 'name' => 'Type', 'in' => 'formData', 'schema' => [ 'description' => '默认值为**1**。取值:'."\n" .'- **1**:单步转。'."\n" .'- **2**:双步转。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'IsSingleTransfer', 'in' => 'formData', 'schema' => [ 'description' => '默认值为**true**,取值:'."\n" .'- **true**:单步转。'."\n" .'- **false**:双步转。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Code' => [ 'description' => '错误编码。', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功。取值:'."\n" .'- **true**:成功。'."\n" .'- **false**:失败。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', ], [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', 'title' => '执行单/双步转交到技能组', 'summary' => '调用TransferCallToSkillGroup接口执行单/双步转交到技能组。', ], 'AddSkillGroup' => [ 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'OuterGroupId', 'in' => 'query', 'schema' => [ 'description' => '外部的技能组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456', ], ], [ 'name' => 'OuterGroupName', 'in' => 'query', 'schema' => [ 'description' => '外部的技能组名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '热线技能组', ], ], [ 'name' => 'OuterGroupType', 'in' => 'query', 'schema' => [ 'description' => '外部的技能组类型。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mybank', ], ], [ 'name' => 'OuterDepartmentId', 'in' => 'query', 'schema' => [ 'description' => '外部的部门ID。', 'type' => 'string', 'required' => false, 'example' => '123456', ], ], [ 'name' => 'OuterDepartmentType', 'in' => 'query', 'schema' => [ 'description' => '外部的部门类型。', 'type' => 'string', 'required' => false, 'example' => 'type_invalid', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '状态码描述。', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '创建技能组ID。', 'type' => 'string', 'example' => '123456', ], 'Code' => [ 'description' => '状态码。返回200表示请求成功。', 'type' => 'string', 'example' => '200', ], 'Success' => [ 'description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"123456\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n 123456\\n 200\\n true\\n","errorExample":""}]', 'title' => '创建技能组', 'summary' => '调用AddSkillGroup创建外部技能组。', ], 'DeleteSkillGroup' => [ 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'OuterGroupType', 'in' => 'query', 'schema' => [ 'description' => '外部技能组类型,有以下枚举值: 1:热线 2:在线'."\n" .'4:工单', 'type' => 'string', 'required' => false, 'example' => '2', ], ], [ 'name' => 'OuterGroupId', 'in' => 'query', 'schema' => [ 'description' => '外部技能组id', 'type' => 'string', 'required' => false, 'example' => '123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'type' => 'object', 'properties' => [ 'Message' => [ 'description' => '错误描述', 'type' => 'string', 'example' => 'xxxx', ], 'RequestId' => [ 'description' => '请求ID,用于跟踪错误原因', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', ], 'Data' => [ 'description' => '数据', 'type' => 'boolean', 'example' => 'true', ], 'Code' => [ 'description' => '错误编码', 'type' => 'string', 'example' => 'Success', ], 'Success' => [ 'description' => '接口调用是否成功', 'type' => 'boolean', 'example' => 'true', ], ], ], ], ], 'errorCodes' => [ 500 => [ [ 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\ntrue\\nSuccess\\ntrue","errorExample":""}]', 'title' => '删除技能组', 'summary' => '根据技能组id、技能组渠道类型,删除外部技能组。', ], ], 'endpoints' => [ [ 'regionId' => 'ap-northeast-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-2-pop', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-3', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-beijing', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-finance-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-finance-pop', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-gov-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-nu16-b01', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-edge-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-fujian', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-haidian-cm12-c01', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-bj-b01', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-finance', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-internal-prod-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-internal-test-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-internal-test-2', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-internal-test-3', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-test-306', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong-finance-pop', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-huhehaote', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-huhehaote-nebula-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-north-2-gov-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-qingdao-nebula', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-et15-b01', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-et2-b01', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-inner', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-internal-test-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-inner', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-st4-d01', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-su18-b01', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-wuhan', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-wulanchabu', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-yushanfang', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-zhangbei-na61-b01', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou-na62-a01', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-zhengzhou-nebula-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'eu-west-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'eu-west-1-oxs', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'me-east-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'rus-west-1-pop', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'aiccs.aliyuncs.com', ], [ 'regionId' => 'cn-qingdao', 'endpoint' => 'aiccs.aliyuncs.com', ], ], ];