'1.0',
'info' => ['style' => 'RPC', 'product' => 'aiccs', 'version' => '2019-10-15'],
'directories' => [
[
'children' => ['QueryAiVoiceAgentDetailNew', 'PageQueryAgentListNew', 'QueryAiVoiceAgentDetail', 'PageQueryAgentList'],
'type' => 'directory',
'title' => '通信智能体',
'id' => 452190,
],
[
'children' => ['AddInboundNumber', 'TestLargeModel', 'UpdateLargeModel', 'AddLargeModel', 'AddModelApplication', 'UpdateModelApplication', 'LlmSmartCall', 'LlmSmartCallEncrypt', 'HangupOperate', 'ListAvailableTts', 'GetCallDialogContent'],
'type' => 'directory',
'title' => '通信智能引擎',
'id' => 452191,
],
[
'children' => ['ImportOneTaskPhoneNumber', 'QueryConversationDetailInfo', 'QueryAiCallDetailPage', 'StopAiCallTask', 'CancelAiCallDetails', 'StartAiCallTask', 'UpdateAiCallTask', 'QueryAiCallTaskPage', 'QueryAiCallTaskDetail', 'ImportTaskNumberDatas', 'CreateAiCallTask'],
'type' => 'directory',
'title' => '大模型通信呼叫任务',
'id' => 452192,
],
[
'children' => ['GetAudioNoteUploadUrl', 'SubmitAudioNote'],
'type' => 'directory',
'title' => '通话智能分析',
'id' => 454807,
],
[
'children' => ['GetHotlineServiceStatistics', 'GetSkillGroupAndAgentStatusSummary', 'GetDepartmentalLatitudeAgentStatus', 'GetSkillGroupLatitudeState', 'GetAgentBasisStatus', 'GetAgentStatistics'],
'type' => 'directory',
'title' => '热线监控数据',
'id' => 452193,
],
[
'children' => ['GetOnlineServiceVolume', 'GetSeatInformation', 'GetSkillGroupServiceCapability', 'GetSkillGroupAgentStatusDetails', 'GetOnlineSeatInformation', 'GetQueueInformation'],
'type' => 'directory',
'title' => '在线监控数据',
'id' => 452194,
],
[
'children' => ['GetSkillGroupStatusTotal', 'GetAgentDetailReport'],
'type' => 'directory',
'title' => '热线报表数据',
'id' => 452195,
],
[
'children' => ['GetSkillGroupServiceStatus', 'GetAgentServiceStatus'],
'type' => 'directory',
'title' => '在线报表数据',
'id' => 452196,
],
[
'children' => ['CreateAgent', 'DeleteAgent', 'UpdateAgent', 'GetAgent', 'ListAgentBySkillGroupId', 'GetHotlineAgentStatus', 'RemoveAgentFromSkillGroup', 'GetHotlineAgentDetail'],
'type' => 'directory',
'title' => '坐席管理',
'id' => 452197,
],
[
'children' => ['CreateSkillGroup', 'UpdateSkillGroup', 'RemoveSkillGroup', 'QuerySkillGroups', 'ListSkillGroup', 'GetDepGroupTreeData'],
'type' => 'directory',
'title' => '技能组管理',
'id' => 452198,
],
[
'children' => ['CreateDepartment', 'GetAllDepartment', 'DeleteDepartment', 'UpdateDepartment'],
'type' => 'directory',
'title' => '部门管理',
'id' => 452199,
],
[
'children' => ['GenerateWebSocketSign'],
'type' => 'directory',
'title' => '通道',
'id' => 452200,
],
[
'children' => ['HotlineSessionQuery', 'GetRecordData', 'GetRecordUrl', 'DescribeRecordData'],
'type' => 'directory',
'title' => '通话详情',
'id' => 452201,
],
[
'children' => ['GetIndexCurrentValue', 'GetAgentIndexRealTime', 'GetHotlineAgentDetailReport', 'GetHotlineGroupDetailReport'],
'type' => 'directory',
'title' => '数据统计',
'id' => 452202,
],
[
'children' => ['QueryTouchList', 'GetCustomerInfo', 'GetHotlineMessageLog', 'GetHotlineCallAction'],
'type' => 'directory',
'title' => '会话数据',
'id' => 452203,
],
[
'children' => ['RobotCall', 'ListRobotCallDialog', 'ListAiccsRobot', 'ListRobotParams', 'GetCallSoundRecord', 'ListRobotNode'],
'type' => 'directory',
'title' => '机器人外呼',
'id' => 452204,
],
[
'children' => ['CreateTask', 'AttachTask', 'StartTask', 'StopTask', 'CancelTask', 'ListTask', 'ListTaskDetail', 'ListDialog'],
'type' => 'directory',
'title' => '机器人外呼任务',
'id' => 452205,
],
[
'children' => ['SendCcoSmartCall', 'SendCcoSmartCallOperate'],
'type' => 'directory',
'title' => '智能语音交互',
'id' => 452206,
],
[
'children' => ['CreateAiOutboundTask', 'CreateAiOutboundTaskBatch', 'DeleteAiOutboundTask', 'GetAiOutboundTaskBizData', 'GetAiOutboundTaskExecDetail', 'GetAiOutboundTaskDetail', 'UpdateAiOutboundTask', 'InsertAiOutboundPhoneNums', 'GetAiOutboundTaskProgress', 'StopAiOutboundTask', 'TerminateAiOutboundTask', 'GetAiOutboundTaskList', 'StartAiOutboundTask'],
'type' => 'directory',
'title' => '智能外呼任务',
'id' => 452207,
],
[
'children' => ['AddHotlineNumber', 'DeleteHotlineNumber', 'ResetHotlineNumber', 'QueryHotlineNumber', 'GetConfigNumList'],
'type' => 'directory',
'title' => '号码管理',
'id' => 452208,
],
[
'children' => ['AnswerCall', 'FinishHotlineService', 'GetNumLocation', 'GetRtcToken', 'HangupCall', 'ListHotlineRecord', 'ListOutboundPhoneNumber', 'MakeDoubleCall', 'SendHotlineHeartBeat', 'StartCall', 'StartHotlineService', 'SuspendHotlineService'],
'type' => 'directory',
'title' => '话务管理',
'id' => 452209,
],
[
'children' => [
'AddOuterAccount', 'AiccsSmartCall', 'AiccsSmartCallOperate', 'BatchCreateQualityProjects', 'ChangeChatAgentStatus', 'ChangeQualityProjectStatus', 'CreateOutboundTask', 'CreateQualityProject', 'CreateQualityRule', 'CreateThirdSsoAgent', 'DeleteOutboundTask', 'DeleteOuterAccount', 'DeleteQualityProject', 'DeleteQualityRule', 'EditQualityProject', 'EditQualityRule', 'EditQualityRuleTag', 'EncryptPhoneNum', 'FetchCall', 'GetAgentById',
'GetHotlineRuntimeInfo', 'GetHotlineWaitingNumber', 'GetInstanceList', 'GetMcuLvsIp', 'GetOutbounNumList', 'GetQualityProjectDetail', 'GetQualityProjectList', 'GetQualityProjectLog', 'GetQualityResult', 'GetQualityRuleDetail', 'GetQualityRuleList', 'GetQualityRuleTagList', 'HangUpDoubleCall', 'HangupThirdCall', 'HoldCall', 'InsertTaskDetail', 'JoinThirdCall', 'ListChatRecordDetail', 'ListHotlineRecordDetail', 'ListRoles',
'MakeCall', 'QueryHotlineInQueue', 'QueryOutboundTask', 'QueryTaskDetail', 'QueryTickets', 'RestartOutboundTask', 'StartCallV2', 'StartChatWork', 'StartMicroOutbound', 'SuspendOutboundTask', 'UpdateOuterAccount', 'TransferCallToSkillGroup', 'AddSkillGroup', 'DeleteSkillGroup', 'QueryConversationDetailInfoNew', 'LlmFullDuplexCallOperate', 'LlmSmartCallFullDuplex',
],
'type' => 'directory',
'title' => '其他',
'id' => 452210,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'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 \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE339D98-9BD3-4413-B165\\n true\\n Success\\n OK\\n 200\\n","errorExample":""}]',
'title' => '新增热线号码',
'description' => '> 热线号码仅供呼入、呼出使用。',
'changeSet' => [],
'ramActions' => [],
],
'AddInboundNumber' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'LineCode',
'in' => 'query',
'schema' => ['description' => '自定义线路Code。', 'type' => 'string', 'required' => false, 'example' => 'JILIANG_*****_TEST_NET'],
],
[
'name' => 'InboundNumbers',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '呼入号码列表。',
'type' => 'array',
'items' => ['description' => '呼入号码', 'type' => 'string', 'required' => false, 'example' => '24243248*****33'],
'required' => true,
],
],
[
'name' => 'InboundType',
'in' => 'query',
'schema' => ['description' => '线路类型。`1:云通信资源2:客户自带线路。`', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8'],
],
[
'name' => 'ApplicationCode',
'in' => 'query',
'schema' => ['description' => '大模型应用编码。', 'type' => 'string', 'required' => true, 'example' => 'DLWERWLD'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D'],
'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '错误描述', 'type' => 'string', 'example' => '号码不合法'],
'InboundNumber' => ['description' => '呼入手机号。', 'type' => 'string', 'example' => '234234238**33'],
'Result' => ['description' => '`true:添加成功 false:添加失败`', 'type' => 'boolean', 'example' => 'false'],
],
'description' => '',
],
'example' => '',
],
'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'],
'Success' => ['description' => '接口调用是否成功。'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。', 'type' => 'boolean', 'example' => 'false'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '添加呼入号码',
'summary' => '添加呼入号码',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"D6A51251-F7C4-596A-9F45-3C3219A5450D\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"Message\\": \\"号码不合法\\",\\n \\"InboundNumber\\": \\"234234238**33\\",\\n \\"Result\\": false\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]',
],
'AddLargeModel' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '255142',
'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'],
],
'parameters' => [
[
'name' => 'ModelName',
'in' => 'query',
'schema' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'required' => false, 'example' => 'Test Model Name'],
],
[
'name' => 'ModelUrl',
'in' => 'query',
'schema' => ['title' => '模型地址', 'description' => '模型地址', 'type' => 'string', 'required' => false, 'example' => 'https://xxxxxxxxxxx'],
],
[
'name' => 'AuthCode',
'in' => 'query',
'schema' => ['title' => '授权码', 'description' => '授权码', 'type' => 'string', 'required' => false, 'example' => 'sk-xxxxxxxxxxx*******xx'],
],
[
'name' => 'Temperature',
'in' => 'query',
'schema' => ['title' => '温度', 'description' => '温度', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.1'],
],
[
'name' => 'TopP',
'in' => 'query',
'schema' => ['title' => 'topP', 'description' => 'topP', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.1'],
],
[
'name' => 'TopK',
'in' => 'query',
'schema' => ['title' => 'topK', 'description' => 'topK', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'BaseModel',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '基础模型',
'description' => '基础模型',
'type' => 'array',
'items' => ['description' => '基础模型名字', 'type' => 'string', 'required' => false, 'example' => 'qwen-max'],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => '鉴权失败原因', 'type' => 'string', 'example' => 'None'],
'RequestId' => ['title' => '', 'description' => '请求ID。', 'type' => 'string', 'example' => 'B1B8E483-372F-5AA8-A4B2-CA82EC967B0C'],
'Message' => ['title' => '', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'successful'],
'Data' => ['title' => '', 'description' => '数据列表。', 'type' => 'boolean', 'example' => 'false'],
'Code' => ['title' => '', 'description' => '状态码。返回OK表示请求成功。', 'type' => 'string', 'example' => 'OK'],
'Success' => ['title' => '', 'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。', 'type' => 'boolean', 'example' => 'false'],
],
'description' => '',
],
],
],
'title' => '添加大模型网关',
'summary' => 'AddLargeModel',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"B1B8E483-372F-5AA8-A4B2-CA82EC967B0C\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": false,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]',
],
'AddModelApplication' => [
'summary' => '新增模型应用。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '254052',
'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ApplicationName',
'in' => 'query',
'schema' => ['title' => '模型应用名称', 'description' => '模型应用名称', 'type' => 'string', 'required' => true, 'example' => '测试应用'],
],
[
'name' => 'ApplicationCps',
'in' => 'query',
'schema' => ['title' => '应用并发请求数', 'description' => '应用并发请求数', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '25'],
],
[
'name' => 'ModelCode',
'in' => 'query',
'schema' => ['title' => '模型编码', 'description' => '模型编码', 'type' => 'string', 'required' => true, 'example' => '1234'],
],
[
'name' => 'ModelVersion',
'in' => 'query',
'schema' => ['title' => '模型版本', 'description' => '模型版本', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'QualificationId',
'in' => 'query',
'schema' => ['title' => '资质ID', 'description' => '资质ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '85'],
],
[
'name' => 'QualificationName',
'in' => 'query',
'schema' => ['title' => '资质名称', 'description' => '资质名称', 'type' => 'string', 'required' => false, 'example' => '测试资质'],
],
[
'name' => 'SpeechId',
'in' => 'query',
'schema' => ['title' => '话束id', 'description' => '话术ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '88'],
],
[
'name' => 'SpeechContent',
'in' => 'query',
'schema' => ['title' => '话术内容', 'description' => '话术内容', 'type' => 'string', 'required' => false, 'example' => '测试话术。'],
],
[
'name' => 'UsageDesc',
'in' => 'query',
'schema' => ['title' => '用途', 'description' => '用途', 'type' => 'string', 'required' => false, 'example' => '测试用途'],
],
[
'name' => 'DyvmsSceneName',
'in' => 'query',
'schema' => ['title' => '场景名称', 'description' => '场景名称', 'type' => 'string', 'required' => false, 'example' => '测试场景'],
],
[
'name' => 'StartWord',
'in' => 'query',
'schema' => ['title' => '开场白', 'description' => '开场白', 'type' => 'string', 'required' => true, 'example' => '你好,这是一句开场白。'],
],
[
'name' => 'StartWordType',
'in' => 'query',
'schema' => ['description' => '开场白类型', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0:文本'."\n"
.'1:录音'],
],
[
'name' => 'RecordingFile',
'in' => 'query',
'schema' => ['description' => '开场白录音音频文件地址,当开场白类型为1时必填', 'type' => 'string', 'required' => false, 'example' => 'https://xxxxxxxx.wav'],
],
[
'name' => 'Prompt',
'in' => 'query',
'schema' => ['title' => '提示词', 'description' => '提示词', 'type' => 'string', 'required' => false, 'example' => '测试提示词。'],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => ['title' => '来源', 'description' => '来源。固定值:USER。', 'type' => 'string', 'required' => false, 'example' => 'USER'],
],
[
'name' => 'TtsConfig',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => 'tts配置,包括音色、音量、音速等。',
'description' => 'tts配置,包括音色、音量、音速等。',
'type' => 'object',
'properties' => [
'VoiceCode' => ['title' => '音色code', 'description' => '音色code', 'type' => 'string', 'required' => false, 'example' => 'ddddfd'],
'MixingTemplate' => ['description' => '混音模板id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
'BackgroundEnabled' => ['description' => '是否开启背景音', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'TtsVolume' => ['title' => 'TTS 变量播放的音量。取值范围:0~100,默认值为 0。', 'description' => 'TTS 变量播放的音量。取值范围:0~100,默认值为 0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '55'],
'TtsStyle' => ['title' => '声音风格', 'description' => '声音风格', 'type' => 'string', 'required' => false, 'example' => '龙小夏'],
'ResourceId' => ['description' => '资源id', 'type' => 'string', 'required' => false, 'example' => 'example'],
'CustomerAccountId' => ['description' => '账号id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '45'],
'VoiceType' => ['title' => '声音类型', 'description' => '声音类型。'."\n"
."\n"
.'```'."\n"
.'SYSTEM:系统音色'."\n"
.'COSYCLONE:复刻音色'."\n"
.'BL-CUSTOM:定制精品复刻音色'."\n"
.'```', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM'],
'MixingEnabled' => ['description' => '是否开启混音', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'TtsSpeed' => ['title' => 'TTS 变量播放时的声音速度。取值范围:-200~200,默认值为 0。', 'description' => 'TTS 变量播放时的声音速度。取值范围:-200~200,默认值为 0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13'],
'BackgroundSound' => ['description' => '背景音id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
'BackgroundVolume' => ['description' => '背景音音量', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0:low'."\n"
.'1:medium'."\n"
.'2:high'],
],
'required' => true,
'example' => '',
],
],
[
'name' => 'MuteDuration',
'in' => 'query',
'schema' => ['title' => '静音时长', 'description' => '静音时长', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '70'],
],
[
'name' => 'MuteActive',
'in' => 'query',
'schema' => ['title' => '第一个静音是否唤起模型', 'description' => '第一个静音是否唤起模型', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'MuteHangupNum',
'in' => 'query',
'schema' => ['title' => '连续多少个静音事件主动挂机', 'description' => '连续多少个静音事件主动挂机', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5'],
],
[
'name' => 'CallConnectedTriggerModel',
'in' => 'query',
'schema' => ['description' => '是否开启通话接通事件推送,默认关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
'RequestId' => ['title' => '', 'description' => '请求ID。', 'type' => 'string', 'example' => '8C93B345-F702-5449-BA7E-7D110D4BF798'],
'Message' => ['title' => '', 'description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
'Data' => ['title' => '', 'description' => '返回数据,应用Code。', 'type' => 'string', 'example' => '325****2D2'],
'Code' => ['title' => '', 'description' => '状态码。返回OK表示请求成功。', 'type' => 'string', 'example' => 'OK'],
'Success' => ['title' => '', 'description' => '调用接口是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建大模型应用',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"8C93B345-F702-5449-BA7E-7D110D4BF798\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"325****2D2\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'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', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"123456\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n 123456\\n 200\\n true\\n","errorExample":""}]',
'title' => '添加外部关联账户',
'summary' => '调用AddOuterAccount添加外部账号。',
'changeSet' => [
['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"123456\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n 123456\\n 200\\n true\\n","errorExample":""}]',
'title' => '创建技能组',
'summary' => '调用AddSkillGroup创建外部技能组。',
'changeSet' => [
['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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', 'description' => '权限不足,请联系主账号管理员'],
['errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', 'description' => '参数错误'],
],
],
'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",
'changeSet' => [
['createdAt' => '2021-06-23T02:52:00.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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', 'description' => '权限不足,请联系主账号管理员'],
['errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', 'description' => '参数错误'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n A90E4451-FED7-49D2-87C8-00700A8C4D0D\\n true\\n OK\\n","errorExample":""}]',
'title' => '发起智能语音指定动作',
'summary' => '调用AiccsSmartCallOperate接口在智能外呼通话中,发起指定动作,仅用于并行转人工,人工坐席可旁听人机对话等场景。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AiccsSmartCallOperate'],
],
],
'ramActions' => [],
],
'AnswerCall' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => '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', 'description' => '没有发现租户实例'],
['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nxxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue\\n","errorExample":""}]',
'title' => '接听来电',
'summary' => '调用AnswerCall接听来电。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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', 'description' => '权限不足,请联系主账号管理员'],
['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => '参数错误'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 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频率也会触发流控。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachTask'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'aiccs:AttachTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'BatchCreateQualityProjects' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => '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', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"\\",\\n \\"Version\\": 0,\\n \\"ProjectId\\": 0\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CancelAiCallDetails' => [
'summary' => '呼叫任务取消呼叫,如明细记录已经进入待呼队列或者正在呼叫,则无法取消。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '任务ID。在**呼叫任务管理**界面查看任务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。在**呼叫任务管理**>**详情**>**执行记录**>**已完成**>**通话详情**界面左上角查看任务明细ID或通过[QueryAiCallDetailPage](~~2926853~~)接口获取任务明细ID。', 'type' => 'string', 'required' => false, 'example' => '12131231*****'],
'required' => false,
],
],
[
'name' => 'BatchId',
'in' => 'query',
'schema' => ['description' => '批次ID。即为导入被叫数据时返回的批次ID,在**呼叫任务管理**>**详情**>**执行记录**界面查看任务批次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' => '',
],
],
],
'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'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"46C98E28-9239-5D95-AC76-648B8FD4889A\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 50,\\n \\"FailedDetails\\": {\\n \\"176********\\": \\"明细记录当前状态不可取消\\"\\n },\\n \\"FailedCount\\": 75,\\n \\"SucceedCount\\": 81,\\n \\"ResultCode\\": \\"PART_FAILED\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]',
'title' => '取消呼叫任务',
'description' => '- 您可调用此接口取消呼叫任务,也可在**呼叫任务管理**>**管理**>**执行记录**>**待完成**界面手动取消呼叫任务。'."\n"
."\n"
.'- 调用此接口之前,请确保您已创建呼叫任务且已导入被叫数据。'."\n"
."\n"
.'- 若您没有已创建的呼叫任务,可在呼叫任务管理界面创建呼叫任务并导入被叫数据,或通过[CreateAiCallTask](~~2926796~~)、[ImportTaskNumberDatas](~~2926815~~)接口创建呼叫任务并导入被叫数据。'."\n"
."\n"
.'- 呼叫任务取消呼叫后,可能会对您的业务造成影响,请谨慎操作。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelAiCallDetails'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'aiccs:CancelAiCallDetails',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CancelTask' => [
'summary' => '取消智能联络机器人呼叫任务。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => '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', 'description' => '权限不足,请联系主账号管理员'],
['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => '参数错误'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\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频率也会触发流控。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'aiccs:CancelTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ChangeChatAgentStatus' => [
'summary' => '调用ChangeChatAgentStatus修改在线客服状态。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'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', 'description' => ''],
],
],
'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' => '> 目前仅支持将在线客服状态修改为下班状态。',
'changeSet' => [],
'ramActions' => [],
],
'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', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'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.', 'description' => '没有找到技能组分组'],
['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => '没有发现租户实例'],
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"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频率也会触发流控。',
'changeSet' => [
['createdAt' => '2025-05-13T03:55:53.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'aiccs:CreateAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateAiCallTask' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'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`代表结束时间,仅处于这个时间段内的时刻才会发起呼出调度,否则将等待下一个可调度是间段到来。'."\n"
."\n"
.'> - 根据运营商政策要求,最终执行时间以平台调度为准,您可通过[真实号管理](https://dyvms.console.aliyun.com/number/list/normal)查看号码限呼时段。', 'type' => 'string', 'required' => false, 'example' => '{"startTime":"09:00:00","endTime":"10:00:00"}'."\n"],
'required' => true,
],
],
[
'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' => ['description' => '创建来源:取值'."\n"
."\n"
.'- 0:智能体创建'."\n"
."\n"
.'- 1:引擎创建', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
],
[
'name' => 'ApplicationCode',
'in' => 'query',
'schema' => ['description' => '应用code,创建来源为引擎创建时使用', 'type' => 'string', 'required' => false, 'example' => '025****C98'],
],
[
'name' => 'PhoneType',
'in' => 'query',
'schema' => ['description' => '号码类型(创建来源为引擎创建时使用)'."\n"
."\n"
.'- 0:阿里云号码'."\n"
."\n"
.'- 1:客户自带线路', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
],
[
'name' => 'LineEncoding',
'in' => 'query',
'schema' => ['description' => '线路编码', 'type' => 'string', 'required' => false, 'example' => 'JILIANG_***_***_NET'],
],
[
'name' => 'LinePhoneNum',
'in' => 'query',
'schema' => ['description' => '自带线路号码', 'type' => 'string', 'required' => false, 'example' => '152****3120'],
],
],
'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'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建呼叫任务',
'summary' => '创建呼叫任务。',
'description' => '在创建呼叫任务之前,请先使用智能体进行拨测以确认效果符合您的要求。',
'changeSet' => [
['createdAt' => '2025-12-24T09:12:26.000Z', 'description' => 'OpenAPI 下线'],
['createdAt' => '2025-12-24T08:27:56.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8C93B345-F702-5449-BA7E-7D110D4BF798\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'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频率也会触发流控。',
'changeSet' => [],
'ramActions' => [],
],
'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频率也会触发流控。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAiOutboundTaskBatch'],
],
],
'ramActions' => [],
],
'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', 'description' => '系统错误,请联系管理员!'],
],
],
'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频率也会触发流控。',
'changeSet' => [
['createdAt' => '2021-06-01T12:37:29.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDepartment'],
],
],
'ramActions' => [],
],
'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', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'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', 'description' => '传入参数不正确'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"\\",\\n \\"Version\\": 0,\\n \\"ProjectId\\": 0\\n },\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CreateQualityRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => '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', 'description' => '传入参数不正确'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CreateSkillGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'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', 'description' => '当前实例不可用或不存在'],
['errorMessage' => 'The specified department is unavailable or does not exist.', 'errorCode' => 'Department.NotFound', 'description' => ''],
],
],
'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频率也会触发流控。',
'changeSet' => [
['createdAt' => '2021-05-21T09:25:21.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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', 'description' => '权限不足,请联系主账号管理员'],
['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => '参数错误'],
],
],
'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频率也会触发流控。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'aiccs:CreateTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateThirdSsoAgent' => [
'summary' => '根据用户账号创建免登到客服工作台的坐席。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => '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', 'description' => ''],
],
],
'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' => '创建免登到客服工作台的坐席',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateThirdSsoAgent'],
],
],
'ramActions' => [],
],
'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.', 'description' => '没有找到指定坐席'],
['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => '没有发现租户实例'],
['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\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频率也会触发流控。',
'changeSet' => [
['createdAt' => '2025-05-14T01:41:39.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'aiccs:DeleteAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeleteAiOutboundTask' => [
'summary' => '根据实例ID、任务ID删除智能外呼任务。删除后,获取外呼任务列表时无法获取到该任务。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'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频率也会触发流控。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAiOutboundTask'],
],
],
'ramActions' => [],
],
'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', 'description' => '指定部门不存在'],
],
500 => [
['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"Message\\": \\"seccessful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\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频率也会触发流控。',
'changeSet' => [
['createdAt' => '2021-06-01T12:37:29.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDepartment'],
],
],
'ramActions' => [],
],
'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 \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 98B032F5-6473-4EAC-8BA8-C28993513A1F\\n true\\n Success\\n OK\\n 200\\n","errorExample":""}]',
'title' => '删除配置的热线号码',
'changeSet' => [
['createdAt' => '2021-06-22T12:36:22.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHotlineNumber'],
],
],
'ramActions' => [],
],
'DeleteOutboundTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => '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', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteOuterAccount' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'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', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n xxxx\\n EE338D98-9BD3-4413-B165\\n true\\n 200\\n true\\n","errorExample":""}]',
'title' => '删除外部账号',
'summary' => '调用DeleteOuterAccount根据外部账号ID删除外部账号。',
'changeSet' => [
['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DeleteQualityProject' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'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', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteQualityRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => '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', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteSkillGroup' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'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', 'description' => '系统错误,请联系管理员!'],
],
],
'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、技能组渠道类型,删除外部技能组。',
'changeSet' => [
['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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', 'description' => '权限不足,请联系主账号管理员'],
['errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', 'description' => '参数错误'],
],
],
'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接口获取通话信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'aiccs:DescribeRecordData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'EditQualityProject' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => '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', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"\\",\\n \\"Version\\": 0,\\n \\"ProjectId\\": 0\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'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', 'description' => '传入参数不正确'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'EditQualityRuleTag' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'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', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'EncryptPhoneNum' => [
'summary' => '调用EncryptPhoneNum将用户手机号码进行加密。',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => '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', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": \\"20nJ****/9Fl/kxx/***7\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n EE338D98-9BD3-4413-B165\\n true\\n 200\\n xxxx\\n 20nJ****/9Fl/kxx/***7\\n","errorExample":""}]',
'title' => '将用户手机号码进行加密',
'changeSet' => [
['createdAt' => '2021-04-25T12:05:56.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EncryptPhoneNum'],
],
],
'ramActions' => [],
],
'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', 'description' => '没有找到指定坐席'],
['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => '没有发现租户实例'],
['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]',
'title' => '取回通话信息',
'summary' => '取回\\恢复通话。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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', 'description' => '没有发现租户实例'],
['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"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频率也会触发流控。',
'changeSet' => [
['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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', 'description' => '没有找到指定坐席'],
['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => '没有发现租户实例'],
['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"dnthF_oinHg7JMJDmKqex3UxDD7\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\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频率也会触发流控。',
'changeSet' => [
['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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', 'description' => '没有找到指定坐席'],
['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => '没有发现租户实例'],
['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => '系统错误,请联系管理员!'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"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频率也会触发流控。',
'changeSet' => [
['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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