'1.0', 'info' => ['style' => 'RPC', 'product' => 'aiccs', 'version' => '2019-10-15'], 'directories' => [ [ 'children' => ['QueryAiVoiceAgentDetailNew', 'PageQueryAgentListNew', 'QueryAiVoiceAgentDetail', 'PageQueryAgentList'], 'type' => 'directory', 'title' => 'Communication agent', ], [ 'children' => ['AddInboundNumber', 'TestLargeModel', 'UpdateLargeModel', 'AddLargeModel', 'AddModelApplication', 'UpdateModelApplication', 'LlmSmartCall', 'LlmSmartCallEncrypt', 'HangupOperate', 'ListAvailableTts', 'GetCallDialogContent'], 'type' => 'directory', 'title' => 'Communication Intelligence Engine', ], [ 'children' => ['ImportOneTaskPhoneNumber', 'QueryConversationDetailInfo', 'QueryAiCallDetailPage', 'StopAiCallTask', 'CancelAiCallDetails', 'StartAiCallTask', 'UpdateAiCallTask', 'QueryAiCallTaskPage', 'QueryAiCallTaskDetail', 'ImportTaskNumberDatas', 'CreateAiCallTask'], 'type' => 'directory', 'title' => 'Large model call task', ], [ 'children' => ['GetHotlineServiceStatistics', 'GetSkillGroupAndAgentStatusSummary', 'GetDepartmentalLatitudeAgentStatus', 'GetSkillGroupLatitudeState', 'GetAgentBasisStatus', 'GetAgentStatistics'], 'type' => 'directory', 'title' => 'Hotline monitoring data', ], [ 'children' => ['GetOnlineServiceVolume', 'GetSeatInformation', 'GetSkillGroupServiceCapability', 'GetSkillGroupAgentStatusDetails', 'GetOnlineSeatInformation', 'GetQueueInformation'], 'type' => 'directory', 'title' => 'Online monitoring data', ], [ 'children' => ['GetSkillGroupStatusTotal', 'GetAgentDetailReport'], 'type' => 'directory', 'title' => 'Hotline Report Data', ], [ 'children' => ['GetSkillGroupServiceStatus', 'GetAgentServiceStatus'], 'type' => 'directory', 'title' => 'online report data', ], [ 'children' => ['CreateAgent', 'DeleteAgent', 'UpdateAgent', 'GetAgent', 'ListAgentBySkillGroupId', 'GetHotlineAgentStatus', 'RemoveAgentFromSkillGroup', 'GetHotlineAgentDetail'], 'type' => 'directory', 'title' => 'Agent management', ], [ 'children' => ['CreateSkillGroup', 'UpdateSkillGroup', 'RemoveSkillGroup', 'QuerySkillGroups', 'ListSkillGroup', 'GetDepGroupTreeData'], 'type' => 'directory', 'title' => 'Skill Group Management', ], [ 'children' => ['CreateDepartment', 'GetAllDepartment', 'DeleteDepartment', 'UpdateDepartment'], 'type' => 'directory', 'title' => 'Department Management', ], [ 'children' => ['GenerateWebSocketSign'], 'type' => 'directory', 'title' => 'Channel', ], [ 'children' => ['HotlineSessionQuery', 'GetRecordData', 'GetRecordUrl', 'DescribeRecordData'], 'type' => 'directory', 'title' => 'Call Details', ], [ 'children' => ['GetIndexCurrentValue', 'GetAgentIndexRealTime', 'GetHotlineAgentDetailReport', 'GetHotlineGroupDetailReport'], 'type' => 'directory', 'title' => 'Data statistics', ], [ 'children' => ['QueryTouchList', 'GetCustomerInfo', 'GetHotlineMessageLog', 'GetHotlineCallAction'], 'type' => 'directory', 'title' => 'Session data', ], [ 'children' => ['RobotCall', 'ListRobotCallDialog', 'ListAiccsRobot', 'ListRobotParams', 'GetCallSoundRecord', 'ListRobotNode'], 'type' => 'directory', 'title' => 'Automated outbound calls', ], [ 'children' => ['CreateTask', 'AttachTask', 'StartTask', 'StopTask', 'CancelTask', 'ListTask', 'ListTaskDetail', 'ListDialog'], 'type' => 'directory', 'title' => 'Automated outbound calling', ], [ 'children' => ['CreateAiOutboundTask', 'CreateAiOutboundTaskBatch', 'DeleteAiOutboundTask', 'GetAiOutboundTaskBizData', 'GetAiOutboundTaskExecDetail', 'GetAiOutboundTaskDetail', 'UpdateAiOutboundTask', 'InsertAiOutboundPhoneNums', 'GetAiOutboundTaskProgress', 'StopAiOutboundTask', 'TerminateAiOutboundTask', 'GetAiOutboundTaskList', 'StartAiOutboundTask'], 'type' => 'directory', 'title' => 'Intelligent outbound call tasks', ], [ 'children' => ['AddHotlineNumber', 'DeleteHotlineNumber', 'ResetHotlineNumber', 'QueryHotlineNumber', 'GetConfigNumList'], 'type' => 'directory', 'title' => 'Number Management', ], [ 'children' => ['AnswerCall', 'FinishHotlineService', 'GetNumLocation', 'GetRtcToken', 'HangupCall', 'ListHotlineRecord', 'ListOutboundPhoneNumber', 'MakeDoubleCall', 'SendHotlineHeartBeat', 'StartCall', 'StartHotlineService', 'SuspendHotlineService'], 'type' => 'directory', 'title' => 'Call management', ], [ 'children' => [ 'AddOuterAccount', 'AddSkillGroup', 'AiccsSmartCall', 'AiccsSmartCallOperate', 'BatchCreateQualityProjects', 'ChangeChatAgentStatus', 'ChangeQualityProjectStatus', 'CreateOutboundTask', 'CreateQualityProject', 'CreateQualityRule', 'CreateThirdSsoAgent', 'DeleteOutboundTask', 'DeleteOuterAccount', 'DeleteQualityProject', 'DeleteQualityRule', 'DeleteSkillGroup', 'EditQualityProject', 'EditQualityRule', 'EditQualityRuleTag', 'EncryptPhoneNum', 'FetchCall', 'GetAgentById', 'GetAudioNoteUploadUrl', 'GetHotlineRuntimeInfo', 'GetHotlineWaitingNumber', 'GetInstanceList', 'GetMcuLvsIp', 'GetOutbounNumList', 'GetQualityProjectDetail', 'GetQualityProjectList', 'GetQualityProjectLog', 'GetQualityResult', 'GetQualityRuleDetail', 'GetQualityRuleList', 'GetQualityRuleTagList', 'HangUpDoubleCall', 'HangupThirdCall', 'HoldCall', 'InsertTaskDetail', 'JoinThirdCall', 'ListChatRecordDetail', 'ListHotlineRecordDetail', 'ListRoles', 'LlmFullDuplexCallOperate', 'LlmSmartCallFullDuplex', 'MakeCall', 'QueryConversationDetailInfoNew', 'QueryHotlineInQueue', 'QueryOutboundTask', 'QueryTaskDetail', 'QueryTickets', 'RestartOutboundTask', 'SendCcoSmartCall', 'SendCcoSmartCallOperate', 'StartCallV2', 'StartChatWork', 'StartMicroOutbound', 'SubmitAudioNote', 'SuspendOutboundTask', 'TransferCallToSkillGroup', 'UpdateOuterAccount', ], 'title' => 'Others', 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AddHotlineNumber' => [ 'summary' => 'Invoke the AddHotlineNumber API to add a hotline number.', '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' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it in the Intelligent Contact Center console.', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'HotlineNumber', 'in' => 'formData', 'schema' => ['description' => 'Hotline number.', 'example' => '05710000****', 'pattern' => '^\\d+$', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'Description', 'in' => 'formData', 'schema' => ['description' => 'Description of the number.', 'example' => '热线号码', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'EnableInbound', 'in' => 'formData', 'schema' => ['description' => 'Indicates whether the number is used for inbound calls.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], ], [ 'name' => 'InboundFlowId', 'in' => 'formData', 'schema' => ['description' => 'The IVR flow ID for inbound calls. You can obtain it on the SaaS Workbench > Channel Integration > IVR Flow Management page.', 'example' => '123456', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'EnableOutbound', 'in' => 'formData', 'schema' => ['description' => 'Whether it is used for outbound calls.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], ], [ 'name' => 'OutboundAllDepart', 'in' => 'formData', 'schema' => ['description' => 'Whether outbound calls apply to all departments under the instance.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], ], [ 'name' => 'EnableInboundEvaluation', 'in' => 'formData', 'schema' => ['description' => 'Whether inbound satisfaction evaluation is enabled.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], ], [ 'name' => 'EnableOutboundEvaluation', 'in' => 'formData', 'schema' => ['description' => 'Indicates whether outbound call satisfaction evaluation is enabled.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], ], [ 'name' => 'EvaluationLevel', 'in' => 'formData', 'schema' => [ 'description' => 'Satisfaction Level. Valid values: '."\n" ."\n" .'- **2**: Two-level (Satisfied, Not satisfied) '."\n" .'- **3**: Three-level (Satisfied, Neutral, Not satisfied) '."\n" .'- **4**: Four-level (Very satisfied, Satisfied, Neutral, Not satisfied) '."\n" .'- **5**: Five-level (Very satisfied, Satisfied, Neutral, Not satisfied, Very poor)', 'example' => '2', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer', 'enum' => ['2', '3', '4', '5'], ], ], [ 'name' => 'OutboundRangeList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Outbound call effective scope.', 'items' => [ 'description' => 'Outbound call effective scope.', 'properties' => [ 'GroupIdList' => [ 'description' => 'List of effective skill groups. '."\n" .'> If the skill group list is empty, the setting applies to the entire department. Otherwise, it applies only to the specified skill groups under the department.', 'items' => ['description' => 'Skill group ID.', 'example' => '1234', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, 'title' => '', 'type' => 'array', 'example' => '', ], 'DepartmentId' => ['description' => 'Effective department ID.', 'example' => '123456', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], 'required' => false, 'type' => 'object', 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'type' => 'array', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE339D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'title' => '', 'type' => 'string'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'example' => '200', 'format' => 'int64', 'title' => '', 'type' => 'integer'], 'Code' => ['description' => 'The status code. A value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'title' => '', 'type' => 'string'], 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], 'title' => 'Schema of Response', 'type' => 'object', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Add Hotline Number', 'description' => '> Hotline numbers are for inbound and outbound calls only.', 'changeSet' => [ ['createdAt' => '2021-06-22T12:36:22.000Z', 'description' => 'OpenAPI offline'], ], 'ramActions' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddHotlineNumber'], ], ], ], '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' => 'The code for the custom line.', 'type' => 'string', 'required' => false, 'example' => 'JILIANG_*****_TEST_NET', 'title' => ''], ], [ 'name' => 'InboundNumbers', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The inbound number.', 'type' => 'string', 'required' => false, 'example' => '24243248*****33', 'title' => ''], 'required' => true, 'description' => 'A list of inbound numbers.', 'title' => '', 'example' => '', ], ], [ 'name' => 'InboundType', 'in' => 'query', 'schema' => ['description' => 'The line type. Valid values: `1` (cloud communication resource) and `2` (customer-owned line).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8', 'title' => ''], ], [ 'name' => 'ApplicationCode', 'in' => 'query', 'schema' => ['description' => 'The code of the large model application.', 'type' => 'string', 'required' => true, 'example' => 'DLWERWLD', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about why access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D', 'title' => ''], 'Message' => ['description' => 'The status code description.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => '号码不合法', 'title' => ''], 'InboundNumber' => ['description' => 'The inbound number.', 'type' => 'string', 'example' => '234234238**33', 'title' => ''], 'Result' => ['description' => 'Indicates whether the number was added successfully. `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', 'description' => 'The returned data.', 'title' => '', ], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" ."\n" .'- **true**: The call succeeded.'."\n" ."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => 'The response object.', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AddInboundNumber', 'summary' => 'Adds one or more inbound numbers.', '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' => ['description' => 'The model name.', 'type' => 'string', 'required' => false, 'example' => 'Test Model Name', 'title' => ''], ], [ 'name' => 'ModelUrl', 'in' => 'query', 'schema' => ['description' => 'The model URL.', 'type' => 'string', 'required' => false, 'example' => 'https://xxxxxxxxxxx', 'title' => ''], ], [ 'name' => 'AuthCode', 'in' => 'query', 'schema' => ['description' => 'The authorization code.', 'type' => 'string', 'required' => false, 'example' => 'sk-xxxxxxxxxxx*******xx', 'title' => ''], ], [ 'name' => 'Temperature', 'in' => 'query', 'schema' => ['description' => 'The temperature.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.1', 'title' => ''], ], [ 'name' => 'TopP', 'in' => 'query', 'schema' => ['description' => 'The `top-p` value.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.1', 'title' => ''], ], [ 'name' => 'TopK', 'in' => 'query', 'schema' => ['description' => 'The `top-k` value.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'BaseModel', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The base model.', 'type' => 'array', 'items' => ['description' => 'The base model name.', 'type' => 'string', 'required' => false, 'example' => 'qwen-max', 'title' => ''], 'required' => false, 'example' => '', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The reason for the authentication failure.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'B1B8E483-372F-5AA8-A4B2-CA82EC967B0C'], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Data' => ['description' => 'The result of the operation.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'Code' => ['description' => 'The status code. A value of `OK` indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request succeeded.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'AddLargeModel', 'summary' => 'Adds a large language model.', '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' => 'Add a model application', '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' => ['description' => 'The name of the model application.', 'type' => 'string', 'required' => true, 'example' => '测试应用', 'title' => ''], ], [ 'name' => 'ApplicationCps', 'in' => 'query', 'schema' => ['description' => 'The number of concurrent requests per second (CPS).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '25', 'title' => ''], ], [ 'name' => 'ModelCode', 'in' => 'query', 'schema' => ['description' => 'The model code.', 'type' => 'string', 'required' => true, 'example' => '1234', 'title' => ''], ], [ 'name' => 'ModelVersion', 'in' => 'query', 'schema' => ['description' => 'The model version.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'QualificationId', 'in' => 'query', 'schema' => ['description' => 'The qualification ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '85', 'title' => ''], ], [ 'name' => 'QualificationName', 'in' => 'query', 'schema' => ['description' => 'The name of the qualification.', 'type' => 'string', 'required' => false, 'example' => '测试资质', 'title' => ''], ], [ 'name' => 'SpeechId', 'in' => 'query', 'schema' => ['description' => 'The speech script ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '88', 'title' => ''], ], [ 'name' => 'SpeechContent', 'in' => 'query', 'schema' => ['description' => 'The speech script content.', 'type' => 'string', 'required' => false, 'example' => '测试话术。', 'title' => ''], ], [ 'name' => 'UsageDesc', 'in' => 'query', 'schema' => ['description' => 'The purpose of the application.', 'type' => 'string', 'required' => false, 'example' => '测试用途', 'title' => ''], ], [ 'name' => 'DyvmsSceneName', 'in' => 'query', 'schema' => ['description' => 'The scene name.', 'type' => 'string', 'required' => false, 'example' => '测试场景', 'title' => ''], ], [ 'name' => 'StartWord', 'in' => 'query', 'schema' => ['description' => 'The opening line.', 'type' => 'string', 'required' => true, 'example' => '你好，这是一句开场白。', 'title' => ''], ], [ 'name' => 'StartWordType', 'in' => 'query', 'schema' => ['description' => 'The type of the opening line.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0：文本'."\n" .'1：录音', 'title' => ''], ], [ 'name' => 'RecordingFile', 'in' => 'query', 'schema' => ['description' => 'The URL of the audio file for the opening line. This parameter is required if `StartWordType` is set to `1`.', 'type' => 'string', 'required' => false, 'example' => 'https://xxxxxxxx.wav', 'title' => ''], ], [ 'name' => 'Prompt', 'in' => 'query', 'schema' => ['description' => 'The prompt.', 'type' => 'string', 'required' => false, 'example' => '测试提示词。', 'title' => ''], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => ['description' => 'The source. The value must be `USER`.', 'type' => 'string', 'required' => false, 'example' => 'USER', 'title' => ''], ], [ 'name' => 'TtsConfig', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The TTS configuration, including voice, volume, speech speed, and more.', 'type' => 'object', 'properties' => [ 'VoiceCode' => ['description' => 'The voice code.', 'type' => 'string', 'required' => false, 'example' => 'ddddfd', 'title' => ''], 'MixingTemplate' => ['description' => 'The mixing template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], 'BackgroundEnabled' => ['description' => 'Specifies whether to enable background sound.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'TtsVolume' => ['description' => 'The volume for TTS playback. Valid values: 0–100. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '55', 'title' => ''], 'TtsStyle' => ['description' => 'The voice style.', 'type' => 'string', 'required' => false, 'example' => '龙小夏', 'title' => ''], 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'CustomerAccountId' => ['description' => 'The account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '45', 'title' => ''], 'VoiceType' => ['description' => 'The voice type.'."\n" ."\n" .'```'."\n" .'SYSTEM: System voice'."\n" .'COSYCLONE: Cloned voice'."\n" .'BL-CUSTOM: Premium custom cloned voice'."\n" .'```', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM', 'title' => ''], 'MixingEnabled' => ['description' => 'Specifies whether to enable mixing.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'TtsSpeed' => ['description' => 'The speech speed for TTS playback. Valid values: -200–200. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13', 'title' => ''], 'BackgroundSound' => ['description' => 'The background sound ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], 'BackgroundVolume' => ['description' => 'The background sound volume.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0：low'."\n" .'1：medium'."\n" .'2：high', 'title' => ''], ], 'required' => true, 'example' => '', 'title' => '', ], ], [ 'name' => 'MuteDuration', 'in' => 'query', 'schema' => ['description' => 'The mute duration.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '70', 'title' => ''], ], [ 'name' => 'MuteActive', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the first mute event triggers the model.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'MuteHangupNum', 'in' => 'query', 'schema' => ['description' => 'The number of consecutive mute events that trigger an automatic hang-up.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], ], [ 'name' => 'CallConnectedTriggerModel', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to push an event notification when a call is connected. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The detailed reason for the access denied error.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8C93B345-F702-5449-BA7E-7D110D4BF798'], 'Message' => ['description' => 'The message that explains the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Data' => ['description' => 'The returned application code.', 'type' => 'string', 'title' => '', 'example' => '325****2D2'], 'Code' => ['description' => 'The status code. A value of OK indicates a successful request.', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AddModelApplication', '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' => 'External Account ID.', 'docRequired' => true, 'example' => '1212', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OuterAccountType', 'in' => 'query', 'schema' => ['description' => 'External account type.', 'docRequired' => true, 'example' => 'alipay', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OuterAccountName', 'in' => 'query', 'schema' => ['description' => 'External account name.', 'example' => '测试', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'Avatar', 'in' => 'query', 'schema' => ['description' => 'Profile picture.', 'example' => 'http://****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'RealName', 'in' => 'query', 'schema' => ['description' => 'Real name of the account.', 'example' => '张三', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OuterDepartmentId', 'in' => 'query', 'schema' => ['description' => 'External department ID.', 'example' => '3', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OuterGroupIds', 'in' => 'query', 'schema' => ['description' => 'List of external skill group IDs. Separate multiple IDs with commas (,).', 'example' => '["222","333","444"]', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'Ext', 'in' => 'query', 'schema' => ['description' => 'Extension field, in JSON string format.', 'example' => '{"备注":"临时技能组"}', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OuterDepartmentType', 'in' => 'query', 'schema' => ['description' => 'External department type: Invalid department type.', 'example' => 'type_invalid', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OuterGroupType', 'in' => 'query', 'schema' => ['description' => 'Skill group type.', 'example' => 'mybank', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'Data' => ['description' => 'Created Account ID.', 'example' => '123456', 'type' => 'string', 'title' => ''], 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"123456\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Add External Associated Account', 'summary' => 'Invoke AddOuterAccount to add an external account.', 'changeSet' => [ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], ], '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 of the external skill group.', 'docRequired' => true, 'example' => '123456', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OuterGroupName', 'in' => 'query', 'schema' => ['description' => 'Name of the external skill group.', 'docRequired' => true, 'example' => '热线技能组', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OuterGroupType', 'in' => 'query', 'schema' => ['description' => 'Type of the external skill group.', 'docRequired' => true, 'example' => 'mybank', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OuterDepartmentId', 'in' => 'query', 'schema' => ['description' => 'ID of the external department.', 'example' => '123456', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OuterDepartmentType', 'in' => 'query', 'schema' => ['description' => 'Type of the external department.', 'example' => 'type_invalid', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'Data' => ['description' => 'ID of the created skill group.', 'example' => '123456', 'type' => 'string', 'title' => ''], 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"123456\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Create a Skill Group', 'summary' => 'Invoke AddSkillGroup to create an external skill group.', 'changeSet' => [ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], ], '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' => 'Product name. Default value: **aiccs**.', 'example' => 'aiccs', 'required' => false, 'type' => 'string', 'default' => 'aiccs', 'title' => ''], ], [ 'name' => 'CalledShowNumber', 'in' => 'query', 'schema' => ['description' => 'The caller ID displayed to the callee. This must be a number you have purchased.'."\n" ."\n" .'You can log on to the [Contact Center console](https://aiccs.console.aliyun.com/overview?spm=a2c4g.11186623.0.0.7f9bf9658X6jte) to view your purchased numbers.', 'example' => '0571000****', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'CalledNumber', 'in' => 'query', 'schema' => ['description' => 'Called number. Only numbers in the Chinese mainland are supported. ', 'example' => '1862222****', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'VoiceCode', 'in' => 'query', 'schema' => ['description' => 'The Intelligent Outbound Call playback audio file supports both network files and TTS. Multiple files and TTS parameters can be mixed for playback, separated by commas (,). The replacement values for TTS parameters are specified in **VoiceCodeParam**.'."\n" ."\n" .'- When the playback file is a network file: Set the VoiceCode parameter to a publicly accessible URL of the audio file. We recommend using a WAV-formatted audio file with a sampling frequency of 8000 Hz or 16000 Hz.'."\n" .'- When the playback file uses TTS: Set the VoiceCode parameter to a variable name such as $name$, and define the corresponding content for this variable in VoiceCodeParam.', 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => ['description' => 'An ID reserved for the caller. This ID will be returned to the caller in the receipt message. '."\n" .'It is a string with a length of 1 to 15 bytes.', 'example' => '222356****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'PlayTimes', 'in' => 'query', 'schema' => ['description' => 'The parameter is not supported yet.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'Volume', 'in' => 'query', 'schema' => ['description' => 'The volume for playing user audio. Valid values range from **-4 to 4**. We recommend setting it to **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'Speed', 'in' => 'query', 'schema' => ['description' => 'This parameter is not currently supported.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'AsrModelId', 'in' => 'query', 'schema' => ['description' => 'ASR model ID. You can view the ASR model ID on the [ASR Model Management page](https://aiccs.console.aliyun.com/sentence/model/private?spm=a2c4g.11186623.0.0.7f9b2964fYSGv4).', 'example' => 'bf71664d30d2478fb8cb8c39c6b6****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AsrBaseId', 'in' => 'query', 'schema' => ['description' => 'ASR foundation model.'."\n" ."\n" .'- **customer_service_8k**: Mandarin.'."\n" .'- **dialect_customer_service_8k**: Heavy accent.'."\n" ."\n" .'> - When invoking the **SendCcoSmartCall** API, you must specify an ASR model. We recommend that you provide either the **asrModelId** or **AsrBaseId** parameter.'."\n" .'- If only **asrModelId** is set, the specified ASR model is used.'."\n" .'- If only **AsrBaseId** is set, the specified ASR foundation model is used.'."\n" .'- If neither parameter is set, the default ASR foundation model is used. By default, **AsrBaseId** is **customer_service_8k**, which corresponds to the Mandarin ASR foundation model.'."\n" .'- If both parameters are set, confirm that they correctly correspond to each other.'."\n", 'example' => 'customer_service_8k', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AsrAlsAmId', 'in' => 'query', 'schema' => ['description' => 'Acoustic model ID.', 'example' => '23387****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AsrVocabularyId', 'in' => 'query', 'schema' => ['description' => 'Hotword ID. You can view the ASR hotword ID on the [ASR Hotword Management Page](https://aiccs.console.aliyun.com/sentence/vocab?spm=a2c4g.11186623.0.0.7f9bf965IKBpsi). ', 'example' => '6689****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'RecordFlag', 'in' => 'query', 'schema' => ['description' => 'Whether to record during the call.', 'example' => 'true', 'required' => false, 'type' => 'boolean', 'title' => ''], ], [ 'name' => 'PauseTime', 'in' => 'query', 'schema' => ['description' => 'Pause duration. Specifies how long the user must pause to indicate the end of a sentence. Unit: milliseconds. Valid range: **300–1200**.'."\n" ."\n" .'- If the specified value is outside this range, PauseTime defaults to **800**.'."\n" .'- Only the first setting takes effect; subsequent settings are ignored.', 'example' => '800', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'MuteTime', 'in' => 'query', 'schema' => ['description' => 'Silence duration. This parameter defines how long the call waits for user speech before ending the call. The unit is milliseconds, and valid values range from **1000 to 20000**.'."\n" ."\n" .'- If the specified value is outside this range, **MuteTime** defaults to **10000**.'."\n" .'- This parameter can be dynamically updated during the call. The last set value takes effect.', 'example' => '10000', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'ActionCodeBreak', 'in' => 'query', 'schema' => ['description' => 'Whether the initial audio playback file is interruptible. The default value is **true**, which means the initial audio playback file can be interrupted. ', 'example' => 'true', 'required' => false, 'type' => 'boolean', 'title' => ''], ], [ 'name' => 'DynamicId', 'in' => 'query', 'schema' => ['description' => 'A dynamic extension ID reserved for the caller, which is returned in the webhook address to serve as the customer\'s developer identity.', 'example' => '2234****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'EarlyMediaAsr', 'in' => 'query', 'schema' => ['description' => 'Early media speech recognition identity. When set to **true**, it records the reason why the call was not answered. Default value: **false**, meaning disabled.'."\n" ."\n" .'> To enable early media speech recognition, you must manually set this parameter to **true**.', 'example' => 'fasle', 'required' => false, 'type' => 'boolean', 'title' => ''], ], [ 'name' => 'VoiceCodeParam', 'in' => 'query', 'schema' => ['description' => 'TTS parameter string in JSON format. It must correspond to the TTS parameters of VoiceCode.', 'example' => '“{\\”name\\”:\\”喂，你好\\”}”', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'SessionTimeout', 'in' => 'query', 'schema' => ['description' => 'Maximum call duration, in seconds. The call is automatically disconnected after timeout.', 'example' => '120', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'ActionCodeTimeBreak', 'in' => 'query', 'schema' => ['description' => 'Interrupts based on the user\'s continuous speaking duration. Takes effect only when ActionCodeBreak is **true**. Unit: milliseconds.', 'example' => '120', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'TtsConf', 'in' => 'query', 'schema' => ['description' => 'Whether to configure TTS voice parameters.'."\n" .'- If set to **true**, you must use the TtsStyle, TtsVolume, and TtsSpeed parameters to define the voice style.'."\n" .'- If set to **false**, related parameters are not required and will have no effect even if configured.', 'example' => 'true', 'required' => false, 'type' => 'boolean', 'title' => ''], ], [ 'name' => 'TtsStyle', 'in' => 'query', 'schema' => ['description' => 'Voice style used during TTS variable playback. Default value: **xiaoyun**. For available styles, see the voice style list.', 'example' => 'xiaoyun', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'TtsVolume', 'in' => 'query', 'schema' => ['description' => 'The volume for TTS variable playback. Valid values range from **0 to 100**. The default value is **0**.', 'example' => '10', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'TtsSpeed', 'in' => 'query', 'schema' => ['description' => 'Speech speed when playing TTS variables. Valid values range from **-200 to 200**. The default value is **0**. ', 'example' => '100', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'EnableITN', 'in' => 'query', 'schema' => ['description' => 'Whether to execute ITN during post-processing. '."\n" ."\n" .'> When set to **true**, Chinese numerals are converted to Arabic numerals in the output. The default value is **false**. ', 'example' => 'true', 'required' => false, 'type' => 'boolean', 'default' => 'false', 'title' => ''], ], [ 'name' => 'BackgroundFileCode', 'in' => 'query', 'schema' => ['description' => 'ID of the background audio file played during the conversation between the user and the robot. '."\n" ."\n" .'You can log on to the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview), choose **Intelligent Interaction > Audio File Management**, and click **View** to check the corresponding audio ID. ', 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'BackgroundVolume', 'in' => 'query', 'schema' => ['description' => 'The parameter is not supported yet.', 'example' => '1', 'format' => 'int32', 'maximum' => '4', 'minimum' => '-4', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'BackgroundSpeed', 'in' => 'query', 'schema' => ['description' => 'This parameter is currently not supported.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Returned data. ', 'properties' => [ 'Message' => ['description' => 'Description of the status code. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'Request ID. ', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'type' => 'string', 'title' => ''], 'Data' => ['description' => 'Request status code. A return value of "OK" indicates that the request succeeded. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Code' => ['description' => 'Unique receipt ID for this call. ', 'example' => '116012854210^10281427****', 'type' => 'string', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"OK\\",\\n \\"Code\\": \\"116012854210^10281427****\\"\\n}","type":"json"}]', 'title' => 'Initiate an Intelligent Speech Interaction Call ', 'summary' => 'Invoke the AiccsSmartCall API to initiate an Intelligent Speech Interaction call.'."\n", 'requestParamsDescription' => '### Voice Style List'."\n" ."\n" .'- Xiaoyun Standard Female Voice: xiaoyun '."\n" .'- Xiaogang Standard Male Voice: xiaogang '."\n" .'- Ruoxi Gentle Female Voice: ruoxi '."\n" .'- Xiaomeng Standard Female Voice: xiaomeng '."\n" .'- Xiaowei Standard Male Voice: xiaowei '."\n" .'- Amei Sweet Female Voice: amei '."\n" .'- Xiaoxue Gentle Female Voice: xiaoxue '."\n" .'- Siqi Gentle Female Voice: siqi '."\n" .'- Sijia Standard Female Voice: sijia '."\n" .'- Sicheng Standard Male Voice: sicheng '."\n" .'- Siyue Gentle Female Voice: siyue '."\n" .'- Xiaomei Sweet Female Voice: xiaomei '."\n" .'- Sitong Standard Child Voice: sitong '."\n" .'- Ning\'er Standard Female Voice: ninger '."\n" .'- Xiaobei Loli Female Voice: xiaobei '."\n" .'- Yina Zhejiang-accented Mandarin Female Voice: yina '."\n", 'changeSet' => [ ['createdAt' => '2021-06-23T02:52:00.000Z', 'description' => 'Request parameters changed'], ], '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' => 'Product name. Default value: **aiccs**.', 'example' => 'aiccs', 'required' => false, 'type' => 'string', 'default' => 'aiccs', 'title' => ''], ], [ 'name' => 'CallId', 'in' => 'query', 'schema' => ['description' => 'Unique receipt ID of the call. You can obtain it by invoking [SendCcoSmartCall](~~311247~~).', 'example' => '116012854210^102814279****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'Command', 'in' => 'query', 'schema' => ['description' => 'Specifies the action to be initiated for the called number during an Intelligent outbound call.'."\n" ."\n" .'> Currently, only the **parallelBridge** parameter is supported, which indicates bridging the called number with a call center agent.', 'example' => 'parallelBridge', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'Param', 'in' => 'query', 'schema' => ['description' => 'Extension field.', 'example' => 'Param', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Returned data.', 'properties' => [ 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'type' => 'string', 'title' => ''], 'Data' => ['description' => 'Result of the command execution. '."\n" .'- **true**: The command executed successfully. '."\n" .'- **false**: The command failed to execute.', 'example' => 'true', 'type' => 'string', 'title' => ''], 'Code' => ['description' => 'Request status code. A return value of OK indicates that the request succeeded.', 'example' => 'OK', 'type' => 'string', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', 'title' => 'Initiate a Specified Action in Intelligent Voice', 'summary' => 'Invoke the AiccsSmartCallOperate API to initiate a specified action during an Intelligent outbound call. This API is only used for scenarios such as parallel transfer to a human agent or allowing a human agent to listen in on the man-machine dialogue.', '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' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'AICCS instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => ['description' => 'Agent account name (agent logon name).', 'docRequired' => true, 'example' => '123@123.com', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'CallId', 'in' => 'formData', 'schema' => ['description' => 'The acid from the WebSocket after an inbound call.', 'docRequired' => true, 'example' => '7719786', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'formData', 'schema' => ['description' => 'The jobId from the WebSocket after an inbound call.', 'docRequired' => true, 'example' => '7719787', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'ConnectionId', 'in' => 'formData', 'schema' => ['description' => 'The connId from the WebSocket after an inbound call.', 'docRequired' => true, 'example' => '7719788', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'properties' => [ 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'Code' => ['description' => 'Status code. A return value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Answer Incoming Call', 'summary' => 'Invoke AnswerCall to answer an incoming call.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'AttachTask' => [ 'summary' => 'Append job details.'."\n", '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' => 'The job ID. You can obtain the job ID from the [Task Management](https://aiccs.console.aliyun.com/job/list) interface.', 'example' => '12****', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '0', 'required' => true, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'CallString', 'in' => 'query', 'schema' => ['description' => 'The calling string (callee information and parameter list). Valid values:'."\n" ."\n" .'- **LIST**: Use this type when the script has no input variables. In this case, only the callee numbers need to be provided. Example: `0571****5678,0571****5679`.'."\n" .'- **JSON**: Use this type when the script includes input variables. You must provide the variable names, callee numbers, and variable values. Example: `{"ParamNames":["name","age"],"CalleeList":[{"Callee":"181****0000","Params":["Zhang San","20"]},{"Callee":"181****0001","Params":["Li Si","21"]}]}`. **ParamNames** represents the list of parameter names; **Params** represents the list of parameter values.'."\n" ."\n" .'> You can view the script input variables on the [**Script Management**](https://aiccs.console.aliyun.com/patter/list) > **View** > **Input and Output Parameters** interface.', '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" .'}', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Data' => ['description' => 'The quantity of successfully appended entries.', 'example' => '10', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Code' => ['description' => 'The request status code. A value of OK indicates that the request succeeded.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" .'- **true**: Succeeded.'."\n" .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 10,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Append Details', 'description' => '- After creating an Intelligent Contact Robot calling job, you can invoke this API to append job details.'."\n" ."\n" .'- Before invoking this API, ensure that you already have a successfully created Intelligent Contact Robot calling job.'."\n" ."\n" .'- If you do not have a successfully created Intelligent Contact Robot calling job, you can click **Create Job** on the [Task Management](https://aiccs.console.aliyun.com/job/list) interface or create a job by using the [CreateTask](~~2718003~~) API.'."\n" ."\n" .'### Queries per second (QPS) limits'."\n" .'- Per-user invocation frequency: No rate limiting.'."\n" .'- API frequency: 500 queries per second (QPS).'."\n" ."\n" .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", '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' => 'All Resource', '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, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'CheckFreqType', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'TimeRangeStart', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'TimeRangeEnd', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'AnalysisIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], [ 'name' => 'InstanceList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], [ 'name' => 'ChannelTouchType', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Version' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'ProjectId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'title' => '', 'example' => '', ], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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\\": false\\n}","type":"json"}]', 'title' => '', 'summary' => '', ], 'CancelAiCallDetails' => [ 'summary' => 'This operation cancels calls from a call task. You cannot cancel a call if its detail record is already in the pending call queue or is in progress.', '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' => 'The task ID. You can view the task ID on the **Call Task Management** page or obtain it by calling the [QueryAiCallTaskPage](~~2926799~~) operation.', 'type' => 'string', 'required' => true, 'example' => '138************'."\n", 'title' => ''], ], [ 'name' => 'DetailIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'A list of detail IDs. If you specify this parameter, `BatchId` and `PhoneNumbers` are ignored.', 'type' => 'array', 'items' => ['description' => 'The detail ID. You can find the detail ID in the upper-left corner of the page after you navigate to **Call Task Management** > **Details** > **Execution Record** > **Completed** > **Call Details**, or obtain it by calling the [QueryAiCallDetailPage](~~2926853~~) API.', 'type' => 'string', 'required' => false, 'example' => '12131231*****', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'BatchId', 'in' => 'query', 'schema' => ['description' => 'The batch ID. This ID is returned when you import callee data. You can find the task batch ID on the **Call Task Management**>**Details**>**Execution Record** page, or use the import batch ID that is returned by the [ImportTaskNumberDatas](~~2926815~~) API operation. If DetailIdList is specified, this parameter is invalid.', 'type' => 'string', 'required' => false, 'example' => '4253331213*****', 'title' => ''], ], [ 'name' => 'PhoneNumbers', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'A list of phone numbers. This parameter takes effect only when `BatchId` is also specified.', 'type' => 'array', 'items' => ['description' => 'The phone number of the call that you want to cancel. This must be a phone number from the imported callee data.', 'type' => 'string', 'required' => false, 'example' => '180*******', 'title' => ''], 'required' => false, 'example' => '', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The detailed reason why the access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => '成功', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '46C98E28-9239-5D95-AC76-648B8FD4889A', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], 'FailedDetails' => ['description' => 'Details about the failed cancellations. This is a map where the key is the failed detail ID or phone number, and the value is the reason for the failure.', 'type' => 'object', 'example' => '{'."\n" .' "176********": "明细记录当前状态不可取消"'."\n" .'}', 'title' => ''], 'FailedCount' => ['description' => 'The number of calls that could not be canceled.', 'type' => 'integer', 'format' => 'int64', 'example' => '75', 'title' => ''], 'SucceedCount' => ['description' => 'The number of calls that were successfully canceled.', 'type' => 'integer', 'format' => 'int64', 'example' => '81', 'title' => ''], 'ResultCode' => [ 'description' => 'The result code of the cancellation. Valid values:'."\n" ."\n" .'- ALL\\_FAILED: All cancellations failed.'."\n" ."\n" .'- ALL\\_SUCCEED: All cancellations succeeded.'."\n" ."\n" .'- PART\\_FAILED: Some cancellations failed.', 'enumValueTitles' => ['ALL_FAILED' => '', 'ALL_SUCCEED' => '', 'PART_FAILED' => ''], 'type' => 'string', 'example' => 'PART_FAILED', 'title' => '', ], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request succeeded.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'Cancel Calls for Communication Agent Call Jobs ', 'description' => '- Use this operation to cancel calls. Alternatively, you can manually cancel calls in the console by navigating to **Call Task Management** > **Manage** > **Execution Records** > **Pending**.'."\n" ."\n" .'- Before calling this operation, ensure you have created a call task and imported callee data.'."\n" ."\n" .'- If you have not created a call task, you can create one and import callee data on the **Call Task Management** page. You can also call the [CreateAiCallTask](~~2926815~~) and [ImportTaskNumberDatas]() operations.'."\n" ."\n" .'- Canceling a call task may affect your business. Please proceed with caution.', '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' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CancelTask' => [ 'summary' => 'Cancel an Intelligent Contact Robot calling job.'."\n", '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' => 'The unique job ID of the robot calling task. You can view it in the [Task Management](https://aiccs.console.aliyun.com/job/list) interface or obtain it by using the [CreateTask](~~223556~~) API.'."\n", 'example' => '12****', 'format' => 'int64', 'required' => true, 'type' => 'integer', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'RequestId' => ['description' => 'Request ID.'."\n", 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], 'Message' => ['description' => 'Description of the status code.'."\n", 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Data' => ['description' => 'Indicates whether the operation succeeded. Valid values:'."\n" .'- **true**: Succeeded.'."\n" .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], 'Code' => ['description' => 'Request status code. A value of OK indicates that the request succeeded.'."\n", 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API was invoked successfully. Valid values:'."\n" .'- **true**: Succeeded.'."\n" .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Cancel Job'."\n", 'description' => '- You can invoke this API to cancel an Intelligent Contact Robot calling job, or manually cancel the job in the [Task Management](https://aiccs.console.aliyun.com/job/list) interface.'."\n" ."\n" .'- After an Intelligent Contact Robot calling job is canceled, it cannot be started again. Proceed with caution.'."\n" ."\n" .'- If you want to pause a job and restart it later, you can manually pause the job in the [Task Management](https://aiccs.console.aliyun.com/job/list) interface or pause it by using the [StopTask](~~2718006~~) API.'."\n" ."\n" .'### Queries per second (QPS) limits'."\n" .'- Per-user invocation frequency: No rate limiting.'."\n" .'- API frequency: 500 queries per second (QPS).'."\n" ."\n" .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'aiccs:CancelTask', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [], ], ], 'ChangeChatAgentStatus' => [ 'summary' => 'Invoke ChangeChatAgentStatus to modify the Live Support status.', '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' => ['description' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'title' => 'clientToken', 'type' => 'string'], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => ['description' => 'Agent account.', 'example' => 'account1', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'Method', 'in' => 'formData', 'schema' => [ 'description' => 'The target online status to switch to. Currently, only **requestLogout** (request offline) is supported.', 'example' => 'requestLogout', 'required' => true, 'title' => '', 'type' => 'string', 'enum' => ['requestRest', 'requestLogout', 'restToWork'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'properties' => [ 'Message' => ['description' => 'Description of the status code.', 'example' => 'success', 'title' => 'message', 'type' => 'string'], 'RequestId' => ['description' => 'Request ID.', 'example' => 'DF6A3FB7-A5AA-43BE-A65B', 'title' => 'requestId', 'type' => 'string'], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int32', 'title' => 'httpStatusCode', 'type' => 'integer'], 'Data' => ['description' => 'Current agent status. Valid values:'."\n" .'- **0**: Offline'."\n" .'- **3**: On break', 'example' => '0', 'title' => 'data', 'type' => 'string'], 'Code' => ['description' => 'Status code.', 'example' => 'Success', 'title' => 'code', 'type' => 'string'], 'Success' => ['description' => 'Whether the API call succeeded.', 'example' => 'true', 'title' => 'success', 'type' => 'boolean'], ], 'title' => 'result', 'type' => 'object', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"DF6A3FB7-A5AA-43BE-A65B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"0\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Modify Live Support Status', 'description' => '> Currently, only changing the Live Support status to offline is supported.', 'changeSet' => [], 'ramActions' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeChatAgentStatus'], ], ], ], '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, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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\\": false\\n}","type":"json"}]', 'title' => '', 'summary' => '', ], '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' => ['description' => 'Unique ID of the customer request. Used for idempotency validation. It can be generated using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'title' => '', 'type' => 'string'], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'AICCS instance ID. '."\n" .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview). ', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'DisplayName', 'in' => 'formData', 'schema' => ['description' => 'Display name of the agent. ', 'docRequired' => true, 'example' => 'XX测试', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => 'ID of the skill group to which the agent belongs. ', 'format' => 'int64', 'items' => ['description' => 'Skill group ID.'."\n" ."\n" .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and check the **SkillGroupId** in the response parameters to obtain the skill group ID.', 'example' => '1234****', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'maxItems' => 200, 'required' => false, 'type' => 'array', 'title' => '', 'example' => '', ], ], [ 'name' => 'SkillGroupIdList', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => 'List of skill group IDs to which the agent belongs.', 'format' => 'int64', 'items' => ['description' => 'List of skill group IDs.'."\n" ."\n" .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and check the **SkillGroupId** in the response parameters to obtain the skill group ID.', 'example' => '1223****,1456****', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'maxItems' => 200, 'required' => false, 'type' => 'array', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'properties' => [ 'Message' => ['description' => 'Description of the status code. ', 'example' => 'successful', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code. ', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Data' => ['description' => 'Agent ID. ', 'example' => '2578****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Code' => ['description' => 'Status code. A value of "Success" indicates that the request succeeded. ', 'example' => 'Success', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values: '."\n" .'- **true**: Succeeded. '."\n" .'- **false**: Failed. ', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 0,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Create Agent ', 'summary' => 'Create an agent account in the Cloud Customer Service System and return the agent ID. ', 'description' => '- Before calling this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" .'- If you need to specify skill group information, refer to the guidance in [Request Parameters](#api-detail-35). '."\n" .'- You can manage agents by calling [DeleteAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-deleteagent) to delete an agent or [UpdateAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-updateagent) to update agent data. '."\n" ."\n" .'### QPS Limit'."\n" .'- Per-user call frequency: No rate limiting. '."\n" .'- API call frequency: 100 queries per second (QPS). '."\n" ."\n" .'> If the total calls from multiple users exceed the API frequency limit, throttling will be triggered. ', 'changeSet' => [ ['createdAt' => '2025-05-13T03:55:53.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aiccs:CreateAgent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', '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' => 'The name of the task. It must be unique within an account.', 'type' => 'string', 'required' => true, 'example' => '测试任务', 'title' => ''], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'The ID of a published agent.', 'type' => 'string', 'required' => false, 'example' => '1180**************'."\n", 'title' => ''], ], [ 'name' => 'VirtualNumber', 'in' => 'query', 'schema' => ['description' => 'The service instance used for outbound calls.', 'type' => 'string', 'required' => false, 'example' => '032712122*****', 'title' => ''], ], [ 'name' => 'StartType', 'in' => 'query', 'schema' => [ 'description' => 'The startup mode. Valid values:'."\n" ."\n" .'- `IMMEDIATE`: Starts the task immediately.'."\n" ."\n" .'- `SCHEDULE`: Starts the task at a scheduled time.', 'enumValueTitles' => ['SCHEDULE' => '', 'IMMEDIATE' => ''], 'type' => 'string', 'required' => true, 'example' => 'SCHEDULE', 'title' => '', ], ], [ 'name' => 'MissCallRetry', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable retry. Valid values:'."\n" ."\n" .'- `true`: Enables retry.'."\n" ."\n" .'- `false` (default): Disables retry.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', 'title' => ''], ], [ 'name' => 'CallRetryReason', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The failure reasons that trigger a retry.', 'type' => 'array', 'items' => [ 'description' => 'The specific reason for the retry. Valid values:'."\n" ."\n" .'- `CALL_REJECTED`: Call rejection.'."\n" ."\n" .'- `USER_BUSY`: User busy.'."\n" ."\n" .'- `SUSPEND`: Suspended service.'."\n" ."\n" .'- `INVALID_NUMBER`: Invalid number.'."\n" ."\n" .'- `POWERED_OFF`: Powered off.'."\n" ."\n" .'- `NETWORK_BUSY`: Network busy.'."\n" ."\n" .'- `NO_ANSWER`: No answer.', 'enumValueTitles' => ['CALL_REJECTED' => '', 'USER_BUSY' => '', 'SUSPEND' => '', 'INVALID_NUMBER' => '', 'POWERED_OFF' => '', 'NETWORK_BUSY' => '', 'NO_ANSWER' => ''], 'type' => 'string', 'required' => false, 'example' => 'CALL_REJECTED', 'title' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'CallRetryTimes', 'in' => 'query', 'schema' => ['description' => 'The number of retries. The maximum value is 3.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'CallRetryInterval', 'in' => 'query', 'schema' => ['description' => 'The retry interval, in minutes. The maximum value is 720.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '32', 'title' => ''], ], [ 'name' => 'CallTime', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The list of callable time periods.', 'type' => 'array', 'items' => ['description' => 'The callable time period, in the following JSON format:'."\n" ."\n" .'```json'."\n" .'{"startTime":"09:00:00","endTime":"10:00:00"}'."\n" .'```'."\n" ."\n" .'The system makes outbound calls only during this period. If the current time is outside the specified period, the system waits for the next callable period.'."\n" ."\n" .'> - In compliance with carrier policies, the actual execution time is subject to platform scheduling. You can view the restricted calling periods for your numbers in [Real Number Management](https://dyvms.console.aliyun.com/number/list/normal).', 'type' => 'string', 'required' => false, 'example' => '{"startTime":"09:00:00","endTime":"10:00:00"}'."\n", 'title' => ''], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'CallDay', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The list of callable days.', 'type' => 'array', 'items' => [ 'description' => 'The callable day. Valid values:'."\n" ."\n" .'- `MONDAY`: Monday.'."\n" ."\n" .'- `TUESDAY`: Tuesday.'."\n" ."\n" .'- `WEDNESDAY`: Wednesday.'."\n" ."\n" .'- `THURSDAY`: Thursday.'."\n" ."\n" .'- `FRIDAY`: Friday.'."\n" ."\n" .'- `SATURDAY`: Saturday.'."\n" ."\n" .'- `SUNDAY`: Sunday.', 'enumValueTitles' => ['WEDNESDAY' => '', 'MONDAY' => '', 'THURSDAY' => '', 'SUNDAY' => '', 'TUESDAY' => '', 'FRIDAY' => '', 'SATURDAY' => ''], 'type' => 'string', 'required' => false, 'example' => 'MONDAY', 'title' => '', ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'TaskStartTime', 'in' => 'query', 'schema' => ['description' => 'The scheduled start time for the task, specified as a timestamp in milliseconds. This parameter is required and applies only when `StartType` is set to `SCHEDULE`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12313123133', 'title' => ''], ], [ 'name' => 'TaskCps', 'in' => 'query', 'schema' => ['description' => 'The task concurrency. The maximum value is 500.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '75', 'title' => ''], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'description' => '', 'title' => ''], ], [ 'name' => 'ApplicationCode', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => '025****C98', 'description' => '', 'title' => ''], ], [ 'name' => 'PhoneType', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'description' => '', 'title' => ''], ], [ 'name' => 'LineEncoding', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => 'JILIANG_***_***_NET', 'description' => '', 'title' => ''], ], [ 'name' => 'LinePhoneNum', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => '152****3120', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The detailed reason for the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8C93B345-F702-5449-BA7E-7D110D4BF798', 'title' => ''], 'Data' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1213123123*****', 'title' => ''], 'Code' => ['description' => 'The request status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" ."\n" .'- **true**: The call succeeded.'."\n" ."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Create an outbound calling job for the Communication Intelligent Agent', 'summary' => 'Creates a call task.', 'description' => 'Before creating a call task, make a test call with an agent to ensure the results meet your requirements.', 'changeSet' => [ ['createdAt' => '2025-12-24T09:12:26.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-12-24T08:27:56.000Z', 'description' => 'OpenAPI offline'], ], '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' => 'Create an Intelligent Outbound Call Job. You can configure the Task Type, job name, outbound caller ID, callee number deduplication policy, and other settings when creating the job.', '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' => ['description' => 'AICCS instance ID. '."\n" .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'cc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'Task Type. Valid values: '."\n" .'- **2**: Predictive outbound call. '."\n" .'- **3**: Automated outbound call.', 'example' => '2', 'format' => 'int32', 'required' => true, 'title' => '', 'type' => 'integer', 'enum' => ['2', '3'], ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'Job name. Length: 1 to 15 characters.', 'example' => '测试任务', 'maxLength' => 15, 'minLength' => 1, 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'Job description. Length: 0 to 100 characters.', 'example' => '房产销售', 'maxLength' => 100, 'required' => false, 'title' => '', 'type' => 'string'], ], [ 'name' => 'OutboundNums', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Outbound caller numbers. '."\n" ."\n" .'> Must be purchased numbers. Separate multiple numbers with commas (,).', 'items' => ['description' => 'Outbound caller numbers. '."\n" ."\n" .'> Must be purchased numbers. Separate multiple numbers with commas (,).', 'example' => '["0571****5678","0571****5678"]', 'required' => true, 'type' => 'string', 'title' => ''], 'required' => true, 'title' => '', 'type' => 'array', 'example' => '', ], ], [ 'name' => 'NumRepeated', 'in' => 'query', 'schema' => [ 'description' => 'Called number deduplication policy. Valid values:'."\n" .'- **0**: Remove duplicates within the job.'."\n" .'- **1**: Do not remove duplicates.', 'example' => '1', 'format' => 'int32', 'required' => true, 'title' => '', 'type' => 'integer', 'enum' => ['0', '1'], ], ], [ 'name' => 'HandlerId', 'in' => 'query', 'schema' => ['description' => 'The skill group ID (for predictive outbound calls) or IVR ID (for automated outbound calls). You can obtain this information in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => '123456', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'ExecutionTime', 'in' => 'query', 'schema' => ['description' => 'Job execution time, in JSON format.'."\n" ."\n" .'> The end time must be later than the start time.', '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"}]}', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'ConcurrentRate', 'in' => 'query', 'schema' => ['description' => 'Concurrent call rate for automated outbound calls.', 'example' => '10', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'RecallRule', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'Failed call retry policy. '."\n" ."\n" .'> If empty, no retries are performed.', 'properties' => [ 'Count' => ['description' => 'Number of retries. Valid values: **1 to 3**.', 'example' => '1', 'format' => 'int32', 'maximum' => '3', 'minimum' => '1', 'required' => false, 'title' => '', 'type' => 'integer'], 'Interval' => ['description' => 'Retry interval. Valid values: **1 to 60**, unit: minutes.', 'example' => '1', 'format' => 'int32', 'maximum' => '60', 'minimum' => '1', 'required' => false, 'title' => '', 'type' => 'integer'], ], 'required' => false, 'title' => '', 'type' => 'object', 'example' => '', ], ], [ 'name' => 'ForecastCallRate', 'in' => 'query', 'schema' => ['description' => 'Fixed outbound ratio for predictive dialing. Valid values: **≥1**.', 'example' => '1.5', 'format' => 'float', 'maximum' => '100', 'minimum' => '1', 'required' => false, 'title' => '', 'type' => 'number'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Returned data.', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Data' => ['description' => 'Job ID.', 'example' => '123456', 'format' => 'int64', 'title' => '', 'type' => 'integer'], 'Code' => ['description' => 'Request status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values: '."\n" .'- **true**: Succeeded. '."\n" .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 123456,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Create Intelligent Outbound Call Job', 'description' => '- The **Data** field in the response parameters of this API is the job ID. '."\n" .'- After creating an Intelligent Outbound Call Job, if you need to make updates, you can invoke the [UpdateAiOutboundTask](~~2718021~~) API to update the outbound call job.'."\n" ."\n" .'### Queries per second (QPS) Limit'."\n" .'- Per-user invocation frequency: No Rate Limiting.'."\n" .'- API frequency: 20 queries per second (QPS).'."\n" ."\n" .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', 'changeSet' => [], 'ramActions' => [], 'flowControl' => [ 'flowControlList' => [], ], ], 'CreateAiOutboundTaskBatch' => [ 'summary' => 'Creates a batch for an Intelligent Outbound Calling job based on the instance ID and job ID, enabling data under the job to be queried by batch.', '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' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID.'."\n" ."\n" .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'agent_***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The job ID.'."\n" ."\n" .'You can invoke the [CreateAiOutboundTask](~~312260~~) API and view the **Data** field in the response, or invoke the [GetAiOutboundTaskList](~~2718026~~) API and view the **TaskId** field in the response.', 'example' => '123456', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], 'Message' => ['description' => 'The status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Data' => ['description' => 'The version ID of the newly created job batch.', 'example' => '123456', 'format' => 'int32', 'title' => '', 'type' => 'integer'], 'Code' => ['description' => 'The request status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" .'- **true**: Succeeded.'."\n" .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 123456,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Create a batch for an Intelligent Outbound Calling job', 'description' => 'Before invoking this API, we recommend that you confirm the instance ID and job ID. For guidance on how to obtain them, see the instructions in [Request Parameters](#api-detail-35).'."\n" .'### QPS limit'."\n" .'- Per-user invocation frequency: 20 queries per second (QPS).'."\n" .'- API-wide invocation frequency: 20 queries per second (QPS).'."\n" ."\n" .'> If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAiOutboundTaskBatch'], ], ], 'ramActions' => [], ], 'CreateDepartment' => [ 'summary' => 'Creates department information based on the Artificial Intelligence Cloud Call Service (AICCS) instance ID and department name. Upon successful creation, the department ID is returned.', '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' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'DepartmentName', 'in' => 'query', 'schema' => ['description' => 'Department name.', 'example' => '部门A', 'required' => true, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', 'title' => 'Id of the request', 'type' => 'string'], 'Message' => ['description' => 'Description of the status code.', 'example' => 'successful', 'type' => 'string', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'format' => 'int32', 'type' => 'integer', 'title' => ''], 'Data' => ['description' => 'Department ID.', 'example' => '123456', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" .'- **true**: Succeeded.'."\n" .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123456,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Create Department Information', 'description' => '- If you need to update department information, you can invoke the [UpdateDepartment](~~2717977~~) API.'."\n" .'- After successfully creating department information by invoking this API, the **Data** field in the response contains the department ID. If you need to query the department ID later, you can invoke the [GetAllDepartment](~~2717975~~) API.'."\n" ."\n" .'### Queries per second (QPS) limits'."\n" .'- Per-user invocation frequency: 100 times/second.'."\n" .'- API invocation frequency: 100 times/second.'."\n" ."\n" .'> Throttling is triggered if the total invocations from multiple users exceed the API frequency limit.', 'changeSet' => [ ['createdAt' => '2021-06-01T12:37:29.000Z', 'description' => 'OpenAPI offline'], ], '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', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'RetryTime', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '3', 'minimum' => '0', 'default' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'RetryInterval', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '2880', 'minimum' => '0', 'default' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'SkillGroup', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'Ani', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'Model', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '10', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DepartmentId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ExtAttrs', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'CallInfos', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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\\": false\\n}","type":"json"}]', 'title' => '', 'summary' => '', ], '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, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'CheckFreqType', 'in' => 'formData', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ScopeType', 'in' => 'formData', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'TimeRangeStart', 'in' => 'formData', 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'TimeRangeEnd', 'in' => 'formData', 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ChannelTouchType', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], [ 'name' => 'DepList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], [ 'name' => 'GroupList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], [ 'name' => 'ServicerList', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], [ 'name' => 'AnalysisIds', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Version' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'ProjectId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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\\": false\\n}","type":"json"}]', 'title' => '', 'summary' => '', ], '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, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'Name', 'in' => 'formData', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'RuleTag', 'in' => 'formData', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'MatchType', 'in' => 'formData', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'KeyWords', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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\\": false\\n}","type":"json"}]', 'title' => '', 'summary' => '', ], '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' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'SkillGroupName', 'in' => 'formData', 'schema' => ['description' => 'Skill group name.', 'docRequired' => true, 'example' => '在线自动化技能组', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'formData', 'schema' => ['description' => 'Skill group description.', 'example' => '在线自动化技能组', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'DisplayName', 'in' => 'formData', 'schema' => ['description' => 'External display name of the skill group.', 'example' => '在线自动化技能组', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'ChannelType', 'in' => 'formData', 'schema' => ['description' => 'Channel type of the skill group. Valid values:'."\n" ."\n" .'- **1**: Hotline.'."\n" .'- **2**: Online.'."\n" .'- **3**: Ticket.', 'docRequired' => true, 'example' => '2', 'format' => 'int32', 'maximum' => '7', 'minimum' => '0', 'required' => true, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'formData', 'schema' => ['description' => 'Unique ID of the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-****-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'DepartmentId', 'in' => 'formData', 'schema' => ['description' => 'Department ID.', 'example' => '123', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'properties' => [ 'Message' => ['description' => 'Description of the status code.', 'example' => 'successful', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'Data' => ['description' => 'ID of the successfully created skill group.', 'example' => '123456', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Code' => ['description' => 'Status code. A value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" .'- **true**: Succeeded.'."\n" .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 123456,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Create a Skill Group', 'summary' => 'Create a skill group based on the skill group name and channel type.', 'description' => '- This API allows you to define information such as the external display name and description of the skill group. For details, see [Request Parameters](#api-detail-35).'."\n" .'- The **Data** parameter returned by this API is the ID of the successfully created skill group.'."\n" ."\n" .'### Queries per second (QPS) limits'."\n" .'- Per-user invocation frequency: No rate limiting.'."\n" .'- API frequency: 1000 queries per second.'."\n" ."\n" .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', 'changeSet' => [ ['createdAt' => '2021-05-21T09:25:21.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'CreateTask' => [ 'summary' => 'Create an Artificial Intelligence Cloud Call Service robot outbound calling job.'."\n", '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' => 'Task Name. Supports Chinese and English characters. Length: 0 to 30 characters.', 'example' => '测试任务', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'RobotId', 'in' => 'query', 'schema' => ['description' => 'ID of the specified robot (script ID), indicating which robot script to use for initiating calls. '."\n" ."\n" .'You can obtain the script ID on the [Script Management](https://aiccs.console.aliyun.com/patter/list) page in the console.'."\n", 'example' => '12****', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'Caller', 'in' => 'query', 'schema' => ['description' => 'Outbound caller number.'."\n" ."\n" .'> The number must be a purchased number. Separate multiple numbers with commas (,).', 'example' => '0571****5678,0571****5679', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'CallString', 'in' => 'query', 'schema' => ['description' => 'Call string (callee information and parameter list). Valid values:'."\n" ."\n" .'- **LIST**: `05715678****,05715679****`'."\n" .'- **JSON**: `{"ParamNames":["name","age"],"CalleeList":[{"Callee":"1810000****","Params":["Zhang San","20"]},{"Callee":"1810001****","Params":["Li Si","21"]}]}`. In this example, ParamNames represents the List of Parameter Names; Params represents the List of parameter values.'."\n" ."\n" .'> - The order of the Parameter Name List and the parameter value List must correspond. '."\n" .'- A maximum of 1 000 callee numbers is allowed.'."\n", 'example' => '{"ParamNames":["name","age"],"CalleeList":[{"Callee":"1810000****","Params":["张三","20"]},{"Callee":"1810001****","Params":["李四","21"]}]}', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'CallStringType', 'in' => 'query', 'schema' => ['description' => 'Call string type. Valid values: '."\n" .'- **LIST** '."\n" .'- **JSON**'."\n", 'example' => 'JSON', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'RetryFlag', 'in' => 'query', 'schema' => ['description' => 'Whether to enable automatic retry. Valid values:'."\n" ."\n" .'- **1**: Retry.'."\n" .'- **0**: No retry.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'RetryCount', 'in' => 'query', 'schema' => ['description' => 'Retry Count.', 'example' => '2', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'RetryInterval', 'in' => 'query', 'schema' => ['description' => 'Retry interval. Unit: minute. Must be greater than 1.', 'example' => '2', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ 'name' => 'RetryStatusCode', 'in' => 'query', 'schema' => ['description' => 'Call statuses that require redialing. Separate multiple statuses with commas (,). Valid values: '."\n" .'- **200010**: Power off '."\n" .'- **200011**: Service suspended '."\n" .'- **200002**: Busy '."\n" .'- **200012**: Call failed '."\n" .'- **200005**: Unable to connect '."\n" .'- **200003**: No acknowledgement'."\n", 'example' => '200010,200011', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'StartNow', 'in' => 'query', 'schema' => ['description' => 'Indicates whether to start immediately. '."\n" .'- **true**: Yes. '."\n" .'- **false**: No.'."\n", 'example' => '是', 'required' => false, 'type' => 'boolean', 'default' => 'false', 'title' => ''], ], [ 'name' => 'WorkTimeList', 'in' => 'query', 'schema' => ['description' => 'List of working hours (accurate to the minute).'."\n", 'example' => '10:00-12:00,13:00-14:00', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'WorkDay', 'in' => 'query', 'schema' => ['description' => 'Work day. Valid values:'."\n" ."\n" .'- **1**: Monday.'."\n" .'- **2**: Tuesday.'."\n" .'- **3**: Wednesday.'."\n" .'- **4**: Thursday.'."\n" .'- **5**: Friday.'."\n" .'- **6**: Saturday.'."\n" .'- **7**: Sunday.'."\n", 'example' => '1', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'SeatCount', 'in' => 'query', 'schema' => ['description' => 'Concurrency (number of agents).', 'example' => '3', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'RequestId' => ['description' => 'Request ID.'."\n", 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], 'Message' => ['description' => 'Description of the status code.'."\n", 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Data' => ['description' => 'Unique job ID of the robot outbound calling task.'."\n", 'example' => '12****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Code' => ['description' => 'Request status code. A return value of "OK" indicates that the request succeeded.'."\n", 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded. '."\n" .'- **true**: Succeeded. '."\n" .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Create Job'."\n", 'description' => '- You can invoke this API to create a job, or create one in the **Artificial Intelligence Cloud Call Service console** > **Outbound Robot (Standard Edition)** > [Task Management](https://aiccs.console.aliyun.com/job/list) by clicking **Create Job**. '."\n" .'- After invoking this API, the **Data** field in the response contains the unique job ID of the robot outbound calling task.'."\n" ."\n" .'### Queries per second (QPS) limits'."\n" .'- Per-user invocation frequency: No rate limiting.'."\n" .'- API frequency: 500 queries per second (QPS).'."\n" ."\n" .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aiccs:CreateTask', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateThirdSsoAgent' => [ 'summary' => 'Create an agent that enables password-free login to the Cloud Customer Service System based on a User Account.', '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' => ['description' => 'Unique ID for the customer request. Used for idempotency validation and can be generated using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'title' => 'clientToken', 'type' => 'string'], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'AICCS instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'example' => 'ccc_xp_pre***', 'required' => true, 'title' => 'param1', 'type' => 'string'], ], [ 'name' => 'ClientId', 'in' => 'formData', 'schema' => ['description' => 'The client ID issued to the tenant instance.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => true, 'title' => 'param2', 'type' => 'string'], ], [ 'name' => 'AccountId', 'in' => 'formData', 'schema' => ['description' => 'Account ID to synchronize.', 'example' => 'accountId1', 'required' => true, 'title' => 'param3', 'type' => 'string'], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => ['description' => 'Account name to synchronize.', 'example' => 'accountName1', 'required' => true, 'title' => 'param4', 'type' => 'string'], ], [ 'name' => 'DisplayName', 'in' => 'formData', 'schema' => ['description' => 'Agent display name.', 'example' => '张三', 'required' => false, 'title' => 'param5', 'type' => 'string'], ], [ 'name' => 'SkillGroupIds', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => 'List of skill group IDs.', 'items' => ['description' => 'Skill group ID. '."\n" .'> The specified skill groups must belong to the same skill group group.', 'example' => '1', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, 'title' => 'param6', 'type' => 'array', 'example' => '', ], ], [ 'name' => 'RoleIds', 'in' => 'formData', 'style' => 'flat', 'schema' => [ 'description' => 'List of role IDs.', 'items' => ['description' => 'Role ID.', 'example' => '1', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, 'title' => 'param7', 'type' => 'array', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'properties' => [ 'Message' => ['description' => 'Description of the status code.', 'example' => 'Success', 'title' => 'message', 'type' => 'string'], 'RequestId' => ['description' => 'requestId', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'requestId', 'type' => 'string'], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'title' => 'httpStatusCode', 'type' => 'integer'], 'Data' => ['description' => 'The ID of the created agent.', 'example' => '123456', 'format' => 'int64', 'title' => '', 'type' => 'integer'], 'Code' => ['description' => 'Status code.', 'example' => '200', 'title' => 'code', 'type' => 'string'], 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'title' => 'success', 'type' => 'boolean'], ], 'title' => 'result', 'type' => 'object', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123456,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Create an agent for password-free login to the Cloud Customer Service System', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateThirdSsoAgent'], ], ], 'ramActions' => [], ], 'DeleteAgent' => [ 'summary' => 'Deletes an agent account in the Cloud Customer Service System based on the instance ID and agent account name.', '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' => ['description' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298****', 'required' => false, 'title' => '', 'type' => 'string'], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'AICCS instance ID. '."\n" .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox specified during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'properties' => [ 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Code' => ['description' => 'Status code. A value of Success indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" .'- **true**: Succeeded.'."\n" .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Delete Agent', 'description' => '- Before deletion, we recommend that you confirm the agent account name and instance ID to be deleted. For guidance on how to obtain them, see the description of [Request Parameters](#api-detail-35).'."\n" .'- If an agent is accidentally deleted, you can invoke the [CreateAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-createagent) API to recreate the agent.'."\n" ."\n" .'> If an account is re-added after deletion, the agent ID remains unchanged.'."\n" ."\n" .'### Queries per second (QPS) Limit'."\n" .'- Per-user invocation frequency: No rate limiting.'."\n" .'- API frequency: 100 queries per second.'."\n" ."\n" .'> Throttling is triggered if the total invocations from multiple users exceed the API frequency limit.', 'changeSet' => [ ['createdAt' => '2025-05-14T01:41:39.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aiccs:DeleteAgent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteAiOutboundTask' => [ 'summary' => 'Deletes an Intelligent Outbound Calling job by instance ID and job ID. After deletion, the job will no longer appear in the outbound calling job list.', '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' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID.'."\n" ."\n" .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'agent_***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The job ID.'."\n" ."\n" .'You can call the [CreateAiOutboundTask](~~312260~~) API and check the **Data** field in the response, or call the [GetAiOutboundTaskList](~~2718026~~) API and check the **TaskId** field in the response.', 'example' => '123456', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Code' => ['description' => 'The request status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" .'- **true**: Succeeded.'."\n" .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Delete an Intelligent Outbound Calling Job', 'description' => '>Deletion is a sensitive operation. Proceed with caution.>'."\n" ."\n" .'- Before deletion, we recommend that you confirm the job ID and related information. You can call the [GetAiOutboundTaskList](~~2718026~~) API to view the outbound calling job list and verify the task name, description, and corresponding job ID.'."\n" .'- If you need to recreate an Intelligent Outbound Calling job, you can call the [CreateAiOutboundTask](~~312260~~) API.'."\n" ."\n" .'### Queries per second (QPS) limits'."\n" .'- Per-user invocation frequency: 20 times/second.'."\n" .'- API invocation frequency: 20 times/second.'."\n" ."\n" .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAiOutboundTask'], ], ], 'ramActions' => [], ], 'DeleteDepartment' => [ 'summary' => 'Deletes department information based on the Artificial Intelligence Cloud Call Service (AICCS) instance ID and department 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' => ['description' => 'The AICCS instance ID. '."\n" .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'DepartmentId', 'in' => 'query', 'schema' => ['description' => 'The department ID. '."\n" ."\n" .'You can call the [GetAllDepartment](~~2717975~~) API and check the **DepartmentId** field in the response to obtain the department ID.', 'example' => '12****', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', 'title' => 'Id of the request', 'type' => 'string'], 'Message' => ['description' => 'Description of the status code.', 'example' => 'seccessful', 'type' => 'string', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Data' => ['description' => 'Indicates whether the operation succeeded. Valid values:'."\n" .'- **true**: Succeeded'."\n" .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], 'Code' => ['description' => 'The status code. A value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API was invoked successfully. Valid values:'."\n" .'- **true**: Succeeded.'."\n" .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"Message\\": \\"seccessful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Delete Department Information', 'description' => '- Deletion is a sensitive operation. Proceed with caution.'."\n" ."\n" .'- Before invoking this API, we recommend that you confirm the AICCS instance ID and department ID. For guidance on how to obtain them, see the instructions in [Request Parameters](#api-detail-35).'."\n" .'- If you accidentally delete department information, you can call the [CreateDepartment](~~2717974~~) API to recreate it.'."\n" ."\n\n" .'### Queries per second (QPS) limit'."\n" .'- Per-user invocation frequency: 100 times/second.'."\n" .'- API invocation frequency: 100 times/second.'."\n" ."\n" .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', 'changeSet' => [ ['createdAt' => '2021-06-01T12:37:29.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDepartment'], ], ], 'ramActions' => [], ], 'DeleteHotlineNumber' => [ 'summary' => 'Invoke the DeleteHotlineNumber API to delete a configured hotline number.', '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' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'HotlineNumber', 'in' => 'formData', 'schema' => ['description' => 'The hotline number.', 'example' => '05710000****', 'pattern' => '^\\d+$', 'required' => true, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', 'title' => 'Id of the request', 'type' => 'string'], 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'title' => '', 'type' => 'string'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'example' => '200', 'format' => 'int64', 'title' => '', 'type' => 'integer'], 'Code' => ['description' => 'The status code. A value of Success indicates that the request succeeded.', 'example' => 'Success', 'title' => '', 'type' => 'string'], 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], 'title' => 'Schema of Response', 'type' => 'object', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Delete a configured hotline number', 'changeSet' => [ ['createdAt' => '2021-06-22T12:36:22.000Z', 'description' => 'OpenAPI offline'], ], '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', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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\\": false\\n}","type":"json"}]', 'title' => '', 'summary' => '', ], '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' => 'External Account ID.', 'docRequired' => true, 'example' => '123456', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OuterAccountType', 'in' => 'query', 'schema' => ['description' => 'Type of the external account.', 'docRequired' => true, 'example' => 'aliyun', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'Data' => ['description' => 'Indicates whether the operation succeeded. Valid values:'."\n" .'- **true**: Succeeded'."\n" .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], 'Code' => ['description' => 'Status code. A value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Delete External Account', 'summary' => 'Invoke DeleteOuterAccount to delete an external account by its external Account ID.', 'changeSet' => [ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], ], '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, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'default' => '1', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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\\": false\\n}","type":"json"}]', 'title' => '', 'summary' => '', ], '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, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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\\": false\\n}","type":"json"}]', 'title' => '', 'summary' => '', ], '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' => 'External skill group type. Valid enumeration values are: 1: Hotline, 2: Online, 4: Ticket', 'example' => '2', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OuterGroupId', 'in' => 'query', 'schema' => ['description' => 'External skill group ID', 'example' => '123456', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'properties' => [ 'Message' => ['description' => 'Fault description', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'Request ID, used to trail the cause of an error', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'Data' => ['description' => 'Data', 'example' => 'true', 'type' => 'boolean', 'title' => ''], 'Code' => ['description' => 'Fault encoding', 'example' => 'Success', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Delete Skill Group', 'summary' => 'Deletes an external skill group based on the skill group ID and skill group channel type.', 'changeSet' => [ ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], ], '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' => 'Product name. Default value: **aiccs**.', 'example' => 'aiccs', 'required' => false, 'type' => 'string', 'default' => 'aiccs', 'title' => ''], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => ['description' => 'Account type.', 'example' => 'BUC_TYPE', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AccountId', 'in' => 'query', 'schema' => ['description' => 'AccountId.', 'example' => '2235****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'Acid', 'in' => 'query', 'schema' => ['description' => 'Session ID.', 'example' => '1004849****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'SecLevel', 'in' => 'query', 'schema' => ['description' => 'Recording desensitization level. Valid values: **1–4**.', 'example' => '2', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'Acid' => ['description' => 'Session ID.', 'example' => '1004849****', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'Message' => ['description' => 'Status code description.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'OssLink' => ['description' => 'Recording file link.', 'example' => 'https://****', 'type' => 'string', 'title' => ''], 'AgentId' => ['description' => 'Agent ID.', 'example' => '1212****', 'type' => 'string', 'title' => ''], 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"Acid\\": \\"1004849****\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"OssLink\\": \\"https://****\\",\\n \\"AgentId\\": \\"1212****\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', 'title' => 'Retrieve Call Records', 'summary' => 'Invoke the DescribeRecordData API to retrieve call information.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aiccs:DescribeRecordData', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', '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, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProjectName', 'in' => 'formData', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'CheckFreqType', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProjectVersion', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ScopeType', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'TimeRangeStart', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'TimeRangeEnd', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'AnalysisIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], [ 'name' => 'DepList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], [ 'name' => 'GroupList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], [ 'name' => 'ServicerList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], [ 'name' => 'ChannelTouchType', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Version' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'ProjectId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'title' => '', 'example' => '', ], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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\\": false\\n}","type":"json"}]', 'title' => '', 'summary' => '', ], '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, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'Name', 'in' => 'formData', 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'RuleTag', 'in' => 'formData', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'MatchType', 'in' => 'formData', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'QualityRuleId', 'in' => 'formData', 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'KeyWords', 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, 'maxItems' => 3, 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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\\": false\\n}","type":"json"}]', 'title' => '', 'summary' => '', ], '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, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'AnalysisTypes', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], 'Name' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 100, 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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\\": false\\n}","type":"json"}]', 'title' => '', 'summary' => '', ], 'EncryptPhoneNum' => [ 'summary' => 'Invoke EncryptPhoneNum to encrypt the User\'s Phone number.', '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' => ['description' => 'AICCS instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'example' => 'ccc_xp_pre***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'PhoneNum', 'in' => 'query', 'schema' => ['description' => 'The plaintext phone number.', 'example' => '130****0000', 'required' => true, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'title' => '', 'type' => 'string'], 'Data' => ['description' => 'The ciphertext after encryption.', 'example' => '20nJ****/9Fl/kxx/***7', 'title' => '', 'type' => 'string'], 'Code' => ['description' => 'The status code. A return value of 200 indicates that the Request Succeeded.', 'example' => '200', 'title' => '', 'type' => 'string'], 'Success' => ['description' => 'Indicates whether the API Call Succeeded.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], 'title' => 'Schema of Response', 'type' => 'object', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": \\"20nJ****/9Fl/kxx/***7\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Encrypt the User\'s Phone number', 'changeSet' => [ ['createdAt' => '2021-04-25T12:05:56.000Z', 'description' => 'OpenAPI offline'], ], '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' => 'Unique ID of the customer request, used for idempotency validation; can be generated using UUID', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'AICCS instance ID, visible in the Artificial Intelligence Cloud Call Service console', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => ['description' => 'Agent account name (agent logon name)', 'docRequired' => true, 'example' => '123@123.com', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'CallId', 'in' => 'formData', 'schema' => ['description' => 'The acid from WebSocket after an inbound call', 'docRequired' => true, 'example' => '7719786', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'formData', 'schema' => ['description' => 'The jobId from WebSocket after an inbound call', 'docRequired' => true, 'example' => '7719787', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'ConnectionId', 'in' => 'formData', 'schema' => ['description' => 'The connId from WebSocket after an inbound call', 'docRequired' => true, 'example' => '7719788', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'HoldConnectionId', 'in' => 'formData', 'schema' => ['description' => 'The holdConnId from WebSocket after an inbound call (only provided during two-step transfer)', 'docRequired' => true, 'example' => '0', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'properties' => [ 'Message' => ['description' => 'Fault description', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'Request ID, used to trail the cause of a fault', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'Code' => ['description' => 'Fault encoding', 'example' => 'Success', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Retrieve Call Information', 'summary' => 'Retrieve or recover a call.', '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' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" .'You can obtain it in the Instance Management section of the left-side navigation pane in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'properties' => [ 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Code' => ['description' => 'Status code. A return value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" .'- **true**: Succeeded.'."\n" .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'End Hotline Service', 'summary' => 'End the hotline service by instance ID and agent account name.', 'description' => '### Queries per second (QPS) limit'."\n" .'- Per-user API call frequency: No rate limiting.'."\n" .'- API frequency: 100 calls per second.'."\n" ."\n" .'> If the total number of calls from multiple users exceeds the API frequency limit, throttling will be triggered.', 'changeSet' => [ ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], ], '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' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-****-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'properties' => [ 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Data' => ['description' => 'MessageBox message channel signature code.', 'example' => 'dnthF_oinHg7JMJDmKqex3UxDD7', 'type' => 'string', 'title' => ''], 'Code' => ['description' => 'Status code. A value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" .'- **true**: Succeeded.'."\n" .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"dnthF_oinHg7JMJDmKqex3UxDD7\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Generate MessageBox Channel Signature', 'summary' => 'Generate a message channel access signature based on the Artificial Intelligence Cloud Call Service (AICCS) instance ID and agent account name. ', 'description' => '- You can invoke this API to generate a message channel access signature. The **Data** field in the response contains the MessageBox message channel signature code.'."\n" ."\n" .'- Before invoking the API, we recommend that you confirm your AICCS instance ID. For instructions on how to obtain it, see the description of [Request Parameters](#api-detail-35).'."\n" ."\n" .'### Queries per second (QPS) limit'."\n" .'- Per-user invocation frequency: No rate limiting.'."\n" .'- API-wide frequency: 100 queries per second.'."\n" ."\n" .'> If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered.', 'changeSet' => [ ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], ], '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' => ['description' => 'Unique customer request ID. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'title' => '', 'type' => 'string'], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. Unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Data' => [ 'description' => 'Agent data.', 'properties' => [ 'Status' => ['description' => 'Agent status. Valid values:'."\n" ."\n" .'- **0**: Normal'."\n" .'- **1**: Freeze'."\n" .'- **2**: Delete'."\n" ."\n" .'> Only agents with a Normal status can perform Business Activities.', 'example' => '0', 'format' => 'int32', 'type' => 'integer', 'title' => ''], 'TenantId' => ['description' => 'Tenant ID to which the agent belongs, corresponding to the instance ID in the request parameters.', 'example' => '0', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'GroupList' => [ 'description' => 'Skill group information to which the agent belongs.', 'items' => [ 'description' => 'Skill group information.', 'properties' => [ 'Description' => ['description' => 'Skill group description.', 'example' => '自动化技能组', 'type' => 'string', 'title' => ''], 'DisplayName' => ['description' => 'Display name of the skill group.', 'example' => '自动化技能组', 'type' => 'string', 'title' => ''], 'SkillGroupId' => ['description' => 'Skill group ID.', 'example' => '123456', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'ChannelType' => ['description' => 'Skill group channel type.', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], 'Name' => ['description' => 'Skill group name.', 'example' => '自动化技能组', 'type' => 'string', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'type' => 'array', 'title' => '', 'example' => '', ], 'DisplayName' => ['description' => 'Agent display name shown externally.', 'example' => 'XX测试', 'type' => 'string', 'title' => ''], 'AgentId' => ['description' => 'Agent ID.', 'example' => '222222', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'AccountName' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. Unique within the instance.', 'example' => 'username@example.com', 'type' => 'string', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], 'Code' => ['description' => 'Status code. A return value of Success indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" .'- **true**: Succeeded.'."\n" .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', 'title' => '', 'example' => '', ], ], ], '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' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'Obtain agent information', 'summary' => 'Query agent information in the Cloud Customer Service System by instance ID and agent account name, such as agent ID.', 'description' => '- Before invoking this API, confirm the AICCS instance information and the agent account name. For guidance on how to obtain these details, refer to the instructions in [Request Parameters](#api-detail-35).'."\n" .'- Deleted agents can also be queried. Check the **Status** parameter in the response. If its value is 2, it indicates that the agent has been deleted.'."\n" ."\n" .'### queries per second (QPS) Limit'."\n" .'- Per-user invocation frequency: No Rate Limiting.'."\n" .'- API frequency: 100 times/second.'."\n" ."\n" .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', 'changeSet' => [ ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetAgentBasisStatus' => [ 'summary' => 'Obtain the agent-level status metrics under hotline monitoring. Supports queries by instance, time range, agent, and department group.'."\n", 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" .'You can obtain it in the **Instance Management** section of the left-side navigation pane in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview). ', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => ['description' => 'The UNIX timestamp of the start date. Unit: milliseconds. ', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => ['description' => 'End Datetime UNIX timestamp. Unit: milliseconds.', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. The value must be greater than **0**. Default value: **20**. ', 'example' => '20', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'CurrentPage', 'in' => 'query', 'schema' => ['description' => 'The current page number. The value must be greater than **0**. Default value: **1**. ', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'A list of agent IDs. ', 'items' => ['description' => 'Agent ID.'."\n" ."\n" .'You can invoke the [GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent) API and check the **AgentId** field in the response parameters to obtain the agent ID.', 'example' => '["2256****","2257****"]', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, 'title' => '', 'type' => 'array', 'example' => '', ], ], [ 'name' => 'DepIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => 'A list of department IDs. ', 'items' => ['description' => 'The department ID. '."\n" ."\n" .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and view the **DepartmentId** field in the response to obtain the department ID. ', 'example' => '["6083****","6084****"]', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, 'title' => '', 'type' => 'array', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], 'Message' => ['description' => 'Status code description. ', 'example' => 'OK', 'title' => '', 'type' => 'string'], 'Data' => [ 'description' => 'Data list. ', 'properties' => [ 'TotalNum' => ['description' => 'Total number of records. ', 'example' => '4', 'format' => 'int32', 'title' => '', 'type' => 'integer'], 'PageNum' => ['description' => 'Current page number. ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], 'PageSize' => ['description' => 'Page size. ', 'example' => '2000', 'format' => 'int32', 'title' => '', 'type' => 'integer'], 'Rows' => ['description' => 'The information is a JSON string of the List