diff options
Diffstat (limited to 'data/en_us/aiccs/2023-05-16')
| -rw-r--r-- | data/en_us/aiccs/2023-05-16/api-docs.php | 7018 |
1 files changed, 1978 insertions, 5040 deletions
diff --git a/data/en_us/aiccs/2023-05-16/api-docs.php b/data/en_us/aiccs/2023-05-16/api-docs.php index e4c8433..848bd99 100644 --- a/data/en_us/aiccs/2023-05-16/api-docs.php +++ b/data/en_us/aiccs/2023-05-16/api-docs.php @@ -1,57 +1,18 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'aiccs', - 'version' => '2023-05-16', - ], + 'info' => ['style' => 'RPC', 'product' => 'aiccs', 'version' => '2023-05-16'], 'directories' => [ - 'AddBlacklist', - 'AddTask', - 'AgentCancelCall', - 'AgentRecoverCall', - 'Details', - 'EditTask', - 'ImportNumber', - 'ImportNumberV2', - 'Page', - 'SmsTemplateCreate', - 'SmsTemplatePageList', - 'TaskCallChats', - 'TaskCallInfo', - 'TaskCallList', - 'TaskCancelCall', - 'TaskList', - 'TaskRecoverCall', - 'TemplateList', - 'UpdateAgentStatus', - 'UpdateTaskCustomer', + 'AddBlacklist', 'AddTask', 'AgentCancelCall', 'AgentRecoverCall', 'Details', 'EditTask', 'ImportNumber', 'ImportNumberV2', 'Page', 'SmsTemplateCreate', 'SmsTemplatePageList', 'TaskCallChats', 'TaskCallInfo', 'TaskCallList', 'TaskCancelCall', 'TaskList', 'TaskRecoverCall', 'TemplateList', 'UpdateAgentStatus', 'UpdateTaskCustomer', 'QuickAddTask', - 'AddAgent', - 'QueryAgentInfo', - 'AddAgentGroup', - 'JoinAgentGroup', - 'QuitAgentGroup', - 'AgentGroupPage', - 'AgentCallList', - 'AgentImportNumber', - 'CallNumberDetail', - 'CallChatList', ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AddBlacklist' => [ - 'summary' => '添加黑名单接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Adds phone numbers to the blacklist for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -62,9 +23,7 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '179242', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], ], 'parameters' => [ [ @@ -72,16 +31,10 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表', + 'title' => '', + 'description' => 'The list of phone numbers.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1380001****', - ], + 'items' => ['description' => 'The phone number.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1380001****'], 'required' => true, 'example' => '', ], @@ -89,24 +42,12 @@ [ 'name' => 'ExpiredDay', 'in' => 'query', - 'schema' => [ - 'title' => '有效天数', - 'description' => '有效天数', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The number of days for which the blacklist entry remains valid.', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ 'name' => 'Remark', 'in' => 'query', - 'schema' => [ - 'title' => '备注', - 'description' => '备注', - 'type' => 'string', - 'required' => true, - 'example' => '示例值', - ], + 'schema' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'required' => true, 'example' => '备注'], ], ], 'responses' => [ @@ -114,78 +55,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ 'UnHandleNumbers' => [ - 'title' => '错误手机号', - 'description' => '错误手机号', + 'title' => '', + 'description' => 'The unrecognized phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1380001****', - ], + 'items' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '1380001****', 'title' => ''], 'example' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The request status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + .'- true: The operation is successful.'."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"UnHandleNumbers\\": [\\n \\"1380001****\\"\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'AddTask' => [ - 'summary' => '创建任务接口', - 'methods' => [ - 'post', - 'get', + 'title' => 'Add blacklist numbers for industry edition', + 'description' => 'Adds phone numbers to the outbound call blocking blacklist for the industry edition.', + 'requestParamsDescription' => 'Batch blacklisting is supported, with a maximum of 5000 phone numbers per request.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AddBlacklist', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddBlacklist'], + ], ], + ], + 'AddTask' => [ + 'summary' => 'Creates a task for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREaiccsD1POR4'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -193,176 +131,114 @@ [ 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'title' => '任务类型', - 'description' => '任务类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The type of the task. Valid values:'."\n" + .'- 1: Batch AI outbound call without transfer to a human agent.'."\n" + .'- 2: Batch voice notification.'."\n" + .'- 6: New voice notification. This is the default voice notification type for enterprises that registered after October 2022.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '任务名称', - 'description' => '任务名称', - 'type' => 'string', - 'required' => true, - 'example' => '示例值示例值示例值', - ], + 'schema' => ['title' => '', 'description' => 'The name of the task.', 'type' => 'string', 'required' => true, 'example' => '任务名称'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '任务启动日期', - 'description' => '任务启动日期', - 'type' => 'string', - 'required' => false, - 'example' => '2022-09-16', - ], + 'schema' => ['title' => '', 'description' => 'The start date of the task.', 'type' => 'string', 'required' => false, 'example' => '2022-09-16'], ], [ 'name' => 'TemplateType', 'in' => 'query', - 'schema' => [ - 'title' => '话术模板类型', - 'description' => '话术模板类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The templatetype of the script template. Valid values:'."\n" + .'- 1: Single template.'."\n" + .'- 2: Intelligent script Policy Template.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '话术模板ID', - 'description' => '话术模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '17', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the script template.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '17'], ], [ 'name' => 'MaxConcurrency', 'in' => 'query', - 'schema' => [ - 'title' => '并发数', - 'description' => '并发数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '99', - ], + 'schema' => ['title' => '', 'description' => 'The number of concurrent calls. Default value: 1. The value cannot exceed the maximum concurrency configured for the enterprise.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '99'], ], [ 'name' => 'RecallType', 'in' => 'query', - 'schema' => [ - 'title' => '重呼配置', - 'description' => '重呼配置', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '53', - ], + 'schema' => ['title' => '', 'description' => 'The recall configuration. Valid values:'."\n" + .'- 1: No recall.'."\n" + .'- 2: Interval-based recall.'."\n" + .'- 3: Scheduled recall.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '53'], ], [ 'name' => 'RepeatInterval', 'in' => 'query', - 'schema' => [ - 'title' => '重呼间隔', - 'description' => '重呼间隔', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14', - ], + 'schema' => ['title' => '', 'description' => 'The recall interval. This parameter is required when RecallType is set to 2. Unit: minutes. The value must be a positive integer greater than or equal to 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14'], ], [ 'name' => 'RepeatCount', 'in' => 'query', - 'schema' => [ - 'title' => '重呼次数', - 'description' => '重呼次数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '37', - ], + 'schema' => ['title' => '', 'description' => 'The number of recall attempts. This parameter is required when RecallType is set to 2. The value must be a positive integer greater than or equal to 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '37'], ], [ 'name' => 'RepeatTimes', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '重呼时间', - 'description' => '重呼时间', + 'title' => '', + 'description' => 'The recall times.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '22:00', - ], + 'items' => ['title' => '', 'description' => 'This parameter is required when RecallType is set to 3. Format: ["8:00","9:00"]. Separate multiple time points with commas. Valid values:'."\n" + .'"7:00", "7:30", "8:00", "8:30", "9:00", "9:30", "10:00", "10:30", "11:00", "11:30", "12:00", "12:30", "13:00", "13:30", "14:00", "14:30", "15:00", "15:30", "16:00", "16:30", "17:00", "17:30", "18:00", "18:30", "19:00", "19:30", "20:00", "20:30", "21:00", "21:30", "22:00".', 'type' => 'string', 'required' => false, 'example' => '22:00'], 'required' => false, - 'example' => '', + 'example' => '示例值', ], ], [ 'name' => 'RecordPath', 'in' => 'query', - 'schema' => [ - 'title' => '录音地址', - 'description' => '录音地址', - 'type' => 'string', - 'required' => false, - 'example' => '示例值', - ], + 'schema' => ['title' => '', 'description' => 'The URL of the recording. This parameter is required when the business type enabled for the enterprise is voice notification.', 'type' => 'string', 'required' => false, 'example' => '示例值'], ], [ 'name' => 'PlaySleepVal', 'in' => 'query', - 'schema' => [ - 'title' => '播放间隔时长', - 'description' => '播放间隔时长', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '89', - ], + 'schema' => ['title' => '', 'description' => 'The playback interval. This parameter is required when the business type enabled for the enterprise is voice notification. Unit: seconds. The value must be a non-negative integer.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '89'], ], [ 'name' => 'PlayTimes', 'in' => 'query', - 'schema' => [ - 'title' => '录音播放次数', - 'description' => '录音播放次数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '51', - ], + 'schema' => ['title' => '', 'description' => 'The number of times the recording is played. This parameter is required when the business type enabled for the enterprise is voice notification. The value must be a non-negative integer.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '51'], ], [ 'name' => 'RepeatReason', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '重呼条件', - 'description' => '重呼条件', + 'title' => '', + 'description' => 'The recall conditions.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'items' => ['title' => '', 'description' => 'You can select multiple values. If this parameter is not specified, all conditions are used by default. The recall condition refers to the status of the previous outbound call, such as "Busy" or "Empty number".'."\n" + ."\n" + .'The condition codes and their descriptions are as follows:'."\n" + ."\n" + .'2: Phone off.'."\n" + .'3: Empty number.'."\n" + .'4: Number changed.'."\n" + .'5: Service suspended.'."\n" + .'6: Busy.'."\n" + .'7: Rejected.'."\n" + .'8: Unreachable.'."\n" + .'9: No answer.'."\n" + .'10: Overdue payment.'."\n" + .'11: Line fault.'."\n" + .'12: Call failed.'."\n" + .'30: Blocked.'."\n" + .'40: Daily call limit reached.', 'type' => 'string', 'required' => false, 'example' => '2'], 'required' => false, 'example' => '', ], @@ -372,29 +248,29 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '外呼时间', - 'description' => '外呼时间', + 'title' => '', + 'description' => 'The outbound call time. Format example: for "8:30-12:00 13:30-19:00", pass [[8.5,12][13.5,19]]. Default value: [[8,20]].', 'type' => 'array', 'items' => [ + 'title' => '', + 'description' => 'The outbound call time. Format example: for "8:30-12:00 13:30-19:00", pass [[8.5,12][13.5,19]]. Default value: [[8,20]].', 'type' => 'object', 'properties' => [ 'CallTime' => [ - 'description' => '', + 'title' => '', + 'description' => 'The outbound call time.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12:30', - ], + 'items' => ['title' => '', 'description' => 'The outbound call time, for example, 8.5.', 'type' => 'string', 'required' => false, 'example' => '8.5'], 'required' => false, 'example' => '', ], ], 'required' => false, + 'example' => '', ], 'required' => false, - 'example' => '', + 'enumValueTitles' => [], + 'example' => '14', ], ], [ @@ -402,35 +278,26 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '短信发送规则', - 'description' => '短信发送规则', + 'title' => '', + 'description' => 'The SMS sending rule.', 'type' => 'array', 'items' => [ + 'title' => '', + 'description' => 'The SMS sending rule.', 'type' => 'object', 'properties' => [ 'IntentTags' => [ - 'title' => '意向标签', - 'description' => '意向标签', + 'title' => '', + 'description' => 'The intent labels.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'A', - ], + 'items' => ['title' => '', 'description' => 'The matched intent labels in uppercase, for example, ["A", "B"]. An SMS message is triggered if any condition is met.', 'type' => 'string', 'required' => false, 'example' => 'A'], 'required' => false, 'example' => '', ], - 'SmsTemplateId' => [ - 'title' => '短信模板ID', - 'description' => '短信模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '71', - ], + 'SmsTemplateId' => ['title' => '', 'description' => 'The ID of the SMS template.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '71'], ], 'required' => false, + 'example' => '', ], 'required' => false, 'example' => '', @@ -439,109 +306,118 @@ [ 'name' => 'CallbackUrl', 'in' => 'query', - 'schema' => [ - 'title' => '回调地址', - 'description' => '回调地址', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值示例值', - ], + 'schema' => ['title' => '', 'description' => 'The callback URL.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值示例值'], ], [ 'name' => 'FlashSmsType', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The flash SMS configuration.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'default' => ''], + ], + [ + 'name' => 'FlashSmsTemplateId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the flash SMS template. This parameter is required when FlashSmsType is set to 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '96', 'default' => ''], + ], + [ + 'name' => 'CallTimeStrList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '发送闪信配置', - 'description' => '发送闪信配置', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The outbound call time with minute-level precision. If both this parameter and CallTimeList are specified, this parameter takes precedence. Use this parameter for minute-level precision. For example, for 08:31-12:05 13:33-19:00, pass [["08:31","12:05"]["13:33","19:00"]]. Default value: [["08:00","20:00"]].', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The outbound call time with minute-level precision. If both this parameter and CallTimeList are specified, this parameter takes precedence. Use this parameter for minute-level precision. For example, for 08:31-12:05 13:33-19:00, pass [["08:31","12:05"]["13:33","19:00"]]. Default value: [["08:00","20:00"]].', + 'type' => 'object', + 'properties' => [ + 'CallTime' => [ + 'title' => '', + 'description' => 'The first call time string.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The first call time string.', 'type' => 'string', 'required' => false, 'example' => '"08:31"'], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], 'required' => false, - 'example' => '0', - 'default' => '', + 'example' => '', ], ], [ - 'name' => 'FlashSmsTemplateId', + 'name' => 'WeekTag', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '当发送闪信配置为1时,闪信模板ID必填', - 'description' => '当发送闪信配置为1时,闪信模板ID必填', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The days of the week on which outbound calls are made. For example, [1,2,3,4,5,6,7] indicates that outbound calls are made from Monday to Sunday.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Wednesday.', 'type' => 'string', 'required' => false, 'example' => '3'], 'required' => false, - 'example' => '96', - 'default' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'AccessDeniedDetail', 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5453cc9b-02bc-4dbb-9527-f28a9100b912', - ], + 'AccessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None'], + 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => '成功'], + 'RequestId' => ['title' => '', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => '5453cc9b-02bc-4dbb-9527-f28a9100b912'], 'Model' => [ - 'description' => '', + 'title' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '47', - ], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '47'], ], 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1686225227338', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Timestamp' => ['title' => '', 'description' => 'The operation timestamp ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1686225227338'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the operation was successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'false'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"5453cc9b-02bc-4dbb-9527-f28a9100b912\\",\\n \\"Model\\": {\\n \\"TaskId\\": 47\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1686225227338,\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Create task - industry edition', + 'description' => 'Creates a task for the industry edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AddTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"5453cc9b-02bc-4dbb-9527-f28a9100b912\\",\\n \\"Model\\": {\\n \\"TaskId\\": 47\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1686225227338,\\n \\"Success\\": false\\n}","type":"json"}]', ], 'AgentCancelCall' => [ - 'summary' => '坐席取消号码外呼', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Cancels an outbound call by an agent in the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -554,9 +430,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '179248', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -564,40 +438,22 @@ [ 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '64', - ], + 'schema' => ['title' => '', 'description' => 'The agent ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '64'], ], [ 'name' => 'AgentTag', 'in' => 'query', - 'schema' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['title' => '', 'description' => 'The agent tag.', 'type' => 'string', 'required' => false, 'example' => 'abc'], ], [ 'name' => 'Numbers', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表', + 'title' => '', + 'description' => 'The list of phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13314206082', - ], + 'items' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13314206082', 'title' => ''], 'required' => false, 'example' => '', ], @@ -607,15 +463,10 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户自定义标签列表', - 'description' => '用户自定义标签列表', + 'title' => '', + 'description' => 'The list of user-defined tags.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], + 'items' => ['description' => 'The label.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''], 'required' => false, 'example' => '', ], @@ -626,70 +477,62 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'UnHandleNumbers' => [ - 'title' => '错误手机列表', - 'description' => '错误手机列表', + 'title' => '', + 'description' => 'The list of unrecognized phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '13100000000', - ], + 'items' => ['description' => 'The unrecognized phone number.', 'type' => 'string', 'example' => '13100000000', 'title' => ''], 'example' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code. A value of 0 indicates success.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"UnHandleNumbers\\": [\\n \\"13100000000\\"\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Cancel outbound call by agent in industry edition', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AgentCancelCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AgentCancelCall'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"UnHandleNumbers\\": [\\n \\"13100000000\\"\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], 'AgentRecoverCall' => [ - 'summary' => '坐席任务恢复号码', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Restores the numbers that were canceled for outbound calls by an agent to the pending outbound call status and initiates outbound calls.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -702,9 +545,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '179246', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -712,40 +553,22 @@ [ 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the agent.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5'], ], [ 'name' => 'AgentTag', 'in' => 'query', - 'schema' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['title' => '', 'description' => 'The tag of the agent.', 'type' => 'string', 'required' => false, 'example' => 'abc'], ], [ 'name' => 'Tags', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户自定义标签列表', - 'description' => '用户自定义标签列表', + 'title' => '', + 'description' => 'The list of user-defined tags.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], + 'items' => ['description' => 'The label.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''], 'required' => false, 'example' => '', ], @@ -755,15 +578,10 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表', + 'title' => '', + 'description' => 'The list of phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13541251222,18665214444', - ], + 'items' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13541251222,18665214444', 'title' => ''], 'required' => false, 'example' => '', ], @@ -771,26 +589,12 @@ [ 'name' => 'BeginImportTime', 'in' => 'query', - 'schema' => [ - 'title' => '查询开始导入时间', - 'description' => '查询开始导入时间', - 'type' => 'string', - 'required' => false, - 'example' => ' 2020-03-06 10:10:10', - 'default' => '"2023-01-09 18:58:19"', - ], + 'schema' => ['title' => '', 'description' => 'The start time of the import time range to query.', 'type' => 'string', 'required' => false, 'example' => ' 2020-03-06 10:10:10', 'default' => '"2023-01-09 18:58:19"'], ], [ 'name' => 'EndImportTime', 'in' => 'query', - 'schema' => [ - 'title' => '查询结束导入时间', - 'description' => '查询结束导入时间', - 'type' => 'string', - 'required' => false, - 'example' => ' 2021-03-06 10:10:10', - 'default' => '"2023-01-09 18:58:19"', - ], + 'schema' => ['title' => '', 'description' => 'The end time of the import time range to query.', 'type' => 'string', 'required' => false, 'example' => ' 2021-03-06 10:10:10', 'default' => '"2023-01-09 18:58:19"'], ], ], 'responses' => [ @@ -798,71 +602,62 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'UnHandleNumbers' => [ - 'title' => '错误手机列表', - 'description' => '错误手机列表', + 'title' => '', + 'description' => 'The list of unrecognized phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '13314206082', - ], + 'items' => ['description' => 'The unrecognized phone number.', 'type' => 'string', 'example' => '13314206082', 'title' => ''], 'example' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code. A value of 0 indicates success.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['title' => '', 'description' => 'Indicates whether the operation was successful. Valid values:'."\n" + .'- true: The operation was successful.'."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"UnHandleNumbers\\": [\\n \\"13314206082\\"\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'Details' => [ - 'summary' => 'AI批量任务查询号码状态接口', - 'methods' => [ - 'post', - 'get', + 'title' => 'Industry edition - resume agent outbound calls', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AgentRecoverCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AgentRecoverCall'], + ], ], + ], + 'Details' => [ + 'summary' => 'Queries the number status of an AI batch task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -870,74 +665,37 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务id', - 'description' => '任务id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '90', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '90'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '开始导入时间', - 'description' => '开始导入时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-25 15:19:02', - ], + 'schema' => ['title' => '', 'description' => 'The start time of the import. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2023-04-25 15:19:02'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'title' => '结束导入时间', - 'description' => '结束导入时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-25 15:19:02', - ], + 'schema' => ['title' => '', 'description' => 'The end time of the import. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2023-04-25 15:19:02'], ], [ 'name' => 'BatchId', 'in' => 'query', - 'schema' => [ - 'title' => '批次id', - 'description' => '批次id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '75', - ], + 'schema' => ['title' => '', 'description' => 'The batch ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '75'], ], [ 'name' => 'Numbers', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表', + 'title' => '', + 'description' => 'The list of phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13541251222', - ], + 'items' => ['description' => 'The phone number to query. Batch queries are supported, with a maximum of 1000 numbers.', 'type' => 'string', 'required' => false, 'example' => '13541251222', 'title' => ''], 'required' => false, 'example' => '', ], @@ -945,38 +703,20 @@ [ 'name' => 'NumberStatus', 'in' => 'query', - 'schema' => [ - 'title' => '号码状态', - 'description' => '号码状态', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The number status to query. Valid values:'."\n" + .'1: failed to call.'."\n" + .'2: call in progress.'."\n" + .'3: call completed.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => '页数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '77', - ], + 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '77'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页条数', - 'description' => '每页条数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3'], ], ], 'responses' => [ @@ -984,188 +724,200 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '389b2d0a-37e2-406d-b576-1fc0827be46a', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '389b2d0a-37e2-406d-b576-1fc0827be46a', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The model.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '79', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '94', - ], - 'TotalPage' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '71.8132', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '79', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '94', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'List' => [ - 'description' => '', + 'description' => 'The list.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The record.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '28', - ], - 'BatchId' => [ - 'title' => '批次号', - 'description' => '批次号', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '27', - ], - 'CallDesc' => [ - 'title' => '呼叫状态描述', - 'description' => '呼叫状态描述', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'CallId' => [ - 'title' => '外呼ID', - 'description' => '外呼ID', - 'type' => 'string', - 'example' => '28dd74a4-30ec-43c0-9bec-272924c51eeb', - ], - 'CallType' => [ - 'title' => '外呼类型', - 'description' => '外呼类型', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2001', - ], - 'CallStatus' => [ - 'title' => '呼叫状态', - 'description' => '呼叫状态', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ImportTime' => [ - 'title' => '导入时间', - 'description' => '导入时间', - 'type' => 'string', - 'example' => '2023-04-25 15:19:02', - ], - 'NumberDesc' => [ - 'title' => '号码状态描述', - 'description' => '号码状态描述', - 'type' => 'string', - 'example' => '示例值', - ], - 'Number' => [ - 'title' => '外呼号码', - 'description' => '外呼号码', - 'type' => 'string', - 'example' => '188******454', - ], - 'InterceptReason' => [ - 'title' => '拦截原因', - 'description' => '拦截原因', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'NumberStatus' => [ - 'title' => '号码状态', - 'description' => '号码状态', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Tag' => [ - 'title' => '用户自定义标签', - 'description' => '用户自定义标签', - 'type' => 'string', - 'example' => 'A', - ], - 'NumberMD5' => [ - 'title' => '外呼号码MD5', - 'description' => '外呼号码MD5', - 'type' => 'string', - 'example' => 'cbe1b40f76f2cca4735954886b706ffa', - ], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '28'], + 'BatchId' => ['title' => '', 'description' => 'The batch ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '27'], + 'CallDesc' => ['title' => '', 'description' => 'The call status description, such as "Answered" or "Rejected".'."\n" + .'When the number status is 1 (failed to call), valid values:'."\n" + .'-516: outbound number concurrency limit.'."\n" + .'-515: number frequency limit.'."\n" + .'-514: no line configured.'."\n" + .'-513: concurrency limit.'."\n" + .'-512: outside calling hours.'."\n" + .'-511: blocked area code.'."\n" + .'-310: waiting for distribution.'."\n" + .'-210: call canceled (repayment query failed).'."\n" + .'-110: call canceled (repayment completed).'."\n" + .'-20: agent offline.'."\n" + .'-19: agent did not answer.'."\n" + .'-18: failed to call agent.'."\n" + .'-17: call canceled.'."\n" + .'-16: call timed out.'."\n" + .'-15: failed to obtain voice gateway information.'."\n" + .'-14: failed to convert MD5 to phone number.'."\n" + .'-13: failed to pre-cache audio file.'."\n" + .'When the number status is 2 (call in progress), valid values:'."\n" + .'-12: pre-caching audio file.'."\n" + .'-11: waiting to pre-cache audio file.'."\n" + .'-10: not started.'."\n" + .'-9: waiting to call.'."\n" + .'-8: calling.'."\n" + .'-7: AI call in progress.'."\n" + .'-6: assigning agent.'."\n" + .'-5: manual call in progress.'."\n" + .'-4: monitoring ringing.'."\n" + .'-3: monitoring failed.'."\n" + .'-2: monitoring.'."\n" + .'When the number status is 3 (call completed), valid values:'."\n" + .'1: answered.'."\n" + .'2: powered off.'."\n" + .'3: invalid number.'."\n" + .'4: number changed.'."\n" + .'5: out of service.'."\n" + .'6: busy.'."\n" + .'7: rejected.'."\n" + .'8: unreachable.'."\n" + .'9: missed.'."\n" + .'10: overdue payment.'."\n" + .'11: line failure.'."\n" + .'12: call failed.'."\n" + .'30: intercepted. '."\n" + .'40: daily call limit reached.', 'type' => 'string', 'example' => '已接听'], + 'CallId' => ['title' => '', 'description' => 'The outbound call ID.', 'type' => 'string', 'example' => '28dd74a4-30ec-43c0-9bec-272924c51eeb'], + 'CallType' => ['title' => '', 'description' => 'The outbound call type. Valid values:'."\n" + .'2001: batch - predictive outbound call.'."\n" + .'2002: batch - AI outbound call - no transfer to agent.'."\n" + .'2003: batch - AI outbound call - transfer to agent on answer.'."\n" + .'2004: batch - AI outbound call - intelligent transfer to agent.'."\n" + .'2005: batch - voice notification.', 'type' => 'integer', 'format' => 'int64', 'example' => '2001'], + 'CallStatus' => ['title' => '', 'description' => 'The call status code.'."\n" + .'When the number status is 1 (failed to call), valid values:'."\n" + .'-516: outbound number concurrency limit.'."\n" + .'-515: number frequency limit.'."\n" + .'-514: no line configured.'."\n" + .'-513: concurrency limit.'."\n" + .'-512: outside calling hours.'."\n" + .'-511: blocked area code.'."\n" + .'-310: waiting for distribution.'."\n" + .'-210: call canceled (repayment query failed).'."\n" + .'-110: call canceled (repayment completed).'."\n" + .'-20: agent offline.'."\n" + .'-19: agent did not answer.'."\n" + .'-18: failed to call agent.'."\n" + .'-17: call canceled.'."\n" + .'-16: call timed out.'."\n" + .'-15: failed to obtain voice gateway information.'."\n" + .'-14: failed to convert MD5 to phone number.'."\n" + .'-13: failed to pre-cache audio file.'."\n" + .'When the number status is 2 (call in progress), valid values:'."\n" + .'-12: pre-caching audio file.'."\n" + .'-11: waiting to pre-cache audio file.'."\n" + .'-10: not started.'."\n" + .'-9: waiting to call.'."\n" + .'-8: calling.'."\n" + .'-7: AI call in progress.'."\n" + .'-6: assigning agent.'."\n" + .'-5: manual call in progress.'."\n" + .'-4: monitoring ringing.'."\n" + .'-3: monitoring failed.'."\n" + .'-2: monitoring.'."\n" + .'When the number status is 3 (call completed), valid values:'."\n" + .'1: answered.'."\n" + .'2: powered off.'."\n" + .'3: invalid number.'."\n" + .'4: number changed.'."\n" + .'5: out of service.'."\n" + .'6: busy.'."\n" + .'7: rejected.'."\n" + .'8: unreachable.'."\n" + .'9: missed.'."\n" + .'10: overdue payment.'."\n" + .'11: line failure.'."\n" + .'12: call failed.'."\n" + .'30: intercepted. '."\n" + .'40: daily call limit reached.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ImportTime' => ['title' => '', 'description' => 'The import time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2023-04-25 15:19:02'], + 'NumberDesc' => ['title' => '', 'description' => 'The number status description, such as "Failed to call". Valid values:'."\n" + .'1: failed to call.'."\n" + .'2: call in progress.'."\n" + .'3: call completed.', 'type' => 'string', 'example' => '未能外呼'], + 'Number' => ['title' => '', 'description' => 'The outbound call number.', 'type' => 'string', 'example' => '188******454'], + 'InterceptReason' => ['title' => '', 'description' => 'The interception reason. When the status is intercepted, valid values: blacklist interception, graylist interception, or abnormal number interception.', 'type' => 'string', 'example' => '黑名单拦截'], + 'NumberStatus' => ['title' => '', 'description' => 'The number status. Valid values:'."\n" + .'1: failed to call.'."\n" + .'2: call in progress.'."\n" + .'3: call completed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Tag' => ['title' => '', 'description' => 'The user-defined tag.', 'type' => 'string', 'example' => 'A'], + 'NumberMD5' => ['title' => '', 'description' => 'The MD5 hash of the outbound call number.', 'type' => 'string', 'example' => 'cbe1b40f76f2cca4735954886b706ffa'], ], + 'title' => '', + 'example' => '', ], 'example' => '', + 'title' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1686279332221', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1686279332221', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"389b2d0a-37e2-406d-b576-1fc0827be46a\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 79,\\n \\"PageSize\\": 94,\\n \\"TotalPage\\": 10,\\n \\"PageNo\\": 100,\\n \\"List\\": [\\n {\\n \\"TaskId\\": 28,\\n \\"BatchId\\": 27,\\n \\"CallDesc\\": \\"已接听\\",\\n \\"CallId\\": \\"28dd74a4-30ec-43c0-9bec-272924c51eeb\\",\\n \\"CallType\\": 2001,\\n \\"CallStatus\\": 1,\\n \\"ImportTime\\": \\"2023-04-25 15:19:02\\",\\n \\"NumberDesc\\": \\"未能外呼\\",\\n \\"Number\\": \\"188******454\\",\\n \\"InterceptReason\\": \\"黑名单拦截\\",\\n \\"NumberStatus\\": 1,\\n \\"Tag\\": \\"A\\",\\n \\"NumberMD5\\": \\"cbe1b40f76f2cca4735954886b706ffa\\"\\n }\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1686279332221,\\n \\"Success\\": false\\n}","type":"json"}]', - ], - 'EditTask' => [ - 'summary' => '编辑任务接口', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query number status of an AI batch task (industry edition)', + 'description' => 'Queries the number status of an AI batch task.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:Details', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Details'], + ], ], + ], + 'EditTask' => [ + 'summary' => 'Edits a task in the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -1173,111 +925,86 @@ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务id', - 'description' => '任务id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '29', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '29'], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'title' => '任务状态', - 'description' => '任务状态', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['title' => '', 'description' => 'The task status. Modifies the task status. Valid values:'."\n" + .'- 2: started.'."\n" + .'- 4: stopped.'."\n" + ."\n" + .'If this parameter is not specified, the task status is not modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '任务名称', - 'description' => '任务名称', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], + 'schema' => ['title' => '', 'description' => 'The task name. Modifies the task name. The name cannot exceed 100 characters.'."\n" + ."\n" + .'If this parameter is not specified, the task name is not modified.', 'type' => 'string', 'required' => false, 'example' => '任务名称'."\n" + ."\n"], ], [ 'name' => 'TemplateType', 'in' => 'query', - 'schema' => [ - 'title' => '话术模板类型', - 'description' => '话术模板类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The script templatetype. Valid values:'."\n" + .'- 1: single-model template.'."\n" + .'- 2: intelligent script Policy Template.'."\n" + ."\n" + .'If you do not pass parameter, the templatetype is not modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '话术模板ID', - 'description' => '话术模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '24', - ], + 'schema' => ['title' => '', 'description' => 'The script template ID.'."\n" + ."\n" + .'If this parameter is not specified, the template ID is not modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '24'], ], [ 'name' => 'MaxConcurrency', 'in' => 'query', - 'schema' => [ - 'title' => '并发数', - 'description' => '并发数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '83', - ], + 'schema' => ['title' => '', 'description' => 'The concurrency. Modifies the concurrency. Default value: 1. The value cannot exceed the maximum concurrency configured for the enterprise.'."\n" + ."\n" + .'If this parameter is not specified, the concurrency is not modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '83'], ], [ 'name' => 'RecallType', 'in' => 'query', - 'schema' => [ - 'title' => '重呼配置', - 'description' => '重呼配置', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The recall configuration. Valid values:'."\n" + .'- 1: no recall. This is the default value.'."\n" + .'- 2: interval-based recall.'."\n" + .'- 3: scheduled recall.'."\n" + ."\n" + .'If this parameter is not specified, the recall configuration is not modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'CallTimeList', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '外呼时间', - 'description' => '外呼时间', + 'title' => '', + 'description' => 'The call time. For example, to specify 8:30-12:00 and 13:30-19:00, pass [[8.5,12][13.5,19]].'."\n" + ."\n" + .'If this parameter is not specified, the call time is not modified.', 'type' => 'array', 'items' => [ + 'title' => '', + 'description' => 'The call time. For example, to specify 8:30-12:00 and 13:30-19:00, pass [[8.5,12][13.5,19]].'."\n" + ."\n" + .'If this parameter is not specified, the call time is not modified.', 'type' => 'object', 'properties' => [ 'CallTime' => [ - 'description' => '', + 'title' => '', + 'description' => 'The call time.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '8.5', - ], + 'items' => ['title' => '', 'description' => 'The call time.', 'type' => 'string', 'required' => false, 'example' => '8.5'], 'required' => false, 'example' => '', ], ], 'required' => false, + 'example' => '', ], 'required' => false, 'example' => '', @@ -1286,41 +1013,29 @@ [ 'name' => 'RepeatInterval', 'in' => 'query', - 'schema' => [ - 'title' => '重呼间隔', - 'description' => '重呼间隔', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '91', - ], + 'schema' => ['title' => '', 'description' => 'The recall interval. Required when the recall option is set to 2. Unit: minutes. The value must be a positive integer greater than or equal to 1.'."\n" + ."\n" + .'If this parameter is not specified, the recall interval is not modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '91'], ], [ 'name' => 'RepeatCount', 'in' => 'query', - 'schema' => [ - 'title' => '重呼次数', - 'description' => '重呼次数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '51', - ], + 'schema' => ['title' => '', 'description' => 'The recall count. Required when the recall option is set to 2. The value must be a positive integer greater than or equal to 1.'."\n" + ."\n" + .'If this parameter is not specified, the recall count is not modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '51'], ], [ 'name' => 'RepeatTimes', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '重呼时间', - 'description' => '重呼时间', + 'title' => '', + 'description' => 'The recall time.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '8:30', - ], + 'items' => ['title' => '', 'description' => 'Required when the recall option is set to 3. Format: ["8:00","9:00"]. Separate multiple time points with commas. Valid values:'."\n" + .'"7:00", "7:30", "8:00", "8:30", "9:00", "9:30", "10:00", "10:30", "11:00", "11:30", "12:00", "12:30", "13:00", "13:30", "14:00", "14:30", "15:00", "15:30", "16:00", "16:30", "17:00", "17:30", "18:00", "18:30", "19:00", "19:30", "20:00", "20:30", "21:00", "21:30", "22:00"'."\n" + ."\n" + .'If this parameter is not specified, the recall time is not modified.', 'type' => 'string', 'required' => false, 'example' => '8:30'], 'required' => false, 'example' => '', ], @@ -1328,72 +1043,43 @@ [ 'name' => 'RecordPath', 'in' => 'query', - 'schema' => [ - 'title' => '录音地址', - 'description' => '录音地址', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值示例值', - ], + 'schema' => ['title' => '', 'description' => 'The recording URL.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值示例值'], ], [ 'name' => 'PlaySleepVal', 'in' => 'query', - 'schema' => [ - 'title' => '播放间隔时长', - 'description' => '播放间隔时长', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '29', - ], + 'schema' => ['title' => '', 'description' => 'The playback interval duration.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '29'], ], [ 'name' => 'PlayTimes', 'in' => 'query', - 'schema' => [ - 'title' => '录音播放次数', - 'description' => '录音播放次数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['title' => '', 'description' => 'The recording playback count.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'], ], [ 'name' => 'SendSmsPlan', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '短信发送规则', - 'description' => '短信发送规则', + 'title' => '', + 'description' => 'The SMS sending rule. Specifies the rule for sending post-hangup SMS messages. If this parameter is empty, no SMS messages are sent.', 'type' => 'array', 'items' => [ + 'title' => '', + 'description' => 'The SMS sending rule. Specifies the rule for sending post-hangup SMS messages. If this parameter is empty, no SMS messages are sent.', 'type' => 'object', 'properties' => [ 'IntentTags' => [ - 'title' => '意向标签', - 'description' => '意向标签', + 'title' => '', + 'description' => 'The intent labels.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'A', - ], + 'items' => ['title' => '', 'description' => 'The array of intent labels in uppercase. Example: ["A", "B"].', 'type' => 'string', 'required' => false, 'example' => 'A'], 'required' => false, 'example' => '', ], - 'SmsTemplateId' => [ - 'title' => '短信模板ID', - 'description' => '短信模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'SmsTemplateId' => ['title' => '', 'description' => 'The SMS template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], 'required' => false, + 'example' => '', ], 'required' => false, 'example' => '', @@ -1404,16 +1090,26 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '重呼条件', - 'description' => '重呼条件', + 'title' => '', + 'description' => 'The recall condition.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'items' => ['title' => '', 'description' => 'Multiple values can be selected. If this parameter is not specified, the default conditions are [2, 3, 4, 5, 6, 8, 9, 10, 11, 12]. The recall condition refers to the status of the previous outbound call, such as "busy" or "empty number".'."\n" + ."\n" + .'The recall condition codes and their descriptions are as follows:'."\n" + ."\n" + .'2: powered off.'."\n" + .'3: empty number.'."\n" + .'4: number changed.'."\n" + .'5: suspended.'."\n" + .'6: busy.'."\n" + .'7: rejected.'."\n" + .'8: unreachable.'."\n" + .'9: unanswered.'."\n" + .'10: overdue payment.'."\n" + .'11: line fault.'."\n" + .'12: call failed.'."\n" + .'30: intercepted.'."\n" + .'40: daily call limit reached.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], 'required' => false, 'example' => '', ], @@ -1421,110 +1117,120 @@ [ 'name' => 'CallbackUrl', 'in' => 'query', - 'schema' => [ - 'title' => '回调地址', - 'description' => '回调地址', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值示例值', - ], + 'schema' => ['title' => '', 'description' => 'The callback URL.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值示例值'], ], [ 'name' => 'FlashSmsType', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The flash SMS configuration. Default value: 0. Valid values:'."\n" + .'- 0: do not send flash SMS.'."\n" + .'- 1: send flash SMS.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'default' => ''], + ], + [ + 'name' => 'FlashSmsTemplateId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The flash SMS template ID. Required when the flash SMS configuration is set to 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'default' => ''], + ], + [ + 'name' => 'CallTimeStrList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '发送闪信配置,默认为0,0不发送闪信.1发送闪信', - 'description' => '发送闪信配置,默认为0,0不发送闪信.1发送闪信', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The call time with minute-level precision. If both this parameter and CallTimeList are specified, this parameter takes precedence. Use this parameter for minute-level precision. For example, to specify 08:31-12:05 and 13:33-19:00, pass [["08:31","12:05"]["13:33","19:00"]]. Default value: [["08:00","20:00"]].', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The call time with minute-level precision. If both this parameter and CallTimeList are specified, this parameter takes precedence. Use this parameter for minute-level precision. For example, to specify 08:31-12:05 and 13:33-19:00, pass [["08:31","12:05"]["13:33","19:00"]]. Default value: [["08:00","20:00"]].', + 'type' => 'object', + 'properties' => [ + 'CallTime' => [ + 'title' => '', + 'description' => 'The first call time string.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The first call time string.', 'type' => 'string', 'required' => false, 'example' => '"08:00"'], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], 'required' => false, - 'example' => '0', - 'default' => '', + 'example' => '', ], ], [ - 'name' => 'FlashSmsTemplateId', + 'name' => 'WeekTag', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '当发送闪信配置为1时,闪信模板ID必填', - 'description' => '当发送闪信配置为1时,闪信模板ID必填', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The days of the week for outbound calls. Example: [1,2,3,4,5,6,7], which indicates outbound calls from Monday to Sunday.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Wednesday.', 'type' => 'string', 'required' => false, 'example' => '3'], 'required' => false, - 'example' => '60', - 'default' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5453cc9b-02bc-4dbb-9527-f28a9100b912', - ], + 'AccessDeniedDetail' => ['title' => '', 'description' => 'The details of the access denial.', 'type' => 'string', 'example' => 'None'], + 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => '成功'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5453cc9b-02bc-4dbb-9527-f28a9100b912'], 'Model' => [ - 'description' => '', + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '92', - ], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '92'], ], 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1686225227338', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Timestamp' => ['title' => '', 'description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1686225227338'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"5453cc9b-02bc-4dbb-9527-f28a9100b912\\",\\n \\"Model\\": {\\n \\"TaskId\\": 92\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1686225227338,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Industry edition - edit task', + 'description' => 'Edits a task in the industry edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:EditTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"5453cc9b-02bc-4dbb-9527-f28a9100b912\\",\\n \\"Model\\": {\\n \\"TaskId\\": 92\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1686225227338,\\n \\"Success\\": true\\n}","type":"json"}]', ], 'ImportNumber' => [ - 'summary' => '导入号码', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Imports task phone numbers in batches for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1537,9 +1243,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '179241', - 'abilityTreeNodes' => [ - 'FEATUREaiccsDTMAFT', - ], + 'abilityTreeNodes' => ['FEATUREaiccsDTMAFT'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -1547,81 +1251,47 @@ [ 'name' => 'OutId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'example' => '示例值示例值', - ], + 'schema' => ['description' => 'The external ID used for idempotency control.', 'type' => 'string', 'required' => true, 'example' => '示例值示例值', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '92', - ], + 'schema' => ['description' => 'The task ID. This must be determined in advance.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '92', 'title' => ''], ], [ 'name' => 'Customers', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The outbound call customers, including specific user information such as phone numbers and names. A maximum of 1000 customers can be specified.', 'type' => 'array', 'items' => [ 'description' => 'map', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13541251222,18665214444', - ], - 'ClientUrl' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://test.com', - ], - 'Tag' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], - 'NumberMD5' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值', - ], - 'Properties' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{"testt":"123"}', - ], + 'Number' => ['description' => 'The plaintext phone number. You must specify either NumberMD5 or Number.', 'type' => 'string', 'required' => false, 'example' => '13541251222', 'title' => ''], + 'ClientUrl' => ['description' => 'The client pop-up URL. This is a special field.', 'type' => 'string', 'required' => false, 'example' => 'http://test.com', 'title' => ''], + 'Tag' => ['description' => 'The user-defined tag.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''], + 'NumberMD5' => ['description' => 'The MD5 hash of the phone number. You must specify either NumberMD5 or Number.', 'type' => 'string', 'required' => false, 'example' => '示例值', 'title' => ''], + 'Properties' => ['description' => 'The properties that must be specified based on the specific task parameter requirements. The total length is limited to 500 characters. Excess characters are truncated.', 'type' => 'object', 'required' => false, 'example' => '{"testt":"123"}', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, - 'example' => '', + 'example' => '92', + 'title' => '', ], ], [ 'name' => 'FailReturn', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'Valid values:'."\n" + .'- 0: imports the data that passes validation and returns the data that fails validation.'."\n" + .'- 1: does not import any data, including data that passes and fails validation.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -1629,88 +1299,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', - ], + 'AccessDeniedDetail' => ['description' => 'The details about the access denial. This field is returned only when RAM authentication fails.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'ImportNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '26', - ], - 'BatchId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '54', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '94', - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '状态描述', 'title' => ''], + 'ImportNum' => ['description' => 'The number of imported records.', 'type' => 'integer', 'format' => 'int64', 'example' => '26', 'title' => ''], + 'BatchId' => ['description' => 'The batch ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '54', 'title' => ''], + 'Data' => ['description' => 'The fault information.', 'type' => 'string', 'example' => '示例', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '非必填 可能没有值', 'title' => ''], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"Message\\": \\"状态描述\\",\\n \\"ImportNum\\": 26,\\n \\"BatchId\\": 54,\\n \\"Data\\": \\"示例\\",\\n \\"Code\\": 0\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'ImportNumberV2' => [ - 'summary' => '导入号码', - 'methods' => [ - 'post', + 'title' => 'Import task phone numbers in batches for the industry edition', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:ImportNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportNumber'], + ], ], + ], + 'ImportNumberV2' => [ + 'summary' => 'Imports task phone numbers in batches for the industry edition with an increased import quantity limit.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1723,9 +1366,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '262750', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -1733,82 +1374,47 @@ [ 'name' => 'OutId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值', - ], + 'schema' => ['description' => 'Required. The external transaction ID.', 'type' => 'string', 'required' => false, 'example' => '示例值', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '92', - ], + 'schema' => ['description' => 'Required. The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '89', 'title' => ''], ], [ 'name' => 'Customers', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Required. The information about the outbound call customers, such as phone numbers and names. A maximum of 1000 entries are allowed.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], - 'ClientUrl' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], - 'Tag' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], - 'NumberMD5' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], - 'Properties' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '', - ], + 'Number' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13800138000', 'title' => ''], + 'ClientUrl' => ['description' => 'The client pop-up URL. This is a special field.', 'type' => 'string', 'required' => false, 'example' => 'http://xxxx', 'title' => ''], + 'Tag' => ['description' => 'The tag.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'NumberMD5' => ['description' => 'The encrypted phone number. Either this parameter or the Number parameter must be specified.', 'type' => 'string', 'required' => false, 'example' => 'frgwryh5q4y623532542', 'title' => ''], + 'Properties' => ['description' => 'The parameters. These must be agreed upon in advance.', 'type' => 'object', 'required' => false, 'example' => '{"testt":"123"}', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, 'example' => '', + 'title' => '', ], ], [ 'name' => 'FailReturn', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Valid values:'."\n" + .'- 0: imports the data that passes validation and returns the data that fails validation.'."\n" + .'- 1: does not import any data (including data that passes and fails validation) if some data fails validation.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -1816,90 +1422,50 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason why access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功'."\n", 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'ImportNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '58', - ], - 'BatchId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '74', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '示例值示例值示例值', 'title' => ''], + 'ImportNum' => ['description' => 'The number of successfully imported entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '当前批次导入成功的数量', 'title' => ''], + 'BatchId' => ['description' => 'The batch ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '导入号码时返回的批次号', 'title' => ''], + 'Data' => ['description' => 'The fault error message.', 'type' => 'string', 'example' => '如failReturn传0,则返回该字段,可以为空;如为1,不返回。例:[{"number":"外呼号码为空或错误. 错误值:185207857231","尊称":"尊称错误,请传入中文。错误值:abc","还款金额":"值错误,请传入数字。错误值:a219.33","逾期天数":"值错误,请传入数字。错误值:今天中午十一点之前"}]}', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '98', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'title' => '', + ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '98', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\\\n\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": {\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"ImportNum\\": 0,\\n \\"BatchId\\": 0,\\n \\"Data\\": \\"如failReturn传0,则返回该字段,可以为空;如为1,不返回。例:[{\\\\\\"number\\\\\\":\\\\\\"外呼号码为空或错误. 错误值:185207857231\\\\\\",\\\\\\"尊称\\\\\\":\\\\\\"尊称错误,请传入中文。错误值:abc\\\\\\",\\\\\\"还款金额\\\\\\":\\\\\\"值错误,请传入数字。错误值:a219.33\\\\\\",\\\\\\"逾期天数\\\\\\":\\\\\\"值错误,请传入数字。错误值:今天中午十一点之前\\\\\\"}]}\\",\\n \\"Code\\": 200\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 98,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'Page' => [ - 'summary' => '查询企业黑名单', - 'methods' => [ - 'post', - 'get', + 'title' => 'Import task phone numbers in batches (industry edition V2)', + 'changeSet' => [ + ['createdAt' => '2025-05-13T14:41:07.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'Page' => [ + 'summary' => 'Query Industry Edition blocklist.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1912,9 +1478,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '179243', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -1924,39 +1488,23 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Number list.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '15823099196', - ], + 'items' => ['description' => 'Mobile phone number.', 'type' => 'string', 'required' => false, 'example' => '15823099196', 'title' => ''], 'required' => false, 'example' => '', + 'title' => '', ], ], [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The number of entries per page in a paginated query.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -1964,124 +1512,233 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', - ], + 'Message' => ['description' => 'The status code description.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '97', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'TotalPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '97', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'List' => [ - 'description' => '', + 'description' => 'The details list.', 'type' => 'array', 'items' => [ 'description' => 'map', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'title' => '手机号码', - 'description' => '手机号码', - 'type' => 'string', - 'example' => '13314206082', - ], - 'CreateTime' => [ - 'title' => '添加时间', - 'description' => '添加时间', - 'type' => 'string', - 'example' => ' 2020-03-06 10:10:10', - ], - 'NumberMD5' => [ - 'title' => '手机号MD5', - 'description' => '手机号MD5', - 'type' => 'string', - 'example' => 'e10adc3949ba59abbe56e057f20f883e', - ], - 'ExpirationTime' => [ - 'title' => '过期时间', - 'description' => '过期时间', - 'type' => 'string', - 'example' => '1', - ], - 'Remark' => [ - 'title' => '备注', - 'description' => '备注', - 'type' => 'string', - 'example' => '示例值', - ], + 'Number' => ['title' => '', 'description' => 'The mobile phone number.', 'type' => 'string', 'example' => '13314206082'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the entry was created.', 'type' => 'string', 'example' => ' 2020-03-06 10:10:10'], + 'NumberMD5' => ['title' => '', 'description' => 'The MD5 hash of the mobile phone number.', 'type' => 'string', 'example' => 'e10adc3949ba59abbe56e057f20f883e'], + 'ExpirationTime' => ['title' => '', 'description' => 'The expiration time.', 'type' => 'string', 'example' => '1'], + 'Remark' => ['title' => '', 'description' => 'The remark.', 'type' => 'string', 'example' => '备注'], ], + 'title' => '', + 'example' => '', ], 'example' => '', + 'title' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + 'Code' => ['description' => 'The status code. A return value of 0 indicates a successful request.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 97,\\n \\"PageSize\\": 20,\\n \\"TotalPage\\": 5,\\n \\"PageNo\\": 1,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"13314206082\\",\\n \\"CreateTime\\": \\" 2020-03-06 10:10:10\\",\\n \\"NumberMD5\\": \\"e10adc3949ba59abbe56e057f20f883e\\",\\n \\"ExpirationTime\\": \\"1\\",\\n \\"Remark\\": \\"备注\\"\\n }\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Industry Edition - Paginated blocklist query', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:Page', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Page'], + ], + ], + ], + 'QuickAddTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREaiccsDTMAFT'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the task.', 'type' => 'string', 'required' => true, 'example' => 'a'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The start date of the task.', 'type' => 'string', 'required' => false, 'example' => '2019-04-30'], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The script templatetype. If not specified, the default value is 1. Valid values:'."\n" + ."\n" + .'- 1: single template.'."\n" + .'- 2: intelligent script policy template.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the script template. If not specified, the script template of the copied task is used.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'SmsTemplateId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the SMS template.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ReferenceTaskId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the task to be copied.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'AgentGroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the agent group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'CallTimeList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The outbound call time.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The outbound call time.', + 'type' => 'object', + 'properties' => [ + 'CallTime' => [ + 'title' => '', + 'description' => 'The outbound call time.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The outbound call time.', 'type' => 'string', 'required' => false, 'example' => '8.5'], + 'required' => false, + 'example' => '', + ], ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', + 'required' => false, + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CallTimeStrList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The outbound call time, accurate to the minute. If both fields have values, this field takes precedence. Use this field for minute-level precision. For example, to specify 08:31-12:05 and 13:33-19:00, pass [["08:31","12:05"]["13:33","19:00"]]. Default value: [["08:00","20:00"]].', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CallTime' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'example' => '"08:00"', 'description' => '', 'title' => ''], + 'required' => false, + 'example' => '["08:00","20:00"]', + 'description' => '', + 'title' => '', + ], ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', + 'required' => false, + 'example' => 'CallTimeStrList', + 'description' => '', + 'title' => '', + ], + 'required' => false, + 'example' => '[["08:31","12:05"]["13:33","19:00"]];默认为[["08:00","20:00"]]', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The detailed reason why access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. This ID uniquely identifies the request. If an issue occurs, use the RequestId to locate the relevant records for troubleshooting.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Model' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'example' => '', + 'title' => '', ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '77', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Industry edition - quick task creation', + 'summary' => 'Quickly creates a task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 97,\\n \\"PageSize\\": 20,\\n \\"TotalPage\\": 5,\\n \\"PageNo\\": 1,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"13314206082\\",\\n \\"CreateTime\\": \\" 2020-03-06 10:10:10\\",\\n \\"NumberMD5\\": \\"e10adc3949ba59abbe56e057f20f883e\\",\\n \\"ExpirationTime\\": \\"1\\",\\n \\"Remark\\": \\"备注\\"\\n }\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"TaskId\\": 1\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 77,\\n \\"Success\\": true\\n}","type":"json"}]', ], 'SmsTemplateCreate' => [ - 'summary' => '短信模板创建', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Adds an SMS template for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2094,9 +1751,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '180596', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -2104,59 +1759,30 @@ [ 'name' => 'TemplateName', 'in' => 'query', - 'schema' => [ - 'title' => '模板名称', - 'description' => '模板名称', - 'type' => 'string', - 'required' => true, - 'example' => '示例值示例值', - ], + 'schema' => ['title' => '', 'description' => 'The name of the template.', 'type' => 'string', 'required' => true, 'example' => '模板'], ], [ 'name' => 'Sign', 'in' => 'query', - 'schema' => [ - 'title' => '短信签名', - 'description' => '短信签名', - 'type' => 'string', - 'required' => true, - 'example' => 'ef2i29fsljf', - ], + 'schema' => ['title' => '', 'description' => 'The SMS signature.', 'type' => 'string', 'required' => true, 'example' => 'ef2i29fsljf'], ], [ 'name' => 'TemplateType', 'in' => 'query', - 'schema' => [ - 'title' => '模板类型', - 'description' => '模板类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '56', - ], + 'schema' => ['title' => '', 'description' => 'The templatetype.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '模板类型,默认为1'."\n" + .'1:普通短信模板'], ], [ 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'title' => '短信内容', - 'description' => '短信内容', - 'type' => 'string', - 'required' => true, - 'example' => '示例值示例值示例值', - ], + 'schema' => ['title' => '', 'description' => 'The content of the SMS message.', 'type' => 'string', 'required' => true, 'example' => '短信内容,可增加变量,变量格式:{变量},需系统存在'], ], [ 'name' => 'SmsType', 'in' => 'query', - 'schema' => [ - 'title' => '短信类型', - 'description' => '短信类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '73', - ], + 'schema' => ['title' => '', 'description' => 'The type of the SMS message.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '短信类型,默认为3'."\n" + .'3:挂机短信'."\n" + .'4:群发短信'], ], ], 'responses' => [ @@ -2164,57 +1790,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], - 'Model' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], + 'Model' => ['description' => 'The returned result.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": \\"成功\\",\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Add an SMS template for the industry edition', + 'description' => 'Creates an SMS template for the industry edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmsTemplateCreate'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:SmsTemplateCreate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'SmsTemplatePageList' => [ - 'summary' => '短信模板列表查询', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Queries the list of SMS templates for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2225,93 +1843,51 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '180597', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], ], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '24', - ], + 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '24'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页条数', - 'description' => '每页条数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '97', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '97'], ], [ 'name' => 'TemplateType', 'in' => 'query', - 'schema' => [ - 'title' => '模板类型', - 'description' => '模板类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '19', - ], + 'schema' => ['title' => '', 'description' => 'The templatetype.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '需查询的模板类型'."\n" + .'1:普通短信模板'."\n" + .'2:智能短链模板'], ], [ 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '模板ID', - 'description' => '模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '83', - ], + 'schema' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '83'], ], [ 'name' => 'SmsType', 'in' => 'query', - 'schema' => [ - 'title' => '短信类型', - 'description' => '短信类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '42', - ], + 'schema' => ['title' => '', 'description' => 'The SMS type.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '需要查询的短信类型'."\n" + .'3:挂机短信'."\n" + .'4:群发短信'], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'title' => '模板状态', - 'description' => '模板状态', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '92', - ], + 'schema' => ['title' => '', 'description' => 'The template status.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '需要查询的模板状态'."\n" + .'1:待审核'."\n" + .'2:审核中'."\n" + .'3:审核不通过'."\n" + .'4:可应用'], ], [ 'name' => 'Sign', 'in' => 'query', - 'schema' => [ - 'title' => '短信签名', - 'description' => '短信签名', - 'type' => 'string', - 'required' => false, - 'example' => '114ah23m', - ], + 'schema' => ['title' => '', 'description' => 'The SMS signature.', 'type' => 'string', 'required' => false, 'example' => '114ah23m'], ], ], 'responses' => [ @@ -2319,155 +1895,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'TotalPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '31', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '53', - ], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '31', 'title' => ''], + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '53', 'title' => ''], 'List' => [ - 'description' => '', + 'description' => 'The list of records.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The record.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '模板状态', - 'description' => '模板状态', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18', - ], - 'SmsType' => [ - 'title' => '短信类型', - 'description' => '短信类型', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Content' => [ - 'title' => '短信内容', - 'description' => '短信内容', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2021-09-26 11:34:59', - ], - 'TemplateName' => [ - 'title' => '模板名称', - 'description' => '模板名称', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Sign' => [ - 'title' => '短信签名', - 'description' => '短信签名', - 'type' => 'string', - 'example' => 'a234n', - ], - 'TemplateType' => [ - 'title' => '模板类型', - 'description' => '模板类型', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '56', - ], - 'Properties' => [ - 'title' => '模板所需参数', - 'description' => '模板所需参数', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'TemplateId' => [ - 'title' => '模板ID', - 'description' => '模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '67', - ], - 'ShortUrlTaskId' => [ - 'title' => '智能短链ID', - 'description' => '智能短链ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '46', - ], + 'Status' => ['title' => '', 'description' => 'The template status.', 'type' => 'integer', 'format' => 'int64', 'example' => '1:待审核'."\n" + .'2:审核中'."\n" + .'3:审核不通过'."\n" + .'4:可应用'], + 'SmsType' => ['title' => '', 'description' => 'The SMS type.', 'type' => 'string', 'example' => '3:挂机短信'."\n" + .'4:群发短信'], + 'Content' => ['title' => '', 'description' => 'The SMS content.', 'type' => 'string', 'example' => '短信内容'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2021-09-26 11:34:59'], + 'TemplateName' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'example' => '短信模板10926001'], + 'Sign' => ['title' => '', 'description' => 'The SMS signature.', 'type' => 'string', 'example' => 'a234n'], + 'TemplateType' => ['title' => '', 'description' => 'The templatetype.', 'type' => 'integer', 'format' => 'int64', 'example' => '1:普通短信模板'."\n" + .'2:智能短链模板'], + 'Properties' => ['title' => '', 'description' => 'The parameters required by the template.', 'type' => 'string', 'example' => '“尊称,姓名,金额"'], + 'TemplateId' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '67'], + 'ShortUrlTaskId' => ['title' => '', 'description' => 'The intelligent short URL ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '46'], ], + 'title' => '', + 'example' => '', ], 'example' => '', + 'title' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 42,\\n \\"TotalPage\\": 31,\\n \\"PageNo\\": 53,\\n \\"List\\": [\\n {\\n \\"Status\\": 0,\\n \\"SmsType\\": \\"3:挂机短信\\\\n4:群发短信\\",\\n \\"Content\\": \\"短信内容\\",\\n \\"CreateTime\\": \\"2021-09-26 11:34:59\\",\\n \\"TemplateName\\": \\"短信模板10926001\\",\\n \\"Sign\\": \\"a234n\\",\\n \\"TemplateType\\": 0,\\n \\"Properties\\": \\"“尊称,姓名,金额\\\\\\"\\",\\n \\"TemplateId\\": 67,\\n \\"ShortUrlTaskId\\": 46\\n }\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query SMS template list for industry edition', + 'description' => 'Queries the list of SMS templates for the industry edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmsTemplatePageList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:SmsTemplatePageList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'TaskCallChats' => [ - 'summary' => '查询聊天记录接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Queries chat records for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2480,9 +1989,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '180600', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -2490,48 +1997,22 @@ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '26', - ], + 'schema' => ['title' => '', 'description' => 'The task ID in the decision system. This parameter can be left empty. At least one of the following parameters must have a value: TaskId, AgentId, and AgentTag. If multiple values are specified, the query is performed based on the following priority: TaskId > AgentId > AgentTag. Only the parameter with the highest priority is used for the query.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '26'], ], [ 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '72', - ], + 'schema' => ['title' => '', 'description' => 'The agent ID. This parameter can be left empty. At least one of the following parameters must have a value: TaskId, AgentId, and AgentTag. If multiple values are specified, the query is performed based on the following priority: TaskId > AgentId > AgentTag. Only the parameter with the highest priority is used for the query.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '72'], ], [ 'name' => 'AgentTag', 'in' => 'query', - 'schema' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'required' => false, - 'example' => 'AA', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the agent in your business system. This parameter is used to query the corresponding AgentId. This parameter can be left empty. At least one of the following parameters must have a value: TaskId, AgentId, and AgentTag. If multiple values are specified, the query is performed based on the following priority: TaskId > AgentId > AgentTag. Only the parameter with the highest priority is used for the query.', 'type' => 'string', 'required' => false, 'example' => 'AA'], ], [ 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'title' => '外呼ID', - 'description' => '外呼ID', - 'type' => 'string', - 'required' => true, - 'example' => '9b2eb6b8-7a27-4357-b5ec-104450086e24', - ], + 'schema' => ['title' => '', 'description' => 'The outbound call ID.', 'type' => 'string', 'required' => true, 'example' => '9b2eb6b8-7a27-4357-b5ec-104450086e24'], ], ], 'responses' => [ @@ -2539,81 +2020,66 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'FromNumber' => [ - 'title' => '说话号码', - 'description' => '说话号码', - 'type' => 'string', - 'example' => '138*****265', - ], - 'Content' => [ - 'title' => '说话内容', - 'description' => '说话内容', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'CreateTime' => [ - 'title' => '说话时间', - 'description' => '说话时间', - 'type' => 'string', - 'example' => '2022-01-13 14:56:46.604', - ], + 'FromNumber' => ['title' => '', 'description' => 'The number of the speaker. A value of 0 indicates the robot.', 'type' => 'string', 'example' => '138*****265'], + 'Content' => ['title' => '', 'description' => 'The content of the speech.', 'type' => 'string', 'example' => '你好,请问是a吗?'], + 'CreateTime' => ['title' => '', 'description' => 'The time of the speech. Format: 2019-01-09 14:14:19.', 'type' => 'string', 'example' => '2022-01-13 14:56:46'], ], + 'title' => '', + 'example' => '', ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": [\\n {\\n \\"FromNumber\\": \\"138*****265\\",\\n \\"Content\\": \\"你好,请问是a吗?\\",\\n \\"CreateTime\\": \\"2022-01-13 14:56:46\\"\\n }\\n ],\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query chat records for the industry edition', + 'description' => 'Queries chat records for the industry edition.', + 'requestParamsDescription' => 'At least one of the following parameters must have a value: TaskId, AgentId, and AgentTag. If multiple values are specified, the query is performed based on the following priority: TaskId > AgentId > AgentTag. Only the parameter with the highest priority is used for the query.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCallChats'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:TaskCallChats', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'TaskCallInfo' => [ - 'summary' => '获取任务外呼情况接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Retrieves the outbound call status of a task for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2621,24 +2087,12 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -2646,77 +2100,59 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '示例值示例值示例值', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'FinishTotal' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '75', - ], - 'UnCallTotal' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '59', - ], + 'FinishTotal' => ['description' => 'The number of completed outbound calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '75', 'title' => ''], + 'UnCallTotal' => ['description' => 'The number of outbound calls that failed to be made.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'Total' => ['description' => 'The total number of outbound calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '59', 'title' => ''], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '62', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '62', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Model\\": {\\n \\"FinishTotal\\": 75,\\n \\"UnCallTotal\\": 3,\\n \\"Total\\": 59\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 62,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Retrieve task outbound call status for the industry edition', + 'description' => 'Retrieves the outbound call status of a task for the industry edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCallInfo'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:TaskCallInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'TaskCallList' => [ - 'summary' => 'AI批量任务查询外呼记录接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Queries outbound call records for an industry edition AI batch task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2729,30 +2165,17 @@ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '93', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '93'], ], [ 'name' => 'IntentTags', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '意向标签', - 'description' => '意向标签', + 'title' => '', + 'description' => 'The intent tag used to filter records. For example, if you set this parameter to "C", only records with intent tag C are returned. To query multiple intent tags, specify them as ["A","B","C"].', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '"A"', - ], + 'items' => ['description' => 'The intent tag.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '"A"'], 'required' => false, 'example' => '', ], @@ -2760,28 +2183,17 @@ [ 'name' => 'BatchId', 'in' => 'query', - 'schema' => [ - 'title' => '导入号码时返回的批次号', - 'description' => '导入号码时返回的批次号', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The batch ID returned when phone numbers are imported.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'Numbers', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表', + 'title' => '', + 'description' => 'The phone numbers to query. You can specify up to 1000 numbers for exact match.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '158*****196', - ], + 'items' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '158*****196', 'title' => ''], 'required' => false, 'example' => '', ], @@ -2789,48 +2201,22 @@ [ 'name' => 'CallDate', 'in' => 'query', - 'schema' => [ - 'title' => '开始外呼时间', - 'description' => '开始外呼时间', - 'type' => 'string', - 'required' => true, - 'example' => '2022-01-25 00:00:00', - ], + 'schema' => ['title' => '', 'description' => 'The start date of outbound calls. You can query data only within the last 30 days. Format: 2020-03-06 10:10:10.', 'type' => 'string', 'required' => true, 'example' => '2022-01-25 00:00:00'], ], [ 'name' => 'EndCallDate', 'in' => 'query', - 'schema' => [ - 'title' => '结束外呼时间', - 'description' => '结束外呼时间', - 'type' => 'string', - 'required' => true, - 'example' => '2022-01-25 00:00:00', - ], + 'schema' => ['title' => '', 'description' => 'The end time of outbound calls. You can query data for only one day. The start call date and end call date must be different time points on the same day. Format: 2020-03-06 10:10:10.', 'type' => 'string', 'required' => true, 'example' => '2022-01-25 00:00:00'], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => '页数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '39', - ], + 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '39'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页外呼记录数,正整数,默认10000', - 'description' => '每页外呼记录数,正整数,默认10000', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '97', - ], + 'schema' => ['title' => '', 'description' => 'The number of outbound call records per page. The value must be a positive integer. Default value: 10000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '97'], ], ], 'responses' => [ @@ -2838,349 +2224,154 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '95', - ], - 'TotalPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '39', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '62', - ], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '80', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '95', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '39', 'title' => ''], + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '62', 'title' => ''], 'List' => [ - 'description' => '', + 'description' => 'The list of records.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The record.', 'type' => 'object', 'properties' => [ - 'AddWx' => [ - 'title' => '加微', - 'description' => '加微', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TaskId' => [ - 'title' => '外呼任务ID', - 'description' => '外呼任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '70', - ], - 'Keywords' => [ - 'title' => '回复关键词', - 'description' => '回复关键词', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'AgentExtension' => [ - 'title' => '坐席分机', - 'description' => '坐席分机', - 'type' => 'string', - 'example' => '112', - ], - 'CallType' => [ - 'title' => '外呼类型', - 'description' => '外呼类型', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1001', - ], - 'AnswerTime' => [ - 'title' => '接通时间', - 'description' => '接通时间', - 'type' => 'string', - 'example' => '2022-01-26 18:58:25', - ], - 'IntentTag' => [ - 'title' => '意向标签', - 'description' => '意向标签', - 'type' => 'string', - 'example' => '“C”', - ], - 'TransferStatusCode' => [ - 'title' => '转人工状态编码', - 'description' => '转人工状态编码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ImportTime' => [ - 'title' => '导入时间', - 'description' => '导入时间', - 'type' => 'string', - 'example' => '2022-01-26 18:58:25', - ], - 'IndividualTag' => [ - 'title' => '个性标签', - 'description' => '个性标签', - 'type' => 'string', - 'example' => 'A', - ], - 'Properties' => [ - 'title' => '参数', - 'description' => '参数', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'StatusCode' => [ - 'title' => '外呼状态编码', - 'description' => '外呼状态编码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AgentSpeakingDuration' => [ - 'title' => '人工通话时长', - 'description' => '人工通话时长', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '98', - ], - 'Remark' => [ - 'title' => '备注', - 'description' => '备注', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'CallTimes' => [ - 'title' => '呼叫次数', - 'description' => '呼叫次数', - 'type' => 'string', - 'example' => '1', - ], - 'Number' => [ - 'title' => '外呼号码', - 'description' => '外呼号码', - 'type' => 'string', - 'example' => '138*****123', - ], - 'InterceptReason' => [ - 'title' => '拦截原因', - 'description' => '拦截原因', - 'type' => 'string', - 'example' => '示例值', - ], - 'IntentDescription' => [ - 'title' => '意向说明', - 'description' => '意向说明', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'StatusDescription' => [ - 'title' => '外呼状态描述', - 'description' => '外呼状态描述', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'SpeakingDuration' => [ - 'title' => 'AI通话时长', - 'description' => 'AI通话时长', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '45', - ], - 'Gateway' => [ - 'title' => '外呼网关', - 'description' => '外呼网关', - 'type' => 'string', - 'example' => '123', - ], - 'TransferStatus' => [ - 'title' => '转人工状态', - 'description' => '转人工状态', - 'type' => 'string', - 'example' => '示例值', - ], - 'AgentId' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '87', - ], - 'TemplateId' => [ - 'title' => 'AI话术ID', - 'description' => 'AI话术ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '66', - ], - 'AgentTag' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'example' => 'A', - ], - 'Status' => [ - 'title' => '外呼状态', - 'description' => '外呼状态', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'CallId' => [ - 'title' => '外呼ID', - 'description' => '外呼ID', - 'type' => 'string', - 'example' => '9197ed9e-ceda-42a5-b683-823b23ef208e', - ], - 'BatchId' => [ - 'title' => '批次ID', - 'description' => '批次ID', - 'type' => 'string', - 'example' => '1', - ], - 'HangupTime' => [ - 'title' => '挂断时间', - 'description' => '挂断时间', - 'type' => 'string', - 'example' => '2022-01-26 18:58:25', - ], - 'CallBeginTime' => [ - 'title' => '开始通话时间', - 'description' => '开始通话时间', - 'type' => 'string', - 'example' => '2022-01-26 18:58:25', - ], - 'RingTime' => [ - 'title' => '振铃时长', - 'description' => '振铃时长', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '66', - ], - 'AgentSpeakingTime' => [ - 'title' => '人工通话时长', - 'description' => '人工通话时长', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'AddWxStatus' => [ - 'title' => '加微进度', - 'description' => '加微进度', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'HangupType' => [ - 'title' => '挂机方式', - 'description' => '挂机方式', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SpeakingTurns' => [ - 'title' => '对话轮次', - 'description' => '对话轮次', - 'type' => 'string', - 'example' => '0', - ], - 'Sms' => [ - 'title' => '挂机短信', - 'description' => '挂机短信', - 'type' => 'string', - 'example' => '示例值', - ], - 'AnswerRecall' => [ - 'title' => '是否接通重呼', - 'description' => '是否接通重呼', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - 'Tag' => [ - 'title' => '用户自定义标签', - 'description' => '用户自定义标签', - 'type' => 'string', - 'example' => '示例值', - ], - 'NumberMD5' => [ - 'title' => '外呼号码MD5', - 'description' => '外呼号码MD5', - 'type' => 'string', - 'example' => '75916b635568954583783d', - ], - 'ChatRecord' => [ - 'title' => '对话录音', - 'description' => '对话录音', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'SpeakingTime' => [ - 'title' => 'AI通话时长', - 'description' => 'AI通话时长', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], + 'AddWx' => ['title' => '', 'description' => 'Indicates whether to add WeChat. Valid values:'."\n" + .'- 0: Do not add.'."\n" + .'- 1: Add.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TaskId' => ['title' => '', 'description' => 'The outbound call task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '70'], + 'Keywords' => ['title' => '', 'description' => 'The reply keywords.', 'type' => 'string', 'example' => '好'], + 'AgentExtension' => ['title' => '', 'description' => 'The agent extension number.', 'type' => 'string', 'example' => '112'], + 'CallType' => ['title' => '', 'description' => 'The outbound call type. Valid values:'."\n" + .'- 1001: Agent - manual outbound call.'."\n" + .'- 1002: Agent - AI outbound call - no transfer to agent.'."\n" + .'- 1003: Agent - AI outbound call - transfer to agent upon connection.'."\n" + .'- 1004: Agent - AI outbound call - intelligent transfer to agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '1001'], + 'AnswerTime' => ['title' => '', 'description' => 'The time when the call was answered. Format: 2019-01-09 14:14:19.', 'type' => 'string', 'example' => '2022-01-26 18:58:25'], + 'IntentTag' => ['title' => '', 'description' => 'The intent tag.', 'type' => 'string', 'example' => '“C”'], + 'TransferStatusCode' => ['title' => '', 'description' => 'The status code for transfer to agent, such as 1 or 2. This value can be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ImportTime' => ['title' => '', 'description' => 'The import time. Format: 2019-01-09 14:14:19.', 'type' => 'string', 'example' => '2022-01-26 18:58:25'], + 'IndividualTag' => ['title' => '', 'description' => 'The individual tags, such as "投诉,非本人". This value can be empty.', 'type' => 'string', 'example' => 'A'], + 'Properties' => ['title' => '', 'description' => 'The parameter values specified when phone numbers are imported, in JSON format.', 'type' => 'string', 'example' => '{\\"电话号码\\":\\"13100000000\\"}'], + 'StatusCode' => ['title' => '', 'description' => 'The outbound call status code, such as 1 or 2.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AgentSpeakingDuration' => ['title' => '', 'description' => 'The agent speaking duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '98'], + 'Remark' => ['title' => '', 'description' => 'The manual remarks. Example:', 'type' => 'string', 'example' => '备注内容'], + 'CallTimes' => ['title' => '', 'description' => 'The number of call attempts.', 'type' => 'string', 'example' => '1'], + 'Number' => ['title' => '', 'description' => 'The outbound call number.', 'type' => 'string', 'example' => '138*****123'], + 'InterceptReason' => ['title' => '', 'description' => 'The interception reason. When the status is intercepted, valid values: blacklist interception, graylist interception, or abnormal number interception.', 'type' => 'string', 'example' => '黑名单拦截,灰名单拦截,异常号码拦截'], + 'IntentDescription' => ['title' => '', 'description' => 'The intent description, such as "确认本人,未承诺还款".', 'type' => 'string', 'example' => '如“确认本人,未承诺还款”'], + 'StatusDescription' => ['title' => '', 'description' => 'The outbound call status description.', 'type' => 'string', 'example' => '外呼状态,如“已接听”“拒接”'."\n" + .'注,转外呼状态编码与描述对应:'."\n" + .'1 "已接听",'."\n" + .'2 "关机",'."\n" + .'3 "空号",'."\n" + .'4 "改号",'."\n" + .'5 "停机",'."\n" + .'6 "占线",'."\n" + .'7 "拒接",'."\n" + .'8 "无法接通",'."\n" + .'9 "未接",'."\n" + .'10 "用户欠费",'."\n" + .'11 "线路故障",'."\n" + .'12 "呼叫失败"'."\n" + .'30 "已拦截" '."\n" + .'40 "单日呼叫次数受限"'."\n" + .'50 "取消外呼-已转化" '], + 'SpeakingDuration' => ['title' => '', 'description' => 'The call duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '45'], + 'Gateway' => ['title' => '', 'description' => 'The outbound call gateway.', 'type' => 'string', 'example' => '123'], + 'TransferStatus' => ['title' => '', 'description' => 'The transfer-to-agent status.', 'type' => 'string', 'example' => '转人工状态,可以为空,如未触发、分配坐席失败'."\n" + .'注,转人工状态编码与状态对应:'."\n" + .'0 "未触发",'."\n" + .'1 "分配坐席失败",'."\n" + .'2 "无空闲坐席分配",'."\n" + .'10 "振铃未接听",'."\n" + .'11 "振铃占线",'."\n" + .'12 "振铃话机离线",'."\n" + .'13 "振铃失败",'."\n" + .'14 "监听失败",'."\n" + .'20 "监听未接听",'."\n" + .'30 "已接听",'."\n" + .'31 "接听失败"'], + 'AgentId' => ['title' => '', 'description' => 'The agent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '87'], + 'TemplateId' => ['title' => '', 'description' => 'The AI script ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '66'], + 'AgentTag' => ['title' => '', 'description' => 'The agent tag.', 'type' => 'string', 'example' => 'A'], + 'Status' => ['title' => '', 'description' => 'The outbound call status.', 'type' => 'string', 'example' => '未接、占线、拒接、用户欠费、线路故障、呼叫失败、已接听、无法接通、关机、停机、改号、空号、无效接通、已拦截、单日呼叫次数受限、取消外呼-已转化'], + 'CallId' => ['title' => '', 'description' => 'The outbound call ID.', 'type' => 'string', 'example' => '9197ed9e-ceda-42a5-b683-823b23ef208e'], + 'BatchId' => ['title' => '', 'description' => 'The batch ID.', 'type' => 'string', 'example' => '1'], + 'HangupTime' => ['title' => '', 'description' => 'The call hangup time. Format: 2019-01-09 14:14:19.', 'type' => 'string', 'example' => '2022-01-26 18:58:25'], + 'CallBeginTime' => ['title' => '', 'description' => 'The call start time. Format: 2019-11-23 14:47:06.', 'type' => 'string', 'example' => '2022-01-26 18:58:25'], + 'RingTime' => ['title' => '', 'description' => 'The ring duration. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '66'], + 'AgentSpeakingTime' => ['title' => '', 'description' => 'The agent speaking duration. If the duration is greater than 1 minute, the value is displayed in minutes and seconds. If the duration is less than 1 minute, the value is displayed in seconds.', 'type' => 'string', 'example' => '0秒'], + 'AddWxStatus' => ['title' => '', 'description' => 'The WeChat addition progress.', 'type' => 'string', 'example' => '可选值:已申请、加微成功'], + 'HangupType' => ['title' => '', 'description' => 'The hangup type. Valid values:'."\n" + .'- 1: AI hangup.'."\n" + .'- 2: Agent hangup.'."\n" + .'- 3: Customer hangup.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SpeakingTurns' => ['title' => '', 'description' => 'The number of conversation turns.', 'type' => 'string', 'example' => '0'], + 'Sms' => ['title' => '', 'description' => 'The post-hangup SMS message.', 'type' => 'string', 'example' => '1、2'."\n" + .'1:发送,2:不发送'], + 'AnswerRecall' => ['title' => '', 'description' => 'Indicates whether the call is a redial after connection.', 'type' => 'integer', 'format' => 'int64', 'example' => '可选值:0、1'."\n" + .'0正常外呼,1接通重呼'], + 'Tag' => ['title' => '', 'description' => 'The user-defined tag.', 'type' => 'string', 'example' => '好'], + 'NumberMD5' => ['title' => '', 'description' => 'The MD5 hash of the outbound call number.', 'type' => 'string', 'example' => '75916b635568954583783d'], + 'ChatRecord' => ['title' => '', 'description' => 'The conversation recording.', 'type' => 'string', 'example' => 'URL,可以为空'], + 'SpeakingTime' => ['title' => '', 'description' => 'The call duration. If the duration is greater than 1 minute, the value is displayed in minutes and seconds. If the duration is less than 1 minute, the value is displayed in seconds.', 'type' => 'string', 'example' => '0秒'], ], + 'title' => '', + 'example' => '', ], 'example' => '', + 'title' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 80,\\n \\"PageSize\\": 95,\\n \\"TotalPage\\": 39,\\n \\"PageNo\\": 62,\\n \\"List\\": [\\n {\\n \\"AddWx\\": 0,\\n \\"TaskId\\": 70,\\n \\"Keywords\\": \\"好\\",\\n \\"AgentExtension\\": \\"112\\",\\n \\"CallType\\": 1001,\\n \\"AnswerTime\\": \\"2022-01-26 18:58:25\\",\\n \\"IntentTag\\": \\"“C”\\",\\n \\"TransferStatusCode\\": 1,\\n \\"ImportTime\\": \\"2022-01-26 18:58:25\\",\\n \\"IndividualTag\\": \\"A\\",\\n \\"Properties\\": \\"{\\\\\\\\\\\\\\"电话号码\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"13100000000\\\\\\\\\\\\\\"}\\",\\n \\"StatusCode\\": 1,\\n \\"AgentSpeakingDuration\\": 98,\\n \\"Remark\\": \\"备注内容\\",\\n \\"CallTimes\\": \\"1\\",\\n \\"Number\\": \\"138*****123\\",\\n \\"InterceptReason\\": \\"黑名单拦截,灰名单拦截,异常号码拦截\\",\\n \\"IntentDescription\\": \\"如“确认本人,未承诺还款”\\",\\n \\"StatusDescription\\": \\"外呼状态,如“已接听”“拒接”\\\\n注,转外呼状态编码与描述对应:\\\\n1 \\\\\\"已接听\\\\\\",\\\\n2 \\\\\\"关机\\\\\\",\\\\n3 \\\\\\"空号\\\\\\",\\\\n4 \\\\\\"改号\\\\\\",\\\\n5 \\\\\\"停机\\\\\\",\\\\n6 \\\\\\"占线\\\\\\",\\\\n7 \\\\\\"拒接\\\\\\",\\\\n8 \\\\\\"无法接通\\\\\\",\\\\n9 \\\\\\"未接\\\\\\",\\\\n10 \\\\\\"用户欠费\\\\\\",\\\\n11 \\\\\\"线路故障\\\\\\",\\\\n12 \\\\\\"呼叫失败\\\\\\"\\\\n30 \\\\\\"已拦截\\\\\\" \\\\n40 \\\\\\"单日呼叫次数受限\\\\\\"\\\\n50 \\\\\\"取消外呼-已转化\\\\\\" \\",\\n \\"SpeakingDuration\\": 45,\\n \\"Gateway\\": \\"123\\",\\n \\"TransferStatus\\": \\"转人工状态,可以为空,如未触发、分配坐席失败\\\\n注,转人工状态编码与状态对应:\\\\n0 \\\\\\"未触发\\\\\\",\\\\n1 \\\\\\"分配坐席失败\\\\\\",\\\\n2 \\\\\\"无空闲坐席分配\\\\\\",\\\\n10 \\\\\\"振铃未接听\\\\\\",\\\\n11 \\\\\\"振铃占线\\\\\\",\\\\n12 \\\\\\"振铃话机离线\\\\\\",\\\\n13 \\\\\\"振铃失败\\\\\\",\\\\n14 \\\\\\"监听失败\\\\\\",\\\\n20 \\\\\\"监听未接听\\\\\\",\\\\n30 \\\\\\"已接听\\\\\\",\\\\n31 \\\\\\"接听失败\\\\\\"\\",\\n \\"AgentId\\": 87,\\n \\"TemplateId\\": 66,\\n \\"AgentTag\\": \\"A\\",\\n \\"Status\\": \\"未接、占线、拒接、用户欠费、线路故障、呼叫失败、已接听、无法接通、关机、停机、改号、空号、无效接通、已拦截、单日呼叫次数受限、取消外呼-已转化\\",\\n \\"CallId\\": \\"9197ed9e-ceda-42a5-b683-823b23ef208e\\",\\n \\"BatchId\\": \\"1\\",\\n \\"HangupTime\\": \\"2022-01-26 18:58:25\\",\\n \\"CallBeginTime\\": \\"2022-01-26 18:58:25\\",\\n \\"RingTime\\": 66,\\n \\"AgentSpeakingTime\\": \\"0秒\\",\\n \\"AddWxStatus\\": \\"可选值:已申请、加微成功\\",\\n \\"HangupType\\": 1,\\n \\"SpeakingTurns\\": \\"0\\",\\n \\"Sms\\": \\"1、2\\\\n1:发送,2:不发送\\",\\n \\"AnswerRecall\\": 0,\\n \\"Tag\\": \\"好\\",\\n \\"NumberMD5\\": \\"75916b635568954583783d\\",\\n \\"ChatRecord\\": \\"URL,可以为空\\",\\n \\"SpeakingTime\\": \\"0秒\\"\\n }\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Query outbound call records for an industry edition AI batch task', + 'description' => 'Queries outbound call records for an industry edition AI batch task.', + 'requestParamsDescription' => 'The end time of outbound calls. You can query data for only one day. The start call date and end call date must be different time points on the same day. Format: 2020-03-06 10:10:10.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCallList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'aiccs:TaskCallList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'TaskCancelCall' => [ - 'summary' => '批量任务取消号码外呼', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Cancels outbound calls for a task in the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3188,43 +2379,24 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30', - 'default' => '', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30', 'default' => ''], ], [ 'name' => 'Numbers', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The list of phone numbers.', 'type' => 'array', - 'items' => [ - 'title' => '号码', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13661109390', - ], + 'items' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13661109390'], 'required' => false, 'example' => '', + 'title' => '', ], ], [ @@ -3232,18 +2404,13 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The list of labels.', 'type' => 'array', - 'items' => [ - 'title' => '用户自定义标签', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], + 'items' => ['title' => '', 'description' => 'The custom label.', 'type' => 'string', 'required' => false, 'example' => 'tag1'], 'required' => false, 'example' => '', 'default' => '', + 'title' => '', ], ], ], @@ -3252,69 +2419,62 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'UnHandleNumbers' => [ - 'title' => '错误手机号', - 'description' => '错误手机号', + 'title' => '', + 'description' => 'The list of unrecognized phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '13541251222,18665214444', - ], + 'items' => ['description' => 'The unrecognized phone number.', 'type' => 'string', 'example' => '13541251222,18665214444', 'title' => ''], 'example' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"UnHandleNumbers\\": [\\n \\"13541251222,18665214444\\"\\n ]\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'TaskList' => [ - 'summary' => '查询任务列表接口', - 'methods' => [ - 'post', - 'get', + 'title' => 'Cancel outbound calls for a task in the industry edition', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:TaskCancelCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCancelCall'], + ], ], + ], + 'TaskList' => [ + 'summary' => 'Queries the task list for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3327,290 +2487,198 @@ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], ], [ 'name' => 'LastCallTime', 'in' => 'query', - 'schema' => [ - 'title' => '最后外呼时间', - 'description' => '最后外呼时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-05 12:11:11', - ], + 'schema' => ['title' => '', 'description' => 'The time of the last outbound call.', 'type' => 'string', 'required' => false, 'example' => '2023-04-05 12:11:11'], ], [ 'name' => 'CreateTime', 'in' => 'query', - 'schema' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-05 12:11:11', - ], + 'schema' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'required' => false, 'example' => '2023-04-05 12:11:11'], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'title' => '任务状态。1 未启用,2 启用中,4 已停止', - 'description' => '任务状态。1 未启用,2 启用中,4 已停止', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['title' => '', 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'- 2: Published.'."\n" + ."\n" + .'- 4: Disabled.'."\n" + ."\n" + .'- 6: Deleted.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason for the access denial.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功'."\n", 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-****-1ECA-****-7CBDF776AAD2'."\n", 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '任务状态', - 'description' => '任务状态', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '79', - ], - 'AllowDayOfWeek' => [ - 'title' => '外呼时间', - 'description' => '外呼时间', - 'type' => 'string', - 'example' => '“1,2,3”', - ], - 'TaskId' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '68', - ], + 'Status' => ['title' => '', 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'- 2: Published.'."\n" + ."\n" + .'- 4: Disabled.'."\n" + ."\n" + .'- 6: Deleted.', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'AllowDayOfWeek' => ['title' => '', 'description' => 'The outbound call days of the week. Valid values:'."\n" + ."\n" + .'- 1: Monday.'."\n" + ."\n" + .'- 2: Tuesday.'."\n" + ."\n" + .'- 3: Wednesday.'."\n" + ."\n" + .'- 4: Thursday.'."\n" + ."\n" + .'- 5: Friday.'."\n" + ."\n" + .'- 6: Saturday.'."\n" + ."\n" + .'- 7: Sunday.', 'type' => 'string', 'example' => '1,2,3'], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '68'], 'IntentTags' => [ - 'title' => '意向标签列表', - 'description' => '意向标签列表', + 'title' => '', + 'description' => 'The list of intent tags.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The intent tag object.', 'type' => 'object', 'properties' => [ - 'IntentDescription' => [ - 'title' => '意向标签描述', - 'description' => '意向标签描述', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'IntentTag' => [ - 'title' => '意向标签ID', - 'description' => '意向标签ID', - 'type' => 'string', - 'example' => '示例值示例值', - ], + 'IntentDescription' => ['title' => '', 'description' => 'The description of the intent tag.', 'type' => 'string', 'example' => '满意'], + 'IntentTag' => ['title' => '', 'description' => 'The intent tag ID.', 'type' => 'string', 'example' => '123'], ], + 'title' => '', + 'example' => '', ], 'example' => '', ], - 'Priority' => [ - 'title' => '优先任务', - 'description' => '优先任务', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '66', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2023-04-05 12:11:11'."\n", - ], - 'CallType' => [ - 'title' => '外呼类型', - 'description' => '外呼类型', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '95', - ], - 'MaxConcurrency' => [ - 'title' => '最大并发数', - 'description' => '最大并发数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '95', - ], + 'Priority' => ['title' => '', 'description' => 'Specifies whether the task is a priority task. Valid values:'."\n" + ."\n" + .'- 1: No.'."\n" + ."\n" + .'- 2: Yes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2023-04-05 12:11:11'."\n"], + 'CallType' => ['title' => '', 'description' => 'The outbound call type. Valid values:'."\n" + ."\n" + .'- 1001: Agent - manual outbound call.'."\n" + ."\n" + .'- 1002: Agent - AI outbound call - no transfer to agent.'."\n" + ."\n" + .'- 1003: Agent - AI outbound call - transfer to agent upon connection.'."\n" + ."\n" + .'- 1004: Agent - AI outbound call - intelligent transfer to agent.'."\n" + ."\n" + .'- 2001: Batch - predictive outbound call.'."\n" + ."\n" + .'- 2002: Batch - AI outbound call - no transfer to agent.'."\n" + ."\n" + .'- 2003: Batch - AI outbound call - transfer to agent upon connection.'."\n" + ."\n" + .'- 2004: Batch - AI outbound call - intelligent transfer to agent.'."\n" + ."\n" + .'- 2005: Batch - voice notification.', 'type' => 'integer', 'format' => 'int64', 'example' => '1001'], + 'MaxConcurrency' => ['title' => '', 'description' => 'The maximum concurrency.', 'type' => 'integer', 'format' => 'int64', 'example' => '95'], 'PersonalityTags' => [ - 'title' => '个性标签列表', - 'description' => '个性标签列表', + 'title' => '', + 'description' => 'The list of personality tags.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AA', - ], + 'items' => ['description' => 'The personality tag.', 'type' => 'string', 'example' => 'AA', 'title' => ''], 'example' => '', ], - 'SendSms' => [ - 'title' => '发送短信', - 'description' => '发送短信', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '39', - ], - 'ImportTime' => [ - 'title' => '最近导入时间', - 'description' => '最近导入时间', - 'type' => 'string', - 'example' => '2023-04-05 12:11:11', - ], - 'Properties' => [ - 'title' => '任务所需参数', - 'description' => '任务所需参数', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'FlashSmsTemplateName' => [ - 'title' => '闪信模板名称', - 'description' => '闪信模板名称', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'AllowCallTimeFormat' => [ - 'title' => '外呼时间段格式化', - 'description' => '外呼时间段格式化', - 'type' => 'string', - 'example' => '“8:00 ~ 20:00”', - ], - 'LastCallTime' => [ - 'title' => '最后外呼时间', - 'description' => '最后外呼时间', - 'type' => 'string', - 'example' => '2023-04-05 12:11:11', - ], - 'TaskName' => [ - 'title' => '任务名称', - 'description' => '任务名称', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RecallType' => [ - 'title' => '自动重呼', - 'description' => '自动重呼', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'TemplateName' => [ - 'title' => '话术模板名称', - 'description' => '话术模板名称', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'SmsName' => [ - 'title' => '短信模板', - 'description' => '短信模板', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'AllowCallTime' => [ - 'title' => '外呼时间段', - 'description' => '外呼时间段', - 'type' => 'string', - 'example' => '“8:00~20:30”', - ], - 'FlashSmsTemplateId' => [ - 'title' => '闪信模板id', - 'description' => '闪信模板id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '99', - ], - 'TemplateId' => [ - 'title' => '话术模板Id', - 'description' => '话术模板Id', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'InvalidReCall' => [ - 'title' => '接通重呼次数', - 'description' => '接通重呼次数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '31', - ], - 'FlashSmsType' => [ - 'title' => '发送闪信配置,可选0,1;0表示否,1表示是', - 'description' => '发送闪信配置,可选0,1;0表示否,1表示是', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], + 'SendSms' => ['title' => '', 'description' => 'Specifies whether to send SMS messages. Valid values:'."\n" + ."\n" + .'- 1: No.'."\n" + ."\n" + .'- 2: Yes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ImportTime' => ['title' => '', 'description' => 'The most recent import time.', 'type' => 'string', 'example' => '2023-04-05 12:11:11'], + 'Properties' => ['title' => '', 'description' => 'The parameters required by the task.', 'type' => 'string', 'example' => '尊称,姓名,金额'], + 'FlashSmsTemplateName' => ['title' => '', 'description' => 'The flash SMS template name.', 'type' => 'string', 'example' => '示例值'], + 'AllowCallTimeFormat' => ['title' => '', 'description' => 'The formatted outbound call time period.', 'type' => 'string', 'example' => '9:00 ~ 12:00\\n13.5 ~ 20'], + 'LastCallTime' => ['title' => '', 'description' => 'The time of the last outbound call.', 'type' => 'string', 'example' => '2023-04-05 12:11:11'], + 'TaskName' => ['title' => '', 'description' => 'The task name.', 'type' => 'string', 'example' => '第一个外呼任务'], + 'RecallType' => ['title' => '', 'description' => 'The automatic recall type. Valid values:'."\n" + ."\n" + .'- 1: No recall.'."\n" + ."\n" + .'- 2: Interval recall.'."\n" + ."\n" + .'- 3: Scheduled recall.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TemplateName' => ['title' => '', 'description' => 'The script template name.', 'type' => 'string', 'example' => '第一个话术'], + 'SmsName' => ['title' => '', 'description' => 'The SMS template.', 'type' => 'string', 'example' => '短信02np'], + 'AllowCallTime' => ['title' => '', 'description' => 'The outbound call time period.', 'type' => 'string', 'example' => '[[9,12],[[13.5,20]]]'], + 'FlashSmsTemplateId' => ['title' => '', 'description' => 'The flash SMS template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '99'], + 'TemplateId' => ['title' => '', 'description' => 'The script template ID.', 'type' => 'string', 'example' => '123'], + 'InvalidReCall' => ['title' => '', 'description' => 'The recall setting for connected calls. Valid values:'."\n" + ."\n" + .'- 1: No recall.'."\n" + ."\n" + .'- 2: Recall.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'FlashSmsType' => ['title' => '', 'description' => 'Specifies whether to send flash SMS messages. Valid values:'."\n" + ."\n" + .'- 0: No.'."\n" + ."\n" + .'- 1: Yes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'title' => '', + 'example' => '', ], 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'title' => '', + ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '80', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"成功\\\\n\\",\\n \\"RequestId\\": \\"8EFC6D10-****-1ECA-****-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": [\\n {\\n \\"Status\\": 4,\\n \\"AllowDayOfWeek\\": \\"1,2,3\\",\\n \\"TaskId\\": 68,\\n \\"IntentTags\\": [\\n {\\n \\"IntentDescription\\": \\"满意\\",\\n \\"IntentTag\\": \\"123\\"\\n }\\n ],\\n \\"Priority\\": 1,\\n \\"CreateTime\\": \\"2023-04-05 12:11:11\\\\n\\",\\n \\"CallType\\": 1001,\\n \\"MaxConcurrency\\": 95,\\n \\"PersonalityTags\\": [\\n \\"AA\\"\\n ],\\n \\"SendSms\\": 1,\\n \\"ImportTime\\": \\"2023-04-05 12:11:11\\",\\n \\"Properties\\": \\"尊称,姓名,金额\\",\\n \\"FlashSmsTemplateName\\": \\"示例值\\",\\n \\"AllowCallTimeFormat\\": \\"9:00 ~ 12:00\\\\\\\\n13.5 ~ 20\\",\\n \\"LastCallTime\\": \\"2023-04-05 12:11:11\\",\\n \\"TaskName\\": \\"第一个外呼任务\\",\\n \\"RecallType\\": 1,\\n \\"TemplateName\\": \\"第一个话术\\",\\n \\"SmsName\\": \\"短信02np\\",\\n \\"AllowCallTime\\": \\"[[9,12],[[13.5,20]]]\\",\\n \\"FlashSmsTemplateId\\": 99,\\n \\"TemplateId\\": \\"123\\",\\n \\"InvalidReCall\\": 1,\\n \\"FlashSmsType\\": 1\\n }\\n ],\\n \\"Code\\": 0,\\n \\"Timestamp\\": 80,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query task list for industry edition', + 'description' => 'Queries the task list for the industry edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'aiccs:TaskList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'TaskRecoverCall' => [ - 'summary' => '批量任务恢复号码', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Resumes outbound calls for canceled numbers in a task (industry edition). For numbers that have been canceled in a task, you can call this operation to resume them and add them back to the outbound call queue.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3618,40 +2686,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '93', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '93'], ], [ 'name' => 'Tags', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户自定义标签列表', - 'description' => '用户自定义标签列表', + 'title' => '', + 'description' => 'The list of custom tags.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], + 'items' => ['description' => 'The label.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''], 'required' => false, 'example' => '', ], @@ -3661,15 +2711,10 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表', + 'title' => '', + 'description' => 'The list of phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13541251222,18665214444', - ], + 'items' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13541251222,18665214444', 'title' => ''], 'required' => false, 'example' => '', ], @@ -3677,24 +2722,12 @@ [ 'name' => 'BeginImportTime', 'in' => 'query', - 'schema' => [ - 'title' => '查询开始导入时间', - 'description' => '查询开始导入时间', - 'type' => 'string', - 'required' => false, - 'example' => '"2023-01-09 18:58:19"', - ], + 'schema' => ['title' => '', 'description' => 'The start time of the import time range to query.', 'type' => 'string', 'required' => false, 'example' => '"2023-01-09 18:58:19"'], ], [ 'name' => 'EndImportTime', 'in' => 'query', - 'schema' => [ - 'title' => '查询结束导入时间', - 'description' => '查询结束导入时间', - 'type' => 'string', - 'required' => false, - 'example' => '"2023-01-09 18:58:19"', - ], + 'schema' => ['title' => '', 'description' => 'The end time of the import time range to query.', 'type' => 'string', 'required' => false, 'example' => '"2023-01-09 18:58:19"'], ], ], 'responses' => [ @@ -3702,57 +2735,48 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', 'title' => ''], + 'Model' => ['description' => 'The returned result.', 'type' => 'object', 'example' => '无内容', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'TemplateList' => [ - 'summary' => '话术模板列表查询接口', - 'methods' => [ - 'post', - 'get', + 'title' => 'Resume task outbound calls (industry edition)', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:TaskRecoverCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskRecoverCall'], + ], ], + ], + 'TemplateList' => [ + 'summary' => 'Queries the list of industry edition script templates.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3765,125 +2789,94 @@ [ 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '必须空参', - 'description' => '必须空参', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '9', - ], + 'schema' => ['title' => '', 'description' => 'Required empty parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '9'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'object', 'properties' => [ 'IntentTags' => [ - 'title' => '意向标签', - 'description' => '意向标签', + 'title' => '', + 'description' => 'The intent tags.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'example' => '', - ], + 'items' => ['description' => '{'."\n" + .' "intentDescription": "已成为客户",'."\n" + .' "intentTag": "A"'."\n" + .' }.', 'type' => 'object', 'title' => '', 'example' => '{'."\n" + .' "intentDescription": "已成为客户",'."\n" + .' "intentTag": "A"'."\n" + .' }'], 'example' => '', ], - 'TemplateName' => [ - 'title' => '话术模板名称', - 'description' => '话术模板名称', - 'type' => 'string', - 'example' => '示例值示例值', - ], + 'TemplateName' => ['title' => '', 'description' => 'The name of the script template.', 'type' => 'string', 'example' => '模板'], 'PersonalityTags' => [ - 'title' => '个性标签', - 'description' => '个性标签', + 'title' => '', + 'description' => 'The personality tags.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'items' => ['description' => 'The tag.', 'type' => 'string', 'example' => '标签', 'title' => ''], 'example' => '', ], - 'TemplateType' => [ - 'title' => '模板类型', - 'description' => '模板类型', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '55', - ], - 'Properties' => [ - 'title' => '话术所需参数', - 'description' => '话术所需参数', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'TemplateId' => [ - 'title' => 'AI话术ID', - 'description' => 'AI话术ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '59', - ], + 'TemplateType' => ['title' => '', 'description' => 'The template type.', 'type' => 'integer', 'format' => 'int64', 'example' => '1:单模版;2:智能话术策略模板。'], + 'Properties' => ['title' => '', 'description' => 'The parameters required by the script.', 'type' => 'string', 'example' => '"尊称,姓名,金额"'], + 'TemplateId' => ['title' => '', 'description' => 'The AI script ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '59'], ], + 'title' => '', + 'example' => '', ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": [\\n {\\n \\"IntentTags\\": [\\n {\\n \\"intentDescription\\": \\"已成为客户\\",\\n \\"intentTag\\": \\"A\\"\\n }\\n ],\\n \\"TemplateName\\": \\"模板\\",\\n \\"PersonalityTags\\": [\\n \\"标签\\"\\n ],\\n \\"TemplateType\\": 0,\\n \\"Properties\\": \\"\\\\\\"尊称,姓名,金额\\\\\\"\\",\\n \\"TemplateId\\": 59\\n }\\n ],\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'List industry edition script templates', + 'description' => 'Queries the list of industry edition script templates.', + 'requestParamsDescription' => 'TemplateId is an invalid parameter and does not need to be specified. This parameter serves only as a placeholder because the platform requires at least one request parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TemplateList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'aiccs:TemplateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'UpdateAgentStatus' => [ - 'summary' => '修改坐席状态', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Updates the status of an agent in the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3891,48 +2884,26 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '58', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the agent.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '58'], ], [ 'name' => 'AgentTag', 'in' => 'query', - 'schema' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'required' => false, - 'example' => 'abac', - ], + 'schema' => ['title' => '', 'description' => 'The tag of the agent.', 'type' => 'string', 'required' => false, 'example' => 'abac'], ], [ 'name' => 'AgentStatus', 'in' => 'query', - 'schema' => [ - 'title' => '坐席状态 1:在线;2:忙碌;3:小休;4:离线', - 'description' => '坐席状态 1:在线;2:忙碌;3:小休;4:离线', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The status of the agent. Valid values:'."\n" + .'- 1: online'."\n" + .'- 2: busy'."\n" + .'- 3: on break'."\n" + .'- 4: offline.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -3940,57 +2911,48 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], + 'Model' => ['description' => 'The returned result.', 'type' => 'object', 'example' => '无内容', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The timestamp of the operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'UpdateTaskCustomer' => [ - 'summary' => '更新当天导入的号码', - 'methods' => [ - 'post', - 'get', + 'title' => 'Update agent status in the industry edition', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:UpdateAgentStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAgentStatus'], + ], ], + ], + 'UpdateTaskCustomer' => [ + 'summary' => 'Updates the number parameters of a task in the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3998,69 +2960,35 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '59', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '59'], ], [ 'name' => 'Customers', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '外呼客户', - 'description' => '外呼客户', + 'title' => '', + 'description' => 'The outbound call customers.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The number details.', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'title' => '电话号码', - 'description' => '电话号码', - 'type' => 'string', - 'required' => false, - 'example' => '13661109390', - ], - 'Cancel' => [ - 'title' => '是否取消外呼 0否,1是', - 'description' => '是否取消外呼 0否,1是', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - 'Tag' => [ - 'title' => '用户自定义标签', - 'description' => '用户自定义标签', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], - 'Properties' => [ - 'title' => '需根据具体任务参数要求传输', - 'description' => '需根据具体任务参数要求传输', - 'type' => 'object', - 'required' => false, - 'example' => '{"test":"234"}', - ], + 'Number' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13661109390'], + 'Cancel' => ['title' => '', 'description' => 'Specifies whether to cancel the outbound call. Valid values:'."\n" + .'- 0: Do not cancel.'."\n" + .'- 1: Cancel.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + 'Tag' => ['title' => '', 'description' => 'The user-defined label.', 'type' => 'string', 'required' => false, 'example' => 'tag1'], + 'Properties' => ['title' => '', 'description' => 'The properties that must be specified based on the specific task parameter requirements.', 'type' => 'object', 'required' => false, 'example' => '{"test":"234"}'], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, 'example' => '', @@ -4072,2408 +3000,418 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'UnHandleNumbers' => [ - 'title' => '错误手机列表', - 'description' => '错误手机列表', + 'title' => '', + 'description' => 'The list of unrecognized phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '13661109390', - ], + 'items' => ['description' => 'The unrecognized phone number.', 'type' => 'string', 'example' => '13661109390', 'title' => ''], 'example' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'The result of the request. Valid values:'."\n" + .'- true: The request was successful.'."\n" + .'- false: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": {\\n \\"UnHandleNumbers\\": [\\n \\"13661109390\\"\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'QuickAddTask' => [ - 'summary' => '快速创建任务接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '任务名称', - 'description' => '任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'a', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '任务启动日期', - 'description' => '任务启动日期', - 'type' => 'string', - 'required' => false, - 'example' => '2019-04-30', - ], - ], - [ - 'name' => 'TemplateType', - 'in' => 'query', - 'schema' => [ - 'title' => '话术模板类型', - 'description' => '话术模板类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1:单模版;2:智能话术策略模板。不填默认1。', - ], - ], - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'title' => '话术模板ID,如果不传则使用被复制任务的话术模板', - 'description' => '话术模板ID,如果不传则使用被复制任务的话术模板', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'SmsTemplateId', - 'in' => 'query', - 'schema' => [ - 'title' => '短信模板ID', - 'description' => '短信模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'ReferenceTaskId', - 'in' => 'query', - 'schema' => [ - 'title' => '被复制任务ID', - 'description' => '被复制任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'AgentGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席组ID', - 'description' => '坐席组ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'CallTimeList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '外呼时间', - 'description' => '外呼时间', - 'type' => 'array', - 'items' => [ - 'title' => '外呼时间', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CallTime' => [ - 'title' => '外呼时间', - 'description' => '外呼时间', - 'type' => 'array', - 'items' => [ - 'title' => '外呼时间', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '8.5', - ], - 'required' => false, - 'example' => '', - ], - ], - 'required' => false, + 'title' => 'Update task number parameters in the industry edition', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:UpdateTaskCustomer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'title' => '任务id', - 'description' => '任务id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '77', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTaskCustomer'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"TaskId\\": 1\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 77,\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'AddAgent' => [ - 'summary' => '创建坐席', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + ], + 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'CorpusCreateFailure', 'message' => 'Failed to create the corpus.', 'http_code' => 400, 'description' => ''], + ['code' => 'CorpusDeleteFailure', 'message' => 'Failed to delete the corpus.', 'http_code' => 400, 'description' => ''], + ['code' => 'Department.NotFound', 'message' => 'The specified department does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'Forbidden.Operation', 'message' => 'No permissions for this operation.', 'http_code' => 400, 'description' => 'No operation permission'], + ['code' => 'InvalidCustomer.NotFound', 'message' => 'Failed to query customers.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidInstanceId', 'message' => 'The specified instance is unavailable or does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidOperation', 'message' => 'The operation is invalid.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidParameter', 'message' => 'The specified parameter is invalid.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidParameter.ApplicationCode', 'message' => 'The specified parameter "ApplicationCode" is invalid.', 'http_code' => 400, 'description' => 'The parameter ApplicationCode is invalid.'], + ['code' => 'InvalidParameter.CallDate', 'message' => 'The specified parameter "CallDate" is not valid.', 'http_code' => 400, 'description' => 'Invalid CallDate.'], + ['code' => 'InvalidParameter.CallId', 'message' => 'The parameter CallId is invalid.', 'http_code' => 400, 'description' => 'The parameter CallId is invalid.'."\n"], + ['code' => 'InvalidPartnerId.NotFound', 'message' => 'You must specify PartnerId.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidUserInfo.Exception', 'message' => 'Failed to query user information.', 'http_code' => 400, 'description' => ''], + ['code' => 'INVALID_SUMMARY_AGENT', 'message' => 'summary agent is invalid.', 'http_code' => 400, 'description' => 'Subtotal Intelligence Illegal'], + ['code' => 'INVALID_TASK_NAME', 'message' => 'taskName is invalid.', 'http_code' => 400, 'description' => 'Invalid task name'], + ['code' => 'MissingParameter.CallerNumber', 'message' => 'Parameter "CallerNumber" which is mandatory for the request is not provided.', 'http_code' => 400, 'description' => 'The request required parameter "CallerNumber" was not provided ".'], + ['code' => 'ModelCreateFailure', 'message' => 'Failed to create the model.', 'http_code' => 400, 'description' => ''], + ['code' => 'ModelDeleteFailure', 'message' => 'Failed to delete the the model.', 'http_code' => 400, 'description' => ''], + ['code' => 'ModelNotExist', 'message' => 'The model does not exist.', 'http_code' => 400, 'description' => 'The model does not exist.'], + ['code' => 'ModelStatus.Invalid', 'message' => 'Model state invalid.', 'http_code' => 400, 'description' => 'Invalid model state.'], + ['code' => 'ModelUpperLimitReached', 'message' => 'The maximum number of models is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoAgentFound', 'message' => 'The specified agent does not exist.', 'http_code' => 500, 'description' => ''], + ['code' => 'NoSkillGroupSetFound', 'message' => 'The specified skill group set does not exist.', 'http_code' => 500, 'description' => ''], + ['code' => 'NoTenantFound', 'message' => 'The specified tenant does not exist.', 'http_code' => 500, 'description' => ''], + ['code' => 'Parameter.Error', 'message' => 'Parameter error.', 'http_code' => 400, 'description' => ''], + ['code' => 'Parameter.Exception', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'ParameterError', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'Permission.NotAuthorized', 'message' => 'Insufficient permissions. Please contact the primary account administrator.', 'http_code' => 400, 'description' => ''], + ['code' => 'PermissionInsufficient', 'message' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'http_code' => 400, 'description' => ''], + ['code' => 'RequestParamError', 'message' => 'The request parameter you sent is abnormal. Please check.', 'http_code' => 501, 'description' => 'The request parameter you sent is abnormal. Please check!'], + ['code' => 'SUMMARY_AGENT_NOT_ONLINE', 'message' => 'summary agent is not online.', 'http_code' => 400, 'description' => 'Subtotal intelligences not online'], + ['code' => 'SystemError', 'message' => 'A system error occurred. Please contact the administrator.', 'http_code' => 500, 'description' => ''], + ['code' => 'SystemHandleFail', 'message' => 'A system error occurred while processing your request.', 'http_code' => 500, 'description' => 'A system error occurred while processing your request.'], + ['code' => 'TASK_FILE_NOT_EXIST', 'message' => 'task file is not exist.', 'http_code' => 400, 'description' => 'Tasks'], + ['code' => 'TrainFailure', 'message' => 'Model training failed.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabCreateFailure', 'message' => 'Failed to create the vocab.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabDeleteFailure', 'message' => 'Failed to delete the vocab.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabFileEmpty', 'message' => 'The vocab file cannot be empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabFileNotExist', 'message' => 'The vocab file does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabUpdateFailure', 'message' => 'Failed to update the vocab.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabUpperLimitReached', 'message' => 'The maximum number of vocab groups is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'WordExceed', 'message' => 'Each word cannot exceed 10 characters.', 'http_code' => 400, 'description' => ''], + ['code' => 'WordExceed', 'message' => 'Each group of vocabs cannot exceed 128 words.', 'http_code' => 400, 'description' => ''], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ImportNumberV2'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + 'createdAt' => '2025-05-13T14:41:14.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportNumber'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TemplateList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCallInfo'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AgentCancelCall'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Page'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmsTemplatePageList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskRecoverCall'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AgentRecoverCall'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Details'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmsTemplateCreate'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCancelCall'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCallList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTaskCustomer'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddBlacklist'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCallChats'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAgentStatus'], + ], + ], + 'ram' => [ + 'productCode' => 'AICCS', + 'productName' => 'Artificial Intelligence Cloud Call Service', + 'ramCodes' => ['aiccs'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'TaskCallInfo', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'Account', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席账号名(必须唯一)', - 'description' => '坐席账号名(必须唯一)', - 'type' => 'string', - 'required' => true, - 'example' => 'seat_001', - ], - ], - [ - 'name' => 'Password', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席账号密码 (可以跟分机密码一致)', - 'description' => '坐席账号密码 (可以跟分机密码一致)', - 'type' => 'string', - 'required' => true, - 'example' => 'gwegwe23t32', - ], - ], - [ - 'name' => 'ExtensionPwd', - 'in' => 'query', - 'schema' => [ - 'title' => '分机密码', - 'description' => '分机密码', - 'type' => 'string', - 'required' => true, - 'example' => 'gwegwe23t32', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席名称', - 'description' => '坐席名称', - 'type' => 'string', - 'required' => true, - 'example' => 'xxx', - ], - ], - [ - 'name' => 'AgentTag', - 'in' => 'query', - 'schema' => [ - 'title' => '合作方唯一标识', - 'description' => '合作方唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', + 'ramAction' => [ + 'action' => 'aiccs:TaskCallInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Model' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'object', - 'properties' => [ - 'AgentId' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '82', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"AgentId\\": 1\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 82,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'QueryAgentInfo' => [ - 'summary' => '查询坐席具体信息', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'TaskCancelCall', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'AgentId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'AgentTag', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'required' => false, - 'example' => '"1"', + 'ramAction' => [ + 'action' => 'aiccs:TaskCancelCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Access Denied', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Account' => [ - 'title' => '坐席账号', - 'description' => '坐席账号', - 'type' => 'string', - 'example' => 'a', - ], - 'WsRegisterAddress' => [ - 'title' => 'WebSocket分机注册地址', - 'description' => 'WebSocket分机注册地址', - 'type' => 'string', - 'example' => 'a', - ], - 'AgentExtension' => [ - 'title' => '坐席分机号', - 'description' => '坐席分机号', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2026-11-11 11:11:11', - ], - 'AgentGroupIds' => [ - 'title' => '坐席组ID列表', - 'description' => '坐席组ID列表', - 'type' => 'array', - 'items' => [ - 'title' => '坐席组ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'example' => '', - ], - 'WsProtocol' => [ - 'title' => 'WebSocket分机注册协议', - 'description' => 'WebSocket分机注册协议', - 'type' => 'string', - 'example' => 'b', - ], - 'AgentGroupList' => [ - 'title' => '坐席组列表', - 'description' => '坐席组列表', - 'type' => 'array', - 'items' => [ - 'title' => '坐席组', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'title' => '坐席组名称', - 'description' => '坐席组名称', - 'type' => 'string', - 'example' => 'a', - ], - 'GroupId' => [ - 'title' => '坐席组ID', - 'description' => '坐席组ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - 'example' => '', - ], - 'Name' => [ - 'title' => '坐席名称', - 'description' => '坐席名称', - 'type' => 'string', - 'example' => 'b', - ], - 'Active' => [ - 'title' => '账号启用状态,0-停用,1-启用,默认1', - 'description' => '账号启用状态,0-停用,1-启用,默认1', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AgentStatus' => [ - 'title' => '坐席状态,1:在线;2:忙碌;3:小休;4:离线', - 'description' => '坐席状态,1:在线;2:忙碌;3:小休;4:离线', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ExtensionPwd' => [ - 'title' => '分机密码', - 'description' => '分机密码', - 'type' => 'string', - 'example' => 'a', - ], - 'ExtensionServer' => [ - 'title' => '分机注册地址', - 'description' => '分机注册地址', - 'type' => 'string', - 'example' => 'b', - ], - 'AgentId' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AgentTag' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'example' => 'c', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '43', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '17', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'TaskList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'aiccs:TaskList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"Access Denied\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"Account\\": \\"a\\",\\n \\"WsRegisterAddress\\": \\"a\\",\\n \\"AgentExtension\\": 1,\\n \\"CreateTime\\": \\"2026-11-11 11:11:11\\",\\n \\"AgentGroupIds\\": [\\n 123\\n ],\\n \\"WsProtocol\\": \\"b\\",\\n \\"AgentGroupList\\": [\\n {\\n \\"GroupName\\": \\"a\\",\\n \\"GroupId\\": 1\\n }\\n ],\\n \\"Name\\": \\"b\\",\\n \\"Active\\": 1,\\n \\"AgentStatus\\": 1,\\n \\"ExtensionPwd\\": \\"a\\",\\n \\"ExtensionServer\\": \\"b\\",\\n \\"AgentId\\": 1,\\n \\"AgentTag\\": \\"c\\"\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 17,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'AddAgentGroup' => [ - 'summary' => '创建坐席组接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'TaskCallChats', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'AgentGroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席组名称,不能为空且最大长度为20个字符', - 'description' => '坐席组名称,不能为空且最大长度为20个字符', - 'type' => 'string', - 'required' => true, - 'example' => 'abc', + 'ramAction' => [ + 'action' => 'aiccs:TaskCallChats', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AgentGroupName' => [ - 'title' => '坐席组名称', - 'description' => '坐席组名称', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'CreateTime' => [ - 'title' => '创建坐席组的时间', - 'description' => '创建坐席组的时间', - 'type' => 'string', - 'example' => '示例值', - ], - 'AgentGroupId' => [ - 'title' => '坐席组ID', - 'description' => '坐席组ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '48', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '40', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + [ + 'apiName' => 'UpdateTaskCustomer', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:UpdateTaskCustomer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"AgentGroupName\\": \\"example\\",\\n \\"CreateTime\\": \\"example\\",\\n \\"AgentGroupId\\": 48\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 40,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'JoinAgentGroup' => [ - 'summary' => '绑定坐席组', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'TaskCallList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'aiccs:TaskCallList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'SmsTemplatePageList', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'AgentGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席组ID', - 'description' => '坐席组ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'AgentIds', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '坐席ID列表', - 'description' => '坐席ID列表', - 'type' => 'array', - 'items' => [ - 'title' => '坐席ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '111', - ], - 'required' => true, - 'example' => '', + 'ramAction' => [ + 'action' => 'aiccs:SmsTemplatePageList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + [ + 'apiName' => 'AddTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AddTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 30,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'QuitAgentGroup' => [ - 'summary' => '解绑坐席组', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'Details', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'AgentGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席组ID', - 'description' => '坐席组ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '60', - ], - ], - [ - 'name' => 'AgentIds', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '坐席ID列表', - 'description' => '坐席ID列表', - 'type' => 'array', - 'items' => [ - 'title' => '坐席ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '111', - ], - 'required' => true, - 'example' => '', + 'ramAction' => [ + 'action' => 'aiccs:Details', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'Page', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:Page', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 15,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'AgentGroupPage' => [ - 'summary' => '坐席组分页查询', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'EditTask', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'AgentGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席组ID', - 'description' => '坐席组ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'title' => '当前页', - 'description' => '当前页', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页数量', - 'description' => '分页数量', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'ramAction' => [ + 'action' => 'aiccs:EditTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'a', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12345', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Pages' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '82', - ], - 'Size' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Current' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '62', - ], - 'Records' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AgentGroupName' => [ - 'title' => '坐席组名称', - 'description' => '坐席组名称', - 'type' => 'string', - 'example' => 'a', - ], - 'CreateTime' => [ - 'title' => '创建坐席组的时间', - 'description' => '创建坐席组的时间', - 'type' => 'string', - 'example' => '2026-01-01 11:11:11', - ], - 'AgentIds' => [ - 'title' => '坐席组下的坐席id列表', - 'description' => '坐席组下的坐席id列表', - 'type' => 'array', - 'items' => [ - 'title' => '坐席组下的坐席id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50022260', - ], - 'example' => '', - ], - 'AgentGroupId' => [ - 'title' => '坐席组ID', - 'description' => '坐席组ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - 'example' => '', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '71', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + [ + 'apiName' => 'SmsTemplateCreate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:SmsTemplateCreate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"a\\",\\n \\"RequestId\\": \\"12345\\",\\n \\"Model\\": {\\n \\"Pages\\": 82,\\n \\"Size\\": 15,\\n \\"Total\\": 12,\\n \\"Current\\": 62,\\n \\"Records\\": [\\n {\\n \\"AgentGroupName\\": \\"a\\",\\n \\"CreateTime\\": \\"2026-01-01 11:11:11\\",\\n \\"AgentIds\\": [\\n 50022260\\n ],\\n \\"AgentGroupId\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 71,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'AgentCallList' => [ - 'summary' => '坐席外呼查询外呼记录', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ImportNumber', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'AgentId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '51', - ], - ], - [ - 'name' => 'AgentTag', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'required' => false, - 'example' => 'abcd', - ], - ], - [ - 'name' => 'Numbers', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表', - 'type' => 'array', - 'items' => [ - 'title' => '号码', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13541251222', - ], - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'NumberMD5s', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '号码MD5列表', - 'description' => '号码MD5列表', - 'type' => 'array', - 'items' => [ - 'title' => '号码MD5', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abcd', - ], - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'Tags', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '用户自定义标签列表', - 'description' => '用户自定义标签列表', - 'type' => 'array', - 'items' => [ - 'title' => '用户自定义标签', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'CallDate', - 'in' => 'query', - 'schema' => [ - 'title' => '开始外呼时间', - 'description' => '开始外呼时间', - 'type' => 'string', - 'required' => true, - 'example' => '2020-03-06 10:10:10', - ], - ], - [ - 'name' => 'EndCallDate', - 'in' => 'query', - 'schema' => [ - 'title' => '结束外呼时间', - 'description' => '结束外呼时间', - 'type' => 'string', - 'required' => true, - 'example' => '2020-03-07 10:10:10', - ], - ], - [ - 'name' => 'Page', - 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => '页数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '7', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页外呼记录数', - 'description' => '每页外呼记录数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14', + 'ramAction' => [ + 'action' => 'aiccs:ImportNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '27', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '40', - ], - 'TotalPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '49', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '44', - ], - 'List' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'title' => '外呼任务ID', - 'description' => '外呼任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AgentExtension' => [ - 'title' => '坐席分机', - 'description' => '坐席分机', - 'type' => 'string', - 'example' => 'a', - ], - 'Keywords' => [ - 'title' => '回复关键词', - 'description' => '回复关键词', - 'type' => 'string', - 'example' => '如链接,利息', - ], - 'CallType' => [ - 'title' => '可选项:1001:坐席-人工外呼,1002:坐席-AI外呼-不转人工,1003:坐席-AI外呼-接通转人工,1004:坐席-AI外呼-智能转人工;', - 'description' => '可选项:1001:坐席-人工外呼,1002:坐席-AI外呼-不转人工,1003:坐席-AI外呼-接通转人工,1004:坐席-AI外呼-智能转人工;', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1001', - ], - 'AnswerTime' => [ - 'title' => '接通时间 格式:2019-11-23 14:47:06', - 'description' => '接通时间 格式:2019-11-23 14:47:06', - 'type' => 'string', - 'example' => '2019-11-23 14:47:06', - ], - 'IntentTag' => [ - 'title' => '意向标签, 如“C”', - 'description' => '意向标签, 如“C”', - 'type' => 'string', - 'example' => 'C', - ], - 'TransferStatusCode' => [ - 'title' => '转人工状态编码', - 'description' => '转人工状态编码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ImportTime' => [ - 'title' => '导入时间,格式:2019-11-23 14:47:06', - 'description' => '导入时间,格式:2019-11-23 14:47:06', - 'type' => 'string', - 'example' => '2019-11-23 14:47:06', - ], - 'IndividualTag' => [ - 'title' => '个性标签', - 'description' => '个性标签', - 'type' => 'string', - 'example' => '如投诉,非本人', - ], - 'Properties' => [ - 'title' => '导入号码时的参数值', - 'description' => '导入号码时的参数值', - 'type' => 'string', - 'example' => '{"电话号码":"13100000000"}', - ], - 'StatusCode' => [ - 'title' => '外呼状态编码', - 'description' => '外呼状态编码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AgentSpeakingDuration' => [ - 'title' => '坐席通话时长,单位:秒', - 'description' => '坐席通话时长,单位:秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Remark' => [ - 'title' => '人工备注信息', - 'description' => '人工备注信息', - 'type' => 'string', - 'example' => 'abcd', - ], - 'Number' => [ - 'title' => '外呼号码', - 'description' => '外呼号码', - 'type' => 'string', - 'example' => '1', - ], - 'InterceptReason' => [ - 'title' => '拦截原因 当状态为已拦截时,可选值:黑名单拦截,灰名单拦截,异常号码拦截', - 'description' => '拦截原因 当状态为已拦截时,可选值:黑名单拦截,灰名单拦截,异常号码拦截', - 'type' => 'string', - 'example' => '黑名单拦截', - ], - 'IntentDescription' => [ - 'title' => '意向说明 如:确认本人,未承诺还款', - 'description' => '意向说明 如:确认本人,未承诺还款', - 'type' => 'string', - 'example' => '如:确认本人', - ], - 'StatusDescription' => [ - 'title' => '外呼状态,如“已接听”“拒接”,转外呼状态编码与描述对应 1-已接听,2-关机', - 'description' => '外呼状态,如“已接听”“拒接”,转外呼状态编码与描述对应 1-已接听,2-关机', - 'type' => 'string', - 'example' => '已接听', - ], - 'SpeakingDuration' => [ - 'title' => '通话时长 单位:秒', - 'description' => '通话时长 单位:秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TransferStatus' => [ - 'title' => '转人工状态 0-未触发', - 'description' => '转人工状态 0-未触发', - 'type' => 'string', - 'example' => '未触发', - ], - 'AgentId' => [ - 'title' => '分配坐席ID', - 'description' => '分配坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TemplateId' => [ - 'title' => 'AI话术ID', - 'description' => 'AI话术ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AgentTag' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'example' => 'a', - ], - 'BatchId' => [ - 'title' => '导入号码时返回的批次号', - 'description' => '导入号码时返回的批次号', - 'type' => 'string', - 'example' => '1', - ], - 'CallId' => [ - 'title' => '外呼ID', - 'description' => '外呼ID', - 'type' => 'string', - 'example' => '1', - ], - 'HangupTime' => [ - 'title' => '挂断时间 格式:2019-11-23 14:47:06', - 'description' => '挂断时间 格式:2019-11-23 14:47:06', - 'type' => 'string', - 'example' => '2019-11-23 14:47:06', - ], - 'CallBeginTime' => [ - 'title' => '开始通话时间, 格式:2019-11-23 14:47:06', - 'description' => '开始通话时间, 格式:2019-11-23 14:47:06', - 'type' => 'string', - 'example' => '2019-11-23 14:47:06', - ], - 'RingTime' => [ - 'title' => '振铃时长 单位:毫秒', - 'description' => '振铃时长 单位:毫秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AgentSpeakingTime' => [ - 'title' => '坐席通话时长,单位:大于1分钟,显示分钟秒,小于1分钟,显示秒', - 'description' => '坐席通话时长,单位:大于1分钟,显示分钟秒,小于1分钟,显示秒', - 'type' => 'string', - 'example' => '1', - ], - 'HangupType' => [ - 'title' => '挂机方式 AI挂机1,坐席挂机2,客户挂机3', - 'description' => '挂机方式 AI挂机1,坐席挂机2,客户挂机3', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SpeakingTurns' => [ - 'title' => '对话轮次', - 'description' => '对话轮次', - 'type' => 'string', - 'example' => '1', - ], - 'Sms' => [ - 'title' => '挂机短信 1:发送,2:不发送', - 'description' => '挂机短信 1:发送,2:不发送', - 'type' => 'string', - 'example' => '1', - ], - 'Tag' => [ - 'title' => '用户自定义标签', - 'description' => '用户自定义标签', - 'type' => 'string', - 'example' => '1', - ], - 'NumberMD5' => [ - 'title' => '外呼号码MD5', - 'description' => '外呼号码MD5', - 'type' => 'string', - 'example' => '1', - ], - 'ChatRecord' => [ - 'title' => '对话录音', - 'description' => '对话录音', - 'type' => 'string', - 'example' => 'URL', - ], - 'SpeakingTime' => [ - 'title' => '通话时长 单位:大于1分钟,显示分钟秒,小于1分钟,显示秒', - 'description' => '通话时长 单位:大于1分钟,显示分钟秒,小于1分钟,显示秒', - 'type' => 'string', - 'example' => '1', - ], - 'TransferTime' => [ - 'title' => '转接人工时间', - 'description' => '转接人工时间', - 'type' => 'string', - 'example' => '2019-01-09 14:14:19', - ], - ], - ], - 'example' => '', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '89', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + [ + 'apiName' => 'TemplateList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'aiccs:TemplateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值\\",\\n \\"RequestId\\": \\"示例值\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 27,\\n \\"PageSize\\": 40,\\n \\"TotalPage\\": 49,\\n \\"PageNo\\": 44,\\n \\"List\\": [\\n {\\n \\"TaskId\\": 1,\\n \\"AgentExtension\\": \\"a\\",\\n \\"Keywords\\": \\"如链接,利息\\",\\n \\"CallType\\": 1001,\\n \\"AnswerTime\\": \\"2019-11-23 14:47:06\\",\\n \\"IntentTag\\": \\"C\\",\\n \\"TransferStatusCode\\": 0,\\n \\"ImportTime\\": \\"2019-11-23 14:47:06\\",\\n \\"IndividualTag\\": \\"如投诉,非本人\\",\\n \\"Properties\\": \\"{\\\\\\"电话号码\\\\\\":\\\\\\"13100000000\\\\\\"}\\",\\n \\"StatusCode\\": 1,\\n \\"AgentSpeakingDuration\\": 1,\\n \\"Remark\\": \\"abcd\\",\\n \\"Number\\": \\"1\\",\\n \\"InterceptReason\\": \\"黑名单拦截\\",\\n \\"IntentDescription\\": \\"如:确认本人\\",\\n \\"StatusDescription\\": \\"已接听\\",\\n \\"SpeakingDuration\\": 1,\\n \\"TransferStatus\\": \\"未触发\\",\\n \\"AgentId\\": 1,\\n \\"TemplateId\\": 1,\\n \\"AgentTag\\": \\"a\\",\\n \\"BatchId\\": \\"1\\",\\n \\"CallId\\": \\"1\\",\\n \\"HangupTime\\": \\"2019-11-23 14:47:06\\",\\n \\"CallBeginTime\\": \\"2019-11-23 14:47:06\\",\\n \\"RingTime\\": 1,\\n \\"AgentSpeakingTime\\": \\"1\\",\\n \\"HangupType\\": 1,\\n \\"SpeakingTurns\\": \\"1\\",\\n \\"Sms\\": \\"1\\",\\n \\"Tag\\": \\"1\\",\\n \\"NumberMD5\\": \\"1\\",\\n \\"ChatRecord\\": \\"URL\\",\\n \\"SpeakingTime\\": \\"1\\",\\n \\"TransferTime\\": \\"2019-01-09 14:14:19\\"\\n }\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 89,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'AgentImportNumber' => [ - 'summary' => '坐席外呼导入号码', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'TaskRecoverCall', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'OutId', - 'in' => 'query', - 'schema' => [ - 'title' => '请求id,具有唯一性,用来做请求幂等处理,一个请求id有效期10分钟。不传则不做幂等处理', - 'description' => '请求id,具有唯一性,用来做请求幂等处理,一个请求id有效期10分钟。不传则不做幂等处理', - 'type' => 'string', - 'required' => false, - 'example' => '1asgfh', - ], - ], - [ - 'name' => 'AgentId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID,可以为空,但agentId与agentTag必须其中1个有值。用于查询对应的坐席信息', - 'description' => '坐席ID,可以为空,但agentId与agentTag必须其中1个有值。用于查询对应的坐席信息', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'AgentTag', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席唯一标识(创建坐席时的用户唯一标识),可以为空,但agentId与agentTag必须其中1个有值。用于查询对应的坐席信息', - 'description' => '坐席唯一标识(创建坐席时的用户唯一标识),可以为空,但agentId与agentTag必须其中1个有值。用于查询对应的坐席信息', - 'type' => 'string', - 'required' => false, - 'example' => '1001', - ], - ], - [ - 'name' => 'CallType', - 'in' => 'query', - 'schema' => [ - 'title' => '外呼类型 可选项:1001:坐席-人工外呼,1002:坐席-AI外呼-不转人工,1003:坐席-AI外呼-接通转人工,1004:坐席-AI外呼-智能转人工"', - 'description' => '外呼类型 可选项:1001:坐席-人工外呼,1002:坐席-AI外呼-不转人工,1003:坐席-AI外呼-接通转人工,1004:坐席-AI外呼-智能转人工"', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '79', - ], - ], - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'title' => 'AI话术ID 客户已制作并已发布/平台授权的AI话术ID,如callType=1001可不填;如callType=1002,1003或1004 ,必填。', - 'description' => 'AI话术ID 客户已制作并已发布/平台授权的AI话术ID,如callType=1001可不填;如callType=1002,1003或1004 ,必填。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席-人工外呼选择的外呼线路,只针对callType=1001生效,其他callType不生效。如callType=1001,且gatewayId不传值,默认按系统的线路配置外呼', - 'description' => '坐席-人工外呼选择的外呼线路,只针对callType=1001生效,其他callType不生效。如callType=1001,且gatewayId不传值,默认按系统的线路配置外呼', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Customers', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '具体用户信息,如手机号、姓名等,需根据具体任务参数要求传输。注:当callType为1001时,只会导入第1条数据', - 'description' => '具体用户信息,如手机号、姓名等,需根据具体任务参数要求传输。注:当callType为1001时,只会导入第1条数据', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Number' => [ - 'title' => '号码,如手机号等', - 'description' => '号码,如手机号等', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'ClientUrl' => [ - 'title' => '客户详情URL,用于展示客户用户在客户业务系统的详细信息,做多80个字符', - 'description' => '客户详情URL,用于展示客户用户在客户业务系统的详细信息,做多80个字符', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'Tag' => [ - 'title' => '用户自定义标签,最多50个字符', - 'description' => '用户自定义标签,最多50个字符', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'NumberMD5' => [ - 'title' => '用户电话号码MD5,和number两者必传一个', - 'description' => '用户电话号码MD5,和number两者必传一个', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'Properties' => [ - 'title' => '用户具体信息。如AI话术模板没变量要求或为人工外呼,可为空(总长度500个字符,多余的会被剔除)', - 'description' => '用户具体信息。如AI话术模板没变量要求或为人工外呼,可为空(总长度500个字符,多余的会被剔除)', - 'type' => 'object', - 'required' => false, - 'example' => '{"test":"234"}', - ], - ], - 'required' => false, - ], - 'required' => true, - 'example' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Access Denied', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BatchId' => [ - 'title' => '批次ID', - 'description' => '批次ID', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Id' => [ - 'title' => '外呼编号ID', - 'description' => '外呼编号ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '93', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + 'ramAction' => [ + 'action' => 'aiccs:TaskRecoverCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"Access Denied\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"BatchId\\": \\"example\\",\\n \\"Id\\": 80\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 93,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'CallNumberDetail' => [ - 'summary' => '获取号码外呼详情', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdateAgentStatus', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '外呼编号ID', - 'description' => '外呼编号ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '95', - ], - ], - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '33', + 'ramAction' => [ + 'action' => 'aiccs:UpdateAgentStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Keywords' => [ - 'title' => '回复关键词', - 'description' => '回复关键词', - 'type' => 'string', - 'example' => 'a', - ], - 'CallType' => [ - 'title' => '可选项 1-AI外呼,6-语音通知', - 'description' => '可选项 1-AI外呼,6-语音通知', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'IntentTag' => [ - 'title' => '意向标签', - 'description' => '意向标签', - 'type' => 'string', - 'example' => 'a', - ], - 'StatusCode' => [ - 'title' => '外呼状态编码', - 'description' => '外呼状态编码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Remark' => [ - 'title' => '备注信息', - 'description' => '备注信息', - 'type' => 'string', - 'example' => 'a', - ], - 'Number' => [ - 'title' => '外呼号码', - 'description' => '外呼号码', - 'type' => 'string', - 'example' => 'a', - ], - 'TransferStatus' => [ - 'title' => '转人工状态 0-未触发,', - 'description' => '转人工状态 0-未触发,', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NumberMd5' => [ - 'title' => '外呼号码MD5', - 'description' => '外呼号码MD5', - 'type' => 'string', - 'example' => 'a', - ], - 'TemplateId' => [ - 'title' => '外呼使用的模板ID', - 'description' => '外呼使用的模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CallId' => [ - 'title' => '每次呼叫的唯一标识', - 'description' => '每次呼叫的唯一标识', - 'type' => 'string', - 'example' => 'a', - ], - 'BatchId' => [ - 'title' => '导入号码时返回的批次号', - 'description' => '导入号码时返回的批次号', - 'type' => 'string', - 'example' => '1', - ], - 'CreateTime' => [ - 'title' => '创建时间 格式 2026-01-01 00:00:00', - 'description' => '创建时间 格式 2026-01-01 00:00:00', - 'type' => 'string', - 'example' => '2026-01-01 00:00:00', - ], - 'Params' => [ - 'title' => '自定义参数 json', - 'description' => '自定义参数 json', - 'type' => 'string', - 'example' => '{"名字":"a"}', - ], - 'Duration' => [ - 'title' => '通话轮次', - 'description' => '通话轮次', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GatewayId' => [ - 'title' => '线路id', - 'description' => '线路id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AnswerTransferType' => [ - 'title' => '接通转接类型 1-不转人工;2-接通转人工;3-智能转人工', - 'description' => '接通转接类型 1-不转人工;2-接通转人工;3-智能转人工', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Sid' => [ - 'title' => '坐席id', - 'description' => '坐席id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'BridgeBill' => [ - 'title' => '转接计费时长', - 'description' => '转接计费时长', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ClientUrl' => [ - 'title' => '客户详情url', - 'description' => '客户详情url', - 'type' => 'string', - 'example' => 'a', - ], - 'Bill' => [ - 'title' => '通话时长,单位为毫秒,实际计费需向上取整转换为秒', - 'description' => '通话时长,单位为毫秒,实际计费需向上取整转换为秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Id' => [ - 'title' => '号码编号', - 'description' => '号码编号', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Tag' => [ - 'title' => '用户自定义标签', - 'description' => '用户自定义标签', - 'type' => 'string', - 'example' => 'a', - ], - 'AiBill' => [ - 'title' => 'ai计费时长', - 'description' => 'ai计费时长', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PersonalityTag' => [ - 'title' => '个性标签', - 'description' => '个性标签', - 'type' => 'string', - 'example' => 'a', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '48', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'AddBlacklist', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AddBlacklist', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"TaskId\\": 1,\\n \\"Keywords\\": \\"a\\",\\n \\"CallType\\": 1,\\n \\"IntentTag\\": \\"a\\",\\n \\"StatusCode\\": 200,\\n \\"Remark\\": \\"a\\",\\n \\"Number\\": \\"a\\",\\n \\"TransferStatus\\": 0,\\n \\"NumberMd5\\": \\"a\\",\\n \\"TemplateId\\": 1,\\n \\"CallId\\": \\"a\\",\\n \\"BatchId\\": \\"1\\",\\n \\"CreateTime\\": \\"2026-01-01 00:00:00\\",\\n \\"Params\\": \\"{\\\\\\"名字\\\\\\":\\\\\\"a\\\\\\"}\\",\\n \\"Duration\\": 1,\\n \\"GatewayId\\": 1,\\n \\"AnswerTransferType\\": 1,\\n \\"Sid\\": 1,\\n \\"BridgeBill\\": 1,\\n \\"ClientUrl\\": \\"a\\",\\n \\"Bill\\": 1,\\n \\"Id\\": 1,\\n \\"Tag\\": \\"a\\",\\n \\"AiBill\\": 1,\\n \\"PersonalityTag\\": \\"a\\"\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 48,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'CallChatList' => [ - 'summary' => '获取聊天内容', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'AgentRecoverCall', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'CallId', - 'in' => 'query', - 'schema' => [ - 'title' => 'callId', - 'description' => 'callId', - 'type' => 'string', - 'required' => false, - 'example' => 'a', + 'ramAction' => [ + 'action' => 'aiccs:AgentRecoverCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'title' => '说话内容', - 'description' => '说话内容', - 'type' => 'string', - 'example' => '1', - ], - 'CreateTime' => [ - 'title' => '说话时间', - 'description' => '说话时间', - 'type' => 'string', - 'example' => '2019-01-09 14:14:19', - ], - 'FromType' => [ - 'title' => '说话号码,其中0为AI,1-用户,2-坐席', - 'description' => '说话号码,其中0为AI,1-用户,2-坐席', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'ChatId' => [ - 'title' => '聊天内容id', - 'description' => '聊天内容id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '79', - ], - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '81', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'AgentCancelCall', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AgentCancelCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": [\\n {\\n \\"Content\\": \\"1\\",\\n \\"CreateTime\\": \\"2019-01-09 14:14:19\\",\\n \\"FromType\\": 0,\\n \\"ChatId\\": 79\\n }\\n ],\\n \\"Code\\": 0,\\n \\"Timestamp\\": 81,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2-pop', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-pop', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-gov-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-nu16-b01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-edge-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-fujian', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-haidian-cm12-c01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-bj-b01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-prod-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-2', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-3', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-test-306', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong-finance-pop', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote-nebula-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-qingdao-nebula', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-et15-b01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-et2-b01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-inner', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-internal-test-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-inner', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-st4-d01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-su18-b01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wuhan', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-yushanfang', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangbei-na61-b01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou-na62-a01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhengzhou-nebula-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1-oxs', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'rus-west-1-pop', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'aiccs.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |
