'1.0',
'info' => [
'style' => 'RPC',
'product' => 'OutboundBot',
'version' => '2019-12-26',
],
'directories' => [
[
'children' => [
'CreateInstanceBindNumber',
'DescribeTenantBindNumber',
'ListAllTenantBindNumberBinding',
],
'type' => 'directory',
'title' => '号码管理',
'id' => 294946,
],
[
'children' => [
'GenerateUploadUrl',
'CreateJobDataParsingTask',
'CreateJobGroupExportTask',
'DescribeIntentStatistics',
'DescribeJobDataParsingTaskProgress',
'ListResourceTags',
'TagResources',
'UntagResources',
'GetConcurrentConversationQuota',
'ListDownloadTasks',
'CreateDownloadUrl',
'ListChatbotInstances',
'CreateTaskExportTask',
'GetJobDataUploadParams',
'ListFlashSmsTemplates',
'GetRealtimeConcurrencyReport',
'GetVersion',
'AssignJobs',
'AssignJobsAsync',
'CancelJobs',
'CreateAgentProfile',
'CreateAnnotationMission',
'CreateBatchRepeatJob',
'CreateBeebotIntent',
'CreateBeebotIntentLgf',
'CreateBeebotIntentUserSay',
'CreateDialogueFlow',
'CreateGlobalQuestion',
'CreateInstance',
'CreateIntent',
'CreateJobGroup',
'CreateScript',
'CreateTag',
'DeleteAgentProfiles',
'DeleteBeebotIntent',
'DeleteBeebotIntentLgf',
'DeleteBeebotIntentUserSay',
'DeleteContactBlockList',
'DeleteContactWhiteList',
'DeleteDialogueFlow',
'DeleteGlobalQuestion',
'DeleteInstance',
'DeleteIntent',
'DeleteJobGroup',
'DeleteScript',
'DeleteScriptRecording',
'DescribeBeebotIntent',
'DescribeDialogueNodeStatistics',
'DescribeDsReports',
'DescribeGlobalQuestion',
'DescribeGroupExecutingInfo',
'DescribeInstance',
'DescribeIntent',
'DescribeJob',
'DescribeJobGroup',
'DescribeScript',
'DescribeScriptVoiceConfig',
'DescribeTTSDemo',
'DescribeTagHitsSummary',
'Dialogue',
'DownloadRecording',
'DownloadScriptRecording',
'DuplicateScript',
'ExportScript',
'GetAfterAnswerDelayPlayback',
'GetAgentProfile',
'GetAgentProfileTemplate',
'GetAnnotationMissionSummary',
'GetAnnotationMissionTagInfoList',
'GetAssignJobsAsyncResult',
'GetBaseStrategyPeriod',
'GetContactBlockList',
'GetContactWhiteList',
'GetCurrentConcurrency',
'GetMaxAttemptsPerDay',
'GetSummaryInfo',
'GetTaskByUuid',
'ImportScript',
'InflightTaskTimeout',
'ListAgentProfiles',
'ListAnnotationMission',
'ListAnnotationMissionSession',
'ListApiPlugins',
'ListBeebotIntent',
'ListBeebotIntentLgf',
'ListBeebotIntentUserSay',
'ListDialogueFlows',
'ListGlobalQuestions',
'ListInstances',
'ListIntentions',
'ListIntents',
'ListJobGroups',
'ListJobGroupsAsync',
'ListJobs',
'ListJobsByGroup',
'ListOutboundCallNumbers',
'ListScriptPublishHistories',
'ListScriptRecording',
'ListScriptVoiceConfigs',
'ListScripts',
'ListTags',
'ModifyAgentProfile',
'ModifyAnnotationMission',
'ModifyBeebotIntent',
'ModifyBeebotIntentLgf',
'ModifyBeebotIntentUserSay',
'ModifyDialogueFlow',
'ModifyGlobalQuestion',
'ModifyInstance',
'ModifyIntent',
'ModifyJobGroup',
'ModifyScript',
'ModifyScriptVoiceConfig',
'ModifyTagGroups',
'PublishScript',
'PublishScriptForDebug',
'QueryJobs',
'QueryJobsWithResult',
'QueryScriptsByStatus',
'ResumeJobs',
'RollbackScript',
'SaveAfterAnswerDelayPlayback',
'SaveAnnotationMissionSessionList',
'SaveAnnotationMissionTagInfoList',
'SaveBaseStrategyPeriod',
'SaveContactBlockList',
'SaveContactWhiteList',
'SaveMaxAttemptsPerDay',
'SearchTask',
'StartJob',
'SubmitScriptReview',
'SuspendCall',
'SuspendCallWithFile',
'SuspendJobs',
'TaskPreparing',
'TerminateCall',
'WithdrawScriptReview',
],
'type' => 'directory',
'title' => '其他',
'id' => 294847,
],
[
'children' => [
'ModifyOutboundCallNumber',
'ModifyTTSConfig',
'SubmitRecording',
'GetAsrServerInfo',
'DescribeJobGroupExportTaskProgress',
'ChangeResourceGroup',
'ListTagResources',
'RecordFailure',
'CreateBatchJobs',
'GetNumberDistrictInfoTemplateDownloadUrl',
'SaveEffectiveDays',
'DeleteAllNumberDistrictInfo',
'UploadScriptRecording',
'GetEmptyNumberNoMoreCallsInfo',
'ModifyEmptyNumberNoMoreCallsInfo',
'ModifyBatchJobs',
'DeleteOutboundCallNumber',
'QueryScriptWaveforms',
'DescribeTTSConfig',
'DeleteScriptWaveform',
'SubmitBatchJobs',
'CreateScriptWaveform',
],
'type' => 'directory',
'title' => '已作废',
'id' => 294865,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AssignJobs' => [
'summary' => '批量创建外呼任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95',
],
],
[
'name' => 'StrategyJson',
'in' => 'query',
'schema' => [
'description' => '作业组执行策略'."\n"
.'- repeatBy 重复类型。Once(不重复),Day(按天重复),Week(按周重复),Month(按月重复); '."\n"
.'- startTime 策略开始时间。'."\n"
.'- endTime 策略结束时间。 '."\n"
.'- workingTime 可外呼时间段。'."\n"
.'- maxAttemptsPerDay 每天该任务下号码最大可尝试呼叫次数。'."\n"
.'- minAttemptInterval 号码重试呼叫时间间隔,单位分钟。'."\n"
.'- routingStrategy 号码策略,None(不指定),LocalFirst(本市号码优先), - LocalProvinceFirst(本省号码优先)。'."\n"
.'- repeatDays 对应重复类型下的执行日期。若重复类型RepeatBy为周,0表示周日,1-6分别表示周一至周六;若重复周期RepeatBy为月,1-31分别表示1至31日,没有该指定日期的月份不执行,如:若选定30日,二月份不执行。'."\n"
.'- repeatable 是否开启循环任务,true/false',
'type' => 'string',
'required' => false,
'example' => '{"maxAttemptsPerDay":"3","minAttemptInterval":"10","routingStrategy":"LocalProvinceFirst","repeatDays":["1","2","3"],"workingTime":[{"beginTime":"10:00:00","endTime":"11:00:00"},{"beginTime":"14:00:00","endTime":"15:00:00"}],"repeatable":true,"endTime":1707494400000,"startTime":1706976000000,"repeatBy":"Week"}',
],
],
[
'name' => 'RosterType',
'in' => 'query',
'schema' => [
'description' => '名单类型。'."\n"
."\n"
.'接口对接方式下发外呼任务默认JSON,可不填。'."\n"
.'通过名单上传,填入 excel。',
'type' => 'string',
'required' => false,
'example' => 'json',
],
],
[
'name' => 'JobDataParsingTaskId',
'in' => 'query',
'schema' => [
'description' => '解析外呼任务数据的任务ID。'."\n"
."\n"
.'接口对接方式下发外呼任务可不填。'."\n"
."\n"
.'> 若使用文件上传的形式,则需要调用CreateJobDataParsingTask来获取对应参数值,',
'type' => 'string',
'required' => false,
'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95',
],
],
[
'name' => 'IsAsynchrony',
'in' => 'query',
'schema' => [
'description' => '是否异步。'."\n"
."\n"
.'接口对接方式下发外呼任务可不填,默认为false。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '主叫号码列表(给客户拨打电话时候的显示号码)。'."\n"
."\n"
.'> 若不填,则默认全选',
'type' => 'array',
'items' => [
'description' => '主叫号码。',
'type' => 'string',
'required' => false,
'example' => '4008013260',
],
'required' => false,
'maxItems' => 99,
],
],
[
'name' => 'JobsJson',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '>此参数为必填。>'."\n"
."\n"
.'作业数据,格式是一个JSON数组,具体格式参考示例值,'."\n"
."\n"
.'JobsJson.N是个List,每个JobJson对应一个联系人(contact)。',
'type' => 'array',
'items' => [
'description' => 'extras //额外信息,非必填'."\n"
."\n"
.'- key //自定义变量名称key'."\n"
."\n"
.'- value //自定义变量内容value'."\n"
."\n"
.'contacts // 必填字段,被叫人联系信息'."\n"
."\n"
.'- phoneNumber // 必填字段,被叫人电话号码。'."\n"
."\n"
.'- referenceId // 必填字段,联系人ID(用户自定义),主要是避免重名现象。'."\n"
."\n"
.'- role //非必填字段,该联系人在此外呼业务中的角色,不指定则不区分。'."\n"
."\n"
.'- honorific //非必填字段,联系人尊称。'."\n"
."\n"
.'- name //非必填字段,联系人姓名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{'."\n"
.' "extras": [{'."\n"
.' "value": "测试",'."\n"
.' "key": "测试"'."\n"
.' }, {'."\n"
.' "key": "ServiceId",'."\n"
.' "value": null'."\n"
.' }, {'."\n"
.' "key": "TenantId",'."\n"
.' "value": null'."\n"
.' }],'."\n"
.' "contacts": [{'."\n"
.' "phoneNumber": "134*******",'."\n"
.' "name": "张三",'."\n"
.' "referenceId": "C01",'."\n"
.' "role": "客户1",'."\n"
.' "honorific": "老张"'."\n"
.' }]'."\n"
.'}',
],
'required' => false,
'docRequired' => true,
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息。',
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'JobGroupId' => [
'description' => '任务组ID。',
'type' => 'string',
'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息。',
'type' => 'string',
'example' => 'Success',
],
'JobsId' => [
'description' => '作业ID列表。',
'type' => 'array',
'items' => [
'description' => '作业ID。',
'type' => 'string',
'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76',
],
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"JobGroupId\\": \\"390515b5-6115-4ccf-83e2-52d5bfaf2ddf\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"JobsId\\": [\\n \\"12f3dd08-0c55-44ce-9b64-e69d35ed3a76\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 390515b5-6115-4ccf-83e2-52d5bfaf2ddf\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n OK\\n Success\\n 12f3dd08-0c55-44ce-9b64-e69d35ed3a76\\n","errorExample":""}]',
'title' => '批量创建外呼任务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:AssignJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'AssignJobsAsync' => [
'summary' => '异步创建外呼任务。',
'path' => '',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => [
'description' => '实例 ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76',
],
],
[
'name' => 'JobGroupId',
'in' => 'formData',
'schema' => [
'description' => '任务组 ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95',
],
],
[
'name' => 'StrategyJson',
'in' => 'formData',
'schema' => [
'description' => '作业组执行策略'."\n"
."\n"
.'- repeatBy'."\n"
."\n"
.' 重复类型。Once(不重复),Day(按天重复),Week(按周重复),Month(按月重复);'."\n"
."\n"
.'- startTime'."\n"
."\n"
.' 策略开始时间。'."\n"
."\n"
.'- endTime'."\n"
."\n"
.' 策略结束时间。'."\n"
."\n"
.'- workingTime'."\n"
."\n"
.' 可外呼时间段。'."\n"
."\n"
.'- maxAttemptsPerDay'."\n"
."\n"
.' 每天该任务下号码最大可尝试呼叫次数。'."\n"
."\n"
.'- minAttemptInterval'."\n"
."\n"
.' 号码重试呼叫时间间隔,单位分钟。'."\n"
."\n"
.'- routingStrategy'."\n"
."\n"
.' 号码策略,None(不指定),LocalFirst(本市号码优先), - LocalProvinceFirst(本省号码优先)。'."\n"
."\n"
.'- repeatDays'."\n"
."\n"
.' 对应重复类型下的执行日期。若重复类型 RepeatBy 为周,0 表示周日,1-6 分别表示周一至周六;若重复周期 RepeatBy 为月,1-31 分别表示 1 至 31 日,没有该指定日期的月份不执行,如:若选定 30 日,二月份不执行。'."\n"
."\n"
.'- repeatable'."\n"
."\n"
.' 是否开启循环任务,true/false',
'type' => 'string',
'required' => false,
'example' => '{"maxAttemptsPerDay":"3","minAttemptInterval":"10","routingStrategy":"LocalProvinceFirst","repeatDays":["1","2","3"],"workingTime":[{"beginTime":"10:00:00","endTime":"11:00:00"},{"beginTime":"14:00:00","endTime":"15:00:00"}],"repeatable":true,"endTime":1707494400000,"startTime":1706976000000,"repeatBy":"Week"}',
],
],
[
'name' => 'CallingNumber',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '主叫号码列表(给客户拨打电话时候的显示号码)。'."\n"
."\n"
.'> 若不填,则默认全选',
'type' => 'array',
'items' => [
'description' => '主叫号码。',
'type' => 'string',
'required' => false,
'example' => '4008013260',
],
'required' => false,
'maxItems' => 99,
],
],
[
'name' => 'JobsJson',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '作业数据,格式是一个 JSON 数组,具体格式参考示例值。'."\n"
."\n"
.'JobsJson.N 是个 List,每个 JobJson 对应一个联系人(contact)。',
'type' => 'array',
'items' => [
'description' => 'extras //额外信息,非必填'."\n"
."\n"
.'- key //自定义变量名称key'."\n"
."\n"
.'- value //自定义变量内容value'."\n"
."\n"
.'contacts // 必填字段,被叫人联系信息'."\n"
."\n"
.'- phoneNumber // 必填字段,被叫人电话号码'."\n"
."\n"
.'- referenceId // 必填字段,联系人ID(用户自定义),主要是避免重名现象'."\n"
."\n"
.'- role //非必填字段,该联系人在此外呼业务中的角色,不指定则不区分'."\n"
."\n"
.'- honorific //非必填字段,联系人尊称'."\n"
."\n"
.'- name //非必填字段,联系人姓名',
'type' => 'string',
'required' => false,
'example' => '{'."\n"
.' "extras": [{'."\n"
.' "value": "测试",'."\n"
.' "key": "测试"'."\n"
.' }, {'."\n"
.' "key": "ServiceId",'."\n"
.' "value": null'."\n"
.' }, {'."\n"
.' "key": "TenantId",'."\n"
.' "value": null'."\n"
.' }],'."\n"
.' "contacts": [{'."\n"
.' "phoneNumber": "134*******",'."\n"
.' "name": "张三",'."\n"
.' "referenceId": "C01",'."\n"
.' "role": "客户1",'."\n"
.' "honorific": "老张"'."\n"
.' }]'."\n"
.'}',
'docRequired' => true,
],
'required' => false,
'maxItems' => 10000,
'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回信息。',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'HttpStatusCode' => [
'description' => 'HTTP 状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息。',
'type' => 'string',
'example' => 'Success',
],
'AsyncTaskId' => [
'description' => '异步任务ID。',
'type' => 'string',
'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'title' => '异步创建外呼任务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:AssignJobsAsync',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"AsyncTaskId\\": \\"12f3dd08-0c55-44ce-9b64-e69d35ed3a76\\"\\n}","type":"json"}]',
],
'CancelJobs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => [
'description' => '是否取消全部',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'false',
],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => [
'description' => '过滤条件,场景ID'."\n"
.'>可以通过 DescribeJobGroup获取',
'type' => 'string',
'required' => false,
'example' => '35641113-b2f6-464e-a772-25c25554798b',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '过滤条件,任务组ID',
'type' => 'string',
'required' => false,
'example' => '9f84892d-721a-4069-9975-668c8164d64e',
],
],
[
'name' => 'JobId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '过滤条件,作业ID'."\n"
."\n"
.'> 当ALL参数为false时,JobId是必填的',
'type' => 'array',
'items' => [
'description' => '被取消的作业ID',
'type' => 'string',
'required' => false,
'example' => 'edf45790-7200-4cbc-b157-8c0a5f400b75',
],
'required' => false,
'maxItems' => 99,
],
],
[
'name' => 'JobReferenceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '过滤条件,作业的引用id'."\n"
."\n"
.'> 即为上传外呼名单时客户上传的ReferenceId',
'type' => 'array',
'items' => [
'description' => '作业的第三方id',
'type' => 'string',
'required' => false,
'example' => 'C01',
],
'required' => false,
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '取消即将执行或执行中的作业',
'summary' => '取消创建后即将执行的作业或者执行中的作业(已经在通话中的作业取消无效)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CancelJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ChangeResourceGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '资源组id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ResourceId.1=b949ae1f-01dc-4191-ae5a-70fbe6772fd8',
],
],
[
'name' => 'NewResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '新资源组id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'rg-aeky6wvb7yzabqy',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '【已废弃】更改资源组',
'summary' => '更改资源组。',
'changeSet' => [
[
'createdAt' => '2024-07-22T12:43:47.000Z',
'description' => '错误码发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:ChangeResourceGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateAgentProfile' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '229905',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => [
'title' => 'instance id',
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'PromptJson',
'in' => 'formData',
'schema' => [
'title' => 'prompt json',
'description' => '智能体配置(普通模式)',
'type' => 'string',
'required' => false,
'example' => '{'."\n"
.' "name": "安妮",'."\n"
.' "gender": "女",'."\n"
.' "age": 20,'."\n"
.' "role": "游戏推广员",'."\n"
.' "communicationStyle": ["亲切", "口语化", "活泼"],'."\n"
.' "goals": "通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。",'."\n"
.' "background": "福利介绍\\n从${开始时间}开始,直至${结束时间}结束,为期一周的时间里,我们精心准备了\'限时寻宝\'福利活动。只要您在这段时间内每日登录游戏,即可领取登录礼包,内含珍稀材料、能量药剂和限定外观奖励\\n\\n福利亮点\\n本次活动的亮点在于,累积登录达到5天的玩家,将额外获得一份\'神秘宝箱\',开启宝箱获得稀有宠物,将为您的战斗增添强大助力!千万别错过这次增强实力的绝佳机会。\\n\\n参与方式\\n登录游戏后,在活动面板中找到\'限时寻宝\',点击即可领取对应的奖励。记得每天上线,奖励不等人哦!",'."\n"
.' "skills": "作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。",'."\n"
.' "workflow": "1.亲切问候与自我介绍\\n- 开场白:“尊敬的冒险者,您好!我是安妮,来自游戏客服团队。今天有幸与您连线,是想分享一项即将启动的独家福利活动,绝对会让您的探险之旅更加精彩纷呈!”\\n- 确认玩家想了解活动后,再进行福利活动的介绍\\n2.福利活动介绍\\n3.强调福利亮点\\n4.说明参与方式与提醒\\n5.鼓励分享与反馈\\n- 互动号召:“如果您觉得这个活动不错,不妨和您的公会伙伴或者游戏朋友分享这个好消息。同时,我们也非常欢迎您在活动结束后,通过游戏内置的反馈系统告诉我们您的体验感受和建议。”\\n技能6: 礼貌结束通话\\n- 结束语:“好了,尊敬的冒险者,以上就是这次活动的主要内容。希望您能在活动中满载而归,祝您在旅程中所向披靡!如果还有任何疑问,欢迎随时联系我们客服团队。感谢您的接听,期待再次为您服务,再见!”",'."\n"
.' "constraint": "你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\n明确活动的起止时间,确保玩家不会混淆。\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。\\n鼓励玩家间的互动和反馈,以促进游戏社区的活跃度。\\n结束通话时保持礼貌,给玩家留下良好印象。\\n用户询问的问题与目标或流程无关时, 请礼貌拒绝,并引导到目标问题上。\\n对于不知道的问题,请不要胡乱回复,需要礼貌回复“不清楚”,并引导到目标问题上。",'."\n"
.' "openingPrompt": "尊敬的冒险者,您好!我是安妮,来自游戏客服团队。今天有幸与您连线,是想分享一项即将启动的独家福利活动,绝对会让您的探险之旅更加精彩纷呈!",'."\n"
.' "output": "",'."\n"
.' "aiHangupOutput": "",'."\n"
.' "aiSilenceTimeoutOutput": ""'."\n"
.'}',
],
],
[
'name' => 'Prompt',
'in' => 'formData',
'schema' => [
'title' => 'prompt',
'description' => '智能体配置(专业模式)',
'type' => 'string',
'required' => false,
'example' => '\\n名称:安妮 \\n身份:游戏推广员\\n背景:通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。\\n技能:作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。\\n约束条件:你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\n明确活动的起止时间,确保玩家不会混淆。\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。',
],
],
[
'name' => 'AgentProfileTemplateId',
'in' => 'formData',
'schema' => [
'title' => 'agent template id',
'description' => '智能体模版ID(唯一值)',
'type' => 'string',
'required' => true,
'example' => 'default-survey',
],
],
[
'name' => 'Model',
'in' => 'formData',
'schema' => [
'title' => '模型id',
'description' => '模型ID(唯一值)',
'type' => 'string',
'required' => true,
'example' => 'model_001',
],
],
[
'name' => 'ModelConfig',
'in' => 'formData',
'schema' => [
'title' => 'model config',
'description' => '模型配置(废弃)',
'type' => 'string',
'required' => false,
'example' => '""',
],
],
[
'name' => 'ScriptId',
'in' => 'formData',
'schema' => [
'title' => 'script id',
'description' => '场景 ID',
'type' => 'string',
'required' => true,
'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17',
],
],
[
'name' => 'LabelsJson',
'in' => 'formData',
'schema' => [
'title' => 'labels json',
'description' => '标签描述',
'type' => 'string',
'required' => false,
'example' => '[{'."\n"
.' "name": "是否满意",'."\n"
.' "description": "对介绍的游戏内容是否感兴趣",'."\n"
.' "valueList": "[\\"有兴趣\\",\\"没兴趣\\"]"'."\n"
.'}]',
],
],
[
'name' => 'VariablesJson',
'in' => 'formData',
'schema' => [
'title' => 'variables json',
'description' => '变量配置',
'type' => 'string',
'required' => false,
'example' => '[{'."\n"
.' "name": "开始时间",'."\n"
.' "description": "开始时间"'."\n"
.'}, {'."\n"
.' "name": "结束时间",'."\n"
.' "description": "结束时间"'."\n"
.'}]',
],
],
[
'name' => 'Scenario',
'in' => 'formData',
'schema' => [
'title' => '场景',
'description' => '场景',
'type' => 'string',
'required' => false,
'example' => '测试场景',
],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => [
'title' => '描述',
'description' => '描述',
'type' => 'string',
'required' => false,
'example' => '描述当前智能体的功能',
],
],
[
'name' => 'AppIp',
'in' => 'formData',
'schema' => [
'title' => 'app_ip , POP设置',
'description' => 'app_ip (系统字段)-可不填写',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'InstructionJson',
'in' => 'formData',
'schema' => [
'description' => '指令配置',
'type' => 'string',
'required' => false,
'example' => '[{'."\n"
.' "type": "TransferToAgent",'."\n"
.' "instructions": [{'."\n"
.' "code": "Transfer0",'."\n"
.' "skillGroupId": "testcode",'."\n"
.' "skillGroupName": "skillgroup"'."\n"
.' }],'."\n"
.' "timeoutEnable": false'."\n"
.'}, {'."\n"
.' "type": "CollectNumber",'."\n"
.' "instructions": [{'."\n"
.' "code": "DTMF0",'."\n"
.' "name": "收号测试",'."\n"
.' "collectVoice": true,'."\n"
.' "terminator": "#"'."\n"
.' }]'."\n"
.'}]',
],
],
[
'name' => 'FaqCategoryIds',
'in' => 'formData',
'schema' => [
'description' => 'FAQ目录ID',
'type' => 'string',
'required' => false,
'example' => '[30000474726]',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'Ok',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'CreateTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '1739333534000',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '1737077564000',
],
'AgentProfileId' => [
'title' => 'agent profile id',
'description' => '智能体配置 ID',
'type' => 'string',
'example' => 'd31794e2a51f47d2901b4094d88311d7',
],
'InstanceId' => [
'title' => '实例id',
'description' => '实例ID',
'type' => 'string',
'example' => '1e16c663-0339-4064-9d57-07f772e78f21',
],
'ScriptId' => [
'title' => 'script id',
'description' => '场景 ID',
'type' => 'string',
'example' => 'd13ad2d3-3fe6-4352-b38b-bd6559047de8',
],
'AgentType' => [
'title' => 'agent type',
'description' => 'agent type',
'type' => 'string',
'example' => '“”',
],
'PromptJson' => [
'title' => 'prompt json',
'description' => '智能体配置',
'type' => 'string',
'example' => '{'."\n"
.' "name": "安妮",'."\n"
.' "gender": "女",'."\n"
.' "age": 20,'."\n"
.' "role": "游戏推广员",'."\n"
.' "communicationStyle": ["亲切", "口语化", "活泼"],'."\n"
.' "goals": "通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。",'."\n"
.' "background": "福利介绍\\n从${开始时间}开始,直至${结束时间}结束,为期一周的时间里,我们精心准备了\'限时寻宝\'福利活动。只要您在这段时间内每日登录游戏,即可领取登录礼包,内含珍稀材料、能量药剂和限定外观奖励\\n\\n福利亮点\\n本次活动的亮点在于,累积登录达到5天的玩家,将额外获得一份\'神秘宝箱\',开启宝箱获得稀有宠物,将为您的战斗增添强大助力!千万别错过这次增强实力的绝佳机会。\\n\\n参与方式\\n登录游戏后,在活动面板中找到\'限时寻宝\',点击即可领取对应的奖励。记得每天上线,奖励不等人哦!",'."\n"
.' "skills": "作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。",'."\n"
.' "workflow": "1.亲切问候与自我介绍\\n- 开场白:“尊敬的冒险者,您好!我是安妮,来自游戏客服团队。今天有幸与您连线,是想分享一项即将启动的独家福利活动,绝对会让您的探险之旅更加精彩纷呈!”\\n- 确认玩家想了解活动后,再进行福利活动的介绍\\n2.福利活动介绍\\n3.强调福利亮点\\n4.说明参与方式与提醒\\n5.鼓励分享与反馈\\n- 互动号召:“如果您觉得这个活动不错,不妨和您的公会伙伴或者游戏朋友分享这个好消息。同时,我们也非常欢迎您在活动结束后,通过游戏内置的反馈系统告诉我们您的体验感受和建议。”\\n技能6: 礼貌结束通话\\n- 结束语:“好了,尊敬的冒险者,以上就是这次活动的主要内容。希望您能在活动中满载而归,祝您在旅程中所向披靡!如果还有任何疑问,欢迎随时联系我们客服团队。感谢您的接听,期待再次为您服务,再见!”",'."\n"
.' "constraint": "你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\n明确活动的起止时间,确保玩家不会混淆。\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。\\n鼓励玩家间的互动和反馈,以促进游戏社区的活跃度。\\n结束通话时保持礼貌,给玩家留下良好印象。\\n用户询问的问题与目标或流程无关时, 请礼貌拒绝,并引导到目标问题上。\\n对于不知道的问题,请不要胡乱回复,需要礼貌回复“不清楚”,并引导到目标问题上。",'."\n"
.' "openingPrompt": "尊敬的冒险者,您好!我是安妮,来自游戏客服团队。今天有幸与您连线,是想分享一项即将启动的独家福利活动,绝对会让您的探险之旅更加精彩纷呈!",'."\n"
.' "output": "",'."\n"
.' "aiHangupOutput": "",'."\n"
.' "aiSilenceTimeoutOutput": ""'."\n"
.'}',
],
'Prompt' => [
'title' => 'prompt',
'description' => '提示词(专业模式)',
'type' => 'string',
'example' => '\\n名称:安妮 \\n身份:游戏推广员\\n背景:通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。\\n技能:作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。\\n约束条件:你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\n明确活动的起止时间,确保玩家不会混淆。\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。',
],
'AgentProfileTemplateId' => [
'title' => 'agent template id',
'description' => '智能体配置模版 ID',
'type' => 'string',
'example' => 'default-survey',
],
'Model' => [
'title' => '模型id',
'description' => '模型ID',
'type' => 'string',
'example' => 'model_001',
],
'ModelConfig' => [
'title' => 'model config',
'description' => '模型配置',
'type' => 'string',
'example' => '""',
],
'System' => [
'title' => '是否是系统模版',
'description' => '是否是系统模版',
'type' => 'boolean',
'example' => 'True',
],
'LabelsJson' => [
'title' => 'labels',
'description' => '标签描述',
'type' => 'string',
'example' => '[{'."\n"
.' "name": "是否满意",'."\n"
.' "description": "对介绍的游戏内容是否感兴趣",'."\n"
.' "valueList": "[\\"有兴趣\\",\\"没兴趣\\"]"'."\n"
.'}]',
],
'VariablesJson' => [
'title' => 'variables',
'description' => '变量配置',
'type' => 'string',
'example' => '[{'."\n"
.' "name": "开始时间",'."\n"
.' "description": "开始时间"'."\n"
.'}, {'."\n"
.' "name": "结束时间",'."\n"
.' "description": "结束时间"'."\n"
.'}]',
],
'Scenario' => [
'title' => '场景',
'description' => '场景',
'type' => 'string',
'example' => '场景',
],
'Description' => [
'title' => '描述',
'description' => '描述',
'type' => 'string',
'example' => '这是一个智能体。',
],
'InstructionJson' => [
'description' => '指令配置',
'type' => 'string',
'example' => '[{'."\n"
.' "type": "TransferToAgent",'."\n"
.' "instructions": [{'."\n"
.' "code": "Transfer0",'."\n"
.' "skillGroupId": "testcode",'."\n"
.' "skillGroupName": "skillgroup"'."\n"
.' }],'."\n"
.' "timeoutEnable": false'."\n"
.'}, {'."\n"
.' "type": "CollectNumber",'."\n"
.' "instructions": [{'."\n"
.' "code": "DTMF0",'."\n"
.' "name": "收号测试",'."\n"
.' "collectVoice": true,'."\n"
.' "terminator": "#"'."\n"
.' }]'."\n"
.'}]',
],
],
],
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExists.InstanceId',
'errorMessage' => 'The specified instance %s does not exist.',
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"Ok\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"CreateTime\\": \\"1739333534000\\",\\n \\"UpdateTime\\": \\"1737077564000\\",\\n \\"AgentProfileId\\": \\"d31794e2a51f47d2901b4094d88311d7\\",\\n \\"InstanceId\\": \\"1e16c663-0339-4064-9d57-07f772e78f21\\",\\n \\"ScriptId\\": \\"d13ad2d3-3fe6-4352-b38b-bd6559047de8\\",\\n \\"AgentType\\": \\"“”\\",\\n \\"PromptJson\\": \\"{\\\\n\\\\t\\\\\\"name\\\\\\": \\\\\\"安妮\\\\\\",\\\\n\\\\t\\\\\\"gender\\\\\\": \\\\\\"女\\\\\\",\\\\n\\\\t\\\\\\"age\\\\\\": 20,\\\\n\\\\t\\\\\\"role\\\\\\": \\\\\\"游戏推广员\\\\\\",\\\\n\\\\t\\\\\\"communicationStyle\\\\\\": [\\\\\\"亲切\\\\\\", \\\\\\"口语化\\\\\\", \\\\\\"活泼\\\\\\"],\\\\n\\\\t\\\\\\"goals\\\\\\": \\\\\\"通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。\\\\\\",\\\\n\\\\t\\\\\\"background\\\\\\": \\\\\\"福利介绍\\\\\\\\n从${开始时间}开始,直至${结束时间}结束,为期一周的时间里,我们精心准备了\'限时寻宝\'福利活动。只要您在这段时间内每日登录游戏,即可领取登录礼包,内含珍稀材料、能量药剂和限定外观奖励\\\\\\\\n\\\\\\\\n福利亮点\\\\\\\\n本次活动的亮点在于,累积登录达到5天的玩家,将额外获得一份\'神秘宝箱\',开启宝箱获得稀有宠物,将为您的战斗增添强大助力!千万别错过这次增强实力的绝佳机会。\\\\\\\\n\\\\\\\\n参与方式\\\\\\\\n登录游戏后,在活动面板中找到\'限时寻宝\',点击即可领取对应的奖励。记得每天上线,奖励不等人哦!\\\\\\",\\\\n\\\\t\\\\\\"skills\\\\\\": \\\\\\"作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。\\\\\\",\\\\n\\\\t\\\\\\"workflow\\\\\\": \\\\\\"1.亲切问候与自我介绍\\\\\\\\n- 开场白:“尊敬的冒险者,您好!我是安妮,来自游戏客服团队。今天有幸与您连线,是想分享一项即将启动的独家福利活动,绝对会让您的探险之旅更加精彩纷呈!”\\\\\\\\n- 确认玩家想了解活动后,再进行福利活动的介绍\\\\\\\\n2.福利活动介绍\\\\\\\\n3.强调福利亮点\\\\\\\\n4.说明参与方式与提醒\\\\\\\\n5.鼓励分享与反馈\\\\\\\\n- 互动号召:“如果您觉得这个活动不错,不妨和您的公会伙伴或者游戏朋友分享这个好消息。同时,我们也非常欢迎您在活动结束后,通过游戏内置的反馈系统告诉我们您的体验感受和建议。”\\\\\\\\n技能6: 礼貌结束通话\\\\\\\\n- 结束语:“好了,尊敬的冒险者,以上就是这次活动的主要内容。希望您能在活动中满载而归,祝您在旅程中所向披靡!如果还有任何疑问,欢迎随时联系我们客服团队。感谢您的接听,期待再次为您服务,再见!”\\\\\\",\\\\n\\\\t\\\\\\"constraint\\\\\\": \\\\\\"你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\\\\\\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\\\\\\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\\\\\\\n明确活动的起止时间,确保玩家不会混淆。\\\\\\\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。\\\\\\\\n鼓励玩家间的互动和反馈,以促进游戏社区的活跃度。\\\\\\\\n结束通话时保持礼貌,给玩家留下良好印象。\\\\\\\\n用户询问的问题与目标或流程无关时, 请礼貌拒绝,并引导到目标问题上。\\\\\\\\n对于不知道的问题,请不要胡乱回复,需要礼貌回复“不清楚”,并引导到目标问题上。\\\\\\",\\\\n\\\\t\\\\\\"openingPrompt\\\\\\": \\\\\\"尊敬的冒险者,您好!我是安妮,来自游戏客服团队。今天有幸与您连线,是想分享一项即将启动的独家福利活动,绝对会让您的探险之旅更加精彩纷呈!\\\\\\",\\\\n\\\\t\\\\\\"output\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"aiHangupOutput\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"aiSilenceTimeoutOutput\\\\\\": \\\\\\"\\\\\\"\\\\n}\\",\\n \\"Prompt\\": \\"\\\\\\\\n名称:安妮 \\\\\\\\n身份:游戏推广员\\\\\\\\n背景:通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。\\\\\\\\n技能:作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。\\\\\\\\n约束条件:你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\\\\\\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\\\\\\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\\\\\\\n明确活动的起止时间,确保玩家不会混淆。\\\\\\\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。\\",\\n \\"AgentProfileTemplateId\\": \\"default-survey\\",\\n \\"Model\\": \\"model_001\\",\\n \\"ModelConfig\\": \\"\\\\\\"\\\\\\"\\",\\n \\"System\\": true,\\n \\"LabelsJson\\": \\"[{\\\\n\\\\t\\\\\\"name\\\\\\": \\\\\\"是否满意\\\\\\",\\\\n\\\\t\\\\\\"description\\\\\\": \\\\\\"对介绍的游戏内容是否感兴趣\\\\\\",\\\\n\\\\t\\\\\\"valueList\\\\\\": \\\\\\"[\\\\\\\\\\\\\\"有兴趣\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"没兴趣\\\\\\\\\\\\\\"]\\\\\\"\\\\n}]\\",\\n \\"VariablesJson\\": \\"[{\\\\n\\\\t\\\\\\"name\\\\\\": \\\\\\"开始时间\\\\\\",\\\\n\\\\t\\\\\\"description\\\\\\": \\\\\\"开始时间\\\\\\"\\\\n}, {\\\\n\\\\t\\\\\\"name\\\\\\": \\\\\\"结束时间\\\\\\",\\\\n\\\\t\\\\\\"description\\\\\\": \\\\\\"结束时间\\\\\\"\\\\n}]\\",\\n \\"Scenario\\": \\"场景\\",\\n \\"Description\\": \\"这是一个智能体。\\",\\n \\"InstructionJson\\": \\"[{\\\\n\\\\t\\\\\\"type\\\\\\": \\\\\\"TransferToAgent\\\\\\",\\\\n\\\\t\\\\\\"instructions\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"code\\\\\\": \\\\\\"Transfer0\\\\\\",\\\\n\\\\t\\\\t\\\\\\"skillGroupId\\\\\\": \\\\\\"testcode\\\\\\",\\\\n\\\\t\\\\t\\\\\\"skillGroupName\\\\\\": \\\\\\"skillgroup\\\\\\"\\\\n\\\\t}],\\\\n\\\\t\\\\\\"timeoutEnable\\\\\\": false\\\\n}, {\\\\n\\\\t\\\\\\"type\\\\\\": \\\\\\"CollectNumber\\\\\\",\\\\n\\\\t\\\\\\"instructions\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"code\\\\\\": \\\\\\"DTMF0\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"收号测试\\\\\\",\\\\n\\\\t\\\\t\\\\\\"collectVoice\\\\\\": true,\\\\n\\\\t\\\\t\\\\\\"terminator\\\\\\": \\\\\\"#\\\\\\"\\\\n\\\\t}]\\\\n}]\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '创建智能体配置',
'summary' => '创建智能配置。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateAgentProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateAnnotationMission' => [
'summary' => '创建标注任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '129549',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'AnnotationMissionDataSourceType',
'in' => 'query',
'schema' => [
'title' => '1:外呼',
'description' => '标注任务数据类型。'."\n"
."\n"
.'- 1:外呼',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'title' => '外呼场景ID',
'description' => '外呼场景ID',
'type' => 'string',
'required' => false,
'example' => '6236f21e-2e04-4dad-a47b-ae77e6a48325',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'bf3b51a5-e88a-4636-98b0-1a34725a085b',
],
],
[
'name' => 'Finished',
'in' => 'query',
'schema' => [
'description' => '业务是否正常结束。'."\n"
."\n"
.'> 当SessionEndReasonFilterList没有传入值时,这个参数才生效。'."\n"
.'> - true:正常通话记录'."\n"
.'> - false:非正常完结通话记录',
'type' => 'boolean',
'required' => false,
'example' => 'True',
],
],
[
'name' => 'SessionEndReasonFilterList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '通话结果状态过滤条件',
'description' => '通话结果状态过滤条件'."\n"
."\n"
.'> 与SessionEndReasonFilterListJsonString 相同,二者选其一填入即可。',
'type' => 'array',
'items' => [
'description' => '关键词过滤规则。'."\n"
."\n"
.'**通话记录过滤枚举值**'."\n"
.'- 1:正常完结'."\n"
.'- 2:拒识后机器人挂机'."\n"
.'- 3:静默超时挂机'."\n"
.'- 4:拒识后用户挂机'."\n"
.'- 5:用户无理由挂机'."\n"
.'- 6:命中意图转人工'."\n"
.'- 7:拒识转人工'."\n"
.'- 8:用户侧无交互'."\n"
.'- 9:系统异常中断'."\n"
.'- 10:命中意图转IVR'."\n"
.'- 11:拒识别转IVR',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'SessionEndReasonFilterListJsonString',
'in' => 'query',
'schema' => [
'title' => '通话结果状态过滤条件',
'description' => '通话结果状态过滤条件'."\n"
."\n"
.'>与SessionEndReasonFilterList作用相同,两个参数任选其一填入即可。'."\n"
.' 格式为[1]、[1,2]等。数组中可填入多个过滤条件,过滤条件对应的枚举值如下。'."\n"
."\n"
.'**通话记录过滤枚举值**'."\n"
.'- 1:正常完结'."\n"
.'- 2:拒识后机器人挂机'."\n"
.'- 3:静默超时挂机'."\n"
.'- 4:拒识后用户挂机'."\n"
.'- 5:用户无理由挂机'."\n"
.'- 6:命中意图转人工'."\n"
.'- 7:拒识转人工'."\n"
.'- 8:用户侧无交互'."\n"
.'- 9:系统异常中断'."\n"
.'- 10:命中意图转IVR'."\n"
.'- 11:拒识别转IVR',
'type' => 'string',
'required' => false,
'example' => '[1]',
],
],
[
'name' => 'ExcludeOtherSession',
'in' => 'query',
'schema' => [
'title' => '是否排除其他任务已标注的通话记录',
'description' => '是否排除其他任务已标注的通话记录,不填写默认为false',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ConversationTimeStartFilter',
'in' => 'query',
'schema' => [
'title' => '通话时间过滤开始时间',
'description' => '通话时间过滤开始时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1683302400000',
],
],
[
'name' => 'ConversationTimeEndFilter',
'in' => 'query',
'schema' => [
'title' => '通话时间过滤结束时间',
'description' => '通话时间过滤结束时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1682956800000',
],
],
[
'name' => 'SamplingType',
'in' => 'query',
'schema' => [
'title' => '抽样类型',
'description' => '抽样类型。'."\n"
."\n"
.'- 1:全量'."\n"
.'- 2:百分比'."\n"
.'- 3:自定义量',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'SamplingRate',
'in' => 'query',
'schema' => [
'title' => '抽样比例',
'description' => '抽样比例'."\n"
."\n"
.'> 该参数当SamplingType为2时生效,同时需要必填,否则会导致创建失败。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'SamplingCount',
'in' => 'query',
'schema' => [
'title' => '抽样数量自定义量',
'description' => '抽样数量自定义量'."\n"
.'> 该参数当SamplingType为3时生效,同时需要必填,否则会导致创建失败。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AnnotationMissionName',
'in' => 'query',
'schema' => [
'title' => '标注任务名称',
'description' => '标注任务名称',
'type' => 'string',
'required' => false,
'example' => '询问卖车-标注任务-20230506-112934',
],
],
[
'name' => 'AnnotationMissionDebugDataSourceList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '标注数据来源列表'."\n"
."\n"
.'> 与AnnotationMissionDebugDataSourceListJsonString参数作用相同,两者任选其一即可。',
'type' => 'array',
'items' => [
'description' => '业务数据列表'."\n"
."\n"
.'**枚举值:**'."\n"
.'- 1:外呼任务'."\n"
.'- 2:测试任务',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'required' => false,
],
],
[
'name' => 'AnnotationMissionDebugDataSourceListJsonString',
'in' => 'query',
'schema' => [
'description' => '调试数据JSON'."\n"
.'> 与AnnotationMissionDebugDataSourceList参数作用相同,两者任选其一即可。格式为[1]、[2]、[1,2]。数组中可填入多个过滤条件,过滤条件对应的枚举值如下'."\n"
."\n"
.'- 1:外呼任务'."\n"
.'- 2:测试任务',
'type' => 'string',
'required' => false,
'example' => '[1]',
],
],
[
'name' => 'ChatbotId',
'in' => 'query',
'schema' => [
'description' => '机器人ID'."\n"
."\n"
.'> 可从DescribeScript接口中拿到',
'type' => 'string',
'required' => false,
'example' => 'chatbot-cn-fqEnFZBYnb',
],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => [
'description' => '坐席ID'."\n"
."\n"
.'>可从DescribeInstance接口中获取',
'type' => 'string',
'required' => false,
'example' => '1168702',
],
],
[
'name' => 'AgentKey',
'in' => 'query',
'schema' => [
'description' => '业务空间key'."\n"
."\n"
.'> 可从DescribeInstance接口中获取',
'type' => 'string',
'required' => false,
'example' => '9137ab9c27044921860030adf8590ec4_p_outbound_public',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否调用成功。true:调用成功。 false:调用失败。',
'type' => 'boolean',
'example' => 'True',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '附加信息。取值说明如下:请求正常,返回success。请求异常,返回具体异常错误码。',
'type' => 'string',
'example' => '执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-uax33hol2uu,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'True',
],
'Message' => [
'description' => '附加信息。取值说明如下:请求正常,返回success。请求异常,返回具体异常错误码。',
'type' => 'string',
'example' => '执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-uax33hol2uu,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821',
],
],
],
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-uax33hol2uu,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-uax33hol2uu,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '创建标注任务',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:CreateAnnotationMission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateBatchJobs' => [
'summary' => '批量创建外呼作业,已废弃。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd',
],
],
[
'name' => 'BatchJobName',
'in' => 'query',
'schema' => [
'description' => '批量作业名字',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '第一个作业组',
],
],
[
'name' => 'BatchJobDescription',
'in' => 'query',
'schema' => [
'description' => '批量作业描述',
'type' => 'string',
'required' => false,
'example' => '描述',
],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => false,
'example' => 'c6a668d1-3145-4048-9101-cb3678bb8884',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'b9ff4e88-65f9-4eb3-987c-11ba51f3f24d',
],
],
[
'name' => 'StrategyJson',
'in' => 'query',
'schema' => [
'description' => '作业执行策略JSON(必填)',
'type' => 'string',
'required' => false,
'example' => '{"maxAttemptsPerDay":2,"name":"策略名字","workingTime":[{"beginTime":"09:00:00","endTime":"12:00:00"},{"beginTime":"13:00:00","endTime":"18:30:00"}],"minAttemptInterval":60}',
],
],
[
'name' => 'JobFilePath',
'in' => 'query',
'schema' => [
'description' => '下载批量作Excel的地址,'."\n"
."\n"
.'>该参数通过 GetJobDataUploadParams接口其返回参数Folder获取',
'type' => 'string',
'required' => false,
'example' => '52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx',
],
],
[
'name' => 'Submitted',
'in' => 'query',
'schema' => [
'description' => '是否提交,false 提交,true 草稿状态',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'false',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '主叫号码列表。',
'type' => 'array',
'items' => [
'description' => '主叫号码。',
'type' => 'string',
'required' => false,
'example' => '["4008013260"]',
],
'required' => false,
'example' => '["95187"]',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'BatchJob' => [
'description' => '作业组信息',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '作业组创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1579068424000',
],
'ScenarioId' => [
'description' => '作业组场景ID',
'type' => 'string',
'example' => '6cea9bed-63e6-439e-ae4c-b3333efff53d',
],
'JobGroupName' => [
'description' => '作业组名字',
'type' => 'string',
'example' => '批量作业01',
],
'BatchJobId' => [
'description' => '作业组ID',
'type' => 'string',
'example' => '5a7e8b09-baf9-4cab-b540-c971f47a7146',
],
'JobFilePath' => [
'description' => '上传Excel文件key',
'type' => 'string',
'example' => '52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx',
],
'JobGroupDescription' => [
'description' => '作业组描述',
'type' => 'string',
'example' => '第一个批量作业',
],
'CallingNumbers' => [
'description' => '主叫号码列表',
'type' => 'array',
'items' => [
'description' => '主叫号码列表',
'type' => 'string',
'example' => '["4008013260 "]',
],
],
'Strategy' => [
'description' => '作业执行策略',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '策略类型',
'type' => 'string',
'example' => 'Repeatable',
],
'StrategyName' => [
'description' => '策略名字',
'type' => 'string',
'example' => '策略',
],
'MaxAttemptsPerDay' => [
'description' => '拨打失败后最多重新拨打次数',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'FollowUpStrategy' => [
'description' => '前周期未完成外呼业务的后续处理方案。',
'type' => 'string',
'example' => 'CONTINUE',
],
'EndTime' => [
'description' => '调度策略总的结束时间',
'type' => 'integer',
'format' => 'int64',
'example' => '2209702074000',
],
'Customized' => [
'description' => '策略自定义信息',
'type' => 'string',
'example' => '{}',
],
'IsTemplate' => [
'description' => '是否是模板',
'type' => 'boolean',
'example' => 'false',
],
'StartTime' => [
'description' => '作业组开始执行时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1578550074000',
],
'StrategyId' => [
'description' => '策略ID',
'type' => 'string',
'example' => 'f718798d-96be-40e4-bef6-317b54855708',
],
'RoutingStrategy' => [
'description' => '主叫号码录音策略',
'type' => 'string',
'example' => 'LocalFirst',
],
'MinAttemptInterval' => [
'description' => '重新拨打间隔时间',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'StrategyDescription' => [
'description' => '策略描述',
'type' => 'string',
'example' => '作业执行策略',
],
'RepeatBy' => [
'description' => '重复执行方式,Once 不重复, Day 没人重复, Week 每周重复,Month 每月重复',
'type' => 'string',
'example' => 'Once',
],
'WorkingTime' => [
'description' => '作业一天中的执行时间段',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '结束时间',
'type' => 'string',
'example' => '12:00:00',
],
'BeginTime' => [
'description' => '开始时间',
'type' => 'string',
'example' => '09:00:00',
],
],
'description' => '',
],
],
'RepeatDays' => [
'description' => '重复执行的天列表。',
'type' => 'array',
'items' => [
'description' => '重复执行天',
'type' => 'string',
'example' => '[1,2,3,4,5]',
],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"BatchJob\\": {\\n \\"CreationTime\\": 1579068424000,\\n \\"ScenarioId\\": \\"6cea9bed-63e6-439e-ae4c-b3333efff53d\\",\\n \\"JobGroupName\\": \\"批量作业01\\",\\n \\"BatchJobId\\": \\"5a7e8b09-baf9-4cab-b540-c971f47a7146\\",\\n \\"JobFilePath\\": \\"52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx\\",\\n \\"JobGroupDescription\\": \\"第一个批量作业\\",\\n \\"CallingNumbers\\": [\\n \\"[\\\\\\"4008013260 \\\\\\"]\\"\\n ],\\n \\"Strategy\\": {\\n \\"Type\\": \\"Repeatable\\",\\n \\"StrategyName\\": \\"策略\\",\\n \\"MaxAttemptsPerDay\\": 3,\\n \\"FollowUpStrategy\\": \\"CONTINUE\\",\\n \\"EndTime\\": 2209702074000,\\n \\"Customized\\": \\"{}\\",\\n \\"IsTemplate\\": false,\\n \\"StartTime\\": 1578550074000,\\n \\"StrategyId\\": \\"f718798d-96be-40e4-bef6-317b54855708\\",\\n \\"RoutingStrategy\\": \\"LocalFirst\\",\\n \\"MinAttemptInterval\\": 10,\\n \\"StrategyDescription\\": \\"作业执行策略\\",\\n \\"RepeatBy\\": \\"Once\\",\\n \\"WorkingTime\\": [\\n {\\n \\"EndTime\\": \\"12:00:00\\",\\n \\"BeginTime\\": \\"09:00:00\\"\\n }\\n ],\\n \\"RepeatDays\\": [\\n \\"[1,2,3,4,5]\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n \\n 1579068424000\\n 6cea9bed-63e6-439e-ae4c-b3333efff53d\\n 批量作业01\\n 5a7e8b09-baf9-4cab-b540-c971f47a7146\\n 52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx\\n 第一个批量作业\\n [\\"4008013260 \\"]\\n \\n Repeatable\\n 策略\\n 3\\n CONTINUE\\n 2209702074000\\n {}\\n false\\n 1578550074000\\n f718798d-96be-40e4-bef6-317b54855708\\n LocalFirst\\n 10\\n 作业执行策略\\n Once\\n \\n 12:00:00\\n 09:00:00\\n \\n [1,2,3,4,5]\\n \\n \\n","errorExample":""}]',
'title' => '批量创建外呼作业-已废弃',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateBatchJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateBatchRepeatJob' => [
'summary' => '复制已创建的任务组重新发起外呼任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94033',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2bfa5ae4-7185-4227-a3b8-328f26f11be1',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '作业名称',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '24',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '作业组描述',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '测试3',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术id',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '0fe7f71c-8771-42ef-9bb1-19aa16ae7120',
],
],
[
'name' => 'SourceGroupId',
'in' => 'query',
'schema' => [
'description' => '作业组id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c4f8a3d3-2e94-4bd4-aef8-e35f663d4847',
],
],
[
'name' => 'FilterStatus',
'in' => 'query',
'schema' => [
'description' => '作业组状态',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Succeeded,NoInteraction,Failed,Cancelled',
],
],
[
'name' => 'StrategyJson',
'in' => 'query',
'schema' => [
'description' => '作业执行策略',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '{\\"maxAttemptsPerDay\\":1,\\"minAttemptInterval\\":1,\\"routingStrategy\\":\\"LocalFirst\\"}',
],
],
[
'name' => 'RecallStrategyJson',
'in' => 'query',
'schema' => [
'description' => '重拨策略json',
'type' => 'string',
'required' => false,
'example' => '{\\"emptyNumberIgnore\\":false,\\"inArrearsIgnore\\":false,\\"outOfServiceIgnore\\":false}',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '主叫号码',
'type' => 'array',
'items' => [
'description' => '主叫号码',
'type' => 'string',
'required' => false,
'example' => '03737075611',
],
'required' => false,
'example' => '[]',
'maxItems' => 100,
],
],
[
'name' => 'RingingDuration',
'in' => 'query',
'schema' => [
'description' => '振铃时长',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '25',
],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => [
'description' => '作业优先级',
'type' => 'string',
'required' => false,
'example' => '10',
],
],
[
'name' => 'MinConcurrency',
'in' => 'query',
'schema' => [
'description' => '最小并发数',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2',
],
],
[
'name' => 'FlashSmsExtras',
'in' => 'query',
'schema' => [
'description' => '闪信推送的配置参数,JSON格式,包含第三方闪信的配置信息。 '."\n"
.'- templateId: 闪信模板ID。 '."\n"
.'- configId: 闪信配置ID。',
'type' => 'string',
'required' => false,
'example' => '{"templateId":"10471","configId":"8037f524-6ff2-4dbe-bb28-f59234ea7a64"}'."\n",
],
],
[
'name' => 'RecallCallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '重呼主叫号码列表',
'type' => 'array',
'items' => [
'description' => '重呼主叫号码',
'type' => 'string',
'required' => false,
'example' => '4008013260',
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http错误码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'JobGroup' => [
'description' => '作业组信息',
'type' => 'object',
'properties' => [
'Id' => [
'description' => '作业组id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'RingingDuration' => [
'description' => '振铃时长',
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'Priority' => [
'description' => '作业优先级',
'type' => 'string',
'example' => '3',
],
'MinConcurrency' => [
'description' => '最小并发',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
'example' => '{}',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"JobGroup\\": {\\n \\"Id\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"RingingDuration\\": 30,\\n \\"Priority\\": \\"3\\",\\n \\"MinConcurrency\\": 1\\n }\\n}","type":"json"}]',
'title' => '复制任务组重新发起外呼',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2024-06-24T02:14:42.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2024-01-04T12:35:21.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2021-12-22T12:30:34.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2021-12-22T12:30:34.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateBatchRepeatJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateBeebotIntent' => [
'summary' => '小模型场景中创建意图。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '224513',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a',
],
],
[
'name' => 'IntentDefinition',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '意图定义描述',
'type' => 'object',
'properties' => [
'IntentName' => [
'description' => '意图名称'."\n"
."\n"
.'> 即为意图code,唯一标识符',
'type' => 'string',
'required' => true,
'example' => '知道了',
],
'AliasName' => [
'description' => '意图别名',
'type' => 'string',
'required' => false,
'example' => '嗯明白了',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n",
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'BeebotRequestId' => [
'description' => '内部请求ID',
'type' => 'string',
'example' => '497CFAFF-48CC-161A-AD2C-252DED569037',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'IntentId' => [
'description' => '意图 ID',
'type' => 'integer',
'format' => 'int64',
'example' => '10717802',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\\\n\\",\\n \\"Success\\": true,\\n \\"BeebotRequestId\\": \\"497CFAFF-48CC-161A-AD2C-252DED569037\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"IntentId\\": 10717802\\n}","type":"json"}]',
'title' => '【小模型接口】创建小蜜机器人意图',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateBeebotIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateBeebotIntentLgf' => [
'summary' => '创建小模型场景意图问法模版。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '224614',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'LgfDefinition',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'LGF定义信息',
'type' => 'object',
'properties' => [
'IntentId' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10717802',
],
'RuleText' => [
'description' => '意图配置',
'type' => 'string',
'required' => true,
'example' => '我是一个问法模版',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息',
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP错误码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'LgfId' => [
'description' => '问法模版ID',
'type' => 'integer',
'format' => 'int64',
'example' => '5666117',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'True',
],
'BeebotRequestId' => [
'description' => '内部请求ID',
'type' => 'string',
'example' => '497CFAFF-48CC-161A-AD2C-252DED569037',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"LgfId\\": 5666117,\\n \\"Success\\": true,\\n \\"BeebotRequestId\\": \\"497CFAFF-48CC-161A-AD2C-252DED569037\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '【小模型接口】创建小蜜机器人意图问法模版',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateBeebotIntentLgf',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateBeebotIntentUserSay' => [
'summary' => '创建小模型场景的意图问法。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '224602',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'UserSayDefinition',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '用户问法定义描述',
'type' => 'object',
'properties' => [
'IntentId' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10717802',
],
'Content' => [
'description' => '用户问法',
'type' => 'string',
'required' => true,
'example' => '你知道xxxxx么?',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'UserSayId' => [
'description' => '用户问法ID',
'type' => 'integer',
'format' => 'int64',
'example' => '17448458',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'BeebotRequestId' => [
'description' => '内部请求ID',
'type' => 'string',
'example' => '0B219FCB-EC71-1F08-BB1B-0E87C20158C8',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"UserSayId\\": 17448458,\\n \\"Success\\": true,\\n \\"BeebotRequestId\\": \\"0B219FCB-EC71-1F08-BB1B-0E87C20158C8\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '【小模型接口】创建小蜜机器人意图用户问法',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateBeebotIntentUserSay',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateDialogueFlow' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd',
],
],
[
'name' => 'DialogueName',
'in' => 'query',
'schema' => [
'description' => '对话流程名字',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '主流程',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd0bf93dd-1a54-4f00-819e-c75502d38681',
],
],
[
'name' => 'DialogueFlowType',
'in' => 'query',
'schema' => [
'description' => '流程类型,子流程类型 SubFlow, 主流程类型 MainFlow',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'MainFlow',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http 状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'DialogueFlowId' => [
'description' => '对话流id',
'type' => 'string',
'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidDialogueFlowName.Duplicated',
'errorMessage' => 'The specified DialogueFlowName already exists.',
'description' => '对话流名称已经存在。请您更换一个名字。',
],
],
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"DialogueFlowId\\": \\"390515b5-6115-4ccf-83e2-52d5bfaf2ddf\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n 390515b5-6115-4ccf-83e2-52d5bfaf2ddf\\n true\\n OK\\n Success\\n","errorExample":""}]',
'title' => '创建对话流程 -旧画布接口',
'summary' => '创建对话流程,旧画布接口。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateDialogueFlow',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateDownloadUrl' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'DownloadTaskId',
'in' => 'query',
'schema' => [
'description' => '下载任务ID。'."\n"
.'> 该参数通过ListDownloadTasks接口的返参:TaskId获取的',
'type' => 'string',
'required' => true,
'example' => '137da36b41304bcd999a0a7895dc6881',
],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => [
'description' => '文件ID。'."\n"
.'> 该参数通过ListDownloadTasks接口的返参:FileId获取的',
'type' => 'string',
'required' => true,
'example' => '6f91885fa24b4c408d8f4eb392fd8ae6',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'FileHttpUrl' => [
'description' => '文件URL',
'type' => 'string',
'example' => 'http://www.xxx.com/xxx',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'EC08CC41-6870-5594-939A-F758F057898F',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"FileHttpUrl\\": \\"http://www.xxx.com/xxx\\",\\n \\"RequestId\\": \\"EC08CC41-6870-5594-939A-F758F057898F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '创建下载文件URL',
'summary' => '创建下载中心任务的URL链接。',
'changeSet' => [
[
'createdAt' => '2021-11-24T13:00:44.000Z',
'description' => 'OpenAPI 下线',
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateDownloadUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateGlobalQuestion' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'GlobalQuestionName',
'in' => 'query',
'schema' => [
'description' => '全局问题名字',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '未识别全局问题',
],
],
[
'name' => 'GlobalQuestionType',
'in' => 'query',
'schema' => [
'description' => '全局问题类型',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'COMMON',
],
],
[
'name' => 'Questions',
'in' => 'query',
'schema' => [
'description' => '全局问题',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '["未识别的用户问题"]',
],
],
[
'name' => 'Answers',
'in' => 'query',
'schema' => [
'description' => '全局问题的答案',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '["你好,您可以再说一遍吗","不好意思我刚才没有听清"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'GlobalQuestionId' => [
'description' => '全局问题ID',
'type' => 'string',
'example' => 'a546b616-724b-437f-bdb3-629a30c98567',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '56666881-887A-530A-B679-C3B6B6B142C0',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidGlobalQuestionName.Duplicated',
'errorMessage' => 'The specified GlobalQuestionName already exists.',
'description' => '全局问题名称已经存在。请您更换一个名字。',
],
],
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"GlobalQuestionId\\": \\"a546b616-724b-437f-bdb3-629a30c98567\\",\\n \\"RequestId\\": \\"56666881-887A-530A-B679-C3B6B6B142C0\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '【旧画布接口】创建全局问题',
'summary' => '旧画布场景中创建全局问题。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateGlobalQuestion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'description' => '实例名字。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '第一个实例',
],
],
[
'name' => 'InstanceDescription',
'in' => 'query',
'schema' => [
'description' => '实例描述。',
'type' => 'string',
'required' => false,
'example' => '这个是第一的实例',
],
],
[
'name' => 'MaxConcurrentConversation',
'in' => 'query',
'schema' => [
'description' => '实例最大并发。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [
14 => '14',
],
'example' => '4',
],
],
[
'name' => 'NluServiceType',
'in' => 'query',
'schema' => [
'description' => '服务类型。'."\n"
."\n"
.'> 若不填入,默认为Managed'."\n"
."\n"
.'- DialogStudio:对话引擎3.0。'."\n"
."\n"
.'- Authorized:公有云版本对话机器人,公有云客户自己购买的智能语音交互产品服务(客户私有服务),通过场景管理-编辑-调用服务-自定义服务完成授权。'."\n"
."\n"
.'- Provided:独立部署版本对话机器人。'."\n"
."\n"
.'- Managed:旧版外呼画布,智能外呼产品默认智能语音交互产品服务(公共服务)。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'DialogStudio' => '对话引擎3.0',
'Authorized' => '公有云版本对话机器人',
'Provided' => '独立部署版本对话机器人',
'Managed' => '旧版画布',
],
'example' => 'DialogStudio',
'enum' => [
'Managed',
'Authorized',
'Provided',
'Baseme',
'Ant',
'Notification',
'MyBankJustice',
'DialogStudio',
],
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID。'."\n"
."\n"
.'> 可通过资源管理文档获取来源api,相关链接:https://api.aliyun.com/document/ResourceManager/2020-03-31/ListResourceGroups',
'type' => 'string',
'required' => false,
'example' => 'rg-acfmwd4qr3z773y',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '主叫号码列表。'."\n"
."\n"
.'> 默认不填',
'type' => 'array',
'items' => [
'description' => '主叫号码。'."\n"
."\n"
.'> 默认不填',
'type' => 'string',
'required' => false,
'example' => '4008013260',
],
'required' => false,
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Instance' => [
'description' => '业务实例信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间,单位毫秒',
'type' => 'integer',
'format' => 'int64',
'example' => '1578469042851',
],
'InstanceId' => [
'description' => '业务实例ID。',
'type' => 'string',
'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
'CreatorId' => [
'description' => '创建者ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '435986',
],
'OwnerName' => [
'description' => '所有者名称。',
'type' => 'string',
'example' => 'xxxx',
],
'InstanceDescription' => [
'description' => '业务实例描述。',
'type' => 'string',
'example' => '这个是第一个实例',
],
'InstanceName' => [
'description' => '业务实例名字。',
'type' => 'string',
'example' => '第一个实例',
],
'CreatorName' => [
'description' => '创建者名字。',
'type' => 'string',
'example' => 'xxx',
],
'ResourceGroupId' => [
'description' => '资源组ID。',
'type' => 'string',
'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
'MaxConcurrentConversation' => [
'description' => '实例最大并发。',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidInstanceName.Duplicated',
'errorMessage' => 'The specified InstanceName already exists.',
'description' => '实例名称已经存在。请您更换一个名字。',
],
[
'errorCode' => 'LimitExceeded.ConcurrentConversation',
'errorMessage' => 'The maximum number of concurrent conversations is exceeded.',
'description' => '并发数已经超限,请重新设置。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Instance\\": {\\n \\"CreationTime\\": 1578469042851,\\n \\"InstanceId\\": \\"90515b5-6115-4ccf-83e2-52d5bfaf2ddf\\",\\n \\"CreatorId\\": 435986,\\n \\"OwnerName\\": \\"xxxx\\",\\n \\"InstanceDescription\\": \\"这个是第一个实例\\",\\n \\"InstanceName\\": \\"第一个实例\\",\\n \\"CreatorName\\": \\"xxx\\",\\n \\"ResourceGroupId\\": \\"90515b5-6115-4ccf-83e2-52d5bfaf2ddf\\",\\n \\"MaxConcurrentConversation\\": 4\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n 无\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n \\n 1578469042851\\n 90515b5-6115-4ccf-83e2-52d5bfaf2ddf\\n 435986\\n xxxx\\n 这个是第一个实例\\n 第一个实例\\n xxx\\n 90515b5-6115-4ccf-83e2-52d5bfaf2ddf\\n 4\\n \\n","errorExample":""}]',
'title' => '创建业务实例',
'summary' => '创建一个智能外呼业务实例。',
'changeSet' => [
[
'createdAt' => '2022-06-28T12:45:55.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-06-22T02:25:50.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateInstanceBindNumber' => [
'summary' => '业务实例绑定号码。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbot85J9KC',
],
],
'parameters' => [
[
'name' => 'Number',
'in' => 'query',
'schema' => [
'description' => '绑定的号码(必填)'."\n"
."\n"
.'> 号码列表参考ListAllTenantBindNumberBinding接口的返回参数Number',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '15005059355',
],
],
[
'name' => 'InstanceList',
'in' => 'query',
'schema' => [
'title' => '智能外呼实例ID。',
'description' => '智能外呼实例ID列表'."\n"
."\n"
.'> 修改该参数值会将覆盖之前参数,该参数置为空时表示将号码绑定列表置空',
'type' => 'string',
'required' => false,
'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf'."\n"
.',123*****09,456*****08',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'List' => [
'description' => '号码数据列表',
'type' => 'array',
'items' => [
'description' => '号码数据列表',
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '实例id',
'type' => 'string',
'example' => '96b847ad-2683-4794-b7b4-7ef094fb81f6',
],
'Success' => [
'description' => '是否绑定成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"96b847ad-2683-4794-b7b4-7ef094fb81f6\\",\\n \\"Success\\": true\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '实例绑定号码',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-03-01T12:36:05.000Z',
'description' => 'OpenAPI 下线',
],
],
'flowControl' => [
'flowControlList' => [
[
'threshold' => '1000',
'countWindow' => 1,
'regionId' => '*',
'api' => 'CreateInstanceBindNumber',
],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateInstanceBindNumber',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateIntent' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'IntentName',
'in' => 'query',
'schema' => [
'description' => '意图名称',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '是本人',
],
],
[
'name' => 'IntentDescription',
'in' => 'query',
'schema' => [
'description' => '意图描述',
'type' => 'string',
'required' => false,
'example' => '确定是本人的意图',
],
],
[
'name' => 'Utterances',
'in' => 'query',
'schema' => [
'description' => '用户表述',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '["是","是的","是啊","嗯嗯","是我","是我,有事吗","对,是","对的","对是我",""]',
],
],
[
'name' => 'Keywords',
'in' => 'query',
'schema' => [
'description' => '关键字',
'type' => 'string',
'required' => false,
'example' => '["是","是的"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'IntentId' => [
'description' => '意图ID',
'type' => 'string',
'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidIntentName.Duplicated',
'errorMessage' => 'The specified IntentName already exists.',
'description' => '意图名称已经存在。请您更换一个名字。',
],
],
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"IntentId\\": \\"390515b5-6115-4ccf-83e2-52d5bfaf2ddf\\"\\n}","type":"json"}]',
'title' => '【旧画布接口】创建意图',
'summary' => '旧画布场景下创建触发意图。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateJobDataParsingTask' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94038',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'JobFilePath',
'in' => 'query',
'schema' => [
'description' => '任务所在文件路径'."\n"
."\n"
.'> 该参数为GetJobDataUploadParams接口的返回参数Folder值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'UPLOADED/JOB/024f8cf0-c842-4c01-b74b-c8667e4579c7/e5897675-91f0-4e53-8af8-7e1ce4f2c089_KDC HR- 外呼话术2- 外呼名单模板 - Copy.xlsx',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b3865dc3-40fa-4afd-9fe4-dc7cda305a24',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'JobDataParsingTaskId' => [
'description' => '上传的任务ID'."\n"
."\n"
.'> 该参数将用于DescribeJobDataParsingTaskProgress的JobDataParsingTaskId参数中。',
'type' => 'string',
'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"JobDataParsingTaskId\\": \\"d004cfd2-6a81-491c-83c6-cbe186620c95\\"\\n}","type":"json"}]',
'title' => '创建任务数据解析任务',
'summary' => '创建任务数据解析任务。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateJobDataParsingTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateJobGroup' => [
'summary' => '创建作业组。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd',
],
],
[
'name' => 'JobGroupName',
'in' => 'query',
'schema' => [
'description' => '任务名字。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '第一个任务',
],
],
[
'name' => 'JobGroupDescription',
'in' => 'query',
'schema' => [
'description' => '任务描述。',
'type' => 'string',
'required' => false,
'example' => '任务描述',
],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => [
'description' => '已废弃',
'type' => 'string',
'required' => false,
'example' => 'b9ff4e88-65f9-4eb3-987c-11ba51f3f24d'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'b9ff4e88-65f9-4eb3-987c-11ba51f3f24d',
],
],
[
'name' => 'StrategyJson',
'in' => 'query',
'schema' => [
'description' => '任务执行策略。 '."\n"
.'- repeatBy 重复类型。Once(不重复),Week(按周重复),Month(按月重复); '."\n"
.'- startTime 按时间执行时的策略开始时间。'."\n"
.'- endTime 按时间执行的策略结束时间。 '."\n"
.'> 执行方式分为'."\n"
.'> - 不填写策略开始与结束时间时,执行方式为立即执行。'."\n"
.'> - 当填入策略时间后,表示按时间执行,同时需要选择重复类型repeatBy。'."\n"
.'- workingTime 可外呼时间段。'."\n"
.'- maxAttemptsPerDay 每天该任务下号码最大可尝试呼叫次数。'."\n"
.'- minAttemptInterval 号码重试呼叫时间间隔,单位分钟。'."\n"
.'- routingStrategy 号码策略,None(不指定),LocalFirst(本市号码优先), - LocalProvinceFirst(本省号码优先)。'."\n"
.'- repeatDays 对应重复类型下的执行日期。若重复类型RepeatBy为周,0表示周日,1-6分别表示周一至周六;若重复周期RepeatBy为月,1-31分别表示1至31日,没有该指定日期的月份不执行,如:若选定30日,二月份不执行。'."\n"
.'- repeatable 是否开启循环任务,true/false',
'type' => 'string',
'required' => false,
'example' => '{"maxAttemptsPerDay":"3","minAttemptInterval":"10","routingStrategy":"LocalProvinceFirst","repeatDays":["1","2","3"],"workingTime":[{"beginTime":"10:00:00","endTime":"11:00:00"},{"beginTime":"14:00:00","endTime":"15:00:00"}],"repeatable":true,"endTime":1707494400000,"startTime":1706976000000,"repeatBy":"Week"}',
],
],
[
'name' => 'RecallStrategyJson',
'in' => 'query',
'schema' => [
'description' => '重拨策略,JSON格式,json中参数值默认为false。'."\n"
."\n"
.'- **emptyNumberIgnore**:空号不外呼。'."\n"
.'- **inArrearsIgnore**:欠费不外呼。'."\n"
.'- **outOfServiceIgnore**:停机不外呼。',
'type' => 'string',
'required' => false,
'example' => '{"emptyNumberIgnore":true,"inArrearsIgnore":true,"outOfServiceIgnore":true}',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '主叫号码列表。若不填写,则默认全选该实例下绑定的号码',
'type' => 'array',
'items' => [
'description' => '主叫号码。',
'type' => 'string',
'required' => false,
'example' => '4008013260',
],
'required' => false,
'maxItems' => 99,
],
],
[
'name' => 'RingingDuration',
'in' => 'query',
'schema' => [
'description' => '最优振铃时长。默认为25',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '25',
],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => [
'description' => '作业组优先级,取值范围如下'."\n"
.'- **Urgent**:紧急任务。'."\n"
.'- **Daily**:日常任务。',
'type' => 'string',
'required' => false,
'example' => 'Daily',
'enum' => [
'Daily',
'Urgent',
],
],
],
[
'name' => 'MinConcurrency',
'in' => 'query',
'schema' => [
'description' => '并发保障值。 '."\n"
.'- 任务启动时,最低保障N个并发。'."\n"
.'- 同一优先级的任务并发保障值加和不能大于实例并发。 '."\n"
.'- 若配置并发保障值为0,则依赖系统内空闲并发进行智能分配。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'FlashSmsExtras',
'in' => 'query',
'schema' => [
'description' => '闪信推送的配置参数,JSON格式,包含第三方闪信的配置信息。 '."\n"
.'- templateId: 闪信模板ID。 '."\n"
.'- configId: 闪信配置ID。'."\n"
.'- templateContent:闪信内容。'."\n"
."\n"
.'> templateContent的值需要找对应闪信能力提供伙伴获取',
'type' => 'string',
'required' => false,
'example' => '{"templateId":"104xx","configId":"8037f524-6fxxxxx", "templateContent": "【智能外呼机器人】给您来电,敬请接听!"}',
],
],
[
'name' => 'RecallCallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '重呼主叫号码列表',
'type' => 'array',
'items' => [
'description' => '重呼主叫号码列表,指第一次没打通。重呼时使用的主叫,不指定的话,默认和主叫列表一致。',
'type' => 'string',
'required' => false,
'example' => '["4008013260"]',
],
'required' => false,
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP返回码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '提示信息。',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'JobGroup' => [
'description' => '任务信息。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '任务状态。',
'type' => 'string',
'example' => 'Scheduling',
],
'ScenarioId' => [
'description' => '场景ID。',
'type' => 'string',
'example' => '6cea9bed-63e6-439e-ae4c-b3333efff53d',
],
'JobGroupId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9',
],
'CreationTime' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1578550074361',
],
'JobGroupName' => [
'description' => '任务名称。',
'type' => 'string',
'example' => '第一个作业组',
],
'JobFilePath' => [
'description' => '任务文件OSS路径。'."\n"
.'>无值,不做返回',
'type' => 'string',
'example' => 'UPLOADED/JOB/b3865dc3-40fa-4afd-9fe4-dc7cda305a24/229eac13-379d-4abe-96e0-8cf026b56c0b_template (1).xlsx',
],
'JobGroupDescription' => [
'description' => '任务描述。',
'type' => 'string',
'example' => '第一个的作业组',
],
'JobDataParsingTaskId' => [
'description' => '上传的任务文件对应后台异步解析操作的ID.'."\n"
.'>无值,不做返回',
'type' => 'string',
'example' => '744ff448-2b4c-40d4-94ca-51f246905b0f',
],
'ScriptName' => [
'description' => '话术场景名称。',
'type' => 'string',
'example' => '话术',
],
'ScriptVersion' => [
'description' => '话术场景版本。',
'type' => 'string',
'example' => '1628425608429',
],
'ModifyTime' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '1628425608429',
],
'CallingNumbers' => [
'description' => '主叫号码列表。',
'type' => 'array',
'items' => [
'description' => '主叫号码。',
'type' => 'string',
'example' => '["4008013260"]',
],
],
'ExportProgress' => [
'description' => '导出进度。'."\n"
.'>该字段在当前参数已废弃',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '任务导出状态。【已废弃】',
'type' => 'string',
'example' => 'FINISHED',
],
'FileHttpUrl' => [
'description' => '文件地址。【已废弃】',
'type' => 'string',
'example' => 'https://***.oss-cn-shanghai.aliyuncs.com/sample',
],
'Progress' => [
'description' => '进度。【已废弃】',
'type' => 'string',
'example' => '1',
],
],
],
'Strategy' => [
'description' => '任务调度策略。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '策略类型。',
'type' => 'string',
'example' => 'Repeatable',
],
'StrategyName' => [
'description' => '策略名字。',
'type' => 'string',
'example' => '催收策略',
],
'MaxAttemptsPerDay' => [
'description' => '任务中电话未能接通时每天的最多尝试次数。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'FollowUpStrategy' => [
'description' => '执行周期结束后的后续处理方式(该字段不再使用)。',
'type' => 'string',
'example' => 'CONTINUE',
],
'EndTime' => [
'description' => '结束时间',
'type' => 'integer',
'format' => 'int64',
'example' => '2209702074000',
],
'Customized' => [
'description' => '策略自定义数据',
'type' => 'string',
'example' => '{}',
],
'IsTemplate' => [
'description' => '是否是模板',
'type' => 'boolean',
'example' => 'false',
],
'StartTime' => [
'description' => '开始时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1578550074000',
],
'StrategyId' => [
'description' => '策略ID。',
'type' => 'string',
'example' => 'cc9a436e-03b0-4ada-8364-77ec2290aa39',
],
'RoutingStrategy' => [
'description' => '号码策略。'."\n"
.'- None:无特殊规则。'."\n"
.'- LocalFirst:本市号码优先。'."\n"
.'- LocalProvinceFirst:本省号码优先。',
'type' => 'string',
'example' => 'LocalFirst',
],
'MinAttemptInterval' => [
'description' => '拨打间隔时间',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'StrategyDescription' => [
'description' => '策略描述',
'type' => 'string',
'example' => '催收策略',
],
'RepeatBy' => [
'description' => '重复执行方式,once不重复,day每天重复,week每周重复,month每月重复',
'type' => 'string',
'example' => 'Once',
],
'WorkingTime' => [
'description' => '策略执行时间窗口',
'type' => 'array',
'items' => [
'description' => '策略执行时间窗口',
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '窗口开始时间',
'type' => 'string',
'example' => '12:00:00',
],
'BeginTime' => [
'description' => '窗口结束时间',
'type' => 'string',
'example' => '09:00:00',
],
],
],
],
'RepeatDays' => [
'description' => '重复的执行天。'."\n"
.'- 若重复周期**RepeatBy**为**周**,0表示周日,1-6分别表示周一至周六'."\n"
.'- 若重复周期**RepeatBy**为**月**,1-31分别表示1至31日,没有该指定日期的月份不执行,如:若选定30日,二月份不执行',
'type' => 'array',
'items' => [
'description' => '重复的执行天',
'type' => 'string',
'example' => '[1,2,3,4,5]',
],
],
],
],
'RecallStrategy' => [
'description' => '重拨策略。',
'type' => 'object',
'properties' => [
'EmptyNumberIgnore' => [
'description' => '空号不再外呼',
'type' => 'boolean',
'example' => 'true',
],
'InArrearsIgnore' => [
'description' => '欠费不再外呼',
'type' => 'boolean',
'example' => 'true',
],
'OutOfServiceIgnore' => [
'description' => '停机不再外呼',
'type' => 'boolean',
'example' => 'true',
],
],
],
'RingingDuration' => [
'description' => '振铃时长',
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'Priority' => [
'description' => '作业组优先级,取值范围'."\n"
.'- **Urgent**:紧急任务。'."\n"
.'- **Daily**:日常任务。',
'type' => 'string',
'example' => 'Daily',
],
'MinConcurrency' => [
'description' => '并发保障值'."\n"
.'任务启动时,最低保障N个并发;'."\n"
.'同一优先级的任务并发保障值加和不能大于实例并发;'."\n"
.'若配置并发保障值为0,则依赖系统内空闲并发进行智能分配。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'RecallCallingNumbers' => [
'description' => '重呼主叫号码列表',
'type' => 'array',
'items' => [
'description' => '重呼主叫号码列表,指第一次没打通。重呼时使用的主叫,不指定的话,默认和主叫列表一致。',
'type' => 'string',
'example' => '["4008013260"]',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"JobGroup\\": {\\n \\"Status\\": \\"Scheduling\\",\\n \\"ScenarioId\\": \\"6cea9bed-63e6-439e-ae4c-b3333efff53d\\",\\n \\"JobGroupId\\": \\"c62e6789-28a8-41db-941e-171a01d3b3b9\\",\\n \\"CreationTime\\": 1578550074361,\\n \\"JobGroupName\\": \\"第一个作业组\\",\\n \\"JobFilePath\\": \\"UPLOADED/JOB/b3865dc3-40fa-4afd-9fe4-dc7cda305a24/229eac13-379d-4abe-96e0-8cf026b56c0b_template (1).xlsx\\",\\n \\"JobGroupDescription\\": \\"第一个的作业组\\",\\n \\"JobDataParsingTaskId\\": \\"744ff448-2b4c-40d4-94ca-51f246905b0f\\",\\n \\"ScriptName\\": \\"话术\\",\\n \\"ScriptVersion\\": \\"1628425608429\\",\\n \\"ModifyTime\\": \\"1628425608429\\",\\n \\"CallingNumbers\\": [\\n \\"[\\\\\\"4008013260\\\\\\"]\\"\\n ],\\n \\"ExportProgress\\": {\\n \\"Status\\": \\"FINISHED\\",\\n \\"FileHttpUrl\\": \\"https://***.oss-cn-shanghai.aliyuncs.com/sample\\",\\n \\"Progress\\": \\"1\\"\\n },\\n \\"Strategy\\": {\\n \\"Type\\": \\"Repeatable\\",\\n \\"StrategyName\\": \\"催收策略\\",\\n \\"MaxAttemptsPerDay\\": 3,\\n \\"FollowUpStrategy\\": \\"CONTINUE\\",\\n \\"EndTime\\": 2209702074000,\\n \\"Customized\\": \\"{}\\",\\n \\"IsTemplate\\": false,\\n \\"StartTime\\": 1578550074000,\\n \\"StrategyId\\": \\"cc9a436e-03b0-4ada-8364-77ec2290aa39\\",\\n \\"RoutingStrategy\\": \\"LocalFirst\\",\\n \\"MinAttemptInterval\\": 3,\\n \\"StrategyDescription\\": \\"催收策略\\",\\n \\"RepeatBy\\": \\"Once\\",\\n \\"WorkingTime\\": [\\n {\\n \\"EndTime\\": \\"12:00:00\\",\\n \\"BeginTime\\": \\"09:00:00\\"\\n }\\n ],\\n \\"RepeatDays\\": [\\n \\"[1,2,3,4,5]\\"\\n ]\\n },\\n \\"RecallStrategy\\": {\\n \\"EmptyNumberIgnore\\": true,\\n \\"InArrearsIgnore\\": true,\\n \\"OutOfServiceIgnore\\": true\\n },\\n \\"RingingDuration\\": 30,\\n \\"Priority\\": \\"Daily\\",\\n \\"MinConcurrency\\": 1,\\n \\"RecallCallingNumbers\\": [\\n \\"[\\\\\\"4008013260\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n \\n Scheduling\\n 6cea9bed-63e6-439e-ae4c-b3333efff53d\\n c62e6789-28a8-41db-941e-171a01d3b3b9\\n 1578550074361\\n 第一个作业组\\n UPLOADED/JOB/b3865dc3-40fa-4afd-9fe4-dc7cda305a24/229eac13-379d-4abe-96e0-8cf026b56c0b_template (1).xlsx\\n 第一个的作业组\\n 744ff448-2b4c-40d4-94ca-51f246905b0f\\n 话术\\n 1628425608429\\n 1628425608429\\n [\\"4008013260\\"]\\n \\n FINISHED\\n https://***.oss-cn-shanghai.aliyuncs.com/sample\\n \\n \\n \\n Repeatable\\n 催收策略\\n 3\\n CONTINUE\\n 2209702074000\\n {}\\n false\\n 1578550074000\\n cc9a436e-03b0-4ada-8364-77ec2290aa39\\n LocalFirst\\n 3\\n 催收策略\\n Once\\n \\n 12:00:00\\n 09:00:00\\n \\n [1,2,3,4,5]\\n \\n \\n true\\n true\\n true\\n \\n 30\\n Daily\\n 1\\n \\n","errorExample":""}]',
'title' => '创建外呼任务组',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateJobGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateJobGroupExportTask' => [
'summary' => '创建外呼作业组导出任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID(必填)',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'baf6dfdc-eb79-4c63-ab19-c56388b1fbdd',
],
],
[
'name' => 'Option',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '导入任务执行参数',
'type' => 'array',
'items' => [
'description' => '是否忽略录音。'."\n"
.'- 默认为空:导出文本及录音。'."\n"
.'- IgnoreRecording :忽略录音。',
'type' => 'string',
'required' => false,
'example' => 'IgnoreRecording',
],
'required' => false,
'example' => '[]',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '错误码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'TaskId' => [
'description' => '任务ID',
'type' => 'string',
'example' => '744b27f3-437f-4a8c-a181-f668e492fd24',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"TaskId\\": \\"744b27f3-437f-4a8c-a181-f668e492fd24\\"\\n}","type":"json"}]',
'title' => '创建外呼作业组导出任务',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateJobGroupExportTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateScript' => [
'summary' => '创建场景。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4',
],
],
[
'name' => 'ScriptName',
'in' => 'query',
'schema' => [
'description' => '话术名称',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '课程满意度回访',
],
],
[
'name' => 'ScriptDescription',
'in' => 'query',
'schema' => [
'description' => '话术描述',
'type' => 'string',
'required' => false,
'example' => '课程回复话术',
],
],
[
'name' => 'Industry',
'in' => 'query',
'schema' => [
'description' => '所属行业',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '教育',
],
],
[
'name' => 'Scene',
'in' => 'query',
'schema' => [
'description' => '所属场景',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '回访',
],
],
[
'name' => 'ChatbotId',
'in' => 'query',
'schema' => [
'description' => '当Instance的NluServiceType为Authorized或Provided时,需要通过此字段指定话术需要绑定的对话机器人实例ID',
'type' => 'string',
'required' => false,
'example' => 'chatbot-cn-IfaUfqaUnb',
],
],
[
'name' => 'AsrConfig',
'in' => 'query',
'schema' => [
'description' => 'ASR配置,参数定义'."\n"
."\n"
.'- **appKey**:阿里云账号appKey。'."\n"
.'- **maxEndSilence**:语音端点检测时长。'."\n"
.'- **silenceTimeout**:静默超时,单位秒,用户静默N秒后超时。'."\n"
."\n"
.'- **engine**:调用服务;【ali、xunfei】'."\n"
.'- **nlsServiceType**:调用服务类型 【Managed 、Authorized】'."\n"
.'- **engineXunfei**:调用方为xunfei时,需要填入对应配置。'."\n"
.'> 当engine选择ali,nlsServiceType为Authorized时,使用的是自定义服务,服务方为ali,当engine为ali,nlsServiceType为Managed时,使用默认服务,当engine为xunfei,nlsServiceType为Authorized时,使用的服务方为xunfei,需要填入xunfei配置{"uuid":"ed2xxxxxxxxx","globalMaxEndSilence":700,"globalMaxEndSilenceEnable":true}'."\n"
."\n"
.'- **globalMaxEndSilence**:静音检测,单位为毫秒。'."\n"
."\n"
.'- **globalMaxEndSilenceEnable**:静音检测开关,默认开启。'."\n"
."\n"
.'- **speechNoiseThreshold**:噪音过滤阈值',
'type' => 'string',
'required' => false,
'example' => '{'."\n"
.' "appKey": "oQDVNlE6fZ5mg46X",'."\n"
.' "engine": "ali",'."\n"
.' "engineXunfei": "",'."\n"
.' "globalMaxEndSilence": 700,'."\n"
.' "globalMaxEndSilenceEnable": true,'."\n"
.' "maxEndSilence": "500",'."\n"
.' "nlsServiceType": "Managed",'."\n"
.' "silenceTimeout": "5000",'."\n"
.' "speechNoiseThreshold": "0"'."\n"
.'}',
],
],
[
'name' => 'TtsConfig',
'in' => 'query',
'schema' => [
'description' => 'TTS配置,参数定义'."\n"
."\n"
.'- **voice**:发音人。'."\n"
.'- **volume**:音量,取值范围:0~100。默认值:50。'."\n"
.'- **speechRate**:语速,取值范围:-500~500,默认值:0。'."\n"
.'- **pitchRate**:语调,取值范围:-500~500,默认值:0。'."\n"
."\n"
.'- **globalInterruptible**:语音打断配置。'."\n"
.'-**engine**:调用服务;【ali、volc、xunfei】,大模型场景不支持xunfei。'."\n"
.'- **nlsServiceType**:服务类型。【Managed 、Authorized】'."\n"
.'- **engineXunfei**:服务方为xunfei时的配置。'."\n"
.'> 1.当engine选择ali,nlsServiceType为Authorized时,使用的是自定义服务;2.当服务方为ali,当engine为ali,nlsServiceType为Managed时,使用默认服务;3.当engine为xunfei(小模型场景适用),nlsServiceType为Authorized时,使用的服务方为xunfei,需要填入engineXunfei配置{"pitchRate":50,"speechRate":50,"voice":"aisjiuxu","volume":50};4.当engine为vloc,nlsServiceType为Authorized时表示适用的为doubao。',
'type' => 'string',
'required' => false,
'example' => '{'."\n"
.' "appKey": "oQDVNlE6fZ5mg46X",'."\n"
.' "engine": "ali",'."\n"
.' "engineXunfei": "",'."\n"
.' "globalInterruptible": true,'."\n"
.' "nlsServiceType": "Managed",'."\n"
.' "pitchRate": "0",'."\n"
.' "speechRate": "0",'."\n"
.' "voice": "zhiyuan",'."\n"
.' "volume": "50"'."\n"
.'}',
],
],
[
'name' => 'ScriptContent',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '通知类实例,传入话术列表。'."\n"
.'已废弃。',
'type' => 'array',
'items' => [
'description' => '通知类实例,传入话术列表。'."\n"
.'已废弃。',
'type' => 'string',
'required' => false,
'example' => '您好,您昨晚在李佳琦直播间下单的娜薇诗椰子水二代精华2支装还未付款,超时未支付会自动关闭订单,活动错过不再有奥。',
],
'required' => false,
'example' => '[]',
'maxItems' => 100,
],
],
[
'name' => 'ScriptWaveform',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '通知类实例,传入话术声音列表。'."\n"
.'已废弃。',
'type' => 'array',
'items' => [
'description' => '通知类实例,传入话术声音列表。'."\n"
.'已废弃。',
'type' => 'string',
'required' => false,
'example' => '[]',
],
'required' => false,
'example' => '[]',
'maxItems' => 100,
],
],
[
'name' => 'MiniPlaybackEnable',
'in' => 'query',
'schema' => [
'description' => '承接语配置开关(小模型适用)',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'NewBargeInEnable',
'in' => 'query',
'schema' => [
'description' => '优雅打断配置开关(小模型适用)',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'LongWaitEnable',
'in' => 'query',
'schema' => [
'description' => '智能断句配置开关(小模型适用)',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'EmotionEnable',
'in' => 'query',
'schema' => [
'description' => '情绪识别配置开关(小模型适用)',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'AgentKey',
'in' => 'query',
'schema' => [
'description' => '机器人业务空间访问Key',
'type' => 'string',
'required' => false,
'example' => '9137ab9c27044921860030adf8590ec4_p_outbound_public',
],
],
[
'name' => 'AgentLlm',
'in' => 'query',
'schema' => [
'description' => '机器人业务空间是否大模型业务空间',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => [
'description' => '机器人业务空间ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1198938',
],
],
[
'name' => 'NluEngine',
'in' => 'query',
'schema' => [
'description' => 'Nlu引擎(仅大模型场景适用)非大模型场景则为空。'."\n"
."\n"
.'- Prompts-大模型场景, '."\n"
."\n"
.'- SSE_FUNCTION-函数计算模式。'."\n"
.'- BeeBot -工作流模式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'Prompts' => '文本填写模式',
'SSE_FUNCTION' => '函数计算服务模式',
],
'example' => 'Prompts',
],
],
[
'name' => 'NluAccessType',
'in' => 'query',
'schema' => [
'description' => 'Nlu访问方式(仅大模型场景适用)枚举:Managed-使用阿里公共账号访问,非大模型场景则为空。',
'type' => 'string',
'required' => false,
'example' => 'Managed',
],
],
[
'name' => 'ScriptNluProfileJsonString',
'in' => 'query',
'schema' => [
'description' => '> 当nluEngine为SSE_FUNUNCTION时必须需传入对应配置'."\n"
."\n"
.'函数计算服务模式配置'."\n"
."\n"
.'- fcRegion:函数服务地域'."\n"
.'- fcFunction:函数服务名称'."\n"
."\n"
.'- fcHttpTriggerUrl函数服务触发器',
'type' => 'string',
'required' => false,
'example' => '{"fcRegion":"cn-shanghai","fcFunction":"waihu_test","fcHttpTriggerUrl":"https://waihu-test.xxxxxxxxxxx.cn-shanghai-vpc.fcapp.run"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'Script' => [
'description' => '话术信息',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '任务状态。取值范围:'."\n"
."\n"
.'- **DRAFTED**:草稿态。'."\n"
.'- **INITIALIZE_IN_PROGRESS**:正在初始化。'."\n"
.'- **PUBLISHED**:已发布。'."\n"
.'- **PUBLISH_IN_PROGRESS**:正在发布。'."\n"
.'- **ROLLBACK_IN_PROGRESS**:正在回滚。'."\n"
.'- **EXAMINE_IN_PROGRESS**:待审核。'."\n"
.'- **PUBLISHED_AND_EXAMINE_IN_PROGRESS**:已发布待审核状态。'."\n"
.'- **PUBLISH_FAILED**:发布失败。'."\n"
.'- **ROLLBACK_FAILED**:回滚失败。'."\n"
.'- **IMPORT_IN_PROGRESS**:正在导入。'."\n"
.'- **IMPORT_FAILED**:导入失败。',
'type' => 'string',
'example' => 'DRAFTED',
],
'UpdateTime' => [
'description' => '话术更新时间(单位:毫秒)',
'type' => 'integer',
'format' => 'int64',
'example' => '1578474045152',
],
'Industry' => [
'description' => '所属行业',
'type' => 'string',
'example' => '教育',
],
'ScriptDescription' => [
'description' => '话术描述',
'type' => 'string',
'example' => '课程满意度回访',
],
'IsDrafted' => [
'description' => '是否是草稿',
'type' => 'boolean',
'example' => 'true',
],
'DebugStatus' => [
'description' => '话术调试状态',
'type' => 'string',
'example' => 'DRAFTED',
],
'ScriptId' => [
'description' => '话术ID',
'type' => 'string',
'example' => '8c58d3e0-bf27-4685-a5a5-65872ec5abc4',
],
'IsDebugDrafted' => [
'description' => '是否是调试的草稿',
'type' => 'boolean',
'example' => 'true',
],
'ScriptName' => [
'description' => '话术名称',
'type' => 'string',
'example' => '课程满意度回访',
],
'Scene' => [
'description' => '所属场景',
'type' => 'string',
'example' => '回访',
],
'NluEngine' => [
'description' => 'Nlu引擎(仅大模型场景适用)枚举:Prompts-大模型场景, 非大模型场景则为空。',
'type' => 'string',
'example' => 'Prompts',
],
'NluAccessType' => [
'description' => 'Nlu访问方式(仅大模型场景适用)枚举:Managed-使用阿里公共账号访问,非大模型场景则为空。',
'type' => 'string',
'example' => 'Managed',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidScriptName.Duplicated',
'errorMessage' => 'The specified ScriptName already exists.',
'description' => '话术名称已经存在。请您更换一个名字。',
],
],
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Script\\": {\\n \\"Status\\": \\"DRAFTED\\",\\n \\"UpdateTime\\": 1578474045152,\\n \\"Industry\\": \\"教育\\",\\n \\"ScriptDescription\\": \\"课程满意度回访\\",\\n \\"IsDrafted\\": true,\\n \\"DebugStatus\\": \\"DRAFTED\\",\\n \\"ScriptId\\": \\"8c58d3e0-bf27-4685-a5a5-65872ec5abc4\\",\\n \\"IsDebugDrafted\\": true,\\n \\"ScriptName\\": \\"课程满意度回访\\",\\n \\"Scene\\": \\"回访\\",\\n \\"NluEngine\\": \\"Prompts\\",\\n \\"NluAccessType\\": \\"Managed\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n OK\\n Success\\n \\n","errorExample":""}]',
'title' => '创建场景',
'changeSet' => [
[
'createdAt' => '2025-04-25T07:27:13.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2024-08-06T12:39:33.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2024-04-25T12:17:46.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2023-01-09T10:51:59.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2022-08-09T13:08:14.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-06-21T12:54:40.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2021-12-22T12:30:26.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => 'Instance',
'arn' => 'acs:outboundbot:{#regionId}:{#accountId}:instance/{#InstanceId}',
],
],
],
],
],
],
'CreateScriptWaveform' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2bfa5ae4-7185-4227-a3b8-328f26f11be1',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'ScriptContent',
'in' => 'query',
'schema' => [
'description' => '录音播报的话术文本',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '您好,您昨晚在李佳琦直播间下单的娜薇诗椰子水二代精华2支装还未付款,超时未支付会自动关闭订单,活动错过不再有奥。',
],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => [
'description' => '录音文件ID'."\n"
."\n"
.'> 通过GetJobDataUploadParams接口中Folder参数获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '6f91885fa24b4c408d8f4eb392fd8ae6',
],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'description' => '录音文件名',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'faaf8508-9542-4ac4-84a2-0ddcbb5f79a6 (2).json',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '话术信息',
'type' => 'string',
'example' => 'Success',
],
'ScriptWaveformId' => [
'description' => '话术录音id',
'type' => 'string',
'example' => 'df8216aa-d8f6-4501-864f-f8334d946561',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"ScriptWaveformId\\": \\"df8216aa-d8f6-4501-864f-f8334d946561\\"\\n}","type":"json"}]',
'title' => '【废弃】旧画布创建场景声音的录音',
'summary' => '创建播报话术的录音。',
'description' => '****',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateScriptWaveform',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateTag' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0fe7f71c-8771-42ef-9bb1-19aa16ae7120',
],
],
[
'name' => 'TagName',
'in' => 'query',
'schema' => [
'description' => '标签名字',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '研究生',
],
],
[
'name' => 'TagGroup',
'in' => 'query',
'schema' => [
'description' => '标签组信息',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '目标学历',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'Success',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口响应信息',
'type' => 'string',
'example' => 'Success',
],
'TagId' => [
'description' => '标签ID',
'type' => 'string',
'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"TagId\\": \\"390515b5-6115-4ccf-83e2-52d5bfaf2ddf\\"\\n}","type":"json"}]',
'title' => '创建标签-旧画布使用',
'summary' => '创建标签,旧画布中使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateTag',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'CreateTaskExportTask' => [
'summary' => '创建外呼历史导出异步任务。',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '121140',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => '1dcb09c5-d5db-4397-bf65-db854463beea',
],
],
[
'name' => 'TaskCreateTimeGte',
'in' => 'query',
'schema' => [
'description' => '任务创建时间搜索开始时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1646496000000',
],
],
[
'name' => 'TaskCreateTimeLte',
'in' => 'query',
'schema' => [
'description' => '任务创建时间搜索截止时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1646582400000',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID',
'type' => 'string',
'required' => false,
'example' => 'cb731aee-0a5b-4c2b-924c-d9e82eb1d8d7',
],
],
[
'name' => 'HasAnswered',
'in' => 'query',
'schema' => [
'description' => '有无应答',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'HasHangUpByRejection',
'in' => 'query',
'schema' => [
'description' => '是否拒识挂机',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'HasReachedEndOfFlow',
'in' => 'query',
'schema' => [
'description' => '是否对话完结',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'JobGroupNameQuery',
'in' => 'query',
'schema' => [
'description' => '任务名称',
'type' => 'string',
'required' => false,
'example' => '测试_20220217_160147',
],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '作业ID',
'type' => 'string',
'required' => false,
'example' => '82097dd5-54df-475f-beba-eec8f4b7a3e1',
],
],
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => [
'description' => '被叫号码',
'type' => 'string',
'required' => false,
'example' => '11111111111',
],
],
[
'name' => 'UserIdMatch',
'in' => 'query',
'schema' => [
'description' => '用户ID',
'type' => 'string',
'required' => false,
'example' => '82097dd5-54df-475f-beba-eec8f4b7a3e1',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID',
'type' => 'string',
'required' => false,
'example' => '64ebe700-91b4-49cb-b457-0b7c0b598a86',
],
],
[
'name' => 'ActualTimeGte',
'in' => 'query',
'schema' => [
'description' => '拨打时间搜索开始时间(包含)',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1646496000000',
],
],
[
'name' => 'ActualTimeLte',
'in' => 'query',
'schema' => [
'description' => '拨打时间搜索截止时间(包含)',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1646582400000',
],
],
[
'name' => 'RecordingDurationGte',
'in' => 'query',
'schema' => [
'description' => '振铃时长搜索开始时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
[
'name' => 'RecordingDurationLte',
'in' => 'query',
'schema' => [
'description' => '振铃时长搜索截止时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '20',
],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => [
'description' => '页码(从0开始)',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'name' => 'OtherId',
'in' => 'query',
'schema' => [
'description' => '其他ID',
'type' => 'string',
'required' => false,
'example' => '64ebe700-91b4-49cb-b457-0b7c0b598a86',
],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'description' => '排序字段',
'type' => 'string',
'required' => false,
'example' => 'actualTime',
],
],
[
'name' => 'SortOrder',
'in' => 'query',
'schema' => [
'description' => '排序类型 asr:升序,desc:降序',
'type' => 'string',
'required' => false,
'example' => 'desc',
],
],
[
'name' => 'CallDurationGte',
'in' => 'query',
'schema' => [
'description' => '通话时长搜索最小时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
[
'name' => 'CallDurationLte',
'in' => 'query',
'schema' => [
'description' => '通话时长搜索最大时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '20',
],
],
[
'name' => 'JobStatusStringList',
'in' => 'query',
'schema' => [
'description' => '作业状态',
'type' => 'string',
'required' => false,
'example' => 'Succeeded',
],
],
[
'name' => 'TaskStatusStringList',
'in' => 'query',
'schema' => [
'description' => '通话状态',
'type' => 'string',
'required' => false,
'example' => 'Succeeded,Failed',
],
],
[
'name' => 'ScriptNameQuery',
'in' => 'query',
'schema' => [
'description' => '场景名称',
'type' => 'string',
'required' => false,
'example' => '测试',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'description' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'C377C5FF-4F94-1B23-89D0-50C560623EE4',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => '[]',
],
'TaskId' => [
'description' => '导出任务ID',
'type' => 'string',
'example' => 'a7d6dcff1b8b40f4a8b769a9c24e7852',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'TaskExport.ExceedExportMaxLimit',
'errorMessage' => 'exceed export max limit 500000, Please reselect the query conditions.',
'description' => '数量过大,超过500000条,请重新筛选后下载',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"C377C5FF-4F94-1B23-89D0-50C560623EE4\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"[]\\",\\n \\"TaskId\\": \\"a7d6dcff1b8b40f4a8b769a9c24e7852\\"\\n}","type":"json"}]',
'title' => '外呼历史导出',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateTaskExportTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteAgentProfiles' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'AgentProfileIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '智能体配置id集合',
'type' => 'array',
'items' => [
'description' => '智能体配置id',
'type' => 'string',
'required' => false,
'example' => '3d7d253cfb77476da0cf3681bcf7b4e8',
],
'required' => false,
],
],
[
'name' => 'AppIp',
'in' => 'formData',
'schema' => [
'title' => 'app_ip , POP设置',
'description' => 'app_ip (系统字段,可不填)',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'Data' => [
'description' => '返回数据',
'type' => 'string',
'example' => '{}',
],
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExists.InstanceId',
'errorMessage' => 'The specified instance %s does not exist.',
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": \\"{}\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '删除智能体配置(已作废)',
'summary' => '删除大模型机器人。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteAgentProfiles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteAllNumberDistrictInfo' => [
'summary' => '清空归属地号码库,已废弃。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '【已废弃】删除所有号码归属地信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteAllNumberDistrictInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteBeebotIntent' => [
'summary' => '删除小模型场景中的意图。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '224565',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例 ID',
'type' => 'string',
'required' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'IntentId',
'in' => 'query',
'schema' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10717802',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n",
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'BeebotRequestId' => [
'description' => '内部请求ID',
'type' => 'string',
'example' => '497CFAFF-48CC-161A-AD2C-252DED569037',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'IntentId' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'example' => '10717802'."\n",
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\\\n\\",\\n \\"Success\\": true,\\n \\"BeebotRequestId\\": \\"497CFAFF-48CC-161A-AD2C-252DED569037\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"IntentId\\": 10717802\\n}","type":"json"}]',
'title' => '【小模型接口】删除小蜜机器人意图',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteBeebotIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteBeebotIntentLgf' => [
'summary' => '删除小模型场景意图问法模版。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '224616',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'IntentId',
'in' => 'query',
'schema' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10717802',
],
],
[
'name' => 'LgfId',
'in' => 'query',
'schema' => [
'description' => '问法模版ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '5666117',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'LgfId' => [
'description' => '问法模版ID',
'type' => 'integer',
'format' => 'int64',
'example' => '5666117',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'BeebotRequestId' => [
'description' => '内部请求ID',
'type' => 'string',
'example' => '0B219FCB-EC71-1F08-BB1B-0E87C20158C8',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"LgfId\\": 5666117,\\n \\"Success\\": true,\\n \\"BeebotRequestId\\": \\"0B219FCB-EC71-1F08-BB1B-0E87C20158C8\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '【小模型接口】删除小蜜机器人意图问法模版',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteBeebotIntentLgf',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteBeebotIntentUserSay' => [
'summary' => '删除小模型场景意图用户问法。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '224606',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'IntentId',
'in' => 'query',
'schema' => [
'description' => '意图ID',
'type' => 'string',
'required' => true,
'example' => '10717802',
],
],
[
'name' => 'UserSayId',
'in' => 'query',
'schema' => [
'description' => '用户问法ID',
'type' => 'string',
'required' => true,
'example' => '17448458',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n",
],
'UserSayId' => [
'description' => '用户问法ID',
'type' => 'integer',
'format' => 'int64',
'example' => '17448458',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'BeebotRequestId' => [
'description' => '内部请求ID',
'type' => 'string',
'example' => '0B219FCB-EC71-1F08-BB1B-0E87C20158C8',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\\\n\\",\\n \\"UserSayId\\": 17448458,\\n \\"Success\\": true,\\n \\"BeebotRequestId\\": \\"0B219FCB-EC71-1F08-BB1B-0E87C20158C8\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '【小模型接口】删除小蜜意图用户问法',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteBeebotIntentUserSay',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteContactBlockList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94048',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'ContactBlockListId',
'in' => 'query',
'schema' => [
'description' => '联系人列表ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c6320d3c-fa45-4011-b3b1-acdfabe3a8c6',
],
],
[
'name' => 'Operator',
'in' => 'query',
'schema' => [
'description' => '操作人信息',
'type' => 'string',
'required' => false,
'example' => '160131',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c6320d3c-fa45-4011-b3b1-acdfabe3a8c6',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'AffectedRows' => [
'description' => '影响行数【已废弃】',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"AffectedRows\\": 1,\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '删除禁止外呼名单',
'summary' => '删除禁呼名单。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteContactBlockList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteContactWhiteList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94049',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'ContactWhiteListId',
'in' => 'query',
'schema' => [
'description' => '联系人白名单ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '08c32b67-43cd-4d6a-b7ea-d057xxxxxxxx',
],
],
[
'name' => 'Operator',
'in' => 'query',
'schema' => [
'description' => '操作人信息',
'type' => 'string',
'required' => false,
'example' => '测试人',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'AffectedRows' => [
'description' => '影响行数【已废弃】',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"AffectedRows\\": 1,\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '删除外呼白名单',
'summary' => '删除全局外呼策略白名单。',
'changeSet' => [
[
'createdAt' => '2025-02-12T12:45:01.000Z',
'description' => '错误码发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteContactWhiteList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteDialogueFlow' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd7c28efb-47f7-4a85-a522-5038e30a0b98',
],
],
[
'name' => 'DialogueFlowId',
'in' => 'query',
'schema' => [
'description' => '对话流ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'caab25d1-1f30-4996-8135-0036f5661b43',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。'."\n",
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除对话流程-旧画布接口',
'summary' => '删除对话流程,旧画布接口。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteDialogueFlow',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteGlobalQuestion' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0fe7f71c-8771-42ef-9bb1-19aa16ae7120',
],
],
[
'name' => 'GlobalQuestionId',
'in' => 'query',
'schema' => [
'description' => '全局问题ID'."\n"
."\n"
.'> 通过ListGlobalQuestions接口获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '35f1361e-4377-494c-9f10-4274bda0317f',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '【旧画布接口】删除全局问题',
'summary' => '旧画布场景中删除全局问题。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteGlobalQuestion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '被删除的实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http 状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\nSuccess\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '删除业务实例',
'summary' => '删除一个智能外呼业务实例。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteIntent' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '意图所在的话术ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17'."\n",
],
],
[
'name' => 'IntentId',
'in' => 'query',
'schema' => [
'description' => '被删除的意图ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c21fb0ec-fb5e-476f-a6bf-81a892739c8d'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Succes',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n",
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Succes\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除意图-旧画布接口',
'summary' => '删除意图,旧画布接口。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteJobGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'fc1fb484-4fe8-4031-b662-5b87ea88590b',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除一个任务',
'summary' => '删除一个任务。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteJobGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteOutboundCallNumber' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '94055',
'abilityTreeNodes' => [
'FEATUREoutboundbot85J9KC',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '33014787-cc13-49d3-ab2f-a98aa8f15fbb',
],
],
[
'name' => 'OutboundCallNumberId',
'in' => 'query',
'schema' => [
'description' => '号码ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ffa367e0-58f3-43b6-9615-c63db99c5add',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '查询是否成功:'."\n"
."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除外呼号码-已废弃',
'summary' => '删除外呼号码,已废弃。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteCabOutboundCallNumber',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteScript' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b3d5ac22-9643-49c6-aa84-777f6656f9f5',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '被删除的话术id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '5c589560-6b9d-4415-a3e0-049c4ff05f56',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否调用成功。true:调用成功。 false:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除一个话术',
'summary' => '删除一个话术。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteScriptRecording' => [
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '161701',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '录音所属实例ID',
'type' => 'string',
'required' => true,
'example' => '1eefcb81-cd58-4143-8180-6a962d79d708',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '录音所属场景ID',
'type' => 'string',
'required' => true,
'example' => 'dcc42f0d-cfd8-4866-9bbf-002042503745',
],
],
[
'name' => 'UuidsJson',
'in' => 'query',
'schema' => [
'description' => '录音ID列表。为空时,默认全选'."\n"
."\n"
.'> 录音ID在ListScriptRecording接口中获取',
'type' => 'string',
'required' => false,
'example' => '["d17d5bfa-4972-4389-9718-f9602edabe48"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP 状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '56666881-887A-530A-B679-C3B6B6B142C0',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"56666881-887A-530A-B679-C3B6B6B142C0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '【小模型接口】删除小模型场景中的录音',
'summary' => '删除小模型场景中已上传的录音。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteScriptRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DeleteScriptWaveform' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b9ff4e88-65f9-4eb3-987c-11ba51f3f24d',
],
],
[
'name' => 'ScriptWaveformId',
'in' => 'query',
'schema' => [
'description' => '被删除的录音ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'df8216aa-d8f6-4501-864f-f8334d946561',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '0FD69531-F82C-542D-A5E7-CB54544041C5',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"0FD69531-F82C-542D-A5E7-CB54544041C5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '【已废弃】删除话术录音',
'summary' => '删除话术录音。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteScriptWaveform',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeBeebotIntent' => [
'summary' => '获取小模型场景中的意图。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '224569',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'IntentId',
'in' => 'query',
'schema' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10717802',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'BeebotRequestId' => [
'description' => '内部请求ID',
'type' => 'string',
'example' => '0B219FCB-EC71-1F08-BB1B-0E87C20158C8',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息。',
'type' => 'string',
'example' => 'Success',
],
'IntentId' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'example' => '10717802'."\n",
],
'Intent' => [
'description' => '意图信息',
'type' => 'object',
'properties' => [
'IntentId' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'example' => '10717802',
],
'IntentName' => [
'description' => '意图名称',
'type' => 'string',
'example' => '知道了',
],
'AliasName' => [
'description' => '意图别名',
'type' => 'string',
'example' => '嗯明白了',
],
'CreateUserName' => [
'description' => '创建人账号名称',
'type' => 'string',
'example' => 'xxx@voice-navigator-testonaliyun.com',
],
'CreateUserId' => [
'description' => '创建用户iD',
'type' => 'string',
'example' => '1252504',
],
'ModifyUserId' => [
'description' => '修改用户iD',
'type' => 'string',
'example' => '1252504',
],
'ModifyUserName' => [
'description' => '修改人账号名称',
'type' => 'string',
'example' => 'xxx@voice-navigator-testonaliyun.com'."\n",
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'string',
'example' => '2025-04-21 10:29:59.+0800',
],
'ModifyTime' => [
'description' => '修改时间',
'type' => 'string',
'example' => '2025-04-21 15:52:57.+0800',
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"BeebotRequestId\\": \\"0B219FCB-EC71-1F08-BB1B-0E87C20158C8\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"IntentId\\": 10717802,\\n \\"Intent\\": {\\n \\"IntentId\\": 10717802,\\n \\"IntentName\\": \\"知道了\\",\\n \\"AliasName\\": \\"嗯明白了\\",\\n \\"CreateUserName\\": \\"xxx@voice-navigator-testonaliyun.com\\",\\n \\"CreateUserId\\": \\"1252504\\",\\n \\"ModifyUserId\\": \\"1252504\\",\\n \\"ModifyUserName\\": \\"xxx@voice-navigator-testonaliyun.com\\\\n\\",\\n \\"CreateTime\\": \\"2025-04-21 10:29:59.+0800\\",\\n \\"ModifyTime\\": \\"2025-04-21 15:52:57.+0800\\"\\n }\\n}","type":"json"}]',
'title' => '【获取小模型接口】获取小蜜机器人意图',
'description' => '****',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeBeebotIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeDialogueNodeStatistics' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'aeff669b-388f-4619-82af-81e177df5628',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '作业组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'a3c670d1-01bf-491d-b9aa-759b1a82f47c',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '显示统计数据限制',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '999',
'minimum' => '0',
'example' => '30',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'GroupId' => [
'description' => '任务组ID',
'type' => 'string',
'example' => 'f06f7c9f-2895-4b30-a8c2-6ecccb9c9f89',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'TotalCompleted' => [
'description' => '任务组中任务完成的个数',
'type' => 'integer',
'format' => 'int32',
'example' => '13',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79',
],
'NoAnswerDialogueNodes' => [
'description' => '无应答节点',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NoAnswerNum' => [
'description' => '无应答数量',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'GroupId' => [
'description' => '任务组ID',
'type' => 'string',
'example' => 'f06f7c9f-2895-4b30-a8c2-6ecccb9c9f89',
],
'NodeName' => [
'description' => '节点名称',
'type' => 'string',
'example' => 'xxx',
],
'HangUpNum' => [
'description' => '挂机数量',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79',
],
'HitNum' => [
'description' => '命中数量',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
'Id' => [
'description' => 'ID,唯一标识符',
'type' => 'string',
'example' => '123',
],
'NodeId' => [
'description' => '节点ID',
'type' => 'string',
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79',
],
],
'description' => '',
],
'example' => '[]',
],
'HangUpDialogueNodes' => [
'description' => '挂机节点',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'HangUpNum' => [
'description' => '挂机数量',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'NodeId' => [
'description' => '节点ID',
'type' => 'string',
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79',
],
'NodeName' => [
'description' => '节点名称',
'type' => 'string',
'example' => 'xxx',
],
'RateDisplay' => [
'description' => '数量占比',
'type' => 'string',
'example' => '100%',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"GroupId\\": \\"f06f7c9f-2895-4b30-a8c2-6ecccb9c9f89\\",\\n \\"Success\\": true,\\n \\"TotalCompleted\\": 13,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"InstanceId\\": \\"e5035654-1745-484a-8c5b-165f7c7bcd79\\",\\n \\"NoAnswerDialogueNodes\\": [\\n {\\n \\"NoAnswerNum\\": 2,\\n \\"GroupId\\": \\"f06f7c9f-2895-4b30-a8c2-6ecccb9c9f89\\",\\n \\"NodeName\\": \\"xxx\\",\\n \\"HangUpNum\\": 2,\\n \\"InstanceId\\": \\"e5035654-1745-484a-8c5b-165f7c7bcd79\\",\\n \\"HitNum\\": 12,\\n \\"Id\\": \\"123\\",\\n \\"NodeId\\": \\"e5035654-1745-484a-8c5b-165f7c7bcd79\\"\\n }\\n ],\\n \\"HangUpDialogueNodes\\": [\\n {\\n \\"HangUpNum\\": 2,\\n \\"NodeId\\": \\"e5035654-1745-484a-8c5b-165f7c7bcd79\\",\\n \\"NodeName\\": \\"xxx\\",\\n \\"RateDisplay\\": \\"100%\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n f06f7c9f-2895-4b30-a8c2-6ecccb9c9f89\\n true\\n 13\\n OK\\n Success\\n e5035654-1745-484a-8c5b-165f7c7bcd79\\n \\n 2\\n f06f7c9f-2895-4b30-a8c2-6ecccb9c9f89\\n xxx\\n 2\\n e5035654-1745-484a-8c5b-165f7c7bcd79\\n 12\\n 123\\n e5035654-1745-484a-8c5b-165f7c7bcd79\\n \\n \\n 2\\n e5035654-1745-484a-8c5b-165f7c7bcd79\\n xxx\\n 100%\\n \\n","errorExample":""}]',
'title' => '查询对话节点数据统计',
'summary' => '返回任务标签的统计信息。',
'changeSet' => [
[
'createdAt' => '2024-07-22T12:24:23.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2023-03-07T14:46:39.000Z',
'description' => '响应参数发生变更、响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeDialogueNodeStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeDsReports' => [
'summary' => 'DescribeDsReports',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94063',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9eb8fe4f-b286-4834-9688-2c9b171e223e',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '1364f208-982d-4d0c-89aa-d56e22b47589',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'DsReports' => [
'description' => '对话流信息,格式为:key:{value:次数}}',
'type' => 'string',
'example' => '"{\\"标签1\\":{\\"标签值1\\":2},\\"标签2\\":{\\"标签值1\\":2},\\"标签3\\":{\\"标签值1\\":1,\\"标签值2\\":1}}"',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1364f208-982d-4d0c-89aa-d56e22b47589\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"DsReports\\": \\"\\\\\\"{\\\\\\\\\\\\\\"标签1\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"标签值1\\\\\\\\\\\\\\":2},\\\\\\\\\\\\\\"标签2\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"标签值1\\\\\\\\\\\\\\":2},\\\\\\\\\\\\\\"标签3\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"标签值1\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"标签值2\\\\\\\\\\\\\\":1}}\\\\\\"\\"\\n}","type":"json"}]',
'title' => '获取作业组命中标签统计',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeGroupDsReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeGlobalQuestion' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '7cefbff0-8d50-4d6f-b93c-73cee23c1555',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b7ee988b-2837-4bc1-9d56-f76e7c831f60',
],
],
[
'name' => 'GlobalQuestionId',
'in' => 'query',
'schema' => [
'description' => '全局问题ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'e851e242-ad67-4507-96a2-d4114564dcec',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'GlobalQuestion' => [
'description' => '全局问题信息',
'type' => 'object',
'properties' => [
'GlobalQuestionId' => [
'description' => '全局话术ID',
'type' => 'string',
'example' => 'f160ec2e-94f2-4c03-87be-ece5b52d5dd9',
],
'Answers' => [
'description' => '答案回复',
'type' => 'string',
'example' => '["你好,我是你的专属客服顾问."]',
],
'GlobalQuestionType' => [
'description' => '全局话术类型',
'type' => 'string',
'example' => 'COMMON',
],
'GlobalQuestionName' => [
'description' => '全局问题名称',
'type' => 'string',
'example' => '你是谁-全局问题',
],
'Questions' => [
'description' => '全局问题',
'type' => 'string',
'example' => ' ["你是谁","你叫什么"]',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => '290e06a5-6de2-4cc8-8a9c-72b7c152256c',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"GlobalQuestion\\": {\\n \\"GlobalQuestionId\\": \\"f160ec2e-94f2-4c03-87be-ece5b52d5dd9\\",\\n \\"Answers\\": \\"[\\\\\\"你好,我是你的专属客服顾问.\\\\\\"]\\",\\n \\"GlobalQuestionType\\": \\"COMMON\\",\\n \\"GlobalQuestionName\\": \\"你是谁-全局问题\\",\\n \\"Questions\\": \\" [\\\\\\"你是谁\\\\\\",\\\\\\"你叫什么\\\\\\"]\\",\\n \\"ScriptId\\": \\"290e06a5-6de2-4cc8-8a9c-72b7c152256c\\"\\n }\\n}","type":"json"}]',
'title' => '【旧画布接口】返回一个全局问题的数据',
'summary' => '旧画布场景中返回一个全局问题的数据。',
'description' => '****',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeGlobalQuestion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeGroupExecutingInfo' => [
'summary' => '返回任务组内任务执行的情况。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94065',
'abilityTreeNodes' => [
'FEATUREoutboundbotVYZEH6',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '3640dda7-e5b1-4b3e-9ccf-da4fc5402e11',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'GroupId' => [
'description' => '任务组ID',
'type' => 'string',
'example' => 'b24d321a-2a74-4dd1-a0ba-4ab09cef6652',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4',
],
'ExecutingInfo' => [
'description' => '执行信息',
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '结束时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1640087774563',
],
'StartTime' => [
'description' => '开始时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1640087774563',
],
'HangUpByClientNum' => [
'description' => '客户主动挂断次数',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'CreatorName' => [
'description' => '已废弃',
'type' => 'string',
'example' => 'xxx',
],
'TransferByNoAnswer' => [
'description' => '无应答',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'FinishedNum' => [
'description' => '已执行完成的个数',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'TransferByIntentNum' => [
'description' => '意图识别',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'CallNum' => [
'description' => '外呼量',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'CallFailedNum' => [
'description' => '呼叫失败次数',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'NoInteractionNum' => [
'description' => '无交互次数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'JobsProgress' => [
'description' => '执行进度',
'type' => 'object',
'properties' => [
'SchedulingNum' => [
'description' => '调度中的任务数',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'TotalCompletedNum' => [
'description' => '总计完成的数量',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'FailedNum' => [
'description' => '失败个数',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'PausedNum' => [
'description' => '暂停的次数',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'CancelledNum' => [
'description' => '取消的个数',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'TotalJobs' => [
'description' => '总计作业数量',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'TotalNotAnsweredNum' => [
'description' => '无应答的数量',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'ExecutingNum' => [
'description' => '执行中的作业数量',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
],
'example' => '{}',
],
'TalkTurnsDistribution' => [
'description' => '对话轮次分布'."\n"
."\n"
.'- total:全部涉及到的对话轮次'."\n"
.'- 数字:对应轮次'."\n"
."\n"
.'> - 例如:{"total":"5","5":"1"},涉及到的对话轮次是5,用户轮次为5的占1个。',
'type' => 'string',
'example' => '{"total":"5","5":"4"}'."\n",
],
'DurationDistribution' => [
'description' => '通话时长分布',
'type' => 'string',
'example' => '{"max":"40","1":"1","total":"40","min":"40"}',
],
'AvgTalkTime' => [
'description' => '平均通话时长',
'type' => 'integer',
'format' => 'int32',
'example' => '258',
],
],
'example' => '{}',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"GroupId\\": \\"b24d321a-2a74-4dd1-a0ba-4ab09cef6652\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"InstanceId\\": \\"c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4\\",\\n \\"ExecutingInfo\\": {\\n \\"EndTime\\": 1640087774563,\\n \\"StartTime\\": 1640087774563,\\n \\"HangUpByClientNum\\": 5,\\n \\"CreatorName\\": \\"xxx\\",\\n \\"TransferByNoAnswer\\": 5,\\n \\"FinishedNum\\": 5,\\n \\"TransferByIntentNum\\": 5,\\n \\"CallNum\\": 5,\\n \\"CallFailedNum\\": 5,\\n \\"NoInteractionNum\\": 1,\\n \\"JobsProgress\\": {\\n \\"SchedulingNum\\": 5,\\n \\"TotalCompletedNum\\": 5,\\n \\"FailedNum\\": 5,\\n \\"PausedNum\\": 5,\\n \\"CancelledNum\\": 5,\\n \\"TotalJobs\\": 5,\\n \\"TotalNotAnsweredNum\\": 5,\\n \\"ExecutingNum\\": 5\\n },\\n \\"TalkTurnsDistribution\\": \\"{\\\\\\"total\\\\\\":\\\\\\"5\\\\\\",\\\\\\"5\\\\\\":\\\\\\"4\\\\\\"}\\\\n\\",\\n \\"DurationDistribution\\": \\"{\\\\\\"max\\\\\\":\\\\\\"40\\\\\\",\\\\\\"1\\\\\\":\\\\\\"1\\\\\\",\\\\\\"total\\\\\\":\\\\\\"40\\\\\\",\\\\\\"min\\\\\\":\\\\\\"40\\\\\\"}\\",\\n \\"AvgTalkTime\\": 258\\n }\\n}","type":"json"}]',
'title' => '返回任务执行情况',
'changeSet' => [
[
'createdAt' => '2024-11-28T14:29:58.000Z',
'description' => '响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeGroupExecutingInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeInstance' => [
'summary' => '查询智能外呼业务实例信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94066',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息。',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Instance' => [
'description' => '业务实例信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1578469042851',
],
'InstanceId' => [
'description' => '业务实例ID。',
'type' => 'string',
'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
'CreatorId' => [
'description' => '创建者ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '435986',
],
'OwnerName' => [
'description' => '业务实例拥有者名字。',
'type' => 'string',
'example' => 'xxxx',
],
'InstanceDescription' => [
'description' => '业务实例描述。',
'type' => 'string',
'example' => '这个是第一个实例',
],
'InstanceName' => [
'description' => '业务实例名字。',
'type' => 'string',
'example' => '第一个实例',
],
'CreatorName' => [
'description' => '创建者名字。',
'type' => 'string',
'example' => 'xxx',
],
'ResourceGroupId' => [
'description' => '资源组ID。',
'type' => 'string',
'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
'MaxConcurrentConversation' => [
'description' => '实例最大并发。',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Instance\\": {\\n \\"CreationTime\\": 1578469042851,\\n \\"InstanceId\\": \\"90515b5-6115-4ccf-83e2-52d5bfaf2ddf\\",\\n \\"CreatorId\\": 435986,\\n \\"OwnerName\\": \\"xxxx\\",\\n \\"InstanceDescription\\": \\"这个是第一个实例\\",\\n \\"InstanceName\\": \\"第一个实例\\",\\n \\"CreatorName\\": \\"xxx\\",\\n \\"ResourceGroupId\\": \\"90515b5-6115-4ccf-83e2-52d5bfaf2ddf\\",\\n \\"MaxConcurrentConversation\\": 4\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n \\n 1578469042851\\n 90515b5-6115-4ccf-83e2-52d5bfaf2ddf\\n 435986\\n xxxx\\n 这个是第一个实例\\n 第一个实例\\n xxx\\n 90515b5-6115-4ccf-83e2-52d5bfaf2ddf\\n 4\\n \\n","errorExample":""}]',
'title' => '查询业务实例信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeIntent' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'da37319b-6c83-4268-9f19-814aed62e401',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17'."\n",
],
],
[
'name' => 'IntentId',
'in' => 'query',
'schema' => [
'description' => '意图ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '10717802',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '327FEE69-F173-5B2F-9F3B-DCC6182D7BA0',
],
'Success' => [
'description' => '请求成功与否标识。',
'type' => 'boolean',
'example' => 'true',
],
'Intent' => [
'description' => '意图信息',
'type' => 'object',
'properties' => [
'Utterances' => [
'description' => '触发意图的用户表述列表',
'type' => 'string',
'example' => '["ok","好的","好吧","好嘞","可以","行啊","行吧","那行","知道了","我看一下","能的","等会吧","等一下","马上还","等一会","过两天","我会想办法处理"]',
],
'IntentDescription' => [
'description' => '实例描述',
'type' => 'string',
'example' => '同意还款意图',
],
'UpdateTime' => [
'description' => '更新时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1578469042851',
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1578469042851',
],
'Keywords' => [
'description' => '意图的关键字,在List接口可用于过滤查找的意图',
'type' => 'string',
'example' => '["还款"]',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => '6ef95fd5-558f-4ee8-af34-b2ede087a87c',
],
'IntentId' => [
'description' => '意图ID',
'type' => 'string',
'example' => '10722701',
],
'IntentName' => [
'description' => '意图名称',
'type' => 'string',
'example' => '统一还款',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"327FEE69-F173-5B2F-9F3B-DCC6182D7BA0\\",\\n \\"Success\\": true,\\n \\"Intent\\": {\\n \\"Utterances\\": \\"[\\\\\\"ok\\\\\\",\\\\\\"好的\\\\\\",\\\\\\"好吧\\\\\\",\\\\\\"好嘞\\\\\\",\\\\\\"可以\\\\\\",\\\\\\"行啊\\\\\\",\\\\\\"行吧\\\\\\",\\\\\\"那行\\\\\\",\\\\\\"知道了\\\\\\",\\\\\\"我看一下\\\\\\",\\\\\\"能的\\\\\\",\\\\\\"等会吧\\\\\\",\\\\\\"等一下\\\\\\",\\\\\\"马上还\\\\\\",\\\\\\"等一会\\\\\\",\\\\\\"过两天\\\\\\",\\\\\\"我会想办法处理\\\\\\"]\\",\\n \\"IntentDescription\\": \\"同意还款意图\\",\\n \\"UpdateTime\\": 1578469042851,\\n \\"CreateTime\\": 1578469042851,\\n \\"Keywords\\": \\"[\\\\\\"还款\\\\\\"]\\",\\n \\"ScriptId\\": \\"6ef95fd5-558f-4ee8-af34-b2ede087a87c\\",\\n \\"IntentId\\": \\"10722701\\",\\n \\"IntentName\\": \\"统一还款\\"\\n }\\n}","type":"json"}]',
'title' => '获取一个意图-旧画布接口',
'summary' => '获取一个意图,旧画布接口。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeIntentStatistics' => [
'summary' => '查询任务组下的意图统计信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94068',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c3c92de8-e4bd-4db4-a962-50f8acce40bc',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '作业组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '040355a9-e80c-4308-b85c-aa5b9fd25246',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '展示统计的个数(必填)',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'example' => '5',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'GroupId' => [
'description' => '实例所属分组ID。',
'type' => 'string',
'example' => '0c3f352f-d045-491d-9ce7-11f2d2b7775d',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'ProcessIntentNum' => [
'description' => '流程意图总计数',
'type' => 'integer',
'format' => 'int32',
'example' => '123',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e',
],
'GlobalIntentNum' => [
'description' => '全局意图总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'ProcessIntents' => [
'description' => '意图信息列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '类型'."\n"
."\n"
.'- GlobalIntent(0):全局意图'."\n"
."\n"
.'- ProcessIntent(1):流程意图',
'type' => 'string',
'example' => 'ProcessIntent',
],
'GroupId' => [
'description' => '任务组ID',
'type' => 'string',
'example' => '0c3f352f-d045-491d-9ce7-11f2d2b7775d',
],
'HitAfterNoAnswer' => [
'description' => '命中后无应答',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e',
],
'HitNum' => [
'description' => '命中数量',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'IntentId' => [
'description' => '意图ID',
'type' => 'string',
'example' => '12343',
],
'IntentName' => [
'description' => '意图名称',
'type' => 'string',
'example' => '请假意图',
],
'RateDisplay' => [
'description' => '数量占比',
'type' => 'string',
'example' => '33.33%',
],
],
'description' => '',
],
'example' => '[]',
],
'GlobalIntents' => [
'description' => '全局事件数组',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '类型'."\n"
."\n"
.'GlobalIntent(0):全局意图'."\n"
."\n"
.'ProcessIntent(1):流程意图',
'type' => 'string',
'example' => 'GlobalIntent',
],
'GroupId' => [
'description' => '任务组ID',
'type' => 'string',
'example' => '0c3f352f-d045-491d-9ce7-11f2d2b7775d',
],
'HitAfterNoAnswer' => [
'description' => '命中后无应答',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e',
],
'HitNum' => [
'description' => '命中数量',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'IntentId' => [
'description' => '意图ID',
'type' => 'string',
'example' => '21343425',
],
'IntentName' => [
'description' => '意图名称',
'type' => 'string',
'example' => '请假意图',
],
],
'description' => '',
],
'example' => '[]',
],
'IntentsAfterNoAnswer' => [
'description' => '拒识意图信息列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e',
],
'GroupId' => [
'description' => '任务组ID',
'type' => 'string',
'example' => 'b24d321a-2a74-4dd1-a0ba-4ab09cef6652',
],
'HitAfterNoAnswer' => [
'description' => '命中后无应答',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'IntentId' => [
'description' => '意图ID',
'type' => 'string',
'example' => '10398032',
],
'IntentName' => [
'description' => '意图名称',
'type' => 'string',
'example' => '请假意图',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"GroupId\\": \\"0c3f352f-d045-491d-9ce7-11f2d2b7775d\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"ProcessIntentNum\\": 123,\\n \\"InstanceId\\": \\"a4274627-265f-4e14-b2d6-4ee7d4f8593e\\",\\n \\"GlobalIntentNum\\": 100,\\n \\"ProcessIntents\\": [\\n {\\n \\"Type\\": \\"ProcessIntent\\",\\n \\"GroupId\\": \\"0c3f352f-d045-491d-9ce7-11f2d2b7775d\\",\\n \\"HitAfterNoAnswer\\": 1,\\n \\"InstanceId\\": \\"a4274627-265f-4e14-b2d6-4ee7d4f8593e\\",\\n \\"HitNum\\": 10,\\n \\"IntentId\\": \\"12343\\",\\n \\"IntentName\\": \\"请假意图\\",\\n \\"RateDisplay\\": \\"33.33%\\"\\n }\\n ],\\n \\"GlobalIntents\\": [\\n {\\n \\"Type\\": \\"GlobalIntent\\",\\n \\"GroupId\\": \\"0c3f352f-d045-491d-9ce7-11f2d2b7775d\\",\\n \\"HitAfterNoAnswer\\": 1,\\n \\"InstanceId\\": \\"a4274627-265f-4e14-b2d6-4ee7d4f8593e\\",\\n \\"HitNum\\": 11,\\n \\"IntentId\\": \\"21343425\\",\\n \\"IntentName\\": \\"请假意图\\"\\n }\\n ],\\n \\"IntentsAfterNoAnswer\\": [\\n {\\n \\"InstanceId\\": \\"a4274627-265f-4e14-b2d6-4ee7d4f8593e\\",\\n \\"GroupId\\": \\"b24d321a-2a74-4dd1-a0ba-4ab09cef6652\\",\\n \\"HitAfterNoAnswer\\": 1,\\n \\"IntentId\\": \\"10398032\\",\\n \\"IntentName\\": \\"请假意图\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询意图统计信息',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2024-07-22T12:24:23.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2023-03-07T14:46:39.000Z',
'description' => '响应参数发生变更、响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeIntentStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeJob' => [
'summary' => '返回一个作业的对话数据。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94069',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '作业ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c8a2b7f2-ad1a-4865-b872-d0080d9802d9',
],
],
[
'name' => 'WithScript',
'in' => 'query',
'schema' => [
'description' => '是否返回任务场景信息。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息。',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Job' => [
'description' => '作业信息。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '作业状态。'."\n"
.'- Scheduling(调度中),'."\n"
.'- Executing(执行中),'."\n"
.'- Succeeded(成功),'."\n"
.'- Paused(暂停),'."\n"
.'- Failed(失败),'."\n"
.'- Cancelled(已取消),'."\n"
.'- Drafted(草稿态,文件导入时的临时状态);',
'type' => 'string',
'example' => 'Succeeded',
],
'ActualTime' => [
'description' => '作业实际执行时间,【已废弃】',
'type' => 'integer',
'format' => 'int64',
'example' => '1640068026385',
],
'Priority' => [
'description' => '作业优先级。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'DsReport' => [
'description' => '任务命中标签情况【已废弃】',
'type' => 'string',
'example' => '-',
],
'NextExecutionTime' => [
'description' => '任务下次执行的时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1640068026385',
],
'FailureReason' => [
'description' => '作业失败原因。',
'type' => 'string',
'example' => 'NoAnswer',
],
'SystemPriority' => [
'description' => '作业系统优先级。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'InstanceId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28',
],
'CalledNumber' => [
'description' => '被叫号码。',
'type' => 'string',
'example' => '137****7777',
],
'ReferenceId' => [
'description' => '作业的业务ID,有业务方自定义。'."\n"
."\n"
.'> 为上传的ContactId ID值',
'type' => 'string',
'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28',
],
'JobGroupId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8',
],
'ScenarioId' => [
'description' => '场景ID。',
'type' => 'string',
'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150',
],
'StrategyId' => [
'description' => '策略ID。',
'type' => 'string',
'example' => 'c8a2b7f2-ad1a-4865-b872-d0080d9802d9',
],
'EndReason' => [
'description' => '通话完结原因,取值范围'."\n"
."\n"
.'- **1**:FINISHED(正常完结)。'."\n"
.'- **2**:CHATBOT_HANGUP_AFTER_NOANSWER(拒识后机器人挂机)。'."\n"
.'- **3**:CHATBOT_HANGUP_AFTER_SILENCE(静默超时挂机)。'."\n"
.'- **4**:CLIENT_HANGUP_AFTER_NOANSWER(拒识后用户挂机)。'."\n"
.'- **5**:CLIENT_HANGUP(用户无理由挂机)。'."\n"
.'- **6**:TRANSFER_BY_INTENT(命中意图转人工)。'."\n"
.'- **7**:TRANSFER_AFTER_NOANSWER(拒识转人工)。'."\n"
.'- **8**:INO_INTERACTION(用户侧无交互)。'."\n"
.'- **9**:ERROR(系统异常中断)。'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'JobId' => [
'description' => '作业ID。',
'type' => 'string',
'example' => 'b72425bd-7871-4050-838e-033d80d754b7',
],
'Contacts' => [
'description' => '联系人信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PhoneNumber' => [
'description' => '电话号码。',
'type' => 'string',
'example' => '1358****8888',
],
'State' => [
'description' => '联系人状态。【已废弃】',
'type' => 'string',
'example' => 'Available',
],
'ContactId' => [
'description' => '联系人ID。系统生成的',
'type' => 'string',
'example' => 'db3db762-e421-44c9-9a01-cb423470757c',
],
'Honorific' => [
'description' => '联系人尊称。与联系人名字一致',
'type' => 'string',
'example' => '张先生',
],
'JobId' => [
'description' => '作业ID。',
'type' => 'string',
'example' => '72dcd26b-f12d-4c27-b3af-18f6aed5b160',
],
'ContactName' => [
'description' => '联系人名字。',
'type' => 'string',
'example' => '张三',
],
'Role' => [
'description' => '联系人角色。【已废弃】',
'type' => 'string',
'example' => '*',
],
'ReferenceId' => [
'description' => '联系人的业务ID。',
'type' => 'string',
'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34',
],
],
'description' => '',
],
'example' => '[]',
],
'Extras' => [
'description' => '业务参数。'."\n"
."\n"
.'> TenantId、ServiceId为系统生成,其余参数为自定义参考传入的',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '业务参数名字。',
'type' => 'string',
'example' => 'djrq',
],
'Value' => [
'description' => '业务参数值。',
'type' => 'string',
'example' => '2019-08-21 09:49:59.0',
],
],
'description' => '',
],
'example' => '[]',
],
'Summary' => [
'description' => '对话业务标签数据:'."\n"
.'- 大模型场景中:对话完结后的标签命中数据。'."\n"
."\n"
.'- 小模型场景中:对话完结后的变量值数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SummaryName' => [
'description' => '标签名字。',
'type' => 'string',
'example' => 'score',
],
'Category' => [
'description' => '对话摘要类别(历史字段,不再使用)【已废弃】',
'type' => 'string',
'example' => '{}',
],
'Content' => [
'description' => '标签值',
'type' => 'string',
'example' => '5',
],
],
'description' => '',
],
'example' => '[]',
],
'Tasks' => [
'description' => '通话列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '任务状态,取值范围'."\n"
.'(注:**Succeeded**状态已细分原因,不会展示**Succeeded**:1(已接通)状态,之后返回均为具体细分原因类型。)'."\n"
."\n"
.'- **Executing**:0(正在拨打)。'."\n"
.'- **Succeeded**:1(已接通)。'."\n"
.'- **NoAnswer**:2(未接通-无人接听)。'."\n"
.'- **NotExist**:3(未接通-空号)。'."\n"
.'- **Busy**:4(未接通-占线)。'."\n"
.'- **Cancelled**:5(未呼出-任务停止)。'."\n"
.'- **Failed**:6(失败)。'."\n"
.'- **NotConnected**:7(未接通-无法接通)。'."\n"
.'- **PoweredOff**:8(未接通-关机)。'."\n"
.'- **OutOfService**:9(未接通-被叫停机)。'."\n"
.'- **InArrears**:10(未接通-被叫欠费)。'."\n"
.'- **EmptyNumber**:11(未呼出-空号不外呼)。'."\n"
.'- **PerDayCallCountLimit**:12(未呼出-超出每日上限)。'."\n"
.'- **ContactBlockList**:13(未呼出-黑名单)。'."\n"
.'- **CallerNotRegistered**:14(未呼出-主叫号码未注册)。'."\n"
.'- **Terminated**:15(未呼出-被终止)。'."\n"
.'- **VerificationCancelled**:16(未呼出-呼叫前验证不通过取消)。'."\n"
.'- **OutOfServiceNoCall**:17(未呼出-被叫停机不外呼)。'."\n"
.'- **InArrearsNoCall**:18(未呼出-被叫欠费不外呼)。'."\n"
.'- **CallingNumberNotExist**:19(未呼出-主叫号码不存在)。'."\n"
.'- **SucceededFinish**:20(已接通-正常完结)。'."\n"
.'- **SucceededChatbotHangUpAfterNoAnswer**:21(已接通-拒识后机器人挂机)。'."\n"
.'- **SucceededChatbotHangUpAfterSilence**:22(已接通-静默超时挂机)。'."\n"
.'- **SucceededClientHangUpAfterNoAnswer**:23(已接通-拒识后用户挂机)。'."\n"
.'- **SucceededClientHangUp**:24(已接通-用户无理由挂机)。'."\n"
.'- **SucceededTransferByIntent**:25(已接通-命中意图转人工)。'."\n"
.'- **SucceededTransferAfterNoAnswer**:26(已接通-拒识转人工)。'."\n"
.'- **SucceededInoInterAction**:27(已接通-用户侧无交互)。'."\n"
.'- **SucceededError**:28(已接通-系统异常中断)。'."\n"
.'- **SucceededSpecialInterceptVoiceAssistant**:29(已接通-特殊情况拦截-语音助手)。'."\n"
.'- **SucceededSpecialInterceptExtensionNumberTransfer**:30(已接通-特殊情况拦截-分机号转接)。'."\n"
.'- **SucceededSpecialInterceptCustomSpecialIntercept**:31(已接通-特殊情况拦截-自定义拦截)。'."\n"
.'- **HighRiskSipCode**:32(未呼出-高风险不外呼)。',
'type' => 'string',
'example' => 'SucceededTransferByIntent',
],
'PlanedTime' => [
'description' => '计划拨打时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1579068424883',
],
'ChatbotId' => [
'description' => '对话的机器人ID。',
'type' => 'string',
'example' => '1234',
],
'ActualTime' => [
'description' => '实际执行时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1579068424883',
],
'CalledNumber' => [
'description' => '被叫号码。',
'type' => 'string',
'example' => '135****8888',
],
'EndTime' => [
'description' => '实际结束的时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1579068424883',
],
'ScenarioId' => [
'description' => '场景ID。',
'type' => 'string',
'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150',
],
'EndReason' => [
'description' => '完结原因。',
'type' => 'string',
'example' => 'FINISHED',
],
'JobId' => [
'description' => '作业ID。',
'type' => 'string',
'example' => 'b72425bd-7871-4050-838e-033d80d754b7',
],
'CallId' => [
'description' => 'SIP call id。',
'type' => 'string',
'example' => '1528189846043',
],
'CallingNumber' => [
'description' => '主叫号码。',
'type' => 'string',
'example' => '0571****3106',
],
'Brief' => [
'description' => '业务结果(历史字段,不再使用)。',
'type' => 'string',
'example' => '1',
],
'Duration' => [
'description' => '对话持续时间。无该字段返回。'."\n"
."\n"
.'> 该数据在Conversation列表的最后一个字典中ActionParams参数返回',
'type' => 'integer',
'format' => 'int32',
'example' => '120',
],
'TaskId' => [
'description' => '通话ID。',
'type' => 'string',
'example' => 'ff44709e-39a6-43ba-959b-20fcabe3e496',
],
'Conversation' => [
'description' => '任务的对话文本列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ActionParams' => [
'description' => '指令参数。'."\n"
."\n"
.'- 当开启打断能力后,在机器人对话文本中可通过answer该参数值拿到机器人已播报的文本内容如:'."\n"
.' - {"abortDialogueInfo":{"abortDialogueType":"Interrupted","answer":"这是打断文本信息","sequenceId":"xxxxx"},"streamEnd":true}",',
'type' => 'string',
'example' => '{}',
],
'Action' => [
'description' => '指令。',
'type' => 'string',
'example' => 'Broadcast',
],
'Timestamp' => [
'description' => '摘要创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1579068424883',
],
'Speaker' => [
'description' => '对话是谁说的,Robot 机器人 ,Contact 联系人。',
'type' => 'string',
'example' => 'Robot',
],
'Script' => [
'description' => '对话文本。',
'type' => 'string',
'example' => '你好,我是**客服',
],
'Summary' => [
'description' => '对话摘要数据(历史数据,不再使用)。【已废弃】',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SummaryName' => [
'description' => '摘要名字。',
'type' => 'string',
'example' => 'score',
],
'Category' => [
'description' => '对话摘要类别(历史字段,不再使用)。',
'type' => 'string',
'example' => '{}',
],
'Content' => [
'description' => '摘要内容。',
'type' => 'string',
'example' => '5',
],
],
'description' => '',
],
'example' => '[]',
],
'SequenceId' => [
'description' => '会话ID。',
'type' => 'string',
'example' => 'fd279983-93b9-b13b-9a34-64e5df473225',
],
],
'description' => '',
],
'example' => '[]',
],
'Contact' => [
'description' => '联系人信息。',
'type' => 'object',
'properties' => [
'PhoneNumber' => [
'description' => '电话号码。',
'type' => 'string',
'example' => '1351****8888',
],
'State' => [
'description' => '联系人状态。【已废弃】',
'type' => 'string',
'example' => 'Available',
],
'ContactId' => [
'description' => '联系人ID。系统生成的。',
'type' => 'string',
'example' => 'db3db762-e421-44c9-9a01-cb423470757c',
],
'Honorific' => [
'description' => '联系人尊称。与联系人名字保持一致。',
'type' => 'string',
'example' => '张先生',
],
'JobId' => [
'description' => '作业ID【已废弃】',
'type' => 'string',
'example' => 'b72425bd-7871-4050-838e-033d80d754b7',
],
'ContactName' => [
'description' => '联系人名字',
'type' => 'string',
'example' => '张三',
],
'Role' => [
'description' => '联系人角色【已废弃】',
'type' => 'string',
'example' => '*',
],
'ReferenceId' => [
'description' => '联系人业务系统ID。'."\n"
."\n"
.'> 由客户通过ContactId参数自定义上传',
'type' => 'string',
'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34',
],
],
'example' => '{}',
],
'HangUpDirection' => [
'description' => '挂断方。'."\n"
.'- client :客户'."\n"
.'- ivr :机器人',
'type' => 'string',
'example' => 'client',
],
'RingingDuration' => [
'description' => '响铃持续时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '25',
],
'SipCode' => [
'description' => '呼叫任务的SIP状态码。',
'type' => 'string',
'example' => '200',
],
'RealRingingDuration' => [
'description' => '真实振铃持续时长。',
'type' => 'integer',
'format' => 'int64',
'example' => '25',
],
'SipDuration' => [
'description' => 'sip信令时长 。【已废弃】',
'type' => 'integer',
'format' => 'int64',
'example' => '25',
],
],
'description' => '',
],
'example' => '[]',
],
'CallingNumbers' => [
'description' => '主叫号码列表。',
'type' => 'array',
'items' => [
'description' => '主叫号码。',
'type' => 'string',
'example' => '["0571****3106"]',
],
'example' => '["057126883106"]',
],
'Script' => [
'description' => '话术场景。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '状态。',
'type' => 'string',
'enumValueTitles' => [
'IMPORT_FAILED' => '导入失败',
'PUBLISHED' => '已发布',
'EXAMINE_IN_PROGRESS' => '待审核',
'IMPORT_IN_PROGRESS' => '正在导入',
'ROLLBACK_IN_PROGRESS' => '正在回滚',
'PUBLISH_IN_PROGRESS' => '正在发布',
'DRAFTED' => '草稿态',
'INITIALIZE_IN_PROGRESS' => '正在初始化',
'ROLLBACK_FAILED' => '回滚失败',
'PUBLISH_FAILED' => ' 发布失败',
'PUBLISHED_AND_EXAMINE_IN_PROGRESS' => '已发布待审核状态',
],
'example' => 'DRAFTED',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1578881227000',
],
'ChatbotId' => [
'description' => '对话机器人ID。',
'type' => 'string',
'example' => 'chatbot-cn-EJfqqa***',
],
'ScriptId' => [
'description' => '话术ID。',
'type' => 'string',
'example' => '810b5872-57f0-4b27-80ab-7b3f4d8a6374',
],
'IsDebugDrafted' => [
'description' => '调试版本是否为草稿态。',
'type' => 'boolean',
'example' => 'true',
],
'Industry' => [
'description' => '行业。',
'type' => 'string',
'example' => '金融',
],
'ScriptDescription' => [
'description' => '话术描述。',
'type' => 'string',
'example' => '催收话术',
],
'MiniPlaybackConfigEnabled' => [
'description' => '语气承接功能开关。无返回【已废弃】',
'type' => 'boolean',
'example' => 'true',
],
'IsDrafted' => [
'description' => '是否是草稿状态。',
'type' => 'boolean',
'example' => 'true',
],
'TtsConfig' => [
'description' => '话术的TTS配置。【已废弃】',
'type' => 'string',
'example' => '{\\"voice\\":\\"xiaobei\\",\\"volume\\":\\"50\\",\\"speechRate\\":\\"-150\\",\\"pitchRate\\":\\"0\\"}',
],
'DebugStatus' => [
'description' => '调试状态。',
'type' => 'string',
'example' => 'DRAFTED',
],
'AsrConfig' => [
'description' => '话术的ASR配置。【已废弃】',
'type' => 'string',
'example' => '{\\"AppKey\\":\\"3GHttnsvir1FeWWb\\"}',
],
'Scene' => [
'description' => '场景。',
'type' => 'string',
'example' => '催收',
],
'Name' => [
'description' => '话术名字。',
'type' => 'string',
'example' => '催收话术',
],
],
],
],
'example' => '{}',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Job',
'errorMessage' => 'The specified Job does not exist.',
'description' => '指定的任务不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Job\\": {\\n \\"Status\\": \\"Succeeded\\",\\n \\"ActualTime\\": 1640068026385,\\n \\"Priority\\": 5,\\n \\"DsReport\\": \\"-\\",\\n \\"NextExecutionTime\\": 1640068026385,\\n \\"FailureReason\\": \\"NoAnswer\\",\\n \\"SystemPriority\\": 1,\\n \\"InstanceId\\": \\"d5971d98-7312-4f0e-a918-a17d67133e28\\",\\n \\"CalledNumber\\": \\"137****7777\\",\\n \\"ReferenceId\\": \\"d5971d98-7312-4f0e-a918-a17d67133e28\\",\\n \\"JobGroupId\\": \\"fce6c599-8ede-40e3-9f78-0928eda7b4e8\\",\\n \\"ScenarioId\\": \\"ade80092-03d9-4f4d-ad4f-ab8a247d3150\\",\\n \\"StrategyId\\": \\"c8a2b7f2-ad1a-4865-b872-d0080d9802d9\\",\\n \\"EndReason\\": 1,\\n \\"JobId\\": \\"b72425bd-7871-4050-838e-033d80d754b7\\",\\n \\"Contacts\\": [\\n {\\n \\"PhoneNumber\\": \\"1358****8888\\",\\n \\"State\\": \\"Available\\",\\n \\"ContactId\\": \\"db3db762-e421-44c9-9a01-cb423470757c\\",\\n \\"Honorific\\": \\"张先生\\",\\n \\"JobId\\": \\"72dcd26b-f12d-4c27-b3af-18f6aed5b160\\",\\n \\"ContactName\\": \\"张三\\",\\n \\"Role\\": \\"*\\",\\n \\"ReferenceId\\": \\"2fa6bac3-06da-4315-82ab-72d6fd3a6f34\\"\\n }\\n ],\\n \\"Extras\\": [\\n {\\n \\"Key\\": \\"djrq\\",\\n \\"Value\\": \\"2019-08-21 09:49:59.0\\"\\n }\\n ],\\n \\"Summary\\": [\\n {\\n \\"SummaryName\\": \\"score\\",\\n \\"Category\\": \\"{}\\",\\n \\"Content\\": \\"5\\"\\n }\\n ],\\n \\"Tasks\\": [\\n {\\n \\"Status\\": \\"SucceededTransferByIntent\\",\\n \\"PlanedTime\\": 1579068424883,\\n \\"ChatbotId\\": \\"1234\\",\\n \\"ActualTime\\": 1579068424883,\\n \\"CalledNumber\\": \\"135****8888\\",\\n \\"EndTime\\": 1579068424883,\\n \\"ScenarioId\\": \\"ade80092-03d9-4f4d-ad4f-ab8a247d3150\\",\\n \\"EndReason\\": \\"FINISHED\\",\\n \\"JobId\\": \\"b72425bd-7871-4050-838e-033d80d754b7\\",\\n \\"CallId\\": \\"1528189846043\\",\\n \\"CallingNumber\\": \\"0571****3106\\",\\n \\"Brief\\": \\"1\\",\\n \\"Duration\\": 120,\\n \\"TaskId\\": \\"ff44709e-39a6-43ba-959b-20fcabe3e496\\",\\n \\"Conversation\\": [\\n {\\n \\"ActionParams\\": \\"{}\\",\\n \\"Action\\": \\"Broadcast\\",\\n \\"Timestamp\\": 1579068424883,\\n \\"Speaker\\": \\"Robot\\",\\n \\"Script\\": \\"你好,我是**客服\\",\\n \\"Summary\\": [\\n {\\n \\"SummaryName\\": \\"score\\",\\n \\"Category\\": \\"{}\\",\\n \\"Content\\": \\"5\\"\\n }\\n ],\\n \\"SequenceId\\": \\"fd279983-93b9-b13b-9a34-64e5df473225\\"\\n }\\n ],\\n \\"Contact\\": {\\n \\"PhoneNumber\\": \\"1351****8888\\",\\n \\"State\\": \\"Available\\",\\n \\"ContactId\\": \\"db3db762-e421-44c9-9a01-cb423470757c\\",\\n \\"Honorific\\": \\"张先生\\",\\n \\"JobId\\": \\"b72425bd-7871-4050-838e-033d80d754b7\\",\\n \\"ContactName\\": \\"张三\\",\\n \\"Role\\": \\"*\\",\\n \\"ReferenceId\\": \\"2fa6bac3-06da-4315-82ab-72d6fd3a6f34\\"\\n },\\n \\"HangUpDirection\\": \\"client\\",\\n \\"RingingDuration\\": 25,\\n \\"SipCode\\": \\"200\\",\\n \\"RealRingingDuration\\": 25,\\n \\"SipDuration\\": 25\\n }\\n ],\\n \\"CallingNumbers\\": [\\n \\"[\\\\\\"0571****3106\\\\\\"]\\"\\n ],\\n \\"Script\\": {\\n \\"Status\\": \\"DRAFTED\\",\\n \\"UpdateTime\\": 1578881227000,\\n \\"ChatbotId\\": \\"chatbot-cn-EJfqqa***\\",\\n \\"ScriptId\\": \\"810b5872-57f0-4b27-80ab-7b3f4d8a6374\\",\\n \\"IsDebugDrafted\\": true,\\n \\"Industry\\": \\"金融\\",\\n \\"ScriptDescription\\": \\"催收话术\\",\\n \\"MiniPlaybackConfigEnabled\\": true,\\n \\"IsDrafted\\": true,\\n \\"TtsConfig\\": \\"{\\\\\\\\\\\\\\"voice\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xiaobei\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"volume\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"50\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"speechRate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"-150\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pitchRate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"}\\",\\n \\"DebugStatus\\": \\"DRAFTED\\",\\n \\"AsrConfig\\": \\"{\\\\\\\\\\\\\\"AppKey\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"3GHttnsvir1FeWWb\\\\\\\\\\\\\\"}\\",\\n \\"Scene\\": \\"催收\\",\\n \\"Name\\": \\"催收话术\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n \\n Succeeded\\n 1640068026385\\n 5\\n -\\n 1640068026385\\n NoAnswer\\n 1\\n d5971d98-7312-4f0e-a918-a17d67133e28\\n 137****7777\\n d5971d98-7312-4f0e-a918-a17d67133e28\\n fce6c599-8ede-40e3-9f78-0928eda7b4e8\\n ade80092-03d9-4f4d-ad4f-ab8a247d3150\\n c8a2b7f2-ad1a-4865-b872-d0080d9802d9\\n 1\\n b72425bd-7871-4050-838e-033d80d754b7\\n \\n 1358****8888\\n Available\\n db3db762-e421-44c9-9a01-cb423470757c\\n 张先生\\n 72dcd26b-f12d-4c27-b3af-18f6aed5b160\\n 张三\\n *\\n 2fa6bac3-06da-4315-82ab-72d6fd3a6f34\\n \\n \\n djrq\\n 2019-08-21 09:49:59.0\\n \\n \\n score\\n {}\\n 5\\n \\n \\n Succeeded\\n 1579068424883\\n 1234\\n 1579068424883\\n 135****8888\\n 1579068424883\\n ade80092-03d9-4f4d-ad4f-ab8a247d3150\\n FINISHED\\n b72425bd-7871-4050-838e-033d80d754b7\\n 1528189846043\\n 0571****3106\\n 1\\n 120\\n ff44709e-39a6-43ba-959b-20fcabe3e496\\n \\n {}\\n Broadcast\\n 1579068424883\\n Robot\\n \\n \\n score\\n {}\\n 5\\n \\n fd279983-93b9-b13b-9a34-64e5df473225\\n \\n \\n 1351****8888\\n Available\\n db3db762-e421-44c9-9a01-cb423470757c\\n 张先生\\n b72425bd-7871-4050-838e-033d80d754b7\\n 张三\\n *\\n 2fa6bac3-06da-4315-82ab-72d6fd3a6f34\\n \\n client\\n 25\\n 200\\n 25\\n 25\\n \\n [\\"0571****3106\\"]\\n \\n \\n","errorExample":""}]',
'title' => '返回一个作业的对话数据',
'changeSet' => [
[
'createdAt' => '2024-07-22T12:44:38.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2023-04-25T13:37:59.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2021-11-24T13:01:16.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2021-11-24T13:01:16.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeJobDataParsingTaskProgress' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94070',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'JobDataParsingTaskId',
'in' => 'query',
'schema' => [
'description' => '作业数据分析任务ID'."\n"
."\n"
.'> 该参数值通过CreateJobDataParsingTask接口拿到',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '50d5e164-9365-4261-980e-3d979c2c948c',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c209abb3-6804-4a75-b2c7-dd55c8c61b6a',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Progress' => [
'description' => '进度',
'type' => 'object',
'properties' => [
'FailErrorCode' => [
'description' => '失败错误码',
'type' => 'string',
'example' => 'Permission.JobStatus',
],
'Status' => [
'description' => '作业状态'."\n"
.'- Pending:待办的'."\n"
.'- InProgress:进行中'."\n"
.'- Finished:完成的'."\n"
.'- PartialFinished:部分完成'."\n"
.'- Failed:失败',
'type' => 'string',
'example' => 'Pending',
],
'HandledJobCount' => [
'description' => '处理中作业数量',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalJobCount' => [
'description' => '总计作业数量',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'FailReason' => [
'description' => '失败原因',
'type' => 'string',
'example' => 'CreateCorpus',
],
'FeedbackUrl' => [
'description' => '解析失败记录文件的下载地址【废弃】',
'type' => 'string',
'example' => 'xxxx',
],
],
'example' => '{}',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Progress\\": {\\n \\"FailErrorCode\\": \\"Permission.JobStatus\\",\\n \\"Status\\": \\"Pending\\",\\n \\"HandledJobCount\\": 2,\\n \\"TotalJobCount\\": 3,\\n \\"FailReason\\": \\"CreateCorpus\\",\\n \\"FeedbackUrl\\": \\"xxxx\\"\\n }\\n}","type":"json"}]',
'title' => '返回一个作业的进度信息',
'summary' => '获取上传的作业文件解析进度。',
'changeSet' => [
[
'createdAt' => '2022-01-12T12:20:58.000Z',
'description' => '响应参数发生变更',
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeJobDataParsingTaskProgress',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeJobGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94071',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '46a9ad0c-3e11-44da-a9a7-2c21bf5ce185',
],
],
[
'name' => 'BriefTypes',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '过滤条件(历史参数,已废弃)。',
'type' => 'array',
'items' => [
'description' => '过滤条件,业务结果。',
'type' => 'string',
'required' => false,
'example' => '回访成功',
],
'required' => false,
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息。',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'JobGroup' => [
'description' => '任务信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1578881227404',
],
'Status' => [
'description' => '任务状态。',
'type' => 'string',
'example' => 'Completed',
],
'JobGroupName' => [
'description' => '任务组名称。',
'type' => 'string',
'example' => '催收作业组',
],
'ScriptId' => [
'description' => '话术场景ID。',
'type' => 'string',
'example' => '49f00b0d-78ac-4d51-91de-a9e8e92b8470',
],
'JobGroupId' => [
'description' => '任务组ID。',
'type' => 'string',
'example' => '46a9ad0c-3e11-44da-a9a7-2c21bf5ce185',
],
'ScenarioId' => [
'description' => '场景ID(旧画布参数,新画布场景同ScriptId)。',
'type' => 'string',
'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8',
],
'JobFilePath' => [
'description' => '任务名单上传后的OSS Filekey 【已废弃】',
'type' => 'string',
'example' => 'da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx',
],
'JobGroupDescription' => [
'description' => '任务描述。',
'type' => 'string',
'example' => '催收作业组',
],
'JobDataParsingTaskId' => [
'description' => '任务名单解析操作ID。【已废弃】',
'type' => 'string',
'example' => 'da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx',
],
'ScriptName' => [
'description' => '话术场景名称。',
'type' => 'string',
'example' => '催收话术',
],
'ModifyTime' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '1578881227404',
],
'ScriptVersion' => [
'description' => '话术场景版本号。',
'type' => 'string',
'example' => '49f00b0d-78ac-4d51-91de-a9e8e92b8470',
],
'CallingNumbers' => [
'description' => '主叫号码列表。',
'type' => 'array',
'items' => [
'description' => '主叫号码列表。',
'type' => 'string',
'example' => '["1****6"]',
],
],
'ExportProgress' => [
'description' => '导出进度【废弃】'."\n"
."\n"
.'> 该信息从ListJobGroups接口中获取',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '导出状态【已废弃】',
'type' => 'string',
'example' => 'FINISHED',
],
'FileHttpUrl' => [
'description' => '文件地址【已废弃】',
'type' => 'string',
'example' => 'https://oss-cn-shanghai.aliyuncs.com/xx.zip',
],
'Progress' => [
'description' => '导出进度【已废弃】',
'type' => 'string',
'example' => '1',
],
],
],
'Progress' => [
'description' => '任务进展情况。',
'type' => 'object',
'properties' => [
'TotalNotAnswered' => [
'description' => '已废弃',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Status' => [
'description' => '任务整体执行状况。【已废弃】',
'type' => 'string',
'example' => 'Executing',
],
'StartTime' => [
'description' => '开始执行的时间。【已废弃】',
'type' => 'integer',
'format' => 'int64',
'example' => '1578881227404',
],
'Failed' => [
'description' => '失败的作业数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Executing' => [
'description' => '执行中的作业数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalJobs' => [
'description' => '总作业数量',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCompleted' => [
'description' => '总计完成的作业数量',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Duration' => [
'description' => '任务执行时间。【已废弃】',
'type' => 'integer',
'format' => 'int32',
'example' => '1000',
],
'Scheduling' => [
'description' => '调度中的作业数量',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'Paused' => [
'description' => '暂停的作业数量',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Cancelled' => [
'description' => '取消的作业数量',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Briefs' => [
'description' => '业务结果信息【废弃】',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '业务结果名字',
'type' => 'string',
'example' => 'score',
],
'Value' => [
'description' => '业务结果值',
'type' => 'string',
'example' => '5',
],
],
'description' => '',
],
],
'Categories' => [
'description' => 'key vaule 形式的统计信息【废弃】',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '自定义的统计信息字段名字',
'type' => 'string',
'example' => 'success',
],
'Value' => [
'description' => '自定义的统计信息值',
'type' => 'string',
'example' => '10',
],
],
'description' => '',
],
],
],
],
'Strategy' => [
'description' => '作业的执行策略',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '策略类型',
'type' => 'string',
'example' => 'Repeatable',
],
'StrategyName' => [
'description' => '策略名字',
'type' => 'string',
'example' => '催收策略名字',
],
'MaxAttemptsPerDay' => [
'description' => '未接通情况下每日最大呼叫次数',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'FollowUpStrategy' => [
'description' => '执行周期结束后的处理方式(历史参数,已不再使用)。',
'type' => 'string',
'example' => 'NONE',
],
'EndTime' => [
'description' => '调度策略的总结束时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1579881227404',
],
'Customized' => [
'description' => '策略的自定义数据(历史参数,已不再使用)。',
'type' => 'string',
'example' => '{}',
],
'IsTemplate' => [
'description' => '是否是模版',
'type' => 'boolean',
'example' => 'false',
],
'StartTime' => [
'description' => '策略总的开始时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1578881227404',
],
'StrategyId' => [
'description' => '策略ID',
'type' => 'string',
'example' => 'a2bff22c-2604-4df2-83d6-5952e2438c5a',
],
'RoutingStrategy' => [
'description' => '号码路由策略',
'type' => 'string',
'example' => 'LocalFirst',
],
'MinAttemptInterval' => [
'description' => '重新拨打的间隔时间',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'StrategyDescription' => [
'description' => '策略描述',
'type' => 'string',
'example' => '催收策略',
],
'RepeatBy' => [
'description' => '作业重复方式',
'type' => 'string',
'example' => 'Once',
],
'WorkingTime' => [
'description' => '工作时间段',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '开始时间',
'type' => 'string',
'example' => '12:00:00',
],
'BeginTime' => [
'description' => '结束时间',
'type' => 'string',
'example' => '09:00:00',
],
],
'description' => '',
],
],
'RepeatDays' => [
'description' => '重复执行的日期,和RepeatBy结合使用。'."\n"
.'- 若重复周期为“周”,0表示周日,1-6分别表示周一至周六。 '."\n"
.'- 若重复周期为“月”,1-31分别表示1至31日,没有该指定日期的月份不执行,如:若选定30日,二月份不执行。',
'type' => 'array',
'items' => [
'description' => '重复执行的天',
'type' => 'string',
'example' => '[1,2,3,4,5]',
],
],
'Repeatable' => [
'description' => '是否为循环任务',
'type' => 'boolean',
'example' => 'false',
],
],
],
'RecallStrategy' => [
'description' => '重呼策略',
'type' => 'object',
'properties' => [
'EmptyNumberIgnore' => [
'description' => '空号不再外呼',
'type' => 'boolean',
'example' => 'false',
],
'InArrearsIgnore' => [
'description' => '欠费不再外呼',
'type' => 'boolean',
'example' => 'false',
],
'OutOfServiceIgnore' => [
'description' => '停机不再外呼',
'type' => 'boolean',
'example' => 'false',
],
],
],
'Result' => [
'description' => '统计信息(历史参数,已不再提供)【已废弃】',
'type' => 'object',
'properties' => [
'TimeoutHangupNum' => [
'description' => '超时挂机数量【已废弃】',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'FinishedNum' => [
'description' => '完成数量【已废弃】',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'NoInteractNum' => [
'description' => '没有交互数量【已废弃】',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ClientHangupNum' => [
'description' => '客户挂机数量【已废弃】',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'UnrecognizedNum' => [
'description' => '拒识数量【已废弃】',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'RingingDuration' => [
'description' => '振铃时长',
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'Priority' => [
'description' => '优先级',
'type' => 'string',
'example' => '1',
],
'MinConcurrency' => [
'description' => '最小并发',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'FlashSmsExtras' => [
'description' => '闪信推送的配置参数,JSON格式,包含第三方闪信的配置信息。',
'type' => 'object',
'properties' => [
'ConfigId' => [
'description' => '闪信配置ID。',
'type' => 'string',
'example' => 'bebe23e6e2604f50bbeb12900c07703d',
],
'TemplateId' => [
'description' => '闪信模板ID。',
'type' => 'string',
'example' => 'e080d737-5c0b-4350-b7d4-1162530579e7',
],
],
],
'RecallCallingNumbers' => [
'description' => '重呼主叫号码列表,指第一次没打通。重呼时使用的主叫,不指定的话,默认和主叫列表一致。',
'type' => 'array',
'items' => [
'description' => '重呼主叫号码列表',
'type' => 'string',
'example' => '["1****6"]',
],
],
'ScriptNluEngine' => [
'type' => 'string',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.JobGroup',
'errorMessage' => 'The specified JobGroup does not exist.',
'description' => '指定的任务组不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'title' => '查询外呼任务组',
'summary' => '查询智能外呼任务数据。',
'changeSet' => [
[
'createdAt' => '2024-07-22T12:44:38.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2024-06-24T02:14:42.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2024-01-04T12:35:21.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2021-12-22T12:30:34.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2021-12-22T12:30:34.000Z',
'description' => '响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetJobGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"JobGroup\\": {\\n \\"CreationTime\\": 1578881227404,\\n \\"Status\\": \\"Completed\\",\\n \\"JobGroupName\\": \\"催收作业组\\",\\n \\"ScriptId\\": \\"49f00b0d-78ac-4d51-91de-a9e8e92b8470\\",\\n \\"JobGroupId\\": \\"46a9ad0c-3e11-44da-a9a7-2c21bf5ce185\\",\\n \\"ScenarioId\\": \\"fce6c599-8ede-40e3-9f78-0928eda7b4e8\\",\\n \\"JobFilePath\\": \\"da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx\\",\\n \\"JobGroupDescription\\": \\"催收作业组\\",\\n \\"JobDataParsingTaskId\\": \\"da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx\\",\\n \\"ScriptName\\": \\"催收话术\\",\\n \\"ModifyTime\\": \\"1578881227404\\",\\n \\"ScriptVersion\\": \\"49f00b0d-78ac-4d51-91de-a9e8e92b8470\\",\\n \\"CallingNumbers\\": [\\n \\"[\\\\\\"1****6\\\\\\"]\\"\\n ],\\n \\"ExportProgress\\": {\\n \\"Status\\": \\"FINISHED\\",\\n \\"FileHttpUrl\\": \\"https://oss-cn-shanghai.aliyuncs.com/xx.zip\\",\\n \\"Progress\\": \\"1\\"\\n },\\n \\"Progress\\": {\\n \\"TotalNotAnswered\\": 1,\\n \\"Status\\": \\"Executing\\",\\n \\"StartTime\\": 1578881227404,\\n \\"Failed\\": 0,\\n \\"Executing\\": 2,\\n \\"TotalJobs\\": 10,\\n \\"TotalCompleted\\": 2,\\n \\"Duration\\": 1000,\\n \\"Scheduling\\": 5,\\n \\"Paused\\": 0,\\n \\"Cancelled\\": 0,\\n \\"Briefs\\": [\\n {\\n \\"Key\\": \\"score\\",\\n \\"Value\\": \\"5\\"\\n }\\n ],\\n \\"Categories\\": [\\n {\\n \\"Key\\": \\"success\\",\\n \\"Value\\": \\"10\\"\\n }\\n ]\\n },\\n \\"Strategy\\": {\\n \\"Type\\": \\"Repeatable\\",\\n \\"StrategyName\\": \\"催收策略名字\\",\\n \\"MaxAttemptsPerDay\\": 2,\\n \\"FollowUpStrategy\\": \\"NONE\\",\\n \\"EndTime\\": 1579881227404,\\n \\"Customized\\": \\"{}\\",\\n \\"IsTemplate\\": false,\\n \\"StartTime\\": 1578881227404,\\n \\"StrategyId\\": \\"a2bff22c-2604-4df2-83d6-5952e2438c5a\\",\\n \\"RoutingStrategy\\": \\"LocalFirst\\",\\n \\"MinAttemptInterval\\": 10,\\n \\"StrategyDescription\\": \\"催收策略\\",\\n \\"RepeatBy\\": \\"Once\\",\\n \\"WorkingTime\\": [\\n {\\n \\"EndTime\\": \\"12:00:00\\",\\n \\"BeginTime\\": \\"09:00:00\\"\\n }\\n ],\\n \\"RepeatDays\\": [\\n \\"[1,2,3,4,5]\\"\\n ],\\n \\"Repeatable\\": false\\n },\\n \\"RecallStrategy\\": {\\n \\"EmptyNumberIgnore\\": false,\\n \\"InArrearsIgnore\\": false,\\n \\"OutOfServiceIgnore\\": false\\n },\\n \\"Result\\": {\\n \\"TimeoutHangupNum\\": 1,\\n \\"FinishedNum\\": 1,\\n \\"NoInteractNum\\": 1,\\n \\"ClientHangupNum\\": 1,\\n \\"UnrecognizedNum\\": 1\\n },\\n \\"RingingDuration\\": 30,\\n \\"Priority\\": \\"1\\",\\n \\"MinConcurrency\\": 1,\\n \\"FlashSmsExtras\\": {\\n \\"ConfigId\\": \\"bebe23e6e2604f50bbeb12900c07703d\\",\\n \\"TemplateId\\": \\"e080d737-5c0b-4350-b7d4-1162530579e7\\"\\n },\\n \\"RecallCallingNumbers\\": [\\n \\"[\\\\\\"1****6\\\\\\"]\\"\\n ],\\n \\"ScriptNluEngine\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n \\n 1578881227404\\n Completed\\n 催收作业组\\n 49f00b0d-78ac-4d51-91de-a9e8e92b8470\\n 46a9ad0c-3e11-44da-a9a7-2c21bf5ce185\\n fce6c599-8ede-40e3-9f78-0928eda7b4e8\\n da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx\\n 催收作业组\\n da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx\\n 催收话术\\n 1578881227404\\n 49f00b0d-78ac-4d51-91de-a9e8e92b8470\\n [\\"1****6\\"]\\n \\n FINISHED\\n https://oss-cn-shanghai.aliyuncs.com/xx.zip\\n \\n \\n \\n \\n Repeatable\\n 催收策略名字\\n 2\\n NONE\\n 1579881227404\\n {}\\n false\\n 1578881227404\\n a2bff22c-2604-4df2-83d6-5952e2438c5a\\n LocalFirst\\n 10\\n 催收策略\\n Once\\n \\n 12:00:00\\n 09:00:00\\n \\n [1,2,3,4,5]\\n \\n \\n false\\n false\\n false\\n \\n \\n 1\\n 1\\n 1\\n 1\\n 1\\n \\n 30\\n 1\\n 1\\n \\n bebe23e6e2604f50bbeb12900c07703d\\n e080d737-5c0b-4350-b7d4-1162530579e7\\n \\n [\\"1****6\\"]\\n \\n","errorExample":""}]',
],
'DescribeJobGroupExportTaskProgress' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94072',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => false,
'example' => 'b3dbfb82-1ae6-4e73-b717-f494727d2af3',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务id',
'type' => 'string',
'required' => false,
'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'FileHttpUrl' => [
'description' => '文件地址',
'type' => 'string',
'example' => 'http://xxx.xx.com/xx',
],
'Progress' => [
'description' => '导出进度',
'type' => 'number',
'format' => 'float',
'example' => '45.0',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"FileHttpUrl\\": \\"http://xxx.xx.com/xx\\",\\n \\"Progress\\": 45,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '【已废弃】获取任务组导出任务进度',
'summary' => '获取任务组导出任务进度,已废弃,可使用ListDownloadTasks替换。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeJobGroupExportTaskProgress',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeScript' => [
'summary' => '返回一个话术的信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '38d2e8ed-04e9-4dac-83b5-a8e57642ef13',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'bee7e5b1-5d9a-4389-aa7e-bbbee5353a16',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'Script' => [
'description' => '话术',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '话术状态',
'type' => 'string',
'example' => 'DRAFTED',
],
'UpdateTime' => [
'description' => '更新时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1578881227000',
],
'ChatbotId' => [
'description' => '对话机器人ID',
'type' => 'string',
'example' => 'd31794e2a51f47d2901b4094d88311d7',
],
'ScriptId' => [
'description' => '话术ID',
'type' => 'string',
'example' => '810b5872-57f0-4b27-80ab-7b3f4d8a6374',
],
'IsDebugDrafted' => [
'description' => '调试版本是否为草稿态',
'type' => 'boolean',
'example' => 'true',
],
'Industry' => [
'description' => '行业',
'type' => 'string',
'example' => '金融',
],
'ScriptDescription' => [
'description' => '话术描述',
'type' => 'string',
'example' => '催收话术',
],
'MiniPlaybackEnable' => [
'description' => '语气承接配置开关',
'type' => 'boolean',
'example' => 'true',
],
'IsDrafted' => [
'description' => '是否是草稿状态',
'type' => 'boolean',
'example' => 'true',
],
'TtsConfig' => [
'description' => '话术的TTS配置',
'type' => 'string',
'example' => '{'."\n"
.' "appKey": "oQDVNlE6fZ5mg46X",'."\n"
.' "engine": "ali",'."\n"
.' "engineXunfei": "",'."\n"
.' "globalInterruptible": true,'."\n"
.' "nlsServiceType": "Managed",'."\n"
.' "pitchRate": "0",'."\n"
.' "speechRate": "0",'."\n"
.' "voice": "zhiyuan",'."\n"
.' "volume": "50"'."\n"
.'}',
],
'DebugStatus' => [
'description' => '调试话术的状态',
'type' => 'string',
'example' => 'DRAFTED',
],
'AsrConfig' => [
'description' => 'ASR配置',
'type' => 'string',
'example' => '{'."\n"
.' "appKey": "oQDVNlE6fZ5mg46X",'."\n"
.' "engine": "ali",'."\n"
.' "engineXunfei": "",'."\n"
.' "globalMaxEndSilence": 700,'."\n"
.' "globalMaxEndSilenceEnable": true,'."\n"
.' "maxEndSilence": "500",'."\n"
.' "nlsServiceType": "Managed",'."\n"
.' "silenceTimeout": "5000",'."\n"
.' "speechNoiseThreshold": "0"'."\n"
.'}',
],
'Scene' => [
'description' => '场景',
'type' => 'string',
'example' => '催收',
],
'ScriptName' => [
'description' => '话术名字',
'type' => 'string',
'example' => '催收话术',
],
'NewBargeInEnable' => [
'description' => '优雅打断配置开关',
'type' => 'boolean',
'example' => 'true',
],
'LongWaitEnable' => [
'description' => '智能断句配置开关',
'type' => 'boolean',
'example' => 'true',
],
'EmotionEnable' => [
'description' => '情绪识别配置开关',
'type' => 'boolean',
'example' => 'true',
],
'AgentId' => [
'description' => '机器人业务空间访问Key',
'type' => 'integer',
'format' => 'int64',
'example' => '1218333',
],
'AgentKey' => [
'description' => '机器人业务空间访问Key',
'type' => 'string',
'example' => '14791f5f226b4878b3d9b676a0291234',
],
'AgentLlm' => [
'description' => '机器人业务空间是否大模型业务空间',
'type' => 'boolean',
'example' => 'true',
],
'ChatConfig' => [
'description' => '通话配置',
'type' => 'string',
'example' => '{"silenceConfig":{"silenceReplyTimeout":499,"silenceTimeoutMaxCount":10,"silenceTimeoutMaxCountEnable":true},"hangupConfig":{"aiHangupEnable":false,"delayHangup":0,"hangupMaxRounds":20,"hangupMaxRoundsBroadcast":"感谢您的接听,祝您生活愉快,再见!","hangupMaxRoundsEnable":false},"securityInterceptConfig":{"broadcast":"您说的这个问题我不能回答您,您可以尝试询问其他问题。"},"specialInterceptConfig":{"specialInterceptEnable":false,"specialIntercepts":[{"code":"voiceAssistant"},{"code":"extensionNumberTransfer"}]},"transitionConfig":{"transitionSwitch":false}}',
],
'NluEngine' => [
'description' => 'Nlu引擎(仅大模型场景适用)'."\n"
."\n"
.'- Prompts - 文本填写模式, '."\n"
.'- SSE_FUNCTION -函数计算服务模式',
'type' => 'string',
'example' => 'Prompts',
],
'NluProfile' => [
'description' => '函数计算服务模式配置',
'type' => 'object',
'properties' => [
'FcFunction' => [
'description' => '函数服务名称',
'type' => 'string',
'example' => 'sanfang_test',
],
'FcRegion' => [
'description' => '函数服务地域',
'type' => 'string',
'example' => 'cn-shanghai',
],
'FcHttpTriggerUrl' => [
'description' => '函数服务触发器',
'type' => 'string',
'example' => 'http://sanfang_test-xxxxxx.cn-shanghai-vpc.fcapp.run',
],
'SupportBeebotPrompts' => [
'type' => 'boolean',
'description' => '',
],
],
],
'LabelConfig' => [
'type' => 'string',
'description' => '',
],
],
'example' => '{}',
],
'NlsConfig' => [
'description' => '已作废',
'type' => 'string',
'example' => 'none',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Script\\": {\\n \\"Status\\": \\"DRAFTED\\",\\n \\"UpdateTime\\": 1578881227000,\\n \\"ChatbotId\\": \\"d31794e2a51f47d2901b4094d88311d7\\",\\n \\"ScriptId\\": \\"810b5872-57f0-4b27-80ab-7b3f4d8a6374\\",\\n \\"IsDebugDrafted\\": true,\\n \\"Industry\\": \\"金融\\",\\n \\"ScriptDescription\\": \\"催收话术\\",\\n \\"MiniPlaybackEnable\\": true,\\n \\"IsDrafted\\": true,\\n \\"TtsConfig\\": \\"{\\\\n\\\\t\\\\\\"appKey\\\\\\": \\\\\\"oQDVNlE6fZ5mg46X\\\\\\",\\\\n\\\\t\\\\\\"engine\\\\\\": \\\\\\"ali\\\\\\",\\\\n\\\\t\\\\\\"engineXunfei\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"globalInterruptible\\\\\\": true,\\\\n\\\\t\\\\\\"nlsServiceType\\\\\\": \\\\\\"Managed\\\\\\",\\\\n\\\\t\\\\\\"pitchRate\\\\\\": \\\\\\"0\\\\\\",\\\\n\\\\t\\\\\\"speechRate\\\\\\": \\\\\\"0\\\\\\",\\\\n\\\\t\\\\\\"voice\\\\\\": \\\\\\"zhiyuan\\\\\\",\\\\n\\\\t\\\\\\"volume\\\\\\": \\\\\\"50\\\\\\"\\\\n}\\",\\n \\"DebugStatus\\": \\"DRAFTED\\",\\n \\"AsrConfig\\": \\"{\\\\n\\\\t\\\\\\"appKey\\\\\\": \\\\\\"oQDVNlE6fZ5mg46X\\\\\\",\\\\n\\\\t\\\\\\"engine\\\\\\": \\\\\\"ali\\\\\\",\\\\n\\\\t\\\\\\"engineXunfei\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"globalMaxEndSilence\\\\\\": 700,\\\\n\\\\t\\\\\\"globalMaxEndSilenceEnable\\\\\\": true,\\\\n\\\\t\\\\\\"maxEndSilence\\\\\\": \\\\\\"500\\\\\\",\\\\n\\\\t\\\\\\"nlsServiceType\\\\\\": \\\\\\"Managed\\\\\\",\\\\n\\\\t\\\\\\"silenceTimeout\\\\\\": \\\\\\"5000\\\\\\",\\\\n\\\\t\\\\\\"speechNoiseThreshold\\\\\\": \\\\\\"0\\\\\\"\\\\n}\\",\\n \\"Scene\\": \\"催收\\",\\n \\"ScriptName\\": \\"催收话术\\",\\n \\"NewBargeInEnable\\": true,\\n \\"LongWaitEnable\\": true,\\n \\"EmotionEnable\\": true,\\n \\"AgentId\\": 1218333,\\n \\"AgentKey\\": \\"14791f5f226b4878b3d9b676a0291234\\",\\n \\"AgentLlm\\": true,\\n \\"ChatConfig\\": \\"{\\\\\\"silenceConfig\\\\\\":{\\\\\\"silenceReplyTimeout\\\\\\":499,\\\\\\"silenceTimeoutMaxCount\\\\\\":10,\\\\\\"silenceTimeoutMaxCountEnable\\\\\\":true},\\\\\\"hangupConfig\\\\\\":{\\\\\\"aiHangupEnable\\\\\\":false,\\\\\\"delayHangup\\\\\\":0,\\\\\\"hangupMaxRounds\\\\\\":20,\\\\\\"hangupMaxRoundsBroadcast\\\\\\":\\\\\\"感谢您的接听,祝您生活愉快,再见!\\\\\\",\\\\\\"hangupMaxRoundsEnable\\\\\\":false},\\\\\\"securityInterceptConfig\\\\\\":{\\\\\\"broadcast\\\\\\":\\\\\\"您说的这个问题我不能回答您,您可以尝试询问其他问题。\\\\\\"},\\\\\\"specialInterceptConfig\\\\\\":{\\\\\\"specialInterceptEnable\\\\\\":false,\\\\\\"specialIntercepts\\\\\\":[{\\\\\\"code\\\\\\":\\\\\\"voiceAssistant\\\\\\"},{\\\\\\"code\\\\\\":\\\\\\"extensionNumberTransfer\\\\\\"}]},\\\\\\"transitionConfig\\\\\\":{\\\\\\"transitionSwitch\\\\\\":false}}\\",\\n \\"NluEngine\\": \\"Prompts\\",\\n \\"NluProfile\\": {\\n \\"FcFunction\\": \\"sanfang_test\\",\\n \\"FcRegion\\": \\"cn-shanghai\\",\\n \\"FcHttpTriggerUrl\\": \\"http://sanfang_test-xxxxxx.cn-shanghai-vpc.fcapp.run\\",\\n \\"SupportBeebotPrompts\\": true\\n },\\n \\"LabelConfig\\": \\"\\"\\n },\\n \\"NlsConfig\\": \\"none\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n OK\\n Success\\n \\n none\\n","errorExample":""}]',
'title' => '返回一个话术的信息',
'changeSet' => [
[
'createdAt' => '2025-07-22T14:21:12.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2025-06-12T11:39:29.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2025-04-25T07:27:13.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2024-08-06T12:39:33.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2024-04-25T12:17:46.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2022-09-20T13:53:36.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2022-06-21T12:54:40.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2022-03-01T12:42:07.000Z',
'description' => '响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => 'Instance',
'arn' => 'acs:outboundbot:{#regionId}:{#accountId}:instance/{#InstanceId}',
],
],
],
],
],
],
'DescribeScriptVoiceConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0fe7f71c-8771-42ef-9bb1-19aa16ae7120',
],
],
[
'name' => 'ScriptVoiceConfigId',
'in' => 'query',
'schema' => [
'description' => '场景声音配置ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2a07b634-e15d-445f-bbcb-fc4ea2df7b87',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'ScriptVoiceConfig' => [
'description' => '场景声音配置信息',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '录音类型'."\n"
."\n"
.'- WAVEFORM:录音'."\n"
.'- TTS:文本转语音',
'type' => 'string',
'example' => 'TTS',
],
'ScriptVoiceConfigId' => [
'description' => '场景声音配置ID',
'type' => 'string',
'example' => '2a07b634-e15d-445f-bbcb-fc4ea2df7b87',
],
'ScriptContent' => [
'description' => '话术内容',
'type' => 'string',
'example' => '你的花呗欠款逾期了需要处理,你现在能处理一下吗?',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => '291cfc6a-8703-4bdd-a99d-9cba32d5288a',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => '947e0875-b5d4-4b33-b18c-7b2cf85bcb4f',
],
'ScriptWaveformRelation' => [
'description' => '话术录音数据,在Type为WAVEFORM时有值。',
'type' => 'string',
'example' => '[{"ScriptContent":"请问你是","ScriptWaveformId":"07db2f0a-acb2-4e68-b9f4-66397414f50c"},{"ScriptContent":"吗?","ScriptWaveformId":"c2a69440-03e3-406e-b0a9-a9791fccb31b"}]',
],
'Source' => [
'description' => '话术源',
'type' => 'string',
'example' => 'DIALOGUE_FLOW',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"ScriptVoiceConfig\\": {\\n \\"Type\\": \\"TTS\\",\\n \\"ScriptVoiceConfigId\\": \\"2a07b634-e15d-445f-bbcb-fc4ea2df7b87\\",\\n \\"ScriptContent\\": \\"你的花呗欠款逾期了需要处理,你现在能处理一下吗?\\",\\n \\"InstanceId\\": \\"291cfc6a-8703-4bdd-a99d-9cba32d5288a\\",\\n \\"ScriptId\\": \\"947e0875-b5d4-4b33-b18c-7b2cf85bcb4f\\",\\n \\"ScriptWaveformRelation\\": \\"[{\\\\\\"ScriptContent\\\\\\":\\\\\\"请问你是\\\\\\",\\\\\\"ScriptWaveformId\\\\\\":\\\\\\"07db2f0a-acb2-4e68-b9f4-66397414f50c\\\\\\"},{\\\\\\"ScriptContent\\\\\\":\\\\\\"吗?\\\\\\",\\\\\\"ScriptWaveformId\\\\\\":\\\\\\"c2a69440-03e3-406e-b0a9-a9791fccb31b\\\\\\"}]\\",\\n \\"Source\\": \\"DIALOGUE_FLOW\\"\\n }\\n}","type":"json"}]',
'title' => '【旧画布接口】返回一个场景声音配置',
'summary' => '旧画布场景中返回一个场景声音配置。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeScriptVoiceConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeTTSConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0ec0c897-b92c-40e4-9ad7-e6e4f5ce13bb',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd7fbd0a0-27bc-49c4-a456-ecb75e79122b',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'f765d3ee-ec03-4765-b235-6877501d99d1',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'TTSConfig' => [
'description' => 'TTS配置',
'type' => 'object',
'properties' => [
'Voice' => [
'description' => 'TTS模型',
'type' => 'string',
'example' => 'xiaoyun',
],
'SpeechRate' => [
'description' => '语速',
'type' => 'string',
'example' => '-150',
],
'Volume' => [
'description' => '音量',
'type' => 'string',
'example' => '100',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => '947e0875-b5d4-4b33-b18c-7b2cf85bcb4f',
],
'NlsServiceType' => [
'description' => '服务类型',
'type' => 'string',
'example' => 'Managed',
],
'AppKey' => [
'description' => '调用TTS的AppKey',
'type' => 'string',
'example' => 'p2SjSj4zxxxxxxxx',
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"f765d3ee-ec03-4765-b235-6877501d99d1\\",\\n \\"Success\\": true,\\n \\"TTSConfig\\": {\\n \\"Voice\\": \\"xiaoyun\\",\\n \\"SpeechRate\\": \\"-150\\",\\n \\"Volume\\": \\"100\\",\\n \\"InstanceId\\": \\"947e0875-b5d4-4b33-b18c-7b2cf85bcb4f\\",\\n \\"NlsServiceType\\": \\"Managed\\",\\n \\"AppKey\\": \\"p2SjSj4zxxxxxxxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n f765d3ee-ec03-4765-b235-6877501d99d1\\n true\\n \\n xiaoyun\\n -150\\n 100\\n 947e0875-b5d4-4b33-b18c-7b2cf85bcb4f\\n Managed\\n p2SjSj4zxxxxxxxx\\n \\n","errorExample":""}]',
'title' => '【废弃】查询tts配置信息',
'summary' => '查询tts配置信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
[
'createdAt' => '2022-03-01T12:42:07.000Z',
'description' => '响应参数发生变更、错误码发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeTTSConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeTTSDemo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'a8eccb3c-2b26-4b6d-a54f-696b953e33a6',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '5ab2d935-306c-478a-88bf-d08e4e25c1b7',
],
],
[
'name' => 'Voice',
'in' => 'query',
'schema' => [
'description' => '发音人信息,如:aixia / siyue / xiaoyun,完整发音人信息参考下方音色列表。'."\n"
."\n"
.'> 由于克隆音色的Voice是不同非固定的值,在声音复刻时生成,导致现阶段无法提供具体的Voice(具体的VoiceID需要在克隆音色页面中获取请求ListVoiceClone信息)',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'aixia',
],
],
[
'name' => 'Text',
'in' => 'query',
'schema' => [
'description' => '文本内容',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '测试',
],
],
[
'name' => 'SpeechRate',
'in' => 'query',
'schema' => [
'description' => '语速'."\n"
.'[-500,500]之间整数。默认值为0。'."\n"
."\n"
.'大于0表示加快语速。'."\n"
."\n"
.'小于0表示减慢语速。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '500',
'minimum' => '-500',
'example' => '0',
],
],
[
'name' => 'Volume',
'in' => 'query',
'schema' => [
'description' => '音量'."\n"
.'[0,100]之间整数。默认值为50。'."\n"
."\n"
.'大于50表示增大音量。'."\n"
."\n"
.'小于50表示减小音量。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '100',
'minimum' => '0',
'example' => '50',
],
],
[
'name' => 'PitchRate',
'in' => 'query',
'schema' => [
'description' => '语调'."\n"
.'[-500,500]之间整数。默认值为0。'."\n"
."\n"
.'大于0表示升高音高。'."\n"
."\n"
.'小于0表示降低音高。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '语音服务类型 '."\n"
."\n"
.'- 当使用**ali**当作自定义服务时,此字段用来保存智能语音交互产品项目的appKey。'."\n"
."\n"
.'- 当使用**xunfei**作为自定义服务方时,保存对应的appKey',
'type' => 'string',
'required' => false,
'example' => 'xusi*******RnP7',
],
],
[
'name' => 'SecretKey',
'in' => 'query',
'schema' => [
'description' => '该命名空间的AccessKey Secret(SK)。'."\n"
."\n"
.'> 当engine为xunfei时,需要将其SK填入',
'type' => 'string',
'required' => false,
'example' => 'OTdhNDE3Z********zQ****',
],
],
[
'name' => 'AccessKey',
'in' => 'query',
'schema' => [
'description' => '该命名空间的AccessKey(AK)。'."\n"
.'> 当engine为xunfei时,需要将其AK填入',
'type' => 'string',
'required' => false,
'example' => '5d0f37**********ef56db601****',
],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => [
'description' => '存储引擎。可选择【ali、volc、xunfei】'."\n"
."\n"
.'- 使用默认服务或者自定义服务选择阿里时,填入**ali**。'."\n"
."\n"
.'- 使用doubao服务时,须填入**volc**'."\n"
.'- 使用xunfei作为服务方时,填入 **xunfei** (只能在小模型场景使用)',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'xunfei' => 'xunfei',
'volc' => 'volc',
'ali' => 'ali',
],
'example' => 'ali',
],
],
[
'name' => 'NlsServiceType',
'in' => 'query',
'schema' => [
'description' => '服务类型'."\n"
.'Managed:智能外呼产品默认智能语音交互产品服务(公共服务)。'."\n"
.'Authorized:公有云客户自己购买的智能语音交互产品服务(客户私有服务),通过场景管理-编辑-调用服务-自定义服务完成授权。'."\n"
."\n"
.'> 当需要使用阿里智能语音交互时,即使用阿里作为自定义服务方时须要填入Authorized。',
'type' => 'string',
'required' => false,
'example' => 'Authorized',
],
],
[
'name' => 'AliCustomizedVoice',
'in' => 'query',
'schema' => [
'description' => '阿里定制语音,即为声音调用ID',
'type' => 'string',
'required' => false,
'example' => 'voice-e1be3a6',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'AuditionUrl' => [
'description' => '试听文件地址',
'type' => 'string',
'example' => 'http://XXX/XXX',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"AuditionUrl\\": \\"http://XXX/XXX\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n OK\\n Success\\n http://XXX/XXX\\n","errorExample":""}]',
'title' => 'TTS 试听',
'summary' => 'TTS试听。',
'requestParamsDescription' => ''."\n"
.'TTS默认服务音色
'."\n"
."\n"
.'- 大模型音色:'."\n"
.' - CV-v3-flash:龙安洋:cosyvoice-v3-flash:longanyang'."\n"
.' - CV-v3-flash:龙安欢:cosyvoice-v3-flash:longanhuan'."\n"
.' - CV-v3-flash:龙呼呼:cosyvoice-v3-flash:longhuhu_v3'."\n"
.' - CV-v3-flash:龙嘉怡:cosyvoice-v3-flash:longjiayi_v3'."\n"
.' - CV-v3-flash:龙安粤:cosyvoice-v3-flash:longanyue_v3'."\n"
.' - CV-v3-flash:龙老铁:cosyvoice-v3-flash:longlaotie_v3'."\n"
.' - CV-v3-flash:龙陕哥:cosyvoice-v3-flash:longshange_v3'."\n"
.' - CV-v3-flash:龙安闽:cosyvoice-v3-flash:longanmin_v3'."\n"
.' - CV-v3-flash:loongkyong:cosyvoice-v3-flash:loongkyong_v3'."\n"
.' - CV-v3-flash:loongtomoka:cosyvoice-v3-flash:loongtomoka_v3'."\n"
.' - CV-v3-flash:龙飞:cosyvoice-v3-flash:longfei_v3'."\n"
.' - CV-v3-flash:龙应笑:cosyvoice-v3-flash:longyingxiao_v3'."\n"
.' - CV-v3-flash:龙应询:cosyvoice-v3-flash:longyingxun_v3'."\n"
.' - CV-v3-flash:龙应静:cosyvoice-v3-flash:longyingjing_v3'."\n"
.' - CV-v3-flash:龙应聆:cosyvoice-v3-flash:longyingling_v3'."\n"
.' - CV-v3-flash:龙应桃:cosyvoice-v3-flash:longyingtao_v3'."\n"
.' - CV-v3-flash:龙小淳:cosyvoice-v3-flash:longxiaochun_v3'."\n"
.' - CV-v3-flash:龙小夏:cosyvoice-v3-flash:longxiaoxia_v3'."\n"
.' - CV-v3-flash:YUMI:cosyvoice-v3-flash:longyumi_v3'."\n"
.' - CV-v3-flash:龙安昀:cosyvoice-v3-flash:longanyun_v3'."\n"
.' - CV-v3-flash:龙安温:cosyvoice-v3-flash:longanwen_v3'."\n"
.' - CV-v3-flash:龙安莉:cosyvoice-v3-flash:longanli_v3'."\n"
.' - CV-v3-flash:龙安朗:cosyvoice-v3-flash:longanlang_v3'."\n"
.' - CV-v3-flash:龙应沐:cosyvoice-v3-flash:longyingmu_v3'."\n"
.' - CV-v3-flash:龙橙:cosyvoice-v3-flash:longcheng_v3'."\n"
.' - CV-v3-flash:龙泽:cosyvoice-v3-flash:longze_v3'."\n"
.' - CV-v3-flash:龙哲:cosyvoice-v3-flash:longzhe_v3'."\n"
.' - CV-v3-flash:龙颜:cosyvoice-v3-flash:longyan_v3'."\n"
.' - CV-v3-flash:龙星:cosyvoice-v3-flash:longxing_v3'."\n"
.' - CV-v3-flash:龙天:cosyvoice-v3-flash:longtian_v3'."\n"
.' - CV-v3-flash:龙婉:cosyvoice-v3-flash:longwan_v3'."\n"
.' - CV-v3-flash:龙嫱:cosyvoice-v3-flash:longqiang_v3'."\n"
.' - CV-v3-flash:龙菲菲:cosyvoice-v3-flash:longfeifei_v3'."\n"
.' - CV-v3-flash:龙浩:cosyvoice-v3-flash:longhao_v3'."\n"
.' - CV-v3-flash:龙安柔:cosyvoice-v3-flash:longanrou_v3'."\n"
.' - CV-v3-flash:龙寒:cosyvoice-v3-flash:longhan_v3'."\n"
.' - CV-v3-flash:龙安智:cosyvoice-v3-flash:longanzhi_v3'."\n"
.' - CV-v3-flash:龙安灵:cosyvoice-v3-flash:longanling_v3'."\n"
.' - CV-v3-flash:龙安雅:cosyvoice-v3-flash:longanya_v3'."\n"
.' - CV-v3-flash:龙安亲:cosyvoice-v3-flash:longanqin_v3'."\n"
.' - CV-v3-flash:龙三叔:cosyvoice-v3-flash:longsanshu_v3'."\n"
.' - CV-v3-flash:龙媛:cosyvoice-v3-flash:longyuan_v3'."\n"
.' - CV-v3-flash:龙悦:cosyvoice-v3-flash:longyue_v3'."\n"
.' - CV-v3-flash:龙修:cosyvoice-v3-flash:longxiu_v3'."\n"
.' - CV-v3-flash:龙楠:cosyvoice-v3-flash:longnan_v3'."\n"
.' - CV-v3-flash:龙婉君:cosyvoice-v3-flash:longwanjun_v3'."\n"
.' - CV-v3-flash:龙逸尘:cosyvoice-v3-flash:longyichen_v3'."\n"
.' - CV-v3-flash:龙老伯:cosyvoice-v3-flash:longlaobo_v3'."\n"
.' - CV-v3-flash:龙老姨:cosyvoice-v3-flash:longlaoyi_v3'."\n"
.' - CV-v3-flash:龙机器:cosyvoice-v3-flash:longjiqi_v3'."\n"
.' - CV-v3-flash:龙猴哥:cosyvoice-v3-flash:longhouge_v3'."\n"
.' - CV-v3-flash:龙黛玉:cosyvoice-v3-flash:longdaiyu_v3'."\n"
.' - CV-v3-flash:龙安宣:cosyvoice-v3-flash:longanxuan_v3'."\n"
.' - CV-v3-flash:龙书:cosyvoice-v3-flash:longshu_v3'."\n"
.' - CV-v3-flash:Bella3.0:cosyvoice-v3-flash:loongbella_v3'."\n"
.' - CV-v3-plus:龙安洋:cosyvoice-v3-plus:longanyang'."\n"
.' - CV-v3-plus:龙安欢:cosyvoice-v3-plus:longanhuan'."\n"
.' - CosyVoice:龙橙:CosyVoice:longcheng'."\n"
.' - CosyVoice:龙橙v2:CosyVoice:longcheng_v2'."\n"
.' - CosyVoice:龙哲:CosyVoice:longzhe'."\n"
.' - CosyVoice:龙楠:CosyVoice:longnan'."\n"
.' - CosyVoice:龙颜:CosyVoice:longyan'."\n"
.' - CosyVoice:龙嫱:CosyVoice:longqiang'."\n"
.' - CosyVoice:龙华:CosyVoice:longhua'."\n"
.' - CosyVoice:龙华v2:CosyVoice:longhua_v2'."\n"
.' - CosyVoice:龙星:CosyVoice:longxing'."\n"
.' - CosyVoice:龙津:CosyVoice:longjin'."\n"
.' - CosyVoice:龙寒:CosyVoice:longhan'."\n"
.' - CosyVoice:龙天:CosyVoice:longtian'."\n"
.' - CosyVoice:龙婉v2:CosyVoice:longwan_v2'."\n"
.' - CosyVoice:龙书:CosyVoice:longshuo'."\n"
.' - CosyVoice:Stella2.0:CosyVoice:loongstella'."\n"
.' - CosyVoice:龙小诚:CosyVoice:longxiaocheng'."\n"
.' - CosyVoice:龙小夏:CosyVoice:longxiaoxia'."\n"
.' - CosyVoice:龙小夏v2:CosyVoice:longxiaoxia_v2p1'."\n"
.' - CosyVoice:龙小淳:CosyVoice:longxiaochun'."\n"
.' - CosyVoice:龙小淳v2:CosyVoice:longxiaochun_v2'."\n"
.' - CosyVoice:龙小白:CosyVoice:longxiaobai'."\n"
.' - CosyVoice:龙老铁:CosyVoice:longlaotie'."\n"
.' - CosyVoice:龙悦:CosyVoice:longyue'."\n"
.' - CosyVoice:Bella2.0:CosyVoice:loongbella'."\n"
.' - CosyVoice:Bella2.0v2:CosyVoice:loongbella_v2'."\n"
.' - CosyVoice:龙媛:CosyVoice:longyuan'."\n"
.' - CosyVoice:龙书:CosyVoice:longshu'."\n"
.' - CosyVoice:龙书v2:CosyVoice:longshu_v2'."\n"
.' - CosyVoice:龙婧:CosyVoice:longjing'."\n"
.' - CosyVoice:龙妙:CosyVoice:longmiao'."\n"
.' - CosyVoice:龙应淘:CosyVoice:longyingtao'."\n"
.' - CosyVoice:龙应催:cosyvoice-v2:longyingcui'."\n"
."\n"
.'- 通义千问音色:'."\n"
.' - 芊悦:qwen3-tts-flash-realtime:Cherry'."\n"
.' - 晨煦:qwen3-tts-flash-realtime:Ethan'."\n"
.' - 不吃鱼:qwen3-tts-flash-realtime:Nofish'."\n"
.' - 詹妮弗:qwen3-tts-flash-realtime:Jennifer'."\n"
.' - 甜茶:qwen3-tts-flash-realtime:Ryan'."\n"
.' - 卡捷琳娜:qwen3-tts-flash-realtime:Katerina'."\n"
.' - 墨讲师:qwen3-tts-flash-realtime:Elias'."\n"
.' - 上海-阿珍:qwen3-tts-flash-realtime:Jada'."\n"
.' - 北京-晓东:qwen3-tts-flash-realtime:Dylan'."\n"
.' - 四川-晴儿:qwen3-tts-flash-realtime:Sunny'."\n"
.' - 南京-老李:qwen3-tts-flash-realtime:Li'."\n"
.' - 陕西-秦川:qwen3-tts-flash-realtime:Marcus'."\n"
.' - 闽南-阿杰:qwen3-tts-flash-realtime:Roy'."\n"
.' - 天津-李彼得:qwen3-tts-flash-realtime:Peter'."\n"
.' - 粤语-阿强:qwen3-tts-flash-realtime:Rocky'."\n"
.' - 粤语-阿清:qwen3-tts-flash-realtime:Kiki'."\n"
.' - 四川-程川:qwen3-tts-flash-realtime:Eric'."\n"
.' - 苏瑶:qwen3-tts-flash-realtime:Serena'."\n"
.' - 千雪:qwen3-tts-flash-realtime:Chelsie'."\n"
.' - 茉兔:qwen3-tts-flash-realtime:Momo'."\n"
.' - 十三:qwen3-tts-flash-realtime:Vivian'."\n"
.' - 月白:qwen3-tts-flash-realtime:Moon'."\n"
.' - 四月:qwen3-tts-flash-realtime:Maia'."\n"
.' - 凯:qwen3-tts-flash-realtime:Kai'."\n"
.' - 萌宝:qwen3-tts-flash-realtime:Bella'."\n"
.' - 艾登:qwen3-tts-flash-realtime:Aiden'."\n"
.' - 沧明子:qwen3-tts-flash-realtime:Eldric Sage'."\n"
.' - 乖小妹:qwen3-tts-flash-realtime:Mia'."\n"
.' - 沙小弥:qwen3-tts-flash-realtime:Mochi'."\n"
.' - 燕铮莺:qwen3-tts-flash-realtime:Bellona'."\n"
.' - 田叔:qwen3-tts-flash-realtime:Vincent'."\n"
.' - 萌小姬:qwen3-tts-flash-realtime:Bunny'."\n"
.' - 阿闻:qwen3-tts-flash-realtime:Neil'."\n"
.' - 徐大爷:qwen3-tts-flash-realtime:Arthur'."\n"
.' - 邻家妹妹:qwen3-tts-flash-realtime:Nini'."\n"
.' - 诡婆婆:qwen3-tts-flash-realtime:Ebona'."\n"
.' - 小婉:qwen3-tts-flash-realtime:Seren'."\n"
.' - 顽屁小孩:qwen3-tts-flash-realtime:Pip'."\n"
.' - 少女阿月:qwen3-tts-flash-realtime:Stella'."\n"
.' - 博德加:qwen3-tts-flash-realtime:Bodega'."\n"
.' - 索尼莎:qwen3-tts-flash-realtime:Sonrisa'."\n"
.' - 阿列克:qwen3-tts-flash-realtime:Alek'."\n"
.' - 多尔切:qwen3-tts-flash-realtime:Dolce'."\n"
.' - 素熙:qwen3-tts-flash-realtime:Sohee'."\n"
.' - 小野杏:qwen3-tts-flash-realtime:Ono Anna'."\n"
.' - 莱恩:qwen3-tts-flash-realtime:Lenn'."\n"
.' - 埃米尔安:qwen3-tts-flash-realtime:Emilien'."\n"
.' - 安德雷:qwen3-tts-flash-realtime:Andre'."\n"
.' - 拉迪奥·戈尔:qwen3-tts-flash-realtime:Radio Gol'."\n"
."\n"
.'- 通用:'."\n"
.' - 知媛:zhiyuan'."\n"
.' - 知悦:zhiyue'."\n"
.' - 知莎:zhistella'."\n"
.' - 知达:zhida'."\n"
.' - 艾琪:aiqi'."\n"
.' - 艾诚:aicheng'."\n"
.' - 艾佳:aijia'."\n"
.' - 思琪:siqi'."\n"
.' - 思佳:sijia'."\n"
.' - 马树:mashu'."\n"
.' - 悦儿:yuer'."\n"
.' - 若兮:ruoxi'."\n"
.' - 艾达:aida'."\n"
.' - 思诚:sicheng'."\n"
.' - 宁儿:ninger'."\n"
.' - 小云:xiaoyun'."\n"
.' - 小刚:xiaogang'."\n"
.' - 瑞琳:ruilin'."\n"
."\n"
.'- 客服:'."\n"
.' - 知雅:zhiya'."\n"
.' - 艾悦:aiyue'."\n"
.' - 艾雅:aiya'."\n"
.' - 艾婧:aijing'."\n"
.' - 艾美:aimei'."\n"
.' - 思悦:siyue'."\n"
.' - 艾娜:Aina'."\n"
.' - 艾硕:aishuo'."\n"
.' - 艾雨:aiyu'."\n"
.' - 小美:xiaomei'."\n"
.' - 伊娜:yina'."\n"
.' - 思婧:sijing'."\n"
."\n"
.'- 多情感:'."\n"
.' - 知冰:zhibing_emo'."\n"
.' - 知锋:zhifeng_emo'."\n"
.' - 知妙_多情感:zhimiao_emo'."\n"
.' - 知米_多情感:zhimi_emo'."\n"
.' - 知贝_多情感:zhibei_emo'."\n"
.' - 知燕_多情感:zhiyan_emo'."\n"
.' - 知甜_多情感:zhitian_emo'."\n"
."\n"
.'- 数字人:'."\n"
.' - 艾夏:aixia'."\n"
.' - 知柜:zhigui'."\n"
.' - 知硕:zhishuo'."\n"
.' - Cally:cally'."\n"
.' - 知小白:zhixiaobai'."\n"
.' - 知小夏:zhixiaoxia'."\n"
.' - 知小妹:zhixiaomei'."\n"
."\n"
.'- 多语种:'."\n"
.' - Clara:clara'."\n"
.' - Hanna:hanna'."\n"
.' - Waan:waan'."\n"
.' - Camila:camila'."\n"
.' - Perla:perla'."\n"
.' - masha:masha'."\n"
.' - Kyong:kyong'."\n"
.' - Tien:tien'."\n"
.' - 智香:tomoka'."\n"
.' - 智也:tomoya'."\n"
.' - Indah:indah'."\n"
.' - Farah:farah'."\n"
.' - Tala:tala'."\n"
."\n"
.'- 超高清:'."\n"
.' - 知甜:zhitian'."\n"
.' - 知青:zhiqing'."\n"
."\n"
.'- 直播:'."\n"
.' - 知猫:zhimao'."\n"
.' - 老妹:laomei'."\n"
.' - 老铁:laotie'."\n"
.' - 小仙:xiaoxian'."\n"
.' - 柜姐:guijie'."\n"
.' - Stella:stella'."\n"
.' - 猫小美:maoxiaomei'."\n"
.' - 巧薇:qiaowei'."\n"
.' - 艾伦:ailun'."\n"
.' - 艾飞:aifei'."\n"
.' - 亚群:yaqun'."\n"
.' - Stanley:stanley'."\n"
.' - Kenny:kenny'."\n"
.' - Rosa:rosa'."\n"
."\n"
.'- 童声:'."\n"
.' - 艾彤:aitong'."\n"
.' - 艾薇:aiwei'."\n"
.' - 杰力豆:jielidou'."\n"
.' - 小北:xiaobei'."\n"
.' - 思彤:sitong'."\n"
.' - 艾宝:aibao'."\n"
."\n"
.'- 方言:'."\n"
.' - Kelly:kelly'."\n"
.' - 佳佳:jiajia'."\n"
.' - 大虎:dahu'."\n"
.' - 艾侃:aikan'."\n"
.' - 桃子:taozi'."\n"
.' - 青青:qingqing'."\n"
.' - 翠姐:cuijie'."\n"
.' - 小泽:xiaoze'."\n"
.' - 姗姗:shanshan'."\n"
.' - 小玥:xiaoyue'."\n"
."\n"
.'- 英文:'."\n"
.' - Betty:betty'."\n"
.' - Beth:beth'."\n"
.' - Cindy:cindy'."\n"
.' - Donna:donna'."\n"
.' - Eva:eva'."\n"
.' - Brian:brian'."\n"
.' - ava:ava'."\n"
.' - Luca:Luca'."\n"
.' - Luna:Luna'."\n"
.' - Emily:Emily'."\n"
.' - Eric:Eric'."\n"
.' - Annie:annie'."\n"
.' - Andy:Andy'."\n"
.' - William:William'."\n"
.' - Abby:Abby'."\n"
.' - Lydia:Lydia'."\n"
.' - Olivia:Olivia'."\n"
.' - Wendy:Wendy'."\n"
.' - Harry:Harry'."\n"
."\n"
.' '."\n"
.''."\n"
.'doubao音色
'."\n"
."\n"
.'- 多情感:'."\n"
.' - 北京小爷:zh_male_beijingxiaoye_emo_v2_mars_bigtts'."\n"
.' - 柔美女友:zh_female_roumeinvyou_emo_v2_mars_bigtts'."\n"
.' - 阳光青年:zh_male_yangguangqingnian_emo_v2_mars_bigtts'."\n"
.' - 魅力女友:zh_female_meilinvyou_emo_v2_mars_bigtts'."\n"
.' - 爽快思思:zh_female_shuangkuaisisi_emo_v2_mars_bigtts'."\n"
.'- 通用场景:'."\n"
.' - 灿灿/Shiny:zh_female_cancan_mars_bigtts'."\n"
.' - 清新女声\':zh_female_qingxinnvsheng_mars_bigtts'."\n"
.' - 爽快思思/Skye:zh_female_shuangkuaisisi_moon_bigtts'."\n"
.' - 温暖阿虎/Alvin:zh_male_wennuanahu_moon_bigtts'."\n"
.' - 少年梓辛/Brayan:zh_male_shaonianzixin_moon_bigtts'."\n"
.' - 知性女声:zh_female_zhixingnvsheng_mars_bigtts'."\n"
.' - 清爽男大:zh_male_qingshuangnanda_mars_bigtts'."\n"
.' - 邻家女孩:zh_female_linjianvhai_moon_bigtts'."\n"
.' - 渊博小叔:zh_male_yuanboxiaoshu_moon_bigtts'."\n"
.' - 阳光青年:zh_male_yangguangqingnian_moon_bigtts'."\n"
.' - 甜美小源:zh_female_tianmeixiaoyuan_moon_bigtts'."\n"
.' - 清澈梓梓:zh_female_qingchezizi_moon_bigtts'."\n"
.' - 解说小明:zh_male_jieshuoxiaoming_moon_bigtts'."\n"
.' - 开朗姐姐:zh_female_kailangjiejie_moon_bigtts'."\n"
.' - 邻家男孩:zh_male_linjiananhai_moon_bigtts'."\n"
.' - 甜美悦悦:zh_female_tianmeiyueyue_moon_bigtts'."\n"
.' - 心灵鸡汤:zh_female_xinlingjitang_moon_bigtts'."\n"
.' - 知性温婉:ICL_zh_female_zhixingwenwan_tob'."\n"
.' - 暖心体贴:ICL_zh_male_nuanxintitie_tob'."\n"
.' - 温柔文雅:ICL_zh_female_wenrouwenya_tob'."\n"
.' - 开朗轻快:ICL_zh_male_kailangqingkuai_tob'."\n"
.' - 活泼爽朗:ICL_zh_male_huoposhuanglang_tob'."\n"
.' - 率真小伙:ICL_zh_male_shuaizhenxiaohuo_tob'."\n"
.' - 温柔小哥:zh_male_wenrouxiaoge_mars_bigtts'."\n"
.'- 多语种:'."\n"
.' - Smith:en_male_smith_mars_bigtts'."\n"
.' - Anna:en_female_anna_mars_bigtts'."\n"
.' - Adam:en_male_adam_mars_bigtts'."\n"
.' - Sarah:en_female_sarah_mars_bigtts'."\n"
.' - Dryw:en_male_dryw_mars_bigtts'."\n"
.' - かずね(和音)/Javier or Álvaro:multi_male_jingqiangkanye_moon_bigtts'."\n"
.' - はるこ(晴子)/Esmeralda:multi_female_shuangkuaisisi_moon_bigtts'."\n"
.' - ひろし(広志)/Roberto:multi_male_wanqudashu_moon_bigtts'."\n"
.' - あけみ(朱美):multi_female_gaolengyujie_moon_bigtts'."\n"
.' - Amanda:en_female_amanda_mars_bigtts'."\n"
.' - Jackson:en_male_jackson_mars_bigtts'."\n"
.'- 趣味口音:'."\n"
.' - 京腔侃爷 / Harmony:zh_male_jingqiangkanye_moon_bigtts'."\n"
.' - 湾湾小何:zh_female_wanwanxiaohe_moon_bigtts'."\n"
.' - 湾区大叔:zh_female_wanqudashu_moon_bigtts'."\n"
.' - 呆萌川妹:zh_female_daimengchuanmei_moon_bigtts'."\n"
.' - 广州德哥:zh_male_guozhoudege_moon_bigtts'."\n"
.' - 北京小爷:zh_male_beijingxiaoye_moon_bigtts'."\n"
.' - 浩宇小哥:zh_male_haoyuxiaoge_moon_bigtts'."\n"
.' - 广西远舟:zh_male_guangxiyuanzhou_moon_bigtts'."\n"
.' - 妹坨洁儿:zh_female_meituojieer_moon_bigtts'."\n"
.' - 豫州子轩:zh_male_yuzhouzixuan_moon_bigtts'."\n"
.'- 角色扮演:'."\n"
.' - 奶气萌娃:zh_male_naiqimengwa_mars_bigtts'."\n"
.' - 婆婆:zh_female_popo_mars_bigtts'."\n"
.' - 高冷御姐:zh_female_gaolengyujie_moon_bigtts'."\n"
.' - 傲娇霸总:zh_male_aojiaobazong_moon_bigtts'."\n"
.' - 魅力女友:zh_female_meilinvyou_moon_bigtts'."\n"
.' - 深夜播客:zh_male_shenyeboke_moon_bigtts'."\n"
.' - 柔美女友:zh_female_sajiaonvyou_moon_bigtts'."\n"
.' - 撒娇学妹:zh_female_yuanqinvyou_moon_bigtts'."\n"
.' - 病弱少女:ICL_zh_female_bingruoshaonv_tob'."\n"
.' - 活泼女孩:ICL_zh_female_huoponvhai_tob'."\n"
.' - 东方浩然:zh_male_dongfanghaoran_moon_bigtts'."\n"
.' - 绿茶小哥:ICL_zh_male_lvchaxiaoge_tob'."\n"
.' - 娇弱萝莉:ICL_zh_female_jiaoruoluoli_tob'."\n"
.' - 冷淡疏离:ICL_zh_male_lengdanshuli_tob'."\n"
.' - 憨厚敦实:ICL_zh_male_hanhoudunshi_tob'."\n"
.' - 傲气凌人:ICL_zh_male_aiqilingren_tob'."\n"
.' - 活泼刁蛮:ICL_zh_female_huopodiaoman_tob'."\n"
.' - 固执病娇:ICL_zh_male_guzhibingjiao_tob'."\n"
.' - 撒娇粘人:ICL_zh_male_sajiaonianren_tob'."\n"
.' - 傲慢娇声:ICL_zh_female_aomanjiaosheng_tob'."\n"
.' - 潇洒随性:ICL_zh_male_xiaosasuixing_tob'."\n"
.' - 腹黑公子:ICL_zh_male_fuheigongzi_tob'."\n"
.' - 诡异神秘:ICL_zh_male_guiyishenmi_tob'."\n"
.' - 儒雅才俊:ICL_zh_male_ruyacaijun_tob'."\n"
.' - 病娇白莲:ICL_zh_male_bingjiaobailian_tob'."\n"
.' - 正直青年:ICL_zh_male_zhengzhiqingnian_tob'."\n"
.' - 娇憨女王:ICL_zh_female_jiaohannvwang_tob'."\n"
.' - 病娇萌妹:ICL_zh_female_bingjiaomengmei_tob'."\n"
.' - 青涩小生:ICL_zh_male_qingsenaigou_tob'."\n"
.' - 纯真学弟:ICL_zh_male_chunzhenxuedi_tob'."\n"
.' - 暖心学姐:ICL_zh_female_nuanxinxuejie_tob'."\n"
.' - 可爱女生:ICL_zh_female_keainvsheng_tob'."\n"
.' - 成熟姐姐:ICL_zh_female_chengshujiejie_tob'."\n"
.' - 病娇姐姐:ICL_zh_female_bingjiaojiejie_tob'."\n"
.' - 优柔帮主:ICL_zh_male_youroubangzhu_tob'."\n"
.' - 优柔公子:ICL_zh_male_yourougongzi_tob'."\n"
.' - 妩媚御姐:ICL_zh_female_wumeiyujie_tob'."\n"
.' - 调皮公主:ICL_zh_female_tiaopigongzhu_tob'."\n"
.' - 傲娇女友:ICL_zh_female_aojiaonvyou_tob'."\n"
.' - 贴心男友:ICL_zh_male_tiexinnanyou_tob'."\n"
.' - 少年将军:ICL_zh_male_shaonianjiangjun_tob'."\n"
.' - 贴心女友:ICL_zh_female_tiexinnvyou_tob'."\n"
.' - 病娇哥哥:ICL_zh_male_bingjiaogege_tob'."\n"
.' - 学霸男同桌:ICL_zh_male_xuebanantongzhuo_tob'."\n"
.' - 幽默叔叔:ICL_zh_male_youmoshushu_tob'."\n"
.' - 性感御姐:ICL_zh_female_xingganyujie_tob'."\n"
.' - 假小子:ICL_zh_female_jiaxiaozi_tob'."\n"
.' - 冷峻上司:ICL_zh_male_lengjunshangsi_tob'."\n"
.' - 温柔男同桌:ICL_zh_male_wenrounantongzhuo_tob'."\n"
.' - 病娇弟弟:ICL_zh_male_bingjiaodidi_tob'."\n"
.' - 幽默大爷:ICL_zh_male_youmodaye_tob'."\n"
.' - 傲慢少爷:ICL_zh_male_aomanshaoye_tob'."\n"
.' - 神秘法师:ICL_zh_male_shenmifashi_tob'."\n"
.'- 视频配音:'."\n"
.' - 和蔼奶奶:ICL_zh_female_heainainai_tob'."\n"
.' - 邻居阿姨:ICL_zh_female_linjuayi_tob'."\n"
.' - 温柔小雅:zh_female_wenrouxiaoya_moon_bigtts'."\n"
.' - 天才童声:zh_male_tiancaitongsheng_mars_bigtts'."\n"
.' - 猴哥:zh_male_sunwukong_mars_bigtts'."\n"
.' - 熊二:zh_male_xionger_mars_bigtts'."\n"
.' - 佩奇猪:zh_female_peiqi_mars_bigtts'."\n"
.' - 武则天:zh_female_wuzetian_mars_bigtts'."\n"
.' - 顾姐:zh_female_gujie_mars_bigtts'."\n"
.' - 樱桃丸子:zh_female_yingtaowanzi_mars_bigtts'."\n"
.' - 广告解说:zh_male_chunhui_mars_bigtts'."\n"
.' - 少儿故事:zh_female_shaoergushi_mars_bigtts'."\n"
.' - 四郎:zh_male_silang_mars_bigtts'."\n"
.' - 磁性解说男声 / Morgan:zh_male_jieshuonansheng_mars_bigtts'."\n"
.' - 鸡汤妹妹 / Hope:zh_female_jitangmeimei_mars_bigtts'."\n"
.' - 贴心女声 / Candy:zh_female_tiexinnvsheng_mars_bigtts'."\n"
.' - 俏皮女声:zh_female_qiaopinvsheng_mars_bigtts'."\n"
.' - 萌丫头 / Cutey:zh_female_mengyatou_mars_bigtts'."\n"
.' - 懒音绵宝:zh_male_lanxiaoyang_mars_bigtts'."\n"
.' - 亮嗓萌仔:zh_male_dongmanhaimian_mars_bigtts'."\n"
.'- 有声阅读:'."\n"
.' - 悬疑解说:zh_male_changtianyi_mars_bigtts'."\n"
.' - 儒雅青年:zh_male_ruyaqingnian_mars_bigtts'."\n"
.' - 霸气青叔:zh_male_baqiqingshu_mars_bigtts'."\n"
.' - 擎苍:zh_male_qingcang_mars_bigtts'."\n"
.' - 活力小哥:zh_male_yangguangqingnian_mars_bigtts'."\n"
.' - 古风少御:zh_female_gufengshaoyu_mars_bigtts'."\n"
.' - 温柔淑女:zh_female_wenroushunv_mars_bigtts'."\n"
.' - 反卷青年:zh_male_fanjuanqingnian_mars_bigtts'."\n"
."\n\n"
.' ',
'changeSet' => [
[
'createdAt' => '2024-08-28T12:13:12.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2024-02-04T14:18:22.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2023-03-07T13:33:57.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2021-12-15T07:48:20.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeTTSDemo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeTagHitsSummary' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '292eba45-df08-4065-87e7-7e587a1ce4ce',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息。',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '5391EB13-A0E7-402D-A407-B99D4ABAF22A',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'TagGroups' => [
'description' => '标签组信息',
'type' => 'array',
'items' => [
'description' => '标签组信息',
'type' => 'object',
'properties' => [
'TagGroupIndex' => [
'description' => '标签组索引',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'TagGroup' => [
'description' => '标签组名称',
'type' => 'string',
'example' => '标签组',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => '8a4c6d3d-5ed6-44ca-b779-16c20f8862be',
],
'Id' => [
'description' => 'ID',
'type' => 'string',
'example' => '8bb6f8ca-85a3-49f8-86a5-3127902a2156',
],
],
],
],
'TagHitsList' => [
'description' => '命中标签信息',
'type' => 'array',
'items' => [
'description' => '命中标签信息',
'type' => 'object',
'properties' => [
'HitCount' => [
'description' => '命中数量',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TagGroup' => [
'description' => '标签组名称',
'type' => 'string',
'example' => '当前学历',
],
'TagName' => [
'description' => '标签名称',
'type' => 'string',
'example' => '本科',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.JobGroup',
'errorMessage' => 'The specified JobGroup does not exist.',
'description' => '指定的任务组不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"5391EB13-A0E7-402D-A407-B99D4ABAF22A\\",\\n \\"Success\\": true,\\n \\"TagGroups\\": [\\n {\\n \\"TagGroupIndex\\": 0,\\n \\"TagGroup\\": \\"标签组\\",\\n \\"ScriptId\\": \\"8a4c6d3d-5ed6-44ca-b779-16c20f8862be\\",\\n \\"Id\\": \\"8bb6f8ca-85a3-49f8-86a5-3127902a2156\\"\\n }\\n ],\\n \\"TagHitsList\\": [\\n {\\n \\"HitCount\\": 1,\\n \\"TagGroup\\": \\"当前学历\\",\\n \\"TagName\\": \\"本科\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询标签统计数据-旧画布接口',
'summary' => '查询标签统计数据,旧画布接口。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeTagHitsSummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DescribeTenantBindNumber' => [
'summary' => '租户下的号码绑定实例的情况列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '120937',
'abilityTreeNodes' => [
'FEATUREoutboundbot85J9KC',
],
],
'parameters' => [
[
'name' => 'Number',
'in' => 'query',
'schema' => [
'description' => '绑定的号码(必填)'."\n"
."\n"
.'> 查询对应号码在所有的实例中绑定情况。号码通过ListAllTenantBindNumberBinding的返回参数获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '15005059355',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'List' => [
'description' => '作业组描述',
'type' => 'array',
'items' => [
'description' => '数据',
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'e2d7a184-7d6c-45d4-ac24-34ab48f54669',
],
'InstanceName' => [
'description' => '实例名字',
'type' => 'string',
'example' => 'xxxx',
],
'IsBinding' => [
'title' => '是否是绑定状态',
'description' => '是否是绑定状态',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '1364f208-982d-4d0c-89aa-d56e22b47589',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"e2d7a184-7d6c-45d4-ac24-34ab48f54669\\",\\n \\"InstanceName\\": \\"xxxx\\",\\n \\"IsBinding\\": true\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1364f208-982d-4d0c-89aa-d56e22b47589\\"\\n}","type":"json"}]',
'title' => '租户下的号码绑定业务的情况',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-03-01T12:36:05.000Z',
'description' => 'OpenAPI 下线',
],
],
'flowControl' => [
'flowControlList' => [
[
'threshold' => '1000',
'countWindow' => 1,
'regionId' => '*',
'api' => 'DescribeTenantBindNumber',
],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:TenantBindNumber',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'Dialogue' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'CallId',
'in' => 'query',
'schema' => [
'description' => '呼叫ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1528189846043',
],
],
[
'name' => 'CallType',
'in' => 'query',
'schema' => [
'description' => '呼叫类型,一般Outbound',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Outbound',
],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => false,
'example' => '6cea9bed-63e6-439e-ae4c-b3333efff53d',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID',
'type' => 'string',
'required' => false,
'example' => 'ff44709e-39a6-43ba-959b-20fcabe3e496',
],
],
[
'name' => 'Utterance',
'in' => 'query',
'schema' => [
'description' => '用户表述',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '是的',
],
],
[
'name' => 'ActionKey',
'in' => 'query',
'schema' => [
'description' => '外呼需要执行的动作,Hangup 挂机',
'type' => 'string',
'required' => false,
'example' => 'broadcast',
],
],
[
'name' => 'ActionParams',
'in' => 'query',
'schema' => [
'description' => '执行动作需要的参数(已废弃)',
'type' => 'string',
'required' => false,
'example' => '""',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => [
'description' => '主叫号码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1***6',
],
],
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => [
'description' => '被叫号码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '135****4353',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => false,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Feedback' => [
'description' => '返回对话信息',
'type' => 'object',
'properties' => [
'Action' => [
'description' => '给IVR的指令',
'type' => 'string',
'example' => 'broadcast',
],
'ActionParams' => [
'description' => '指令参数',
'type' => 'string',
'example' => '""',
],
'Content' => [
'description' => '对话文本',
'type' => 'string',
'example' => '你好,我是**客服',
],
'Interruptible' => [
'description' => '是否可以打断播报',
'type' => 'boolean',
'example' => 'true',
],
'ContentParams' => [
'description' => '已废弃',
'type' => 'string',
'example' => '“”',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Feedback\\": {\\n \\"Action\\": \\"broadcast\\",\\n \\"ActionParams\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Content\\": \\"你好,我是**客服\\",\\n \\"Interruptible\\": true,\\n \\"ContentParams\\": \\"“”\\"\\n }\\n}","type":"json"}]',
'title' => '和机器人对话',
'summary' => 'CC回调外呼的机器人对话接口。(已废弃)。',
'changeSet' => [
[
'createdAt' => '2024-07-22T12:24:22.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2022-12-29T14:17:10.000Z',
'description' => '响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:Dialogue',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DownloadRecording' => [
'summary' => '下载通话录音。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94084',
'abilityTreeNodes' => [
'FEATUREoutboundbot3SV6AU',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'da37319b-6c83-4268-9f19-814aed62e401',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '通话ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '744b27f3-437f-4a8c-a181-f668e492fd24',
],
],
[
'name' => 'NeedVoiceSliceRecording',
'in' => 'query',
'schema' => [
'description' => '是否查询分段录音',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'DownloadParams' => [
'description' => '文档下载地址',
'type' => 'object',
'properties' => [
'SignatureUrl' => [
'description' => '一个指向录音文件的URL,使用HTTP下载',
'type' => 'string',
'example' => 'http://tiangong-staging.oss-cn-shanghai.aliyuncs.com/record/281eb174-3865-41c1-9274-7b6813edadab.wav?Expires=1578624046&OSSAccessKeyId=LTAI****cqw&Signature=dL2dxWS6VcdZrvG9xOMOBMSP3Fg%3D',
],
'FileName' => [
'description' => '录音文件名,通常为一个uuid',
'type' => 'string',
'example' => '281eb174-3865-41c1-9274-7b6813edadab.wav',
],
'VoiceSliceRecordingListJson' => [
'description' => '分段录音列表,包含文件名和文件URL',
'type' => 'string',
'example' => '[{"fileName":"10a17c447415424c99491884abe27d8a-1.wav","filePath":"https://ssml-test.oss-cn-shanghai.aliyuncs.com/7253/voiceSlice/10a17c447415424c99491884abe27d8a/10a17c447415424c99491884abe27d8a-1.wav?Expires=1686645470&OSSAccessKeyId=LTA*********kr8M9&Signature=V23OhiV5yIOoouriu6SiWkO9h8E%3D"}]',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"DownloadParams\\": {\\n \\"SignatureUrl\\": \\"http://tiangong-staging.oss-cn-shanghai.aliyuncs.com/record/281eb174-3865-41c1-9274-7b6813edadab.wav?Expires=1578624046&OSSAccessKeyId=LTAI****cqw&Signature=dL2dxWS6VcdZrvG9xOMOBMSP3Fg%3D\\",\\n \\"FileName\\": \\"281eb174-3865-41c1-9274-7b6813edadab.wav\\",\\n \\"VoiceSliceRecordingListJson\\": \\"[{\\\\\\"fileName\\\\\\":\\\\\\"10a17c447415424c99491884abe27d8a-1.wav\\\\\\",\\\\\\"filePath\\\\\\":\\\\\\"https://ssml-test.oss-cn-shanghai.aliyuncs.com/7253/voiceSlice/10a17c447415424c99491884abe27d8a/10a17c447415424c99491884abe27d8a-1.wav?Expires=1686645470&OSSAccessKeyId=LTA*********kr8M9&Signature=V23OhiV5yIOoouriu6SiWkO9h8E%3D\\\\\\"}]\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n \\n http://tiangong-staging.oss-cn-shanghai.aliyuncs.com/record/281eb174-3865-41c1-9274-7b6813edadab.wav?Expires=1578624046&OSSAccessKeyId=LTAI****cqw&Signature=dL2dxWS6VcdZrvG9xOMOBMSP3Fg%3D\\n 281eb174-3865-41c1-9274-7b6813edadab.wav\\n [{\\"fileName\\":\\"10a17c447415424c99491884abe27d8a-1.wav\\",\\"filePath\\":\\"https://ssml-test.oss-cn-shanghai.aliyuncs.com/7253/voiceSlice/10a17c447415424c99491884abe27d8a/10a17c447415424c99491884abe27d8a-1.wav?Expires=1686645470&OSSAccessKeyId=LTA*********kr8M9&Signature=V23OhiV5yIOoouriu6SiWkO9h8E%3D\\"}]\\n \\n","errorExample":""}]',
'title' => '下载通话录音',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DownloadCabRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DownloadScriptRecording' => [
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '161708',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'b3865dc3-40fa-4afd-9fe4-dc7cda305a24',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '录音所在场景ID',
'type' => 'string',
'required' => true,
'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17',
],
],
[
'name' => 'Uuid',
'in' => 'query',
'schema' => [
'description' => '录音唯一ID',
'type' => 'string',
'required' => true,
'example' => '5feaab8a-97fd-4720-8108-79e017f2d3ac',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'DownloadParams' => [
'description' => '参数',
'type' => 'object',
'properties' => [
'SignatureUrl' => [
'description' => '一个指向录音文件的url,可使用该地址播放或下载。',
'type' => 'string',
'example' => 'http://tiangong-staging.oss-cn-shanghai.aliyuncs.com/record/281eb174-3865-41c1-9274-7b6813edadab.wav?Expires=1578624046&OSSAccessKeyId=LTAI****cqw&Signature=dL2dxWS6VcdZrvG9xOMOBMSP3Fg%3D',
],
'FileName' => [
'description' => '录音文件名称',
'type' => 'string',
'example' => '281eb174-3865-41c1-9274-7b6813edadab.wav',
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"DownloadParams\\": {\\n \\"SignatureUrl\\": \\"http://tiangong-staging.oss-cn-shanghai.aliyuncs.com/record/281eb174-3865-41c1-9274-7b6813edadab.wav?Expires=1578624046&OSSAccessKeyId=LTAI****cqw&Signature=dL2dxWS6VcdZrvG9xOMOBMSP3Fg%3D\\",\\n \\"FileName\\": \\"281eb174-3865-41c1-9274-7b6813edadab.wav\\"\\n }\\n}","type":"json"}]',
'title' => '【小模型接口】下载录音(获取录音地址)',
'summary' => '下载录音(获取录音地址),小模型场景专用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DownloadScriptRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'DuplicateScript' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399',
],
],
[
'name' => 'SourceScriptId',
'in' => 'query',
'schema' => [
'description' => '源场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '6114e7e8-4140-48d9-b46d-65ea29f13fe8',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '新场景名字',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '复制的催收话术',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'True',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => '6114e7e8-4140-48d9-b46d-65ea29f13fe8',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"ScriptId\\": \\"6114e7e8-4140-48d9-b46d-65ea29f13fe8\\"\\n}","type":"json"}]',
'title' => '【旧画布接口】复制话术',
'summary' => '从原有的话术复制一个新的话术(旧画布专用)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:DuplicateScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ExportScript' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'DownloadParams' => [
'description' => '下载话术的签名URL信息(仅旧画布会返回)',
'type' => 'object',
'properties' => [
'SignatureUrl' => [
'description' => '下载地址(仅旧画布会返回)'."\n"
."\n\n"
."\n"
.'>**非旧画布**: 导出场景任务后,通过**ListDownloadTasks**获取"TaskId": "5d352db754fe430xxxxxxx"、"FileId": "5d000f3f6eae4228b2731427xxxxxx",再通过**CreateDownloadUrl**接口获取下载url。',
'type' => 'string',
'example' => 'http://tiangong-staging.oss-cn-shanghai.aliyuncs.com/record/281eb174-3865-41c1-9274-7b6813edadab.wav?Expires=1578624046&OSSAccessKeyId=LTAI****cqw&Signature=dL2dxWS6VcdZrvG9xOMOBMSP3Fg%3D',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"DownloadParams\\": {\\n \\"SignatureUrl\\": \\"http://tiangong-staging.oss-cn-shanghai.aliyuncs.com/record/281eb174-3865-41c1-9274-7b6813edadab.wav?Expires=1578624046&OSSAccessKeyId=LTAI****cqw&Signature=dL2dxWS6VcdZrvG9xOMOBMSP3Fg%3D\\"\\n }\\n}","type":"json"}]',
'title' => '创建导出场景任务',
'summary' => '导出一个场景。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:ExportScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GenerateUploadUrl' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '130155',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'Key',
'in' => 'query',
'schema' => [
'description' => '上传地址key',
'type' => 'string',
'required' => false,
'example' => '3b9b5dc6d67ee9fa',
],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'description' => '文件名,带扩展名。',
'type' => 'string',
'required' => false,
'example' => 'faaf8508-9542-4ac4-84a2-0ddcbb5f79a6 (2).json',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'True',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'AccessId' => [
'description' => 'OSS的访问ID',
'type' => 'string',
'example' => 'LTAIvKWEr4******',
],
'Policy' => [
'description' => '上传策略',
'type' => 'string',
'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0yNlQwMzo0ODo1My4wMzVaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJ1cGxvYWQvZmlsZS84NzRkNzM3MS03OTFiLTQyODEtOTM1Yy02Mzc2MzBhMzc3ODUvIl1dfQ==",',
],
'Signature' => [
'description' => '签名信息',
'type' => 'string',
'example' => 'I6d1ONWVuTj5i0Kz4Vn+V0lC6v4=',
],
'Folder' => [
'description' => '上传目录',
'type' => 'string',
'example' => 'pload/file/874d7371-791b-4281-935c-637630a37785/874d7371-791b-4281-935c-637630a37785_9bd7916d-a340-4925-a911-92390cbe0f33.json',
],
'Host' => [
'description' => '上传服务器url',
'type' => 'string',
'example' => 'https://cloudagentbot-online.oss-cn-hangzhou.aliyuncs.com',
],
'Expire' => [
'description' => '过期时间(秒)',
'type' => 'integer',
'format' => 'int32',
'example' => '1742960933',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'True',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
],
],
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"AccessId\\": \\"LTAIvKWEr4******\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0yNlQwMzo0ODo1My4wMzVaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJ1cGxvYWQvZmlsZS84NzRkNzM3MS03OTFiLTQyODEtOTM1Yy02Mzc2MzBhMzc3ODUvIl1dfQ==\\\\\\",\\",\\n \\"Signature\\": \\"I6d1ONWVuTj5i0Kz4Vn+V0lC6v4=\\",\\n \\"Folder\\": \\"pload/file/874d7371-791b-4281-935c-637630a37785/874d7371-791b-4281-935c-637630a37785_9bd7916d-a340-4925-a911-92390cbe0f33.json\\",\\n \\"Host\\": \\"https://cloudagentbot-online.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"Expire\\": 1742960933,\\n \\"Success\\": true,\\n \\"Message\\": \\"Success\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '上传热词表文件',
'summary' => '上传热词表文件。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:GenerateUploadUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetAfterAnswerDelayPlayback' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'EntryId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4',
],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => [
'description' => '策略级别(必填)'."\n"
."\n"
.'- 2:实例',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'AfterAnswerDelayPlayback' => [
'description' => '回复的延迟时间',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"AfterAnswerDelayPlayback\\": 1\\n}","type":"json"}]',
'title' => '查询接听后延迟播报时间',
'summary' => '获取接通后延迟放音时间。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAfterAnswerDelayPlayback',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetAgentProfile' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '230365',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => [
'title' => 'instance id',
'description' => '实例 ID',
'type' => 'string',
'required' => true,
'example' => '0ec0c897-b92c-40e4-9ad7-e6e4f5ce13bb',
],
],
[
'name' => 'AgentProfileId',
'in' => 'formData',
'schema' => [
'title' => 'agent profile id',
'description' => '智能体配置ID。'."\n"
.'> 可通过DescribeScript的返回参数ChatbotId获取已经创建场景的智能体配置ID',
'type' => 'string',
'required' => true,
'example' => 'd31794e2a51f47d2901b4094d88311d7',
],
],
[
'name' => 'AppIp',
'in' => 'formData',
'schema' => [
'title' => 'app_ip , POP设置',
'description' => 'app_ip(系统字段,可不填)',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'True',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '返回信息。',
'type' => 'string',
'example' => 'Success',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'CreateTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '1741338619000',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '1741338619000',
],
'AgentProfileId' => [
'title' => 'agent profile id',
'description' => '智能体配置 id',
'type' => 'string',
'example' => 'd31794e2a51f47d2901b4094d88311d7',
],
'InstanceId' => [
'title' => '实例id',
'description' => '实例id',
'type' => 'string',
'example' => '7f04f92c-ccfc-4f8f-a816-6902023be5c6',
],
'ScriptId' => [
'title' => 'script id',
'description' => '场景 id',
'type' => 'string',
'example' => 'd13ad2d3-3fe6-4352-b38b-bd6559047de8',
],
'AgentType' => [
'title' => 'agent type',
'description' => 'agent type',
'type' => 'string',
'example' => '""',
],
'PromptJson' => [
'title' => 'prompt json',
'description' => '智能体配置',
'type' => 'string',
'example' => '{"name":"小x","gender":"男","age":18,"role":"游戏推广员","communicationStyle":["亲切"],"goals":"你好","background":"不是很好","openingPrompt":"你好,我是xxx"}'."\n",
],
'Prompt' => [
'title' => 'prompt',
'description' => '提示词(专业模式)',
'type' => 'string',
'example' => '""',
],
'AgentProfileTemplateId' => [
'title' => 'agent template id',
'description' => '智能体配置模版 id',
'type' => 'string',
'example' => 'default-survey',
],
'Model' => [
'title' => '模型id',
'description' => '模型id',
'type' => 'string',
'example' => 'model_002',
],
'ModelConfig' => [
'title' => 'model config',
'description' => '模型配置',
'type' => 'string',
'example' => '{}',
],
'System' => [
'title' => '是否是系统模版',
'description' => '是否是系统模版',
'type' => 'boolean',
'example' => 'false',
],
'LabelsJson' => [
'title' => 'labels',
'description' => '标签描述',
'type' => 'string',
'example' => '[{\\"name\\":\\"是否送达\\",\\"description\\":\\"购买的家电是否已经送达\\",\\"valueList\\":\\"[\\\\\\"是\\\\\\",\\\\\\"否\\\\\\"]\\"},{\\"name\\":\\"预约上门时间\\",\\"description\\":\\"收集客户期望的上门安装时间\\",\\"valueList\\":\\"[]\\"}]'."\n",
],
'VariablesJson' => [
'title' => 'variables',
'description' => '变量配置',
'type' => 'string',
'example' => '[{\\"name\\":\\"name\\",\\"description\\":\\"客户姓名\\"},{\\"name\\":\\"gender\\",\\"description\\":\\"客户性别\\"}]'."\n",
],
'Scenario' => [
'title' => '场景',
'description' => '场景',
'type' => 'string',
'example' => '测试场景',
],
'Description' => [
'title' => '描述',
'description' => '描述',
'type' => 'string',
'example' => '这是一个大模型机器人',
],
'InstructionJson' => [
'description' => '指令配置',
'type' => 'string',
'example' => '[{"type":"TransferToAgent","instructions":[{"code":"Transfer0","skillGroupId":"123","skillGroupName":"123"}],"timeoutEnable":false},{"type":"CollectNumber","instructions":[]}]'."\n",
],
'ApiPluginJson' => [
'description' => 'api插件配置',
'type' => 'string',
'example' => '[]',
],
'NluConfigJson' => [
'description' => 'nlu配置,参数配置:'."\n"
.'- chatbotInstanceId 小蜜大模型机器人实例id'."\n"
.'- faqCategoryIds 绑定的faq类目id'."\n"
.'- llmAgentId 小蜜大模型业务空间id'."\n"
.'- llmAgentKey 小蜜大模型业务空间key'."\n"
.'- llmAgentInstanceId 小蜜大模型业务空间实例id',
'type' => 'string',
'example' => '{"chatbotInstanceId":"chatbot-cn-j7eiVJZRmb","faqCategoryIds":[30000474726],"llmAgentId":"1246206","llmAgentInstanceId":"outbound_05efb75a-95df-438e-9b9b-8f2c857d5498","llmAgentKey":"d682716514814815ae77757c0bcbda01_p_outbound_public"}'."\n",
],
],
],
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '7A573837-3AD3-54CF-930A-07A3287042C2',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExists.InstanceId',
'errorMessage' => 'The specified instance %s does not exist.',
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"CreateTime\\": \\"1741338619000\\",\\n \\"UpdateTime\\": \\"1741338619000\\",\\n \\"AgentProfileId\\": \\"d31794e2a51f47d2901b4094d88311d7\\",\\n \\"InstanceId\\": \\"7f04f92c-ccfc-4f8f-a816-6902023be5c6\\",\\n \\"ScriptId\\": \\"d13ad2d3-3fe6-4352-b38b-bd6559047de8\\",\\n \\"AgentType\\": \\"\\\\\\"\\\\\\"\\",\\n \\"PromptJson\\": \\"{\\\\\\"name\\\\\\":\\\\\\"小x\\\\\\",\\\\\\"gender\\\\\\":\\\\\\"男\\\\\\",\\\\\\"age\\\\\\":18,\\\\\\"role\\\\\\":\\\\\\"游戏推广员\\\\\\",\\\\\\"communicationStyle\\\\\\":[\\\\\\"亲切\\\\\\"],\\\\\\"goals\\\\\\":\\\\\\"你好\\\\\\",\\\\\\"background\\\\\\":\\\\\\"不是很好\\\\\\",\\\\\\"openingPrompt\\\\\\":\\\\\\"你好,我是xxx\\\\\\"}\\\\n\\",\\n \\"Prompt\\": \\"\\\\\\"\\\\\\"\\",\\n \\"AgentProfileTemplateId\\": \\"default-survey\\",\\n \\"Model\\": \\"model_002\\",\\n \\"ModelConfig\\": \\"{}\\",\\n \\"System\\": false,\\n \\"LabelsJson\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"是否送达\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"购买的家电是否已经送达\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"valueList\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"是\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"否\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"]\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"预约上门时间\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"收集客户期望的上门安装时间\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"valueList\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[]\\\\\\\\\\\\\\"}]\\\\n\\",\\n \\"VariablesJson\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"客户姓名\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"gender\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"客户性别\\\\\\\\\\\\\\"}]\\\\n\\",\\n \\"Scenario\\": \\"测试场景\\",\\n \\"Description\\": \\"这是一个大模型机器人\\",\\n \\"InstructionJson\\": \\"[{\\\\\\"type\\\\\\":\\\\\\"TransferToAgent\\\\\\",\\\\\\"instructions\\\\\\":[{\\\\\\"code\\\\\\":\\\\\\"Transfer0\\\\\\",\\\\\\"skillGroupId\\\\\\":\\\\\\"123\\\\\\",\\\\\\"skillGroupName\\\\\\":\\\\\\"123\\\\\\"}],\\\\\\"timeoutEnable\\\\\\":false},{\\\\\\"type\\\\\\":\\\\\\"CollectNumber\\\\\\",\\\\\\"instructions\\\\\\":[]}]\\\\n\\",\\n \\"ApiPluginJson\\": \\"[]\\",\\n \\"NluConfigJson\\": \\"{\\\\\\"chatbotInstanceId\\\\\\":\\\\\\"chatbot-cn-j7eiVJZRmb\\\\\\",\\\\\\"faqCategoryIds\\\\\\":[30000474726],\\\\\\"llmAgentId\\\\\\":\\\\\\"1246206\\\\\\",\\\\\\"llmAgentInstanceId\\\\\\":\\\\\\"outbound_05efb75a-95df-438e-9b9b-8f2c857d5498\\\\\\",\\\\\\"llmAgentKey\\\\\\":\\\\\\"d682716514814815ae77757c0bcbda01_p_outbound_public\\\\\\"}\\\\n\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"7A573837-3AD3-54CF-930A-07A3287042C2\\"\\n}","type":"json"}]',
'title' => '获取智能体配置',
'summary' => '获取智能体配置。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAgentProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetAgentProfileTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AgentProfileTemplateId',
'in' => 'formData',
'schema' => [
'title' => '模板ID',
'description' => '智能体模板ID',
'type' => 'string',
'required' => true,
'example' => 'default-survey',
],
],
[
'name' => 'AppIp',
'in' => 'formData',
'schema' => [
'title' => 'app_ip , POP设置',
'description' => 'app_ip (系统字段,可不填)',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'CreateTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '1720766491000',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '1720766491000',
],
'AgentProfileTemplateId' => [
'title' => 'agent template id',
'description' => '智能体模版id',
'type' => 'string',
'example' => 'default-survey',
],
'Name' => [
'title' => 'agent profile template name',
'description' => '智能体配置模版名称',
'type' => 'string',
'example' => '问卷调查',
],
'Description' => [
'title' => 'agent profile template description',
'description' => '智能体配置模版描述',
'type' => 'string',
'example' => '说明',
],
'PromptSchema' => [
'title' => 'prompt schema',
'description' => '智能体模版配置',
'type' => 'string',
'example' => '{'."\n"
.' "name": "promptSchema",'."\n"
.' "properties": {'."\n"
.' "name": {'."\n"
.' "displayOrder": 1,'."\n"
.' "displayName": "名称",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "如:云小宝",'."\n"
.' "rows": 1'."\n"
.' },'."\n"
.' "group": "人物与风格",'."\n"
.' "maxLength": 100'."\n"
.' },'."\n"
.' "gender": {'."\n"
.' "displayOrder": 2,'."\n"
.' "displayName": "性别",'."\n"
.' "description": "此选项不会改变男女声音色,如需修改,请在【语音&VUI】中的TTS音色模版中修改",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "SELECT",'."\n"
.' "attributes": {'."\n"
.' "dataSource": ['."\n"
.' "男",'."\n"
.' "女",'."\n"
.' "不指定"'."\n"
.' ]'."\n"
.' },'."\n"
.' "group": "人物与风格",'."\n"
.' "maxLength": 100'."\n"
.' },'."\n"
.' "age": {'."\n"
.' "displayOrder": 3,'."\n"
.' "displayName": "年龄",'."\n"
.' "dataType": "LONG",'."\n"
.' "editorType": "NUMBER",'."\n"
.' "attributes": {'."\n"
.' "innerAfter": "岁"'."\n"
.' },'."\n"
.' "group": "人物与风格",'."\n"
.' "maximum": 60,'."\n"
.' "minimum": 18'."\n"
.' },'."\n"
.' "role": {'."\n"
.' "displayOrder": 3,'."\n"
.' "displayName": "身份",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "SELECTABLE_TAGS",'."\n"
.' "attributes": {'."\n"
.' "mode": "single",'."\n"
.' "dataSource": ['."\n"
.' "游戏推广员",'."\n"
.' "活动运营员",'."\n"
.' "医疗助理",'."\n"
.' "审计专员",'."\n"
.' "保险专员",'."\n"
.' "行政助理"'."\n"
.' ]'."\n"
.' },'."\n"
.' "group": "人物与风格",'."\n"
.' "maxLength": 100'."\n"
.' },'."\n"
.' "communicationStyle": {'."\n"
.' "displayOrder": 4,'."\n"
.' "displayName": "沟通风格",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "SELECTABLE_TAGS",'."\n"
.' "attributes": {'."\n"
.' "mode": "multiple",'."\n"
.' "dataSource": ['."\n"
.' "亲切",'."\n"
.' "自然",'."\n"
.' "口语化",'."\n"
.' "专业",'."\n"
.' "活泼",'."\n"
.' "严肃"'."\n"
.' ]'."\n"
.' },'."\n"
.' "group": "人物与风格",'."\n"
.' "maxLength": 100'."\n"
.' },'."\n"
.' "goals": {'."\n"
.' "displayOrder": 5,'."\n"
.' "displayName": "目标",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "描述此次呼叫的目的。例如,调研上次服务的满意度情况",'."\n"
.' "rows": 5'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 1000'."\n"
.' },'."\n"
.' "background": {'."\n"
.' "displayOrder": 7,'."\n"
.' "displayName": "背景",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "描述此次呼叫的背景,比如活动信息、FAQ等",'."\n"
.' "rows": 10'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 2000'."\n"
.' },'."\n"
.' "openingPrompt": {'."\n"
.' "displayOrder": 100,'."\n"
.' "displayName": "开场白",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "请输入开场白,支持变量",'."\n"
.' "rows": 3,'."\n"
.' "isAutoOptimizePrompt": true'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 100,'."\n"
.' "required": true'."\n"
.' },'."\n"
.' "skills": {'."\n"
.' "displayOrder": 9,'."\n"
.' "displayName": "技能",'."\n"
.' "description": "描述机器人能够执行的具体事项。例如\\n技能1:核验用户身份\\n技能2:进行活动推荐\\n技能3:确认用户参与意向并礼貌挂机",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "描述机器人包含的能力\\n例如:\\n1.使用客服语气询问客户的产品满意度情况\\n2.需要针对产品的易用性、性能、功能完善度、商品价格这4个纬度进行打分调研",'."\n"
.' "rows": 5,'."\n"
.' "isAutoOptimizePrompt": true,'."\n"
.' "quickOptionsEnabled": true,'."\n"
.' "apiPluginsEnabled": true'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 1000'."\n"
.' },'."\n"
.' "workflow": {'."\n"
.' "displayOrder": 10,'."\n"
.' "displayName": "流程",'."\n"
.' "description": "描述机器人执行任务时,与客户交流的过程。例如\\n根据预先设定的问题逻辑推进调研:\\n1. 总体满意度:“首先,请问您对我们服务的整体满意度如何评价?非常满意、满意、一般、不满意还是非常不满意?”\\n2. 服务亮点(若上一题为正面评价):“很高兴听到您的满意!请问哪些方面让您感到特别满意呢?”\\n3. 改进建议(若上一题为负面评价):“非常抱歉给您带来了不便。您认为我们在哪方面可以做得更好?”\\n4. 服务效率:“在服务响应速度和服务完成的时效性上,您的感受是怎样的?”\\n5. 员工态度:“对于服务人员的专业度和态度,您有何评价?”\\n6. 再次选择意愿:“基于此次体验,您未来是否会考虑再次使用我们的服务?”",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "描述工作流程",'."\n"
.' "rows": 10,'."\n"
.' "isAutoOptimizePrompt": true,'."\n"
.' "quickOptionsEnabled": true,'."\n"
.' "apiPluginsEnabled": true'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 4000'."\n"
.' },'."\n"
.' "constraint": {'."\n"
.' "displayOrder": 11,'."\n"
.' "displayName": "约束",'."\n"
.' "description": "描述对话的约束或整体要求,例如\\n你需要记住你的角色信息,并始终遵循。\\n- 在整个通话过程中,保持语气的中立性和友好性,避免对受访者产生引导性影响。\\n- 每轮对话不超过50个字,确保信息传达的高效性。\\n- 严格遵守调研伦理,保证受访者信息的匿名性和隐私安全。\\n- 避免在电话中深入讨论涉及个人隐私或具体服务细节的问题。\\n- 用户询问的问题与目标或流程无关时, 请礼貌拒绝,并引导到目标问题上。\\n- 只回复与本次任务相关的问题;对于不知道的问题,请不要胡乱回复,需要礼貌回复“不清楚”,并引导到目标问题上。",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "描述机器人交流过程中需要注意的问题,或异常情况下的回复参考\\n例如:\\n1.保持对话的专业客服行业专业术语和礼貌性,维护公司形象\\n2.针对客服的情绪如不耐烦、生气等能够精准识别并及时停止调研",'."\n"
.' "rows": 5,'."\n"
.' "isAutoOptimizePrompt": true'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 1000,'."\n"
.' "defaultValue": "- 当前时间:${currentTimeWithDayOfWeek}。\\n- 星期和日期转换时,请用北京时间。\\n- 如果不知道目标用户(客户)性别,则直接称呼目标用户(客户)姓名,不要尊称xx先生/女士。例如:不知道张三的性别,请直接称呼张三,不要称呼张三先生/女士。\\n- 如果知道目标用户(客户)性别,直接称呼xx先生/女士。\\n- 请严格按照流程步骤逐步执行,并确保所有步骤都已经执行,如果还存在没有执行的步骤,则需要再执行一次。"'."\n"
.' },'."\n"
.' "output": {'."\n"
.' "displayOrder": 1000,'."\n"
.' "displayName": "输出",'."\n"
.' "description": "输出",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "- 无格式\\n",'."\n"
.' "rows": 10,'."\n"
.' "isAutoOptimizePrompt": false'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 2000,'."\n"
.' "defaultValue": "- 无格式\\n",'."\n"
.' "hidden": true'."\n"
.' },'."\n"
.' "aiHangupOutput": {'."\n"
.' "displayOrder": 1001,'."\n"
.' "displayName": "aiHangupOutput",'."\n"
.' "description": "aiHangupOutput",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "- 如果判断会话结束,则礼貌回复并追加#[HangUp]\\n- 如果流程已执行完成,则礼貌回复并追加#[HangUp]\\n- 如果大模型(机器人或者Bot)输出了再见,并且表示希望结束会话,则追加#[HangUp]",'."\n"
.' "rows": 10,'."\n"
.' "isAutoOptimizePrompt": false'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 2000,'."\n"
.' "defaultValue": "- 如果判断会话结束,则礼貌回复并追加#[HangUp]\\n- 如果流程已执行完成,则礼貌回复并追加#[HangUp]\\n- 如果大模型(机器人或者Bot)输出了再见,并且表示希望结束会话,则追加#[HangUp]",'."\n"
.' "hidden": true'."\n"
.' },'."\n"
.' "aiSilenceTimeoutOutput": {'."\n"
.' "displayOrder": 1002,'."\n"
.' "displayName": "aiSilenceTimeoutOutput",'."\n"
.' "description": "aiSilenceTimeoutOutput",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "- 如果用户没有说话,则礼貌回复用户。比如“抱歉,我听不到您讲话,请您再说一遍?“\\n- 如果用户没有说话没有达到${aiSilenceTimeoutMaxCount}次,请不要结束会话,但需要进行礼貌回复。\\n-如果用户没有说话达到${aiSilenceTimeoutMaxCount}次,则礼貌回复结束会话并追加#[HangUp]",'."\n"
.' "rows": 10,'."\n"
.' "isAutoOptimizePrompt": false'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 2000,'."\n"
.' "defaultValue": "- 如果用户没有说话,则礼貌回复用户。比如“抱歉,我听不到您讲话,请您再说一遍?“\\n- 如果用户没有说话没有达到${aiSilenceTimeoutMaxCount}次,请不要结束会话,但需要进行礼貌回复。\\n-如果用户没有说话达到${aiSilenceTimeoutMaxCount}次,则礼貌回复结束会话并追加#[HangUp]",'."\n"
.' "hidden": true'."\n"
.' }'."\n"
.' }'."\n"
.'}',
],
],
],
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExists.InstanceId',
'errorMessage' => 'The specified instance %s does not exist.',
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"CreateTime\\": \\"1720766491000\\",\\n \\"UpdateTime\\": \\"1720766491000\\",\\n \\"AgentProfileTemplateId\\": \\"default-survey\\",\\n \\"Name\\": \\"问卷调查\\",\\n \\"Description\\": \\"说明\\",\\n \\"PromptSchema\\": \\"{\\\\n \\\\\\"name\\\\\\": \\\\\\"promptSchema\\\\\\",\\\\n \\\\\\"properties\\\\\\": {\\\\n \\\\\\"name\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 1,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"名称\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"如:云小宝\\\\\\",\\\\n \\\\\\"rows\\\\\\": 1\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"人物与风格\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 100\\\\n },\\\\n \\\\\\"gender\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 2,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"性别\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"此选项不会改变男女声音色,如需修改,请在【语音&VUI】中的TTS音色模版中修改\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"SELECT\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"dataSource\\\\\\": [\\\\n \\\\\\"男\\\\\\",\\\\n \\\\\\"女\\\\\\",\\\\n \\\\\\"不指定\\\\\\"\\\\n ]\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"人物与风格\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 100\\\\n },\\\\n \\\\\\"age\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 3,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"年龄\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"LONG\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"NUMBER\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"innerAfter\\\\\\": \\\\\\"岁\\\\\\"\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"人物与风格\\\\\\",\\\\n \\\\\\"maximum\\\\\\": 60,\\\\n \\\\\\"minimum\\\\\\": 18\\\\n },\\\\n \\\\\\"role\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 3,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"身份\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"SELECTABLE_TAGS\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"mode\\\\\\": \\\\\\"single\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": [\\\\n \\\\\\"游戏推广员\\\\\\",\\\\n \\\\\\"活动运营员\\\\\\",\\\\n \\\\\\"医疗助理\\\\\\",\\\\n \\\\\\"审计专员\\\\\\",\\\\n \\\\\\"保险专员\\\\\\",\\\\n \\\\\\"行政助理\\\\\\"\\\\n ]\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"人物与风格\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 100\\\\n },\\\\n \\\\\\"communicationStyle\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 4,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"沟通风格\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"SELECTABLE_TAGS\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"mode\\\\\\": \\\\\\"multiple\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": [\\\\n \\\\\\"亲切\\\\\\",\\\\n \\\\\\"自然\\\\\\",\\\\n \\\\\\"口语化\\\\\\",\\\\n \\\\\\"专业\\\\\\",\\\\n \\\\\\"活泼\\\\\\",\\\\n \\\\\\"严肃\\\\\\"\\\\n ]\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"人物与风格\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 100\\\\n },\\\\n \\\\\\"goals\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 5,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"目标\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"描述此次呼叫的目的。例如,调研上次服务的满意度情况\\\\\\",\\\\n \\\\\\"rows\\\\\\": 5\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 1000\\\\n },\\\\n \\\\\\"background\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 7,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"背景\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"描述此次呼叫的背景,比如活动信息、FAQ等\\\\\\",\\\\n \\\\\\"rows\\\\\\": 10\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 2000\\\\n },\\\\n \\\\\\"openingPrompt\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 100,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"开场白\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"请输入开场白,支持变量\\\\\\",\\\\n \\\\\\"rows\\\\\\": 3,\\\\n \\\\\\"isAutoOptimizePrompt\\\\\\": true\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 100,\\\\n \\\\\\"required\\\\\\": true\\\\n },\\\\n \\\\\\"skills\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 9,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"技能\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"描述机器人能够执行的具体事项。例如\\\\\\\\n技能1:核验用户身份\\\\\\\\n技能2:进行活动推荐\\\\\\\\n技能3:确认用户参与意向并礼貌挂机\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"描述机器人包含的能力\\\\\\\\n例如:\\\\\\\\n1.使用客服语气询问客户的产品满意度情况\\\\\\\\n2.需要针对产品的易用性、性能、功能完善度、商品价格这4个纬度进行打分调研\\\\\\",\\\\n \\\\\\"rows\\\\\\": 5,\\\\n \\\\\\"isAutoOptimizePrompt\\\\\\": true,\\\\n \\\\\\"quickOptionsEnabled\\\\\\": true,\\\\n \\\\\\"apiPluginsEnabled\\\\\\": true\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 1000\\\\n },\\\\n \\\\\\"workflow\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 10,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"流程\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"描述机器人执行任务时,与客户交流的过程。例如\\\\\\\\n根据预先设定的问题逻辑推进调研:\\\\\\\\n1. 总体满意度:“首先,请问您对我们服务的整体满意度如何评价?非常满意、满意、一般、不满意还是非常不满意?”\\\\\\\\n2. 服务亮点(若上一题为正面评价):“很高兴听到您的满意!请问哪些方面让您感到特别满意呢?”\\\\\\\\n3. 改进建议(若上一题为负面评价):“非常抱歉给您带来了不便。您认为我们在哪方面可以做得更好?”\\\\\\\\n4. 服务效率:“在服务响应速度和服务完成的时效性上,您的感受是怎样的?”\\\\\\\\n5. 员工态度:“对于服务人员的专业度和态度,您有何评价?”\\\\\\\\n6. 再次选择意愿:“基于此次体验,您未来是否会考虑再次使用我们的服务?”\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"描述工作流程\\\\\\",\\\\n \\\\\\"rows\\\\\\": 10,\\\\n \\\\\\"isAutoOptimizePrompt\\\\\\": true,\\\\n \\\\\\"quickOptionsEnabled\\\\\\": true,\\\\n \\\\\\"apiPluginsEnabled\\\\\\": true\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 4000\\\\n },\\\\n \\\\\\"constraint\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 11,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"约束\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"描述对话的约束或整体要求,例如\\\\\\\\n你需要记住你的角色信息,并始终遵循。\\\\\\\\n- 在整个通话过程中,保持语气的中立性和友好性,避免对受访者产生引导性影响。\\\\\\\\n- 每轮对话不超过50个字,确保信息传达的高效性。\\\\\\\\n- 严格遵守调研伦理,保证受访者信息的匿名性和隐私安全。\\\\\\\\n- 避免在电话中深入讨论涉及个人隐私或具体服务细节的问题。\\\\\\\\n- 用户询问的问题与目标或流程无关时, 请礼貌拒绝,并引导到目标问题上。\\\\\\\\n- 只回复与本次任务相关的问题;对于不知道的问题,请不要胡乱回复,需要礼貌回复“不清楚”,并引导到目标问题上。\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"描述机器人交流过程中需要注意的问题,或异常情况下的回复参考\\\\\\\\n例如:\\\\\\\\n1.保持对话的专业客服行业专业术语和礼貌性,维护公司形象\\\\\\\\n2.针对客服的情绪如不耐烦、生气等能够精准识别并及时停止调研\\\\\\",\\\\n \\\\\\"rows\\\\\\": 5,\\\\n \\\\\\"isAutoOptimizePrompt\\\\\\": true\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 1000,\\\\n \\\\\\"defaultValue\\\\\\": \\\\\\"- 当前时间:${currentTimeWithDayOfWeek}。\\\\\\\\n- 星期和日期转换时,请用北京时间。\\\\\\\\n- 如果不知道目标用户(客户)性别,则直接称呼目标用户(客户)姓名,不要尊称xx先生/女士。例如:不知道张三的性别,请直接称呼张三,不要称呼张三先生/女士。\\\\\\\\n- 如果知道目标用户(客户)性别,直接称呼xx先生/女士。\\\\\\\\n- 请严格按照流程步骤逐步执行,并确保所有步骤都已经执行,如果还存在没有执行的步骤,则需要再执行一次。\\\\\\"\\\\n },\\\\n \\\\\\"output\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 1000,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"输出\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"输出\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"- 无格式\\\\\\\\n\\\\\\",\\\\n \\\\\\"rows\\\\\\": 10,\\\\n \\\\\\"isAutoOptimizePrompt\\\\\\": false\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 2000,\\\\n \\\\\\"defaultValue\\\\\\": \\\\\\"- 无格式\\\\\\\\n\\\\\\",\\\\n \\\\\\"hidden\\\\\\": true\\\\n },\\\\n \\\\\\"aiHangupOutput\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 1001,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"aiHangupOutput\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"aiHangupOutput\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"- 如果判断会话结束,则礼貌回复并追加#[HangUp]\\\\\\\\n- 如果流程已执行完成,则礼貌回复并追加#[HangUp]\\\\\\\\n- 如果大模型(机器人或者Bot)输出了再见,并且表示希望结束会话,则追加#[HangUp]\\\\\\",\\\\n \\\\\\"rows\\\\\\": 10,\\\\n \\\\\\"isAutoOptimizePrompt\\\\\\": false\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 2000,\\\\n \\\\\\"defaultValue\\\\\\": \\\\\\"- 如果判断会话结束,则礼貌回复并追加#[HangUp]\\\\\\\\n- 如果流程已执行完成,则礼貌回复并追加#[HangUp]\\\\\\\\n- 如果大模型(机器人或者Bot)输出了再见,并且表示希望结束会话,则追加#[HangUp]\\\\\\",\\\\n \\\\\\"hidden\\\\\\": true\\\\n },\\\\n \\\\\\"aiSilenceTimeoutOutput\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 1002,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"aiSilenceTimeoutOutput\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"aiSilenceTimeoutOutput\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"- 如果用户没有说话,则礼貌回复用户。比如“抱歉,我听不到您讲话,请您再说一遍?“\\\\\\\\n- 如果用户没有说话没有达到${aiSilenceTimeoutMaxCount}次,请不要结束会话,但需要进行礼貌回复。\\\\\\\\n-如果用户没有说话达到${aiSilenceTimeoutMaxCount}次,则礼貌回复结束会话并追加#[HangUp]\\\\\\",\\\\n \\\\\\"rows\\\\\\": 10,\\\\n \\\\\\"isAutoOptimizePrompt\\\\\\": false\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 2000,\\\\n \\\\\\"defaultValue\\\\\\": \\\\\\"- 如果用户没有说话,则礼貌回复用户。比如“抱歉,我听不到您讲话,请您再说一遍?“\\\\\\\\n- 如果用户没有说话没有达到${aiSilenceTimeoutMaxCount}次,请不要结束会话,但需要进行礼貌回复。\\\\\\\\n-如果用户没有说话达到${aiSilenceTimeoutMaxCount}次,则礼貌回复结束会话并追加#[HangUp]\\\\\\",\\\\n \\\\\\"hidden\\\\\\": true\\\\n }\\\\n }\\\\n}\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '获取智能体配置模版(已作废)',
'summary' => '获取智能体配置模版。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAgentProfileTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetAnnotationMissionSummary' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '129550',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'AnnotationMissionId',
'in' => 'query',
'schema' => [
'title' => '标注任务ID',
'description' => '标注任务ID',
'type' => 'string',
'required' => false,
'example' => '50e53ac8-24a4-46d5-b174-ee88867f4780',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否调用成功。true:调用成功。 false:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '附加信息。取值说明如下:请求正常,返回success。请求异常,返回具体异常错误码。',
'type' => 'string',
'example' => 'You are not authorized to perform this action. CDR:View privileges are required.',
],
'Data' => [
'description' => '数据',
'type' => 'object',
'properties' => [
'AnnotationMissionId' => [
'title' => '标注任务ID',
'description' => '标注任务ID',
'type' => 'string',
'example' => 'b3f2c931-5180-43ca-b4aa-2baee2d73c8b',
],
'IntentSummaryInfo' => [
'title' => '语义标注统计信息',
'description' => '语义标注统计信息',
'type' => 'object',
'properties' => [
'IntentUserSayCount' => [
'description' => '对话次数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AnnotationCorrectCount' => [
'description' => '正确chat数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'MatchErrorCount' => [
'description' => '识别错误数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AnnotationInvalid' => [
'description' => '无效数据',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'NoAnnotation' => [
'description' => '未标注',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ChatTotalCount' => [
'description' => 'chat总数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TranslationUnrecognizedCount' => [
'description' => '转译未识别次数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'IntentionNotCoveredCount' => [
'description' => '未覆盖意图',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'AsrSummaryInfo' => [
'title' => '语音标注统计信息',
'description' => '语音标注统计信息',
'type' => 'object',
'properties' => [
'WordErrorRate' => [
'description' => '词错率,单位0.01%,一般用于英文',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CharacterErrorRate' => [
'description' => '字错率,单位0.01%',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SentenceErrorRate' => [
'description' => '句子错率,单位0.01%',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AnnotationInvalid' => [
'description' => '无效数据',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'NoAnnotation' => [
'description' => '未标注',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ChatTotalCount' => [
'description' => 'chat总数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AddVocabularyDataCount' => [
'description' => '添加热词次数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AddCustomizationDataCount' => [
'description' => '添加语言模型数据次数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CharacterCorrectRate' => [
'description' => '字准率,单位0.01%',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
'TagSummaryInfo' => [
'title' => '自定义标签及数量',
'description' => '自定义标签及数量',
'type' => 'object',
'properties' => [
'TagSummaryInfoDetailList' => [
'description' => '标签列表',
'type' => 'array',
'items' => [
'description' => '标签列表',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '标签名字',
'type' => 'string',
'example' => '知晓率1_复制',
],
'Count' => [
'description' => '标签数量',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
],
],
],
],
],
'Success' => [
'description' => '是否调用成功。true:调用成功。 false:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '附加信息。取值说明如下:请求正常,返回success。请求异常,返回具体异常错误码。',
'type' => 'string',
'example' => 'You are not authorized to perform this action. CDR:View privileges are required.',
],
],
],
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"You are not authorized to perform this action. CDR:View privileges are required.\\",\\n \\"Data\\": {\\n \\"AnnotationMissionId\\": \\"b3f2c931-5180-43ca-b4aa-2baee2d73c8b\\",\\n \\"IntentSummaryInfo\\": {\\n \\"IntentUserSayCount\\": 1,\\n \\"AnnotationCorrectCount\\": 1,\\n \\"MatchErrorCount\\": 1,\\n \\"AnnotationInvalid\\": 1,\\n \\"NoAnnotation\\": 1,\\n \\"ChatTotalCount\\": 1,\\n \\"TranslationUnrecognizedCount\\": 1,\\n \\"IntentionNotCoveredCount\\": 1\\n },\\n \\"AsrSummaryInfo\\": {\\n \\"WordErrorRate\\": 1,\\n \\"CharacterErrorRate\\": 1,\\n \\"SentenceErrorRate\\": 1,\\n \\"AnnotationInvalid\\": 1,\\n \\"NoAnnotation\\": 1,\\n \\"ChatTotalCount\\": 1,\\n \\"AddVocabularyDataCount\\": 1,\\n \\"AddCustomizationDataCount\\": 1,\\n \\"CharacterCorrectRate\\": 1\\n },\\n \\"TagSummaryInfo\\": {\\n \\"TagSummaryInfoDetailList\\": [\\n {\\n \\"Name\\": \\"知晓率1_复制\\",\\n \\"Count\\": 3\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"Message\\": \\"You are not authorized to perform this action. CDR:View privileges are required.\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '获取标注任务统计信息',
'summary' => 'null',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAnnotationMissionSummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetAnnotationMissionTagInfoList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '129329',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID'."\n"
."\n"
.'> 不填的话,返回该租户默认标签',
'type' => 'string',
'required' => false,
'example' => '4eee9bf8-1319-468f-ac82-83c50ae389f8',
],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => [
'description' => '页码',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页记录数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
'default' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否调用成功。true:表示调用成功。 false:表示调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'CDR \'job-efbaeefc-4d45-4e79-83f7-b33b0769c969\' doesn\'t exists.',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'AnnotationMissionTagInfoList' => [
'description' => '标签列表',
'type' => 'array',
'items' => [
'description' => '标签列表',
'type' => 'object',
'properties' => [
'AnnotationMissionTagInfoId' => [
'description' => '标签ID',
'type' => 'string',
'example' => 'e1ee87ea-ebad-4079-aebb-1c56a4ef0c06',
],
'InstanceId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => '3c3b8d1d-deff-48d9-9318-addc80ae5b1e',
],
'TenantId' => [
'description' => '租户 ID。',
'type' => 'string',
'example' => 'DING_ORG_dingbd9daecdb7aaed3bffe93478753d9884',
],
'AnnotationMissionTagInfoName' => [
'description' => '标签名称',
'type' => 'string',
'example' => '用户投诉',
],
'AnnotationMissionTagInfoDescription' => [
'description' => '标签描述',
'type' => 'string',
'example' => '用户投诉',
],
'Delete' => [
'description' => '是否已删除',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
'Success' => [
'description' => '是否调用成功。true:表示调用成功。 false:表示调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'CDR \'job-efbaeefc-4d45-4e79-83f7-b33b0769c969\' doesn\'t exists.',
],
],
],
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"CDR \'job-efbaeefc-4d45-4e79-83f7-b33b0769c969\' doesn\'t exists.\\",\\n \\"Data\\": {\\n \\"AnnotationMissionTagInfoList\\": [\\n {\\n \\"AnnotationMissionTagInfoId\\": \\"e1ee87ea-ebad-4079-aebb-1c56a4ef0c06\\",\\n \\"InstanceId\\": \\"3c3b8d1d-deff-48d9-9318-addc80ae5b1e\\",\\n \\"TenantId\\": \\"DING_ORG_dingbd9daecdb7aaed3bffe93478753d9884\\",\\n \\"AnnotationMissionTagInfoName\\": \\"用户投诉\\",\\n \\"AnnotationMissionTagInfoDescription\\": \\"用户投诉\\",\\n \\"Delete\\": false\\n }\\n ],\\n \\"Success\\": true,\\n \\"Message\\": \\"CDR \'job-efbaeefc-4d45-4e79-83f7-b33b0769c969\' doesn\'t exists.\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '获取标注标签列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAnnotationMissionTagInfoList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetAsrServerInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94091',
'abilityTreeNodes' => [
'FEATUREoutboundbotR6RNHS',
],
],
'parameters' => [
[
'name' => 'EntryId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => false,
'example' => '024f8cf0-c842-4c01-b74b-c8667e4579c7',
],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => [
'description' => '策略级别',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '【已废弃】获取asr模型列表、热词列表等信息',
'summary' => '获取asr模型列表、热词列表等信息,已废弃。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAsrServerInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetAssignJobsAsyncResult' => [
'summary' => '获取异步外呼任务上传结果。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94122',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'AsyncTaskId',
'in' => 'query',
'schema' => [
'description' => '异步任务ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dc79b0f9-a781-4305-85e2-d5d56679ae69',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息。',
'type' => 'object',
'properties' => [
'Timeout' => [
'description' => '异步任务是否超时。',
'type' => 'boolean',
'example' => 'false',
],
'HttpStatusCode' => [
'description' => 'HTTP 状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Valid' => [
'description' => '结果是否已经生成完成。',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'JobGroupId' => [
'description' => '任务组ID',
'type' => 'string',
'example' => 'd3550dd1-360d-4fe5-b4b2-667a4a664dab',
],
'JobsId' => [
'description' => '作业ID列表。',
'type' => 'array',
'items' => [
'description' => '作业ID。',
'type' => 'string',
'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76',
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Timeout\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Valid\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"JobGroupId\\": \\"d3550dd1-360d-4fe5-b4b2-667a4a664dab\\",\\n \\"JobsId\\": [\\n \\"12f3dd08-0c55-44ce-9b64-e69d35ed3a76\\"\\n ]\\n}","type":"json"}]',
'title' => '获取异步创建外呼任务结果',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAssignJobsAsyncResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetBaseStrategyPeriod' => [
'summary' => '获取外呼系统中全局可外呼时间段。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94092',
'abilityTreeNodes' => [
'FEATUREoutboundbotFCNV31',
],
],
'parameters' => [
[
'name' => 'EntryId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '024f8cf0-c842-4c01-b74b-c8667e4579c7',
],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => [
'description' => '策略级别,默认填入2'."\n"
.'- 0:系统'."\n"
.'- 1:租户'."\n"
.'- 2:实例',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'OnlyWeekdays' => [
'description' => '是否周六日',
'type' => 'boolean',
'example' => 'false',
],
'OnlyWorkdays' => [
'description' => '是否工作日',
'type' => 'boolean',
'example' => 'false',
],
'WorkingTime' => [
'description' => '策略执行时间段',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '结束时间',
'type' => 'string',
'example' => '00:00:00',
],
'BeginTimeMillis' => [
'description' => '以毫秒表示的每日开始时间',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'EndTimeMillis' => [
'description' => '以毫秒表示的每日结束时间',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'BeginTime' => [
'description' => '开始时间'."\n",
'type' => 'string',
'example' => '00:00:00',
],
],
'description' => '',
],
'example' => '[]',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"OnlyWeekdays\\": false,\\n \\"OnlyWorkdays\\": false,\\n \\"WorkingTime\\": [\\n {\\n \\"EndTime\\": \\"00:00:00\\",\\n \\"BeginTimeMillis\\": 0,\\n \\"EndTimeMillis\\": 0,\\n \\"BeginTime\\": \\"00:00:00\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取全局可外呼时间段',
'changeSet' => [
[
'createdAt' => '2023-03-08T14:50:30.000Z',
'description' => '响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetBaseStrategyPeriod',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetConcurrentConversationQuota' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RemainingConcurrent' => [
'description' => '剩余的并发',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'MaxConcurrent' => [
'description' => '最大并发数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RemainingConcurrent\\": 2,\\n \\"MaxConcurrent\\": 10\\n}","type":"json"}]',
'title' => '获取调用者账号下剩余的并发数',
'summary' => '获取调用者账号下剩余的并发数。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetConcurrentConversationQuota',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetContactBlockList' => [
'summary' => '获取禁止外呼名单。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94094',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号( 必填)',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '个数(必填)',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'example' => '10',
],
],
[
'name' => 'CountTotalRow',
'in' => 'query',
'schema' => [
'description' => '是否展示总条数',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '846e20ae-e113-4231-a792-cb354187c9f6',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'ContactBlocklistList' => [
'description' => '联系人列表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'List' => [
'description' => '数组数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ContactBlockListId' => [
'description' => '外呼禁止呼叫名单业务唯一键',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'CreationTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1640077685465',
],
'Remark' => [
'description' => '备注',
'type' => 'string',
'example' => 'xxxx',
],
'PhoneNumber' => [
'description' => '手机号码',
'type' => 'string',
'example' => '1388888888',
],
'Operator' => [
'description' => '操作人',
'type' => 'string',
'example' => 'xxx',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Name' => [
'description' => '姓名',
'type' => 'string',
'example' => 'xxx',
],
'Creator' => [
'description' => '创建者',
'type' => 'string',
'example' => 'xxx',
],
],
'description' => '',
],
'example' => '[]',
],
],
'example' => '{}',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"ContactBlocklistList\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"List\\": [\\n {\\n \\"ContactBlockListId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"CreationTime\\": 1640077685465,\\n \\"Remark\\": \\"xxxx\\",\\n \\"PhoneNumber\\": \\"1388888888\\",\\n \\"Operator\\": \\"xxx\\",\\n \\"InstanceId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Name\\": \\"xxx\\",\\n \\"Creator\\": \\"xxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取禁止外呼名单',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetContactBlockList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetContactWhiteList' => [
'summary' => '获取全局外呼策略白名单。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94095',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'name' => 'CountTotalRow',
'in' => 'query',
'schema' => [
'description' => '是否需要总条数',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2a830781-324e-4568-ae96-309f93090fe1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'ContactWhitelistList' => [
'description' => '联系人列表',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '每页个数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'List' => [
'description' => '联系人列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1640174411848',
],
'Remark' => [
'description' => '备注',
'type' => 'string',
'example' => 'xxxx',
],
'PhoneNumber' => [
'description' => '手机号码',
'type' => 'string',
'example' => '13959999999',
],
'Operator' => [
'description' => '操作者',
'type' => 'string',
'example' => 'xxx',
],
'ContactWhiteListId' => [
'description' => '白名单ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Name' => [
'description' => '姓名',
'type' => 'string',
'example' => '张三',
],
'Creator' => [
'description' => '创建者',
'type' => 'string',
'example' => '测试123',
],
],
'description' => '',
],
'example' => '{}',
],
],
'example' => '{}',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"ContactWhitelistList\\": {\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"List\\": [\\n {\\n \\"CreationTime\\": 1640174411848,\\n \\"Remark\\": \\"xxxx\\",\\n \\"PhoneNumber\\": \\"13959999999\\",\\n \\"Operator\\": \\"xxx\\",\\n \\"ContactWhiteListId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"InstanceId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Name\\": \\"张三\\",\\n \\"Creator\\": \\"测试123\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取外呼白名单列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetContactWhiteList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetCurrentConcurrency' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'CurrentConcurrency' => [
'description' => '当前的并发',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'MaxConcurrentConversation' => [
'description' => '最大并发',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"CurrentConcurrency\\": 12,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"MaxConcurrentConversation\\": 5,\\n \\"InstanceId\\": \\"12f3dd08-0c55-44ce-9b64-e69d35ed3a76\\"\\n}","type":"json"}]',
'title' => '获取实例当前的并发',
'summary' => '获取实例当前的并发。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetCurrentConcurrency',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetEmptyNumberNoMoreCallsInfo' => [
'summary' => '查询全局维度的空号不再外呼功能开关。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94098',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'EntryId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'db3e679b-7d5e-4d9b-828a-345adca455f3',
],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => [
'description' => '策略级别,在业务实例中默认填2'."\n"
."\n"
.'- 0:系统'."\n"
.'- 1:租户'."\n"
.'- 2:实例',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'EmptyNumberNoMoreCalls' => [
'description' => '空号不再外呼',
'type' => 'boolean',
'example' => 'true',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"EmptyNumberNoMoreCalls\\": true,\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '【废弃】查询全局维度空号不再外呼功能开关',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetEmptyNumberNoMoreCallsInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetJobDataUploadParams' => [
'summary' => '获取作业数据上传参数。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4eee9bf8-1319-468f-ac82-83c50ae389f8',
],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'description' => '文件名称',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'SHUKE_ZA_ol_2_开场白.wav',
],
],
[
'name' => 'UniqueId',
'in' => 'query',
'schema' => [
'description' => '业务唯一ID(防止文件名称重复,不填系统自动添加)',
'type' => 'string',
'required' => false,
'example' => 'sas_siema_1477832102462645_siem_f07e90c2c147cf8cf1549ccb974e1956',
],
],
[
'name' => 'Path',
'in' => 'query',
'schema' => [
'description' => '文件存储的相对路径',
'type' => 'string',
'required' => false,
'example' => '//airwaybill/1237185904146124802',
],
],
[
'name' => 'BusiType',
'in' => 'query',
'schema' => [
'description' => '业务类型',
'type' => 'string',
'required' => false,
'example' => 'SCRIPT_RECORDING',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'True',
],
'UploadParams' => [
'description' => '上传的参数列表',
'type' => 'object',
'properties' => [
'Signature' => [
'description' => '签名信息',
'type' => 'string',
'example' => 'MD4CHQCiECtjdsP+fstJDcqsPt+GbWxSWPzGQxeQiblzAh0AuidaKc5JY5AkHFIE+qiQI3izJQQbpUoG0paPTw==',
],
'Host' => [
'description' => '上传服务器URL',
'type' => 'string',
'example' => 'https://cloudagentbot-online.oss-cn-hangzhou.aliyuncs.com',
],
'Policy' => [
'description' => '上传策略',
'type' => 'string',
'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0xM1QwODo0NToyNy4zMzFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiVVBMT0FERUQvU0NSSVBULzEzNmEwNTVlLTNkMDctNDZjNi04NTNhLTczMWIzYTI5NzNkZS8iXV19',
],
'Folder' => [
'description' => '上传目录'."\n"
."\n"
.'> 该参数的值将用于很多接口的请求参数中。',
'type' => 'string',
'example' => 'UPLOADED/SCRIPT/136a055e-***-46c6-853a-731b3a2973de/18dc6d79-338f-413c-a5a8-dcce5f05b41a_9bd7916d-a340-4925-a911-92390cbe0f33.json',
],
'AccessId' => [
'description' => 'OSS的访问ID',
'type' => 'string',
'example' => 'LTAI****************',
],
'Expire' => [
'description' => '过期时间(秒)',
'type' => 'integer',
'format' => 'int32',
'example' => '1741855527',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"UploadParams\\": {\\n \\"Signature\\": \\"MD4CHQCiECtjdsP+fstJDcqsPt+GbWxSWPzGQxeQiblzAh0AuidaKc5JY5AkHFIE+qiQI3izJQQbpUoG0paPTw==\\",\\n \\"Host\\": \\"https://cloudagentbot-online.oss-cn-hangzhou.aliyuncs.com\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0xM1QwODo0NToyNy4zMzFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiVVBMT0FERUQvU0NSSVBULzEzNmEwNTVlLTNkMDctNDZjNi04NTNhLTczMWIzYTI5NzNkZS8iXV19\\",\\n \\"Folder\\": \\"UPLOADED/SCRIPT/136a055e-***-46c6-853a-731b3a2973de/18dc6d79-338f-413c-a5a8-dcce5f05b41a_9bd7916d-a340-4925-a911-92390cbe0f33.json\\",\\n \\"AccessId\\": \\"LTAI****************\\",\\n \\"Expire\\": 1741855527\\n }\\n}","type":"json"}]',
'title' => '获取作业数据上传参数',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetJobDataUploadParams',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetMaxAttemptsPerDay' => [
'summary' => '查询被叫号码每日拨打上限。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94103',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'EntryId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2bfa5ae4-7185-4227-a3b8-328f26f11be1',
],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => [
'description' => '策略级别,在业务实例中默认填2'."\n"
."\n"
.'- 0:系统'."\n"
.'- 1:租户'."\n"
.'- 2:实例',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'MaxAttemptsPerDay' => [
'description' => '拨打失败后最多重新拨打次数',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"MaxAttemptsPerDay\\": 2,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '查询被叫号码每日拨打上限',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetMaxAttemptsPerDay',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetNumberDistrictInfoTemplateDownloadUrl' => [
'summary' => '获取号码库模板下载链接,已废弃。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '117817',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'FileHttpUrl' => [
'description' => '文件URL',
'type' => 'string',
'example' => 'http://xxx.xx.com/xx',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"FileHttpUrl\\": \\"http://xxx.xx.com/xx\\"\\n}","type":"json"}]',
'title' => '【已废弃】获取号码归属地模板下载链接',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'GetRealtimeConcurrencyReport' => [
'summary' => '查询当前并发列表。',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '207103',
'abilityTreeNodes' => [
'FEATUREoutboundbot3SV6AU',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => false,
'example' => '85bf7efa-a07c-498a-850e-99a5849b8589',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID',
'type' => 'string',
'required' => false,
'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9'."\n",
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页条数',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP 状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'Reports' => [
'description' => '报告详情。',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '16',
],
'PageNumber' => [
'description' => '页码',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'PageSize' => [
'description' => '每页条数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'List' => [
'description' => '报告集合数据',
'type' => 'array',
'items' => [
'description' => '报告信息',
'type' => 'object',
'properties' => [
'ReportDate' => [
'description' => '报告生成时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1743474900488',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => '85bf7efa-a07c-498a-850e-99a5849b8589',
],
'InstanceName' => [
'description' => '实例名称',
'type' => 'string',
'example' => '智能外呼场景',
],
'JobGroupId' => [
'description' => '任务ID',
'type' => 'string',
'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9',
],
'JobGroupName' => [
'description' => '任务名称。',
'type' => 'string',
'example' => '第一个作业组'."\n",
],
'OccupiedConcurrencyCount' => [
'description' => '占用并发值',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'MaxConcurrencyLimit' => [
'description' => '配置的最大并发限制',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'MinConcurrencyLimit' => [
'description' => '任务的最小并发限制',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
],
],
],
],
],
'ReportDate' => [
'description' => '报告生成时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1743474900488',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Reports\\": {\\n \\"TotalCount\\": 16,\\n \\"PageNumber\\": 2,\\n \\"PageSize\\": 10,\\n \\"List\\": [\\n {\\n \\"ReportDate\\": 1743474900488,\\n \\"InstanceId\\": \\"85bf7efa-a07c-498a-850e-99a5849b8589\\",\\n \\"InstanceName\\": \\"智能外呼场景\\",\\n \\"JobGroupId\\": \\"c62e6789-28a8-41db-941e-171a01d3b3b9\\",\\n \\"JobGroupName\\": \\"第一个作业组\\\\n\\",\\n \\"OccupiedConcurrencyCount\\": 1,\\n \\"MaxConcurrencyLimit\\": 2,\\n \\"MinConcurrencyLimit\\": 0\\n }\\n ]\\n },\\n \\"ReportDate\\": 1743474900488\\n}","type":"json"}]',
'title' => '查询当前并发列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetRealtimeConcurrencyReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetSummaryInfo' => [
'summary' => '外呼实例总览。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94105',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'InstanceIdList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '实例ID列表',
'type' => 'array',
'items' => [
'description' => '实例ID',
'type' => 'string',
'required' => false,
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n",
],
'required' => false,
'example' => '[]',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'AgentBotInstanceSummaryList' => [
'description' => '实例列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TotalCallCount' => [
'description' => '累计外呼次数',
'type' => 'integer',
'format' => 'int64',
'example' => '12',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'TotalCallTime' => [
'description' => '累计通话时长',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'UsedRecordingStorageSpace' => [
'description' => '已使用录音存储空间(M)',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
'description' => '',
],
'example' => '[]',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"AgentBotInstanceSummaryList\\": [\\n {\\n \\"TotalCallCount\\": 12,\\n \\"InstanceId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"TotalCallTime\\": 10,\\n \\"UsedRecordingStorageSpace\\": 10\\n }\\n ]\\n}","type":"json"}]',
'title' => '外呼实例总览',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetSummaryInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetTaskByUuid' => [
'summary' => '根据UUID获取任务。',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '024f8cf0-c842-4c01-b74b-c8667e4579c7',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '15160071061',
],
],
[
'name' => 'WithConversations',
'in' => 'query',
'schema' => [
'description' => '是否需要对话信息'."\n"
."\n"
.'> 不填默认为false',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Task' => [
'description' => '任务信息',
'type' => 'object',
'properties' => [
'JobGroupId' => [
'description' => '作业组ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'EndTime' => [
'description' => '结束时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1640090211434',
],
'PlannedTime' => [
'description' => '任务计划执行时间【废弃】',
'type' => 'integer',
'format' => 'int64',
'example' => '1640090211434',
],
'JobId' => [
'description' => '作业ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'CallId' => [
'description' => '呼叫ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'CallingNumber' => [
'description' => '主叫号码',
'type' => 'string',
'example' => '057190294',
],
'ActualTime' => [
'description' => '实际执行时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1640090211434',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'CalledNumber' => [
'description' => '被叫号码',
'type' => 'string',
'example' => '13777777777',
],
'Id' => [
'description' => '任务ID',
'type' => 'string',
'example' => '2',
],
'Conversations' => [
'description' => '对话信息列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Speaker' => [
'description' => '对话是谁说的,Robot 机器人 ,Contact 联系人。',
'type' => 'string',
'example' => 'Robot',
],
'Script' => [
'description' => '对话文本。',
'type' => 'string',
'example' => '你好,我是**客服',
],
'Timestamp' => [
'description' => '摘要创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1579068424883',
],
'Action' => [
'description' => '指令'."\n"
.'- BeginDialogue:开始对话'."\n"
.'- Dialogue:对话'."\n"
.'- AbortDialogue:中止对话'."\n"
.'- SilenceTimeout:静音超时'."\n"
.'- CollectedNumber:已收集号码'."\n"
.'-EndDialogue:结束对话'."\n"
.'- Broadcast:开场白'."\n"
.'- HangUp挂断'."\n"
.'- Authorize:授权'."\n"
.'- TransferToAgent:转接坐席'."\n"
.'- TransferToIVR:转接IVR'."\n"
.'- RedirectToPage:重定向页面'."\n"
.'- CollectNumber:收集号码'."\n"
.'- WaitOnAsyncTask:等待异步任务'."\n"
.'- Error:错误',
'type' => 'string',
'example' => 'Broadcast',
],
'SequenceId' => [
'description' => '会话ID。',
'type' => 'string',
'example' => 'fd279983-93b9-b13b-9a34-64e5df473225',
],
],
'description' => '',
],
],
'EndReason' => [
'description' => '结束原因'."\n"
.'- FINISHED(1, "正常完结"),'."\n"
.'- CHATBOT_HANGUP_AFTER_NOANSWER(2, "拒识后机器人挂机"),'."\n"
.'- CHATBOT_HANGUP_AFTER_SILENCE(3, "静默超时挂机"),'."\n"
.'- CLIENT_HANGUP_AFTER_NOANSWER(4, "拒识后用户挂机"),'."\n"
.'- CLIENT_HANGUP(5, "用户无理由挂机"),'."\n"
.'- TRANSFER_BY_INTENT(6, "命中意图转人工"),'."\n"
.'- TRANSFER_AFTER_NOANSWER(7, "拒识转人工"),'."\n"
."\n"
.'- INO_INTERACTION(8, "用户侧无交互"),'."\n"
."\n"
.'- ERROR(9, "系统异常中断"),'."\n"
."\n"
.'- SPECIAL_INTERCEPT_VOICE_ASSISTANT(10, "特殊情况拦截-语音助手"),'."\n"
.'- SPECIAL_INTERCEPT_EXTENSION_NUMBER_TRANSFER(11, "特殊情况拦截-分机号转接")'."\n"
."\n"
.'>该参数类型为string,返回的为FINISHED之类的枚举值>',
'type' => 'string',
'example' => 'FINISHED',
],
],
'example' => '{}',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '返回信息。',
'type' => 'string',
'example' => 'Success',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'True',
],
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Task\\": {\\n \\"JobGroupId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"EndTime\\": 1640090211434,\\n \\"PlannedTime\\": 1640090211434,\\n \\"JobId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"CallId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"CallingNumber\\": \\"057190294\\",\\n \\"ActualTime\\": 1640090211434,\\n \\"InstanceId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"CalledNumber\\": \\"13777777777\\",\\n \\"Id\\": \\"2\\",\\n \\"Conversations\\": [\\n {\\n \\"Speaker\\": \\"Robot\\",\\n \\"Script\\": \\"你好,我是**客服\\",\\n \\"Timestamp\\": 1579068424883,\\n \\"Action\\": \\"Broadcast\\",\\n \\"SequenceId\\": \\"fd279983-93b9-b13b-9a34-64e5df473225\\"\\n }\\n ],\\n \\"EndReason\\": \\"FINISHED\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
'title' => '根据任务ID获取任务',
'changeSet' => [
[
'createdAt' => '2025-11-18T12:11:46.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2025-01-22T05:51:38.000Z',
'description' => '响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetTaskByUuid',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'GetVersion' => [
'summary' => '获取应用版本信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94109',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '1364f208-982d-4d0c-89aa-d56e22b47589',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Version' => [
'description' => '版本',
'type' => 'string',
'example' => 'v2.4.1.xxxxxxx_release',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1364f208-982d-4d0c-89aa-d56e22b47589\\",\\n \\"Success\\": true,\\n \\"Version\\": \\"v2.4.1.xxxxxxx_release\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '获取应用版本信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ImportScript' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '00b37342-e759-4fe5-b296-aef775933af0',
],
],
[
'name' => 'SignatureUrl',
'in' => 'query',
'schema' => [
'description' => '场景JSON文件对应的URL,使用该地址进行导入。'."\n"
."\n"
.'> 该参数值为GetJobDataUploadParams接口获取的Folder参数',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'UPLOADED/SCRIPT/136a055e-***-46c6-853a-731b3a2973de/18dc6d79-338f-413c-a5a8-dcce5f05b41a_9bd7916d-a340-4925-a911-92390cbe0f33.json'."\n",
],
],
[
'name' => 'NluEngine',
'in' => 'query',
'schema' => [
'description' => 'Nlu引擎(仅大模型场景适用)'."\n"
."\n"
.'枚举:'."\n"
.'- Prompts:大模型场景。'."\n"
.'- 非大模型场景则为空。',
'type' => 'string',
'required' => false,
'example' => 'Prompts',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'ScriptId' => [
'description' => '外呼场景ID',
'type' => 'string',
'example' => 'd7fbd0a0-27bc-49c4-a456-ecb75e79122b',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"ScriptId\\": \\"d7fbd0a0-27bc-49c4-a456-ecb75e79122b\\"\\n}","type":"json"}]',
'title' => '导入场景',
'summary' => '导入场景。',
'changeSet' => [
[
'createdAt' => '2024-08-06T12:39:33.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:ImportScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'InflightTaskTimeout' => [
'summary' => 'InflightTaskTimeout',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94111',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2d350e38-f561-49b0-85d3-b90d9fc7e052',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '6bc0585c-0a8a-46d8-b042-23570bbb4855',
],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => [
'description' => '实例所属的阿里云账号id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1864632921948620',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '任务超时',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:InflightTaskTimeout',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListAgentProfiles' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => [
'title' => 'instance id',
'description' => '实例 ID',
'type' => 'string',
'required' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'ScriptId',
'in' => 'formData',
'schema' => [
'title' => 'script id',
'description' => '场景ID',
'type' => 'string',
'required' => false,
'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95'."\n",
],
],
[
'name' => 'AppIp',
'in' => 'formData',
'schema' => [
'title' => 'app_ip , POP设置',
'description' => 'app_ip(系统字段,可不填)',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse>',
'description' => 'BaseResponse>',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '返回结果的提示信息。',
'type' => 'string',
'example' => 'Success',
],
'Data' => [
'description' => '返回数据',
'type' => 'array',
'items' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'CreateTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '1721701525327',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '1721701525327'."\n",
],
'AgentProfileId' => [
'title' => 'agent profile id',
'description' => '智能体配置ID',
'type' => 'string',
'example' => '37ca3ca1ac4b4e57adf3da5b5d939d04',
],
'InstanceId' => [
'title' => '实例id',
'description' => '实例ID',
'type' => 'string',
'example' => 'e49ad122-15a1-443a-a102-84a78a93be79',
],
'ScriptId' => [
'title' => 'script id',
'description' => '场景ID',
'type' => 'string',
'example' => '43972417-0657-452a-81c2-c59d8245a9b2',
],
'AgentType' => [
'title' => 'agent type',
'description' => 'agent type',
'type' => 'string',
'example' => '“”',
],
'PromptJson' => [
'title' => 'prompt json',
'description' => '智能体配置',
'type' => 'string',
'example' => '{"name":"小x","gender":"男","age":18,"role":"游戏推广员","communicationStyle":["亲切"],"goals":"你好","background":"不是很好","openingPrompt":"你好,我是xxx"}'."\n",
],
'Prompt' => [
'title' => 'prompt',
'description' => '提示词(专业模式)',
'type' => 'string',
'example' => '“”',
],
'AgentProfileTemplateId' => [
'title' => 'agent template id',
'description' => '智能体模版ID',
'type' => 'string',
'example' => 'default-survey'."\n",
],
'Model' => [
'title' => '模型id',
'description' => '模型ID',
'type' => 'string',
'example' => 'model_002',
],
'ModelConfig' => [
'title' => 'model config',
'description' => '模型配置',
'type' => 'string',
'example' => '{}',
],
'System' => [
'title' => '是否是系统模版',
'description' => '是否是系统模版',
'type' => 'boolean',
'example' => 'false',
],
'LabelsJson' => [
'title' => 'labels',
'description' => '标签描述',
'type' => 'string',
'example' => '[{\\"name\\":\\"是否送达\\",\\"description\\":\\"购买的家电是否已经送达\\",\\"valueList\\":\\"[\\\\\\"是\\\\\\",\\\\\\"否\\\\\\"]\\"},{\\"name\\":\\"预约上门时间\\",\\"description\\":\\"收集客户期望的上门安装时间\\",\\"valueList\\":\\"[]\\"}]'."\n",
],
'VariablesJson' => [
'title' => 'variables',
'description' => '变量配置',
'type' => 'string',
'example' => '[{\\"name\\":\\"name\\",\\"description\\":\\"客户姓名\\"},{\\"name\\":\\"gender\\",\\"description\\":\\"客户性别\\"}]'."\n",
],
'Scenario' => [
'title' => '场景',
'description' => '场景',
'type' => 'string',
'example' => '测试场景',
],
'Description' => [
'title' => '描述',
'description' => '描述',
'type' => 'string',
'example' => '这是一个充满智慧的智能体。',
],
'InstructionJson' => [
'description' => '指令配置',
'type' => 'string',
'example' => '[{"type":"TransferToAgent","instructions":[{"code":"Transfer0","skillGroupId":"123","skillGroupName":"123"}],"timeoutEnable":false},{"type":"CollectNumber","instructions":[]}]'."\n",
],
],
],
],
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExists.InstanceId',
'errorMessage' => 'The specified instance %s does not exist.',
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": [\\n {\\n \\"CreateTime\\": \\"1721701525327\\",\\n \\"UpdateTime\\": \\"1721701525327\\\\n\\",\\n \\"AgentProfileId\\": \\"37ca3ca1ac4b4e57adf3da5b5d939d04\\",\\n \\"InstanceId\\": \\"e49ad122-15a1-443a-a102-84a78a93be79\\",\\n \\"ScriptId\\": \\"43972417-0657-452a-81c2-c59d8245a9b2\\",\\n \\"AgentType\\": \\"“”\\",\\n \\"PromptJson\\": \\"{\\\\\\"name\\\\\\":\\\\\\"小x\\\\\\",\\\\\\"gender\\\\\\":\\\\\\"男\\\\\\",\\\\\\"age\\\\\\":18,\\\\\\"role\\\\\\":\\\\\\"游戏推广员\\\\\\",\\\\\\"communicationStyle\\\\\\":[\\\\\\"亲切\\\\\\"],\\\\\\"goals\\\\\\":\\\\\\"你好\\\\\\",\\\\\\"background\\\\\\":\\\\\\"不是很好\\\\\\",\\\\\\"openingPrompt\\\\\\":\\\\\\"你好,我是xxx\\\\\\"}\\\\n\\",\\n \\"Prompt\\": \\"“”\\",\\n \\"AgentProfileTemplateId\\": \\"default-survey\\\\n\\",\\n \\"Model\\": \\"model_002\\",\\n \\"ModelConfig\\": \\"{}\\",\\n \\"System\\": false,\\n \\"LabelsJson\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"是否送达\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"购买的家电是否已经送达\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"valueList\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"是\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"否\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"]\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"预约上门时间\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"收集客户期望的上门安装时间\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"valueList\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[]\\\\\\\\\\\\\\"}]\\\\n\\",\\n \\"VariablesJson\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"客户姓名\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"gender\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"客户性别\\\\\\\\\\\\\\"}]\\\\n\\",\\n \\"Scenario\\": \\"测试场景\\",\\n \\"Description\\": \\"这是一个充满智慧的智能体。\\",\\n \\"InstructionJson\\": \\"[{\\\\\\"type\\\\\\":\\\\\\"TransferToAgent\\\\\\",\\\\\\"instructions\\\\\\":[{\\\\\\"code\\\\\\":\\\\\\"Transfer0\\\\\\",\\\\\\"skillGroupId\\\\\\":\\\\\\"123\\\\\\",\\\\\\"skillGroupName\\\\\\":\\\\\\"123\\\\\\"}],\\\\\\"timeoutEnable\\\\\\":false},{\\\\\\"type\\\\\\":\\\\\\"CollectNumber\\\\\\",\\\\\\"instructions\\\\\\":[]}]\\\\n\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '获取智能体配置列表(已作废)',
'summary' => '获取该大模型场景下智能体配置的历史发布列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListAgentProfiles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListAllTenantBindNumberBinding' => [
'summary' => '租户绑定号码列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'True',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'Data' => [
'description' => '数据',
'type' => 'object',
'properties' => [
'List' => [
'description' => '数组',
'type' => 'array',
'items' => [
'description' => '返回对象',
'type' => 'object',
'properties' => [
'BindingId' => [
'description' => '绑定id',
'type' => 'string',
'example' => 'b5bfb844-ce85-4779-bc8f-161fba46aa07',
],
'Number' => [
'description' => '号码',
'type' => 'string',
'example' => '15005059355',
],
'TrunkName' => [
'description' => 'trunk名称',
'type' => 'string',
'example' => '小码-公共',
],
'SerializedParams' => [
'description' => '策略',
'type' => 'string',
'example' => '{\\"rateLimitPeriod\\":\\"1\\",\\"rateLimitCount\\":\\"1\\"}',
],
'InstanceNameList' => [
'description' => '实例名字列表',
'type' => 'array',
'items' => [
'description' => '实例名字列表',
'type' => 'string',
'example' => 'discover',
],
],
'BillingType' => [
'type' => 'string',
'description' => '',
],
],
],
],
],
],
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => 'A4BEAB4B-C810-5386-B72A-1A35FF1E6B15',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"BindingId\\": \\"b5bfb844-ce85-4779-bc8f-161fba46aa07\\",\\n \\"Number\\": \\"15005059355\\",\\n \\"TrunkName\\": \\"小码-公共\\",\\n \\"SerializedParams\\": \\"{\\\\\\\\\\\\\\"rateLimitPeriod\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rateLimitCount\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\",\\n \\"InstanceNameList\\": [\\n \\"discover\\"\\n ],\\n \\"BillingType\\": \\"\\"\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"A4BEAB4B-C810-5386-B72A-1A35FF1E6B15\\"\\n}","type":"json"}]',
'title' => '租户绑定的号码列表',
'changeSet' => [
[
'createdAt' => '2022-06-21T12:21:40.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2022-03-01T12:36:05.000Z',
'description' => 'OpenAPI 下线',
],
],
'flowControl' => [
'flowControlList' => [
[
'threshold' => '1000',
'countWindow' => 1,
'regionId' => '*',
'api' => 'ListAllTenantBindNumberBinding',
],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListAllTenantBindNumberBinding',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListAnnotationMission' => [
'summary' => '获取标注任务列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '129328',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'AnnotationMissionId',
'in' => 'query',
'schema' => [
'title' => '标注任务ID',
'description' => '标注任务ID',
'type' => 'string',
'required' => false,
'example' => '0943abcb-bd7d-4ace-8cf7-97d39d4dd0b9',
],
],
[
'name' => 'AnnotationMissionName',
'in' => 'query',
'schema' => [
'title' => '标注任务名称',
'description' => '标注任务名称',
'type' => 'string',
'required' => false,
'example' => '全景服务场景-标注任务-20230316-103253',
],
],
[
'name' => 'AnnotationStatusListFilter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标注状态过滤条件',
'description' => '标注状态过滤条件【历史参数,已弃用】',
'type' => 'array',
'items' => [
'description' => '过滤条件【已弃用】',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '[1]',
],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'AnnotationStatusListStringFilter',
'in' => 'query',
'schema' => [
'title' => '标注状态过滤条件',
'description' => '标注状态过滤条件'."\n"
."\n"
.'> 格式为[1],可以多选过滤条件,具体数组值含义如下'."\n"
."\n"
.'- 1:进行中'."\n"
.'- 2:已完成'."\n"
.'- 3:已关闭',
'type' => 'string',
'required' => false,
'example' => '[1]',
],
],
[
'name' => 'CreateTimeStartFilter',
'in' => 'query',
'schema' => [
'title' => '标注任务创建过滤开始时间',
'description' => '标注任务创建过滤开始时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1661961600000',
],
],
[
'name' => 'CreateTimeEndFilter',
'in' => 'query',
'schema' => [
'title' => '标注任务创建过滤截止时间',
'description' => '标注任务创建过滤截止时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1673280000000',
],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '0',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
'default' => '0',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => false,
'example' => '191ef468-75a2-4004-9441-a5c31bf5cd9d',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否调用成功。true:表示调用成功。false:表示调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '附加信息。取值说明如下:请求正常,返回success。请求异常,返回具体异常错误码。',
'type' => 'string',
'example' => 'CDR \'job-c7b8a817-b8e8-40f3-b7ad-f28dcea218ff\' doesn\'t exists.',
],
'Data' => [
'description' => '数据',
'type' => 'object',
'properties' => [
'AnnotationMissionList' => [
'description' => '标注任务列表',
'type' => 'array',
'items' => [
'description' => '标注任务',
'type' => 'object',
'properties' => [
'AnnotationMissionDataSourceType' => [
'description' => '标注数据来源,1:外呼、2:导航',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => '32be9d94-1346-4c4a-a4d0-ccd379f87013',
],
'AnnotationMissionId' => [
'description' => '任务ID',
'type' => 'string',
'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9',
],
'AnnotationMissionName' => [
'description' => '任务名称',
'type' => 'string',
'example' => '体验场景--移车-标注任务-20230220-141347',
],
'AnnotationStatus' => [
'description' => '标注状态'."\n"
.'- 1:进行中'."\n"
.'- 2:已完成'."\n"
.'- 3:已关闭',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1676170339515',
],
'SessionTotalCount' => [
'description' => '标注任务总数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SessionFinishCount' => [
'description' => '标注任务完成数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'FinishTime' => [
'description' => '标注任务完成时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1683443903785',
],
'ExcludeOtherMissionSession' => [
'description' => '是否排除其他任务已标注的通话记录',
'type' => 'boolean',
'example' => 'false',
],
'SessionEndReasonFilterList' => [
'description' => '创建任务使用的通话结束类型列表'."\n"
.'- 1:正常完结'."\n"
.'- 2:拒识后机器人挂机'."\n"
.'- 3:静默超时挂机'."\n"
.'- 4:拒识后用户挂机'."\n"
.'- 5:用户无理由挂机'."\n"
.'- 6:命中意图转人工'."\n"
.'- 7:拒识转人工'."\n"
.'- 8:用户侧无交互'."\n"
.'- 9:系统异常中断'."\n"
.'- 10:命中意图转IVR'."\n"
.'- 11:拒识别转IVR',
'type' => 'array',
'items' => [
'description' => '创建任务使用的通话结束类型',
'type' => 'integer',
'format' => 'int32',
'example' => '[1]',
],
],
'ConversationTimeStartFilter' => [
'description' => '标注任务通话时间查询条件开始时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1683216000000',
],
'ConversationTimeEndFilter' => [
'description' => '标注任务通话时间查询条件结束时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1684511999000',
],
'SamplingType' => [
'description' => '抽样类型',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SamplingRate' => [
'description' => '抽样比例',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SamplingCount' => [
'description' => '抽样数量最大值限制',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SamplingDescription' => [
'description' => '抽样描述',
'type' => 'string',
'example' => '标注',
],
'AnnotationMissionDebugDataSourceList' => [
'description' => '标注调试数据源列表'."\n"
."\n"
.'> 注意,返回时,会多一个0,返回值为:[0,1]、[0,2]、[0,1,2]',
'type' => 'array',
'items' => [
'description' => '标注调试数据源'."\n"
."\n"
.'- 1:外呼任务'."\n"
.'- 2:测试任务',
'type' => 'integer',
'format' => 'int32',
'example' => '[1]',
],
],
],
],
],
'PageIndex' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'TotalPageCount' => [
'description' => '总页数',
'type' => 'integer',
'format' => 'int64',
'example' => '4',
],
'Success' => [
'description' => '是否调用成功。true:表示调用成功。false:表示调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '附加信息。取值说明如下:请求正常,返回success。请求异常,返回具体异常错误码。',
'type' => 'string',
'example' => 'CDR \'job-c7b8a817-b8e8-40f3-b7ad-f28dcea218ff\' doesn\'t exists.',
],
],
],
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"CDR \'job-c7b8a817-b8e8-40f3-b7ad-f28dcea218ff\' doesn\'t exists.\\",\\n \\"Data\\": {\\n \\"AnnotationMissionList\\": [\\n {\\n \\"AnnotationMissionDataSourceType\\": 1,\\n \\"InstanceId\\": \\"32be9d94-1346-4c4a-a4d0-ccd379f87013\\",\\n \\"AnnotationMissionId\\": \\"ddce607f-f537-4ebd-9914-cf45671defb9\\",\\n \\"AnnotationMissionName\\": \\"体验场景--移车-标注任务-20230220-141347\\",\\n \\"AnnotationStatus\\": 1,\\n \\"CreateTime\\": 1676170339515,\\n \\"SessionTotalCount\\": 1,\\n \\"SessionFinishCount\\": 1,\\n \\"FinishTime\\": 1683443903785,\\n \\"ExcludeOtherMissionSession\\": false,\\n \\"SessionEndReasonFilterList\\": [\\n 0\\n ],\\n \\"ConversationTimeStartFilter\\": 1683216000000,\\n \\"ConversationTimeEndFilter\\": 1684511999000,\\n \\"SamplingType\\": 1,\\n \\"SamplingRate\\": 1,\\n \\"SamplingCount\\": 1,\\n \\"SamplingDescription\\": \\"标注\\",\\n \\"AnnotationMissionDebugDataSourceList\\": [\\n 0\\n ]\\n }\\n ],\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 30,\\n \\"TotalPageCount\\": 4,\\n \\"Success\\": true,\\n \\"Message\\": \\"CDR \'job-c7b8a817-b8e8-40f3-b7ad-f28dcea218ff\' doesn\'t exists.\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '获取标注任务列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListAnnotationMission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListAnnotationMissionSession' => [
'summary' => 'ListAnnotationMissionSession',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '130000',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'AnnotationMissionId',
'in' => 'query',
'schema' => [
'description' => '任务id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '8434a4b0-41fc-41b1-aa75-bbd1f2ab0c8d',
],
],
[
'name' => 'AnnotationMissionSessionId',
'in' => 'query',
'schema' => [
'description' => '标注任务chat实例ID'."\n"
."\n"
.'> 通过SaveAnnotationMissionSessionList接口获取',
'type' => 'string',
'required' => false,
'example' => '8434a4b0-41fc-41b1-aa75-bbd1f2ab0c8d'."\n",
],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '3',
'default' => '0',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的记录数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '0',
],
],
[
'name' => 'Environment',
'in' => 'query',
'schema' => [
'description' => '环境'."\n"
."\n"
.'> 默认为2'."\n"
."\n"
.'**枚举值**'."\n"
.'- 0:NONE'."\n"
.'- 1:私有云'."\n"
.'- 2:公有云',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'IncludeStatusListJsonString',
'in' => 'query',
'schema' => [
'description' => '包含的状态列表'."\n"
."\n"
.'> 格式为[1],数组内填入具体的枚举值'."\n"
."\n"
.'**枚举值**'."\n"
.'- 1:识别正确'."\n"
.'- 2:识别错误'."\n"
.'- 8:无效数据'."\n"
.'- 4:未覆盖意图'."\n"
.'- 16:转译误识别',
'type' => 'string',
'required' => false,
'example' => '[1]',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否调用成功。true:表示调用成功。false:表示调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '附加信息。取值说明如下:请求正常,返回success。请求异常,返回具体异常错误码。',
'type' => 'string',
'example' => 'bp.java.nopowerContact',
],
'Data' => [
'description' => '数据',
'type' => 'object',
'properties' => [
'AnnotationMissionId' => [
'description' => '任务ID',
'type' => 'string',
'example' => 'b3f2c931-5180-43ca-b4aa-2baee2d73c8b',
],
'AnnotationMissionSessionList' => [
'description' => '会话列表',
'type' => 'array',
'items' => [
'description' => '会话',
'type' => 'object',
'properties' => [
'AnnotationMissionSessionId' => [
'description' => '会话ID',
'type' => 'string',
'example' => '64ba5ac9-a4e1-4333-b03c-9d4a588c9f6c'."\n",
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1691117009000',
],
'ModifiedTime' => [
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1677987898384',
],
'AnnotationMissionId' => [
'description' => '任务id',
'type' => 'string',
'example' => '64ba5ac9-a4e1-4333-b03c-9d4a588c9f6c',
],
'InstanceId' => [
'description' => '实例id',
'type' => 'string',
'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => '408d6c4d-23e2-41f6-bbdd-f919a8297aa4',
],
'JobGroupId' => [
'description' => '任务组ID',
'type' => 'string',
'example' => '2f642da1-b00b-4dd6-ac7d-dcbeefd13ff3',
],
'JobId' => [
'description' => '任务ID',
'type' => 'string',
'example' => '42da7cde-a5e8-45cc-b9d2-828711d95b30',
],
'SessionId' => [
'description' => '外呼系统为taskId,导航为conversationId',
'type' => 'string',
'example' => '40669e52-c1c8-487f-9593-29749086bdc9',
],
'AnnotationStatus' => [
'description' => '标注状态'."\n"
."\n"
.'- 0:未完成(UNDO)'."\n"
.'- 1:进行中(DOING)'."\n"
.'- 2:已完成(DONE)'."\n"
.'- 3:已取消(CLOSED)',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AnnotationMissionChatList' => [
'description' => 'chat列表',
'type' => 'array',
'items' => [
'description' => 'chat对象',
'type' => 'object',
'properties' => [
'AnnotationMissionChatId' => [
'description' => 'chat id',
'type' => 'string',
'example' => '40669e52-c1c8-487f-9593-29749086bdc9'."\n",
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1682216045619',
],
'ModifiedTime' => [
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1571649300000',
],
'AnnotationMissionId' => [
'description' => '任务id',
'type' => 'string',
'example' => '03f56192-fa8a-40dc-9558-39b357f0618f',
],
'AnnotationMissionSessionId' => [
'description' => '会话id',
'type' => 'string',
'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n",
],
'InstanceId' => [
'description' => '实例id',
'type' => 'string',
'example' => '77343553-cbc2-4487-a35c-869f1e86c573',
],
'SequenceId' => [
'description' => '序列id',
'type' => 'string',
'example' => '380578077',
],
'OccurTime' => [
'description' => '触发时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1682390676403',
],
'Answer' => [
'description' => '机器人答复内容',
'type' => 'string',
'example' => '{\'Answer\': u\'\\u53c2\\u8003\\u6587\\u6863\\uff1ahttps://help.aliyun.com/document_detail/215402.html\', \'QuestionId\': 371159, \'Uuid\': \'ac14000116781568127896224d0044\'}',
],
'AnnotationStatus' => [
'description' => 'chat标注状态'."\n"
.'- 0:未完成(UNDO)'."\n"
.'- 1:进行中(DOING)'."\n"
.'- 2:已完成(DONE)'."\n"
.'- 3:已取消(CLOSED)',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'IntentAnnotationStatus' => [
'title' => '语义标注状态',
'description' => '语义标注状态'."\n"
.'- 0:未完成(UNDO)'."\n"
.'- 1:进行中(DOING)'."\n"
.'- 2:已完成(DONE)'."\n"
.'- 3:已取消(CLOSED)',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AsrAnnotationStatus' => [
'title' => 'ASR标注状态',
'description' => 'ASR标注状态'."\n"
.'- 0:未完成(UNDO)'."\n"
.'- 1:进行中(DOING)'."\n"
.'- 2:已完成(DONE)'."\n"
.'- 3:已取消(CLOSED)',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TagAnnotationStatus' => [
'title' => '标签标注状态',
'description' => '标签标注状态'."\n"
.'- 0:未完成(UNDO)'."\n"
.'- 1:进行中(DOING)'."\n"
.'- 2:已完成(DONE)'."\n"
.'- 3:已取消(CLOSED)',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SubStatus' => [
'title' => '标注动作:1正确、20匹配错误未优化 21匹配错误已优化、3未覆盖、4无效',
'description' => '标注动作:1正确、20匹配错误未优化 21匹配错误已优化、3未覆盖、4无效',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TranslationError' => [
'description' => '转译错误标识'."\n"
.'- 0:否'."\n"
.'- 1:是',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AnnotationAsrResult' => [
'description' => 'ASR人工标注文本结果,用于字准率的计算',
'type' => 'string',
'example' => '[]',
],
'OriginalAsrResult' => [
'description' => 'ASR识别结果',
'type' => 'string',
'example' => '[]',
],
'AnnotationMissionChatIntentUserSayInfoList' => [
'description' => 'chat意图列表',
'type' => 'array',
'items' => [
'description' => 'chat意图',
'type' => 'object',
'properties' => [
'AnnotationMissionChatIntentUserSayInfoId' => [
'description' => 'ID',
'type' => 'string',
'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n",
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1682216045619',
],
'ModifiedTime' => [
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1682216045619',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n",
],
'AnnotationMissionId' => [
'description' => '标注任务ID',
'type' => 'string',
'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n",
],
'AnnotationMissionSessionId' => [
'description' => '会话ID',
'type' => 'string',
'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n",
],
'AnnotationMissionChatId' => [
'description' => 'ChatID',
'type' => 'string',
'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n",
],
'Content' => [
'description' => '修改后问法',
'type' => 'string',
'example' => '[]',
],
'IntentId' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'example' => '11234112',
],
'DialogId' => [
'description' => '对话ID',
'type' => 'integer',
'format' => 'int64',
'example' => '29921312',
],
'BotId' => [
'description' => '机器人ID',
'type' => 'string',
'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n",
],
'Delete' => [
'description' => '已删除',
'type' => 'boolean',
'example' => 'true',
],
'Create' => [
'description' => '已创建',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
'AnnotationMissionChatVocabularyInfoList' => [
'description' => '标注任务chat热词标注信息表',
'type' => 'array',
'items' => [
'description' => '标注任务chat热词标注信息',
'type' => 'object',
'properties' => [
'AnnotationMissionChatVocabularyInfoId' => [
'description' => 'ID',
'type' => 'string',
'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n",
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1675218421941',
],
'ModifiedTime' => [
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1676272557653',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => '818961ce-d9ba-4f88-89ca-2a04b24bdf01',
],
'AnnotationMissionId' => [
'description' => '任务ID',
'type' => 'string',
'example' => 'b3f2c931-5180-43ca-b4aa-2baee2d73c8b',
],
'AnnotationMissionSessionId' => [
'description' => '会话ID',
'type' => 'string',
'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n",
],
'AnnotationMissionChatId' => [
'description' => 'ChatID',
'type' => 'string',
'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n",
],
'VocabularyId' => [
'description' => '热词ID',
'type' => 'string',
'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n",
],
'Vocabulary' => [
'description' => '热词标注内容',
'type' => 'string',
'example' => '[]',
],
'VocabularyName' => [
'description' => 'vocabulary名称',
'type' => 'string',
'example' => '名称',
],
'VocabularyDescription' => [
'description' => '描述',
'type' => 'string',
'example' => '描述',
],
'VocabularyWeight' => [
'description' => '热词权重[-6,5]',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Delete' => [
'description' => '已删除',
'type' => 'boolean',
'example' => 'true',
],
'Create' => [
'description' => '已创建',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
'AnnotationMissionChatCustomizationDataInfoList' => [
'description' => '标注任务chat语言模型标注信息表',
'type' => 'array',
'items' => [
'description' => '标注任务chat语言模型标注信息',
'type' => 'object',
'properties' => [
'AnnotationMissionChatCustomizationDataInfoId' => [
'description' => 'ID',
'type' => 'string',
'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n",
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1682216045619',
],
'ModifiedTime' => [
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1679552585384',
],
'InstanceId' => [
'description' => '实例id',
'type' => 'string',
'example' => 'd3fbfca8-4208-4d4b-a53a-c4dba5e43a66',
],
'AnnotationMissionId' => [
'description' => '任务ID',
'type' => 'string',
'example' => '2f03b24a-fda2-4501-90ba-0a9a59f8dd9d',
],
'AnnotationMissionSessionId' => [
'description' => '会话id',
'type' => 'string',
'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n",
],
'AnnotationMissionChatId' => [
'description' => 'ChatID',
'type' => 'string',
'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n",
],
'CustomizationDataId' => [
'description' => '自定义数据ID',
'type' => 'string',
'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n",
],
'Content' => [
'description' => '语音标注文本',
'type' => 'string',
'example' => '抱歉哈,可能给您造成困扰了,这边先不打扰您,祝您生活愉快,再见',
],
'CustomizationDataName' => [
'description' => '名称',
'type' => 'string',
'example' => '默认数据',
],
'CustomizationDataDescription' => [
'description' => '描述',
'type' => 'string',
'example' => '默认数据',
],
'CustomizationDataWeight' => [
'description' => '语言模型数据权重',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Delete' => [
'description' => '是否已删除。',
'type' => 'boolean',
'example' => 'true',
],
'Create' => [
'description' => '是否创建',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
'AnnotationMissionChatTagInfoList' => [
'description' => '标注信息chat绑定标签映射关系列表',
'type' => 'array',
'items' => [
'description' => '标注信息chat绑定标签映射关系',
'type' => 'object',
'properties' => [
'AnnotationMissionChatTagInfoId' => [
'description' => '注释Chat标签信息ID',
'type' => 'string',
'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n",
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1686797050000',
],
'ModifiedTime' => [
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1679019660000',
],
'InstanceId' => [
'description' => '实例id',
'type' => 'string',
'example' => '32be9d94-1346-4c4a-a4d0-ccd379f87013',
],
'AnnotationMissionId' => [
'description' => '任务ID',
'type' => 'string',
'example' => 'e7272cbb-a60d-4b41-b5c4-8863edc0b8f7',
],
'AnnotationMissionSessionId' => [
'description' => '会话ID',
'type' => 'string',
'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n",
],
'AnnotationMissionChatId' => [
'description' => 'ChatID',
'type' => 'string',
'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n",
],
'AnnotationMissionTagInfoId' => [
'description' => 'TagID',
'type' => 'string',
'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n",
],
'AnnotationMissionTagInfoName' => [
'description' => 'Tag名称',
'type' => 'string',
'example' => '标签',
],
'Delete' => [
'description' => '删除',
'type' => 'boolean',
'example' => 'true',
],
'Create' => [
'description' => '创建',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
'Version' => [
'description' => '版本号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'DebugConversation' => [
'description' => '调试对话',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
'Success' => [
'description' => '是否调用成功。true:表示调用成功。false:表示调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '附加信息。取值说明如下:请求正常,返回success。请求异常,返回具体异常错误码。',
'type' => 'string',
'example' => 'bp.java.nopowerContact',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
],
],
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"bp.java.nopowerContact\\",\\n \\"Data\\": {\\n \\"AnnotationMissionId\\": \\"b3f2c931-5180-43ca-b4aa-2baee2d73c8b\\",\\n \\"AnnotationMissionSessionList\\": [\\n {\\n \\"AnnotationMissionSessionId\\": \\"64ba5ac9-a4e1-4333-b03c-9d4a588c9f6c\\\\n\\",\\n \\"CreateTime\\": 1691117009000,\\n \\"ModifiedTime\\": 1677987898384,\\n \\"AnnotationMissionId\\": \\"64ba5ac9-a4e1-4333-b03c-9d4a588c9f6c\\",\\n \\"InstanceId\\": \\"a4274627-265f-4e14-b2d6-4ee7d4f8593e\\",\\n \\"ScriptId\\": \\"408d6c4d-23e2-41f6-bbdd-f919a8297aa4\\",\\n \\"JobGroupId\\": \\"2f642da1-b00b-4dd6-ac7d-dcbeefd13ff3\\",\\n \\"JobId\\": \\"42da7cde-a5e8-45cc-b9d2-828711d95b30\\",\\n \\"SessionId\\": \\"40669e52-c1c8-487f-9593-29749086bdc9\\",\\n \\"AnnotationStatus\\": 1,\\n \\"AnnotationMissionChatList\\": [\\n {\\n \\"AnnotationMissionChatId\\": \\"40669e52-c1c8-487f-9593-29749086bdc9\\\\n\\",\\n \\"CreateTime\\": 1682216045619,\\n \\"ModifiedTime\\": 1571649300000,\\n \\"AnnotationMissionId\\": \\"03f56192-fa8a-40dc-9558-39b357f0618f\\",\\n \\"AnnotationMissionSessionId\\": \\"03f56192-fa8a-40dc-9558-39b357f0618f\\\\n\\",\\n \\"InstanceId\\": \\"77343553-cbc2-4487-a35c-869f1e86c573\\",\\n \\"SequenceId\\": \\"380578077\\",\\n \\"OccurTime\\": 1682390676403,\\n \\"Answer\\": \\"{\'Answer\': u\'\\\\\\\\u53c2\\\\\\\\u8003\\\\\\\\u6587\\\\\\\\u6863\\\\\\\\uff1ahttps://help.aliyun.com/document_detail/215402.html\', \'QuestionId\': 371159, \'Uuid\': \'ac14000116781568127896224d0044\'}\\",\\n \\"AnnotationStatus\\": 1,\\n \\"IntentAnnotationStatus\\": 1,\\n \\"AsrAnnotationStatus\\": 1,\\n \\"TagAnnotationStatus\\": 1,\\n \\"SubStatus\\": 1,\\n \\"TranslationError\\": 1,\\n \\"AnnotationAsrResult\\": \\"[]\\",\\n \\"OriginalAsrResult\\": \\"[]\\",\\n \\"AnnotationMissionChatIntentUserSayInfoList\\": [\\n {\\n \\"AnnotationMissionChatIntentUserSayInfoId\\": \\"03f56192-fa8a-40dc-9558-39b357f0618f\\\\n\\",\\n \\"CreateTime\\": 1682216045619,\\n \\"ModifiedTime\\": 1682216045619,\\n \\"InstanceId\\": \\"77343553-cbc2-4487-a35c-869f1e86c573\\\\n\\",\\n \\"AnnotationMissionId\\": \\"77343553-cbc2-4487-a35c-869f1e86c573\\\\n\\",\\n \\"AnnotationMissionSessionId\\": \\"77343553-cbc2-4487-a35c-869f1e86c573\\\\n\\",\\n \\"AnnotationMissionChatId\\": \\"77343553-cbc2-4487-a35c-869f1e86c573\\\\n\\",\\n \\"Content\\": \\"[]\\",\\n \\"IntentId\\": 11234112,\\n \\"DialogId\\": 29921312,\\n \\"BotId\\": \\"77343553-cbc2-4487-a35c-869f1e86c573\\\\n\\",\\n \\"Delete\\": true,\\n \\"Create\\": false\\n }\\n ],\\n \\"AnnotationMissionChatVocabularyInfoList\\": [\\n {\\n \\"AnnotationMissionChatVocabularyInfoId\\": \\"03f56192-fa8a-40dc-9558-39b357f0618f\\\\n\\",\\n \\"CreateTime\\": 1675218421941,\\n \\"ModifiedTime\\": 1676272557653,\\n \\"InstanceId\\": \\"818961ce-d9ba-4f88-89ca-2a04b24bdf01\\",\\n \\"AnnotationMissionId\\": \\"b3f2c931-5180-43ca-b4aa-2baee2d73c8b\\",\\n \\"AnnotationMissionSessionId\\": \\"77343553-cbc2-4487-a35c-869f1e86c573\\\\n\\",\\n \\"AnnotationMissionChatId\\": \\"77343553-cbc2-4487-a35c-869f1e86c573\\\\n\\",\\n \\"VocabularyId\\": \\"77343553-cbc2-4487-a35c-869f1e86c573\\\\n\\",\\n \\"Vocabulary\\": \\"[]\\",\\n \\"VocabularyName\\": \\"名称\\",\\n \\"VocabularyDescription\\": \\"描述\\",\\n \\"VocabularyWeight\\": 0,\\n \\"Delete\\": true,\\n \\"Create\\": true\\n }\\n ],\\n \\"AnnotationMissionChatCustomizationDataInfoList\\": [\\n {\\n \\"AnnotationMissionChatCustomizationDataInfoId\\": \\"03f56192-fa8a-40dc-9558-39b357f0618f\\\\n\\",\\n \\"CreateTime\\": 1682216045619,\\n \\"ModifiedTime\\": 1679552585384,\\n \\"InstanceId\\": \\"d3fbfca8-4208-4d4b-a53a-c4dba5e43a66\\",\\n \\"AnnotationMissionId\\": \\"2f03b24a-fda2-4501-90ba-0a9a59f8dd9d\\",\\n \\"AnnotationMissionSessionId\\": \\"03f56192-fa8a-40dc-9558-39b357f0618f\\\\n\\",\\n \\"AnnotationMissionChatId\\": \\"03f56192-fa8a-40dc-9558-39b357f0618f\\\\n\\",\\n \\"CustomizationDataId\\": \\"03f56192-fa8a-40dc-9558-39b357f0618f\\\\n\\",\\n \\"Content\\": \\"抱歉哈,可能给您造成困扰了,这边先不打扰您,祝您生活愉快,再见\\",\\n \\"CustomizationDataName\\": \\"默认数据\\",\\n \\"CustomizationDataDescription\\": \\"默认数据\\",\\n \\"CustomizationDataWeight\\": 1,\\n \\"Delete\\": true,\\n \\"Create\\": true\\n }\\n ],\\n \\"AnnotationMissionChatTagInfoList\\": [\\n {\\n \\"AnnotationMissionChatTagInfoId\\": \\"03f56192-fa8a-40dc-9558-39b357f0618f\\\\n\\",\\n \\"CreateTime\\": 1686797050000,\\n \\"ModifiedTime\\": 1679019660000,\\n \\"InstanceId\\": \\"32be9d94-1346-4c4a-a4d0-ccd379f87013\\",\\n \\"AnnotationMissionId\\": \\"e7272cbb-a60d-4b41-b5c4-8863edc0b8f7\\",\\n \\"AnnotationMissionSessionId\\": \\"03f56192-fa8a-40dc-9558-39b357f0618f\\\\n\\",\\n \\"AnnotationMissionChatId\\": \\"03f56192-fa8a-40dc-9558-39b357f0618f\\\\n\\",\\n \\"AnnotationMissionTagInfoId\\": \\"03f56192-fa8a-40dc-9558-39b357f0618f\\\\n\\",\\n \\"AnnotationMissionTagInfoName\\": \\"标签\\",\\n \\"Delete\\": true,\\n \\"Create\\": true\\n }\\n ]\\n }\\n ],\\n \\"Version\\": 1,\\n \\"DebugConversation\\": true\\n }\\n ],\\n \\"Success\\": true,\\n \\"Message\\": \\"bp.java.nopowerContact\\",\\n \\"TotalCount\\": 30\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '获取标注任务chat实例列表',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListAnnotationMissionSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListApiPlugins' => [
'methods' => [
'get',
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '251341',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => '024f8cf0-c842-4c01-b74b-c8667e4579c7',
],
],
[
'name' => 'UuidsJson',
'in' => 'query',
'schema' => [
'description' => 'API插件唯一标识列表',
'type' => 'string',
'required' => false,
'example' => '["d17d5bfa-4972-4389-9718-f9602edabe48"]',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'ApiPlugins' => [
'description' => 'API插件列表',
'type' => 'array',
'items' => [
'description' => 'API插件配置',
'type' => 'object',
'properties' => [
'DraftedConfigJson' => [
'description' => '草稿状态配置',
'type' => 'string',
'example' => '{'."\n"
.' "description": "测试-2",'."\n"
.' "functionMeta": {'."\n"
.' "failoverRegionWeight": 0.5,'."\n"
.' "functionMetaId": "a9127136087e4172b31b8f400430d63b",'."\n"
.' "functionName": "yongyu-stream-2",'."\n"
.' "regionId": "cn-hangzhou"'."\n"
.' },'."\n"
.' "inputParams": [{'."\n"
.' "debugValue": "1112",'."\n"
.' "description": "测试",'."\n"
.' "name": "test",'."\n"
.' "required": false,'."\n"
.' "type": "String",'."\n"
.' "valueSource": "Var"'."\n"
.' }],'."\n"
.' "name": "测试插件01",'."\n"
.' "outputParams": [{'."\n"
.' "description": "直接返回API结果,并作为提示词输入给模型",'."\n"
.' "name": "result",'."\n"
.' "type": "String"'."\n"
.' }],'."\n"
.' "timeout": 5,'."\n"
.' "transitionContent": "稍等,和您确认下信息。",'."\n"
.' "type": "Function"'."\n"
.'}',
],
'Status' => [
'description' => '状态。'."\n"
."\n"
.'- Drafted 草稿'."\n"
.'- Published 已发布'."\n"
.'- PublishedAndEdited 已发布(已编辑)',
'type' => 'string',
'enumValueTitles' => [
'Drafted' => 'Drafted',
'Published' => 'Published',
'PublishedAndEdited' => 'PublishedAndEdited',
],
'example' => 'Drafted',
],
'Type' => [
'description' => '类型',
'type' => 'string',
'enumValueTitles' => [
'Function' => 'Function',
],
'example' => 'Function',
],
'PublishedConfigJson' => [
'description' => '发布配置',
'type' => 'string',
'example' => '{'."\n"
.' "description": "发布-2",'."\n"
.' "functionMeta": {'."\n"
.' "failoverRegionWeight": 0.5,'."\n"
.' "functionMetaId": "c4af5815daaa485bb8118be6b2f14058",'."\n"
.' "functionName": "yongyu-stream-2",'."\n"
.' "regionId": "cn-hangzhou"'."\n"
.' },'."\n"
.' "inputParams": [{'."\n"
.' "debugValue": "111",'."\n"
.' "description": "发布",'."\n"
.' "name": "test",'."\n"
.' "required": false,'."\n"
.' "type": "String",'."\n"
.' "valueSource": "Var"'."\n"
.' }],'."\n"
.' "name": "发布插件",'."\n"
.' "outputParams": [{'."\n"
.' "description": "直接返回API结果,并作为提示词输入给模型",'."\n"
.' "name": "result",'."\n"
.' "type": "String"'."\n"
.' }],'."\n"
.' "timeout": 5,'."\n"
.' "transitionContent": "稍等,和您确认下信息。",'."\n"
.' "type": "Function"'."\n"
.'}',
],
'Uuid' => [
'description' => '插件唯一标识',
'type' => 'string',
'example' => 'e1a3c448-20cf-4586-8aa2-4cdca75f7c20',
],
'Description' => [
'description' => '描述信息。',
'type' => 'string',
'example' => '这个插件是用来xxx.....',
],
'GmtCreate' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1666230851000',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => '7c0e5b5e-a839-4999-8301-2c7d07a1f16f',
],
'GmtModified' => [
'description' => '更新时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1641891940000',
],
'Name' => [
'description' => '插件名称',
'type' => 'string',
'example' => '这是一个插件',
],
],
],
],
'PageSize' => [
'description' => '每页展示的条数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"ApiPlugins\\": [\\n {\\n \\"DraftedConfigJson\\": \\"{\\\\n\\\\t\\\\\\"description\\\\\\": \\\\\\"测试-2\\\\\\",\\\\n\\\\t\\\\\\"functionMeta\\\\\\": {\\\\n\\\\t\\\\t\\\\\\"failoverRegionWeight\\\\\\": 0.5,\\\\n\\\\t\\\\t\\\\\\"functionMetaId\\\\\\": \\\\\\"a9127136087e4172b31b8f400430d63b\\\\\\",\\\\n\\\\t\\\\t\\\\\\"functionName\\\\\\": \\\\\\"yongyu-stream-2\\\\\\",\\\\n\\\\t\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\"\\\\n\\\\t},\\\\n\\\\t\\\\\\"inputParams\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"debugValue\\\\\\": \\\\\\"1112\\\\\\",\\\\n\\\\t\\\\t\\\\\\"description\\\\\\": \\\\\\"测试\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"test\\\\\\",\\\\n\\\\t\\\\t\\\\\\"required\\\\\\": false,\\\\n\\\\t\\\\t\\\\\\"type\\\\\\": \\\\\\"String\\\\\\",\\\\n\\\\t\\\\t\\\\\\"valueSource\\\\\\": \\\\\\"Var\\\\\\"\\\\n\\\\t}],\\\\n\\\\t\\\\\\"name\\\\\\": \\\\\\"测试插件01\\\\\\",\\\\n\\\\t\\\\\\"outputParams\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"description\\\\\\": \\\\\\"直接返回API结果,并作为提示词输入给模型\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"result\\\\\\",\\\\n\\\\t\\\\t\\\\\\"type\\\\\\": \\\\\\"String\\\\\\"\\\\n\\\\t}],\\\\n\\\\t\\\\\\"timeout\\\\\\": 5,\\\\n\\\\t\\\\\\"transitionContent\\\\\\": \\\\\\"稍等,和您确认下信息。\\\\\\",\\\\n\\\\t\\\\\\"type\\\\\\": \\\\\\"Function\\\\\\"\\\\n}\\",\\n \\"Status\\": \\"Drafted\\",\\n \\"Type\\": \\"Function\\",\\n \\"PublishedConfigJson\\": \\"{\\\\n\\\\t\\\\\\"description\\\\\\": \\\\\\"发布-2\\\\\\",\\\\n\\\\t\\\\\\"functionMeta\\\\\\": {\\\\n\\\\t\\\\t\\\\\\"failoverRegionWeight\\\\\\": 0.5,\\\\n\\\\t\\\\t\\\\\\"functionMetaId\\\\\\": \\\\\\"c4af5815daaa485bb8118be6b2f14058\\\\\\",\\\\n\\\\t\\\\t\\\\\\"functionName\\\\\\": \\\\\\"yongyu-stream-2\\\\\\",\\\\n\\\\t\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\"\\\\n\\\\t},\\\\n\\\\t\\\\\\"inputParams\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"debugValue\\\\\\": \\\\\\"111\\\\\\",\\\\n\\\\t\\\\t\\\\\\"description\\\\\\": \\\\\\"发布\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"test\\\\\\",\\\\n\\\\t\\\\t\\\\\\"required\\\\\\": false,\\\\n\\\\t\\\\t\\\\\\"type\\\\\\": \\\\\\"String\\\\\\",\\\\n\\\\t\\\\t\\\\\\"valueSource\\\\\\": \\\\\\"Var\\\\\\"\\\\n\\\\t}],\\\\n\\\\t\\\\\\"name\\\\\\": \\\\\\"发布插件\\\\\\",\\\\n\\\\t\\\\\\"outputParams\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"description\\\\\\": \\\\\\"直接返回API结果,并作为提示词输入给模型\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"result\\\\\\",\\\\n\\\\t\\\\t\\\\\\"type\\\\\\": \\\\\\"String\\\\\\"\\\\n\\\\t}],\\\\n\\\\t\\\\\\"timeout\\\\\\": 5,\\\\n\\\\t\\\\\\"transitionContent\\\\\\": \\\\\\"稍等,和您确认下信息。\\\\\\",\\\\n\\\\t\\\\\\"type\\\\\\": \\\\\\"Function\\\\\\"\\\\n}\\",\\n \\"Uuid\\": \\"e1a3c448-20cf-4586-8aa2-4cdca75f7c20\\",\\n \\"Description\\": \\"这个插件是用来xxx.....\\",\\n \\"GmtCreate\\": 1666230851000,\\n \\"InstanceId\\": \\"7c0e5b5e-a839-4999-8301-2c7d07a1f16f\\",\\n \\"GmtModified\\": 1641891940000,\\n \\"Name\\": \\"这是一个插件\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
'title' => '查询API插件列表',
'summary' => '查询API插件列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListApiPlugins',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListBeebotIntent' => [
'summary' => '小模型场景中展示意图列表。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '224571',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'IntentName',
'in' => 'query',
'schema' => [
'description' => '意图名称'."\n"
."\n"
.'> 即为意图code,唯一标识符号',
'type' => 'string',
'required' => false,
'example' => '知道了',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'BeebotRequestId' => [
'description' => '内部请求ID',
'type' => 'string',
'example' => '497CFAFF-48CC-161A-AD2C-252DED569037',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'PageSize' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'Intents' => [
'description' => '意图列表',
'type' => 'array',
'items' => [
'description' => '意图信息',
'type' => 'object',
'properties' => [
'IntentId' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'example' => '10717802'."\n",
],
'IntentName' => [
'description' => '意图名称'."\n"
."\n"
.'> 即为意图code,唯一标识符号',
'type' => 'string',
'example' => '知道了',
],
'AliasName' => [
'description' => '意图别名',
'type' => 'string',
'example' => '嗯明白了',
],
'ModifyUserId' => [
'description' => '修改用户ID',
'type' => 'string',
'example' => '1252504',
],
'ModifyUserName' => [
'description' => '修改账号名称',
'type' => 'string',
'example' => 'xxx@voice-navigator-testonaliyun.com'."\n",
],
'CreateUserName' => [
'description' => '创建账号名称',
'type' => 'string',
'example' => 'xxx@voice-navigator-testonaliyun.com'."\n",
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'string',
'example' => '2025-04-21 16:03:15.+0800',
],
'CreateUserId' => [
'description' => '创建用户ID',
'type' => 'string',
'example' => '1252504',
],
'ModifyTime' => [
'description' => '修改时间',
'type' => 'string',
'example' => '2025-04-21 16:03:15.+0800',
],
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"BeebotRequestId\\": \\"497CFAFF-48CC-161A-AD2C-252DED569037\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"Intents\\": [\\n {\\n \\"IntentId\\": 10717802,\\n \\"IntentName\\": \\"知道了\\",\\n \\"AliasName\\": \\"嗯明白了\\",\\n \\"ModifyUserId\\": \\"1252504\\",\\n \\"ModifyUserName\\": \\"xxx@voice-navigator-testonaliyun.com\\\\n\\",\\n \\"CreateUserName\\": \\"xxx@voice-navigator-testonaliyun.com\\\\n\\",\\n \\"CreateTime\\": \\"2025-04-21 16:03:15.+0800\\",\\n \\"CreateUserId\\": \\"1252504\\",\\n \\"ModifyTime\\": \\"2025-04-21 16:03:15.+0800\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '【小模型接口】列表展示小蜜机器人意图',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListBeebotIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListBeebotIntentLgf' => [
'summary' => '列表小模型场景意图问法模版。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '224618',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'IntentId',
'in' => 'query',
'schema' => [
'description' => '意图ID',
'type' => 'string',
'required' => true,
'example' => '10717802',
],
],
[
'name' => 'LgfText',
'in' => 'query',
'schema' => [
'description' => '意图问法模版',
'type' => 'string',
'required' => false,
'example' => '我是一个问法模版'."\n",
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'BeebotRequestId' => [
'description' => '内部请求ID',
'type' => 'string',
'example' => '497CFAFF-48CC-161A-AD2C-252DED569037',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'PageSize' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'Lgfs' => [
'description' => 'LGF列表说明',
'type' => 'array',
'items' => [
'description' => 'LGF列表说明',
'type' => 'object',
'properties' => [
'LgfId' => [
'description' => '问法模版ID',
'type' => 'integer',
'format' => 'int64',
'example' => '5666117',
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'string',
'example' => '2025-04-21 10:54:18.+0800',
],
'ModifyTime' => [
'description' => '修改时间',
'type' => 'string',
'example' => '2025-04-21 10:54:18.+0800',
],
'RuleText' => [
'description' => '问法模版内容',
'type' => 'string',
'example' => '我是一个问法模版'."\n",
],
'IntentId' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'example' => '10717802',
],
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"BeebotRequestId\\": \\"497CFAFF-48CC-161A-AD2C-252DED569037\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"Lgfs\\": [\\n {\\n \\"LgfId\\": 5666117,\\n \\"CreateTime\\": \\"2025-04-21 10:54:18.+0800\\",\\n \\"ModifyTime\\": \\"2025-04-21 10:54:18.+0800\\",\\n \\"RuleText\\": \\"我是一个问法模版\\\\n\\",\\n \\"IntentId\\": 10717802\\n }\\n ]\\n}","type":"json"}]',
'title' => '【小模型接口】列表展示小蜜机器人意图问法模版',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListBeebotIntentLgf',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListBeebotIntentUserSay' => [
'summary' => '列表展示小模型场景意图用户问法。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '224611',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'IntentId',
'in' => 'query',
'schema' => [
'description' => '意图ID',
'type' => 'string',
'required' => true,
'example' => '10717802',
],
],
[
'name' => 'Content',
'in' => 'query',
'schema' => [
'description' => '问法内容关键字',
'type' => 'string',
'required' => false,
'example' => '知道',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的个数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '0956D5DA-0978-5DC9-94B0-C68527DA7475',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'BeebotRequestId' => [
'description' => '内部请求ID',
'type' => 'string',
'example' => 'D7BBFCDF-59B0-1ADA-BCA3-4B77F642DDFB',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'PageSize' => [
'description' => '每页显示个数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'UserSays' => [
'description' => '用户问法列表',
'type' => 'array',
'items' => [
'description' => '用户问法',
'type' => 'object',
'properties' => [
'UserSayId' => [
'description' => '问法ID',
'type' => 'string',
'example' => '17448458',
],
'Content' => [
'description' => '问法内容',
'type' => 'string',
'example' => '你知道xxxx么?',
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'string',
'example' => '2025-04-21 14:16:05.+0800',
],
'ModifyTime' => [
'description' => '修改时间',
'type' => 'string',
'example' => '2025-04-21 14:16:05.+0800',
],
'IntentId' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'example' => '10717802',
],
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0956D5DA-0978-5DC9-94B0-C68527DA7475\\",\\n \\"Success\\": true,\\n \\"BeebotRequestId\\": \\"D7BBFCDF-59B0-1ADA-BCA3-4B77F642DDFB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"UserSays\\": [\\n {\\n \\"UserSayId\\": \\"17448458\\",\\n \\"Content\\": \\"你知道xxxx么?\\",\\n \\"CreateTime\\": \\"2025-04-21 14:16:05.+0800\\",\\n \\"ModifyTime\\": \\"2025-04-21 14:16:05.+0800\\",\\n \\"IntentId\\": 10717802\\n }\\n ]\\n}","type":"json"}]',
'title' => '【小模型接口】列表展示小蜜机器人用户问法',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListBeebotIntentUserSay',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListChatbotInstances' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '10000',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '个数'."\n"
."\n"
.'> 该参数的值需小于等于50',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '1000',
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'AgentKey',
'in' => 'query',
'schema' => [
'description' => '机器人业务空间访问Key'."\n"
."\n"
.'> ListChatbotAgents获取,默认不填,则查询所有业务空间的机器人。',
'type' => 'string',
'required' => false,
'example' => '9137ab9c27044921860030adf8590ec4_p_outbound_public',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Bots' => [
'description' => '机器⼈列表信息',
'type' => 'array',
'items' => [
'description' => '机器⼈列表信息',
'type' => 'object',
'properties' => [
'Introduction' => [
'description' => '机器⼈备注',
'type' => 'string',
'example' => '这是直播的描述',
],
'Avatar' => [
'description' => '头像URL',
'type' => 'string',
'example' => 'https://ccrm.wengine.cn/ccrm/system/common/fileDownload/noToken?fileId=975cdeaa064846e3b6004abd9ba1d7c8',
],
'TimeZone' => [
'description' => '机器⼈的时区,参考《公共-时区码》',
'type' => 'string',
'example' => 'Asia/Shanghai',
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'string',
'example' => '2022-01-18T02:36:00Z',
],
'LanguageCode' => [
'description' => '机器⼈服务的语⾔,如zh-cn、 en-us',
'type' => 'string',
'example' => 'zh-cn',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'e874fcf0-d2f4-4e62-9377-b6f35fe55210',
],
'Name' => [
'description' => '机器人名字',
'type' => 'string',
'example' => '智能回访2',
],
],
],
],
'PageSize' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Bots\\": [\\n {\\n \\"Introduction\\": \\"这是直播的描述\\",\\n \\"Avatar\\": \\"https://ccrm.wengine.cn/ccrm/system/common/fileDownload/noToken?fileId=975cdeaa064846e3b6004abd9ba1d7c8\\",\\n \\"TimeZone\\": \\"Asia/Shanghai\\",\\n \\"CreateTime\\": \\"2022-01-18T02:36:00Z\\",\\n \\"LanguageCode\\": \\"zh-cn\\",\\n \\"InstanceId\\": \\"e874fcf0-d2f4-4e62-9377-b6f35fe55210\\",\\n \\"Name\\": \\"智能回访2\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 5,\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
'title' => '查询云小蜜公有云版本机器人列表',
'summary' => '查询云小蜜机器人公有云版本实例列表。',
'changeSet' => [
[
'createdAt' => '2024-04-25T12:17:46.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListChatbotInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListDialogueFlows' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b5b0a30f-69e7-4147-98b5-553fc526361d',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd7c28efb-47f7-4a85-a522-5038e30a0b98',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP返回码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '表示是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'DialogueFlows' => [
'description' => '对话流程数据列表',
'type' => 'array',
'items' => [
'description' => '对话流程数据列表',
'type' => 'object',
'properties' => [
'DialogueFlowDefinition' => [
'description' => '对话流程数据',
'type' => 'string',
'example' => '{"transitions":[{"source":"cc31e02b","sourceAnchor":0,"target":"345700de","targetAnchor":0,"id":"16d37c6e","index":1}],"nodes":[{"shape":"start-html","type":"start","size":"170*34","x":180,"y":134,"id":"cc31e02b","index":0,"nodeIndex":0,"content":{"branches":[{"branchName":"发起对话","branchId":"3c50a880-a7bc-11e9-80fc-5917e4f31864"}]},"coordinates":{"x":180,"y":134}},{"shape":"function-html","type":"transfer","size":"170*34","x":606,"y":134,"id":"345700de","nodeIndex":1,"name":"功能节点","script":"你是 @name ma","content":{"action":"Hangup","actionParams":"","label":["test1","test2","test3","test4","test5"]},"coordinates":{"x":606,"y":134},"index":2,"questions":["你是 @联系人姓名 ma"]}]}',
],
'DialogueFlowType' => [
'description' => '流程类型。'."\n"
.'- 子流程类型 SubFlow, '."\n"
.'- 主流程类型 MainFlow',
'type' => 'string',
'example' => 'MainFlow',
],
'DialogueFlowId' => [
'description' => '对话流ID',
'type' => 'string',
'example' => 'dae01529-3c3e-458e-b07a-97643d09ebb9',
],
'DialogueFlowName' => [
'description' => '对话流程名字',
'type' => 'string',
'example' => '主流程',
],
'ScriptId' => [
'description' => '外呼场景ID',
'type' => 'string',
'example' => '2d5aa451-661f-4f08-b0c4-28eec78decc4',
],
'ScriptVersion' => [
'description' => '场景版本号',
'type' => 'string',
'example' => '1569220563549',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"DialogueFlows\\": [\\n {\\n \\"DialogueFlowDefinition\\": \\"{\\\\\\"transitions\\\\\\":[{\\\\\\"source\\\\\\":\\\\\\"cc31e02b\\\\\\",\\\\\\"sourceAnchor\\\\\\":0,\\\\\\"target\\\\\\":\\\\\\"345700de\\\\\\",\\\\\\"targetAnchor\\\\\\":0,\\\\\\"id\\\\\\":\\\\\\"16d37c6e\\\\\\",\\\\\\"index\\\\\\":1}],\\\\\\"nodes\\\\\\":[{\\\\\\"shape\\\\\\":\\\\\\"start-html\\\\\\",\\\\\\"type\\\\\\":\\\\\\"start\\\\\\",\\\\\\"size\\\\\\":\\\\\\"170*34\\\\\\",\\\\\\"x\\\\\\":180,\\\\\\"y\\\\\\":134,\\\\\\"id\\\\\\":\\\\\\"cc31e02b\\\\\\",\\\\\\"index\\\\\\":0,\\\\\\"nodeIndex\\\\\\":0,\\\\\\"content\\\\\\":{\\\\\\"branches\\\\\\":[{\\\\\\"branchName\\\\\\":\\\\\\"发起对话\\\\\\",\\\\\\"branchId\\\\\\":\\\\\\"3c50a880-a7bc-11e9-80fc-5917e4f31864\\\\\\"}]},\\\\\\"coordinates\\\\\\":{\\\\\\"x\\\\\\":180,\\\\\\"y\\\\\\":134}},{\\\\\\"shape\\\\\\":\\\\\\"function-html\\\\\\",\\\\\\"type\\\\\\":\\\\\\"transfer\\\\\\",\\\\\\"size\\\\\\":\\\\\\"170*34\\\\\\",\\\\\\"x\\\\\\":606,\\\\\\"y\\\\\\":134,\\\\\\"id\\\\\\":\\\\\\"345700de\\\\\\",\\\\\\"nodeIndex\\\\\\":1,\\\\\\"name\\\\\\":\\\\\\"功能节点\\\\\\",\\\\\\"script\\\\\\":\\\\\\"你是 @name ma\\\\\\",\\\\\\"content\\\\\\":{\\\\\\"action\\\\\\":\\\\\\"Hangup\\\\\\",\\\\\\"actionParams\\\\\\":\\\\\\"\\\\\\",\\\\\\"label\\\\\\":[\\\\\\"test1\\\\\\",\\\\\\"test2\\\\\\",\\\\\\"test3\\\\\\",\\\\\\"test4\\\\\\",\\\\\\"test5\\\\\\"]},\\\\\\"coordinates\\\\\\":{\\\\\\"x\\\\\\":606,\\\\\\"y\\\\\\":134},\\\\\\"index\\\\\\":2,\\\\\\"questions\\\\\\":[\\\\\\"你是 @联系人姓名 ma\\\\\\"]}]}\\",\\n \\"DialogueFlowType\\": \\"MainFlow\\",\\n \\"DialogueFlowId\\": \\"dae01529-3c3e-458e-b07a-97643d09ebb9\\",\\n \\"DialogueFlowName\\": \\"主流程\\",\\n \\"ScriptId\\": \\"2d5aa451-661f-4f08-b0c4-28eec78decc4\\",\\n \\"ScriptVersion\\": \\"1569220563549\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '【旧画布接口】查询一个场景下的对话流程列表',
'summary' => '旧画布场景中查询一个话术下的对话流程列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListDialogueFlows',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListDownloadTasks' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '1000',
'minimum' => '1',
'enumValueTitles' => [],
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '50',
'minimum' => '1',
'enumValueTitles' => [],
'example' => '10',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'ae4572af-376f-439f-8970-38764acbaa91',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '904CFA7B-8AD9-50FF-9B3E-404B20B9EE31',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'True',
],
'DownloadTasks' => [
'description' => '下载任务列表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'List' => [
'description' => '下载任务数组',
'type' => 'array',
'items' => [
'description' => '下载任务数组',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '导出状态。'."\n"
.'- Pending:待处理'."\n"
.'- InProgress:进行中'."\n"
.'- Finished:已完成'."\n"
.'- Failed:失败'."\n"
.'- Expired:已过期'."\n"
.'- Cancelled:已取消',
'type' => 'string',
'example' => 'Empty',
],
'Title' => [
'description' => '标题',
'type' => 'string',
'example' => 'GUI-TEST-新建风险',
],
'ExpireTime' => [
'description' => '过期时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1646792941',
],
'TaskId' => [
'description' => '任务ID',
'type' => 'string',
'example' => '6b0e547e-501c-480a-812f-d27e28e74f9a',
],
'DownloadTaskFiles' => [
'description' => '下载任务文件列表',
'type' => 'array',
'items' => [
'description' => '下载任务文件列表',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '文件状态'."\n"
.'- Pending:待处理'."\n"
.'- InProgress:进行中'."\n"
.'- Finished:已完成'."\n"
.'- Failed:失败'."\n"
.'- Expired:已过期'."\n"
.'- Cancelled:已取消',
'type' => 'string',
'example' => 'Empty',
],
'Title' => [
'description' => '标题',
'type' => 'string',
'example' => 'GUI-TEST-新建风险',
],
'Progress' => [
'description' => '完成进度【已废弃】',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'FileId' => [
'description' => '文件ID',
'type' => 'string',
'example' => '01f8d11abdb9406996c0c46e7*******',
],
],
],
],
],
],
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"904CFA7B-8AD9-50FF-9B3E-404B20B9EE31\\",\\n \\"Success\\": true,\\n \\"DownloadTasks\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"Empty\\",\\n \\"Title\\": \\"GUI-TEST-新建风险\\",\\n \\"ExpireTime\\": 1646792941,\\n \\"TaskId\\": \\"6b0e547e-501c-480a-812f-d27e28e74f9a\\",\\n \\"DownloadTaskFiles\\": [\\n {\\n \\"Status\\": \\"Empty\\",\\n \\"Title\\": \\"GUI-TEST-新建风险\\",\\n \\"Progress\\": 10,\\n \\"FileId\\": \\"01f8d11abdb9406996c0c46e7*******\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '任务下载列表',
'summary' => '查看下载中心列表。',
'changeSet' => [
[
'createdAt' => '2023-06-20T13:56:47.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2021-11-24T13:00:44.000Z',
'description' => 'OpenAPI 下线',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListDownloadTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListFlashSmsTemplates' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399',
],
],
[
'name' => 'ProviderId',
'in' => 'query',
'schema' => [
'description' => '闪信供应商ID。'."\n"
."\n"
.'- Uincall:北京优音通信有限公司'."\n"
.'- ShangHaiTianNan:上海田南'."\n"
.'- HeDao:伽雷可斯',
'type' => 'string',
'required' => true,
'example' => 'Uincall',
],
],
[
'name' => 'ConfigId',
'in' => 'query',
'schema' => [
'description' => '闪信配置ID。',
'type' => 'string',
'required' => true,
'example' => 'fe542524-9585-4cc7-be54-c8782ed7f60e',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => '无',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'EC08CC41-6870-5594-939A-F758F057898F',
],
'Success' => [
'description' => '是否调用成功。true:调用成功。false:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据',
'type' => 'array',
'items' => [
'description' => '闪信模板。',
'type' => 'object',
'properties' => [
'TemplateName' => [
'description' => '模板名称。',
'type' => 'string',
'example' => '模板1',
],
'TemplateId' => [
'description' => '闪信模板ID。',
'type' => 'string',
'example' => '17*******************01',
],
'TemplateContent' => [
'description' => '模板内容。',
'type' => 'string',
'example' => '您好,xxx来电。',
],
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EC08CC41-6870-5594-939A-F758F057898F\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"TemplateName\\": \\"模板1\\",\\n \\"TemplateId\\": \\"17*******************01\\",\\n \\"TemplateContent\\": \\"您好,xxx来电。\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取闪信模板',
'summary' => '使用ListFlashSmsTemplates获取闪信模板。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListFlashSmsTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListGlobalQuestions' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dd8c2b62-4660-457f-9597-6723b5722aff',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'f63b0dfc-848a-42f3-9329-8854e232e977',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页页码',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的条数。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'GlobalQuestions' => [
'description' => '全局话术数据',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页码',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'List' => [
'description' => '全局话术数组',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GlobalQuestionId' => [
'description' => '全局问题ID',
'type' => 'string',
'example' => '53c27755-d41e-46a6-bb3c-4f66f257d50c',
],
'Answers' => [
'description' => '全局问题的回复',
'type' => 'string',
'example' => '["你好,您可以再说一遍吗","不好意思我刚才没有听清"]',
],
'GlobalQuestionType' => [
'description' => '全局问题类型'."\n"
."\n"
.'- SYSTEM:系统'."\n"
.'- COMMON:通用',
'type' => 'string',
'example' => 'SYSTEM',
],
'GlobalQuestionName' => [
'description' => '全局问题名字',
'type' => 'string',
'example' => '未识别',
],
'Questions' => [
'description' => '全局问题列表',
'type' => 'string',
'example' => '["测试问题1","测试问题2"]',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17',
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"GlobalQuestions\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"GlobalQuestionId\\": \\"53c27755-d41e-46a6-bb3c-4f66f257d50c\\",\\n \\"Answers\\": \\"[\\\\\\"你好,您可以再说一遍吗\\\\\\",\\\\\\"不好意思我刚才没有听清\\\\\\"]\\",\\n \\"GlobalQuestionType\\": \\"SYSTEM\\",\\n \\"GlobalQuestionName\\": \\"未识别\\",\\n \\"Questions\\": \\"[\\\\\\"测试问题1\\\\\\",\\\\\\"测试问题2\\\\\\"]\\",\\n \\"ScriptId\\": \\"aa279896-64a6-4182-864c-4f2b04ec8d17\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '【旧画布接口】查询全局问题列表',
'summary' => '查询关键问题列表,旧画布接口。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:ListGlobalQuestions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListInstances' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '94119',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID。'."\n"
.'> 可通过资源管理文档获取来源api,相关链接:https://api.aliyun.com/document/ResourceManager/2020-03-31/ListResourceGroups',
'type' => 'string',
'required' => false,
'example' => 'rg-acfm3iugit3uw7a',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '业务实例的标签列表。'."\n"
.'>可通过ListResourceTags 接口获取',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '实例标签Key。',
'type' => 'string',
'required' => false,
'example' => 'name',
],
'Value' => [
'description' => '实例标签值。',
'type' => 'string',
'required' => false,
'example' => 'xxx',
],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '智能外呼实例名称',
'type' => 'string',
'required' => false,
'example' => 'xxx',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息。',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Instances' => [
'description' => '业务实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => ' 1578469042851',
],
'InstanceId' => [
'description' => '业务实例ID。',
'type' => 'string',
'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
'OwnerName' => [
'description' => '主账号名称。',
'type' => 'string',
'example' => 'xxx',
],
'CreatorId' => [
'description' => '创建者ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '34234',
],
'InstanceDescription' => [
'description' => '智能外呼业务实例描述。',
'type' => 'string',
'example' => '这是一个实例',
],
'InstanceName' => [
'description' => '智能外呼业务实例名称。',
'type' => 'string',
'example' => '回访',
],
'ResourceGroupId' => [
'description' => '资源组ID。',
'type' => 'string',
'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
'CreatorName' => [
'description' => '创建者姓名。',
'type' => 'string',
'example' => 'xxx',
],
'MaxConcurrentConversation' => [
'description' => '允许的最大外呼并发数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'ResourceTags' => [
'description' => '标签信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签Key。',
'type' => 'string',
'example' => 'age',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'example' => '20',
],
],
'description' => '',
],
'example' => '[]',
],
'IsPreset' => [
'description' => '该实例是否为系统预置实例。',
'type' => 'boolean',
'example' => 'false',
],
],
'description' => '',
],
],
'TotalCount' => [
'description' => '实例数量',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Instances\\": [\\n {\\n \\"CreationTime\\": 1578469042851,\\n \\"InstanceId\\": \\"90515b5-6115-4ccf-83e2-52d5bfaf2ddf\\",\\n \\"OwnerName\\": \\"xxx\\",\\n \\"CreatorId\\": 34234,\\n \\"InstanceDescription\\": \\"这是一个实例\\",\\n \\"InstanceName\\": \\"回访\\",\\n \\"ResourceGroupId\\": \\"90515b5-6115-4ccf-83e2-52d5bfaf2ddf\\",\\n \\"CreatorName\\": \\"xxx\\",\\n \\"MaxConcurrentConversation\\": 10,\\n \\"ResourceTags\\": [\\n {\\n \\"Key\\": \\"age\\",\\n \\"Value\\": \\"20\\"\\n }\\n ],\\n \\"IsPreset\\": false\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n \\n 90515b5-6115-4ccf-83e2-52d5bfaf2ddf\\n xxx\\n 34234\\n 这是一个实例\\n 回访\\n 90515b5-6115-4ccf-83e2-52d5bfaf2ddf\\n xxx\\n 10\\n \\n age\\n 20\\n \\n false\\n \\n 1\\n 1\\n 10\\n","errorExample":""}]',
'title' => '查询业务实例列表',
'summary' => '查询智能外呼业务实例列表。',
'changeSet' => [
[
'createdAt' => '2024-04-22T12:31:34.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2022-09-27T13:02:34.000Z',
'description' => '响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListIntentions' => [
'summary' => '标注中心列表查询意图。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '125270',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'BotId',
'in' => 'query',
'schema' => [
'description' => '机器人ID'."\n"
."\n"
.'> 可通过DescribeScript接口中获取,对应参数为ChatbotId',
'type' => 'string',
'required' => false,
'example' => 'chatbot-cn-n7QmzrUnNe',
],
],
[
'name' => 'UserNick',
'in' => 'query',
'schema' => [
'description' => '意图名称'."\n"
."\n"
.'> 可根据关键字模糊查询作为条件',
'type' => 'string',
'required' => false,
'example' => '知道',
],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => [
'title' => 'page number',
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => 'page size',
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
'default' => '10',
],
],
[
'name' => 'IntentId',
'in' => 'query',
'schema' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10717802',
],
],
[
'name' => 'Environment',
'in' => 'query',
'schema' => [
'description' => '环境'."\n"
."\n"
.'- 1:私有云'."\n"
.'- 2:公有云',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2',
],
],
[
'name' => 'AnnotationMissionDataSourceType',
'in' => 'query',
'schema' => [
'description' => '>此参数必填,根据场景来选择>'."\n"
."\n"
.'标注数据来源。'."\n"
.'- 1:外呼'."\n"
.'- 2:导航',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'IntentList' => [
'description' => '意图列表',
'type' => 'array',
'items' => [
'description' => '意图数据',
'type' => 'object',
'properties' => [
'BotId' => [
'description' => '机器人ID【已废弃】',
'type' => 'integer',
'format' => 'int64',
'example' => 'chatbot-cn-n7QmzrUnNe'."\n",
],
'DialogId' => [
'description' => '对话流ID',
'type' => 'string',
'example' => '50099',
],
'Name' => [
'description' => '意图名称',
'type' => 'string',
'example' => '知道了',
],
'Alias' => [
'description' => '意图别名',
'type' => 'array',
'items' => [
'description' => '意图别名',
'type' => 'string',
'example' => '嗯明白了',
],
],
'Id' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'example' => '10717802',
],
'BotName' => [
'description' => '机器人名称',
'type' => 'string',
'example' => '111',
],
'Language' => [
'description' => '语言'."\n"
."\n"
.'- 英语 en-us'."\n"
.'- 中文 zh-cn',
'type' => 'string',
'example' => 'zh-cn'."\n",
],
'Type' => [
'description' => '意图类型:'."\n"
.'- 0: 正常意图; '."\n"
.'- 1: UNKNOWN; '."\n"
.'- 2: TableQA意图; '."\n"
.'- 3: 由标准意图生成',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'TableId' => [
'description' => '表ID',
'type' => 'integer',
'format' => 'int64',
'example' => '43258',
],
'UserSay' => [
'description' => '问法列表',
'type' => 'array',
'items' => [
'description' => '问法数据',
'type' => 'object',
'properties' => [
'Id' => [
'description' => '问法ID',
'type' => 'string',
'example' => '17448458',
],
'FromId' => [
'description' => '来源iD'."\n"
.'>无效内容>',
'type' => 'string',
'example' => '1234567',
],
'Strict' => [
'description' => '是否严格匹配',
'type' => 'boolean',
'example' => 'true',
],
'UserSayData' => [
'description' => '问法列表',
'type' => 'array',
'items' => [
'description' => '问法数据',
'type' => 'object',
'properties' => [
'SlotId' => [
'description' => '槽位唯⼀标识',
'type' => 'string',
'example' => '9ec31b50-32b8-11eb-9478-19d2d885afdb'."\n",
],
'Text' => [
'description' => '表述',
'type' => 'string',
'example' => '知道',
],
],
],
],
],
],
],
'RuleCheck' => [
'description' => 'lgf意图表述表达式',
'type' => 'array',
'items' => [
'description' => 'lgf意图表述表达式',
'type' => 'object',
'properties' => [
'Strict' => [
'description' => '是否严格匹配',
'type' => 'boolean',
'example' => 'true',
],
'Text' => [
'description' => '表达式值',
'type' => 'string',
'example' => '知道',
],
'Warning' => [
'description' => '警告信息',
'type' => 'array',
'items' => [
'description' => '警告信息',
'type' => 'string',
'example' => '“”',
],
],
'Error' => [
'description' => '错误信息',
'type' => 'array',
'items' => [
'description' => '错误信息',
'type' => 'string',
'example' => '“”',
],
],
],
],
],
'Slot' => [
'description' => '意图槽位信息',
'type' => 'array',
'items' => [
'description' => '意图槽位信息',
'type' => 'object',
'properties' => [
'Id' => [
'description' => '槽位唯⼀标识',
'type' => 'string',
'example' => '9ec31b50-32b8-11eb-9478-19d2d885afdb'."\n",
],
'Name' => [
'description' => '槽位名称',
'type' => 'string',
'example' => '知道',
],
'IsArray' => [
'description' => '是否数组:'."\n"
."\n"
.'- true:是'."\n"
.'- false:否',
'type' => 'boolean',
'example' => 'false',
],
'IsEncrypt' => [
'description' => '是否加密'."\n"
.'>无效内容>',
'type' => 'boolean',
'example' => 'false',
],
'IsInteractive' => [
'description' => '是否交互'."\n"
.'>无效内容>',
'type' => 'boolean',
'example' => 'false',
],
'Value' => [
'description' => '槽位划词结果',
'type' => 'string',
'example' => '@知道',
],
'Tags' => [
'description' => '槽位划词标签',
'type' => 'array',
'items' => [
'description' => '槽位划词标签',
'type' => 'object',
'properties' => [
'UserSayId' => [
'description' => '标签对应意图表述唯⼀标识',
'type' => 'string',
'example' => '17448458',
],
'Value' => [
'description' => '标签对应意图表述划词结果',
'type' => 'string',
'example' => '你知道xxxx?',
],
],
],
],
'Question' => [
'description' => '槽位反问话术',
'type' => 'array',
'items' => [
'description' => '槽位反问话术',
'type' => 'string',
'example' => '你知道?',
],
],
'IsNecessary' => [
'description' => '是否必填槽:'."\n"
."\n"
.'- true:是'."\n"
.'- false:否',
'type' => 'boolean',
'example' => 'true',
],
'LifeSpan' => [
'description' => '槽位生命周期',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'FeedbackType' => [
'description' => '反馈类型'."\n"
.'>无效内容>',
'type' => 'string',
'example' => 'test',
],
'FeedbackFunctions' => [
'description' => '反问函数'."\n"
.'>无效内容>',
'type' => 'array',
'items' => [
'description' => '反问函数',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Description' => [
'description' => '反问描述',
'type' => 'string',
'example' => 'GA setup for HPC cn4-HPC-EndUserServer-GlobalAccelerator',
],
'Function' => [
'description' => '反问函数',
'type' => 'string',
'example' => 'count',
],
'Name' => [
'description' => '函数名称',
'type' => 'string',
'example' => '方欣云呼系统每日拨测_2024年11月',
],
'AliyunService' => [
'description' => '阿里云服务',
'type' => 'string',
'example' => 'test',
],
'AliyunFunction' => [
'description' => '阿里云函数名字',
'type' => 'string',
'example' => 'test',
],
'EndPoint' => [
'description' => '接入节点',
'type' => 'string',
'example' => 'cn-hangzhou.log.aliyuncs.com',
],
'Type' => [
'description' => '反问类型',
'type' => 'string',
'example' => 'cluster',
],
'Switch' => [
'description' => '功能开关。取值:'."\n"
.'- **on**:开启'."\n"
.'- **off**:关闭',
'type' => 'array',
'items' => [
'description' => '分支类型',
'type' => 'object',
'properties' => [
'Id' => [
'description' => '条件id',
'type' => 'string',
'example' => 'b9932604-08ae-4525-bbe5-c8cce3066070',
],
'Label' => [
'description' => '反问话术标签',
'type' => 'string',
'example' => 'SQL_SUB_QUERY',
],
'Type' => [
'description' => '类型',
'type' => 'string',
'example' => 'PASSKEY',
],
'Value' => [
'description' => '条件的值',
'type' => 'string',
'example' => 'BASE_VALIDATE_FILTER_SWITCH',
],
'Name' => [
'description' => '条件名字',
'type' => 'string',
'example' => '测试0609_20241021_101018_复制_复制_复制',
],
],
],
],
'Params' => [
'description' => '参数',
'type' => 'object',
'additionalProperties' => [
'type' => 'any',
'example' => '{"type":2}',
'description' => '参数内容',
],
],
],
],
],
],
],
],
],
],
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'BotId' => [
'description' => '机器人ID',
'type' => 'string',
'example' => 'chatbot-cn-n7QmzrUnNe'."\n",
],
],
],
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"IntentList\\": [\\n {\\n \\"BotId\\": 0,\\n \\"DialogId\\": \\"50099\\",\\n \\"Name\\": \\"知道了\\",\\n \\"Alias\\": [\\n \\"嗯明白了\\"\\n ],\\n \\"Id\\": 10717802,\\n \\"BotName\\": \\"111\\",\\n \\"Language\\": \\"zh-cn\\\\n\\",\\n \\"Type\\": 0,\\n \\"TableId\\": 43258,\\n \\"UserSay\\": [\\n {\\n \\"Id\\": \\"17448458\\",\\n \\"FromId\\": \\"1234567\\",\\n \\"Strict\\": true,\\n \\"UserSayData\\": [\\n {\\n \\"SlotId\\": \\"9ec31b50-32b8-11eb-9478-19d2d885afdb\\\\n\\",\\n \\"Text\\": \\"知道\\"\\n }\\n ]\\n }\\n ],\\n \\"RuleCheck\\": [\\n {\\n \\"Strict\\": true,\\n \\"Text\\": \\"知道\\",\\n \\"Warning\\": [\\n \\"“”\\"\\n ],\\n \\"Error\\": [\\n \\"“”\\"\\n ]\\n }\\n ],\\n \\"Slot\\": [\\n {\\n \\"Id\\": \\"9ec31b50-32b8-11eb-9478-19d2d885afdb\\\\n\\",\\n \\"Name\\": \\"知道\\",\\n \\"IsArray\\": false,\\n \\"IsEncrypt\\": false,\\n \\"IsInteractive\\": false,\\n \\"Value\\": \\"@知道\\",\\n \\"Tags\\": [\\n {\\n \\"UserSayId\\": \\"17448458\\",\\n \\"Value\\": \\"你知道xxxx?\\"\\n }\\n ],\\n \\"Question\\": [\\n \\"你知道?\\"\\n ],\\n \\"IsNecessary\\": true,\\n \\"LifeSpan\\": 0,\\n \\"FeedbackType\\": \\"test\\",\\n \\"FeedbackFunctions\\": [\\n {\\n \\"Code\\": \\"OK\\",\\n \\"Description\\": \\"GA setup for HPC cn4-HPC-EndUserServer-GlobalAccelerator\\",\\n \\"Function\\": \\"count\\",\\n \\"Name\\": \\"方欣云呼系统每日拨测_2024年11月\\",\\n \\"AliyunService\\": \\"test\\",\\n \\"AliyunFunction\\": \\"test\\",\\n \\"EndPoint\\": \\"cn-hangzhou.log.aliyuncs.com\\",\\n \\"Type\\": \\"cluster\\",\\n \\"Switch\\": [\\n {\\n \\"Id\\": \\"b9932604-08ae-4525-bbe5-c8cce3066070\\",\\n \\"Label\\": \\"SQL_SUB_QUERY\\",\\n \\"Type\\": \\"PASSKEY\\",\\n \\"Value\\": \\"BASE_VALIDATE_FILTER_SWITCH\\",\\n \\"Name\\": \\"测试0609_20241021_101018_复制_复制_复制\\"\\n }\\n ],\\n \\"Params\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\":2}\\"\\n }\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Success\\": true,\\n \\"Message\\": \\"Success\\",\\n \\"BotId\\": \\"chatbot-cn-n7QmzrUnNe\\\\n\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '标注中心列表查询意图',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListIntentions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListIntents' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例 ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b9ff4e88-65f9-4eb3-987c-11ba51f3f24d',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '过滤条件,意图关键字',
'type' => 'string',
'required' => false,
'example' => '还款',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Intents' => [
'description' => '意图列表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'List' => [
'description' => '意图数组',
'type' => 'array',
'items' => [
'description' => '意图信息',
'type' => 'object',
'properties' => [
'Utterances' => [
'description' => '触发意图的用户表述',
'type' => 'string',
'example' => '["ok","好的","好吧","好嘞","可以","行啊","行吧","那行","知道了","我看一下","能的","等会吧","等一下","马上还","等一会","过两天","我会想办法处理"]',
],
'IntentDescription' => [
'description' => '实例描述',
'type' => 'string',
'example' => '同意还款意图',
],
'UpdateTime' => [
'description' => '意图更新时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1578469042851',
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1578469042851',
],
'Keywords' => [
'description' => '意图关键字',
'type' => 'string',
'example' => '["还款"]',
],
'ScriptId' => [
'description' => '话术ID',
'type' => 'string',
'example' => '6ef95fd5-558f-4ee8-af34-b2ede087a87c',
],
'IntentId' => [
'description' => '意图ID',
'type' => 'string',
'example' => 'a8494b35-eefb-4c8a-887b-b60d2f0fa57a',
],
'IntentName' => [
'description' => '意图名称',
'type' => 'string',
'example' => '统一还款',
],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Intents\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"List\\": [\\n {\\n \\"Utterances\\": \\"[\\\\\\"ok\\\\\\",\\\\\\"好的\\\\\\",\\\\\\"好吧\\\\\\",\\\\\\"好嘞\\\\\\",\\\\\\"可以\\\\\\",\\\\\\"行啊\\\\\\",\\\\\\"行吧\\\\\\",\\\\\\"那行\\\\\\",\\\\\\"知道了\\\\\\",\\\\\\"我看一下\\\\\\",\\\\\\"能的\\\\\\",\\\\\\"等会吧\\\\\\",\\\\\\"等一下\\\\\\",\\\\\\"马上还\\\\\\",\\\\\\"等一会\\\\\\",\\\\\\"过两天\\\\\\",\\\\\\"我会想办法处理\\\\\\"]\\",\\n \\"IntentDescription\\": \\"同意还款意图\\",\\n \\"UpdateTime\\": 1578469042851,\\n \\"CreateTime\\": 1578469042851,\\n \\"Keywords\\": \\"[\\\\\\"还款\\\\\\"]\\",\\n \\"ScriptId\\": \\"6ef95fd5-558f-4ee8-af34-b2ede087a87c\\",\\n \\"IntentId\\": \\"a8494b35-eefb-4c8a-887b-b60d2f0fa57a\\",\\n \\"IntentName\\": \\"统一还款\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询意图列表-旧画布接口',
'summary' => '查询意图列表,旧画布接口。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListIntents',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListJobGroups' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '94121',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '业务ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '按任务组创建时间起筛',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1578965079000',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '按任务组创建时间止筛',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1579965079000',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页记录数。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '100',
'example' => '10',
],
],
[
'name' => 'AsyncQuery',
'in' => 'query',
'schema' => [
'description' => '是否异步获取查询结果',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'SearchText',
'in' => 'query',
'schema' => [
'description' => '搜索关键字',
'type' => 'string',
'required' => false,
'example' => '面试',
],
],
[
'name' => 'JobGroupStatusFilter',
'in' => 'query',
'schema' => [
'description' => '过滤条件:按照任务状态过滤,可以同时选择多个状态过滤,各个状态之间用逗号分隔,逻辑或关系。'."\n"
.'取值范围:'."\n"
.'- **Draft**:草稿。'."\n"
.'- **Scheduling**:调度中。'."\n"
.'- **Executing**:执行中。'."\n"
.'- **Completed**:已完成。'."\n"
.'- **Paused**:挂起。'."\n"
.'- **Failed**:失败。'."\n"
.'- **Cancelled**:已取消。'."\n"
.'- **Initializing**:初始化。',
'type' => 'string',
'required' => false,
'example' => 'Draft',
],
],
[
'name' => 'OnlyMinConcurrencyEnabled',
'in' => 'query',
'schema' => [
'description' => '查看并发保障值有效任务',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否调用成功。true:调用成功。 false:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'Success',
],
'AsyncTaskId' => [
'description' => '异步查询ID,若为异步查询,可以根据此ID获取查询结果。',
'type' => 'string',
'example' => '6243d904-939d-42ce-a8e4-886a139e77a3'."\n",
],
'JobGroups' => [
'description' => '任务列表。',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页数据数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '记录总数',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'List' => [
'description' => '数组',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '执行状态,取值范围:'."\n"
."\n"
.'- **Draft**:草稿。'."\n"
.'- **Scheduling**:调度中。'."\n"
.'- **Executing**:执行中。'."\n"
.'- **Completed**:已完成。'."\n"
.'- **Paused**:挂起。'."\n"
.'- **Failed**:失败。'."\n"
.'- **Cancelled**:已取消。'."\n"
.'- **Initializing**:初始化。',
'type' => 'string',
'example' => 'Draft',
],
'JobGroupId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9',
],
'CreationTime' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1578550074361',
],
'JobGroupName' => [
'description' => '任务名字。',
'type' => 'string',
'example' => '催收作业组',
],
'TotalCallNum' => [
'description' => '总呼叫次数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'ScriptId' => [
'description' => '话术ID。',
'type' => 'string',
'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9',
],
'JobGroupDescription' => [
'description' => '任务描述。',
'type' => 'string',
'example' => '催收的作业组',
],
'JobDataParsingTaskId' => [
'description' => 'jobFile解析任务的ID。【已废弃】',
'type' => 'string',
'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9',
],
'ScriptName' => [
'description' => '话术名称。',
'type' => 'string',
'example' => '话术名称',
],
'ScriptVersion' => [
'description' => '话术版本。',
'type' => 'string',
'example' => 'd9e828ac-744b-4dd3-848a-17a3da9167b8',
],
'ModifyTime' => [
'description' => '修改时间,单位毫秒。',
'type' => 'string',
'example' => '1578550074361',
],
'Progress' => [
'description' => '任务统计信息。',
'type' => 'object',
'properties' => [
'TotalNotAnswered' => [
'description' => '已废弃',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Status' => [
'description' => '> 该参数已不返回'."\n"
."\n"
.'执行状态,取值范围:'."\n"
."\n"
.'- **Draft**:草稿。'."\n"
.'- **Scheduling**:调度中。'."\n"
.'- **Executing**:执行中。'."\n"
.'- **Completed**:已完成。'."\n"
.'- **Paused**:挂起。'."\n"
.'- **Failed**:失败。'."\n"
.'- **Cancelled**:已取消。'."\n"
.'- **Initializing**:初始化。',
'type' => 'string',
'example' => 'Scheduling',
],
'StartTime' => [
'description' => '开始时间。【废弃】',
'type' => 'integer',
'format' => 'int64',
'example' => '1578550074361',
],
'FailedNum' => [
'description' => '失败的作业数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'PausedNum' => [
'description' => '暂停的作业数量',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'CancelledNum' => [
'description' => '取消的作业数量',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'TotalJobs' => [
'description' => '作业总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalCompleted' => [
'description' => '到当前时间为止作业完成数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'Duration' => [
'description' => '到目前为止执行总时长。【废弃】',
'type' => 'integer',
'format' => 'int32',
'example' => '1578550074361',
],
'ExecutingNum' => [
'description' => '执行中的作业数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Scheduling' => [
'description' => '调度中的作业数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
'example' => '{}',
],
'ExportProgress' => [
'description' => '导出进度。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '导出任务状态,取值范围:'."\n"
."\n"
.'- **PENDING**:等待中。'."\n"
.'- **IN_PROGRESS**:处理中。'."\n"
.'- **FINISHED**:完成。'."\n"
.'- **FAILED**:失败。',
'type' => 'string',
'example' => 'PENDING',
],
'FileHttpUrl' => [
'description' => '已废弃',
'type' => 'string',
'example' => 'http://www.xxx.com/xxx',
],
'Progress' => [
'description' => '进度。',
'type' => 'string',
'example' => '1',
],
],
'example' => '{}',
],
'Strategy' => [
'description' => '策略。【已废弃】'."\n"
."\n"
.'> 需要查看任务策略信息,可调用DescribeJobGroup接口获取',
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '策略结束时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '2209702074000',
],
'StartTime' => [
'description' => '策略开始时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1578550074000',
],
],
'example' => '{}',
],
'MinConcurrency' => [
'description' => ' '."\n"
.'并发保障值有效任务数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"AsyncTaskId\\": \\"6243d904-939d-42ce-a8e4-886a139e77a3\\\\n\\",\\n \\"JobGroups\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"Draft\\",\\n \\"JobGroupId\\": \\"c62e6789-28a8-41db-941e-171a01d3b3b9\\",\\n \\"CreationTime\\": 1578550074361,\\n \\"JobGroupName\\": \\"催收作业组\\",\\n \\"TotalCallNum\\": 10,\\n \\"ScriptId\\": \\"c62e6789-28a8-41db-941e-171a01d3b3b9\\",\\n \\"JobGroupDescription\\": \\"催收的作业组\\",\\n \\"JobDataParsingTaskId\\": \\"c62e6789-28a8-41db-941e-171a01d3b3b9\\",\\n \\"ScriptName\\": \\"话术名称\\",\\n \\"ScriptVersion\\": \\"d9e828ac-744b-4dd3-848a-17a3da9167b8\\",\\n \\"ModifyTime\\": \\"1578550074361\\",\\n \\"Progress\\": {\\n \\"TotalNotAnswered\\": 1,\\n \\"Status\\": \\"Scheduling\\",\\n \\"StartTime\\": 1578550074361,\\n \\"FailedNum\\": 5,\\n \\"PausedNum\\": 5,\\n \\"CancelledNum\\": 5,\\n \\"TotalJobs\\": 20,\\n \\"TotalCompleted\\": 3,\\n \\"Duration\\": 1578550074361,\\n \\"ExecutingNum\\": 10,\\n \\"Scheduling\\": 10\\n },\\n \\"ExportProgress\\": {\\n \\"Status\\": \\"PENDING\\",\\n \\"FileHttpUrl\\": \\"http://www.xxx.com/xxx\\",\\n \\"Progress\\": \\"1\\"\\n },\\n \\"Strategy\\": {\\n \\"EndTime\\": 2209702074000,\\n \\"StartTime\\": 1578550074000\\n },\\n \\"MinConcurrency\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n OK\\n Success\\n 2bb0cf15-2126-4c9b-bc30-bb5301b96284\\n \\n 1\\n 10\\n 100\\n \\n Draft\\n c62e6789-28a8-41db-941e-171a01d3b3b9\\n 1578550074361\\n 催收作业组\\n 10\\n c62e6789-28a8-41db-941e-171a01d3b3b9\\n 催收的作业组\\n c62e6789-28a8-41db-941e-171a01d3b3b9\\n 话术名称\\n d9e828ac-744b-4dd3-848a-17a3da9167b8\\n 1578550074361\\n \\n \\n PENDING\\n http://www.xxx.com/xxx\\n \\n \\n \\n 2209702074000\\n 1578550074000\\n \\n
\\n \\n","errorExample":""}]',
'title' => '查询任务列表',
'summary' => '查询外呼任务列表。',
'changeSet' => [
[
'createdAt' => '2025-02-15T02:02:23.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2024-06-24T02:14:42.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2022-07-07T08:05:17.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-07-07T02:56:19.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-06-22T02:25:50.000Z',
'description' => '请求参数发生变更、错误码发生变更',
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListJobGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListJobGroupsAsync' => [
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '94122',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'AsyncTaskId',
'in' => 'query',
'schema' => [
'description' => '当调用ListJobGroup时采用Async模式时,ListJobGroup返回的AsyncTaskId的值。根据该ID可以获取异步查询的结果。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '6243d904-939d-42ce-a8e4-886a139e77a3',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Timeout' => [
'description' => '是否超时。',
'type' => 'boolean',
'example' => 'true',
],
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Vaild' => [
'description' => '是否有效。',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口响应信息。',
'type' => 'string',
'example' => 'Success',
],
'PageSize' => [
'description' => '每页显示的条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageNumber' => [
'description' => '页号。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '总计个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'JobGroups' => [
'description' => '任务列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '任务状态。',
'type' => 'string',
'example' => 'Scheduling',
],
'CreationTime' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1640316786259',
],
'JobGroupId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'JobGroupName' => [
'description' => '任务名字。',
'type' => 'string',
'example' => 'xxx',
],
'TotalCallNum' => [
'description' => '总呼叫次数。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'ScriptId' => [
'description' => '话术ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'JobGroupDescription' => [
'description' => '任务描述。',
'type' => 'string',
'example' => 'xxx',
],
'JobDataParsingTaskId' => [
'description' => 'jobFile解析任务的ID。【已废弃】',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'ScriptName' => [
'description' => '话术名称。',
'type' => 'string',
'example' => 'xxxx',
],
'ScriptVersion' => [
'description' => '话术版本。',
'type' => 'string',
'example' => '111',
],
'ModifyTime' => [
'description' => '修改时间,单位毫秒。',
'type' => 'string',
'example' => '1640316786259',
],
'Strategy' => [
'description' => '策略。【已废弃】'."\n"
."\n"
.'> 需要查看任务策略信息,可调用DescribeJobGroup接口获取',
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '策略结束时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1640316786259',
],
'StartTime' => [
'description' => '策略开始时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1640316786259',
],
],
'example' => '{}',
],
'Progress' => [
'description' => '任务统计信息。',
'type' => 'object',
'properties' => [
'TotalNotAnswered' => [
'description' => '作业未接通数量。【已废弃】',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Status' => [
'description' => '执行状态,取值范围:'."\n"
."\n"
.'- Draft:草稿。'."\n"
.'- Scheduling:调度中。'."\n"
.'- Executing:执行中。'."\n"
.'- Completed:已完成。'."\n"
.'- Paused:挂起。'."\n"
.'- Failed:失败。'."\n"
.'- Cancelled:已取消。'."\n"
.'- Initializing:初始化。',
'type' => 'string',
'example' => 'Scheduling',
],
'StartTime' => [
'description' => '开始时间。【已废弃】',
'type' => 'integer',
'format' => 'int64',
'example' => '1640316786259',
],
'FailedNum' => [
'description' => '失败的作业数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PausedNum' => [
'description' => '暂停的作业数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'CancelledNum' => [
'description' => '取消的作业数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCompleted' => [
'description' => '已完成的作业数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalJobs' => [
'description' => '作业总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'Duration' => [
'description' => '到目前为止执行总时长。【废弃】',
'type' => 'integer',
'format' => 'int32',
'example' => '1000',
],
'Scheduling' => [
'description' => '调度中的作业数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'ExecutingNum' => [
'description' => '执行中的作业数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
],
'example' => '{}',
],
'ExportProgress' => [
'description' => '导出进度。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '状态。',
'type' => 'string',
'example' => 'PENDING',
],
'FileHttpUrl' => [
'description' => '下载地址。【废弃】',
'type' => 'string',
'example' => 'http://www.xxx.com/xxx'."\n",
],
'Progress' => [
'description' => '进度。',
'type' => 'string',
'example' => '50',
],
],
'example' => '{}',
],
'MinConcurrency' => [
'description' => '最小并发数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Timeout\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Vaild\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 100,\\n \\"JobGroups\\": [\\n {\\n \\"Status\\": \\"Scheduling\\",\\n \\"CreationTime\\": 1640316786259,\\n \\"JobGroupId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"JobGroupName\\": \\"xxx\\",\\n \\"TotalCallNum\\": 100,\\n \\"ScriptId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"JobGroupDescription\\": \\"xxx\\",\\n \\"JobDataParsingTaskId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"ScriptName\\": \\"xxxx\\",\\n \\"ScriptVersion\\": \\"111\\",\\n \\"ModifyTime\\": \\"1640316786259\\",\\n \\"Strategy\\": {\\n \\"EndTime\\": 1640316786259,\\n \\"StartTime\\": 1640316786259\\n },\\n \\"Progress\\": {\\n \\"TotalNotAnswered\\": 1,\\n \\"Status\\": \\"Scheduling\\",\\n \\"StartTime\\": 1640316786259,\\n \\"FailedNum\\": 10,\\n \\"PausedNum\\": 10,\\n \\"CancelledNum\\": 10,\\n \\"TotalCompleted\\": 10,\\n \\"TotalJobs\\": 100,\\n \\"Duration\\": 1000,\\n \\"Scheduling\\": 20,\\n \\"ExecutingNum\\": 20\\n },\\n \\"ExportProgress\\": {\\n \\"Status\\": \\"PENDING\\",\\n \\"FileHttpUrl\\": \\"http://www.xxx.com/xxx\\\\n\\",\\n \\"Progress\\": \\"50\\"\\n },\\n \\"MinConcurrency\\": 1\\n }\\n ]\\n}","type":"json"}]',
'title' => '异步查询任务列表',
'summary' => '异步获取外呼任务列表。当在调用ListJobGroup接口时指定了Async时,使用此接口获取异步ListJobGroup的结果。',
'changeSet' => [
[
'createdAt' => '2024-06-24T02:14:42.000Z',
'description' => '响应参数发生变更、错误码发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListJobGroupsAsync',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListJobs' => [
'summary' => '查询多个作业。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94124',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'JobId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '作业ID列表,注:子级条数 <= 99。',
'type' => 'array',
'items' => [
'description' => '作业ID',
'type' => 'string',
'required' => false,
'example' => '24fb9a8d-f20e-4ee2-a11c-094dda68c5cc',
],
'required' => true,
'example' => '24fb9a8d-f20e-4ee2-a11c-094dda68c5cc',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Jobs' => [
'description' => '作业数组',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '作业状态,取值范围'."\n"
."\n"
.'- **Scheduling**:调度中。'."\n"
.'- **Executing**:执行中。'."\n"
.'- **Succeeded**:成功。'."\n"
.'- **Paused**:挂起。'."\n"
.'- **Failed**:失败。'."\n"
.'- **Cancelled**:已取消。'."\n"
.'- **Drafted**:草稿态。',
'type' => 'string',
'example' => 'Succeeded',
],
'ScenarioId' => [
'description' => '业务ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'JobGroupId' => [
'description' => '作业组ID',
'type' => 'string',
'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8',
],
'StrategyId' => [
'description' => '策略ID',
'type' => 'string',
'example' => 'c8a2b7f2-ad1a-4865-b872-d0080d9802d9',
],
'JobId' => [
'description' => '作业ID',
'type' => 'string',
'example' => 'b72425bd-7871-4050-838e-033d80d754b7',
],
'Priority' => [
'description' => ' '."\n"
.'作业优先级',
'type' => 'integer',
'format' => 'int32',
'example' => ' 5',
],
'SystemPriority' => [
'description' => ' '."\n"
.'系统优先级',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'FailureReason' => [
'description' => '作业失败原因',
'type' => 'string',
'example' => 'NoAnswer',
],
'ReferenceId' => [
'description' => '作业的业务ID,有业务方自定义。'."\n"
."\n"
.'> 为上传的ContactIdID值。',
'type' => 'string',
'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28',
],
'Contacts' => [
'description' => '联系人列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PhoneNumber' => [
'description' => '电话号码',
'type' => 'string',
'example' => '135****8888',
],
'State' => [
'description' => '状态【已废弃】',
'type' => 'string',
'example' => 'Available',
],
'ContactId' => [
'description' => '联系人ID。系统自动生成',
'type' => 'string',
'example' => 'db3db762-e421-44c9-9a01-cb423470757c',
],
'Honorific' => [
'description' => '尊称。与联系人名字相同',
'type' => 'string',
'example' => '张先生',
],
'JobId' => [
'description' => '作业ID【已废弃】',
'type' => 'string',
'example' => '72dcd26b-f12d-4c27-b3af-18f6aed5b160',
],
'ContactName' => [
'description' => '联系人名字',
'type' => 'string',
'example' => '张三',
],
'Role' => [
'description' => '联系人角色【废弃】',
'type' => 'string',
'example' => '*',
],
'ReferenceId' => [
'description' => '联系人第三方系统ID',
'type' => 'string',
'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34',
],
],
'description' => '',
],
],
'Extras' => [
'description' => '业务参数列表。'."\n"
."\n"
.'> 说明 TenantId、ServiceId为系统生成,其余参数为自定义参考传入的',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '业务参数Key',
'type' => 'string',
'example' => 'name',
],
'Value' => [
'description' => '业务参数Value',
'type' => 'string',
'example' => '张三',
],
],
'description' => '',
],
],
'Summary' => [
'description' => '对话业务标签数据:'."\n"
."\n"
.'大模型场景中:对话完结后的标签命中数据。'."\n"
."\n"
.'小模型场景中:对话完结后的变量值数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SummaryName' => [
'description' => '标签名字。',
'type' => 'string',
'example' => 'score',
],
'Category' => [
'description' => ' '."\n"
.'对话摘要类别',
'type' => 'string',
'example' => ' {}',
],
'Content' => [
'description' => '标签值',
'type' => 'string',
'example' => '5',
],
],
'description' => '',
],
],
'Tasks' => [
'description' => '任务列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '任务状态,取值范围'."\n"
.'(注:**Succeeded**状态已细分原因,不会展示**Succeeded**:1(已接通)状态,之后返回均为具体细分原因类型。)'."\n"
."\n"
.'- **Executing**:0(正在拨打)。'."\n"
.'- **Succeeded**:1(已接通)。'."\n"
.'- **NoAnswer**:2(未接通-无人接听)。'."\n"
.'- **NotExist**:3(未接通-空号)。'."\n"
.'- **Busy**:4(未接通-占线)。'."\n"
.'- **Cancelled**:5(未呼出-任务停止)。'."\n"
.'- **Failed**:6(失败)。'."\n"
.'- **NotConnected**:7(未接通-无法接通)。'."\n"
.'- **PoweredOff**:8(未接通-关机)。'."\n"
.'- **OutOfService**:9(未接通-被叫停机)。'."\n"
.'- **InArrears**:10(未接通-被叫欠费)。'."\n"
.'- **EmptyNumber**:11(未呼出-空号不外呼)。'."\n"
.'- **PerDayCallCountLimit**:12(未呼出-超出每日上限)。'."\n"
.'- **ContactBlockList**:13(未呼出-黑名单)。'."\n"
.'- **CallerNotRegistered**:14(未呼出-主叫号码未注册)。'."\n"
.'- **Terminated**:15(未呼出-被终止)。'."\n"
.'- **VerificationCancelled**:16(未呼出-呼叫前验证不通过取消)。'."\n"
.'- **OutOfServiceNoCall**:17(未呼出-被叫停机不外呼)。'."\n"
.'- **InArrearsNoCall**:18(未呼出-被叫欠费不外呼)。'."\n"
.'- **CallingNumberNotExist**:19(未呼出-主叫号码不存在)。'."\n"
.'- **SucceededFinish**:20(已接通-正常完结)。'."\n"
.'- **SucceededChatbotHangUpAfterNoAnswer**:21(已接通-拒识后机器人挂机)。'."\n"
.'- **SucceededChatbotHangUpAfterSilence**:22(已接通-静默超时挂机)。'."\n"
.'- **SucceededClientHangUpAfterNoAnswer**:23(已接通-拒识后用户挂机)。'."\n"
.'- **SucceededClientHangUp**:24(已接通-用户无理由挂机)。'."\n"
.'- **SucceededTransferByIntent**:25(已接通-命中意图转人工)。'."\n"
.'- **SucceededTransferAfterNoAnswer**:26(已接通-拒识转人工)。'."\n"
.'- **SucceededInoInterAction**:27(已接通-用户侧无交互)。'."\n"
.'- **SucceededError**:28(已接通-系统异常中断)。'."\n"
.'- **SucceededSpecialInterceptVoiceAssistant**:29(已接通-特殊情况拦截-语音助手)。'."\n"
.'- **SucceededSpecialInterceptExtensionNumberTransfer**:30(已接通-特殊情况拦截-分机号转接)。'."\n"
.'- **SucceededSpecialInterceptCustomSpecialIntercept**:31(已接通-特殊情况拦截-自定义拦截)。'."\n"
.'- **HighRiskSipCode**:32(未呼出-高风险不外呼)。',
'type' => 'string',
'example' => 'Succeeded',
],
'PlanedTime' => [
'description' => '任务计划执行时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1579068424883',
],
'ChatbotId' => [
'description' => '对话机器人id',
'type' => 'string',
'example' => ' 1234',
],
'ActualTime' => [
'description' => '实际执行时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1579068424883',
],
'CalledNumber' => [
'description' => '被叫号码',
'type' => 'string',
'example' => '135****8888',
],
'ScenarioId' => [
'description' => '场景ID。历史参数。【已废弃】',
'type' => 'string',
'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150',
],
'JobId' => [
'description' => '作业ID',
'type' => 'string',
'example' => 'b72425bd-7871-4050-838e-033d80d754b7',
],
'CallId' => [
'description' => '呼叫ID',
'type' => 'string',
'example' => '1528189846043',
],
'CallingNumber' => [
'description' => '主叫号码',
'type' => 'string',
'example' => '0571****3106',
],
'Brief' => [
'description' => '业务结果。历史参数【已废弃】',
'type' => 'string',
'example' => '1',
],
'Duration' => [
'description' => '持续时间。',
'type' => 'integer',
'format' => 'int32',
'example' => ' 120',
],
'TaskId' => [
'description' => '任务ID',
'type' => 'string',
'example' => 'ff44709e-39a6-43ba-959b-20fcabe3e496',
],
'Conversation' => [
'description' => '对话列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Speaker' => [
'description' => '是谁说的话,Robot 机器人, Contact 联系人',
'type' => 'string',
'example' => 'Robot',
],
'Timestamp' => [
'description' => '对话文本入库时间戳',
'type' => 'integer',
'format' => 'int64',
'example' => '1579068424883',
],
'Script' => [
'description' => ' '."\n"
.'对话文本',
'type' => 'string',
'example' => '你好,我是**客服',
],
'Summary' => [
'description' => '摘要信息,【已废弃】',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SummaryName' => [
'description' => '摘要名称',
'type' => 'string',
'example' => '是本人',
],
'Category' => [
'description' => '类目',
'type' => 'string',
'example' => '标签',
],
'Content' => [
'description' => '摘要内容',
'type' => 'string',
'example' => '是',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
'Contact' => [
'description' => ' '."\n"
.'任务的联系人',
'type' => 'object',
'properties' => [
'PhoneNumber' => [
'description' => '电话号码',
'type' => 'string',
'example' => '135****8888',
],
'State' => [
'description' => '状态。',
'type' => 'string',
'example' => 'Available',
],
'ContactId' => [
'description' => '联系人ID',
'type' => 'string',
'example' => 'db3db762-e421-44c9-9a01-cb423470757c',
],
'Honorific' => [
'description' => '联系人尊称。不填入则与联系人名称相同',
'type' => 'string',
'example' => '张先生',
],
'JobId' => [
'description' => '作业ID。已废弃',
'type' => 'string',
'example' => 'b72425bd-7871-4050-838e-033d80d754b7',
],
'ContactName' => [
'description' => '联系人名字',
'type' => 'string',
'example' => '张三',
],
'Role' => [
'description' => '角色。',
'type' => 'string',
'example' => '*',
],
'ReferenceId' => [
'description' => '联系人第三方系统ID',
'type' => 'string',
'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34',
],
],
],
],
'description' => '',
],
],
'CallingNumbers' => [
'description' => '主叫号码列表',
'type' => 'array',
'items' => [
'description' => '主叫号码列表',
'type' => 'string',
'example' => '["0571****3106"]',
],
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Jobs\\": [\\n {\\n \\"Status\\": \\"Succeeded\\",\\n \\"ScenarioId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"JobGroupId\\": \\"fce6c599-8ede-40e3-9f78-0928eda7b4e8\\",\\n \\"StrategyId\\": \\"c8a2b7f2-ad1a-4865-b872-d0080d9802d9\\",\\n \\"JobId\\": \\"b72425bd-7871-4050-838e-033d80d754b7\\",\\n \\"Priority\\": 5,\\n \\"SystemPriority\\": 1,\\n \\"FailureReason\\": \\"NoAnswer\\",\\n \\"ReferenceId\\": \\"d5971d98-7312-4f0e-a918-a17d67133e28\\",\\n \\"Contacts\\": [\\n {\\n \\"PhoneNumber\\": \\"135****8888\\",\\n \\"State\\": \\"Available\\",\\n \\"ContactId\\": \\"db3db762-e421-44c9-9a01-cb423470757c\\",\\n \\"Honorific\\": \\"张先生\\",\\n \\"JobId\\": \\"72dcd26b-f12d-4c27-b3af-18f6aed5b160\\",\\n \\"ContactName\\": \\"张三\\",\\n \\"Role\\": \\"*\\",\\n \\"ReferenceId\\": \\"2fa6bac3-06da-4315-82ab-72d6fd3a6f34\\"\\n }\\n ],\\n \\"Extras\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"张三\\"\\n }\\n ],\\n \\"Summary\\": [\\n {\\n \\"SummaryName\\": \\"score\\",\\n \\"Category\\": \\"\\\\t{}\\",\\n \\"Content\\": \\"5\\"\\n }\\n ],\\n \\"Tasks\\": [\\n {\\n \\"Status\\": \\"Succeeded\\",\\n \\"PlanedTime\\": 1579068424883,\\n \\"ChatbotId\\": \\"\\\\t1234\\",\\n \\"ActualTime\\": 1579068424883,\\n \\"CalledNumber\\": \\"135****8888\\",\\n \\"ScenarioId\\": \\"ade80092-03d9-4f4d-ad4f-ab8a247d3150\\",\\n \\"JobId\\": \\"b72425bd-7871-4050-838e-033d80d754b7\\",\\n \\"CallId\\": \\"1528189846043\\",\\n \\"CallingNumber\\": \\"0571****3106\\",\\n \\"Brief\\": \\"1\\",\\n \\"Duration\\": 120,\\n \\"TaskId\\": \\"ff44709e-39a6-43ba-959b-20fcabe3e496\\",\\n \\"Conversation\\": [\\n {\\n \\"Speaker\\": \\"Robot\\",\\n \\"Timestamp\\": 1579068424883,\\n \\"Script\\": \\"你好,我是**客服\\",\\n \\"Summary\\": [\\n {\\n \\"SummaryName\\": \\"是本人\\",\\n \\"Category\\": \\"标签\\",\\n \\"Content\\": \\"是\\"\\n }\\n ]\\n }\\n ],\\n \\"Contact\\": {\\n \\"PhoneNumber\\": \\"135****8888\\",\\n \\"State\\": \\"Available\\",\\n \\"ContactId\\": \\"db3db762-e421-44c9-9a01-cb423470757c\\",\\n \\"Honorific\\": \\"张先生\\",\\n \\"JobId\\": \\"b72425bd-7871-4050-838e-033d80d754b7\\",\\n \\"ContactName\\": \\"张三\\",\\n \\"Role\\": \\"*\\",\\n \\"ReferenceId\\": \\"2fa6bac3-06da-4315-82ab-72d6fd3a6f34\\"\\n }\\n }\\n ],\\n \\"CallingNumbers\\": [\\n \\"[\\\\\\"0571****3106\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n \\n Succeeded\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n fce6c599-8ede-40e3-9f78-0928eda7b4e8\\n c8a2b7f2-ad1a-4865-b872-d0080d9802d9\\n b72425bd-7871-4050-838e-033d80d754b7\\n 1\\n NoAnswer\\n d5971d98-7312-4f0e-a918-a17d67133e28\\n \\n 135****8888\\n Available\\n db3db762-e421-44c9-9a01-cb423470757c\\n 张先生\\n 72dcd26b-f12d-4c27-b3af-18f6aed5b160\\n 张三\\n *\\n 2fa6bac3-06da-4315-82ab-72d6fd3a6f34\\n \\n \\n name\\n 张三\\n \\n \\n score\\n \\t{}\\n 5\\n \\n \\n Succeeded\\n 1579068424883\\n \\t1234\\n 1579068424883\\n 135****8888\\n ade80092-03d9-4f4d-ad4f-ab8a247d3150\\n b72425bd-7871-4050-838e-033d80d754b7\\n 1528189846043\\n 0571****3106\\n 1\\n ff44709e-39a6-43ba-959b-20fcabe3e496\\n \\n Robot\\n 1579068424883\\n \\n \\n 是本人\\n 标签\\n 是\\n \\n \\n \\n 135****8888\\n Available\\n db3db762-e421-44c9-9a01-cb423470757c\\n 张先生\\n b72425bd-7871-4050-838e-033d80d754b7\\n 张三\\n *\\n 2fa6bac3-06da-4315-82ab-72d6fd3a6f34\\n \\n \\n [\\"0571****3106\\"]\\n \\n","errorExample":""}]',
'title' => '查询多个作业',
'changeSet' => [
[
'createdAt' => '2024-07-24T07:36:11.000Z',
'description' => '错误码发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListJobsByGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例 ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '作业组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'de48407d-309e-451a-81ec-6fb11f8fdbf3',
],
],
[
'name' => 'JobStatus',
'in' => 'query',
'schema' => [
'description' => '作业状态',
'type' => 'string',
'required' => false,
'example' => 'Succeeded',
],
],
[
'name' => 'JobFailureReason',
'in' => 'query',
'schema' => [
'description' => '作业失败原因',
'type' => 'string',
'required' => false,
'example' => 'NoAnswer',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Jobs' => [
'description' => '作业数组',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '18',
],
'List' => [
'description' => '作业列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '作业状态。'."\n"
.'- Scheduling(0, "调度中")'."\n"
.'- Executing(1, "执行中"),'."\n"
.'- Succeeded(2, "结束-已触达"),'."\n"
.'- Paused(3, "暂停"),'."\n"
.'- Failed(4, "结束-未触达")'."\n"
.'- Cancelled(5, "已取消-人工干预")'."\n"
.'- Drafted(6, "草稿态"),',
'type' => 'string',
'example' => 'Succeeded',
],
'ScenarioId' => [
'description' => '场景ID(历史参数)',
'type' => 'string',
'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150',
],
'JobGroupId' => [
'description' => '任务ID',
'type' => 'string',
'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8',
],
'StrategyId' => [
'description' => '策略ID',
'type' => 'string',
'example' => 'c8a2b7f2-ad1a-4865-b872-d0080d9802d9',
],
'JobId' => [
'description' => '作业ID',
'type' => 'string',
'example' => 'b72425bd-7871-4050-838e-033d80d754b7',
],
'Priority' => [
'description' => '优先级',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'SystemPriority' => [
'description' => ' '."\n"
.'系统优先级',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'FailureReason' => [
'description' => '失败原因。'."\n"
.'- Unknown(未知错误), '."\n"
.'- NoAnswer(无人接听),'."\n"
.'- InvalidStrategy(无效的策略,策略配置不正确),'."\n"
.'- TimeUp(调度时发现超时),'."\n"
.'- NoStrategy(策略为空或没有找到),'."\n"
.'- CallFailed(呼叫失败),'."\n"
.'- PerDayCallCountLimit(号码每日呼叫次数限制),'."\n"
.'- ContactBlockList(禁止外呼名单),'."\n"
.'- EmptyNumber(空号不再外呼),'."\n"
.'- JobPerDayCallCountLimit(号码每日呼叫次数限制),'."\n"
.'- VerificationCancelled(呼叫前验证不通过取消),'."\n"
.'- ContactSuspended(止呼),'."\n"
.'- InArrears(欠费),'."\n"
.'- OutOfService(停机),'."\n"
.'- NoneRepeatableJobMaxAttemptCountLimit(任务达到最大尝试次数);',
'type' => 'string',
'example' => 'NoAnswer',
],
'ReferenceId' => [
'description' => '第三方系统id',
'type' => 'string',
'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28',
],
'Contacts' => [
'description' => '联系人列表',
'type' => 'array',
'items' => [
'description' => '联系人信息。',
'type' => 'object',
'properties' => [
'PhoneNumber' => [
'description' => '联系人号码',
'type' => 'string',
'example' => '134********',
],
'State' => [
'description' => '已废弃',
'type' => 'string',
'example' => 'Available',
],
'ContactId' => [
'description' => '联系人ID。(系统自动生成)',
'type' => 'string',
'example' => 'db3db762-e421-44c9-9a01-cb423470757c',
],
'Honorific' => [
'description' => '联系人尊称。(与联系人名字一致)',
'type' => 'string',
'example' => '张先生',
],
'JobId' => [
'description' => '作业ID。(已废弃)',
'type' => 'string',
'example' => '72dcd26b-f12d-4c27-b3af-18f6aed5b160',
],
'ContactName' => [
'description' => '联系人名字',
'type' => 'string',
'example' => '张三',
],
'Role' => [
'description' => '已废弃',
'type' => 'string',
'example' => '*',
],
'ReferenceId' => [
'description' => '联系人第三方系统id,客户自己上传',
'type' => 'string',
'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34',
],
],
],
],
'Extras' => [
'description' => '业务数据'."\n"
."\n"
.'> TenantId、ServiceId为系统生成,其余参数为自定义参考传入的',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '业务参数名字',
'type' => 'string',
'example' => '性别',
],
'Value' => [
'description' => '业务参数值',
'type' => 'string',
'example' => '男',
],
],
'description' => '',
],
],
'Summary' => [
'description' => '对话摘要。【已废弃】'."\n"
."\n"
.'> 可通过DescribeJob接口获取',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SummaryName' => [
'description' => '摘要名字',
'type' => 'string',
'example' => 'score',
],
'JobGroupId' => [
'description' => '作业组ID',
'type' => 'string',
'example' => '88e56cfb-33f8-477a-907c-0fe83292d924',
],
'JobId' => [
'description' => '作业ID。',
'type' => 'string',
'example' => 'f102a853-5f5a-47fb-8869-b31ea74a9620',
],
'Category' => [
'description' => '对话摘要类别',
'type' => 'string',
'example' => '{}',
],
'TaskId' => [
'description' => '通话ID。',
'type' => 'string',
'example' => 'b0f35dd1-0337-402e-9c4f-3a6c2426950a',
],
'Content' => [
'description' => '对话摘要内容',
'type' => 'string',
'example' => '5',
],
'ConversationDetailId' => [
'description' => '通话记录ID',
'type' => 'string',
'example' => '62a860f5-a8b3-4b75-9512-c7e04bb7c8bc',
],
'SummaryId' => [
'description' => '摘要ID',
'type' => 'string',
'example' => '680f1905-81ae-4aab-99dd-2964dfb767fa',
],
],
'description' => '',
],
],
'CallingNumbers' => [
'description' => '主叫号码列表',
'type' => 'array',
'items' => [
'description' => '主叫号码',
'type' => 'string',
'example' => '0571****3106',
],
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter %s is invalid.',
'description' => '参数值校验不通过。请使用请求参数构造规范化的请求字符串。',
],
],
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Jobs\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 18,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"Succeeded\\",\\n \\"ScenarioId\\": \\"ade80092-03d9-4f4d-ad4f-ab8a247d3150\\",\\n \\"JobGroupId\\": \\"fce6c599-8ede-40e3-9f78-0928eda7b4e8\\",\\n \\"StrategyId\\": \\"c8a2b7f2-ad1a-4865-b872-d0080d9802d9\\",\\n \\"JobId\\": \\"b72425bd-7871-4050-838e-033d80d754b7\\",\\n \\"Priority\\": 5,\\n \\"SystemPriority\\": 1,\\n \\"FailureReason\\": \\"NoAnswer\\",\\n \\"ReferenceId\\": \\"d5971d98-7312-4f0e-a918-a17d67133e28\\",\\n \\"Contacts\\": [\\n {\\n \\"PhoneNumber\\": \\"134********\\",\\n \\"State\\": \\"Available\\",\\n \\"ContactId\\": \\"db3db762-e421-44c9-9a01-cb423470757c\\",\\n \\"Honorific\\": \\"张先生\\",\\n \\"JobId\\": \\"72dcd26b-f12d-4c27-b3af-18f6aed5b160\\",\\n \\"ContactName\\": \\"张三\\",\\n \\"Role\\": \\"*\\",\\n \\"ReferenceId\\": \\"2fa6bac3-06da-4315-82ab-72d6fd3a6f34\\"\\n }\\n ],\\n \\"Extras\\": [\\n {\\n \\"Key\\": \\"性别\\",\\n \\"Value\\": \\"男\\"\\n }\\n ],\\n \\"Summary\\": [\\n {\\n \\"SummaryName\\": \\"score\\",\\n \\"JobGroupId\\": \\"88e56cfb-33f8-477a-907c-0fe83292d924\\",\\n \\"JobId\\": \\"f102a853-5f5a-47fb-8869-b31ea74a9620\\",\\n \\"Category\\": \\"{}\\",\\n \\"TaskId\\": \\"b0f35dd1-0337-402e-9c4f-3a6c2426950a\\",\\n \\"Content\\": \\"5\\",\\n \\"ConversationDetailId\\": \\"62a860f5-a8b3-4b75-9512-c7e04bb7c8bc\\",\\n \\"SummaryId\\": \\"680f1905-81ae-4aab-99dd-2964dfb767fa\\"\\n }\\n ],\\n \\"CallingNumbers\\": [\\n \\"0571****3106\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '根据作业组查询作业',
'summary' => '根据作业组查询作业。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListJobsByGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListOutboundCallNumbers' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '94126',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'OutboundCallNumbers' => [
'description' => '号码列表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'List' => [
'description' => '号码数据列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Number' => [
'description' => '号码',
'type' => 'string',
'example' => '10088',
],
'OutboundCallNumberId' => [
'description' => '号码id',
'type' => 'string',
'example' => ' fa0e21e9-caab-4629-9121-1e341243d599',
],
'RateLimitCount' => [
'description' => '限流时间范围,单位为秒',
'type' => 'string',
'example' => '10',
],
'RateLimitPeriod' => [
'description' => ' '."\n"
.'限流次数',
'type' => 'string',
'example' => '100',
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"OutboundCallNumbers\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"10088\\",\\n \\"OutboundCallNumberId\\": \\"\\\\tfa0e21e9-caab-4629-9121-1e341243d599\\",\\n \\"RateLimitCount\\": \\"10\\",\\n \\"RateLimitPeriod\\": \\"100\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询外呼主叫号码列表',
'summary' => '查询外呼主叫号码列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListOutboundCallNumbers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListResourceTags' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'instance',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口消息提示',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'ResourceTags' => [
'description' => '资源标签信息',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'List' => [
'description' => '资源标签列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '资源标签key',
'type' => 'string',
'example' => 'name',
],
'Value' => [
'description' => '资源标签值',
'type' => 'string',
'example' => 'xxx',
],
],
'description' => '',
],
'example' => '[]',
],
],
'example' => '{}',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"ResourceTags\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"List\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"xxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询实例资源标签',
'summary' => '查询实例业务资源的标签。',
'changeSet' => [
[
'createdAt' => '2024-07-24T07:36:10.000Z',
'description' => '错误码发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListResourceTags',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListScriptPublishHistories' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b0f35dd1-0337-402e-9c4f-3a6c2426950a',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示多少条',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'ScriptPublishHistories' => [
'description' => '历史列表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'List' => [
'description' => '数据数组',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PublishTime' => [
'description' => '发布时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1578965079000',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => '29420f65-8f1f-4009-b2f8-f4f7b5d59090',
],
'Description' => [
'description' => '发布描述',
'type' => 'string',
'example' => '第一次发布',
],
'ScriptVersion' => [
'description' => '话术版本',
'type' => 'string',
'example' => '1578965079000',
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"ScriptPublishHistories\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"List\\": [\\n {\\n \\"PublishTime\\": 1578965079000,\\n \\"InstanceId\\": \\"af81a389-91f0-4157-8d82-720edd02b66a\\",\\n \\"ScriptId\\": \\"29420f65-8f1f-4009-b2f8-f4f7b5d59090\\",\\n \\"Description\\": \\"第一次发布\\",\\n \\"ScriptVersion\\": \\"1578965079000\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n \\n 1\\n 10\\n 100\\n \\n 1578965079000\\n af81a389-91f0-4157-8d82-720edd02b66a\\n 29420f65-8f1f-4009-b2f8-f4f7b5d59090\\n 第一次发布\\n 1578965079000\\n
\\n \\n","errorExample":""}]',
'title' => '查询外呼小模型场景发布历史列表',
'summary' => '查询外呼发布历史列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListScriptPublishHistories',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListScriptRecording' => [
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '161707',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '录音所属实例ID',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'c209abb3-6804-4a75-b2c7-dd55c8c61b6a'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '录音所属场景ID',
'type' => 'string',
'required' => true,
'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95'."\n",
],
],
[
'name' => 'UuidsJson',
'in' => 'query',
'schema' => [
'description' => '录音ID列表'."\n"
."\n"
.'> 即录音唯一ID的列表,不填写则展示所有',
'type' => 'string',
'required' => false,
'example' => '["d17d5bfa-4972-4389-9718-f9602edabe48"]',
],
],
[
'name' => 'StatesJson',
'in' => 'query',
'schema' => [
'description' => '录音状态'."\n"
."\n"
.'- 校验中:1'."\n"
.'- 校验未通过:2'."\n"
.'- 处理中:3'."\n"
.'- 处理失败:4'."\n"
.'- 审核中:5'."\n"
.'- 审核未通过:6'."\n"
.'- 发布失败:7'."\n"
.'- 已发布:8'."\n"
.'- 待发布:9',
'type' => 'string',
'required' => false,
'example' => '['."\n"
.' "8"'."\n"
.']',
],
],
[
'name' => 'Search',
'in' => 'query',
'schema' => [
'description' => '搜索条件:可根据录音名称、录音内容查询',
'type' => 'string',
'required' => false,
'example' => '您好',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
[
'name' => 'RefIdsJson',
'in' => 'query',
'schema' => [
'description' => '录音ID列表(JSON格式),与UuidsJson相同',
'type' => 'string',
'required' => false,
'example' => '["d9fad189-760b-47b9-837f-aeabb4fc9109\\"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n",
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'PageSize' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int64',
'example' => '99',
],
'ScriptRecordings' => [
'description' => '录音列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RecordingContent' => [
'description' => '录音内容',
'type' => 'string',
'example' => '您好!',
],
'State' => [
'description' => '录音状态',
'type' => 'integer',
'format' => 'int32',
'example' => '8',
],
'StorageUuid' => [
'description' => '存储UUID',
'type' => 'string',
'example' => '393674ed-3b5d-db44-0fda-615d05210178'."\n",
],
'StateExtend' => [
'description' => '状态扩展',
'type' => 'string',
'example' => '无',
],
'InstanceId' => [
'description' => '所属实例ID',
'type' => 'string',
'example' => 'ff0fb845-9f90-46d3-9716-d36b8a1e753a',
],
'GmtModified' => [
'description' => '更新时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1654601332000',
],
'ScriptId' => [
'description' => '录音所属场景id',
'type' => 'string',
'example' => '6019b692-fd9e-4adb-8877-cef6a297b234',
],
'Uuid' => [
'description' => '录音唯一ID',
'type' => 'string',
'example' => '0a77386e-6402-8d23-4adf-6ec13b3f404d'."\n",
],
'GmtUpload' => [
'description' => '录音上传时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1654601332000',
],
'RecordingDuration' => [
'description' => '录音时长,单位秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RecordingName' => [
'description' => '录音名称',
'type' => 'string',
'example' => 'hello.wav',
],
'GmtCreate' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1744963749000',
],
'InnerId' => [
'description' => '录音文件在实例下的ID',
'type' => 'string',
'example' => '000003'."\n",
],
'RefId' => [
'description' => '录音唯一ID',
'type' => 'string',
'example' => '0a77386e-6402-8d23-4adf-6ec13b3f404d'."\n",
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\\\n\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 99,\\n \\"ScriptRecordings\\": [\\n {\\n \\"RecordingContent\\": \\"您好!\\",\\n \\"State\\": 8,\\n \\"StorageUuid\\": \\"393674ed-3b5d-db44-0fda-615d05210178\\\\n\\",\\n \\"StateExtend\\": \\"无\\",\\n \\"InstanceId\\": \\"ff0fb845-9f90-46d3-9716-d36b8a1e753a\\",\\n \\"GmtModified\\": 1654601332000,\\n \\"ScriptId\\": \\"6019b692-fd9e-4adb-8877-cef6a297b234\\",\\n \\"Uuid\\": \\"0a77386e-6402-8d23-4adf-6ec13b3f404d\\\\n\\",\\n \\"GmtUpload\\": 1654601332000,\\n \\"RecordingDuration\\": 10,\\n \\"RecordingName\\": \\"hello.wav\\",\\n \\"GmtCreate\\": 1744963749000,\\n \\"InnerId\\": \\"000003\\\\n\\",\\n \\"RefId\\": \\"0a77386e-6402-8d23-4adf-6ec13b3f404d\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '【小模型接口】查询录音文件列表',
'summary' => '查询录音文件列表,小模型场景使用。',
'changeSet' => [
[
'createdAt' => '2023-03-30T12:41:10.000Z',
'description' => '响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListScriptRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListScriptVoiceConfigs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'f95c7ca6-872c-4765-8493-165a8dfc682d',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'ScriptVoiceConfigs' => [
'description' => '话术录音列表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'List' => [
'description' => '话术录音数组',
'type' => 'array',
'items' => [
'description' => '话术录音数组',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '语音类型',
'type' => 'string',
'example' => 'TTS',
],
'ScriptVoiceConfigId' => [
'description' => '语音配置ID',
'type' => 'string',
'example' => '2c8fa91f-9856-4145-90f2-08252f09bc18',
],
'ScriptContent' => [
'description' => '话术文本内容',
'type' => 'string',
'example' => '请问你是 @name 吗',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'bdd49242-114c-4045-b1d1-25ccc1756c75',
],
'ScriptId' => [
'description' => '话术ID',
'type' => 'string',
'example' => 'a7441a05-43bb-4a2d-acb0-365f245d7a5b',
],
'ScriptWaveformRelation' => [
'description' => '话录音配置关系数据',
'type' => 'string',
'example' => '""',
],
'Source' => [
'description' => '话术源',
'type' => 'string',
'example' => 'DIALOGUE_FLOW',
],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"ScriptVoiceConfigs\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"List\\": [\\n {\\n \\"Type\\": \\"TTS\\",\\n \\"ScriptVoiceConfigId\\": \\"2c8fa91f-9856-4145-90f2-08252f09bc18\\",\\n \\"ScriptContent\\": \\"请问你是 @name 吗\\",\\n \\"InstanceId\\": \\"bdd49242-114c-4045-b1d1-25ccc1756c75\\",\\n \\"ScriptId\\": \\"a7441a05-43bb-4a2d-acb0-365f245d7a5b\\",\\n \\"ScriptWaveformRelation\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Source\\": \\"DIALOGUE_FLOW\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '【旧画布接口】查询场景声音配置列表',
'summary' => '旧画布场景中查询场景声音列表。',
'description' => '****',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListScriptVoiceConfigs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListScripts' => [
'summary' => '查询话术列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94130',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'bdd49242-114c-4045-b1d1-25ccc1756c75',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页显示的条数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
[
'name' => 'ScriptName',
'in' => 'query',
'schema' => [
'description' => '话术名字',
'type' => 'string',
'required' => false,
'example' => '课程满意度回访',
],
],
[
'name' => 'NluEngine',
'in' => 'query',
'schema' => [
'description' => 'Nlu机器人引擎。'."\n"
."\n"
.'- 如果不填写,则查询小模型场景;'."\n"
."\n"
.'- 如果填写Prompts,则查询大模型场景下的文本填写模式;'."\n"
."\n"
.'- 如果填写SSE_FUNCTION,则查询大模型下的函数计算模式;',
'type' => 'string',
'required' => false,
'example' => 'Prompts',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Scripts' => [
'description' => '话术列表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'List' => [
'description' => '话术数组',
'type' => 'array',
'items' => [
'description' => '话术数组',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '话术状态',
'type' => 'string',
'example' => 'DRAFTED',
],
'UpdateTime' => [
'description' => '更新时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1578965079000',
],
'ScriptId' => [
'description' => '话术ID',
'type' => 'string',
'example' => '8d6a6e41-8093-49af-a9d1-0281878758ac',
],
'IsDebugDrafted' => [
'description' => '调试版本是否为草稿态',
'type' => 'boolean',
'example' => 'true',
],
'Industry' => [
'description' => '行业',
'type' => 'string',
'example' => '金融',
],
'ScriptDescription' => [
'description' => '话术描述',
'type' => 'string',
'example' => '电话销售话术',
],
'IsDrafted' => [
'description' => '是否是草稿',
'type' => 'boolean',
'example' => 'true',
],
'DebugStatus' => [
'description' => '调试状态',
'type' => 'string',
'example' => 'DRAFTED',
],
'MiniPlaybackEnable' => [
'description' => '承接语配置开关',
'type' => 'boolean',
'example' => 'false',
],
'RejectReason' => [
'description' => '审核失败理由',
'type' => 'string',
'example' => '话术用语不合规',
],
'Scene' => [
'description' => '场景',
'type' => 'string',
'example' => '电销',
],
'ScriptName' => [
'description' => '话术名字',
'type' => 'string',
'example' => '电话销售话术',
],
'NewBargeInEnable' => [
'description' => '优雅打断配置开关,大模型均为false',
'type' => 'boolean',
'example' => 'false',
],
'LongWaitEnable' => [
'description' => '长时停顿配置开关,大模型均为false',
'type' => 'boolean',
'example' => 'false',
],
'EmotionEnable' => [
'description' => '情绪识别配置开关,大模型均为false',
'type' => 'boolean',
'example' => 'false',
],
'IsPreset' => [
'description' => '是否是预置场景',
'type' => 'boolean',
'example' => 'false',
],
'AgentKey' => [
'description' => '机器人业务空间访问Key',
'type' => 'string',
'example' => '14791f5f226b4878b3d9b676a0291234',
],
'AgentLlm' => [
'description' => '机器人业务空间是否大模型业务空间',
'type' => 'boolean',
'example' => 'false',
],
'agentId' => [
'description' => '机器人业务空间ID',
'type' => 'integer',
'format' => 'int64',
'example' => '1160195',
],
'NluEngine' => [
'description' => '机器人引擎。如果是小模型场景,则此字段为空;如果是大模型场景则此字段为Prompts',
'type' => 'string',
'example' => '空或者Prompts',
],
'NluAccessType' => [
'description' => '机器人访问类型。如果是小模型场景,则返回为空;如果是大模型场景,则返回Managed',
'type' => 'string',
'example' => '空或者Managed',
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1578965079000',
],
'NluProfile' => [
'description' => '函数计算服务模式配置',
'type' => 'object',
'properties' => [
'FcFunction' => [
'description' => '函数服务名称',
'type' => 'string',
'example' => 'sanfang_test',
],
'FcRegion' => [
'description' => '函数服务地域',
'type' => 'string',
'example' => 'cn-shanghai'."\n",
],
'FcHttpTriggerUrl' => [
'description' => '函数服务触发器',
'type' => 'string',
'example' => 'http://sanfang_test-xxxxxx.cn-shanghai-vpc.fcapp.run'."\n",
],
],
],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Scripts\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 15,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"DRAFTED\\",\\n \\"UpdateTime\\": 1578965079000,\\n \\"ScriptId\\": \\"8d6a6e41-8093-49af-a9d1-0281878758ac\\",\\n \\"IsDebugDrafted\\": true,\\n \\"Industry\\": \\"金融\\",\\n \\"ScriptDescription\\": \\"电话销售话术\\",\\n \\"IsDrafted\\": true,\\n \\"DebugStatus\\": \\"DRAFTED\\",\\n \\"MiniPlaybackEnable\\": false,\\n \\"RejectReason\\": \\"话术用语不合规\\",\\n \\"Scene\\": \\"电销\\",\\n \\"ScriptName\\": \\"电话销售话术\\",\\n \\"NewBargeInEnable\\": false,\\n \\"LongWaitEnable\\": false,\\n \\"EmotionEnable\\": false,\\n \\"IsPreset\\": false,\\n \\"AgentKey\\": \\"14791f5f226b4878b3d9b676a0291234\\",\\n \\"AgentLlm\\": false,\\n \\"agentId\\": 1160195,\\n \\"NluEngine\\": \\"空或者Prompts\\",\\n \\"NluAccessType\\": \\"空或者Managed\\",\\n \\"CreateTime\\": 1578965079000,\\n \\"NluProfile\\": {\\n \\"FcFunction\\": \\"sanfang_test\\",\\n \\"FcRegion\\": \\"cn-shanghai\\\\n\\",\\n \\"FcHttpTriggerUrl\\": \\"http://sanfang_test-xxxxxx.cn-shanghai-vpc.fcapp.run\\\\n\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n \\n 1\\n 10\\n 15\\n \\n DRAFTED\\n 1578965079000\\n 8d6a6e41-8093-49af-a9d1-0281878758ac\\n true\\n 金融\\n 电话销售话术\\n true\\n DRAFTED\\n false\\n 话术用语不合规\\n 电销\\n 电话销售话术\\n false\\n false\\n false\\n false\\n 14791f5f226b4878b3d9b676a0291234\\n false\\n 1160195\\n
\\n \\n","errorExample":""}]',
'title' => '查询话术列表',
'changeSet' => [
[
'createdAt' => '2025-04-25T07:27:13.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2025-03-26T03:20:42.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2024-08-06T12:39:33.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2024-04-25T12:17:46.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2022-09-27T13:02:34.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2022-06-21T12:54:40.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2021-12-22T12:30:26.000Z',
'description' => '响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListScripts',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => 'Instance',
'arn' => 'acs:outboundbot:{#regionId}:{#accountId}:instance/{#InstanceId}',
],
],
],
],
],
],
'ListTagResources' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '已废弃',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-shanghai',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [
'INSTANCE' => 'INSTANCE',
],
'example' => 'INSTANCE',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '下一个查询开始Token',
'type' => 'string',
'required' => false,
'example' => 'b949ae1f-01dc-4191-ae5a-70fbe6772fd8',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源ID列表,n 的取值范围为 [1, 50]',
'type' => 'array',
'items' => [
'description' => '资源ID,资源类型是INSTANCE时传入实例ID',
'type' => 'string',
'required' => false,
'example' => 'af651b72-4a64-4340-ae7f-2cf0054d32f9',
],
'required' => false,
'example' => 'ResourceId.1=b949ae1f-01dc-4191-ae5a-70fbe6772fd8',
'maxItems' => 51,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键,n 的取值范围为 [1, 20]。',
'type' => 'string',
'required' => false,
'example' => 'Tag.1.Key=key1',
],
'Value' => [
'description' => '标签值,n 的取值范围为 [1, 20]',
'type' => 'string',
'required' => false,
'example' => 'Tag.1.Value=value1',
],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'NextToken' => [
'description' => '下一个查询开始Token',
'type' => 'string',
'example' => 'b949ae1f-01dc-4191-ae5a-70fbe6772fd8',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'TagResources' => [
'description' => '资源列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ResourceType' => [
'description' => '资源类型',
'type' => 'string',
'example' => 'instance',
],
'TagValue' => [
'description' => '标签值',
'type' => 'string',
'example' => 'value1',
],
'ResourceId' => [
'description' => '资源ID',
'type' => 'string',
'example' => 'b949ae1f-01dc-4191-ae5a-70fbe6772fd8',
],
'TagKey' => [
'description' => '标签键',
'type' => 'string',
'example' => 'key1',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"NextToken\\": \\"b949ae1f-01dc-4191-ae5a-70fbe6772fd8\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceType\\": \\"instance\\",\\n \\"TagValue\\": \\"value1\\",\\n \\"ResourceId\\": \\"b949ae1f-01dc-4191-ae5a-70fbe6772fd8\\",\\n \\"TagKey\\": \\"key1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n b949ae1f-01dc-4191-ae5a-70fbe6772fd8\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n OK\\n Success\\n \\n instance\\n value1\\n b949ae1f-01dc-4191-ae5a-70fbe6772fd8\\n key1\\n \\n","errorExample":""}]',
'title' => '【已废弃】查询资源标签关系',
'summary' => '查询资源标签关系。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
[
'createdAt' => '2024-07-24T07:36:09.000Z',
'description' => '错误码发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListTagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ListTags' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '8a4c6d3d-5ed6-44ca-b779-16c20f8862be',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口消息提示',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'TagGroups' => [
'description' => '标签组列表',
'type' => 'array',
'items' => [
'description' => '标签组列表',
'type' => 'object',
'properties' => [
'TagGroupId' => [
'description' => '标签组ID',
'type' => 'string',
'example' => '38c03261-9fe8-4b9b-8c3b-983a60319012',
],
'TagGroupIndex' => [
'description' => '标签组索引',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TagGroup' => [
'description' => '标签组名称',
'type' => 'string',
'example' => '当前学历',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => '365b955d-6f4d-4ab5-a6e1-9a301307f4b1',
],
],
],
],
'Tags' => [
'description' => '标签列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagGroup' => [
'description' => '标签组名称',
'type' => 'string',
'example' => '当前学历',
],
'TagName' => [
'description' => '标签名字',
'type' => 'string',
'example' => '本科',
],
'TagIndex' => [
'description' => '标签索引',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => '8a4c6d3d-5ed6-44ca-b779-16c20f8862be',
],
'TagId' => [
'description' => '标签ID',
'type' => 'string',
'example' => 'd62be647-6202-4b1f-9708-0baeec552635',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"TagGroups\\": [\\n {\\n \\"TagGroupId\\": \\"38c03261-9fe8-4b9b-8c3b-983a60319012\\",\\n \\"TagGroupIndex\\": 1,\\n \\"TagGroup\\": \\"当前学历\\",\\n \\"ScriptId\\": \\"365b955d-6f4d-4ab5-a6e1-9a301307f4b1\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"TagGroup\\": \\"当前学历\\",\\n \\"TagName\\": \\"本科\\",\\n \\"TagIndex\\": 1,\\n \\"ScriptId\\": \\"8a4c6d3d-5ed6-44ca-b779-16c20f8862be\\",\\n \\"TagId\\": \\"d62be647-6202-4b1f-9708-0baeec552635\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询话术下的标签-旧画布接口',
'summary' => '查询话术下的标签,旧画布接口。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListTags',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyAgentProfile' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '230368',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => [
'title' => 'instance id',
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd',
],
],
[
'name' => 'AgentProfileId',
'in' => 'formData',
'schema' => [
'title' => 'agent profile id',
'description' => '智能体配置ID'."\n"
."\n"
.'> 可通过DescribeScript的返回参数ChatbotId获取已经创建场景的智能体配置ID',
'type' => 'string',
'required' => true,
'example' => '37ca3ca1ac4b4e57adf3da5b5d939d04',
],
],
[
'name' => 'PromptJson',
'in' => 'formData',
'schema' => [
'title' => 'prompt json',
'description' => '智能体配置',
'type' => 'string',
'required' => false,
'example' => '{'."\n"
.' "name": "安妮",'."\n"
.' "gender": "女",'."\n"
.' "age": 20,'."\n"
.' "role": "游戏推广员",'."\n"
.' "communicationStyle": ["亲切", "口语化", "活泼"],'."\n"
.' "goals": "通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。",'."\n"
.' "background": "福利介绍\\n从${开始时间}开始,直至${结束时间}结束,为期一周的时间里,我们精心准备了\'限时寻宝\'福利活动。只要您在这段时间内每日登录游戏,即可领取登录礼包,内含珍稀材料、能量药剂和限定外观奖励\\n\\n福利亮点\\n本次活动的亮点在于,累积登录达到5天的玩家,将额外获得一份\'神秘宝箱\',开启宝箱获得稀有宠物,将为您的战斗增添强大助力!千万别错过这次增强实力的绝佳机会。\\n\\n参与方式\\n登录游戏后,在活动面板中找到\'限时寻宝\',点击即可领取对应的奖励。记得每天上线,奖励不等人哦!",'."\n"
.' "skills": "作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。",'."\n"
.' "workflow": "1.亲切问候与自我介绍\\n- 开场白:“尊敬的冒险者,您好!我是安妮,来自游戏客服团队。今天有幸与您连线,是想分享一项即将启动的独家福利活动,绝对会让您的探险之旅更加精彩纷呈!”\\n- 确认玩家想了解活动后,再进行福利活动的介绍\\n2.福利活动介绍\\n3.强调福利亮点\\n4.说明参与方式与提醒\\n5.鼓励分享与反馈\\n- 互动号召:“如果您觉得这个活动不错,不妨和您的公会伙伴或者游戏朋友分享这个好消息。同时,我们也非常欢迎您在活动结束后,通过游戏内置的反馈系统告诉我们您的体验感受和建议。”\\n技能6: 礼貌结束通话\\n- 结束语:“好了,尊敬的冒险者,以上就是这次活动的主要内容。希望您能在活动中满载而归,祝您在旅程中所向披靡!如果还有任何疑问,欢迎随时联系我们客服团队。感谢您的接听,期待再次为您服务,再见!”",'."\n"
.' "constraint": "你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\n明确活动的起止时间,确保玩家不会混淆。\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。\\n鼓励玩家间的互动和反馈,以促进游戏社区的活跃度。\\n结束通话时保持礼貌,给玩家留下良好印象。\\n用户询问的问题与目标或流程无关时, 请礼貌拒绝,并引导到目标问题上。\\n对于不知道的问题,请不要胡乱回复,需要礼貌回复“不清楚”,并引导到目标问题上。",'."\n"
.' "openingPrompt": "尊敬的冒险者,您好!我是安妮,来自游戏客服团队。今天有幸与您连线,是想分享一项即将启动的独家福利活动,绝对会让您的探险之旅更加精彩纷呈!",'."\n"
.' "output": "",'."\n"
.' "aiHangupOutput": "",'."\n"
.' "aiSilenceTimeoutOutput": ""'."\n"
.'}',
],
],
[
'name' => 'Prompt',
'in' => 'formData',
'schema' => [
'title' => 'prompt',
'description' => '提示词(专业模式)',
'type' => 'string',
'required' => false,
'example' => '\\n名称:安妮 \\n身份:游戏推广员\\n背景:通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。\\n技能:作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。\\n约束条件:你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\n明确活动的起止时间,确保玩家不会混淆。\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。',
],
],
[
'name' => 'Model',
'in' => 'formData',
'schema' => [
'title' => '模型id',
'description' => '模型ID',
'type' => 'string',
'required' => false,
'example' => 'model_001',
],
],
[
'name' => 'ModelConfig',
'in' => 'formData',
'schema' => [
'title' => 'model config',
'description' => '模型配置',
'type' => 'string',
'required' => false,
'example' => '{}',
],
],
[
'name' => 'VariablesJson',
'in' => 'formData',
'schema' => [
'title' => 'variables',
'description' => '变量配置',
'type' => 'string',
'required' => false,
'example' => '[{'."\n"
.' "name": "开始时间",'."\n"
.' "description": "开始时间"'."\n"
.'}, {'."\n"
.' "name": "结束时间",'."\n"
.' "description": "结束时间"'."\n"
.'}]',
],
],
[
'name' => 'LabelsJson',
'in' => 'formData',
'schema' => [
'title' => 'labels',
'description' => '标签描述',
'type' => 'string',
'required' => false,
'example' => '[{'."\n"
.' "name": "是否满意",'."\n"
.' "description": "对介绍的游戏内容是否感兴趣",'."\n"
.' "valueList": "[\\"有兴趣\\",\\"没兴趣\\"]"'."\n"
.'}]',
],
],
[
'name' => 'Scenario',
'in' => 'formData',
'schema' => [
'title' => '场景',
'description' => '场景',
'type' => 'string',
'required' => false,
'example' => '测试场景',
],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => [
'title' => '描述',
'description' => '描述',
'type' => 'string',
'required' => false,
'example' => '第一版本提交审核',
],
],
[
'name' => 'InstructionJson',
'in' => 'formData',
'schema' => [
'description' => '指令配置',
'type' => 'string',
'required' => false,
'example' => '[{'."\n"
.' "type": "TransferToAgent",'."\n"
.' "instructions": [{'."\n"
.' "code": "Transfer0",'."\n"
.' "skillGroupId": "testcode",'."\n"
.' "skillGroupName": "skillgroup"'."\n"
.' }],'."\n"
.' "timeoutEnable": false'."\n"
.'}, {'."\n"
.' "type": "CollectNumber",'."\n"
.' "instructions": [{'."\n"
.' "code": "DTMF0",'."\n"
.' "name": "收号测试",'."\n"
.' "collectVoice": true,'."\n"
.' "terminator": "#"'."\n"
.' }]'."\n"
.'}]',
],
],
[
'name' => 'ApiPluginJson',
'in' => 'formData',
'schema' => [
'description' => 'API插件配置'."\n"
."\n"
.'> 若需要绑定多个api,通过ListApiPlugins拿到多个api的uuid,以[{"uuid":"xxx"},{"uuid":"xxxx""},....]样式填入',
'type' => 'string',
'required' => false,
'example' => '[{"uuid":"a55d171da96c41a************"},{"uuid":"d41a3e5195d1402********"}]',
],
],
[
'name' => 'FaqCategoryIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'FAQ目录ID',
'type' => 'array',
'items' => [
'description' => 'FAQ目录ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '30000474726',
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'CreateTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '1721356124220',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '1715416630.0',
],
'AgentProfileId' => [
'title' => 'agent profile id',
'description' => '智能体配置ID',
'type' => 'string',
'example' => '3d7d253cfb77476da0cf3681bcf7b4e8',
],
'InstanceId' => [
'title' => '实例id',
'description' => '实例ID',
'type' => 'string',
'example' => '788066f2-f160-458e-a3bb-83e1c9d5606d',
],
'ScriptId' => [
'title' => 'script id',
'description' => '场景ID',
'type' => 'string',
'example' => '3eacaec0-64ba-4008-9392-1d419b0d2673',
],
'AgentType' => [
'title' => 'agent type',
'description' => 'Agent Type',
'type' => 'string',
'example' => 'Human',
],
'PromptJson' => [
'title' => 'prompt json',
'description' => '智能体配置',
'type' => 'string',
'example' => '{'."\n"
.' "name": "安妮",'."\n"
.' "gender": "女",'."\n"
.' "age": 20,'."\n"
.' "role": "游戏推广员",'."\n"
.' "communicationStyle": ["亲切", "口语化", "活泼"],'."\n"
.' "goals": "通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。",'."\n"
.' "background": "福利介绍\\n从${开始时间}开始,直至${结束时间}结束,为期一周的时间里,我们精心准备了\'限时寻宝\'福利活动。只要您在这段时间内每日登录游戏,即可领取登录礼包,内含珍稀材料、能量药剂和限定外观奖励\\n\\n福利亮点\\n本次活动的亮点在于,累积登录达到5天的玩家,将额外获得一份\'神秘宝箱\',开启宝箱获得稀有宠物,将为您的战斗增添强大助力!千万别错过这次增强实力的绝佳机会。\\n\\n参与方式\\n登录游戏后,在活动面板中找到\'限时寻宝\',点击即可领取对应的奖励。记得每天上线,奖励不等人哦!",'."\n"
.' "skills": "作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。",'."\n"
.' "workflow": "1.亲切问候与自我介绍\\n- 开场白:“尊敬的冒险者,您好!我是安妮,来自游戏客服团队。今天有幸与您连线,是想分享一项即将启动的独家福利活动,绝对会让您的探险之旅更加精彩纷呈!”\\n- 确认玩家想了解活动后,再进行福利活动的介绍\\n2.福利活动介绍\\n3.强调福利亮点\\n4.说明参与方式与提醒\\n5.鼓励分享与反馈\\n- 互动号召:“如果您觉得这个活动不错,不妨和您的公会伙伴或者游戏朋友分享这个好消息。同时,我们也非常欢迎您在活动结束后,通过游戏内置的反馈系统告诉我们您的体验感受和建议。”\\n技能6: 礼貌结束通话\\n- 结束语:“好了,尊敬的冒险者,以上就是这次活动的主要内容。希望您能在活动中满载而归,祝您在旅程中所向披靡!如果还有任何疑问,欢迎随时联系我们客服团队。感谢您的接听,期待再次为您服务,再见!”",'."\n"
.' "constraint": "你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\n明确活动的起止时间,确保玩家不会混淆。\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。\\n鼓励玩家间的互动和反馈,以促进游戏社区的活跃度。\\n结束通话时保持礼貌,给玩家留下良好印象。\\n用户询问的问题与目标或流程无关时, 请礼貌拒绝,并引导到目标问题上。\\n对于不知道的问题,请不要胡乱回复,需要礼貌回复“不清楚”,并引导到目标问题上。",'."\n"
.' "openingPrompt": "尊敬的冒险者,您好!我是安妮,来自游戏客服团队。今天有幸与您连线,是想分享一项即将启动的独家福利活动,绝对会让您的探险之旅更加精彩纷呈!",'."\n"
.' "output": "",'."\n"
.' "aiHangupOutput": "",'."\n"
.' "aiSilenceTimeoutOutput": ""'."\n"
.'}',
],
'Prompt' => [
'title' => 'prompt',
'description' => '提示词(专业模式)',
'type' => 'string',
'example' => '\\n名称:安妮 \\n身份:游戏推广员\\n背景:通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。\\n技能:作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。\\n约束条件:你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\n明确活动的起止时间,确保玩家不会混淆。\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。'."\n",
],
'AgentProfileTemplateId' => [
'title' => 'agent template id',
'description' => 'Agent Template ID',
'type' => 'string',
'example' => 'default-survey',
],
'Model' => [
'title' => '模型id',
'description' => '模型ID',
'type' => 'string',
'example' => 'model_002',
],
'ModelConfig' => [
'title' => 'model config',
'description' => '模型配置',
'type' => 'string',
'example' => '""',
],
'System' => [
'title' => '是否是系统模版',
'description' => '是否是系统模版',
'type' => 'boolean',
'example' => 'true',
],
'LabelsJson' => [
'title' => 'labels',
'description' => '标签描述',
'type' => 'string',
'example' => '[{'."\n"
.' "name": "是否满意",'."\n"
.' "description": "对介绍的游戏内容是否感兴趣",'."\n"
.' "valueList": "[\\"有兴趣\\",\\"没兴趣\\"]"'."\n"
.'}]',
],
'VariablesJson' => [
'title' => 'variables',
'description' => '变量配置',
'type' => 'string',
'example' => '[{'."\n"
.' "name": "开始时间",'."\n"
.' "description": "开始时间"'."\n"
.'}, {'."\n"
.' "name": "结束时间",'."\n"
.' "description": "结束时间"'."\n"
.'}]',
],
'Scenario' => [
'title' => '场景',
'description' => '场景',
'type' => 'string',
'example' => 'default',
],
'Description' => [
'title' => '描述',
'description' => '描述',
'type' => 'string',
'example' => '这是一个大模型场景',
],
'InstructionJson' => [
'description' => '指令配置',
'type' => 'string',
'example' => '[{'."\n"
.' "type": "TransferToAgent",'."\n"
.' "instructions": [{'."\n"
.' "code": "Transfer0",'."\n"
.' "skillGroupId": "testcode",'."\n"
.' "skillGroupName": "skillgroup"'."\n"
.' }],'."\n"
.' "timeoutEnable": false'."\n"
.'}, {'."\n"
.' "type": "CollectNumber",'."\n"
.' "instructions": [{'."\n"
.' "code": "DTMF0",'."\n"
.' "name": "收号测试",'."\n"
.' "collectVoice": true,'."\n"
.' "terminator": "#"'."\n"
.' }]'."\n"
.'}]',
],
'ApiPluginJson' => [
'description' => 'API插件配置',
'type' => 'string',
'example' => '[]',
],
'NluConfigJson' => [
'description' => 'NLU配置,参数配置:'."\n"
."\n"
.'- chatbotInstanceId 小蜜大模型机器人实例id'."\n"
.'- faqCategoryIds 绑定的faq类目id'."\n"
.'- llmAgentId 小蜜大模型业务空间id'."\n"
.'- llmAgentKey 小蜜大模型业务空间key'."\n"
.'- llmAgentInstanceId 小蜜大模型业务空间实例id',
'type' => 'string',
'example' => '{'."\n"
.' "chatbotInstanceId": "chatbot-cn-j7eiVJZRmb",'."\n"
.' "faqCategoryIds": [30000474726],'."\n"
.' "llmAgentId": "1246206",'."\n"
.' "llmAgentInstanceId": "outbound_05efb75a-95df-438e-9b9b-8f2c857d5498",'."\n"
.' "llmAgentKey": "d682716514814815ae77757c0bcbda01_p_outbound_public"'."\n"
.'}',
],
],
],
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExists.InstanceId',
'errorMessage' => 'The specified instance %s does not exist.',
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"CreateTime\\": \\"1721356124220\\",\\n \\"UpdateTime\\": \\"1715416630.0\\",\\n \\"AgentProfileId\\": \\"3d7d253cfb77476da0cf3681bcf7b4e8\\",\\n \\"InstanceId\\": \\"788066f2-f160-458e-a3bb-83e1c9d5606d\\",\\n \\"ScriptId\\": \\"3eacaec0-64ba-4008-9392-1d419b0d2673\\",\\n \\"AgentType\\": \\"Human\\",\\n \\"PromptJson\\": \\"{\\\\n\\\\t\\\\\\"name\\\\\\": \\\\\\"安妮\\\\\\",\\\\n\\\\t\\\\\\"gender\\\\\\": \\\\\\"女\\\\\\",\\\\n\\\\t\\\\\\"age\\\\\\": 20,\\\\n\\\\t\\\\\\"role\\\\\\": \\\\\\"游戏推广员\\\\\\",\\\\n\\\\t\\\\\\"communicationStyle\\\\\\": [\\\\\\"亲切\\\\\\", \\\\\\"口语化\\\\\\", \\\\\\"活泼\\\\\\"],\\\\n\\\\t\\\\\\"goals\\\\\\": \\\\\\"通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。\\\\\\",\\\\n\\\\t\\\\\\"background\\\\\\": \\\\\\"福利介绍\\\\\\\\n从${开始时间}开始,直至${结束时间}结束,为期一周的时间里,我们精心准备了\'限时寻宝\'福利活动。只要您在这段时间内每日登录游戏,即可领取登录礼包,内含珍稀材料、能量药剂和限定外观奖励\\\\\\\\n\\\\\\\\n福利亮点\\\\\\\\n本次活动的亮点在于,累积登录达到5天的玩家,将额外获得一份\'神秘宝箱\',开启宝箱获得稀有宠物,将为您的战斗增添强大助力!千万别错过这次增强实力的绝佳机会。\\\\\\\\n\\\\\\\\n参与方式\\\\\\\\n登录游戏后,在活动面板中找到\'限时寻宝\',点击即可领取对应的奖励。记得每天上线,奖励不等人哦!\\\\\\",\\\\n\\\\t\\\\\\"skills\\\\\\": \\\\\\"作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。\\\\\\",\\\\n\\\\t\\\\\\"workflow\\\\\\": \\\\\\"1.亲切问候与自我介绍\\\\\\\\n- 开场白:“尊敬的冒险者,您好!我是安妮,来自游戏客服团队。今天有幸与您连线,是想分享一项即将启动的独家福利活动,绝对会让您的探险之旅更加精彩纷呈!”\\\\\\\\n- 确认玩家想了解活动后,再进行福利活动的介绍\\\\\\\\n2.福利活动介绍\\\\\\\\n3.强调福利亮点\\\\\\\\n4.说明参与方式与提醒\\\\\\\\n5.鼓励分享与反馈\\\\\\\\n- 互动号召:“如果您觉得这个活动不错,不妨和您的公会伙伴或者游戏朋友分享这个好消息。同时,我们也非常欢迎您在活动结束后,通过游戏内置的反馈系统告诉我们您的体验感受和建议。”\\\\\\\\n技能6: 礼貌结束通话\\\\\\\\n- 结束语:“好了,尊敬的冒险者,以上就是这次活动的主要内容。希望您能在活动中满载而归,祝您在旅程中所向披靡!如果还有任何疑问,欢迎随时联系我们客服团队。感谢您的接听,期待再次为您服务,再见!”\\\\\\",\\\\n\\\\t\\\\\\"constraint\\\\\\": \\\\\\"你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\\\\\\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\\\\\\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\\\\\\\n明确活动的起止时间,确保玩家不会混淆。\\\\\\\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。\\\\\\\\n鼓励玩家间的互动和反馈,以促进游戏社区的活跃度。\\\\\\\\n结束通话时保持礼貌,给玩家留下良好印象。\\\\\\\\n用户询问的问题与目标或流程无关时, 请礼貌拒绝,并引导到目标问题上。\\\\\\\\n对于不知道的问题,请不要胡乱回复,需要礼貌回复“不清楚”,并引导到目标问题上。\\\\\\",\\\\n\\\\t\\\\\\"openingPrompt\\\\\\": \\\\\\"尊敬的冒险者,您好!我是安妮,来自游戏客服团队。今天有幸与您连线,是想分享一项即将启动的独家福利活动,绝对会让您的探险之旅更加精彩纷呈!\\\\\\",\\\\n\\\\t\\\\\\"output\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"aiHangupOutput\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"aiSilenceTimeoutOutput\\\\\\": \\\\\\"\\\\\\"\\\\n}\\",\\n \\"Prompt\\": \\"\\\\\\\\n名称:安妮 \\\\\\\\n身份:游戏推广员\\\\\\\\n背景:通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。\\\\\\\\n技能:作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。\\\\\\\\n约束条件:你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\\\\\\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\\\\\\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\\\\\\\n明确活动的起止时间,确保玩家不会混淆。\\\\\\\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。\\\\n\\",\\n \\"AgentProfileTemplateId\\": \\"default-survey\\",\\n \\"Model\\": \\"model_002\\",\\n \\"ModelConfig\\": \\"\\\\\\"\\\\\\"\\",\\n \\"System\\": true,\\n \\"LabelsJson\\": \\"[{\\\\n\\\\t\\\\\\"name\\\\\\": \\\\\\"是否满意\\\\\\",\\\\n\\\\t\\\\\\"description\\\\\\": \\\\\\"对介绍的游戏内容是否感兴趣\\\\\\",\\\\n\\\\t\\\\\\"valueList\\\\\\": \\\\\\"[\\\\\\\\\\\\\\"有兴趣\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"没兴趣\\\\\\\\\\\\\\"]\\\\\\"\\\\n}]\\",\\n \\"VariablesJson\\": \\"[{\\\\n\\\\t\\\\\\"name\\\\\\": \\\\\\"开始时间\\\\\\",\\\\n\\\\t\\\\\\"description\\\\\\": \\\\\\"开始时间\\\\\\"\\\\n}, {\\\\n\\\\t\\\\\\"name\\\\\\": \\\\\\"结束时间\\\\\\",\\\\n\\\\t\\\\\\"description\\\\\\": \\\\\\"结束时间\\\\\\"\\\\n}]\\",\\n \\"Scenario\\": \\"default\\",\\n \\"Description\\": \\"这是一个大模型场景\\",\\n \\"InstructionJson\\": \\"[{\\\\n\\\\t\\\\\\"type\\\\\\": \\\\\\"TransferToAgent\\\\\\",\\\\n\\\\t\\\\\\"instructions\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"code\\\\\\": \\\\\\"Transfer0\\\\\\",\\\\n\\\\t\\\\t\\\\\\"skillGroupId\\\\\\": \\\\\\"testcode\\\\\\",\\\\n\\\\t\\\\t\\\\\\"skillGroupName\\\\\\": \\\\\\"skillgroup\\\\\\"\\\\n\\\\t}],\\\\n\\\\t\\\\\\"timeoutEnable\\\\\\": false\\\\n}, {\\\\n\\\\t\\\\\\"type\\\\\\": \\\\\\"CollectNumber\\\\\\",\\\\n\\\\t\\\\\\"instructions\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"code\\\\\\": \\\\\\"DTMF0\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"收号测试\\\\\\",\\\\n\\\\t\\\\t\\\\\\"collectVoice\\\\\\": true,\\\\n\\\\t\\\\t\\\\\\"terminator\\\\\\": \\\\\\"#\\\\\\"\\\\n\\\\t}]\\\\n}]\\",\\n \\"ApiPluginJson\\": \\"[]\\",\\n \\"NluConfigJson\\": \\"{\\\\n\\\\t\\\\\\"chatbotInstanceId\\\\\\": \\\\\\"chatbot-cn-j7eiVJZRmb\\\\\\",\\\\n\\\\t\\\\\\"faqCategoryIds\\\\\\": [30000474726],\\\\n\\\\t\\\\\\"llmAgentId\\\\\\": \\\\\\"1246206\\\\\\",\\\\n\\\\t\\\\\\"llmAgentInstanceId\\\\\\": \\\\\\"outbound_05efb75a-95df-438e-9b9b-8f2c857d5498\\\\\\",\\\\n\\\\t\\\\\\"llmAgentKey\\\\\\": \\\\\\"d682716514814815ae77757c0bcbda01_p_outbound_public\\\\\\"\\\\n}\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '修改智能体配置',
'summary' => '修改智能体配置。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyAgentProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyAnnotationMission' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '129327',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'AnnotationMissionId',
'in' => 'query',
'schema' => [
'title' => '标注任务ID',
'description' => '标注任务ID。',
'type' => 'string',
'required' => false,
'example' => 'c88cc004-de69-4eee-aa5f-2efed533a54e',
],
],
[
'name' => 'AnnotationMissionName',
'in' => 'query',
'schema' => [
'title' => '标注状态',
'description' => '标注任务名称。',
'type' => 'string',
'required' => false,
'example' => '询问卖车-标注任务-20230506-112934',
],
],
[
'name' => 'AnnotationStatus',
'in' => 'query',
'schema' => [
'title' => '标注任务名称',
'description' => '标注任务状态',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [
1 => ' 进行中',
' 已完成',
' 已关闭',
],
'example' => '2',
],
],
[
'name' => 'Delete',
'in' => 'query',
'schema' => [
'title' => '删除任务',
'description' => '删除任务',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '表示是否调用成功。true:调用成功。 false:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'The operation is not allowed. User state (DIALING) does not meet expectations (READY).',
],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '错误信息。',
'type' => 'string',
'example' => 'The operation is not allowed. User state (DIALING) does not meet expectations (READY).',
],
],
],
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"The operation is not allowed. User state (DIALING) does not meet expectations (READY).\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The operation is not allowed. User state (DIALING) does not meet expectations (READY).\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '修改标注任务',
'summary' => '修改标注任务状态与名称。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyAnnotationMission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyBatchJobs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '作业组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c6a668d1-3145-4048-9101-cb3678bb8884',
],
],
[
'name' => 'BatchJobName',
'in' => 'query',
'schema' => [
'description' => '作业名称',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '催收作业组',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '作业组描述',
'type' => 'string',
'required' => false,
'example' => '这是催收作业组-01',
],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => [
'description' => '场景ID。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'c6a668d1-3145-4048-9101-cb3678bb8884',
],
],
[
'name' => 'StrategyJson',
'in' => 'query',
'schema' => [
'description' => '策略JSON',
'type' => 'string',
'required' => false,
'example' => '{"maxAttemptsPerDay":2,"name":"策略名字","workingTime":[{"beginTime":"09:00:00","endTime":"12:00:00"},{"beginTime":"13:00:00","endTime":"18:30:00"}],"minAttemptInterval":60}',
],
],
[
'name' => 'JobFilePath',
'in' => 'query',
'schema' => [
'description' => '作业Excel文件下载地址',
'type' => 'string',
'required' => false,
'example' => '52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx',
],
],
[
'name' => 'Submitted',
'in' => 'query',
'schema' => [
'description' => '是否提交,false 提交,true保存为草稿状态',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'false',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术ID',
'type' => 'string',
'required' => false,
'example' => '7d820242-f4f0-4d2e-ae35-b424c41cbc5b',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '主叫号码',
'type' => 'array',
'items' => [
'description' => '主叫号码。',
'type' => 'string',
'required' => false,
'example' => '["0591***212"]',
],
'required' => false,
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'JobGroup' => [
'description' => '作业组信息',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1579068424000',
],
'JobGroupId' => [
'description' => '作业组ID',
'type' => 'string',
'example' => '5a7e8b09-baf9-4cab-b540-c971f47a7146',
],
'ScenarioId' => [
'description' => '场景ID。',
'type' => 'string',
'example' => '6cea9bed-63e6-439e-ae4c-b3333efff53d',
],
'JobGroupName' => [
'description' => '作业组名字',
'type' => 'string',
'example' => '第一个催收作业组',
],
'JobFilePath' => [
'description' => '作业文件上传后的文件Key',
'type' => 'string',
'example' => '52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx',
],
'JobGroupDescription' => [
'description' => '作业组描述',
'type' => 'string',
'example' => '第一个催收作业组',
],
'CallingNumbers' => [
'description' => '主叫号码列表',
'type' => 'array',
'items' => [
'description' => '主叫号码列表',
'type' => 'string',
'example' => '["1****6"]',
],
],
'Strategy' => [
'description' => '执行策略',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '策略类型。',
'type' => 'string',
'example' => 'Repeatable',
],
'StrategyName' => [
'description' => '策略名称。',
'type' => 'string',
'example' => '催收策略',
],
'MaxAttemptsPerDay' => [
'description' => '拨打失败后最大重复拨打次数',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'FollowUpStrategy' => [
'description' => '执行周期结束后的后续处理方式',
'type' => 'string',
'example' => 'CONTINUE',
],
'EndTime' => [
'description' => '结束时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '2209702074000',
],
'Customized' => [
'description' => '策略自定义数据',
'type' => 'string',
'example' => '{}',
],
'IsTemplate' => [
'description' => '是否是模板',
'type' => 'boolean',
'example' => 'false',
],
'StartTime' => [
'description' => '开始时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1578550074000',
],
'StrategyId' => [
'description' => '策略ID。',
'type' => 'string',
'example' => 'f718798d-96be-40e4-bef6-317b54855708',
],
'RoutingStrategy' => [
'description' => '号码路由策略。',
'type' => 'string',
'example' => 'LocalFirst',
],
'MinAttemptInterval' => [
'description' => '重复拨打的间隔时间',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'StrategyDescription' => [
'description' => '策略描述',
'type' => 'string',
'example' => '催收作业执行策略',
],
'RepeatBy' => [
'description' => '重复执行方式,',
'type' => 'string',
'example' => 'Once',
],
'WorkingTime' => [
'description' => '策略执行时间段',
'type' => 'array',
'items' => [
'description' => '策略执行时间段',
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '结束时间。',
'type' => 'string',
'example' => '1581997093000',
],
'BeginTime' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '1581937093000',
],
],
],
],
'RepeatDays' => [
'description' => '重复执行的天',
'type' => 'array',
'items' => [
'description' => '重复执行的天',
'type' => 'string',
'example' => '[1,2,3,4,5]',
],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"JobGroup\\": {\\n \\"CreationTime\\": 1579068424000,\\n \\"JobGroupId\\": \\"5a7e8b09-baf9-4cab-b540-c971f47a7146\\",\\n \\"ScenarioId\\": \\"6cea9bed-63e6-439e-ae4c-b3333efff53d\\",\\n \\"JobGroupName\\": \\"第一个催收作业组\\",\\n \\"JobFilePath\\": \\"52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx\\",\\n \\"JobGroupDescription\\": \\"第一个催收作业组\\",\\n \\"CallingNumbers\\": [\\n \\"[\\\\\\"1****6\\\\\\"]\\"\\n ],\\n \\"Strategy\\": {\\n \\"Type\\": \\"Repeatable\\",\\n \\"StrategyName\\": \\"催收策略\\",\\n \\"MaxAttemptsPerDay\\": 3,\\n \\"FollowUpStrategy\\": \\"CONTINUE\\",\\n \\"EndTime\\": 2209702074000,\\n \\"Customized\\": \\"{}\\",\\n \\"IsTemplate\\": false,\\n \\"StartTime\\": 1578550074000,\\n \\"StrategyId\\": \\"f718798d-96be-40e4-bef6-317b54855708\\",\\n \\"RoutingStrategy\\": \\"LocalFirst\\",\\n \\"MinAttemptInterval\\": 10,\\n \\"StrategyDescription\\": \\"催收作业执行策略\\",\\n \\"RepeatBy\\": \\"Once\\",\\n \\"WorkingTime\\": [\\n {\\n \\"EndTime\\": \\"1581997093000\\",\\n \\"BeginTime\\": \\"1581937093000\\"\\n }\\n ],\\n \\"RepeatDays\\": [\\n \\"[1,2,3,4,5]\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
'title' => '修改作业组(包括作业)-已废弃',
'summary' => '修改作业做(包括作业),已废弃。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyBatchJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyBeebotIntent' => [
'summary' => '修改小模型场景的意图。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '224566',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'IntentId',
'in' => 'query',
'schema' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10717802',
],
],
[
'name' => 'IntentDefinition',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '意图定义',
'type' => 'object',
'properties' => [
'IntentName' => [
'description' => '意图名称',
'type' => 'string',
'required' => true,
'example' => '知道了么',
],
'AliasName' => [
'description' => '意图别名',
'type' => 'string',
'required' => false,
'example' => '嗯明白了',
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息',
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP返回码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '8785D26A-7406-50A1-9653-1313C292E23B',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'BeebotRequestId' => [
'description' => '内部请求ID',
'type' => 'string',
'example' => 'A1F21BF2-CB21-1968-8039-C74699E7DDEB',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'IntentId' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'example' => '10717802',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"8785D26A-7406-50A1-9653-1313C292E23B\\",\\n \\"Success\\": true,\\n \\"BeebotRequestId\\": \\"A1F21BF2-CB21-1968-8039-C74699E7DDEB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"IntentId\\": 10717802\\n}","type":"json"}]',
'title' => '【小模型接口】修改小蜜机器人意图',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyBeebotIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyBeebotIntentLgf' => [
'summary' => '修改小模型场景意图问法模版。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '224617',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'LgfId',
'in' => 'query',
'schema' => [
'description' => '问法模版ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '5666117',
],
],
[
'name' => 'LgfDefinition',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '问法模版定义信息',
'type' => 'object',
'properties' => [
'IntentId' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10717802',
],
'RuleText' => [
'description' => '意图配置',
'type' => 'string',
'required' => true,
'example' => '我是一个问法模版'."\n",
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '302C67BD-19FF-5B66-A45D-F95544604155',
],
'LgfId' => [
'description' => '问法模版ID',
'type' => 'integer',
'format' => 'int64',
'example' => '5666117',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'BeebotRequestId' => [
'description' => '内部请求ID',
'type' => 'string',
'example' => 'A1F21BF2-CB21-1968-8039-C74699E7DDEB',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"302C67BD-19FF-5B66-A45D-F95544604155\\",\\n \\"LgfId\\": 5666117,\\n \\"Success\\": true,\\n \\"BeebotRequestId\\": \\"A1F21BF2-CB21-1968-8039-C74699E7DDEB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '【小模型接口】修改小蜜机器人意图问法模版',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyBeebotIntentLgf',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyBeebotIntentUserSay' => [
'summary' => '修改小模型场景意图用户问法。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '224608',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n",
],
],
[
'name' => 'UserSayId',
'in' => 'query',
'schema' => [
'description' => '用户问法ID',
'type' => 'string',
'required' => true,
'example' => '17448458',
],
],
[
'name' => 'UserSayDefinition',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '用户问法定义',
'type' => 'object',
'properties' => [
'IntentId' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '10717802',
],
'Content' => [
'description' => '用户问法内容',
'type' => 'string',
'required' => true,
'example' => '你知道xxxxx么?'."\n",
],
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回内容',
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'Success',
],
'UserSayId' => [
'description' => '用户问法ID',
'type' => 'integer',
'format' => 'int64',
'example' => '17448458',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'BeebotRequestId' => [
'description' => '内部请求ID',
'type' => 'string',
'example' => 'A1F21BF2-CB21-1968-8039-C74699E7DDEB',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"Success\\",\\n \\"UserSayId\\": 17448458,\\n \\"Success\\": true,\\n \\"BeebotRequestId\\": \\"A1F21BF2-CB21-1968-8039-C74699E7DDEB\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '【小模型接口】修改小蜜机器人意图用户问法',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyBeebotIntentUserSay',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyDialogueFlow' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94145',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'da37319b-6c83-4268-9f19-814aed62e401',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'b0f35dd1-0337-402e-9c4f-3a6c2426950a',
],
],
[
'name' => 'DialogueFlowId',
'in' => 'query',
'schema' => [
'description' => '对话流id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
],
[
'name' => 'DialogueFlowDefinition',
'in' => 'query',
'schema' => [
'description' => '对话流程数据',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{"transitions":[{"id":"a91c4023","index":1,"source":"cc31e02b","sourceAnchor":0,"target":"946045be","targetAnchor":0}],"nodes":[{"collectedNumberEnabled":false,"content":{"branches":[{"branchId":"f5450420-09ab-11ea-b107-e9059c6a79d8","branchName":"发起对话"}]},"coordinates":{"x":180,"y":134},"id":"cc31e02b","index":0,"interruptible":false,"nodeIndex":0,"shape":"start-html","size":"170*34","type":"start","x":180,"y":134},{"collectedNumberEnabled":false,"content":{"actionParams":"","action":"Hangup"},"coordinates":{"x":487.65625,"y":155},"id":"946045be","index":2,"interruptible":false,"labels":[],"name":"功能节点","nodeIndex":1,"questions":["好的同学,您的情况已了解了,稍后我们会安排资深顾问老师给您做更详细的留学评估以及升学指导,请留意电话接听"],"script":"好的同学,您的情况已了解了,稍后我们会安排资深顾问老师给您做更详细的留学评估以及升学指导,请留意电话接听","shape":"function-html","size":"170*34","type":"transfer","x":500,"y":182}]}',
],
],
[
'name' => 'IsDrafted',
'in' => 'query',
'schema' => [
'description' => '是否草稿态',
'type' => 'boolean',
'required' => false,
'docRequired' => true,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'DialogueFlowDefinition' => [
'description' => '对话流程数据',
'type' => 'string',
'example' => '{"transitions":[{"id":"a91c4023","index":1,"source":"cc31e02b","sourceAnchor":0,"target":"946045be","targetAnchor":0}],"nodes":[{"collectedNumberEnabled":false,"content":{"branches":[{"branchId":"f5450420-09ab-11ea-b107-e9059c6a79d8","branchName":"发起对话"}]},"coordinates":{"x":180,"y":134},"id":"cc31e02b","index":0,"interruptible":false,"nodeIndex":0,"shape":"start-html","size":"170*34","type":"start","x":180,"y":134},{"collectedNumberEnabled":false,"content":{"actionParams":"","action":"Hangup"},"coordinates":{"x":487.65625,"y":155},"id":"946045be","index":2,"interruptible":false,"labels":[],"name":"功能节点","nodeIndex":1,"questions":["好的同学,您的情况已了解了,稍后我们会安排资深顾问老师给您做更详细的留学评估以及升学指导,请留意电话接听"],"script":"好的同学,您的情况已了解了,稍后我们会安排资深顾问老师给您做更详细的留学评估以及升学指导,请留意电话接听","shape":"function-html","size":"170*34","type":"transfer","x":500,"y":182}]}',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'DialogueFlowId' => [
'description' => '对话流id',
'type' => 'string',
'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Succcess',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidDialogueFlowName.Duplicated',
'errorMessage' => 'The specified DialogueFlowName already exists.',
'description' => '对话流名称已经存在。请您更换一个名字。',
],
],
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"DialogueFlowDefinition\\": \\"{\\\\\\"transitions\\\\\\":[{\\\\\\"id\\\\\\":\\\\\\"a91c4023\\\\\\",\\\\\\"index\\\\\\":1,\\\\\\"source\\\\\\":\\\\\\"cc31e02b\\\\\\",\\\\\\"sourceAnchor\\\\\\":0,\\\\\\"target\\\\\\":\\\\\\"946045be\\\\\\",\\\\\\"targetAnchor\\\\\\":0}],\\\\\\"nodes\\\\\\":[{\\\\\\"collectedNumberEnabled\\\\\\":false,\\\\\\"content\\\\\\":{\\\\\\"branches\\\\\\":[{\\\\\\"branchId\\\\\\":\\\\\\"f5450420-09ab-11ea-b107-e9059c6a79d8\\\\\\",\\\\\\"branchName\\\\\\":\\\\\\"发起对话\\\\\\"}]},\\\\\\"coordinates\\\\\\":{\\\\\\"x\\\\\\":180,\\\\\\"y\\\\\\":134},\\\\\\"id\\\\\\":\\\\\\"cc31e02b\\\\\\",\\\\\\"index\\\\\\":0,\\\\\\"interruptible\\\\\\":false,\\\\\\"nodeIndex\\\\\\":0,\\\\\\"shape\\\\\\":\\\\\\"start-html\\\\\\",\\\\\\"size\\\\\\":\\\\\\"170*34\\\\\\",\\\\\\"type\\\\\\":\\\\\\"start\\\\\\",\\\\\\"x\\\\\\":180,\\\\\\"y\\\\\\":134},{\\\\\\"collectedNumberEnabled\\\\\\":false,\\\\\\"content\\\\\\":{\\\\\\"actionParams\\\\\\":\\\\\\"\\\\\\",\\\\\\"action\\\\\\":\\\\\\"Hangup\\\\\\"},\\\\\\"coordinates\\\\\\":{\\\\\\"x\\\\\\":487.65625,\\\\\\"y\\\\\\":155},\\\\\\"id\\\\\\":\\\\\\"946045be\\\\\\",\\\\\\"index\\\\\\":2,\\\\\\"interruptible\\\\\\":false,\\\\\\"labels\\\\\\":[],\\\\\\"name\\\\\\":\\\\\\"功能节点\\\\\\",\\\\\\"nodeIndex\\\\\\":1,\\\\\\"questions\\\\\\":[\\\\\\"好的同学,您的情况已了解了,稍后我们会安排资深顾问老师给您做更详细的留学评估以及升学指导,请留意电话接听\\\\\\"],\\\\\\"script\\\\\\":\\\\\\"好的同学,您的情况已了解了,稍后我们会安排资深顾问老师给您做更详细的留学评估以及升学指导,请留意电话接听\\\\\\",\\\\\\"shape\\\\\\":\\\\\\"function-html\\\\\\",\\\\\\"size\\\\\\":\\\\\\"170*34\\\\\\",\\\\\\"type\\\\\\":\\\\\\"transfer\\\\\\",\\\\\\"x\\\\\\":500,\\\\\\"y\\\\\\":182}]}\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"DialogueFlowId\\": \\"390515b5-6115-4ccf-83e2-52d5bfaf2ddf\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Succcess\\"\\n}","type":"json"}]',
'title' => '修改对话流程-旧画布接口',
'summary' => '修改对话流程,旧画布接口。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:SaveDialogueFlow',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyEmptyNumberNoMoreCallsInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94146',
'abilityTreeNodes' => [
'FEATUREoutboundbotVYZEH6',
],
],
'parameters' => [
[
'name' => 'EntryId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '6cc9f5ca-2cb6-4cc7-a46b-2bbfd3e61b22',
],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => [
'description' => '策略级别,在业务实例中默认填2'."\n"
."\n"
.'- 0:系统'."\n"
.'- 1:租户'."\n"
.'- 2:实例',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'EmptyNumberNoMoreCalls',
'in' => 'query',
'schema' => [
'description' => '空号是否不再外呼',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '【废弃】保存全局维度空号不再外呼功能开关',
'summary' => '保存全局维度空号不再外呼功能开关。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyEmptyNumberNoMoreCallsInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyGlobalQuestion' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0fe7f71c-8771-42ef-9bb1-19aa16ae7120',
],
],
[
'name' => 'GlobalQuestionId',
'in' => 'query',
'schema' => [
'description' => '全局问题ID,此参数为源全局问题的唯一值',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ad80de88-1661-445a-92ec-bf88dc45d581',
],
],
[
'name' => 'GlobalQuestionName',
'in' => 'query',
'schema' => [
'description' => '全局问题名字',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '未识别全局问题',
],
],
[
'name' => 'GlobalQuestionType',
'in' => 'query',
'schema' => [
'description' => '全局问题类型',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'COMMON',
],
],
[
'name' => 'Questions',
'in' => 'query',
'schema' => [
'description' => '问题列表',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '["你是谁","你叫什么"]',
],
],
[
'name' => 'Answers',
'in' => 'query',
'schema' => [
'description' => '回复话术列表',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '["你好,我是你的专属客服顾问."]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'DialogueQuestionId' => [
'description' => '全局问题ID',
'type' => 'string',
'example' => 'ad80de88-1661-445a-92ec-bf88dc45d581',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidGlobalQuestionName.Duplicated',
'errorMessage' => 'The specified GlobalQuestionName already exists.',
'description' => '全局问题名称已经存在。请您更换一个名字。',
],
],
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"DialogueQuestionId\\": \\"ad80de88-1661-445a-92ec-bf88dc45d581\\"\\n}","type":"json"}]',
'title' => '【旧画布接口】修改全局问题',
'summary' => '旧画布接口中修改全局问题。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyGlobalQuestion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '业务实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'description' => '业务实例名字。',
'type' => 'string',
'required' => false,
'example' => '新实例',
],
],
[
'name' => 'InstanceDescription',
'in' => 'query',
'schema' => [
'description' => '业务实例描述。',
'type' => 'string',
'required' => false,
'example' => '这是新的实例',
],
],
[
'name' => 'MaxConcurrentConversation',
'in' => 'query',
'schema' => [
'description' => '最大并发。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '5',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '主叫号码列表。'."\n"
."\n"
.'> 默认不填',
'type' => 'array',
'items' => [
'description' => '主叫号码。'."\n"
."\n"
.'> 默认不填',
'type' => 'string',
'required' => false,
'example' => '1**********',
],
'required' => false,
'example' => '["95187"]',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息。',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Instance' => [
'description' => '业务实例信息。',
'type' => 'object',
'properties' => [
'CreationTime' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1578469042851',
],
'InstanceName' => [
'description' => '业务实例名字',
'type' => 'string',
'example' => '第一个实例',
],
'CreatorName' => [
'description' => '创建者名字。',
'type' => 'string',
'example' => 'xxx',
],
'MaxConcurrentConversation' => [
'description' => '最大并发。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'OwnerName' => [
'description' => '所有者名字。',
'type' => 'string',
'example' => 'xxx',
],
'CreatorId' => [
'description' => '创建者ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '123123',
],
'InstanceId' => [
'description' => '业务实例ID。',
'type' => 'string',
'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf',
],
'InstanceDescription' => [
'description' => '业务实例描述。',
'type' => 'string',
'example' => '这是第一个实例',
],
],
'example' => '{\'InstanceId\': \'ob369xifpi2074\', \'AutoUpgradeObVersion\': False}',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidInstanceName.Duplicated',
'errorMessage' => 'The specified InstanceName already exists.',
'description' => '实例名称已经存在。请您更换一个名字。',
],
[
'errorCode' => 'LimitExceeded.ConcurrentConversation',
'errorMessage' => 'The maximum number of concurrent conversations is exceeded.',
'description' => '并发数已经超限,请重新设置。',
],
],
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Instance\\": {\\n \\"CreationTime\\": 1578469042851,\\n \\"InstanceName\\": \\"第一个实例\\",\\n \\"CreatorName\\": \\"xxx\\",\\n \\"MaxConcurrentConversation\\": 5,\\n \\"OwnerName\\": \\"xxx\\",\\n \\"CreatorId\\": 123123,\\n \\"InstanceId\\": \\"90515b5-6115-4ccf-83e2-52d5bfaf2ddf\\",\\n \\"InstanceDescription\\": \\"这是第一个实例\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n \\n 1578469042851\\n 第一个实例\\n xxx\\n 5\\n xxx\\n 123123\\n 90515b5-6115-4ccf-83e2-52d5bfaf2ddf\\n 这是第一个实例\\n \\n","errorExample":""}]',
'title' => '修改业务实例',
'summary' => '修改智能外呼业务实例。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyIntent' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3'."\n",
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9b70486f-b1c2-429c-8a24-62798015ab1b',
],
],
[
'name' => 'IntentId',
'in' => 'query',
'schema' => [
'description' => '意图ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '3b9a2b33-50d4-4576-8c68-22498f4bf731',
],
],
[
'name' => 'IntentName',
'in' => 'query',
'schema' => [
'description' => '意图名称',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '车险如何办理',
],
],
[
'name' => 'IntentDescription',
'in' => 'query',
'schema' => [
'description' => '意图描述',
'type' => 'string',
'required' => false,
'example' => '询问车险意图',
],
],
[
'name' => 'Utterances',
'in' => 'query',
'schema' => [
'description' => '用户表述',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '["车险如何办理"]',
],
],
[
'name' => 'Keywords',
'in' => 'query',
'schema' => [
'description' => '关键字',
'type' => 'string',
'required' => false,
'example' => '[]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'IntentId' => [
'description' => '意图ID',
'type' => 'string',
'example' => '3b9a2b33-50d4-4576-8c68-22498f4bf731',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidIntentName.Duplicated',
'errorMessage' => 'The specified IntentName already exists.',
'description' => '意图名称已经存在。请您更换一个名字。',
],
],
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Intent',
'errorMessage' => 'The specified Intent does not exist.',
'description' => '指定的意图不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"IntentId\\": \\"3b9a2b33-50d4-4576-8c68-22498f4bf731\\"\\n}","type":"json"}]',
'title' => '修改意图-旧画布接口',
'summary' => '旧画布场景中修改意图,旧画布接口。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyJobGroup' => [
'summary' => '修改智能外呼任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '3edc0260-6f7c-4de4-8535-09372240618b',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '任务名字。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '修改后的作业组',
],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => [
'description' => '场景ID。(历史参数,后续使用ScriptId)'."\n"
."\n"
.'> 当前参数已为历史参数,可传任意值,建议与scriptid保持一致',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'c6a668d1-3145-4048-9101-cb3678bb8884',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '任务描述。',
'type' => 'string',
'required' => false,
'example' => '修改后的作业组',
],
],
[
'name' => 'StrategyJson',
'in' => 'query',
'schema' => [
'description' => '任务执行策略。'."\n"
."\n"
.'- repeatBy 重复类型。Once(不重复),Day(按天重复),Week(按周重复),Month(按月重复);'."\n"
.'- startTime 策略开始时间。'."\n"
.'- endTime 策略结束时间。'."\n"
.'- workingTime 可外呼时间段。'."\n"
.'- maxAttemptsPerDay 每天该任务下号码最大可尝试呼叫次数。'."\n"
.'- minAttemptInterval 号码重试呼叫时间间隔,单位分钟。'."\n"
.'- routingStrategy 号码策略,None(不指定),LocalFirst(本市号码优先), - LocalProvinceFirst(本省号码优先)。'."\n"
.'- repeatDays 对应重复类型下的执行日期。若重复类型RepeatBy为周,0表示周日,1-6分别表示周一至周六;若重复周期RepeatBy为月,1-31分别表示1至31日,没有该指定日期的月份不执行,如:若选定30日,二月份不执行。'."\n"
.'- repeatable 是否开启循环任务,true/false',
'type' => 'string',
'required' => false,
'example' => '{"maxAttemptsPerDay":"3","minAttemptInterval":"10","routingStrategy":"LocalProvinceFirst","repeatDays":["1","2","3"],"workingTime":[{"beginTime":"10:00:00","endTime":"11:00:00"},{"beginTime":"14:00:00","endTime":"15:00:00"}],"repeatable":true,"endTime":1707494400000,"startTime":1706976000000,"repeatBy":"Week"}'."\n",
],
],
[
'name' => 'RecallStrategyJson',
'in' => 'query',
'schema' => [
'description' => '重拨策略JSON',
'type' => 'string',
'required' => false,
'example' => '{"emptyNumberIgnore":false,"inArrearsIgnore":false,"outOfServiceIgnore":false}',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景话术ID。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '5a3940ce-a12f-4222-9f0f-605a9b89ea7c',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '主叫号码。',
'type' => 'array',
'items' => [
'description' => '主叫号码。',
'type' => 'string',
'required' => false,
'example' => '4008013260',
],
'required' => false,
'maxItems' => 99,
],
],
[
'name' => 'JobGroupStatus',
'in' => 'query',
'schema' => [
'description' => '任务状态,取值范围:'."\n"
.'- Draft:草稿。'."\n"
.'- Paused:暂停。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Draft',
],
],
[
'name' => 'RingingDuration',
'in' => 'query',
'schema' => [
'description' => '最优振铃时长。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '25',
],
],
[
'name' => 'MinConcurrency',
'in' => 'query',
'schema' => [
'description' => '并发保障值'."\n"
.'任务启动时,最低保障N个并发;'."\n"
.'同一优先级的任务并发保障值加和不能大于实例并发;'."\n"
.'若配置并发保障值为0,则依赖系统内空闲并发进行智能分配。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => [
'description' => '作业组优先级,取值范围'."\n"
.'- **Urgent**:紧急任务。'."\n"
.'- **Daily**:日常任务。',
'type' => 'string',
'required' => false,
'example' => 'Daily',
],
],
[
'name' => 'FlashSmsExtras',
'in' => 'query',
'schema' => [
'description' => '闪信推送的配置参数,JSON格式,包含第三方闪信的配置信息。'."\n"
."\n"
.'templateId:闪信模板ID。 '."\n"
.'configId:闪信配置ID。',
'type' => 'string',
'required' => false,
'example' => '{"templateId":"10471","configId":"8037f524-6ff2-4dbe-bb28-f59234ea7a64"}'."\n",
],
],
[
'name' => 'RecallCallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '重呼主叫号码列表',
'type' => 'array',
'items' => [
'description' => '重呼主叫号码',
'type' => 'string',
'required' => false,
'example' => '4008013260',
],
'required' => false,
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息。',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'JobGroup' => [
'description' => '任务信息。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '状态。',
'type' => 'string',
'example' => 'Scheduling',
],
'ScenarioId' => [
'description' => '场景ID。'."\n"
."\n"
.'> 该参数返回的为历史参数,具体ScrpitID可通过DescribeJobGroup接口返回',
'type' => 'string',
'example' => '6cea9bed-63e6-439e-ae4c-b3333efff53d',
],
'JobGroupId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9',
],
'CreationTime' => [
'description' => '创建时间'."\n"
."\n"
.'> 可通过DescribeJobGroup接口返回',
'type' => 'integer',
'format' => 'int64',
'example' => '1578550074361',
],
'JobGroupName' => [
'description' => '任务名字。',
'type' => 'string',
'example' => '第一个催收',
],
'JobFilePath' => [
'description' => '任务文件OSS存储路径。【已废弃】',
'type' => 'string',
'example' => 'UPLOADED/JOB/d481cebe-0bb6-4d13-9649-42ce5074fb75/6c7d9132-98e1-4f08-8a76-8a266c7532fd_job_template - 副本.xlsx',
],
'JobGroupDescription' => [
'description' => '任务描述。',
'type' => 'string',
'example' => '催收的作业组',
],
'JobDataParsingTaskId' => [
'description' => '解析外呼任务文件对应的解析任务ID。【已废弃】',
'type' => 'string',
'example' => 'e37d28cb-0413-4816-85ed-fd354d025ea3',
],
'ScriptName' => [
'description' => '话术名称。',
'type' => 'string',
'example' => '话术',
],
'ScriptVersion' => [
'description' => '话术版本。',
'type' => 'string',
'example' => '1628425608429',
],
'ModifyTime' => [
'description' => '修改时间。'."\n"
.'> 可通过DescribeJobGroup接口返回',
'type' => 'string',
'example' => '1628425608429',
],
'CallingNumbers' => [
'description' => '主叫号码列表。',
'type' => 'array',
'items' => [
'description' => '主叫号码列表。',
'type' => 'string',
'example' => '["4008013260"]',
],
],
'ExportProgress' => [
'description' => '导出信息(历史参数,不再使用)。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '状态',
'type' => 'string',
'example' => 'FINISHED',
],
'FileHttpUrl' => [
'description' => '文件地址',
'type' => 'string',
'example' => 'https://***.oss-cn-shanghai.aliyuncs.com/sample',
],
'Progress' => [
'description' => '进度',
'type' => 'string',
'example' => '1',
],
],
],
'Strategy' => [
'description' => '外呼策略。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '策略类型。',
'type' => 'string',
'example' => 'Repeatable',
],
'StrategyName' => [
'description' => '策略名称。',
'type' => 'string',
'example' => '催收策略',
],
'MaxAttemptsPerDay' => [
'description' => '最大尝试次数。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'FollowUpStrategy' => [
'description' => '执行周期结束后的处理方式(历史参数,不再使用)。',
'type' => 'string',
'example' => 'CONTINUE',
],
'EndTime' => [
'description' => '结束时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '2209702074000',
],
'Customized' => [
'description' => '自定义策略数据(历史参数,不再使用)。',
'type' => 'string',
'example' => '{}',
],
'IsTemplate' => [
'description' => '是否是模板(历史参数,不再使用)。',
'type' => 'boolean',
'example' => 'false',
],
'StartTime' => [
'description' => '开始时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1578550074000',
],
'StrategyId' => [
'description' => '策略ID。',
'type' => 'string',
'example' => 'f718798d-96be-40e4-bef6-317b54855708',
],
'RoutingStrategy' => [
'description' => '号码路由策略。',
'type' => 'string',
'example' => 'LocalFirst',
],
'MinAttemptInterval' => [
'description' => '失败后重复拨打的间隔时间。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'StrategyDescription' => [
'description' => '策略描述。',
'type' => 'string',
'example' => '催收作业执行策略',
],
'RepeatBy' => [
'description' => '重复执行方式,Once 不重复,Day 每天重复,Week 每周重复,Month 每月重复。',
'type' => 'string',
'example' => 'Once',
],
'WorkingTime' => [
'description' => '允许外呼的时间段。',
'type' => 'array',
'items' => [
'description' => '工作时间段。',
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '结束时间。',
'type' => 'string',
'example' => '12:00:00',
],
'BeginTime' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '09:00:00',
],
],
],
],
'RepeatDays' => [
'description' => '重复的执行天。'."\n"
."\n"
.'若重复周期RepeatBy为周,0表示周日,1-6分别表示周一至周六'."\n"
.'若重复周期RepeatBy为月,1-31分别表示1至31日,没有该指定日期的月份不执行,如:若选定30日,二月份不执行',
'type' => 'array',
'items' => [
'description' => '重复执行的天。',
'type' => 'string',
'example' => '[1,2,3,4,5]',
],
],
],
],
'RecallStrategy' => [
'description' => '重呼策略',
'type' => 'object',
'properties' => [
'EmptyNumberIgnore' => [
'description' => '空号不再外呼。',
'type' => 'boolean',
'example' => 'false',
],
'InArrearsIgnore' => [
'description' => '欠费不再外呼。',
'type' => 'boolean',
'example' => 'false',
],
'OutOfServiceIgnore' => [
'description' => '停机不再外呼。',
'type' => 'boolean',
'example' => 'false',
],
],
],
'RingingDuration' => [
'description' => '振铃时长。',
'type' => 'integer',
'format' => 'int64',
'example' => '25',
],
'Priority' => [
'description' => '作业组优先级,取值范围'."\n"
."\n"
.'Urgent:紧急任务。'."\n"
.'Daily:日常任务。',
'type' => 'string',
'example' => 'Daily',
],
'MinConcurrency' => [
'description' => '并发保障值'."\n"
.'任务启动时,最低保障N个并发;'."\n"
.'同一优先级的任务并发保障值加和不能大于实例并发;'."\n"
.'若配置并发保障值为0,则依赖系统内空闲并发进行智能分配。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'FlashSmsExtras' => [
'description' => '闪信推送的配置参数,JSON格式,包含第三方闪信的配置信息。'."\n"
."\n"
.'templateId: 闪信模板ID。'."\n"
.'configId: 闪信配置ID。',
'type' => 'string',
'example' => '{"configId":"3157b3c8-3a3e-4ea9-894b-9c8a6", "templateId":"1234"}',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"JobGroup\\": {\\n \\"Status\\": \\"Scheduling\\",\\n \\"ScenarioId\\": \\"6cea9bed-63e6-439e-ae4c-b3333efff53d\\",\\n \\"JobGroupId\\": \\"c62e6789-28a8-41db-941e-171a01d3b3b9\\",\\n \\"CreationTime\\": 1578550074361,\\n \\"JobGroupName\\": \\"第一个催收\\",\\n \\"JobFilePath\\": \\"UPLOADED/JOB/d481cebe-0bb6-4d13-9649-42ce5074fb75/6c7d9132-98e1-4f08-8a76-8a266c7532fd_job_template - 副本.xlsx\\",\\n \\"JobGroupDescription\\": \\"催收的作业组\\",\\n \\"JobDataParsingTaskId\\": \\"e37d28cb-0413-4816-85ed-fd354d025ea3\\",\\n \\"ScriptName\\": \\"话术\\",\\n \\"ScriptVersion\\": \\"1628425608429\\",\\n \\"ModifyTime\\": \\"1628425608429\\",\\n \\"CallingNumbers\\": [\\n \\"[\\\\\\"4008013260\\\\\\"]\\"\\n ],\\n \\"ExportProgress\\": {\\n \\"Status\\": \\"FINISHED\\",\\n \\"FileHttpUrl\\": \\"https://***.oss-cn-shanghai.aliyuncs.com/sample\\",\\n \\"Progress\\": \\"1\\"\\n },\\n \\"Strategy\\": {\\n \\"Type\\": \\"Repeatable\\",\\n \\"StrategyName\\": \\"催收策略\\",\\n \\"MaxAttemptsPerDay\\": 3,\\n \\"FollowUpStrategy\\": \\"CONTINUE\\",\\n \\"EndTime\\": 2209702074000,\\n \\"Customized\\": \\"{}\\",\\n \\"IsTemplate\\": false,\\n \\"StartTime\\": 1578550074000,\\n \\"StrategyId\\": \\"f718798d-96be-40e4-bef6-317b54855708\\",\\n \\"RoutingStrategy\\": \\"LocalFirst\\",\\n \\"MinAttemptInterval\\": 10,\\n \\"StrategyDescription\\": \\"催收作业执行策略\\",\\n \\"RepeatBy\\": \\"Once\\",\\n \\"WorkingTime\\": [\\n {\\n \\"EndTime\\": \\"12:00:00\\",\\n \\"BeginTime\\": \\"09:00:00\\"\\n }\\n ],\\n \\"RepeatDays\\": [\\n \\"[1,2,3,4,5]\\"\\n ]\\n },\\n \\"RecallStrategy\\": {\\n \\"EmptyNumberIgnore\\": false,\\n \\"InArrearsIgnore\\": false,\\n \\"OutOfServiceIgnore\\": false\\n },\\n \\"RingingDuration\\": 25,\\n \\"Priority\\": \\"Daily\\",\\n \\"MinConcurrency\\": 1,\\n \\"FlashSmsExtras\\": \\"{\\\\\\"configId\\\\\\":\\\\\\"3157b3c8-3a3e-4ea9-894b-9c8a6\\\\\\", \\\\\\"templateId\\\\\\":\\\\\\"1234\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n \\n Scheduling\\n 6cea9bed-63e6-439e-ae4c-b3333efff53d\\n c62e6789-28a8-41db-941e-171a01d3b3b9\\n 1578550074361\\n 第一个催收\\n UPLOADED/JOB/d481cebe-0bb6-4d13-9649-42ce5074fb75/6c7d9132-98e1-4f08-8a76-8a266c7532fd_job_template - 副本.xlsx\\n 催收的作业组\\n e37d28cb-0413-4816-85ed-fd354d025ea3\\n 话术\\n 1628425608429\\n 1628425608429\\n [\\"4008013260\\"]\\n \\n FINISHED\\n https://***.oss-cn-shanghai.aliyuncs.com/sample\\n \\n \\n \\n Repeatable\\n 催收策略\\n 3\\n CONTINUE\\n 2209702074000\\n {}\\n false\\n 1578550074000\\n f718798d-96be-40e4-bef6-317b54855708\\n LocalFirst\\n 10\\n 催收作业执行策略\\n Once\\n \\n 12:00:00\\n 09:00:00\\n \\n [1,2,3,4,5]\\n \\n \\n false\\n false\\n false\\n \\n 25\\n Daily\\n 1\\n {\\"configId\\":\\"3157b3c8-3a3e-4ea9-894b-9c8a6\\", \\"templateId\\":\\"1234\\"}\\n \\n","errorExample":""}]',
'title' => '修改任务数据',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2024-06-24T02:14:42.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2024-01-04T12:35:21.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2021-12-22T12:30:34.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2021-12-22T12:30:34.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyJobGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyOutboundCallNumber' => [
'summary' => '修改外呼号码,已废弃。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94151',
'abilityTreeNodes' => [
'FEATUREoutboundbot85J9KC',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3',
],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => [
'description' => '修改的号码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '10088xxx',
],
],
[
'name' => 'RateLimitPeriod',
'in' => 'query',
'schema' => [
'description' => '限流时间范围,单位为秒',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '100',
],
],
[
'name' => 'RateLimitCount',
'in' => 'query',
'schema' => [
'description' => '限流规则个数',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
[
'name' => 'OutboundCallNumberId',
'in' => 'query',
'schema' => [
'description' => '号码ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'fa0e21e9-caab-4629-9121-1e341243d599',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP 状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'OutboundCallNumber' => [
'description' => '号码信息',
'type' => 'object',
'properties' => [
'Number' => [
'description' => '外呼号码',
'type' => 'string',
'example' => '10088xxxx',
],
'OutboundCallNumberId' => [
'description' => '号码ID',
'type' => 'string',
'example' => 'fa0e21e9-caab-4629-9121-1e341243d599',
],
'RateLimitCount' => [
'description' => '限流周期',
'type' => 'string',
'example' => '10',
],
'RateLimitPeriod' => [
'description' => '限流次数',
'type' => 'string',
'example' => '100',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"OutboundCallNumber\\": {\\n \\"Number\\": \\"10088xxxx\\",\\n \\"OutboundCallNumberId\\": \\"fa0e21e9-caab-4629-9121-1e341243d599\\",\\n \\"RateLimitCount\\": \\"10\\",\\n \\"RateLimitPeriod\\": \\"100\\"\\n }\\n}","type":"json"}]',
'title' => '修改外呼号码-已废弃',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyCabOutboundCallNumber',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyScript' => [
'summary' => '修改话术信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbot7QCBLQ',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c6320d3c-fa45-4011-b3b1-acdfabe3a8c6',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c153d0d8-ba04-41c0-8632-453944c9dd0b',
],
],
[
'name' => 'ScriptName',
'in' => 'query',
'schema' => [
'description' => '话术名字',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '续费提醒',
],
],
[
'name' => 'ScriptDescription',
'in' => 'query',
'schema' => [
'description' => '话术描述',
'type' => 'string',
'required' => false,
'example' => '返工回访话术',
],
],
[
'name' => 'Industry',
'in' => 'query',
'schema' => [
'description' => '行业',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '电商',
],
],
[
'name' => 'Scene',
'in' => 'query',
'schema' => [
'description' => '场景信息',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '回访',
],
],
[
'name' => 'ChatbotId',
'in' => 'query',
'schema' => [
'description' => '机器人ID',
'type' => 'string',
'required' => false,
'example' => 'chatbot-cn-iFZfi7eq6e',
],
],
[
'name' => 'AsrConfig',
'in' => 'query',
'schema' => [
'description' => 'ASR配置,参数定义'."\n"
."\n"
.'- **appKey**:阿里云账号appKey。'."\n"
.'- **maxEndSilence**:语音端点检测时长。'."\n"
.'- **silenceTimeout**:静默超时,单位秒,用户静默N秒后超时。'."\n"
."\n"
.'- **engine**:调用服务;【ali、xunfei】'."\n"
.'- **nlsServiceType**:调用服务类型 '."\n"
.' - Managed:公有云nls服务 '."\n"
.' - Authorized:授权的nls服务'."\n"
.' - Provided:客户通过as/sk的nls服务'."\n"
.' - Apes:私有云服务'."\n"
.'- **engineXunfei**:调用方为xunfei时,需要填入对应配置。'."\n"
.'> 当engine选择ali,nlsServiceType为Authorized时,使用的是自定义服务,服务方为ali,当engine为ali,nlsServiceType为Managed时,使用默认服务,当engine为xunfei,nlsServiceType为Authorized时,使用的服务方为xunfei,需要填入xunfei配置{"uuid":"ed2xxxxxxxxx","globalMaxEndSilence":700,"globalMaxEndSilenceEnable":true}'."\n"
."\n"
.'- **globalMaxEndSilence**:静音检测,单位为毫秒。'."\n"
."\n"
.'- **globalMaxEndSilenceEnable**:静音检测开关,默认开启。'."\n"
."\n"
.'- **speechNoiseThreshold**:噪音过滤阈值',
'type' => 'string',
'required' => false,
'example' => '{'."\n"
.' "appKey": "oQDVNlE6fZ5mg46X",'."\n"
.' "engine": "ali",'."\n"
.' "engineXunfei": "",'."\n"
.' "globalMaxEndSilence": 700,'."\n"
.' "globalMaxEndSilenceEnable": true,'."\n"
.' "maxEndSilence": "500",'."\n"
.' "nlsServiceType": "Managed",'."\n"
.' "silenceTimeout": "5000",'."\n"
.' "speechNoiseThreshold": "0"'."\n"
.'}',
],
],
[
'name' => 'TtsConfig',
'in' => 'query',
'schema' => [
'description' => 'TTS配置,参数定义'."\n"
."\n"
.'- **voice**:发音人。'."\n"
.'- **volume**:音量,取值范围:0~100。默认值:50。'."\n"
.'- **speechRate**:语速,取值范围:-500~500,默认值:0。'."\n"
.'- **pitchRate**:语调,取值范围:-500~500,默认值:0。'."\n"
."\n"
.'- **globalInterruptible**:语音打断配置。'."\n"
.'-**engine**:调用服务;【ali、volc、xunfei】,大模型场景不支持xunfei。'."\n"
.'- **nlsServiceType**:调用服务类型 '."\n"
.' - Managed:公有云nls服务 '."\n"
.' - Authorized:授权的nls服务'."\n"
.' - Provided:客户通过as/sk的nls服务'."\n"
.' - Apes:私有云服务'."\n"
.'- **engineXunfei**:服务方为xunfei时的配置。'."\n"
.'> 1.当engine选择ali,nlsServiceType为Authorized时,使用的是自定义服务;2.当服务方为ali,当engine为ali,nlsServiceType为Managed时,使用默认服务;3.当engine为xunfei(小模型场景适用),nlsServiceType为Authorized时,使用的服务方为xunfei,需要填入engineXunfei配置{"pitchRate":50,"speechRate":50,"voice":"aisjiuxu","volume":50};4.当engine为vloc,nlsServiceType为Authorized时表示适用的为doubao。',
'type' => 'string',
'required' => false,
'example' => '{'."\n"
.' "appKey": "oQDVNlE6fZ5mg46X",'."\n"
.' "engine": "ali",'."\n"
.' "engineXunfei": "",'."\n"
.' "globalInterruptible": true,'."\n"
.' "nlsServiceType": "Managed",'."\n"
.' "pitchRate": "0",'."\n"
.' "speechRate": "0",'."\n"
.' "voice": "zhiyuan",'."\n"
.' "volume": "50"'."\n"
.'}',
],
],
[
'name' => 'ScriptContent',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '通知类实例,传入话术列表。'."\n"
.'已作废。',
'type' => 'array',
'items' => [
'description' => '通知类实例,传入话术列表。'."\n"
.'已作废。',
'type' => 'string',
'required' => false,
'example' => '您好,您昨晚在李佳琦直播间下单的娜薇诗椰子水二代精华2支装还未付款,超时未支付会自动关闭订单,活动错过不再有奥。',
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'ScriptWaveform',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '通知类实例,传入话术声音列表。'."\n"
.'已作废。',
'type' => 'array',
'items' => [
'description' => '通知类实例,传入话术声音列表。'."\n"
.'已作废。',
'type' => 'string',
'required' => false,
'example' => '无',
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'NewBargeInEnable',
'in' => 'query',
'schema' => [
'description' => '优雅打断配置开关(小模型)',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'LongWaitEnable',
'in' => 'query',
'schema' => [
'description' => '智能断句配置开关(小模型)',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'MiniPlaybackEnable',
'in' => 'query',
'schema' => [
'description' => '承接语配置开关(小模型)',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'MiniPlaybackConfigListJsonString',
'in' => 'query',
'schema' => [
'description' => '语气承接配置,暂时不支持自定义,默认无需传递该参数。(已作废)',
'type' => 'string',
'required' => false,
'example' => '无',
],
],
[
'name' => 'NlsConfig',
'in' => 'query',
'schema' => [
'description' => '已作废',
'type' => 'string',
'required' => false,
'example' => '无',
],
],
[
'name' => 'EmotionEnable',
'in' => 'query',
'schema' => [
'description' => '情绪识别配置开关',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'AgentKey',
'in' => 'query',
'schema' => [
'description' => '机器人业务空间访问Key',
'type' => 'string',
'required' => false,
'example' => '9137ab9c27044921860030adf8590ec4_p_outbound_public',
],
],
[
'name' => 'AgentLlm',
'in' => 'query',
'schema' => [
'description' => '机器人业务空间是否大模型业务空间'."\n"
."\n",
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => [
'description' => '机器人业务空间ID'."\n"
."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1198938',
],
],
[
'name' => 'NluEngine',
'in' => 'query',
'schema' => [
'description' => 'Nlu引擎(仅大模型场景适用)'."\n"
."\n"
.'> 场景创建后,场景模式无法修改'."\n"
."\n"
.'枚举:'."\n"
.'- Prompts:文本填入模式。'."\n"
.'- SSE_FUNCTION :函数计算模式'."\n"
.'- 非大模型场景则为空。',
'type' => 'string',
'required' => false,
'example' => 'Prompts',
],
],
[
'name' => 'NluAccessType',
'in' => 'query',
'schema' => [
'description' => 'Nlu访问方式(仅大模型场景适用)'."\n"
."\n"
.'枚举:'."\n"
.'- Managed:使用阿里公共账号访问。'."\n"
.'- 非大模型场景则为空。',
'type' => 'string',
'required' => false,
'example' => 'Managed',
],
],
[
'name' => 'ChatConfig',
'in' => 'query',
'schema' => [
'description' => '通话配置'."\n"
.'- silenceConfig :静默配置'."\n"
.' - silenceReplyTimeout:静默回复超时时间,毫秒级'."\n"
.' - silenceTimeoutMaxCount:静默超时几轮后挂机。'."\n"
.' - silenceTimeoutMaxCountEnable:静默是否挂机'."\n"
.'- hangupConfig:挂机配置'."\n"
.' - aiHangupEnable:ai挂机。true,false'."\n"
.' - delayHangup:延迟挂机 ,最大为10'."\n"
.' - hangupMaxRounds:交互轮次:最大100'."\n"
.' - hangupMaxRoundsBroadcast:挂机播报话术'."\n"
.' - hangupMaxRoundsEnable:最多交互轮次判断 true/false'."\n"
.'- securityInterceptConfig:安全拦截配置'."\n"
.' - broadcast:拦截播报话术'."\n"
.'- specialInterceptConfig:特殊情况拦截'."\n"
.' - specialInterceptEnable:特殊情况拦截开关'."\n"
.' - specialIntercepts:特殊情况'."\n"
.' - voiceAssistant:语音助手'."\n"
.' - extensionNumberTransfer:分机号转接'."\n"
.'- transitionConfig:承接语模型配置'."\n"
.' - transitionSwitch:承接语模型开关',
'type' => 'string',
'required' => false,
'example' => '{"silenceConfig":{"silenceReplyTimeout":499,"silenceTimeoutMaxCount":10,"silenceTimeoutMaxCountEnable":true},"hangupConfig":{"aiHangupEnable":false,"delayHangup":0,"hangupMaxRounds":20,"hangupMaxRoundsBroadcast":"感谢您的接听,祝您生活愉快,再见!","hangupMaxRoundsEnable":false},"securityInterceptConfig":{"broadcast":"您说的这个问题我不能回答您,您可以尝试询问其他问题。"},"specialInterceptConfig":{"specialInterceptEnable":false,"specialIntercepts":[{"code":"voiceAssistant"},{"code":"extensionNumberTransfer"}]},"transitionConfig":{"transitionSwitch":false}}',
],
],
[
'name' => 'LabelConfig',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'description' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'Script' => [
'description' => '话术信息',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '话术状态',
'type' => 'string',
'example' => 'PUBLISHED',
],
'UpdateTime' => [
'description' => '更新时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1578881227000',
],
'Industry' => [
'description' => '行业',
'type' => 'string',
'example' => '政务',
],
'ScriptDescription' => [
'description' => '话术描述',
'type' => 'string',
'example' => '返工回访话术',
],
'IsDrafted' => [
'description' => '是否是草稿',
'type' => 'boolean',
'example' => 'true',
],
'DebugStatus' => [
'description' => '话术调试状态',
'type' => 'string',
'example' => 'DRAFTED',
],
'ScriptId' => [
'description' => '话术ID',
'type' => 'string',
'example' => 'c153d0d8-ba04-41c0-8632-453944c9dd0b',
],
'IsDebugDrafted' => [
'description' => '是否是调试的草稿',
'type' => 'boolean',
'example' => 'true',
],
'ScriptName' => [
'description' => '话术名字',
'type' => 'string',
'example' => '回访话术',
],
'Scene' => [
'description' => '场景',
'type' => 'string',
'example' => '回访',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidScriptName.Duplicated',
'errorMessage' => 'The specified ScriptName already exists.',
'description' => '话术名称已经存在。请您更换一个名字。',
],
],
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Script\\": {\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"UpdateTime\\": 1578881227000,\\n \\"Industry\\": \\"政务\\",\\n \\"ScriptDescription\\": \\"返工回访话术\\",\\n \\"IsDrafted\\": true,\\n \\"DebugStatus\\": \\"DRAFTED\\",\\n \\"ScriptId\\": \\"c153d0d8-ba04-41c0-8632-453944c9dd0b\\",\\n \\"IsDebugDrafted\\": true,\\n \\"ScriptName\\": \\"回访话术\\",\\n \\"Scene\\": \\"回访\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n OK\\n Success\\n \\n","errorExample":""}]',
'title' => '修改话术信息',
'changeSet' => [
[
'createdAt' => '2025-06-12T11:39:29.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2024-08-06T12:39:33.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2024-04-25T12:17:46.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-09-20T13:53:36.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-08-09T13:08:14.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-06-21T12:54:40.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-03-01T12:42:07.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => 'Instance',
'arn' => 'acs:outboundbot:{#regionId}:{#accountId}:instance/{#InstanceId}',
],
],
],
],
],
],
'ModifyScriptVoiceConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'bdd49242-114c-4045-b1d1-25ccc1756c75',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1d7a26e0-628b-4c3c-9918-7f2e23273f54',
],
],
[
'name' => 'ScriptVoiceConfigId',
'in' => 'query',
'schema' => [
'description' => '场景声音配置ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'e15cc646-50e5-4bc0-87ec-e4f2d1063b90',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '录音类型'."\n"
."\n"
.'- WAVEFORM:录音'."\n"
.'- TTS:文本转语音',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'TTS',
],
],
[
'name' => 'ScriptWaveformRelation',
'in' => 'query',
'schema' => [
'description' => '话术录音数据,在Type为WAVEFORM时填写'."\n"
."\n"
.'> ScriptWaveformId参数通过CreateScriptWaveform接口获取,ScriptContent为场景声音名称',
'type' => 'string',
'required' => false,
'example' => '[{"ScriptContent":"请问你是","ScriptWaveformId":"07db2f0a-acb2-4e68-b9f4-66397414f50c"},{"ScriptContent":"吗?","ScriptWaveformId":"c2a69440-03e3-406e-b0a9-a9791fccb31b"}]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'ScriptVoiceConfig' => [
'description' => '话术录音配置信息',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '播音类型',
'type' => 'string',
'example' => 'WAVEFORM',
],
'ScriptVoiceConfigId' => [
'description' => '场景声音配置ID',
'type' => 'string',
'example' => '4ddea690-6534-4c88-9cbd-0b5882ec64c0',
],
'ScriptContent' => [
'description' => '语音对应文本',
'type' => 'string',
'example' => '你好',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'bdd49242-114c-4045-b1d1-25ccc1756c75',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => '1d7a26e0-628b-4c3c-9918-7f2e23273f54',
],
'ScriptWaveformRelation' => [
'description' => '录音对应关系数据',
'type' => 'string',
'example' => '[{"ScriptContent":"你好","ScriptWaveformId":"6facc560-9f25-420f-bb0b-99f4299ad0d5"},{"ScriptContent":"吗","ScriptWaveformId":"76f48266-e253-4f44-ab4f-f64f7d38f1b4"}]',
],
'Source' => [
'description' => '话术源',
'type' => 'string',
'example' => 'DIALOGUE_FLOW',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"ScriptVoiceConfig\\": {\\n \\"Type\\": \\"WAVEFORM\\",\\n \\"ScriptVoiceConfigId\\": \\"4ddea690-6534-4c88-9cbd-0b5882ec64c0\\",\\n \\"ScriptContent\\": \\"你好\\",\\n \\"InstanceId\\": \\"bdd49242-114c-4045-b1d1-25ccc1756c75\\",\\n \\"ScriptId\\": \\"1d7a26e0-628b-4c3c-9918-7f2e23273f54\\",\\n \\"ScriptWaveformRelation\\": \\"[{\\\\\\"ScriptContent\\\\\\":\\\\\\"你好\\\\\\",\\\\\\"ScriptWaveformId\\\\\\":\\\\\\"6facc560-9f25-420f-bb0b-99f4299ad0d5\\\\\\"},{\\\\\\"ScriptContent\\\\\\":\\\\\\"吗\\\\\\",\\\\\\"ScriptWaveformId\\\\\\":\\\\\\"76f48266-e253-4f44-ab4f-f64f7d38f1b4\\\\\\"}]\\",\\n \\"Source\\": \\"DIALOGUE_FLOW\\"\\n }\\n}","type":"json"}]',
'title' => '【旧画布接口】修改场景声音配置',
'summary' => '修改旧画布场景中场景声音配置。',
'description' => '****',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyScriptVoiceConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyTTSConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '27244bae-e446-4811-bb1d-f8a07b525af0',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1f1a2ba0-b3e7-4ff9-baf1-6dc8aeac0791',
],
],
[
'name' => 'Voice',
'in' => 'query',
'schema' => [
'description' => '发音人信息,如:aixia / siyue / xiaoyun',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'aixia',
],
],
[
'name' => 'SpeechRate',
'in' => 'query',
'schema' => [
'description' => '语速'."\n"
.'[-500,500]之间整数。默认值为0。'."\n"
."\n"
.'大于0表示加快语速。'."\n"
."\n"
.'小于0表示减慢语速。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '0',
],
],
[
'name' => 'Volume',
'in' => 'query',
'schema' => [
'description' => '音量'."\n"
.'[0,100]之间整数。默认值为50。'."\n"
."\n"
.'大于50表示增大音量。'."\n"
."\n"
.'小于50表示减小音量。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '100',
],
],
[
'name' => 'NlsServiceType',
'in' => 'query',
'schema' => [
'description' => '服务类型'."\n"
.'Managed:智能外呼产品默认智能语音交互产品服务(公共服务)。'."\n"
.'Authorized:公有云客户自己购买的智能语音交互产品服务(客户私有服务),通过场景管理-编辑-调用服务-自定义服务完成授权。',
'type' => 'string',
'required' => false,
'example' => 'Managed',
],
],
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '语音服务类型 nlsServiceType = Authorized时,此字段用来保存智能语音交互产品项目的appKey。',
'type' => 'string',
'required' => false,
'example' => '99****Aw',
],
],
[
'name' => 'PitchRate',
'in' => 'query',
'schema' => [
'title' => '语调 [-500,500]之间整数。默认值为0。'."\n"
."\n"
.'大于0表示升高音高。'."\n"
."\n"
.'小于0表示降低音高。',
'description' => '语调 [-500,500]之间整数。默认值为0。'."\n"
."\n"
.'大于0表示升高音高。'."\n"
."\n"
.'小于0表示降低音高。',
'type' => 'string',
'required' => false,
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP 状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => 'f765d3ee-ec03-4765-b235-6877501d99d1',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'TTSConfig' => [
'description' => 'TTS 配置信息',
'type' => 'object',
'properties' => [
'Voice' => [
'description' => '播音模型',
'type' => 'string',
'example' => 'xiaoyun',
],
'TTSConfigId' => [
'description' => '配置ID',
'type' => 'string',
'example' => '2a07b634-e15d-445f-bbcb-fc4ea2df7b87',
],
'SpeechRate' => [
'description' => '语速',
'type' => 'string',
'example' => '50',
],
'Volume' => [
'description' => '音量',
'type' => 'string',
'example' => '100',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => '291cfc6a-8703-4bdd-a99d-9cba32d5288a',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => '947e0875-b5d4-4b33-b18c-7b2cf85bcb4f',
],
'PitchRate' => [
'title' => '语调'."\n"
.'[-500,500]之间整数。默认值为0。'."\n"
."\n"
.'大于0表示升高音高。'."\n"
."\n"
.'小于0表示降低音高。',
'description' => '语调'."\n"
.'[-500,500]之间整数。默认值为0。'."\n"
."\n"
.'大于0表示升高音高。'."\n"
."\n"
.'小于0表示降低音高。',
'type' => 'string',
'example' => '0',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter %s is invalid.',
'description' => '参数值校验不通过。请使用请求参数构造规范化的请求字符串。',
],
],
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"f765d3ee-ec03-4765-b235-6877501d99d1\\",\\n \\"Success\\": true,\\n \\"TTSConfig\\": {\\n \\"Voice\\": \\"xiaoyun\\",\\n \\"TTSConfigId\\": \\"2a07b634-e15d-445f-bbcb-fc4ea2df7b87\\",\\n \\"SpeechRate\\": \\"50\\",\\n \\"Volume\\": \\"100\\",\\n \\"InstanceId\\": \\"291cfc6a-8703-4bdd-a99d-9cba32d5288a\\",\\n \\"ScriptId\\": \\"947e0875-b5d4-4b33-b18c-7b2cf85bcb4f\\",\\n \\"PitchRate\\": \\"0\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n f765d3ee-ec03-4765-b235-6877501d99d1\\n true\\n \\n xiaoyun\\n 2a07b634-e15d-445f-bbcb-fc4ea2df7b87\\n 50\\n 100\\n 291cfc6a-8703-4bdd-a99d-9cba32d5288a\\n 947e0875-b5d4-4b33-b18c-7b2cf85bcb4f\\n 0\\n \\n","errorExample":""}]',
'title' => '修改旧画布场景的tts配置(旧画布专用,废弃)',
'summary' => '修改旧画布场景的tts配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
[
'createdAt' => '2024-07-24T07:36:03.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2023-03-07T13:33:57.000Z',
'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2022-03-01T12:42:07.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyTTSConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ModifyTagGroups' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cd560e89-0459-4c8a-ad98-47d713e4abd6',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '365b955d-6f4d-4ab5-a6e1-9a301307f4b1',
],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => [
'description' => '标签列表',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '[{"TagGroup":"多层次","ScriptId":"b4d0dcc8-892d-43234-987c9d-3568e5faa62f","TagGroupIndex":0,"Id":"56728a30-c392-453a-a287-31af8301150f"}]',
],
],
[
'name' => 'TagGroups',
'in' => 'query',
'schema' => [
'description' => '标签组信息',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '[{"TagName":"111","TagGroup":"多层次","ScriptId":"b4d0dcc8-892d-4323-8c9d-3568e5faa62f","showInput":true,"Id":"a683fa32-91c5-457e-9ddf-aa8549d14ce0"}]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '5a865b03-d2b9-4ef9-be98-f21fa0d93744',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'TagGroups' => [
'description' => '标签组列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagGroupId' => [
'description' => '标签组ID',
'type' => 'string',
'example' => '54629be9-0746-464a-ab59-4830242cf644',
],
'TagGroupIndex' => [
'description' => '标签组位置',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TagGroup' => [
'description' => '标签组名字',
'type' => 'string',
'example' => '标签组',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => '365b955d-6f4d-4ab5-a6e1-9a301307f4b1',
],
],
'description' => '',
],
],
'Tags' => [
'description' => '标签列表',
'type' => 'array',
'items' => [
'description' => '标签列表',
'type' => 'object',
'properties' => [
'TagGroup' => [
'description' => '标签组名称',
'type' => 'string',
'example' => '当前学历',
],
'TagName' => [
'description' => '标签名称',
'type' => 'string',
'example' => '本科',
],
'TagIndex' => [
'description' => '标签索引',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => '8a4c6d3d-5ed6-44ca-b779-16c20f8862be',
],
'TagId' => [
'description' => '标签唯一ID',
'type' => 'string',
'example' => '19b23e92-4ee3-4129-8c2e-e1968670d887',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"5a865b03-d2b9-4ef9-be98-f21fa0d93744\\",\\n \\"Success\\": true,\\n \\"TagGroups\\": [\\n {\\n \\"TagGroupId\\": \\"54629be9-0746-464a-ab59-4830242cf644\\",\\n \\"TagGroupIndex\\": 1,\\n \\"TagGroup\\": \\"标签组\\",\\n \\"ScriptId\\": \\"365b955d-6f4d-4ab5-a6e1-9a301307f4b1\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"TagGroup\\": \\"当前学历\\",\\n \\"TagName\\": \\"本科\\",\\n \\"TagIndex\\": 1,\\n \\"ScriptId\\": \\"8a4c6d3d-5ed6-44ca-b779-16c20f8862be\\",\\n \\"TagId\\": \\"19b23e92-4ee3-4129-8c2e-e1968670d887\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '修改标签组-旧画布接口',
'summary' => '修改标签组,旧画布接口。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyTagGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'PublishScript' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '要发布的场景id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '3677fe8b-276f-4541-babf-b9d3082a31ba',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '对这次发布场景的描述',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '本次发布了xxxx内容',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '【已废弃】发布话术',
'summary' => '发布场景。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:PublishScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'PublishScriptForDebug' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '0bfe34e5-a7fa-4aac-91d4-bd798518dffc',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '5a865b03-d2b9-4ef9-be98-f21fa0d93744',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"5a865b03-d2b9-4ef9-be98-f21fa0d93744\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"5a865b03-d2b9-4ef9-be98-f21fa0d93744\\n200\\nOK\\ntrue","errorExample":""}]',
'title' => '发布话术到调试环境',
'summary' => '发布话术(调试的版本)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:PublishScriptForDebug',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'QueryJobs' => [
'summary' => '查询作业列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94161',
'abilityTreeNodes' => [
'FEATUREoutboundbot3SV6AU',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => [
'description' => '场景ID。历史参数【已废弃】',
'type' => 'string',
'required' => false,
'example' => 'b0f35dd1-0337-402e-9c4f-3a6c2426950a',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID。',
'type' => 'string',
'required' => false,
'example' => '994b8baf-7ef8-480c-b141-b7b6db77c4df',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '过滤条件,开始时间,缺省为0, 代表从今天0时开始。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1579068424883',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '过滤条件,截止时间,缺省为0,代表截止到当前时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1579077794665',
],
],
[
'name' => 'TimeAlignment',
'in' => 'query',
'schema' => [
'description' => '时间条件按照开始时间还是结束时间查询,有效值为:start、end、job_create。',
'type' => 'string',
'required' => false,
'example' => 'start',
],
],
[
'name' => 'ContactName',
'in' => 'query',
'schema' => [
'description' => '过滤条件,联系人名字。',
'type' => 'string',
'required' => false,
'example' => '张三',
],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => [
'description' => '过滤条件,联系人电话号码。',
'type' => 'string',
'required' => false,
'example' => '135****8888',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '分页序号。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => '响应码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => 'HTTP状态码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息。',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
'Jobs' => [
'description' => '作业数据。',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '分页序号。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '数据总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'description' => '作业数组',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '作业状态。'."\n"
.'- Scheduling(0, "调度中")'."\n"
.'- Executing(1, "执行中"),'."\n"
.'- Succeeded(2, "结束-已触达"),'."\n"
.'- Paused(3, "暂停"),'."\n"
.'- Failed(4, "结束-未触达")'."\n"
.'- Cancelled(5, "已取消-人工干预")'."\n"
.'- Drafted(6, "草稿态"),',
'type' => 'string',
'example' => 'Succeeded',
],
'JobGroupId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8',
],
'ScenarioId' => [
'description' => '场景ID。历史参数,【已废弃】',
'type' => 'string',
'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150',
],
'StrategyId' => [
'description' => '策略ID。',
'type' => 'string',
'example' => 'c8a2b7f2-ad1a-4865-b872-d0080d9802d9',
],
'JobId' => [
'description' => '作业ID。',
'type' => 'string',
'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8',
],
'Priority' => [
'description' => '优先级。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'FailureReason' => [
'description' => '失败原因。'."\n"
.'- Unknown(未知错误), '."\n"
.'- NoAnswer(无人接听),'."\n"
.'- InvalidStrategy(无效的策略,策略配置不正确),'."\n"
.'- TimeUp(调度时发现超时),'."\n"
.'- NoStrategy(策略为空或没有找到),'."\n"
.'- CallFailed(呼叫失败),'."\n"
.'- PerDayCallCountLimit(号码每日呼叫次数限制),'."\n"
.'- ContactBlockList(禁止外呼名单),'."\n"
.'- EmptyNumber(空号不再外呼),'."\n"
.'- JobPerDayCallCountLimit(号码每日呼叫次数限制),'."\n"
.'- VerificationCancelled(呼叫前验证不通过取消),'."\n"
.'- ContactSuspended(止呼),'."\n"
.'- InArrears(欠费),'."\n"
.'- OutOfService(停机);',
'type' => 'string',
'example' => 'NoAnswer',
],
'ReferenceId' => [
'description' => '关联业务ID。',
'type' => 'string',
'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28',
],
'Contacts' => [
'description' => '联系人信息。该参数已废弃。'."\n"
."\n"
.'> 可以通过DescribeJob接口中获取',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PhoneNumber' => [
'description' => '电话号码。',
'type' => 'string',
'example' => '135****8888',
],
'State' => [
'description' => '状态。'."\n"
.'- Available(正常),'."\n"
.'- WrongNumber(号码错误),'."\n"
.'- DoesNotExist(空号),'."\n"
.'- Suspended(止呼);',
'type' => 'string',
'example' => 'Available',
],
'ContactId' => [
'description' => '联系人ID。',
'type' => 'string',
'example' => 'db3db762-e421-44c9-9a01-cb423470757c',
],
'Honorific' => [
'description' => '尊称。',
'type' => 'string',
'example' => '张先生',
],
'JobId' => [
'description' => '作业ID。',
'type' => 'string',
'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8'."\n",
],
'ContactName' => [
'description' => '联系人姓名。',
'type' => 'string',
'example' => '张三',
],
'Role' => [
'description' => '角色。',
'type' => 'string',
'example' => '*',
],
'ReferenceId' => [
'description' => '关联业务ID。',
'type' => 'string',
'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34',
],
],
'description' => '',
],
],
'Extras' => [
'description' => '业务数据,大模型场景的标签收集情况展示。'."\n"
."\n"
.'> key等于TenantId、ServiceId为系统参数。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '业务数据key',
'type' => 'string',
'example' => 'djrq',
],
'Value' => [
'description' => '业务数据value',
'type' => 'string',
'example' => '2019-08-21 09:49:59.0',
],
],
'description' => '',
],
],
'Summary' => [
'description' => '对话小结。(历史字段,不再使用)【废弃】',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SummaryName' => [
'description' => '小结名称。',
'type' => 'string',
'example' => 'score',
],
'GroupId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => 'ba1ba502-d044-48c0-b710-0f1f840a7c53',
],
'JobId' => [
'description' => '作业ID。',
'type' => 'string',
'example' => 'b72425bd-7871-4050-838e-033d80d754b7'."\n",
],
'Category' => [
'description' => '类别',
'type' => 'string',
'example' => '{}',
],
'TaskId' => [
'description' => '通话ID。',
'type' => 'string',
'example' => '9fdf7a81-6781-4ab8-92fb-1d4231ef365e',
],
'Content' => [
'description' => '内容',
'type' => 'string',
'example' => '5',
],
'ConversationDetailId' => [
'description' => '通话记录ID',
'type' => 'string',
'example' => '098b9b09-9223-4a8b-a422-99726f0457f3',
],
'SummaryId' => [
'description' => '摘要ID',
'type' => 'string',
'example' => 'dc67d544-df06-4625-ae48-13e3c9f72d8a',
],
],
'description' => '',
],
],
'Tasks' => [
'description' => '通话列表。该参数已废弃。'."\n"
."\n"
.'> 可通过searchTask接口中获取',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '任务状态,取值范围 (注:Succeeded状态已细分原因,不会展示Succeeded:1(已接通)状态,之后返回均为具体细分原因类型。)'."\n"
."\n"
.'- Executing:0(正在拨打)。'."\n"
.'- Succeeded:1(已接通)。'."\n"
.'- NoAnswer:2(未接通-无人接听)。'."\n"
."\n"
.'- NotExist:3(未接通-空号)。'."\n"
."\n"
.'- Busy:4(未接通-占线)。'."\n"
."\n"
.'- Cancelled:5(未呼出-任务停止)。'."\n"
."\n"
.'- Failed:6(失败)。'."\n"
."\n"
.'- NotConnected:7(未接通-无法接通)。'."\n"
."\n"
.'- PoweredOff:8(未接通-关机)。'."\n"
."\n"
.'- OutOfService:9(未接通-被叫停机)。'."\n"
."\n"
.'- InArrears:10(未接通-被叫欠费)。'."\n"
."\n"
.'- EmptyNumber:11(未呼出-空号不外呼)。'."\n"
."\n"
.'- PerDayCallCountLimit:12(未呼出-超出每日上限)。'."\n"
."\n"
.'- ContactBlockList:13(未呼出-黑名单)。'."\n"
."\n"
.'- CallerNotRegistered:14(未呼出-主叫号码未注册)。'."\n"
."\n"
.'- Terminated:15(未呼出-被终止)。'."\n"
."\n"
.'- VerificationCancelled:16(未呼出-呼叫前验证不通过取消)。'."\n"
."\n"
.'- OutOfServiceNoCall:17(未呼出-被叫停机不外呼)。'."\n"
."\n"
.'- InArrearsNoCall:18(未呼出-被叫欠费不外呼)。'."\n"
."\n"
.'- CallingNumberNotExist:19(未呼出-主叫号码不存在)。'."\n"
.'- SucceededFinish:20(已接通-正常完结)。'."\n"
."\n"
.'- SucceededChatbotHangUpAfterNoAnswer:21(已接通-拒识后机器人挂机)。'."\n"
."\n"
.'- SucceededChatbotHangUpAfterSilence:22(已接通-静默超时挂机)。'."\n"
."\n"
.'- SucceededClientHangUpAfterNoAnswer:23(已接通-拒识后用户挂机)。'."\n"
."\n"
.'- SucceededClientHangUp:24(已接通-用户无理由挂机)。'."\n"
."\n"
.'- SucceededTransferByIntent:25(已接通-命中意图转人工)。'."\n"
."\n"
.'- SucceededTransferAfterNoAnswer:26(已接通-拒识转人工)。'."\n"
."\n"
.'- SucceededInoInterAction:27(已接通-用户侧无交互)。'."\n"
."\n"
.'- SucceededError:28(已接通-系统异常中断)。'."\n"
."\n"
.'- SucceededSpecialInterceptVoiceAssistant:29(已接通-特殊情况拦截-语音助手)。'."\n"
."\n"
.'- SucceededSpecialInterceptExtensionNumberTransfer:30(已接通-特殊情况拦截-分机号转接)。'."\n"
.'- SucceededSpecialInterceptCustomSpecialIntercept:31(已接通-特殊情况拦截-自定义拦截)。'."\n"
.'- HighRiskSipCode:32(未呼出-高风险不外呼)。',
'type' => 'string',
'example' => 'Succeeded',
],
'PlanedTime' => [
'description' => '计划呼出时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1579068424883',
],
'ChatbotId' => [
'description' => '机器人ID。',
'type' => 'string',
'example' => '1234',
],
'ActualTime' => [
'description' => '实际呼出时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1579068424883',
],
'CalledNumber' => [
'description' => '被叫号码。',
'type' => 'string',
'example' => '135****8888',
],
'ScenarioId' => [
'description' => '场景ID。',
'type' => 'string',
'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150',
],
'JobId' => [
'description' => '作业ID。',
'type' => 'string',
'example' => 'b72425bd-7871-4050-838e-033d80d754b7',
],
'CallId' => [
'description' => 'SIP call ID。',
'type' => 'string',
'example' => '1528189846043',
],
'CallingNumber' => [
'description' => '主叫号码。',
'type' => 'string',
'example' => '0571****3106',
],
'Brief' => [
'description' => '总结(历史字段,不再使用)',
'type' => 'string',
'example' => '1',
],
'Duration' => [
'description' => '通话时长。',
'type' => 'integer',
'format' => 'int32',
'example' => '120',
],
'TaskId' => [
'description' => '通话ID。',
'type' => 'string',
'example' => 'ff44709e-39a6-43ba-959b-20fcabe3e496',
],
'Contact' => [
'description' => '联系人信息。',
'type' => 'object',
'properties' => [
'PhoneNumber' => [
'description' => '联系人电话号码。',
'type' => 'string',
'example' => '135****8888',
],
'State' => [
'description' => '状态。',
'type' => 'string',
'example' => 'Available',
],
'ContactId' => [
'description' => '联系人ID。',
'type' => 'string',
'example' => 'db3db762-e421-44c9-9a01-cb423470757c',
],
'Honorific' => [
'description' => '尊称。',
'type' => 'string',
'example' => '张先生',
],
'JobId' => [
'description' => '作业ID。',
'type' => 'string',
'example' => 'b72425bd-7871-4050-838e-033d80d754b7',
],
'ContactName' => [
'description' => '联系人名称。',
'type' => 'string',
'example' => '张三',
],
'Role' => [
'description' => '角色。',
'type' => 'string',
'example' => '*',
],
'ReferenceId' => [
'description' => '业务关联ID。',
'type' => 'string',
'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34',
],
],
],
],
'description' => '',
],
],
'CallingNumbers' => [
'description' => '主叫号码列表。',
'type' => 'array',
'items' => [
'description' => '主叫号码列表。',
'type' => 'string',
'example' => '["0571****3106"]',
],
],
'TagHits' => [
'description' => '小模型场景中命中标签信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagName' => [
'description' => '标签名称。',
'type' => 'string',
'example' => '有意向',
],
'TagGroup' => [
'description' => '标签组名称。',
'type' => 'string',
'example' => '意向收集',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter %s is invalid.',
'description' => '参数值校验不通过。请使用请求参数构造规范化的请求字符串。',
],
],
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.JobGroup',
'errorMessage' => 'The specified JobGroup does not exist.',
'description' => '指定的任务组不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Jobs\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"Succeeded\\",\\n \\"JobGroupId\\": \\"fce6c599-8ede-40e3-9f78-0928eda7b4e8\\",\\n \\"ScenarioId\\": \\"ade80092-03d9-4f4d-ad4f-ab8a247d3150\\",\\n \\"StrategyId\\": \\"c8a2b7f2-ad1a-4865-b872-d0080d9802d9\\",\\n \\"JobId\\": \\"fce6c599-8ede-40e3-9f78-0928eda7b4e8\\",\\n \\"Priority\\": 1,\\n \\"FailureReason\\": \\"NoAnswer\\",\\n \\"ReferenceId\\": \\"d5971d98-7312-4f0e-a918-a17d67133e28\\",\\n \\"Contacts\\": [\\n {\\n \\"PhoneNumber\\": \\"135****8888\\",\\n \\"State\\": \\"Available\\",\\n \\"ContactId\\": \\"db3db762-e421-44c9-9a01-cb423470757c\\",\\n \\"Honorific\\": \\"张先生\\",\\n \\"JobId\\": \\"fce6c599-8ede-40e3-9f78-0928eda7b4e8\\\\n\\",\\n \\"ContactName\\": \\"张三\\",\\n \\"Role\\": \\"*\\",\\n \\"ReferenceId\\": \\"2fa6bac3-06da-4315-82ab-72d6fd3a6f34\\"\\n }\\n ],\\n \\"Extras\\": [\\n {\\n \\"Key\\": \\"djrq\\",\\n \\"Value\\": \\"2019-08-21 09:49:59.0\\"\\n }\\n ],\\n \\"Summary\\": [\\n {\\n \\"SummaryName\\": \\"score\\",\\n \\"GroupId\\": \\"ba1ba502-d044-48c0-b710-0f1f840a7c53\\",\\n \\"JobId\\": \\"b72425bd-7871-4050-838e-033d80d754b7\\\\n\\",\\n \\"Category\\": \\"{}\\",\\n \\"TaskId\\": \\"9fdf7a81-6781-4ab8-92fb-1d4231ef365e\\",\\n \\"Content\\": \\"5\\",\\n \\"ConversationDetailId\\": \\"098b9b09-9223-4a8b-a422-99726f0457f3\\",\\n \\"SummaryId\\": \\"dc67d544-df06-4625-ae48-13e3c9f72d8a\\"\\n }\\n ],\\n \\"Tasks\\": [\\n {\\n \\"Status\\": \\"Succeeded\\",\\n \\"PlanedTime\\": 1579068424883,\\n \\"ChatbotId\\": \\"1234\\",\\n \\"ActualTime\\": 1579068424883,\\n \\"CalledNumber\\": \\"135****8888\\",\\n \\"ScenarioId\\": \\"ade80092-03d9-4f4d-ad4f-ab8a247d3150\\",\\n \\"JobId\\": \\"b72425bd-7871-4050-838e-033d80d754b7\\",\\n \\"CallId\\": \\"1528189846043\\",\\n \\"CallingNumber\\": \\"0571****3106\\",\\n \\"Brief\\": \\"1\\",\\n \\"Duration\\": 120,\\n \\"TaskId\\": \\"ff44709e-39a6-43ba-959b-20fcabe3e496\\",\\n \\"Contact\\": {\\n \\"PhoneNumber\\": \\"135****8888\\",\\n \\"State\\": \\"Available\\",\\n \\"ContactId\\": \\"db3db762-e421-44c9-9a01-cb423470757c\\",\\n \\"Honorific\\": \\"张先生\\",\\n \\"JobId\\": \\"b72425bd-7871-4050-838e-033d80d754b7\\",\\n \\"ContactName\\": \\"张三\\",\\n \\"Role\\": \\"*\\",\\n \\"ReferenceId\\": \\"2fa6bac3-06da-4315-82ab-72d6fd3a6f34\\"\\n }\\n }\\n ],\\n \\"CallingNumbers\\": [\\n \\"[\\\\\\"0571****3106\\\\\\"]\\"\\n ],\\n \\"TagHits\\": [\\n {\\n \\"TagName\\": \\"有意向\\",\\n \\"TagGroup\\": \\"意向收集\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n \\n 1\\n 10\\n 1\\n \\n Succeeded\\n fce6c599-8ede-40e3-9f78-0928eda7b4e8\\n ade80092-03d9-4f4d-ad4f-ab8a247d3150\\n c8a2b7f2-ad1a-4865-b872-d0080d9802d9\\n fce6c599-8ede-40e3-9f78-0928eda7b4e8\\n 1\\n NoAnswer\\n d5971d98-7312-4f0e-a918-a17d67133e28\\n \\n 135****8888\\n Available\\n db3db762-e421-44c9-9a01-cb423470757c\\n 张先生\\n 72dcd26b-f12d-4c27-b3af-18f6aed5b160\\n 张三\\n *\\n 2fa6bac3-06da-4315-82ab-72d6fd3a6f34\\n \\n \\n djrq\\n 2019-08-21 09:49:59.0\\n \\n \\n score\\n ba1ba502-d044-48c0-b710-0f1f840a7c53\\n 994b8baf-7ef8-480c-b141-b7b6db77c4df\\n {}\\n 9fdf7a81-6781-4ab8-92fb-1d4231ef365e\\n 5\\n 098b9b09-9223-4a8b-a422-99726f0457f3\\n dc67d544-df06-4625-ae48-13e3c9f72d8a\\n \\n \\n Succeeded\\n 1579068424883\\n 1234\\n 1579068424883\\n 135****8888\\n ade80092-03d9-4f4d-ad4f-ab8a247d3150\\n b72425bd-7871-4050-838e-033d80d754b7\\n 1528189846043\\n 0571****3106\\n 1\\n 120\\n ff44709e-39a6-43ba-959b-20fcabe3e496\\n \\n 135****8888\\n Available\\n db3db762-e421-44c9-9a01-cb423470757c\\n 张先生\\n b72425bd-7871-4050-838e-033d80d754b7\\n 张三\\n *\\n 2fa6bac3-06da-4315-82ab-72d6fd3a6f34\\n \\n \\n [\\"0571****3106\\"]\\n
\\n \\n","errorExample":""}]',
'title' => '查询作业列表',
'changeSet' => [
[
'createdAt' => '2023-10-20T07:45:12.000Z',
'description' => '响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:ListJobStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'QueryJobsWithResult' => [
'summary' => '根据任务结果查询任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页数'."\n"
."\n"
.'>该参数必填>',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小'."\n"
.'>该参数必填>',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ad16fc35-d824-4102-a606-2be51c1aa6dd',
],
],
[
'name' => 'QueryText',
'in' => 'query',
'schema' => [
'description' => '搜索内容,可以根据号码进行搜索',
'type' => 'string',
'required' => false,
'example' => '1882020****',
],
],
[
'name' => 'JobStatusFilter',
'in' => 'query',
'schema' => [
'description' => '作业状态筛选'."\n"
.'- Scheduling:调度中。'."\n"
.'- Executing:执行中。'."\n"
.'- Succeeded:结束-已触达。'."\n"
.'- Paused:已暂停。'."\n"
.'- Failed:结束-未触达。'."\n"
.'- Cancelled:已取消-人工干预。',
'type' => 'string',
'required' => false,
'example' => 'Succeeded',
],
],
[
'name' => 'HasAnsweredFilter',
'in' => 'query',
'schema' => [
'description' => '是否接通',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'HasHangUpByRejectionFilter',
'in' => 'query',
'schema' => [
'description' => '是否拒识挂机',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'HasReachedEndOfFlowFilter',
'in' => 'query',
'schema' => [
'description' => '是否完结',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9d53cd72-4050-4419-8c17-acc0bf158147',
],
],
[
'name' => 'TaskStatusFilter',
'in' => 'query',
'schema' => [
'description' => '通话状态,["Executing","Succeeded"],多个以英文逗号分隔'."\n"
.'取值范围'."\n"
.'(注:**Succeeded**状态已细分原因,不会展示**Succeeded**:1(已接通)状态,之后返回均为具体细分原因类型。)'."\n"
."\n"
.'- **Executing**:0(正在拨打)。'."\n"
.'- **Succeeded**:1(已接通)。'."\n"
.'- **NoAnswer**:2(未接通-无人接听)。'."\n"
.'- **NotExist**:3(未接通-空号)。'."\n"
.'- **Busy**:4(未接通-占线)。'."\n"
.'- **Cancelled**:5(未呼出-任务停止)。'."\n"
.'- **Failed**:6(失败)。'."\n"
.'- **NotConnected**:7(未接通-无法接通)。'."\n"
.'- **PoweredOff**:8(未接通-关机)。'."\n"
.'- **OutOfService**:9(未接通-被叫停机)。'."\n"
.'- **InArrears**:10(未接通-被叫欠费)。'."\n"
.'- **EmptyNumber**:11(未呼出-空号不外呼)。'."\n"
.'- **PerDayCallCountLimit**:12(未呼出-超出每日上限)。'."\n"
.'- **ContactBlockList**:13(未呼出-黑名单)。'."\n"
.'- **CallerNotRegistered**:14(未呼出-主叫号码未注册)。'."\n"
.'- **Terminated**:15(未呼出-被终止)。'."\n"
.'- **VerificationCancelled**:16(未呼出-呼叫前验证不通过取消)。'."\n"
.'- **OutOfServiceNoCall**:17(未呼出-被叫停机不外呼)。'."\n"
.'- **InArrearsNoCall**:18(未呼出-被叫欠费不外呼)。'."\n"
.'- **CallingNumberNotExist**:19(未呼出-主叫号码不存在)。'."\n"
.'- **SucceededFinish**:20(已接通-正常完结)。'."\n"
.'- **SucceededChatbotHangUpAfterNoAnswer**:21(已接通-拒识后机器人挂机)。'."\n"
.'- **SucceededChatbotHangUpAfterSilence**:22(已接通-静默超时挂机)。'."\n"
.'- **SucceededClientHangUpAfterNoAnswer**:23(已接通-拒识后用户挂机)。'."\n"
.'- **SucceededClientHangUp**:24(已接通-用户无理由挂机)。'."\n"
.'- **SucceededTransferByIntent**:25(已接通-命中意图转人工)。'."\n"
.'- **SucceededTransferAfterNoAnswer**:26(已接通-拒识转人工)。'."\n"
.'- **SucceededInoInterAction**:27(已接通-用户侧无交互)。'."\n"
.'- **SucceededError**:28(已接通-系统异常中断)。'."\n"
.'- **SucceededSpecialInterceptVoiceAssistant**:29(已接通-特殊情况拦截-语音助手)。'."\n"
.'- **SucceededSpecialInterceptExtensionNumberTransfer**:30(已接通-特殊情况拦截-分机号转接)。'."\n"
.'- **SucceededSpecialInterceptCustomSpecialIntercept**:31(已接通-特殊情况拦截-自定义拦截)。'."\n"
.'- **HighRiskSipCode**:32(未呼出-高风险不外呼)',
'type' => 'string',
'required' => false,
'example' => '["Executing"]',
],
],
[
'name' => 'JobFailureReasonsFilter',
'in' => 'query',
'schema' => [
'description' => '作业失败原因列表',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'NoAnswer' => '无人接听',
'PerDayCallCountLimit' => '号码每日呼叫次数限制',
'InArrears' => '欠费',
'OutOfService' => '停机',
'NoStrategy' => '策略为空或没有找到',
'EmptyNumber' => '空号不再外呼',
'JobPerDayCallCountLimit' => '号码每日呼叫次数限制',
'NoneRepeatableJobMaxAttemptCountLimit' => ' 任务最大尝试次数, 当RepeatBy(@see )为None时生效',
'ContactSuspended' => '止呼',
'VerificationCancelled' => '呼叫前验证不通过取消',
'Unknown' => '未知错误',
'InvalidStrategy' => '无效的策略,策略配置不正确',
'TimeUp' => '调度时发现超时',
'CallFailed' => ' 呼叫失败',
'ContactBlockList' => ' 禁止外呼名单',
],
'example' => '["NoAnswer"]',
],
],
[
'name' => 'StartActualTimeFilter',
'in' => 'query',
'schema' => [
'description' => '通话开始时间过滤条件',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1579055782000',
],
],
[
'name' => 'EndActualTimeFilter',
'in' => 'query',
'schema' => [
'description' => '通话结束时间过滤条件',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1579055783000',
],
],
[
'name' => 'LabelsJson',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '通话对应标签筛选条件'."\n"
."\n"
.'>该条件只能通过配置了具体枚举标签值的标签进行筛选,也就是在大模型场景中配置了具体标签值的标签。',
'type' => 'array',
'items' => [
'description' => '需要筛选的标签以及对应标签值。'."\n"
."\n"
.'> 筛选出所有通话中特定标签以及对应的特定标签值。'."\n"
.'如:{"ValueList":["满意","不满意"],"Name":"是否满意"},表示筛选出所有通话中“是否满意”标签对应的标签值为“满意”以及“不满意”的通话信息',
'type' => 'string',
'required' => false,
'example' => '{'."\n"
.' "ValueList": ['."\n"
.' "满意",'."\n"
.' "不满意"'."\n"
.' ],'."\n"
.' "Name": "是否满意"'."\n"
.' }',
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => 'Code',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '9bdaa1d1-a036-4451-ab11-ca0373679091',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'VariableNames' => [
'description' => '需收集的标签名称',
'type' => 'array',
'items' => [
'description' => '标签key全集',
'type' => 'string',
'example' => '是否已经接通',
],
],
'Jobs' => [
'description' => '作业',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageCount' => [
'description' => '总页数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RowCount' => [
'description' => '总条数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'description' => '作业列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '作业状态。'."\n"
.'- Scheduling(0, "调度中")'."\n"
.'- Executing(1, "执行中")'."\n"
.'- Succeeded(2, "结束-已触达")'."\n"
.'- Paused(3, "暂停")'."\n"
.'- Failed(4, "结束-未触达")'."\n"
.'- Cancelled(5, "已取消-人工干预")'."\n"
.'- Drafted(6, "草稿态")',
'type' => 'string',
'example' => 'Succeeded',
],
'StatusName' => [
'description' => '作业状态名称',
'type' => 'string',
'example' => '结束-已触达',
],
'JobFailureReason' => [
'description' => '作业失败原因',
'type' => 'string',
'example' => '- Unknown(未知错误)'."\n"
.'- NoAnswer(无人接听)'."\n"
.'- InvalidStrategy(无效的策略,策略配置不正确)'."\n"
.'- TimeUp(调度时发现超时)'."\n"
.'- NoStrategy(策略为空或没有找到)'."\n"
.'- CallFailed(呼叫失败)'."\n"
.'-PerDayCallCountLimit(号码每日呼叫次数限制)'."\n"
.'- ContactBlockList(禁止外呼名单)'."\n"
.'- EmptyNumber(空号不再外呼)'."\n"
.'- JobPerDayCallCountLimit(号码每日呼叫次数限制)'."\n"
.'- VerificationCancelled(呼叫前验证不通过取消)'."\n"
.'- ContactSuspended(止呼)'."\n"
.'- InArrears(欠费)'."\n"
.'- OutOfService(停机)'."\n"
.'- NoneRepeatableJobMaxAttemptCountLimit( 任务最大尝试次数, 当RepeatBy(@see )为None时生效)',
],
'Id' => [
'description' => '作业ID',
'type' => 'string',
'example' => 'cc231a1d-3c05-4739-8926-193ecf4097ba',
],
'LatestTask' => [
'description' => '最新通话',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '通话状态',
'type' => 'string',
'example' => 'Succeeded',
],
'TaskEndReason' => [
'description' => '通话结果',
'type' => 'string',
'example' => 'FINISHED',
],
'HasAnswered' => [
'description' => '是否接听',
'type' => 'boolean',
'example' => 'true',
],
'CallDuration' => [
'description' => '通话时长',
'type' => 'integer',
'format' => 'int32',
'example' => '40000',
],
'HasReachedEndOfFlow' => [
'description' => '是否完结',
'type' => 'boolean',
'example' => 'true',
],
'StatusName' => [
'description' => '通话状态名称',
'type' => 'string',
'example' => '未呼出-超出每日上限',
],
'CallTime' => [
'description' => '通话时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1615363297000',
],
'CallDurationDisplay' => [
'description' => '通话时长',
'type' => 'string',
'example' => '40',
],
'HasHangUpByRejection' => [
'description' => '是否拒识挂机',
'type' => 'boolean',
'example' => 'false',
],
'Extras' => [
'description' => '需收集的标签名称',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签Key',
'type' => 'string',
'example' => '是否已经接通',
],
'Value' => [
'description' => '标签Value',
'type' => 'string',
'example' => '是',
],
],
'description' => '',
],
],
'TagHits' => [
'description' => '标签命中信息【旧画布返回】',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagName' => [
'description' => '标签名称',
'type' => 'string',
'example' => '猫幼年期,猫幼年期',
],
'TagGroup' => [
'description' => '标签所在标签组',
'type' => 'string',
'example' => '动物',
],
],
'description' => '',
],
],
'Contact' => [
'description' => '联系人',
'type' => 'object',
'properties' => [
'Round' => [
'description' => '轮次',
'type' => 'integer',
'format' => 'int32',
'example' => '151',
],
'JobUuid' => [
'description' => '作业ID',
'type' => 'string',
'example' => 'cc231a1d-3c05-4739-8926-193ecf4097ba'."\n",
],
'PreferredPhoneNumber' => [
'description' => '交流中被叫人自己指定的电话号码,填入后,会实际呼叫该号码。'."\n"
.'> 客户自定义,在接口调用执行外呼任务时方式时通过json方式传入',
'type' => 'string',
'example' => '134123****',
],
'PhoneNumber' => [
'description' => '联系人的电话号码',
'type' => 'string',
'example' => '1882020****',
],
'State' => [
'description' => '该联系人的状态,'."\n"
.'比如正常(Available),号码错误(WrongNumber), 或者是空号(DoesNotExist)等'."\n"
.'> 客户自定义,在接口调用执行外呼任务时方式时通过json方式传入',
'type' => 'string',
'example' => 'Available',
],
'Honorific' => [
'description' => '对联系人的尊称,不填入默认与name相同'."\n"
.'> 客户自定义,在接口调用执行外呼任务时方式时通过json方式传入',
'type' => 'string',
'example' => '张先生',
],
'Name' => [
'description' => '联系人姓名,比如张三',
'type' => 'string',
'example' => '张三',
],
'Role' => [
'description' => '该联系人在此外呼业务中的角色,不指定则不区分。对于催收业务中,联系人的角色可以分为借款人,共同借款人,担保人等。'."\n"
."\n"
.'> 客户自定义,在接口方式时通过json方式传入',
'type' => 'string',
'example' => '借款人',
],
'Id' => [
'description' => '联系人ID,上传外呼名单时系统生成唯一标识',
'type' => 'string',
'example' => '63860deb-6218-45df-b1e0-76f2b166e790',
],
'ReferenceId' => [
'description' => '客户自己上传的联系人ID,需要由业务方提供,这主要是避免重名现象。',
'type' => 'string',
'example' => 'C01',
],
],
],
'HasLastPlaybackCompleted' => [
'description' => '挂断时是否完成播报',
'type' => 'boolean',
'example' => 'true',
],
'DialExceptionCodes' => [
'description' => '通话异常码',
'type' => 'array',
'items' => [
'description' => '通话异常码',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '错误码',
'type' => 'string',
'enumValueTitles' => [],
'example' => '0',
],
'Hint' => [
'description' => '错误提示信息',
'type' => 'string',
'enumValueTitles' => [],
'example' => '无',
],
],
],
],
],
],
],
'description' => '',
],
],
],
],
'Labels' => [
'description' => '可做筛选条件的标签信息。'."\n"
."\n"
.'> 显示该任务组中所有具有枚举值的标签信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '标签名字',
'type' => 'string',
'example' => '是否满意',
],
'ValueList' => [
'description' => '标签值列表。',
'type' => 'array',
'items' => [
'description' => '标签值。',
'type' => 'string',
'example' => '["否","是"]',
],
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"9bdaa1d1-a036-4451-ab11-ca0373679091\\",\\n \\"Success\\": true,\\n \\"VariableNames\\": [\\n \\"是否已经接通\\"\\n ],\\n \\"Jobs\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageCount\\": 1,\\n \\"RowCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"Succeeded\\",\\n \\"StatusName\\": \\"结束-已触达\\",\\n \\"JobFailureReason\\": \\"- Unknown(未知错误)\\\\n- NoAnswer(无人接听)\\\\n- InvalidStrategy(无效的策略,策略配置不正确)\\\\n- TimeUp(调度时发现超时)\\\\n- NoStrategy(策略为空或没有找到)\\\\n- CallFailed(呼叫失败)\\\\n-PerDayCallCountLimit(号码每日呼叫次数限制)\\\\n- ContactBlockList(禁止外呼名单)\\\\n- EmptyNumber(空号不再外呼)\\\\n- JobPerDayCallCountLimit(号码每日呼叫次数限制)\\\\n- VerificationCancelled(呼叫前验证不通过取消)\\\\n- ContactSuspended(止呼)\\\\n- InArrears(欠费)\\\\n- OutOfService(停机)\\\\n- NoneRepeatableJobMaxAttemptCountLimit( 任务最大尝试次数, 当RepeatBy(@see )为None时生效)\\",\\n \\"Id\\": \\"cc231a1d-3c05-4739-8926-193ecf4097ba\\",\\n \\"LatestTask\\": {\\n \\"Status\\": \\"Succeeded\\",\\n \\"TaskEndReason\\": \\"FINISHED\\",\\n \\"HasAnswered\\": true,\\n \\"CallDuration\\": 40000,\\n \\"HasReachedEndOfFlow\\": true,\\n \\"StatusName\\": \\"未呼出-超出每日上限\\",\\n \\"CallTime\\": 1615363297000,\\n \\"CallDurationDisplay\\": \\"40\\",\\n \\"HasHangUpByRejection\\": false,\\n \\"Extras\\": [\\n {\\n \\"Key\\": \\"是否已经接通\\",\\n \\"Value\\": \\"是\\"\\n }\\n ],\\n \\"TagHits\\": [\\n {\\n \\"TagName\\": \\"猫幼年期,猫幼年期\\",\\n \\"TagGroup\\": \\"动物\\"\\n }\\n ],\\n \\"Contact\\": {\\n \\"Round\\": 151,\\n \\"JobUuid\\": \\"cc231a1d-3c05-4739-8926-193ecf4097ba\\\\n\\",\\n \\"PreferredPhoneNumber\\": \\"134123****\\",\\n \\"PhoneNumber\\": \\"1882020****\\",\\n \\"State\\": \\"Available\\",\\n \\"Honorific\\": \\"张先生\\",\\n \\"Name\\": \\"张三\\",\\n \\"Role\\": \\"借款人\\",\\n \\"Id\\": \\"63860deb-6218-45df-b1e0-76f2b166e790\\",\\n \\"ReferenceId\\": \\"C01\\"\\n },\\n \\"HasLastPlaybackCompleted\\": true,\\n \\"DialExceptionCodes\\": [\\n {\\n \\"Code\\": \\"0\\",\\n \\"Hint\\": \\"无\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"是否满意\\",\\n \\"ValueList\\": [\\n \\"[\\\\\\"否\\\\\\",\\\\\\"是\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => '根据任务结果查询任务',
'changeSet' => [
[
'createdAt' => '2025-09-10T13:09:37.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2025-07-15T09:08:02.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2024-11-13T14:08:15.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2024-02-04T14:24:42.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-09-20T13:54:30.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-06-22T02:25:49.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2021-11-24T13:02:02.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2021-11-24T13:02:02.000Z',
'description' => '响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:QueryJobsWithResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'QueryScriptWaveforms' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '5ab2d935-306c-478a-88bf-d08e4e25c1b7',
],
],
[
'name' => 'ScriptContent',
'in' => 'query',
'schema' => [
'description' => '场景声音名称',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '抱歉打扰您了,稍后会有客户经理与您联系啊,再见!'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'ScriptWaveforms' => [
'description' => '场景声音的录音列表'."\n"
."\n"
.'> 只有声音类型为录音时,才会返回录音数据;当该声音为语音合成时不返回',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ScriptContent' => [
'description' => '场景声音名称',
'type' => 'string',
'example' => '测试',
],
'ScriptWaveformId' => [
'description' => '场景声音录音ID',
'type' => 'string',
'example' => '444df4-009c-4791-a720-e7ac4f9821a1'."\n",
],
'FileName' => [
'description' => '录音文件名称',
'type' => 'string',
'example' => 'SHUKE_ZA_ol_32_邀约.wav',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => '25b26ce1-009c-4791-a720-e7ac4f9821a1',
],
'FileId' => [
'description' => '文件在OSS上面的key',
'type' => 'string',
'example' => 'UPLOADED/RECORDING/a8xxxxx-2b26-4b6d-a54f-696b95xxx1/a6bf591a-cf6d-4xxxxxx.wav',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"ScriptWaveforms\\": [\\n {\\n \\"ScriptContent\\": \\"测试\\",\\n \\"ScriptWaveformId\\": \\"444df4-009c-4791-a720-e7ac4f9821a1\\\\n\\",\\n \\"FileName\\": \\"SHUKE_ZA_ol_32_邀约.wav\\",\\n \\"ScriptId\\": \\"25b26ce1-009c-4791-a720-e7ac4f9821a1\\",\\n \\"FileId\\": \\"UPLOADED/RECORDING/a8xxxxx-2b26-4b6d-a54f-696b95xxx1/a6bf591a-cf6d-4xxxxxx.wav\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '【废弃】查询旧画布场景声音录音文件列表',
'summary' => '旧画布接口,查询话术文本的录音列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:QueryScriptWaveforms',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'QueryScriptsByStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '10',
],
],
[
'name' => 'StatusList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '状态列表',
'type' => 'array',
'items' => [
'description' => '场景状态取值范围'."\n"
.'- **DRAFTED**:草稿态'."\n"
.'- **INITIALIZE_IN_PROGRESS**:正在初始化'."\n"
.'- **PUBLISHED**:已发布'."\n"
.'- **PUBLISH_IN_PROGRESS**:正在发布'."\n"
.'- **ROLLBACK_IN_PROGRESS**:正在回滚'."\n"
.'- **EXAMINE_IN_PROGRESS**:待审核'."\n"
.'- **PUBLISHED_AND_EXAMINE_IN_PROGRESS**:已发布待审核状态'."\n"
.'- **PUBLISH_FAILED**:已发布待审核状态'."\n"
.'- **ROLLBACK_FAILED**:回滚失败'."\n"
.'- **IMPORT_IN_PROGRESS**:正在导入'."\n"
.'- **IMPORT_FAILED**:导入失败',
'type' => 'string',
'required' => false,
'example' => 'PUBLISHED',
],
'required' => true,
'maxItems' => 10,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Scripts' => [
'description' => '场景列表',
'type' => 'object',
'properties' => [
'PageNumber' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'List' => [
'description' => '场景信息列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '应用版本的状态,取值范围'."\n"
.'- **DRAFTED**:草稿态'."\n"
.'- **INITIALIZE_IN_PROGRESS**:正在初始化'."\n"
.'- **PUBLISHED**:已发布'."\n"
.'- **PUBLISH_IN_PROGRESS**:正在发布'."\n"
.'- **ROLLBACK_IN_PROGRESS**:正在回滚'."\n"
.'- **EXAMINE_IN_PROGRESS**:待审核'."\n"
.'- **PUBLISHED_AND_EXAMINE_IN_PROGRESS**:已发布待审核状态'."\n"
.'- **PUBLISH_FAILED**:已发布待审核状态'."\n"
.'- **ROLLBACK_FAILED**:回滚失败'."\n"
.'- **IMPORT_IN_PROGRESS**:正在导入'."\n"
.'- **IMPORT_FAILED**:导入失败',
'type' => 'string',
'example' => 'PUBLISHED',
],
'UpdateTime' => [
'description' => '更新时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1579055782000',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'example' => 'fa0e21e9-caab-4629-9121-1e341243d599',
],
'AppliedVersion' => [
'description' => '版本ID',
'type' => 'string',
'example' => '1579055782000',
],
'IsDebugDrafted' => [
'description' => '调试版本是否为草稿态',
'type' => 'boolean',
'example' => 'false',
],
'Industry' => [
'description' => '⾏业',
'type' => 'string',
'example' => '通用',
],
'ScriptDescription' => [
'description' => '话术描述',
'type' => 'string',
'example' => '销售话术',
],
'IsDrafted' => [
'description' => '版本是否为草稿态',
'type' => 'boolean',
'example' => 'false',
],
'DebugStatus' => [
'description' => '调试状态',
'type' => 'string',
'example' => 'PUBLISHED',
],
'DebugVersion' => [
'description' => '调试版本',
'type' => 'string',
'example' => '01bb2df2-a273-42bb-a214-d3c626b13296',
],
'Scene' => [
'description' => '场景',
'type' => 'string',
'example' => '电销',
],
'ScriptName' => [
'description' => '场景名称',
'type' => 'string',
'example' => '销售话术',
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter',
'errorMessage' => 'The specified parameter %s is invalid.',
'description' => '参数值校验不通过。请使用请求参数构造规范化的请求字符串。',
],
],
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Scripts\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 15,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"UpdateTime\\": 1579055782000,\\n \\"ScriptId\\": \\"fa0e21e9-caab-4629-9121-1e341243d599\\",\\n \\"AppliedVersion\\": \\"1579055782000\\",\\n \\"IsDebugDrafted\\": false,\\n \\"Industry\\": \\"通用\\",\\n \\"ScriptDescription\\": \\"销售话术\\",\\n \\"IsDrafted\\": false,\\n \\"DebugStatus\\": \\"PUBLISHED\\",\\n \\"DebugVersion\\": \\"01bb2df2-a273-42bb-a214-d3c626b13296\\",\\n \\"Scene\\": \\"电销\\",\\n \\"ScriptName\\": \\"销售话术\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '根据场景状态查询场景信息',
'summary' => '根据场景状态查询场景信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:QueryScriptsByStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'RecordFailure' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9ab43460-c0b9-40e2-8447-48d82c97fc67',
],
],
[
'name' => 'CallId',
'in' => 'query',
'schema' => [
'description' => '通话id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '4f21446e-324e-46f2-bf62-7f341fb004ea',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd2295c0e-3bc3-48a5-9f56-b185db2be909',
],
],
[
'name' => 'ActualTime',
'in' => 'query',
'schema' => [
'description' => '通话开始时间',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1579055782000',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => [
'description' => '主叫号码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '10086',
],
],
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => [
'description' => '被叫号码',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '135815****',
],
],
[
'name' => 'DispositionCode',
'in' => 'query',
'schema' => [
'description' => '失败原因。'."\n"
."\n"
.'- 空号(NotExists)'."\n"
."\n"
.'- 忙(Busy)'."\n"
."\n"
.'- 无人接听(NotAnswered)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'NotExists',
],
],
[
'name' => 'ExceptionCodes',
'in' => 'query',
'schema' => [
'description' => '外呼未成功时发生的错误编码'."\n"
.'- 空号(NotExists)'."\n"
."\n"
.'- 忙(Busy)'."\n"
.'- 无人接听(NotAnswered)',
'type' => 'string',
'required' => false,
'example' => 'NotExists',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'ivr记录通话失败-已废弃',
'summary' => 'CC提交通话失败原因到外呼业务系统,已废弃。',
'changeSet' => [
[
'createdAt' => '2021-11-24T13:02:02.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:RecordFailure',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'ResumeJobs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => [
'description' => '过滤条件,是否重启所有',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'true',
],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => [
'description' => '过滤条件,场景id(历史参数,已废弃)',
'type' => 'string',
'required' => false,
'example' => 'b016fbdb-b81c-4c06-8870-cb36b8783b6d',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '过滤条件,任务组ID',
'type' => 'string',
'required' => false,
'example' => 'de48407d-309e-451a-81ec-6fb11f8fdbf3',
],
],
[
'name' => 'JobId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '作业ID列表'."\n"
."\n"
.'> 当All的值为false时,该参数必填',
'type' => 'array',
'items' => [
'description' => '作业ID',
'type' => 'string',
'required' => false,
'example' => 'b72425bd-7871-4050-838e-033d80d754b7',
],
'required' => false,
'maxItems' => 99,
],
],
[
'name' => 'JobReferenceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '作业的第三方id'."\n"
."\n"
.'> 即为上传外呼名单时客户上传的ReferenceId',
'type' => 'array',
'items' => [
'description' => '作业的第三方id',
'type' => 'string',
'required' => false,
'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28',
],
'required' => false,
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '重启暂停的作业',
'summary' => '重启暂停的作业。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:ResumeJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'RollbackScript' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94167',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '303523b1-0094-4ebe-b9ed-c23d11c91d61',
],
],
[
'name' => 'RollbackVersion',
'in' => 'query',
'schema' => [
'description' => '回滚的版本'."\n"
."\n"
.'> 取值来源参考ListScriptPublishHistories接口',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1578965079000',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'True',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n","errorExample":""}]',
'title' => '回滚发布的场景(仅小模型)',
'summary' => '回滚发布的小模型场景。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:RollbackScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'SaveAfterAnswerDelayPlayback' => [
'summary' => '保存接听后延迟播报时间。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbotDCPC66',
],
],
'parameters' => [
[
'name' => 'EntryId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '980116ec-2d3d-4747-8059-dc25e7af8501',
],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => [
'description' => '策略级别(必填)。'."\n"
.'- 2:实例',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
[
'name' => 'AfterAnswerDelayPlayback',
'in' => 'query',
'schema' => [
'description' => '延迟播报的播放时间,不填默认为0',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '保存接听后延迟播报时间',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-01-12T12:20:26.000Z',
'description' => '请求参数发生变更',
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:SaveAfterAnswerDelayPlayback',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'SaveAnnotationMissionSessionList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '130001',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'AnnotationMissionSessionListJsonString',
'in' => 'query',
'schema' => [
'description' => '会话列表JSON'."\n"
."\n"
.'> 该参数与AnnotationMissionSessionList作用相同,两者任选其一。'."\n"
.'json字段为AnnotationMissionSessionList的参数',
'type' => 'string',
'required' => false,
'example' => '[{"jobGroupId":"4093e364-57dc-4a89-83e0-a88454642596","modifiedTime":1744971010000,"instanceId":"00b37342-e759-4fe5-b296-aef775933af0","version":0,"annotationMissionId":"3d4bfd93-0d16-4873-9d77-e4fb1771e5cf","createTime":1744971010000,"annotationMissionSessionId":"42032063-8ef2-48e1-bc99-587b51581742","scriptId":"bc50d543-6d52-4df8-8fb0-50f31ee9c1ff","sessionId":"641a2c43-5e2a-4535-8a4d-c66d4b4258d6","jobId":"fa54c5bb-d8a7-40ae-a32e-9a4a0c734ce5","annotationStatus":2,"debugConversation":false}]',
],
],
[
'name' => 'UserNick',
'in' => 'query',
'schema' => [
'description' => '用户昵称',
'type' => 'string',
'required' => false,
'example' => '用户',
],
],
[
'name' => 'AnnotationMissionSessionList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '会话列表'."\n"
."\n"
.'> 与AnnotationMissionSessionListJsonString参数作用相同,两者选择其一即可',
'type' => 'array',
'items' => [
'description' => '会话',
'type' => 'object',
'properties' => [
'AnnotationMissionSessionId' => [
'description' => '会话ID',
'type' => 'string',
'required' => false,
'example' => 'c88cc004-de69-4eee-aa5f-2efed533a54e'."\n",
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2023-04-14T02:01:23Z',
],
'ModifiedTime' => [
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1683858248778',
],
'AnnotationMissionId' => [
'description' => '标注任务ID',
'type' => 'string',
'required' => false,
'example' => 'c88cc004-de69-4eee-aa5f-2efed533a54e',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'required' => false,
'example' => '77343553-cbc2-4487-a35c-869f1e86c573',
],
'ScriptId' => [
'description' => '场景ID',
'type' => 'string',
'required' => false,
'example' => 'e4f32632-2e56-4399-9fec-47bdbaeefdf6',
],
'JobGroupId' => [
'description' => '任务组ID',
'type' => 'string',
'required' => false,
'example' => '29e669bd-a9d1-4529-98cd-c2b0549bcf53',
],
'JobId' => [
'description' => '任务ID',
'type' => 'string',
'required' => false,
'example' => '593aaf5e-1275-4add-9990-22696385dc6e',
],
'SessionId' => [
'description' => '外呼系统为taskId,导航为conversationId',
'type' => 'string',
'required' => false,
'example' => 'e6271044-b4b2-4ad8-ade4-c720be023538',
],
'AnnotationStatus' => [
'description' => '标注状态'."\n"
.'- 0:未完成(UNDO)'."\n"
.'- 1:进行中(DOING)'."\n"
.'- 2:已完成(DONE)'."\n"
.'- 3:已取消(CLOSED)',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'AnnotationMissionChatList' => [
'description' => 'chat列表',
'type' => 'array',
'items' => [
'description' => 'chat列表',
'type' => 'object',
'properties' => [
'AnnotationMissionChatId' => [
'description' => 'chat ID',
'type' => 'string',
'required' => false,
'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n",
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1679629770336',
],
'ModifiedTime' => [
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1629360780000',
],
'AnnotationMissionId' => [
'description' => '标注任务ID',
'type' => 'string',
'required' => false,
'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9',
],
'AnnotationMissionSessionId' => [
'description' => '会话ID',
'type' => 'string',
'required' => false,
'example' => 'c88cc004-de69-4eee-aa5f-2efed533a54e'."\n",
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'required' => false,
'example' => '5ec263fa-c8de-46f4-b844-6fb8275bb645',
],
'SequenceId' => [
'description' => '本轮次会话交互的序列号',
'type' => 'string',
'required' => false,
'example' => '1475140522',
],
'OccurTime' => [
'description' => '触发时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1682493047418',
],
'Answer' => [
'description' => '机器人答复内容',
'type' => 'string',
'required' => false,
'example' => '{\'Answer\': u\'\\u53c2\\u8003\\u6587\\u6863\\uff1ahttps://help.aliyun.com/document_detail/181325.html\', \'QuestionId\': 372858, \'Uuid\': \'ac14000516762684770197536d0044\'}',
],
'AnnotationStatus' => [
'description' => '标注状态'."\n"
.'- 0:未完成(UNDO)'."\n"
.'- 1:进行中(DOING)'."\n"
.'- 2:已完成(DONE)'."\n"
.'- 3:已取消(CLOSED)',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'IntentAnnotationStatus' => [
'title' => '语义标注状态',
'description' => '语义标注状态'."\n"
.'- 0:未完成(UNDO)'."\n"
.'- 1:进行中(DOING)'."\n"
.'- 2:已完成(DONE)'."\n"
.'- 3:已取消(CLOSED)',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'AsrAnnotationStatus' => [
'title' => 'ASR标注状态',
'description' => 'ASR标注状态'."\n"
.'- 0:未完成(UNDO)'."\n"
.'- 1:进行中(DOING)'."\n"
.'- 2:已完成(DONE)'."\n"
.'- 3:已取消(CLOSED)',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'TagAnnotationStatus' => [
'title' => '标签标注状态',
'description' => '标签标注状态'."\n"
.'- 0:未完成(UNDO)'."\n"
.'- 1:进行中(DOING)'."\n"
.'- 2:已完成(DONE)'."\n"
.'- 3:已取消(CLOSED)',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'SubStatus' => [
'title' => '标注动作:1正确、20匹配错误未优化 21匹配错误已优化、3未覆盖、4无效',
'description' => '标注动作:1正确、20匹配错误未优化 21匹配错误已优化、3未覆盖、4无效',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'TranslationError' => [
'description' => '转译错误标识'."\n"
.'- 0:否'."\n"
.'- 1:是',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'AnnotationAsrResult' => [
'description' => 'ASR人工标注文本结果,用于字准率的计算',
'type' => 'string',
'required' => false,
'example' => '[]',
],
'OriginalAsrResult' => [
'description' => 'ASR识别结果',
'type' => 'string',
'required' => false,
'example' => '[]',
],
'AnnotationMissionChatIntentUserSayInfoList' => [
'description' => '列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AnnotationMissionChatIntentUserSayInfoId' => [
'description' => 'ID',
'type' => 'string',
'required' => false,
'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n",
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1683858248778',
],
'ModifiedTime' => [
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1683858248778',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'required' => false,
'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n",
],
'AnnotationMissionId' => [
'description' => '标注任务ID',
'type' => 'string',
'required' => false,
'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n",
],
'AnnotationMissionSessionId' => [
'description' => '会话ID',
'type' => 'string',
'required' => false,
'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n",
],
'AnnotationMissionChatId' => [
'description' => 'chat ID',
'type' => 'string',
'required' => false,
'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n",
],
'Content' => [
'description' => '内容',
'type' => 'string',
'required' => false,
'example' => '[]',
],
'IntentId' => [
'description' => '意图ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '119839',
],
'DialogId' => [
'description' => '对话ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2991201'."\n",
],
'BotId' => [
'description' => '机器人ID',
'type' => 'string',
'required' => false,
'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n",
],
'Delete' => [
'description' => '删除',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'Create' => [
'description' => '创建',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 10,
],
'AnnotationMissionChatVocabularyInfoList' => [
'description' => '标注任务chat热词标注信息表',
'type' => 'array',
'items' => [
'description' => '标注任务chat热词标注信息表',
'type' => 'object',
'properties' => [
'AnnotationMissionChatVocabularyInfoId' => [
'description' => 'ID',
'type' => 'string',
'required' => false,
'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n",
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1677552860720',
],
'ModifiedTime' => [
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1679283408230',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'required' => false,
'example' => '77343553-cbc2-4487-a35c-869f1e86c573',
],
'AnnotationMissionId' => [
'description' => '标注任务ID',
'type' => 'string',
'required' => false,
'example' => '977a45dc-b636-4407-9e98-9f572c709ada',
],
'AnnotationMissionSessionId' => [
'description' => '会话ID',
'type' => 'string',
'required' => false,
'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n",
],
'AnnotationMissionChatId' => [
'description' => 'chat ID',
'type' => 'string',
'required' => false,
'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n",
],
'VocabularyId' => [
'description' => '热词ID',
'type' => 'string',
'required' => false,
'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n",
],
'Vocabulary' => [
'description' => '热词标注内容',
'type' => 'string',
'required' => false,
'example' => '[]',
],
'VocabularyName' => [
'description' => '处理场景名称',
'type' => 'string',
'required' => false,
'example' => '咨询',
],
'VocabularyDescription' => [
'description' => '描述',
'type' => 'string',
'required' => false,
'example' => '售后咨询',
],
'VocabularyWeight' => [
'description' => '热词权重[-6,5]',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
'Delete' => [
'description' => '删除',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'Create' => [
'description' => '创建',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 10,
],
'AnnotationMissionChatCustomizationDataInfoList' => [
'description' => '标注任务chat语言模型标注信息表',
'type' => 'array',
'items' => [
'description' => '标注任务chat语言模型标注信息表',
'type' => 'object',
'properties' => [
'AnnotationMissionChatCustomizationDataInfoId' => [
'description' => 'ID',
'type' => 'string',
'required' => false,
'example' => 'b598a47a-7c03-45fb-af6b-343950dd9512'."\n",
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1682316909210',
],
'ModifiedTime' => [
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1673438100000',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'required' => false,
'example' => 'b598a47a-7c03-45fb-af6b-343950dd9512',
],
'AnnotationMissionId' => [
'description' => '标注任务ID',
'type' => 'string',
'required' => false,
'example' => '03f56192-fa8a-40dc-9558-39b357f0618f',
],
'AnnotationMissionSessionId' => [
'description' => '会话ID',
'type' => 'string',
'required' => false,
'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n",
],
'AnnotationMissionChatId' => [
'description' => 'chat ID',
'type' => 'string',
'required' => false,
'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n",
],
'CustomizationDataId' => [
'description' => 'ID',
'type' => 'string',
'required' => false,
'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n",
],
'Content' => [
'description' => '内容',
'type' => 'string',
'required' => false,
'example' => '现在呢主动邀请到您,机会非常难得,而且额度放着不用,也是不收费的,可以当作咱们的备用金,最快5分钟就能到账,建议您可以先把额度免费领取下来呢。 ',
],
'CustomizationDataName' => [
'description' => '名称',
'type' => 'string',
'required' => false,
'example' => '默认数据',
],
'CustomizationDataDescription' => [
'description' => '描述',
'type' => 'string',
'required' => false,
'example' => '默认数据描述',
],
'CustomizationDataWeight' => [
'description' => '语言模型数据权重',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'Delete' => [
'description' => '删除',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'Create' => [
'description' => '创建',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 10,
],
'AnnotationMissionChatTagInfoList' => [
'description' => '标注信息chat绑定标签映射关系列表',
'type' => 'array',
'items' => [
'description' => '标注信息chat绑定标签映射关系列表',
'type' => 'object',
'properties' => [
'AnnotationMissionChatTagInfoId' => [
'description' => 'ID',
'type' => 'string',
'required' => false,
'example' => 'id',
],
'CreateTime' => [
'description' => 'annotationmissiongroup结束时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1679710866060',
],
'ModifiedTime' => [
'description' => '修改时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1679710866060',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'required' => false,
'example' => '32be9d94-1346-4c4a-a4d0-ccd379f87013',
],
'AnnotationMissionId' => [
'description' => '任务ID',
'type' => 'string',
'required' => false,
'example' => '977a45dc-b636-4407-9e98-9f572c709ada',
],
'AnnotationMissionSessionId' => [
'description' => '会话ID',
'type' => 'string',
'required' => false,
'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n",
],
'AnnotationMissionChatId' => [
'description' => 'chat ID',
'type' => 'string',
'required' => false,
'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n",
],
'AnnotationMissionTagInfoId' => [
'description' => 'tag ID',
'type' => 'string',
'required' => false,
'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n",
],
'AnnotationMissionTagInfoName' => [
'description' => 'tag名称',
'type' => 'string',
'required' => false,
'example' => '-',
],
'Delete' => [
'description' => '删除',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'Create' => [
'description' => '创建',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 10,
],
],
'required' => false,
],
'required' => false,
'maxItems' => 10,
],
],
'required' => false,
],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'Environment',
'in' => 'query',
'schema' => [
'description' => '环境'."\n"
.'- 0:NONE'."\n"
.'- 1:私有云'."\n"
.'- 2:公有云',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'AnnotationMissionDataSourceType',
'in' => 'query',
'schema' => [
'description' => '标注数据来源,1:外呼、2:导航',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => [
'description' => '坐席ID。'."\n"
."\n"
.'> 可通过DescribeInstance接口获取',
'type' => 'string',
'required' => false,
'example' => '1198938',
],
],
[
'name' => 'AgentKey',
'in' => 'query',
'schema' => [
'description' => '业务空间key,不传时访问默认业务空间,key值在主账号业务管理页面获取'."\n"
.'> 可通过DescribeInstance接口获取',
'type' => 'string',
'required' => false,
'example' => '9137ab9c27044921860030adf8590ec4_p_outbound_public',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否调用成功。true:表示调用成功。 false:表示调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '附加信息。取值说明如下:请求正常,返回success。请求异常,返回具体异常错误码。',
'type' => 'string',
'example' => '执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-zz4310rp1lb,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821',
],
'Data' => [
'description' => '数据',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => '执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-zz4310rp1lb,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821',
],
'SaveAnnotationMissionSessionListRequest' => [
'description' => '请求结果',
'type' => 'object',
'properties' => [
'AnnotationMissionSessionListJsonString' => [
'description' => '审批申请的脚本内容',
'type' => 'string',
'example' => '[]',
],
],
],
'MessageList' => [
'description' => '信息列表',
'type' => 'array',
'items' => [
'description' => '信息列表',
'type' => 'string',
'example' => '[]',
],
],
],
],
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '76E93048-F90F-57B7-BD46-6097611A706D',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-zz4310rp1lb,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-zz4310rp1lb,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821\\",\\n \\"SaveAnnotationMissionSessionListRequest\\": {\\n \\"AnnotationMissionSessionListJsonString\\": \\"[]\\"\\n },\\n \\"MessageList\\": [\\n \\"[]\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"76E93048-F90F-57B7-BD46-6097611A706D\\"\\n}","type":"json"}]',
'title' => '保存标注chat实例列表',
'summary' => '保存标注chat实例列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:SaveAnnotationMissionSessionList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'SaveAnnotationMissionTagInfoList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '129330',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'AnnotationMissionTagInfoListJsonString',
'in' => 'query',
'schema' => [
'description' => '标签JSON数据'."\n"
."\n"
.'> json中具体的参数与AnnotationMissionTagInfoList参数相同,二者选其一填写即可。',
'type' => 'string',
'required' => false,
'example' => '[{"delete":false, "InstanceId":"00b37342-e759-4fe5-b296-aef775933af0", "AnnotationMissionTagInfoName":"测试数据1", "AnnotationMissionTagInfoDescription":"测试"}]',
],
],
[
'name' => 'AnnotationMissionTagInfoList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表'."\n"
."\n"
.'> 与AnnotationMissionTagInfoListJsonString参数相同,二者选其一即可。',
'type' => 'array',
'items' => [
'description' => '标签列表',
'type' => 'object',
'properties' => [
'AnnotationMissionTagInfoId' => [
'description' => '标签ID',
'type' => 'string',
'required' => false,
'example' => 'bdbff6a5-1f68-4b41-8d37-6ff805ce165a'."\n",
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'required' => false,
'example' => 'bdbff6a5-1f68-4b41-8d37-6ff805ce165a',
],
'TenantId' => [
'description' => '租户ID。',
'type' => 'string',
'required' => false,
'example' => 'bdbff6a5-1f68-4b41-8d37-6ff805ce165a'."\n",
],
'AnnotationMissionTagInfoName' => [
'description' => '标签名称',
'type' => 'string',
'required' => false,
'example' => '标签',
],
'AnnotationMissionTagInfoDescription' => [
'description' => '标签描述',
'type' => 'string',
'required' => false,
'example' => '标签描述',
],
'Delete' => [
'description' => '是否删除'."\n"
."\n"
.'> 选择true则是删除该标签,填入false则新增',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'Reset',
'in' => 'query',
'schema' => [
'description' => '是否选择恢复默认标签值',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否调用成功。true:表示调用成功。false:表示调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => '执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-uax33hol2uu,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821',
],
'Data' => [
'description' => '数据',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'ExecCount' => [
'description' => '执行成功的数量',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => '执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-uax33hol2uu,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821',
],
],
],
'HttpStatusCode' => [
'description' => 'HTTP状态码。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '1B356EDC-F69A-53B0-B4AF-2AC42200684E',
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-uax33hol2uu,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"ExecCount\\": 1,\\n \\"Message\\": \\"执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-uax33hol2uu,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1B356EDC-F69A-53B0-B4AF-2AC42200684E\\"\\n}","type":"json"}]',
'title' => '保存标注标签映射关系',
'summary' => '批量保存实例标签信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SaveAnnotationMissionTagInfoList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'SaveBaseStrategyPeriod' => [
'summary' => '在系统管理中编辑全局可外呼时间段。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94169',
'abilityTreeNodes' => [
'FEATUREoutboundbotW09IDV',
],
],
'parameters' => [
[
'name' => 'EntryId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'fe51eca2-a904-4b4d-b3ff-31be334b9500',
],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => [
'description' => '策略级别(必填)'."\n"
.'- 2:实例',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
[
'name' => 'OnlyWeekdays',
'in' => 'query',
'schema' => [
'description' => '仅周一至周五外呼,填空时默认为false',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'WorkingTimeFramesJson',
'in' => 'query',
'schema' => [
'description' => '执行时间',
'type' => 'string',
'required' => false,
'example' => '[{"beginTime":"09:00:00","endTime":"21:00:00"}]',
],
],
[
'name' => 'WorkingTime',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '运行时间【已废弃】',
'type' => 'array',
'items' => [
'description' => '运行时间',
'type' => 'string',
'required' => false,
'example' => '[]',
],
'required' => false,
'example' => '[]',
'maxItems' => 99,
],
],
[
'name' => 'OnlyWorkdays',
'in' => 'query',
'schema' => [
'description' => '仅非节假日外呼,填空时默认为false',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '编辑全局可外呼时间段',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2024-07-22T12:24:25.000Z',
'description' => '响应参数发生变更',
],
[
'createdAt' => '2023-03-08T14:50:30.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2022-01-12T12:20:26.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SaveBaseStrategyPeriod',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'SaveContactBlockList' => [
'summary' => '添加该实例下“禁呼名单”。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbotDCPC66',
],
],
'parameters' => [
[
'name' => 'ContactBlockListsJson',
'in' => 'query',
'schema' => [
'description' => '禁呼名单JSON格式的字符串(必填)'."\n"
."\n"
.'- phonenumber:手机号码'."\n"
.'- remark:备注'."\n"
.'- name:姓名'."\n"
.'- creator:创建者',
'type' => 'string',
'required' => false,
'example' => '[{"phoneNumber":"132322","remark":"123321","name":"ccc1","creator":"ccc222"}]',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID(必填)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c3c92de8-e4bd-4db4-a962-50f8acce40bc',
],
],
[
'name' => 'ContactBlockListList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '联系人信息列表【已废弃】',
'type' => 'array',
'items' => [
'description' => '联系人信息列表【已废弃】',
'type' => 'string',
'required' => false,
'example' => '[]',
],
'required' => false,
'example' => '[]',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'AffectedRows' => [
'description' => '影响行数',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"AffectedRows\\": 5,\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '保存禁止外呼名单',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-01-12T12:20:26.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SaveContactBlockList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'SaveContactWhiteList' => [
'summary' => '保存外呼白名单。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbotDCPC66',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID(必填)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c415bb6c-2e6f-46aa-afd9-3b65b6dbe2bc',
],
],
[
'name' => 'ContactWhiteListsJson',
'in' => 'query',
'schema' => [
'description' => '白名单列表(必填)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '[{"phoneNumber":"132322","remark":"123321","name":"ccc1","creator":"ccc222"}]',
],
],
[
'name' => 'ContactWhiteListList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '联系人白名单列表【已废弃】',
'type' => 'array',
'items' => [
'description' => '外呼白名单【已废弃】',
'type' => 'string',
'required' => false,
'example' => '{}',
],
'required' => false,
'example' => '{}',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'AffectedRows' => [
'description' => '影响行数',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"AffectedRows\\": 1,\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '保存外呼白名单',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:23.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-01-12T12:20:26.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SaveContactWhiteList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'SaveEffectiveDays' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '94172',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'EntryId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'e90b5b8e-c8b4-4182-b28d-a5aa81685e49',
],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => [
'description' => '策略级别',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'EffectiveDays',
'in' => 'query',
'schema' => [
'description' => '生效时间',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '30',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '保存基础策略有效期-已废弃',
'summary' => '保存基础策略有效期,已废弃。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'SaveMaxAttemptsPerDay' => [
'summary' => '保存被叫号码每日拨打上限。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbotDCPC66',
],
],
'parameters' => [
[
'name' => 'EntryId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c8bf820a-6a8a-47bc-99bf-97593df8faa8',
],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => [
'description' => '策略级别(必填)'."\n"
.'- 2:实例',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
[
'name' => 'MaxAttemptsPerDay',
'in' => 'query',
'schema' => [
'description' => '每日最大重拨次数,不填写默认为3',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '3',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '保存被叫号码每日拨打上限',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
[
'createdAt' => '2022-01-12T12:20:26.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SaveMaxAttemptsPerDay',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'SearchTask' => [
'summary' => '搜索任务。',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbot3SV6AU',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'd481cebe-0bb6-4d13-9649-42ce5074fb75',
],
],
[
'name' => 'TaskCreateTimeGte',
'in' => 'query',
'schema' => [
'description' => '任务开始时间'."\n"
."\n"
.'> 与任务结束时间参数TaskCreateTimeLte必须同时真实存在,不然会失效。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1646792941',
],
],
[
'name' => 'TaskCreateTimeLte',
'in' => 'query',
'schema' => [
'description' => '任务结束时间'."\n"
.'> 与任务开始时间参数TaskCreateTimeGte必须同时真实存在,不然会失效。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1646792941',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID',
'type' => 'string',
'required' => false,
'example' => '3a30ae7c-27b2-4305-9444-7185ced9d51f',
],
],
[
'name' => 'JobGroupNameQuery',
'in' => 'query',
'schema' => [
'description' => '作业组名字',
'type' => 'string',
'required' => false,
'example' => '国寿财住院保续保_20220301_134130',
],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '作业ID',
'type' => 'string',
'required' => false,
'example' => '11994321-e6bc-47bb-8b1c-8eef8f2f768b',
],
],
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => [
'description' => '被叫号码',
'type' => 'string',
'required' => false,
'example' => '15126426342',
],
],
[
'name' => 'UserIdMatch',
'in' => 'query',
'schema' => [
'description' => '用户ID,用户的唯一标识符号'."\n"
."\n"
.'> 该字段是在上传外呼名单时传入的。'."\n"
.'> - 若是通过json上传则用户ID为referenceId的值'."\n"
.'> - 若是通过excel文件上传外呼名单则用户ID为contactId的值',
'type' => 'string',
'required' => false,
'example' => 'C01',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID',
'type' => 'string',
'required' => false,
'example' => '744b27f3-437f-4a8c-a181-f668e492fd24',
],
],
[
'name' => 'ActualTimeGte',
'in' => 'query',
'schema' => [
'description' => '通话开始时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1646582400000',
],
],
[
'name' => 'ActualTimeLte',
'in' => 'query',
'schema' => [
'description' => '通话结束时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1643126399000',
],
],
[
'name' => 'RecordingDurationGte',
'in' => 'query',
'schema' => [
'description' => '振铃搜索最小时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
[
'name' => 'RecordingDurationLte',
'in' => 'query',
'schema' => [
'description' => '振铃搜索最小时间',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '60',
],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => [
'description' => '页号'."\n"
."\n"
.'> 此接口页号默认从0开始',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '个数'."\n"
."\n"
.'> 当该参数为空时,值默认为10',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'name' => 'OtherId',
'in' => 'query',
'schema' => [
'description' => '其他id'."\n"
."\n"
.'**包括以下:**'."\n"
."\n"
.'- sessionID'."\n"
."\n"
.'- taskid'."\n"
."\n"
.'- jobid',
'type' => 'string',
'required' => false,
'example' => 'AVD-2021-39685',
],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => [
'description' => '排序方式,默认为actualTime',
'type' => 'string',
'required' => false,
'example' => 'actualTime',
],
],
[
'name' => 'SortOrder',
'in' => 'query',
'schema' => [
'description' => '排序顺序。取值范围:'."\n"
."\n"
.'- asc(升序)'."\n"
."\n"
.'- desc(默认值):降序',
'type' => 'string',
'required' => false,
'example' => 'desc',
],
],
[
'name' => 'CallDurationGte',
'in' => 'query',
'schema' => [
'description' => '通话时长搜索最小时间,单位毫秒',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12341155',
],
],
[
'name' => 'CallDurationLte',
'in' => 'query',
'schema' => [
'description' => '通话时长搜索最大时间,单位毫秒',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12341155',
],
],
[
'name' => 'JobStatusStringList',
'in' => 'query',
'schema' => [
'description' => '作业状态,多个以英文逗号分隔,当该字段不为空时,会将jobStatusList覆盖'."\n"
."\n"
.'- Scheduling:调度中。'."\n"
.'- Executing:执行中。'."\n"
.'- Succeeded:结束-已触达。'."\n"
.'- Paused:已停止。'."\n"
.'- Failed:结束-未触达。'."\n"
.'- Cancelled:已取消。',
'type' => 'string',
'required' => false,
'example' => 'Succeeded',
],
],
[
'name' => 'TaskStatusStringList',
'in' => 'query',
'schema' => [
'description' => '通话状态,多个以英文逗号分隔,'."\n"
.'取值范围'."\n"
.'(注:**Succeeded**状态已细分原因,不会展示**Succeeded**:1(已接通)状态,之后返回均为具体细分原因类型。)'."\n"
."\n"
.'- **Executing**:0(正在拨打)。'."\n"
.'- **Succeeded**:1(已接通)。'."\n"
.'- **NoAnswer**:2(未接通-无人接听)。'."\n"
.'- **NotExist**:3(未接通-空号)。'."\n"
.'- **Busy**:4(未接通-占线)。'."\n"
.'- **Cancelled**:5(未呼出-任务停止)。'."\n"
.'- **Failed**:6(失败)。'."\n"
.'- **NotConnected**:7(未接通-无法接通)。'."\n"
.'- **PoweredOff**:8(未接通-关机)。'."\n"
.'- **OutOfService**:9(未接通-被叫停机)。'."\n"
.'- **InArrears**:10(未接通-被叫欠费)。'."\n"
.'- **EmptyNumber**:11(未呼出-空号不外呼)。'."\n"
.'- **PerDayCallCountLimit**:12(未呼出-超出每日上限)。'."\n"
.'- **ContactBlockList**:13(未呼出-黑名单)。'."\n"
.'- **CallerNotRegistered**:14(未呼出-主叫号码未注册)。'."\n"
.'- **Terminated**:15(未呼出-被终止)。'."\n"
.'- **VerificationCancelled**:16(未呼出-呼叫前验证不通过取消)。'."\n"
.'- **OutOfServiceNoCall**:17(未呼出-被叫停机不外呼)。'."\n"
.'- **InArrearsNoCall**:18(未呼出-被叫欠费不外呼)。'."\n"
.'- **CallingNumberNotExist**:19(未呼出-主叫号码不存在)。'."\n"
.'- **SucceededFinish**:20(已接通-正常完结)。'."\n"
.'- **SucceededChatbotHangUpAfterNoAnswer**:21(已接通-拒识后机器人挂机)。'."\n"
.'- **SucceededChatbotHangUpAfterSilence**:22(已接通-静默超时挂机)。'."\n"
.'- **SucceededClientHangUpAfterNoAnswer**:23(已接通-拒识后用户挂机)。'."\n"
.'- **SucceededClientHangUp**:24(已接通-用户无理由挂机)。'."\n"
.'- **SucceededTransferByIntent**:25(已接通-命中意图转人工)。'."\n"
.'- **SucceededTransferAfterNoAnswer**:26(已接通-拒识转人工)。'."\n"
.'- **SucceededInoInterAction**:27(已接通-用户侧无交互)。'."\n"
.'- **SucceededError**:28(已接通-系统异常中断)。'."\n"
.'- **SucceededSpecialInterceptVoiceAssistant**:29(已接通-特殊情况拦截-语音助手)。'."\n"
.'- **SucceededSpecialInterceptExtensionNumberTransfer**:30(已接通-特殊情况拦截-分机号转接)。'."\n"
.'- **SucceededSpecialInterceptCustomSpecialIntercept**:31(已接通-特殊情况拦截-自定义拦截)。'."\n"
.'- **HighRiskSipCode**:32(未呼出-高风险不外呼)',
'type' => 'string',
'required' => false,
'example' => 'Executing',
],
],
[
'name' => 'ScriptNameQuery',
'in' => 'query',
'schema' => [
'description' => '场景名称',
'type' => 'string',
'required' => false,
'example' => '国寿财',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => [
'description' => '主叫号码',
'type' => 'string',
'required' => false,
'example' => '051085500215',
],
],
[
'name' => 'LabelsJson',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '通话对应标签筛选条件'."\n"
."\n"
.'>该条件只能通过配置了具体枚举标签值的标签进行筛选,也就是在大模型场景中配置了具体标签值的标签。',
'type' => 'array',
'items' => [
'description' => '需要筛选的标签以及对应标签值。'."\n"
."\n"
.'> 筛选出所有通话中特定标签以及对应的特定标签值。'."\n"
.'如:{"ValueList":["满意","不满意"],"Name":"是否满意"},表示筛选出所有通话中“是否满意”标签对应的标签值为“满意”以及“不满意”的通话信息',
'type' => 'string',
'required' => false,
'example' => '{'."\n"
.' "ValueList": ['."\n"
.' "满意",'."\n"
.' "不满意"'."\n"
.' ],'."\n"
.' "Name": "是否满意"'."\n"
.' }',
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'PageIndex' => [
'description' => '页号',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '请求状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'PageSize' => [
'description' => '个数',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Total' => [
'description' => '总计个数',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'SearchTaskInfoList' => [
'description' => '任务列表',
'type' => 'array',
'items' => [
'description' => '任务列表',
'type' => 'object',
'properties' => [
'JobGroupName' => [
'description' => '作业组名字',
'type' => 'string',
'example' => '85成新(有笔记划线)2021_11_14_18_00_51',
],
'UserId' => [
'description' => '用户ID',
'type' => 'string',
'example' => '12334134',
],
'ActualTime' => [
'description' => '实际执行时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1643436089677',
],
'CalledNumber' => [
'description' => '被叫号码',
'type' => 'string',
'example' => '15205879599',
],
'TaskStatusString' => [
'description' => '任务状态'."\n"
.'取值范围'."\n"
.'(注:**Succeeded**状态已细分原因,不会展示**Succeeded**:1(已接通)状态,之后返回均为具体细分原因类型。)'."\n"
."\n"
.'- **Executing**:0(正在拨打)。'."\n"
.'- **Succeeded**:1(已接通)。'."\n"
.'- **NoAnswer**:2(未接通-无人接听)。'."\n"
.'- **NotExist**:3(未接通-空号)。'."\n"
.'- **Busy**:4(未接通-占线)。'."\n"
.'- **Cancelled**:5(未呼出-任务停止)。'."\n"
.'- **Failed**:6(失败)。'."\n"
.'- **NotConnected**:7(未接通-无法接通)。'."\n"
.'- **PoweredOff**:8(未接通-关机)。'."\n"
.'- **OutOfService**:9(未接通-被叫停机)。'."\n"
.'- **InArrears**:10(未接通-被叫欠费)。'."\n"
.'- **EmptyNumber**:11(未呼出-空号不外呼)。'."\n"
.'- **PerDayCallCountLimit**:12(未呼出-超出每日上限)。'."\n"
.'- **ContactBlockList**:13(未呼出-黑名单)。'."\n"
.'- **CallerNotRegistered**:14(未呼出-主叫号码未注册)。'."\n"
.'- **Terminated**:15(未呼出-被终止)。'."\n"
.'- **VerificationCancelled**:16(未呼出-呼叫前验证不通过取消)。'."\n"
.'- **OutOfServiceNoCall**:17(未呼出-被叫停机不外呼)。'."\n"
.'- **InArrearsNoCall**:18(未呼出-被叫欠费不外呼)。'."\n"
.'- **CallingNumberNotExist**:19(未呼出-主叫号码不存在)。'."\n"
.'- **SucceededFinish**:20(已接通-正常完结)。'."\n"
.'- **SucceededChatbotHangUpAfterNoAnswer**:21(已接通-拒识后机器人挂机)。'."\n"
.'- **SucceededChatbotHangUpAfterSilence**:22(已接通-静默超时挂机)。'."\n"
.'- **SucceededClientHangUpAfterNoAnswer**:23(已接通-拒识后用户挂机)。'."\n"
.'- **SucceededClientHangUp**:24(已接通-用户无理由挂机)。'."\n"
.'- **SucceededTransferByIntent**:25(已接通-命中意图转人工)。'."\n"
.'- **SucceededTransferAfterNoAnswer**:26(已接通-拒识转人工)。'."\n"
.'- **SucceededInoInterAction**:27(已接通-用户侧无交互)。'."\n"
.'- **SucceededError**:28(已接通-系统异常中断)。'."\n"
.'- **SucceededSpecialInterceptVoiceAssistant**:29(已接通-特殊情况拦截-语音助手)。'."\n"
.'- **SucceededSpecialInterceptExtensionNumberTransfer**:30(已接通-特殊情况拦截-分机号转接)。'."\n"
.'- **SucceededSpecialInterceptCustomSpecialIntercept**:31(已接通-特殊情况拦截-自定义拦截)。'."\n"
.'- **HighRiskSipCode**:32(未呼出-高风险不外呼)。',
'type' => 'string',
'example' => 'Executing',
],
'TaskStatusName' => [
'description' => '通话状态展示内容'."\n"
.'取值范围'."\n"
.'(注:**Succeeded**状态已细分原因,不会展示**Succeeded**:1(已接通)状态,之后返回均为具体细分原因类型。)'."\n"
."\n"
.'- **Executing**:0(正在拨打)。'."\n"
.'- **Succeeded**:1(已接通)。'."\n"
.'- **NoAnswer**:2(未接通-无人接听)。'."\n"
.'- **NotExist**:3(未接通-空号)。'."\n"
.'- **Busy**:4(未接通-占线)。'."\n"
.'- **Cancelled**:5(未呼出-任务停止)。'."\n"
.'- **Failed**:6(失败)。'."\n"
.'- **NotConnected**:7(未接通-无法接通)。'."\n"
.'- **PoweredOff**:8(未接通-关机)。'."\n"
.'- **OutOfService**:9(未接通-被叫停机)。'."\n"
.'- **InArrears**:10(未接通-被叫欠费)。'."\n"
.'- **EmptyNumber**:11(未呼出-空号不外呼)。'."\n"
.'- **PerDayCallCountLimit**:12(未呼出-超出每日上限)。'."\n"
.'- **ContactBlockList**:13(未呼出-黑名单)。'."\n"
.'- **CallerNotRegistered**:14(未呼出-主叫号码未注册)。'."\n"
.'- **Terminated**:15(未呼出-被终止)。'."\n"
.'- **VerificationCancelled**:16(未呼出-呼叫前验证不通过取消)。'."\n"
.'- **OutOfServiceNoCall**:17(未呼出-被叫停机不外呼)。'."\n"
.'- **InArrearsNoCall**:18(未呼出-被叫欠费不外呼)。'."\n"
.'- **CallingNumberNotExist**:19(未呼出-主叫号码不存在)。'."\n"
.'- **SucceededFinish**:20(已接通-正常完结)。'."\n"
.'- **SucceededChatbotHangUpAfterNoAnswer**:21(已接通-拒识后机器人挂机)。'."\n"
.'- **SucceededChatbotHangUpAfterSilence**:22(已接通-静默超时挂机)。'."\n"
.'- **SucceededClientHangUpAfterNoAnswer**:23(已接通-拒识后用户挂机)。'."\n"
.'- **SucceededClientHangUp**:24(已接通-用户无理由挂机)。'."\n"
.'- **SucceededTransferByIntent**:25(已接通-命中意图转人工)。'."\n"
.'- **SucceededTransferAfterNoAnswer**:26(已接通-拒识转人工)。'."\n"
.'- **SucceededInoInterAction**:27(已接通-用户侧无交互)。'."\n"
.'- **SucceededError**:28(已接通-系统异常中断)。'."\n"
.'- **SucceededSpecialInterceptVoiceAssistant**:29(已接通-特殊情况拦截-语音助手)。'."\n"
.'- **SucceededSpecialInterceptExtensionNumberTransfer**:30(已接通-特殊情况拦截-分机号转接)。',
'type' => 'string',
'example' => '正在拨打',
],
'JobStatus' => [
'description' => '作业状态'."\n"
."\n\n"
."\n"
.'- 0:调度中(Scheduling)'."\n"
.'- 1:执行中(Executing)'."\n"
.'- 2:结束-已触达(Succeeded)'."\n"
.'- 3:已停止(Paused)'."\n"
.'- 4:未接通-占线(Failed)'."\n"
.'- 5:已取消(Cancelled)',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'DialException' => [
'description' => '异常情况',
'type' => 'string',
'example' => '[{"code":"OutboundCallError.SipCodeError", "params":[{"key":"SipCode","value":"500"}]}]',
],
'UserName' => [
'description' => '用户名',
'type' => 'string',
'example' => 'xxx',
],
'CallDurationDisplay' => [
'description' => '通话时长',
'type' => 'string',
'example' => '47″',
],
'HasAnswered' => [
'description' => '有无应答',
'type' => 'boolean',
'example' => 'true',
],
'JobStatusName' => [
'description' => '作业状态展示内容'."\n"
."\n"
.'- 0:调度中(Scheduling)'."\n"
.'- 1:执行中(Executing)'."\n"
.'- 2:结束-已触达(Succeeded)'."\n"
.'- 3:已停止(Paused)'."\n"
.'- 4:未接通-占线(Failed)'."\n"
.'- 5:已取消(Cancelled)',
'type' => 'string',
'example' => '调度中',
],
'CallDuration' => [
'description' => '通话时长,单位毫秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '46000',
],
'TaskCreateTime' => [
'description' => '任务创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1646792941',
],
'JobStatusString' => [
'description' => '任务状态'."\n"
."\n"
.'- Scheduling:调度中(0)'."\n"
.'- Executing:执行中(1)'."\n"
.'- Succeeded:结束-已触达(2)'."\n"
.'- Paused:已停止(3)'."\n"
.'- Failed:未接通-占线(4)'."\n"
.'- Cancelled:已取消(5)',
'type' => 'string',
'example' => 'Scheduling',
],
'HasReachedEndOfFlow' => [
'description' => '对话完成',
'type' => 'boolean',
'example' => 'true',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => '73df6283-26b2-402d-bad0-ffa489923ea1',
],
'HasHangUpByRejection' => [
'description' => '拒识挂机',
'type' => 'boolean',
'example' => 'true',
],
'TaskEndReason' => [
'description' => '任务结束原因'."\n"
."\n"
.'- FINISHED(1,"正常完结"),'."\n"
."\n"
.'- CHATBOT_HANGUP_AFTER_NOANSWER(2, "拒识后机器人挂机"),'."\n"
.'- CHATBOT_HANGUP_AFTER_SILENCE(3, "静默超时挂机"),'."\n"
.'- CLIENT_HANGUP_AFTER_NOANSWER(4, "拒识后用户挂机"),'."\n"
.'- CLIENT_HANGUP(5, "用户无理由挂机"),'."\n"
.'- TRANSFER_BY_INTENT(6, "命中意图转人工"),'."\n"
.'- TRANSFER_AFTER_NOANSWER(7, "拒识转人工"),'."\n"
.'- INO_INTERACTION(8, "用户侧无交互"),'."\n"
.'- ERROR(9, "系统异常中断"),'."\n"
."\n"
.'- SPECIAL_INTERCEPT_VOICE_ASSISTANT(10, "特殊情况拦截-语音助手"),'."\n"
.'- SPECIAL_INTERCEPT_EXTENSION_NUMBER_TRANSFER(11, "特殊情况拦截-分机号转接"),'."\n"
.';',
'type' => 'integer',
'format' => 'int32',
'example' => 'OutOfService',
],
'JobGroupId' => [
'description' => '作业组ID',
'type' => 'string',
'example' => '37db3113-ad34-4ba3-b930-468f016bbf95',
],
'TaskStatus' => [
'description' => '取值范围'."\n"
.'(注:**Succeeded**状态已细分原因,不会展示**Succeeded**:1(已接通)状态,之后返回均为具体细分原因类型。)'."\n"
."\n"
.'- **Executing**:0(正在拨打)。'."\n"
.'- **Succeeded**:1(已接通)。'."\n"
.'- **NoAnswer**:2(未接通-无人接听)。'."\n"
.'- **NotExist**:3(未接通-空号)。'."\n"
.'- **Busy**:4(未接通-占线)。'."\n"
.'- **Cancelled**:5(未呼出-任务停止)。'."\n"
.'- **Failed**:6(失败)。'."\n"
.'- **NotConnected**:7(未接通-无法接通)。'."\n"
.'- **PoweredOff**:8(未接通-关机)。'."\n"
.'- **OutOfService**:9(未接通-被叫停机)。'."\n"
.'- **InArrears**:10(未接通-被叫欠费)。'."\n"
.'- **EmptyNumber**:11(未呼出-空号不外呼)。'."\n"
.'- **PerDayCallCountLimit**:12(未呼出-超出每日上限)。'."\n"
.'- **ContactBlockList**:13(未呼出-黑名单)。'."\n"
.'- **CallerNotRegistered**:14(未呼出-主叫号码未注册)。'."\n"
.'- **Terminated**:15(未呼出-被终止)。'."\n"
.'- **VerificationCancelled**:16(未呼出-呼叫前验证不通过取消)。'."\n"
.'- **OutOfServiceNoCall**:17(未呼出-被叫停机不外呼)。'."\n"
.'- **InArrearsNoCall**:18(未呼出-被叫欠费不外呼)。'."\n"
.'- **CallingNumberNotExist**:19(未呼出-主叫号码不存在)。'."\n"
.'- **SucceededFinish**:20(已接通-正常完结)。'."\n"
.'- **SucceededChatbotHangUpAfterNoAnswer**:21(已接通-拒识后机器人挂机)。'."\n"
.'- **SucceededChatbotHangUpAfterSilence**:22(已接通-静默超时挂机)。'."\n"
.'- **SucceededClientHangUpAfterNoAnswer**:23(已接通-拒识后用户挂机)。'."\n"
.'- **SucceededClientHangUp**:24(已接通-用户无理由挂机)。'."\n"
.'- **SucceededTransferByIntent**:25(已接通-命中意图转人工)。'."\n"
.'- **SucceededTransferAfterNoAnswer**:26(已接通-拒识转人工)。'."\n"
.'- **SucceededInoInterAction**:27(已接通-用户侧无交互)。'."\n"
.'- **SucceededError**:28(已接通-系统异常中断)。'."\n"
.'- **SucceededSpecialInterceptVoiceAssistant**:29(已接通-特殊情况拦截-语音助手)。'."\n"
.'- **SucceededSpecialInterceptExtensionNumberTransfer**:30(已接通-特殊情况拦截-分机号转接)。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'JobId' => [
'description' => '作业ID',
'type' => 'string',
'example' => '6203248e-e652-4ef8-a1eb-586ed7b54dc2',
],
'RecordingDuration' => [
'description' => '振玲时长,单位秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TaskId' => [
'description' => '任务ID',
'type' => 'string',
'example' => '479aea04-3a92-4ac3-935d-c8798c667850',
],
'DialExceptionOld' => [
'description' => '异常情况',
'type' => 'string',
'example' => '["OutboundCallError.SipTrunkError"]',
],
'DialExceptionCodes' => [
'description' => '备注信息页面展示使用字段',
'type' => 'array',
'items' => [
'description' => '接口异常码列表',
'type' => 'string',
'example' => '[ { "code":"OutboundCallError.SipCodeError", "hint":"线路侧异常码:480, 首先确定主叫和被叫正确,其次再联系号码和线路的供应商处理!" } ]',
],
],
'HasLastPlaybackCompleted' => [
'description' => '挂断时最后一句是否播报完成',
'type' => 'boolean',
'example' => 'true',
],
'ScriptName' => [
'description' => '场景名称',
'type' => 'string',
'example' => '慢病线索',
],
'CallingNumber' => [
'description' => '主叫号码',
'type' => 'string',
'example' => '02152739269',
],
'Labels' => [
'description' => '当前外呼通话的标签命中情况',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'K' => [
'description' => '标签名称',
'type' => 'string',
'example' => '是否满意',
],
'V' => [
'description' => '命中的标签值',
'type' => 'string',
'example' => '是',
],
],
'description' => '',
],
],
],
],
'example' => '[]',
],
'VariableNames' => [
'description' => '标签名称key的全集',
'type' => 'array',
'items' => [
'description' => '标签key全集',
'type' => 'string',
'example' => '["是否满意","是否是本人","是否收到"]',
],
],
'Labels' => [
'description' => '可做筛选条件的标签信息。'."\n"
."\n"
.'> 显示该任务组中所有具有枚举值的标签信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '标签名称',
'type' => 'string',
'example' => '是否满意',
],
'ValueList' => [
'description' => '标签值列表',
'type' => 'array',
'items' => [
'description' => '标签值',
'type' => 'string',
'example' => '["否","是"]',
],
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"PageIndex\\": 0,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"PageSize\\": 10,\\n \\"Total\\": 2,\\n \\"SearchTaskInfoList\\": [\\n {\\n \\"JobGroupName\\": \\"85成新(有笔记划线)2021_11_14_18_00_51\\",\\n \\"UserId\\": \\"12334134\\",\\n \\"ActualTime\\": 1643436089677,\\n \\"CalledNumber\\": \\"15205879599\\",\\n \\"TaskStatusString\\": \\"Executing\\",\\n \\"TaskStatusName\\": \\"正在拨打\\",\\n \\"JobStatus\\": 0,\\n \\"DialException\\": \\"[{\\\\\\"code\\\\\\":\\\\\\"OutboundCallError.SipCodeError\\\\\\", \\\\\\"params\\\\\\":[{\\\\\\"key\\\\\\":\\\\\\"SipCode\\\\\\",\\\\\\"value\\\\\\":\\\\\\"500\\\\\\"}]}]\\",\\n \\"UserName\\": \\"xxx\\",\\n \\"CallDurationDisplay\\": \\"47″\\",\\n \\"HasAnswered\\": true,\\n \\"JobStatusName\\": \\"调度中\\",\\n \\"CallDuration\\": 46000,\\n \\"TaskCreateTime\\": 1646792941,\\n \\"JobStatusString\\": \\"Scheduling\\",\\n \\"HasReachedEndOfFlow\\": true,\\n \\"InstanceId\\": \\"73df6283-26b2-402d-bad0-ffa489923ea1\\",\\n \\"HasHangUpByRejection\\": true,\\n \\"TaskEndReason\\": 0,\\n \\"JobGroupId\\": \\"37db3113-ad34-4ba3-b930-468f016bbf95\\",\\n \\"TaskStatus\\": 0,\\n \\"JobId\\": \\"6203248e-e652-4ef8-a1eb-586ed7b54dc2\\",\\n \\"RecordingDuration\\": 10,\\n \\"TaskId\\": \\"479aea04-3a92-4ac3-935d-c8798c667850\\",\\n \\"DialExceptionOld\\": \\"[\\\\\\"OutboundCallError.SipTrunkError\\\\\\"]\\",\\n \\"DialExceptionCodes\\": [\\n \\"[\\\\t\\\\t\\\\t\\\\t\\\\t{\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"code\\\\\\":\\\\\\"OutboundCallError.SipCodeError\\\\\\",\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"hint\\\\\\":\\\\\\"线路侧异常码:480, 首先确定主叫和被叫正确,其次再联系号码和线路的供应商处理!\\\\\\"\\\\t\\\\t\\\\t}\\\\t\\\\t\\\\t\\\\t]\\"\\n ],\\n \\"HasLastPlaybackCompleted\\": true,\\n \\"ScriptName\\": \\"慢病线索\\",\\n \\"CallingNumber\\": \\"02152739269\\",\\n \\"Labels\\": [\\n {\\n \\"K\\": \\"是否满意\\",\\n \\"V\\": \\"是\\"\\n }\\n ]\\n }\\n ],\\n \\"VariableNames\\": [\\n \\"[\\\\\\"是否满意\\\\\\",\\\\\\"是否是本人\\\\\\",\\\\\\"是否收到\\\\\\"]\\"\\n ],\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"是否满意\\",\\n \\"ValueList\\": [\\n \\"[\\\\\\"否\\\\\\",\\\\\\"是\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => '搜索任务',
'changeSet' => [
[
'createdAt' => '2025-09-10T13:09:37.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2025-07-14T12:16:13.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
[
'createdAt' => '2021-11-24T13:03:33.000Z',
'description' => 'OpenAPI 下线',
],
[
'createdAt' => '2021-11-24T13:03:33.000Z',
'description' => '请求参数发生变更、响应参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:SearchTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'StartJob' => [
'summary' => '不经过外呼调度系统直接发起呼叫。该接口只针对白名单用户开放。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'da37319b-6c83-4268-9f19-814aed62e401',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID',
'type' => 'string',
'required' => false,
'example' => '4f21446e-324e-46f2-bf62-7f341fb004ea',
],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => [
'description' => '场景ID,为了兼容旧版外呼功能。可不填。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'JobJson',
'in' => 'query',
'schema' => [
'description' => '作业数据,包含以下内容'."\n"
.' '."\n"
.'extras //额外信息,非必填'."\n"
.'- key //自定义变量内容 key'."\n"
.'- value //自定义变量内容 value'."\n"
."\n"
.'contacts // 必填字段,被叫人联系信息'."\n"
.'- phoneNumber // 必填字段,被叫人电话号码 '."\n"
.'- referenceId // 必填字段,联系人 ID(用户自定义),主要是避免重名现象'."\n"
.'- role //非必填字段,该联系人在此外呼业务中的角色,不指定则不区分'."\n"
.'- honorific //非必填字段,联系人尊称'."\n"
.'- name //非必填字段,联系人姓名',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{'."\n"
.' "extras": [{'."\n"
.' "value": "测试",'."\n"
.' "key": "测试"'."\n"
.' }, {'."\n"
.' "key": "ServiceId",'."\n"
.' "value": null'."\n"
.' }, {'."\n"
.' "key": "TenantId",'."\n"
.' "value": null'."\n"
.' }],'."\n"
.' "contacts": [{'."\n"
.' "phonenumber": "198********",'."\n"
.' "name": "张三",'."\n"
.' "priority": 5,'."\n"
.' "referenceId": "C01"'."\n"
.' }]'."\n"
.'}',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '场景ID(必填)',
'type' => 'string',
'required' => false,
'example' => '1eeae263-54ca-4a52-ae14-62da58f3c473',
],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '主叫号码列表',
'type' => 'array',
'items' => [
'description' => '主叫号码',
'type' => 'string',
'required' => false,
'example' => '05710*******',
],
'required' => false,
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '8a621aa1-d2e7-43f3-b54d-8830af73c468',
],
'Success' => [
'description' => '表示是否调用成功。true:调用成功。 false:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
'TaskIds' => [
'description' => '联系人第三方id和外呼系统任务id的映射',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '联系人第三方id',
'type' => 'string',
'example' => 'c93cdd1c-f9b5-4758-be43-7a237a7eaa1d',
],
'Value' => [
'description' => '外呼系统任务id',
'type' => 'string',
'example' => '62229628-45d8-41bd-a80f-6e4c0a39f79b',
],
],
'description' => '',
],
],
'CallIds' => [
'description' => '通话ID列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '联系人第三方id。',
'type' => 'string',
'example' => 'c93cdd1c-f9b5-4758-be43-7a237a7eaa1d',
],
'Value' => [
'description' => '任务的Callid',
'type' => 'string',
'example' => '62229628-45d8-41bd-a80f-6e4c0a39f79b',
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.JobGroup',
'errorMessage' => 'The specified JobGroup does not exist.',
'description' => '指定的任务组不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"8a621aa1-d2e7-43f3-b54d-8830af73c468\\",\\n \\"Success\\": true,\\n \\"TaskIds\\": [\\n {\\n \\"Key\\": \\"c93cdd1c-f9b5-4758-be43-7a237a7eaa1d\\",\\n \\"Value\\": \\"62229628-45d8-41bd-a80f-6e4c0a39f79b\\"\\n }\\n ],\\n \\"CallIds\\": [\\n {\\n \\"Key\\": \\"c93cdd1c-f9b5-4758-be43-7a237a7eaa1d\\",\\n \\"Value\\": \\"62229628-45d8-41bd-a80f-6e4c0a39f79b\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '创建一个作业',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:StartJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'SubmitBatchJobs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '6b3ea2a1-32b3-4041-842b-9bde5de9dda0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.JobGroup',
'errorMessage' => 'The specified JobGroup does not exist.',
'description' => '指定的任务组不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '将草稿状态的作业组提交执行-已废弃',
'summary' => '将草稿状态的作业组提交执行,已废弃。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:SubmitBatchJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'SubmitRecording' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503',
],
],
[
'name' => 'ResourceRecording',
'in' => 'query',
'schema' => [
'description' => '话术录音数据',
'type' => 'string',
'required' => false,
'example' => '{"contactId":"3d35c0487cc041abb7ad0ce61752601f","duration":27,"fileName":"ce2659e5-a20b-4f8e-91b5-5cd909c6b96e_3d35c0487cc041abb7ad0ce61752601f.wav","filePath":"oss://ForCompatibility/waveforms/","startTime":1579057583670,"type":"Source"}',
],
],
[
'name' => 'MergedRecording',
'in' => 'query',
'schema' => [
'description' => '话术录音数据',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{"contactId":"3d35c0487cc041abb7ad0ce61752601f","duration":27,"fileName":"ce2659e5-a20b-4f8e-91b5-5cd909c6b96e_3d35c0487cc041abb7ad0ce61752601f.wav","filePath":"oss://ForCompatibility/waveforms/","startTime":1579057583670,"type":"Merged"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'Http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息。',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功。',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '向外呼提交通话录音-已废弃',
'summary' => '向外呼提交通话录音,已废弃。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:SubmitRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'SubmitScriptReview' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'af81a389-91f0-4157-8d82-720edd02b66a',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '描述',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '第一版本提交审核',
],
],
[
'name' => 'From',
'in' => 'query',
'schema' => [
'description' => '提交审核来源',
'type' => 'string',
'required' => false,
'example' => 'MAINSITE',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'Http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n OK\\n 200\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n","errorExample":""}]',
'title' => '提交场景发布审核',
'summary' => '提交场景发布审核。',
'changeSet' => [
[
'createdAt' => '2023-06-20T12:50:03.000Z',
'description' => '请求参数发生变更、错误码发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SubmitScriptReview',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'SuspendCall' => [
'summary' => '根据列表数据止呼。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID(必填)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'a5fc6490-ef1e-4666-870a-07a4e586c414',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID(必填)',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'f745881b-343d-43e4-9c51-31b7b063031c',
],
],
[
'name' => 'CalledNumbers',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '被叫号码列表',
'type' => 'array',
'items' => [
'description' => '被叫号码列表',
'type' => 'string',
'required' => false,
'example' => '15107137208',
],
'required' => false,
'example' => '[]',
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '根据列表数据止呼',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:23.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:SuspendCall',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'SuspendCallWithFile' => [
'summary' => '根据文件数据止呼。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREoutboundbot7ZIYMY',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID(必填)',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => [
'description' => '任务组ID(必填)',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '0197261b-30e6-467b-83d6-7f72af868b03',
],
],
[
'name' => 'FilePath',
'in' => 'query',
'schema' => [
'description' => '文件路径( 必填)'."\n"
."\n"
.'> 该参数的值通过调用GetJobDataUploadParams接口上传文件,获取到Folder返回参数,传入到FilePath中',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'xxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '根据文件数据止呼',
'changeSet' => [
[
'createdAt' => '2025-07-30T08:33:24.000Z',
'description' => '请求参数发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:SuspendCallWithFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'SuspendJobs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例 ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ef4c09ac-2f5c-49e7-9d33-5d85249cee10',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => [
'description' => '过滤条件,是否暂停所有',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'example' => 'false',
],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => [
'description' => '过滤条件,场景ID(历史参数,已废弃)',
'type' => 'string',
'required' => false,
'example' => '4b6dd926-3cc3-4111-a333-15d9b006fe81',
],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => [
'description' => '过滤条件,任务组ID',
'type' => 'string',
'required' => false,
'example' => '6b3ea2a1-32b3-4041-842b-9bde5de9dda0',
],
],
[
'name' => 'JobId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '作业ID列表'."\n"
."\n"
.'> 当ALL为fasle时,JobId为必填',
'type' => 'array',
'items' => [
'description' => '作业ID',
'type' => 'string',
'required' => false,
'example' => '11994321-e6bc-47bb-8b1c-8eef8f2f768b',
],
'required' => false,
'maxItems' => 99,
],
],
[
'name' => 'JobReferenceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '作业的第三方ID。'."\n"
."\n"
.'> 即为上传外呼名单时客户上传的ReferenceId',
'type' => 'array',
'items' => [
'description' => '作业的第三方id',
'type' => 'string',
'required' => false,
'example' => 'de3ab269-6746-477c-b13d-bd49f13202c2',
],
'required' => false,
'maxItems' => 99,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '1364f208-982d-4d0c-89aa-d56e22b47589',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.JobGroup',
'errorMessage' => 'The specified JobGroup does not exist.',
'description' => '指定的任务组不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"1364f208-982d-4d0c-89aa-d56e22b47589\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '暂停作业',
'summary' => '暂停作业。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:SuspendJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'TagResources' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '已废弃',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-shanghai',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [
'INSTANCE' => 'INSTANCE',
],
'example' => 'INSTANCE',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源ID列表,n 的取值范围为 [1, 50]',
'type' => 'array',
'items' => [
'description' => '资源ID,资源类型是INSTANCE时传入实例ID',
'type' => 'string',
'required' => false,
'example' => '254EB005-EEDF-48A4-9101-9CA5B72FFBCC',
],
'required' => true,
'example' => 'ResourceId.1=b949ae1f-01dc-4191-ae5a-70fbe6772fd8',
'maxItems' => 51,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。'."\n"
.'当key和value与已存标签不同时,会新建标签。'."\n"
.'> 可通过ListResourceTags接口获取到实例标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键,n 的取值范围为 [1, 20]。',
'type' => 'string',
'required' => false,
'example' => 'Tag.1.Key=key1',
],
'Value' => [
'description' => '标签值,n 的取值范围为 [1, 20]。',
'type' => 'string',
'required' => false,
'example' => 'Tag.1.Value=value1',
],
],
'required' => false,
'description' => '',
],
'required' => true,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n","errorExample":""}]',
'title' => '给实例资源打标签',
'summary' => '给实例资源打标签。',
'description' => '**',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
[
'createdAt' => '2024-07-22T12:24:25.000Z',
'description' => '错误码发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:TagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'TaskPreparing' => [
'summary' => '准备执行任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '94182',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '33040b9a-b04b-452f-b554-cd6f3a15f850',
],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '任务id',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'c9e42cd7-ba99-4872-9802-e05719ab051c',
],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => [
'description' => '实例所属账号id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1971226538081821',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示消息',
'type' => 'string',
'example' => 'Succes',
],
'TaskId' => [
'description' => '任务id',
'type' => 'string',
'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Succes\\",\\n \\"TaskId\\": \\"e4e2a770-b97b-465a-80d8-06dca008c503\\"\\n}","type":"json"}]',
'title' => '准备执行任务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:TaskPreparing',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'TerminateCall' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '94183',
'abilityTreeNodes' => [
'FEATUREoutboundbotQHO52V',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd',
],
],
[
'name' => 'CallId',
'in' => 'query',
'schema' => [
'description' => '呼叫ID'."\n"
."\n"
.'> 可通过DescribeJob接口获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1528189846043',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求id',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '终止通话',
'summary' => '通话过程中终止通话。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:TerminateCall',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'UntagResources' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-shanghai',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型,默认为INSTANCE',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [
'INSTANCE' => 'INSTANCE',
],
'example' => 'INSTANCE',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => [
'description' => '是否全部删除,只针对TagKey.N为空时有效。取值范围:'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false'."\n"
."\n"
.'默认是 false',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源ID列表,默认为实例ID列表,n 的取值范围为 1, 50',
'type' => 'array',
'items' => [
'description' => '资源ID,默认为实例ID。',
'type' => 'string',
'required' => false,
'example' => 'ResourceId.1=b949ae1f-01dc-4191-ae5a-70fbe6772fd8',
],
'required' => true,
'maxItems' => 51,
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签键列表,n 的取值范围为 1, 20。',
'type' => 'array',
'items' => [
'description' => '标签键',
'type' => 'string',
'required' => false,
'example' => 'TagKey.1=key1',
],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '接口状态码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n OK\\n Success\\n 254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\n true\\n","errorExample":""}]',
'title' => '删除资源标签',
'summary' => '删除资源标签。',
'changeSet' => [
[
'createdAt' => '2024-07-22T12:24:24.000Z',
'description' => '错误码发生变更',
],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:UntagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'UploadScriptRecording' => [
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '161712',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'example' => 'c209abb3-6804-4a75-b2c7-dd55c8c61b6a',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术ID',
'type' => 'string',
'required' => true,
'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95',
],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => [
'description' => '文件在OSS上面的key',
'type' => 'string',
'required' => true,
'example' => 'cab_script_recording/upload/88a56c18-3dc8-4338-9116-911deb169780/hello.wav',
],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'description' => '文件名称',
'type' => 'string',
'required' => true,
'example' => 'hello.wav',
],
],
[
'name' => 'Content',
'in' => 'query',
'schema' => [
'description' => '录音文件的文本内容',
'type' => 'string',
'required' => true,
'example' => '您好',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'HTTP状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Uuid' => [
'description' => '录音唯一ID',
'type' => 'string',
'example' => '5feaab8a-97fd-4720-8108-79e017f2d3ac',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '返回码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '接口提示信息',
'type' => 'string',
'example' => 'Success',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Uuid\\": \\"5feaab8a-97fd-4720-8108-79e017f2d3ac\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
'title' => '【废弃】上传话术录音',
'summary' => '上传录音文件。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:UploadScriptRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
'WithdrawScriptReview' => [
'summary' => '撤销话术审核。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '94187',
'abilityTreeNodes' => [
'FEATUREoutboundbotN899BL',
],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '38d2e8ed-04e9-4dac-83b5-a8e57642ef13',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => [
'description' => '话术ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => [
'description' => 'Http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Code' => [
'description' => '响应码',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '响应信息',
'type' => 'string',
'example' => 'Success',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC',
],
'Success' => [
'description' => '是否成功',
'type' => 'boolean',
'example' => 'true',
],
'Script' => [
'description' => '话术信息',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '应用版本的状态',
'type' => 'string',
'example' => 'PUBLISHED',
],
'UpdateTime' => [
'description' => '更新时间',
'type' => 'integer',
'format' => 'int64',
'example' => '1578881227000',
],
'Industry' => [
'description' => '行业',
'type' => 'string',
'example' => '金融',
],
'ScriptDescription' => [
'description' => '话术描述',
'type' => 'string',
'example' => '销售话术',
],
'IsDrafted' => [
'description' => '应用版本是否为草稿态',
'type' => 'boolean',
'example' => 'false',
],
'DebugStatus' => [
'description' => '调试状态',
'type' => 'string',
'example' => 'PUBLISHED',
],
'ScriptId' => [
'description' => '话术ID',
'type' => 'string',
'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503',
],
'IsDebugDrafted' => [
'description' => '调试版本是否为草稿态',
'type' => 'boolean',
'example' => 'false',
],
'ScriptName' => [
'description' => '话术名称',
'type' => 'string',
'example' => '销售话术',
],
'Scene' => [
'description' => '场景',
'type' => 'string',
'example' => '电销',
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidScriptName.Duplicated',
'errorMessage' => 'The specified ScriptName already exists.',
'description' => '话术名称已经存在。请您更换一个名字。',
],
],
404 => [
[
'errorCode' => 'NotExist.Instance',
'errorMessage' => 'The specified Instance does not exist.',
'description' => '指定的实例不存在。',
],
[
'errorCode' => 'NotExist.Script',
'errorMessage' => 'The specified Script does not exist.',
'description' => '指定的话术不存在。',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Script\\": {\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"UpdateTime\\": 1578881227000,\\n \\"Industry\\": \\"金融\\",\\n \\"ScriptDescription\\": \\"销售话术\\",\\n \\"IsDrafted\\": false,\\n \\"DebugStatus\\": \\"PUBLISHED\\",\\n \\"ScriptId\\": \\"e4e2a770-b97b-465a-80d8-06dca008c503\\",\\n \\"IsDebugDrafted\\": false,\\n \\"ScriptName\\": \\"销售话术\\",\\n \\"Scene\\": \\"电销\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"OK\\n200\\nf765d3ee-ec03-4765-b235-6877501d99d1\\n\\ntrue","errorExample":""}]',
'title' => '撤销话术审核',
'description' => '****',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:WithdrawScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
],
],
'endpoints' => [
[
'regionId' => 'cn-shanghai',
'regionName' => '华东2(上海)',
'areaId' => 'asiaPacific',
'areaName' => '亚太',
'public' => 'outboundbot.cn-shanghai.aliyuncs.com',
'endpoint' => 'outboundbot.cn-shanghai.aliyuncs.com',
'vpc' => 'outboundbot-vpc.cn-shanghai.aliyuncs.com',
],
],
'errorCodes' => [
[
'code' => 'InternalError',
'message' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.',
'http_code' => 500,
'description' => '内部错误。建议重试,如果多次重试报错请提交工单。',
],
[
'code' => 'InvalidDialogueFlowName.Duplicated',
'message' => 'The specified DialogueFlowName already exists.',
'http_code' => 400,
'description' => '对话流名称已经存在。请您更换一个名字。',
],
[
'code' => 'InvalidGlobalQuestionName.Duplicated',
'message' => 'The specified GlobalQuestionName already exists.',
'http_code' => 400,
'description' => '全局问题名称已经存在。请您更换一个名字。',
],
[
'code' => 'InvalidInstanceName.Duplicated',
'message' => 'The specified InstanceName already exists.',
'http_code' => 400,
'description' => '实例名称已经存在。请您更换一个名字。',
],
[
'code' => 'InvalidIntentName.Duplicated',
'message' => 'The specified IntentName already exists.',
'http_code' => 400,
'description' => '意图名称已经存在。请您更换一个名字。',
],
[
'code' => 'InvalidParameter',
'message' => 'The specified parameter %s is invalid.',
'http_code' => 400,
'description' => '参数值校验不通过。请使用请求参数构造规范化的请求字符串。',
],
[
'code' => 'InvalidScriptName.Duplicated',
'message' => 'The specified ScriptName already exists.',
'http_code' => 400,
'description' => '话术名称已经存在。请您更换一个名字。',
],
[
'code' => 'LimitExceeded.ConcurrentConversation',
'message' => 'The maximum number of concurrent conversations is exceeded.',
'http_code' => 400,
'description' => '并发数已经超限,请重新设置。',
],
[
'code' => 'MissingParameter',
'message' => 'You must specify parameter %s.',
'http_code' => 400,
'description' => '必填参数没有填。请检查调用时是否填写了此参数,并重试请求。',
],
[
'code' => 'NotExist.GlobalQuestion',
'message' => 'The specified GlobalQuestion does not exist in our records.',
'http_code' => 404,
'description' => '指定的全局问题不存在。',
],
[
'code' => 'NotExist.Instance',
'message' => 'The specified Instance does not exist.',
'http_code' => 404,
'description' => '指定的实例不存在。',
],
[
'code' => 'NotExist.Intent',
'message' => 'The specified Intent does not exist.',
'http_code' => 404,
'description' => '指定的意图不存在。',
],
[
'code' => 'NotExist.Job',
'message' => 'The specified Job does not exist.',
'http_code' => 404,
'description' => '指定的任务不存在。',
],
[
'code' => 'NotExist.JobGroup',
'message' => 'The specified JobGroup does not exist.',
'http_code' => 404,
'description' => '指定的任务组不存在。',
],
[
'code' => 'NotExist.Script',
'message' => 'The specified Script does not exist.',
'http_code' => 404,
'description' => '指定的话术不存在。',
],
[
'code' => 'Permission.Instance',
'message' => 'you are not permitted to operate this instance.',
'http_code' => 403,
'description' => '无权限操作该实例',
],
[
'code' => 'Permission.Task',
'message' => 'you are not permitted to operate this task.',
'http_code' => 403,
'description' => '无权限操作该Task。',
],
[
'code' => 'TaskExport.ExceedExportMaxLimit',
'message' => 'exceed export max limit 500000, Please reselect the query conditions.',
'http_code' => 404,
'description' => '数量过大,超过500000条,请重新筛选后下载',
],
],
'changeSet' => [
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'GetTaskByUuid',
],
],
'createdAt' => '2025-11-18T12:12:19.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'ListScripts',
],
],
'createdAt' => '2025-03-26T03:21:13.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'ListJobGroups',
],
],
'createdAt' => '2025-02-15T02:02:51.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '错误码发生变更',
'api' => 'DeleteContactWhiteList',
],
],
'createdAt' => '2025-02-12T12:45:31.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'GetTaskByUuid',
],
],
'createdAt' => '2025-01-22T05:52:05.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'DescribeGroupExecutingInfo',
],
],
'createdAt' => '2024-11-28T14:30:24.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'QueryJobsWithResult',
],
],
'createdAt' => '2024-11-13T14:08:42.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'DescribeTTSDemo',
],
],
'createdAt' => '2024-08-28T12:13:47.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'CreateScript',
],
[
'description' => '响应参数发生变更',
'api' => 'DescribeScript',
],
[
'description' => '请求参数发生变更',
'api' => 'ImportScript',
],
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'ListScripts',
],
[
'description' => '请求参数发生变更',
'api' => 'ModifyScript',
],
],
'createdAt' => '2024-08-06T12:39:58.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '错误码发生变更',
'api' => 'ListJobs',
],
[
'description' => '错误码发生变更',
'api' => 'ListResourceTags',
],
],
'createdAt' => '2024-07-24T07:36:41.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'DescribeJob',
],
[
'description' => '响应参数发生变更',
'api' => 'DescribeJobGroup',
],
],
'createdAt' => '2024-07-22T12:44:47.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '错误码发生变更',
'api' => 'ChangeResourceGroup',
],
],
'createdAt' => '2024-07-22T12:44:05.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'CreateBatchRepeatJob',
],
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'CreateJobGroup',
],
[
'description' => '响应参数发生变更',
'api' => 'DescribeJobGroup',
],
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'ListJobGroups',
],
[
'description' => '响应参数发生变更、错误码发生变更',
'api' => 'ListJobGroupsAsync',
],
[
'description' => '请求参数发生变更',
'api' => 'ModifyJobGroup',
],
],
'createdAt' => '2024-06-24T02:15:06.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'CreateScript',
],
[
'description' => '响应参数发生变更',
'api' => 'DescribeScript',
],
[
'description' => '请求参数发生变更',
'api' => 'ListChatbotInstances',
],
[
'description' => '响应参数发生变更',
'api' => 'ListScripts',
],
[
'description' => '请求参数发生变更',
'api' => 'ModifyScript',
],
],
'createdAt' => '2024-04-25T12:18:08.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'ListInstances',
],
],
'createdAt' => '2024-04-22T12:31:56.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'QueryJobsWithResult',
],
],
'createdAt' => '2024-02-04T14:24:45.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'DescribeTTSDemo',
],
],
'createdAt' => '2024-02-04T14:18:37.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'CreateBatchRepeatJob',
],
[
'description' => '请求参数发生变更',
'api' => 'CreateJobGroup',
],
[
'description' => '响应参数发生变更',
'api' => 'DescribeJobGroup',
],
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'ModifyJobGroup',
],
],
'createdAt' => '2024-01-04T12:35:42.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'QueryJobs',
],
],
'createdAt' => '2023-10-20T07:45:28.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'ListDownloadTasks',
],
],
'createdAt' => '2023-06-20T13:58:00.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '请求参数发生变更、错误码发生变更',
'api' => 'SubmitScriptReview',
],
],
'createdAt' => '2023-06-20T12:51:13.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'DescribeJob',
],
],
'createdAt' => '2023-04-25T13:38:05.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'ListScriptRecording',
],
],
'createdAt' => '2023-03-30T12:41:24.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '响应参数发生变更、响应参数发生变更',
'api' => 'DescribeDialogueNodeStatistics',
],
[
'description' => '响应参数发生变更、响应参数发生变更',
'api' => 'DescribeIntentStatistics',
],
],
'createdAt' => '2023-03-24T08:24:25.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'DescribeTTSDemo',
],
[
'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更',
'api' => 'ModifyTTSConfig',
],
],
'createdAt' => '2023-03-24T08:24:23.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'GetBaseStrategyPeriod',
],
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'SaveBaseStrategyPeriod',
],
],
'createdAt' => '2023-03-24T08:24:08.000Z',
'description' => '',
],
[
'apis' => [
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'CreateScript',
],
],
'createdAt' => '2023-01-09T10:52:38.000Z',
'description' => '屏蔽参数MiniPlaybackConfigListJsonString',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'Dialogue',
],
],
'createdAt' => '2022-12-29T14:17:32.000Z',
'description' => '发布录音管理功能',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'CreateInstance',
],
[
'description' => '请求参数发生变更',
'api' => 'CreateJobGroup',
],
],
'createdAt' => '2022-10-17T02:12:27.000Z',
'description' => '对接网商自建司法调解机器人',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'CreateTaskExportTask',
],
],
'createdAt' => '2022-10-17T02:12:18.000Z',
'description' => 'CreateTaskExportTask接口的instanceId改为必填,否则如果不传 instanceId 有风险会查到别的实例下的数据。',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'ListInstances',
],
[
'description' => '响应参数发生变更',
'api' => 'ListScripts',
],
],
'createdAt' => '2022-09-27T13:03:09.000Z',
'description' => '外呼概览页pop网关接口变更',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'QueryJobsWithResult',
],
],
'createdAt' => '2022-09-20T13:55:17.000Z',
'description' => '外呼3.3软电话免登录体验 通话状态筛选相关接口发布',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'DescribeScript',
],
[
'description' => '请求参数发生变更',
'api' => 'ModifyScript',
],
],
'createdAt' => '2022-09-20T13:54:12.000Z',
'description' => '情绪识别产品化',
],
[
'apis' => [
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'DownloadRecording',
],
],
'createdAt' => '2022-08-09T13:10:11.000Z',
'description' => '支持分段录音试听',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'CreateScript',
],
[
'description' => '请求参数发生变更',
'api' => 'ModifyScript',
],
],
'createdAt' => '2022-08-09T13:09:03.000Z',
'description' => '音义一体设置优化',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'ListJobGroups',
],
],
'createdAt' => '2022-07-07T08:05:38.000Z',
'description' => '修改pageSize最大值',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'ListJobGroups',
],
],
'createdAt' => '2022-07-07T02:56:34.000Z',
'description' => '增加参数校验',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'CreateInstance',
],
[
'description' => '请求参数发生变更、错误码发生变更',
'api' => 'ListJobGroups',
],
[
'description' => '请求参数发生变更',
'api' => 'QueryJobsWithResult',
],
],
'createdAt' => '2022-06-22T02:26:32.000Z',
'description' => '3.1版本公有云发布',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'CreateScript',
],
[
'description' => '响应参数发生变更',
'api' => 'DescribeScript',
],
[
'description' => '响应参数发生变更',
'api' => 'ListScripts',
],
[
'description' => '请求参数发生变更',
'api' => 'ModifyScript',
],
],
'createdAt' => '2022-06-21T12:55:33.000Z',
'description' => '音义一体发布公有云',
],
[
'apis' => [
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'ListAllTenantBindNumberBinding',
],
],
'createdAt' => '2022-06-21T12:22:40.000Z',
'description' => '3.1迭代运维控制台功能',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'DescribeTTSDemo',
],
],
'createdAt' => '2022-05-24T12:30:27.000Z',
'description' => '修复场景试听设置语调不生效问题',
],
[
'apis' => [
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'DescribeJob',
],
[
'description' => '响应参数发生变更',
'api' => 'GetInstanceConfig',
],
],
'createdAt' => '2022-04-20T06:15:08.000Z',
'description' => '标注中心外呼网关发布',
],
[
'apis' => [
[
'description' => 'OpenAPI 下线',
'api' => 'GenerateUploadUrl',
],
],
'createdAt' => '2022-04-11T03:34:29.000Z',
'description' => '标注中心',
],
[
'apis' => [
[
'description' => 'OpenAPI 下线',
'api' => 'CreateTaskExportTask',
],
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'SearchTask',
],
],
'createdAt' => '2022-03-01T16:04:51.000Z',
'description' => '届远12月迭代外呼接口api变更',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'DescribeScript',
],
[
'description' => '响应参数发生变更、错误码发生变更',
'api' => 'DescribeTTSConfig',
],
[
'description' => '请求参数发生变更',
'api' => 'ModifyScript',
],
[
'description' => '请求参数发生变更',
'api' => 'ModifyTTSConfig',
],
],
'createdAt' => '2022-03-01T16:04:27.000Z',
'description' => '外呼STS方式调用ASR 和 TTS',
],
[
'apis' => [
[
'description' => 'OpenAPI 下线',
'api' => 'CreateInstanceBindNumber',
],
[
'description' => 'OpenAPI 下线',
'api' => 'DescribeTenantBindNumber',
],
[
'description' => 'OpenAPI 下线',
'api' => 'ListAllTenantBindNumberBinding',
],
],
'createdAt' => '2022-03-01T16:02:38.000Z',
'description' => '租户绑定号码',
],
[
'apis' => [
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'CreateBatchRepeatJob',
],
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'CreateJobGroup',
],
[
'description' => '响应参数发生变更',
'api' => 'DescribeJobDataParsingTaskProgress',
],
[
'description' => '响应参数发生变更',
'api' => 'DescribeJobGroup',
],
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'ModifyJobGroup',
],
],
'createdAt' => '2022-01-12T12:23:31.000Z',
'description' => '届远11月迭代外呼接口变更',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'SaveAfterAnswerDelayPlayback',
],
[
'description' => '请求参数发生变更',
'api' => 'SaveBaseStrategyPeriod',
],
[
'description' => '请求参数发生变更',
'api' => 'SaveContactBlockList',
],
[
'description' => '请求参数发生变更',
'api' => 'SaveContactWhiteList',
],
[
'description' => '请求参数发生变更',
'api' => 'SaveMaxAttemptsPerDay',
],
],
'createdAt' => '2022-01-12T12:21:25.000Z',
'description' => '账号状态变更提示',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'CreateScript',
],
[
'description' => '响应参数发生变更',
'api' => 'ListScripts',
],
],
'createdAt' => '2021-12-22T12:32:42.000Z',
'description' => '智能打断产品化发布',
],
[
'apis' => [
[
'description' => '请求参数发生变更',
'api' => 'CreateBatchRepeatJob',
],
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'CreateJobGroup',
],
[
'description' => '响应参数发生变更',
'api' => 'DescribeJobGroup',
],
[
'description' => '请求参数发生变更、响应参数发生变更',
'api' => 'ModifyJobGroup',
],
],
'createdAt' => '2021-12-22T12:31:31.000Z',
'description' => '外呼九月迭代新增重拨策略',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'QueryJobsWithResult',
],
],
'createdAt' => '2021-12-22T12:29:10.000Z',
'description' => '届远9月迭代任务查询接口--新增挂断时完成播放字段',
],
[
'apis' => [
[
'description' => 'OpenAPI 下线',
'api' => 'SearchTask',
],
],
'createdAt' => '2021-11-24T13:04:59.000Z',
'description' => '外呼日志中心搜索接口',
],
[
'apis' => [
[
'description' => 'OpenAPI 下线',
'api' => 'GetInstanceConfig',
],
],
'createdAt' => '2021-11-24T13:04:28.000Z',
'description' => '外呼实例配置接口发布',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'DescribeJob',
],
],
'createdAt' => '2021-11-24T13:03:47.000Z',
'description' => '修改了通话详情查询的api,增加了“挂断方”字段',
],
[
'apis' => [
[
'description' => '响应参数发生变更',
'api' => 'QueryJobsWithResult',
],
[
'description' => '请求参数发生变更',
'api' => 'RecordFailure',
],
],
'createdAt' => '2021-11-24T13:03:36.000Z',
'description' => '公有云支持异常码',
],
[
'apis' => [
[
'description' => 'OpenAPI 下线',
'api' => 'CreateDownloadUrl',
],
[
'description' => 'OpenAPI 下线',
'api' => 'ListDownloadTasks',
],
],
'createdAt' => '2021-11-24T13:02:54.000Z',
'description' => '发布了任务中心相关的API',
],
],
'flowControl' => [
'flowControlList' => [
[
'threshold' => '-1',
'countWindow' => 1,
'regionId' => '*',
],
[
'threshold' => '100',
'countWindow' => 1,
'regionId' => '*',
'api' => 'CreateTaskExportTask',
],
[
'threshold' => '10',
'countWindow' => 60,
'regionId' => '*',
'api' => 'ListJobGroups',
],
[
'threshold' => '1000',
'countWindow' => 1,
'regionId' => '*',
'api' => 'CreateInstanceBindNumber',
],
[
'threshold' => '1000',
'countWindow' => 1,
'regionId' => '*',
'api' => 'ListAllTenantBindNumberBinding',
],
[
'threshold' => '1000',
'countWindow' => 1,
'regionId' => '*',
'api' => 'DescribeTenantBindNumber',
],
],
],
'ram' => [
'productCode' => 'OutboundBot',
'productName' => '智能外呼机器人',
'ramCodes' => [
'outboundbot',
],
'ramLevel' => '操作级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'ModifyBeebotIntent',
'description' => '【小模型接口】修改小蜜机器人意图',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyBeebotIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeDialogueNodeStatistics',
'description' => '查询对话节点数据统计',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeDialogueNodeStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ChangeResourceGroup',
'description' => '【已废弃】更改资源组',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:ChangeResourceGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GenerateUploadUrl',
'description' => '上传热词表文件',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:GenerateUploadUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'SaveAnnotationMissionSessionList',
'description' => '保存标注chat实例列表',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:SaveAnnotationMissionSessionList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyEmptyNumberNoMoreCallsInfo',
'description' => '【废弃】保存全局维度空号不再外呼功能开关',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyEmptyNumberNoMoreCallsInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ImportScript',
'description' => '导入场景',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:ImportScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListJobs',
'description' => '查询多个作业',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'WithdrawScriptReview',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:WithdrawScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteScript',
'description' => '删除一个话术',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeIntentStatistics',
'description' => '查询意图统计信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeIntentStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListScriptVoiceConfigs',
'description' => '【旧画布接口】查询话术录音配置列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListScriptVoiceConfigs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetAgentProfile',
'description' => '获取智能体配置',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAgentProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyScript',
'description' => '修改话术信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => 'Instance',
'arn' => 'acs:outboundbot:{#regionId}:{#accountId}:instance/{#InstanceId}',
],
],
],
],
[
'apiName' => 'DeleteScriptRecording',
'description' => '【小模型接口】删除小模型场景中的录音',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteScriptRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteAgentProfiles',
'description' => '删除智能体配置(已作废)',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteAgentProfiles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteOutboundCallNumber',
'description' => '删除外呼号码-已废弃',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteCabOutboundCallNumber',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateBeebotIntent',
'description' => '【小模型接口】创建小蜜机器人意图',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateBeebotIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'SuspendCallWithFile',
'description' => '根据文件数据止呼',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:SuspendCallWithFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListIntentions',
'description' => '标注中心列表查询意图',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListIntentions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'UploadScriptRecording',
'description' => '【废弃】上传话术录音',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:UploadScriptRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListAnnotationMission',
'description' => '获取标注任务列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListAnnotationMission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateDownloadUrl',
'description' => '创建下载文件URL',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateDownloadUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateInstance',
'description' => '创建业务实例',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyIntent',
'description' => '修改意图-旧画布接口',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListOutboundCallNumbers',
'description' => '查询外呼主叫号码列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListOutboundCallNumbers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateBeebotIntentLgf',
'description' => '【小模型接口】创建小蜜机器人意图问法模版',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateBeebotIntentLgf',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetBaseStrategyPeriod',
'description' => '获取全局可外呼时间段',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetBaseStrategyPeriod',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeIntent',
'description' => '获取一个意图-旧画布接口',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteAllNumberDistrictInfo',
'description' => '【已废弃】删除所有号码归属地信息',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteAllNumberDistrictInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListAgentProfiles',
'description' => '获取智能体配置列表(已作废)',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListAgentProfiles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListChatbotInstances',
'description' => '查询云小蜜公有云版本机器人列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListChatbotInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CancelJobs',
'description' => '取消即将执行或执行中的作业',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CancelJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'InflightTaskTimeout',
'description' => '任务超时',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:InflightTaskTimeout',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyAgentProfile',
'description' => '修改智能体配置',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyAgentProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListInstances',
'description' => '查询业务实例列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListTags',
'description' => '查询话术下的标签-旧画布接口',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListTags',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListBeebotIntentLgf',
'description' => '【小模型接口】列表展示小蜜机器人意图问法模版',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListBeebotIntentLgf',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'SaveContactBlockList',
'description' => '保存禁止外呼名单',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SaveContactBlockList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetSummaryInfo',
'description' => '外呼实例总览',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetSummaryInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'QueryScriptWaveforms',
'description' => '【废弃】查询话术录音文件列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:QueryScriptWaveforms',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListGlobalQuestions',
'description' => '【旧画布接口】查询全局问题列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:ListGlobalQuestions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetCurrentConcurrency',
'description' => '获取实例当前的并发',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetCurrentConcurrency',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteBeebotIntentLgf',
'description' => '【小模型接口】删除小蜜机器人意图问法模版',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteBeebotIntentLgf',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeDsReports',
'description' => '获取作业组命中标签统计',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeGroupDsReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'SearchTask',
'description' => '搜索任务',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:SearchTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListTagResources',
'description' => '【已废弃】查询资源标签关系',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListTagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateDialogueFlow',
'description' => '创建对话流程 -旧画布接口',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateDialogueFlow',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'TerminateCall',
'description' => '终止通话',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:TerminateCall',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListBeebotIntentUserSay',
'description' => '列表展示小蜜机器人用户问法',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListBeebotIntentUserSay',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateScriptWaveform',
'description' => '【废弃】旧画布创建场景声音的录音',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateScriptWaveform',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListAnnotationMissionSession',
'description' => '获取标注任务chat实例列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListAnnotationMissionSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetContactWhiteList',
'description' => '获取外呼白名单列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetContactWhiteList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeJob',
'description' => '返回一个作业的对话数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetAfterAnswerDelayPlayback',
'description' => '查询接听后延迟播报时间',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAfterAnswerDelayPlayback',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteContactBlockList',
'description' => '删除禁止外呼名单',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteContactBlockList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListAllTenantBindNumberBinding',
'description' => '租户绑定的号码列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListAllTenantBindNumberBinding',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeScript',
'description' => '返回一个话术的信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => 'Instance',
'arn' => 'acs:outboundbot:{#regionId}:{#accountId}:instance/{#InstanceId}',
],
],
],
],
[
'apiName' => 'ListIntents',
'description' => '查询意图列表-旧画布接口',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListIntents',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateJobDataParsingTask',
'description' => '创建任务数据解析任务',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateJobDataParsingTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteJobGroup',
'description' => '删除一个任务',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteJobGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetMaxAttemptsPerDay',
'description' => '查询被叫号码每日拨打上限',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetMaxAttemptsPerDay',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListScriptPublishHistories',
'description' => '查询外呼小模型场景发布历史列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListScriptPublishHistories',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListBeebotIntent',
'description' => '【小模型接口】列表展示小蜜机器人意图',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListBeebotIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DownloadRecording',
'description' => '下载通话录音',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DownloadCabRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListResourceTags',
'description' => '查询实例资源标签',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListResourceTags',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyTTSConfig',
'description' => '修改旧画布场景的tts配置(旧画布专用,废弃)',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyTTSConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'QueryScriptsByStatus',
'description' => '根据场景状态查询场景信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:QueryScriptsByStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateJobGroup',
'description' => '创建外呼任务组',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateJobGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetVersion',
'description' => '获取应用版本信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetVersion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyScriptVoiceConfig',
'description' => '【旧画布接口】修改场景声音配置',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyScriptVoiceConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'SaveAfterAnswerDelayPlayback',
'description' => '保存接听后延迟播报时间',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:SaveAfterAnswerDelayPlayback',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeJobGroupExportTaskProgress',
'description' => '【已废弃】获取任务组导出任务进度',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeJobGroupExportTaskProgress',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetRealtimeConcurrencyReport',
'description' => '查询当前并发列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetRealtimeConcurrencyReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'RollbackScript',
'description' => '回滚发布的场景(仅小模型)',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:RollbackScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyAnnotationMission',
'description' => '修改标注任务',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyAnnotationMission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'PublishScriptForDebug',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:PublishScriptForDebug',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'QueryJobsWithResult',
'description' => '根据任务结果查询任务',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:QueryJobsWithResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListScriptRecording',
'description' => '【小模型接口】查询录音文件列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListScriptRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'SubmitBatchJobs',
'description' => '将草稿状态的作业组提交执行-已废弃',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:SubmitBatchJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteGlobalQuestion',
'description' => '【旧画布接口】删除全局问题',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteGlobalQuestion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyOutboundCallNumber',
'description' => '修改外呼号码-已废弃',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyCabOutboundCallNumber',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeTTSDemo',
'description' => 'TTS 试听',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeTTSDemo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateScript',
'description' => '创建场景',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => 'Instance',
'arn' => 'acs:outboundbot:{#regionId}:{#accountId}:instance/{#InstanceId}',
],
],
],
],
[
'apiName' => 'TagResources',
'description' => '给实例资源打标签',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:TagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeGroupExecutingInfo',
'description' => '返回任务执行情况',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeGroupExecutingInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyBeebotIntentLgf',
'description' => '【小模型接口】修改小蜜机器人意图问法模版',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyBeebotIntentLgf',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateTaskExportTask',
'description' => '外呼历史导出',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateTaskExportTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyInstance',
'description' => '修改业务实例',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteDialogueFlow',
'description' => '删除对话流程-旧画布接口',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteDialogueFlow',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'SubmitScriptReview',
'description' => '提交场景发布审核',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SubmitScriptReview',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetConcurrentConversationQuota',
'description' => '获取调用者账号下剩余的并发数',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetConcurrentConversationQuota',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateBatchRepeatJob',
'description' => '复制任务组重新发起外呼',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateBatchRepeatJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'SaveContactWhiteList',
'description' => '保存外呼白名单',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SaveContactWhiteList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeScriptVoiceConfig',
'description' => '【旧画布接口】返回一个场景声音配置',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeScriptVoiceConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyBatchJobs',
'description' => '修改作业组(包括作业)-已废弃',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyBatchJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'SuspendCall',
'description' => '根据列表数据止呼',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:SuspendCall',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetAnnotationMissionTagInfoList',
'description' => '获取标注标签列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAnnotationMissionTagInfoList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetEmptyNumberNoMoreCallsInfo',
'description' => '【废弃】查询全局维度空号不再外呼功能开关',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetEmptyNumberNoMoreCallsInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyBeebotIntentUserSay',
'description' => '【小模型接口】修改小蜜机器人意图用户问法',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyBeebotIntentUserSay',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeJobDataParsingTaskProgress',
'description' => '返回一个作业的进度信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeJobDataParsingTaskProgress',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'UntagResources',
'description' => '删除资源标签',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:UntagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetJobDataUploadParams',
'description' => '获取作业数据上传参数',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetJobDataUploadParams',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteIntent',
'description' => '删除意图-旧画布接口',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'StartJob',
'description' => '创建一个作业',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:StartJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListJobsByGroup',
'description' => '根据作业组查询作业',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListJobsByGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyGlobalQuestion',
'description' => '【旧画布接口】修改全局问题',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyGlobalQuestion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ResumeJobs',
'description' => '重启暂停的作业',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:ResumeJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyTagGroups',
'description' => '修改标签组-旧画布接口',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyTagGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteContactWhiteList',
'description' => '删除外呼白名单',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteContactWhiteList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeInstance',
'description' => 'DescribeInstance',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateJobGroupExportTask',
'description' => '创建外呼作业组导出任务',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateJobGroupExportTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'SaveMaxAttemptsPerDay',
'description' => '保存被叫号码每日拨打上限',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SaveMaxAttemptsPerDay',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'RecordFailure',
'description' => 'ivr记录通话失败-已废弃',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:RecordFailure',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListScripts',
'description' => '查询话术列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListScripts',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => 'Instance',
'arn' => 'acs:outboundbot:{#regionId}:{#accountId}:instance/{#InstanceId}',
],
],
],
],
[
'apiName' => 'CreateAgentProfile',
'description' => '创建智能体配置',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateAgentProfile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetAnnotationMissionSummary',
'description' => '获取标注任务统计信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAnnotationMissionSummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeTTSConfig',
'description' => '【废弃】查询tts配置信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeTTSConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'TaskPreparing',
'description' => '准备执行任务',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:TaskPreparing',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListApiPlugins',
'description' => '查询API插件列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListApiPlugins',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateIntent',
'description' => '【旧画布接口】创建意图',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetAsrServerInfo',
'description' => '【已废弃】获取asr模型列表、热词列表等信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAsrServerInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListDownloadTasks',
'description' => '任务下载列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListDownloadTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'SuspendJobs',
'description' => '暂停作业',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:SuspendJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListDialogueFlows',
'description' => '【旧画布接口】查询一个场景下的对话流程列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListDialogueFlows',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListFlashSmsTemplates',
'description' => '获取闪信模板',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListFlashSmsTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteBeebotIntentUserSay',
'description' => '【小模型接口】删除小蜜意图用户问法',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteBeebotIntentUserSay',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateGlobalQuestion',
'description' => '【旧画布接口】创建全局问题',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateGlobalQuestion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteInstance',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateAnnotationMission',
'description' => '创建标注任务',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:CreateAnnotationMission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'SaveAnnotationMissionTagInfoList',
'description' => '保存标注标签映射关系',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SaveAnnotationMissionTagInfoList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'AssignJobs',
'description' => '批量创建外呼任务',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:AssignJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'PublishScript',
'description' => '【已废弃】发布话术',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:PublishScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateTag',
'description' => '创建标签-旧画布使用',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateTag',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyDialogueFlow',
'description' => '修改对话流程-旧画布接口',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:SaveDialogueFlow',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListJobGroups',
'description' => '查询任务列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListJobGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetAgentProfileTemplate',
'description' => '获取智能体配置模版(已作废)',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAgentProfileTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ExportScript',
'description' => '创建导出场景任务',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:ExportScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteScriptWaveform',
'description' => '【已废弃】删除话术录音',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteScriptWaveform',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'AssignJobsAsync',
'description' => '异步创建外呼任务',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:AssignJobsAsync',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DeleteBeebotIntent',
'description' => '【小模型接口】删除小蜜机器人意图',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteBeebotIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeBeebotIntent',
'description' => '【获取小模型接口】获取小蜜机器人意图',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeBeebotIntent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ListJobGroupsAsync',
'description' => '异步查询任务列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListJobGroupsAsync',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeGlobalQuestion',
'description' => '【旧画布接口】返回一个全局问题的数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeGlobalQuestion',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetAssignJobsAsyncResult',
'description' => '获取异步创建外呼任务结果',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAssignJobsAsyncResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DuplicateScript',
'description' => '【旧画布接口】复制话术',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:DuplicateScript',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'Dialogue',
'description' => '和机器人对话',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:Dialogue',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateBeebotIntentUserSay',
'description' => '【小模型接口】创建小蜜机器人意图用户问法',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateBeebotIntentUserSay',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetTaskByUuid',
'description' => '根据任务ID获取任务',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetTaskByUuid',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateBatchJobs',
'description' => '批量创建外呼作业-已废弃',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateBatchJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DownloadScriptRecording',
'description' => '【小模型接口】下载录音(获取录音地址)',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DownloadScriptRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeTagHitsSummary',
'description' => '查询标签统计数据-旧画布接口',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeTagHitsSummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'SubmitRecording',
'description' => '向外呼提交通话录音-已废弃',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:SubmitRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'DescribeJobGroup',
'description' => '查询外呼任务组',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetJobGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'SaveBaseStrategyPeriod',
'description' => '编辑全局可外呼时间段',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SaveBaseStrategyPeriod',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'GetContactBlockList',
'description' => '获取禁止外呼名单',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetContactBlockList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'ModifyJobGroup',
'description' => '修改任务数据',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyJobGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
[
'apiName' => 'CreateInstanceBindNumber',
'description' => '实例绑定号码',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateInstanceBindNumber',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
[
'validationType' => 'always',
'product' => 'OutboundBot',
'resourceType' => '全部资源',
'arn' => '*',
],
],
],
],
],
'resourceTypes' => [
[
'validationType' => 'always',
'resourceType' => 'Instance',
'arn' => 'acs:outboundbot:{#regionId}:{#accountId}:instance/{#InstanceId}',
],
],
],
];