diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/outboundbot/2019-12-26 | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/outboundbot/2019-12-26')
| -rw-r--r-- | data/en_us/outboundbot/2019-12-26/api-docs.php | 45165 |
1 files changed, 45165 insertions, 0 deletions
diff --git a/data/en_us/outboundbot/2019-12-26/api-docs.php b/data/en_us/outboundbot/2019-12-26/api-docs.php new file mode 100644 index 0000000..7d780ea --- /dev/null +++ b/data/en_us/outboundbot/2019-12-26/api-docs.php @@ -0,0 +1,45165 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'OutboundBot', + 'version' => '2019-12-26', + ], + 'directories' => [ + [ + 'children' => [ + 'CreateInstanceBindNumber', + 'DescribeTenantBindNumber', + 'ListAllTenantBindNumberBinding', + ], + 'type' => 'directory', + 'title' => 'Number Management', + ], + [ + 'children' => [ + 'GenerateUploadUrl', + 'CreateJobDataParsingTask', + 'CreateJobGroupExportTask', + 'DescribeIntentStatistics', + 'DescribeJobDataParsingTaskProgress', + 'ListResourceTags', + 'TagResources', + 'UntagResources', + 'GetConcurrentConversationQuota', + 'ListDownloadTasks', + 'CreateDownloadUrl', + 'ListChatbotInstances', + 'CreateTaskExportTask', + 'GetJobDataUploadParams', + 'ListFlashSmsTemplates', + 'GetRealtimeConcurrencyReport', + 'GetVersion', + ], + 'type' => 'directory', + 'title' => 'Other', + ], + [ + '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' => 'Deprecated', + ], + [ + 'children' => [ + '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', + ], + 'title' => 'Others', + 'type' => 'directory', + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'AssignJobs' => [ + 'summary' => 'Create outbound call jobs in batch.', + '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' => 'Instance ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'Execution policy for the job group: '."\n" + .'- repeatBy: Recurrence type. Valid values: Once (no recurrence), Day (daily), Week (weekly), Month (monthly). '."\n" + .'- startTime: Policy start time. '."\n" + .'- endTime: Policy end time. '."\n" + .'- workingTime: Allowed outbound calling time window. '."\n" + .'- maxAttemptsPerDay: Maximum number of call attempts per day for each number under this job. '."\n" + .'- minAttemptInterval: Minimum interval between retry calls for a number, in minutes. '."\n" + .'- routingStrategy: Number routing strategy. Valid values: None (not specified), LocalFirst (local city numbers prioritized), LocalProvinceFirst (local province numbers prioritized). '."\n" + .'- repeatDays: Execution dates corresponding to the recurrence type. If RepeatBy is Week, 0 represents Sunday and 1–6 represent Monday to Saturday. If RepeatBy is Month, values 1–31 represent the 1st to the 31st day of the month; months without the specified date will skip execution (for example, if day 30 is selected, February will be skipped). '."\n" + .'- repeatable: Indicates whether loop tasks are enabled. Valid values: true or 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"}', + 'title' => '', + ], + ], + [ + 'name' => 'RosterType', + 'in' => 'query', + 'schema' => [ + 'description' => 'List type.'."\n" + ."\n" + .'For API integration, the default value is JSON and this parameter can be omitted. '."\n" + .'If uploading a list, specify "excel".', + 'type' => 'string', + 'required' => false, + 'example' => 'json', + 'title' => '', + ], + ], + [ + 'name' => 'JobDataParsingTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task ID for parsing outbound call job data.'."\n" + ."\n" + .'This parameter can be left blank if the outbound call job is delivered via API integration.'."\n" + ."\n" + .'> If you use file upload, you must invoke CreateJobDataParsingTask to obtain the corresponding parameter value.', + 'type' => 'string', + 'required' => false, + 'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95', + 'title' => '', + ], + ], + [ + 'name' => 'IsAsynchrony', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether the operation is asynchronous.'."\n" + ."\n" + .'This parameter can be left blank if the outbound call job is delivered via API integration. The default value is false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of calling numbers (displayed to customers when making outbound calls).'."\n" + ."\n" + .'> If this parameter is not specified, all available numbers are selected by default.', + 'type' => 'array', + 'items' => [ + 'description' => 'Calling number.', + 'type' => 'string', + 'required' => false, + 'example' => '4008013260', + 'title' => '', + ], + 'required' => false, + 'maxItems' => 99, + 'example' => '', + 'title' => '', + ], + ], + [ + 'name' => 'JobsJson', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Job data in the format of a JSON array. For the specific format, refer to the Example Value.'."\n" + ."\n" + .'JobsJson.N is a List, where each JobJson corresponds to one contact.', + 'type' => 'array', + 'items' => [ + 'description' => 'extras // Optional additional information'."\n" + ."\n" + .'- key // Key of the custom variable name'."\n" + ."\n" + .'- value // Value of the custom variable content'."\n" + ."\n" + .'contacts // Required field containing callee contact information'."\n" + ."\n" + .'- phoneNumber // Required field specifying the callee\'s phone number'."\n" + ."\n" + .'- referenceId // Required field specifying the contact ID (defined by the user) to avoid duplicate names'."\n" + ."\n" + .'- role // Optional field specifying the contact’s role in this outbound call scenario; if unspecified, roles are not differentiated'."\n" + ."\n" + .'- honorific // Optional field specifying the contact’s honorific'."\n" + ."\n" + .'- name // Optional field specifying the contact’s name', + 'type' => 'string', + 'required' => 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" + .'}', + 'docRequired' => true, + 'title' => '', + ], + 'required' => false, + 'maxItems' => 99, + 'example' => '', + 'docRequired' => true, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Response information.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Task group ID.', + 'type' => 'string', + 'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'JobsId' => [ + 'description' => 'List of job IDs.', + 'type' => 'array', + 'items' => [ + 'description' => 'Job ID.', + 'type' => 'string', + 'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '', + ], + ], + ], + 'title' => 'Create outbound call jobs in batch', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:AssignJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', + ], + 'AssignJobsAsync' => [ + 'summary' => 'Asynchronously create an outbound call job.', + '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' => 'Instance ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Task group ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyJson', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Job group execution policy.'."\n" + ."\n" + .'- repeatBy'."\n" + ."\n" + .' Recurrence type. Valid values: Once (no recurrence), Day (daily recurrence), Week (weekly recurrence), Month (monthly recurrence).'."\n" + ."\n" + .'- startTime'."\n" + ."\n" + .' Policy start time.'."\n" + ."\n" + .'- endTime'."\n" + ."\n" + .' Policy end time.'."\n" + ."\n" + .'- workingTime'."\n" + ."\n" + .' Allowed outbound calling time segment.'."\n" + ."\n" + .'- maxAttemptsPerDay'."\n" + ."\n" + .' Maximum number of call attempts per contact per day for this job.'."\n" + ."\n" + .'- minAttemptInterval'."\n" + ."\n" + .' Minimum interval between retry calls for a contact, in minutes.'."\n" + ."\n" + .'- routingStrategy'."\n" + ."\n" + .' Number routing strategy. Valid values: None (not specified), LocalFirst (local city numbers preferred), LocalProvinceFirst (numbers from the same province preferred).'."\n" + ."\n" + .'- repeatDays'."\n" + ."\n" + .' Execution dates corresponding to the recurrence type. If RepeatBy is set to Week, 0 represents Sunday and 1–6 represent Monday through Saturday, respectively. If RepeatBy is set to Month, values 1–31 represent the 1st through the 31st of each month. Months that do not have the specified date will skip execution (for example, if the 30th is selected, February will be skipped).'."\n" + ."\n" + .'- repeatable'."\n" + ."\n" + .' Indicates whether loop tasks are enabled. Valid values: true or 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"}', + 'title' => '', + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'List of calling numbers (the caller ID displayed when dialing the customer).'."\n" + ."\n" + .'> If left unspecified, all available numbers are selected by default.', + 'type' => 'array', + 'items' => [ + 'description' => 'Calling number.', + 'type' => 'string', + 'required' => false, + 'example' => '4008013260', + 'title' => '', + ], + 'required' => false, + 'maxItems' => 99, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'JobsJson', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Job data, formatted as a JSON array. For the specific format, see Example Value.'."\n" + ."\n" + .'JobsJson.N is a list where each JobJson corresponds to one contact.', + 'type' => 'array', + 'items' => [ + 'description' => 'extras // Additional information. Optional.'."\n" + ."\n" + .'- key // Key of the custom variable name'."\n" + ."\n" + .'- value // Value of the custom variable content'."\n" + ."\n" + .'contacts // Required field. Contact information of the called party.'."\n" + ."\n" + .'- phoneNumber // Required field. Phone number of the called party.'."\n" + ."\n" + .'- referenceId // Required field. Contact ID (custom-defined by the user) to avoid ambiguity caused by duplicate names.'."\n" + ."\n" + .'- role // Optional field. Role of this contact in the outbound call task. If unspecified, no distinction is made.'."\n" + ."\n" + .'- honorific // Optional field. Honorific title for the contact.'."\n" + ."\n" + .'- name // Optional field. Name of the contact.', + '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, + 'title' => '', + ], + 'required' => false, + 'maxItems' => 10000, + 'docRequired' => true, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response information.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API prompt message.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'AsyncTaskId' => [ + 'description' => 'Asynchronous task ID.', + 'type' => 'string', + 'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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"}]', + 'title' => 'Asynchronously create an outbound call job', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:AssignJobsAsync', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CancelJobs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', + 'title' => '', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to cancel all jobs', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'ScenarioId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition: scenario ID '."\n" + .'> You can obtain this by calling DescribeJobGroup.', + 'type' => 'string', + 'required' => false, + 'example' => '35641113-b2f6-464e-a772-25c25554798b', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition: task group ID', + 'type' => 'string', + 'required' => false, + 'example' => '9f84892d-721a-4069-9975-668c8164d64e', + 'title' => '', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Filter condition: job ID '."\n" + ."\n" + .'> When the All parameter is false, JobId is required.', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'ID of the job to be canceled', + 'required' => false, + 'example' => 'edf45790-7200-4cbc-b157-8c0a5f400b75', + 'title' => '', + ], + 'required' => false, + 'example' => 'edf45790-7200-4cbc-b157-8c0a5f400b75', + 'maxItems' => 99, + 'title' => '', + ], + ], + [ + 'name' => 'JobReferenceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Filter condition: reference ID of the job '."\n" + ."\n" + .'> This corresponds to the ReferenceId uploaded by the Customer when uploading the outbound call list.', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'Third-party ID of the job', + 'required' => false, + 'example' => 'C01', + 'title' => '', + ], + 'required' => false, + 'example' => '4a875676-b136-4087-88b4-de67c61fed69', + 'maxItems' => 99, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Cancel a job that is about to be executed or is currently executing', + 'summary' => 'Cancel a job that is about to be executed or is currently executing (cancellation is invalid for jobs already in a call).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CancelJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ChangeResourceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Resource ID', + 'docRequired' => true, + 'example' => 'ResourceId.1=b949ae1f-01dc-4191-ae5a-70fbe6772fd8', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'New resource group ID', + 'docRequired' => true, + 'example' => 'rg-aeky6wvb7yzabqy', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Deprecated] Change the resource group', + 'summary' => 'Change the resource group.', + 'changeSet' => [ + [ + 'createdAt' => '2024-07-22T12:43:47.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:ChangeResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + ], + ], + [ + 'name' => 'PromptJson', + 'in' => 'formData', + 'schema' => [ + 'title' => 'prompt json', + 'description' => 'Agent configuration (NAT mode)', + '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' => 'Agent configuration (Professional mode)', + 'type' => 'string', + 'required' => false, + 'example' => '\\n名称：安妮 \\n身份：游戏推广员\\n背景：通过电话向玩家宣传最新福利活动，确保每一位玩家都能及时掌握信息，享受游戏的乐趣。\\n技能：作为游戏客服，向用户推荐限时游戏福利活动，强调福利亮点并告知参与流程。\\n约束条件：你需要记住你是安妮，来自于热门游戏客服团队，专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服，需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性，同时语言平易近人，确保玩家轻松理解活动内容。\\n明确活动的起止时间，确保玩家不会混淆。\\n强调活动的重点奖励和参与方式，提升玩家的参与兴趣。', + ], + ], + [ + 'name' => 'AgentProfileTemplateId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'agent template id', + 'description' => 'Agent template ID (Unique value)', + 'type' => 'string', + 'required' => true, + 'example' => 'default-survey', + ], + ], + [ + 'name' => 'Model', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'Model ID (Unique value)', + 'type' => 'string', + 'required' => true, + 'example' => 'model_001', + ], + ], + [ + 'name' => 'ModelConfig', + 'in' => 'formData', + 'schema' => [ + 'title' => 'model config', + 'description' => 'Model Configuration (deprecated)', + 'type' => 'string', + 'required' => false, + 'example' => '""', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'script id', + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17', + ], + ], + [ + 'name' => 'LabelsJson', + 'in' => 'formData', + 'schema' => [ + 'title' => 'labels json', + 'description' => 'Tag Description', + 'type' => 'string', + 'required' => false, + 'example' => '[{'."\n" + .' "name": "是否满意",'."\n" + .' "description": "对介绍的游戏内容是否感兴趣",'."\n" + .' "valueList": "[\\"有兴趣\\",\\"没兴趣\\"]"'."\n" + .'}]', + ], + ], + [ + 'name' => 'VariablesJson', + 'in' => 'formData', + 'schema' => [ + 'title' => 'variables json', + 'description' => 'Variable Configuration', + 'type' => 'string', + 'required' => false, + 'example' => '[{'."\n" + .' "name": "开始时间",'."\n" + .' "description": "开始时间"'."\n" + .'}, {'."\n" + .' "name": "结束时间",'."\n" + .' "description": "结束时间"'."\n" + .'}]', + ], + ], + [ + 'name' => 'Scenario', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'Scenario', + 'type' => 'string', + 'required' => false, + 'example' => '测试场景', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'Description', + 'type' => 'string', + 'required' => false, + 'example' => '描述当前智能体的功能', + ], + ], + [ + 'name' => 'AppIp', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'app_ip (system field) – optional', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1', + ], + ], + [ + 'name' => 'InstructionJson', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Instruction configuration', + '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" + .'}]', + 'title' => '', + ], + ], + [ + 'name' => 'FaqCategoryIds', + 'in' => 'formData', + 'schema' => [ + 'description' => 'FAQ Folder ID', + 'type' => 'string', + 'required' => false, + 'example' => '[30000474726]', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<AgentProfile>', + 'description' => 'BaseResponse<AgentProfile>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status Code', + 'type' => 'string', + 'example' => 'Ok', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message ', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Returned data ', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '', + 'description' => 'Creation Time ', + 'type' => 'string', + 'example' => '1739333534000', + ], + 'UpdateTime' => [ + 'title' => '', + 'description' => 'Updated At', + 'type' => 'string', + 'example' => '1737077564000', + ], + 'AgentProfileId' => [ + 'title' => 'agent profile id', + 'description' => 'Agent configuration ID', + 'type' => 'string', + 'example' => 'd31794e2a51f47d2901b4094d88311d7', + ], + 'InstanceId' => [ + 'title' => '', + 'description' => 'Instance ID ', + 'type' => 'string', + 'example' => '1e16c663-0339-4064-9d57-07f772e78f21', + ], + 'ScriptId' => [ + 'title' => 'script id', + 'description' => 'Scenario ID ', + 'type' => 'string', + 'example' => 'd13ad2d3-3fe6-4352-b38b-bd6559047de8', + ], + 'AgentType' => [ + 'title' => 'agent type', + 'description' => 'agent type', + 'type' => 'string', + 'example' => '“”', + ], + 'PromptJson' => [ + 'title' => 'prompt json', + 'description' => 'Agent configuration', + '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' => 'Prompt (Professional Mode)', + 'type' => 'string', + 'example' => '\\n名称：安妮 \\n身份：游戏推广员\\n背景：通过电话向玩家宣传最新福利活动，确保每一位玩家都能及时掌握信息，享受游戏的乐趣。\\n技能：作为游戏客服，向用户推荐限时游戏福利活动，强调福利亮点并告知参与流程。\\n约束条件：你需要记住你是安妮，来自于热门游戏客服团队，专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服，需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性，同时语言平易近人，确保玩家轻松理解活动内容。\\n明确活动的起止时间，确保玩家不会混淆。\\n强调活动的重点奖励和参与方式，提升玩家的参与兴趣。', + ], + 'AgentProfileTemplateId' => [ + 'title' => 'agent template id', + 'description' => 'Agent configuration template ID', + 'type' => 'string', + 'example' => 'default-survey', + ], + 'Model' => [ + 'title' => '', + 'description' => 'Model ID', + 'type' => 'string', + 'example' => 'model_001', + ], + 'ModelConfig' => [ + 'title' => 'model config', + 'description' => 'Model Configuration', + 'type' => 'string', + 'example' => '""', + ], + 'System' => [ + 'title' => '', + 'description' => 'Indicates whether it is a system template.', + 'type' => 'boolean', + 'example' => 'True', + ], + 'LabelsJson' => [ + 'title' => 'labels', + 'description' => 'Tag Description ', + 'type' => 'string', + 'example' => '[{'."\n" + .' "name": "是否满意",'."\n" + .' "description": "对介绍的游戏内容是否感兴趣",'."\n" + .' "valueList": "[\\"有兴趣\\",\\"没兴趣\\"]"'."\n" + .'}]', + ], + 'VariablesJson' => [ + 'title' => 'variables', + 'description' => 'Variable configuration ', + 'type' => 'string', + 'example' => '[{'."\n" + .' "name": "开始时间",'."\n" + .' "description": "开始时间"'."\n" + .'}, {'."\n" + .' "name": "结束时间",'."\n" + .' "description": "结束时间"'."\n" + .'}]', + ], + 'Scenario' => [ + 'title' => '', + 'description' => 'Scenario', + 'type' => 'string', + 'example' => '场景', + ], + 'Description' => [ + 'title' => '', + 'description' => 'Description ', + 'type' => 'string', + 'example' => '这是一个智能体。', + ], + 'InstructionJson' => [ + 'description' => 'Instruction Configuration', + '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" + .'}]', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID ', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Create Agent Configuration', + 'summary' => 'Create an intelligent configuration. ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateAgentProfile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateAnnotationMission' => [ + 'summary' => 'Create an annotation job ', + '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' => '', + 'description' => 'Data Type of the annotation Job.'."\n" + ."\n" + .'- 1: Outbound call', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'docRequired' => true, + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Outbound scenario ID ', + 'type' => 'string', + 'required' => false, + 'example' => '6236f21e-2e04-4dad-a47b-ae77e6a48325', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID ', + 'type' => 'string', + 'required' => true, + 'example' => 'bf3b51a5-e88a-4636-98b0-1a34725a085b', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'Finished', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether the business ended normally. '."\n" + ."\n" + .'> This parameter takes effect only when SessionEndReasonFilterList is not provided. '."\n" + .'> - true: Normal conversation records '."\n" + .'> - false: Abnormal conversation records ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + 'title' => '', + ], + ], + [ + 'name' => 'SessionEndReasonFilterList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '', + 'description' => 'Filter condition for call result status.'."\n" + ."\n" + .'> This parameter is equivalent to SessionEndReasonFilterListJsonString. You can specify either one of them.', + 'type' => 'array', + 'items' => [ + 'description' => 'Keyword filter rule.'."\n" + ."\n" + .'**Enumeration values for call record filtering**'."\n" + .'- 1: Normal completion '."\n" + .'- 2: Robot hangs up after rejection '."\n" + .'- 3: Hangs up due to silence timeout '."\n" + .'- 4: User hangs up after rejection '."\n" + .'- 5: User hangs up without reason '."\n" + .'- 6: Hit intent and transferred to agent '."\n" + .'- 7: Rejected and transferred to agent '."\n" + .'- 8: No interaction from user side '."\n" + .'- 9: System Exception interruption '."\n" + .'- 10: Hit intent and transferred to IVR '."\n" + .'- 11: Rejected and transferred to IVR', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'example' => '', + ], + ], + [ + 'name' => 'SessionEndReasonFilterListJsonString', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Filter condition for call result status.'."\n" + ."\n" + .'> This parameter serves the same purpose as SessionEndReasonFilterList. You can specify either one of them. '."\n" + .'The format is [1] or [1,2], etc. The array can contain multiple filter conditions. The corresponding enumeration values are as follows.'."\n" + ."\n" + .'**Enumeration values for call record filtering**'."\n" + .'- 1: Normal completion '."\n" + .'- 2: Robot hangs up after rejection '."\n" + .'- 3: Hangs up due to silence timeout '."\n" + .'- 4: User hangs up after rejection '."\n" + .'- 5: User hangs up without reason '."\n" + .'- 6: Hit intent and transferred to agent '."\n" + .'- 7: Rejected and transferred to agent '."\n" + .'- 8: No interaction from user side '."\n" + .'- 9: System Exception interruption '."\n" + .'- 10: Hit intent and transferred to IVR '."\n" + .'- 11: Rejected and transferred to IVR', + 'type' => 'string', + 'required' => false, + 'example' => '[1]', + ], + ], + [ + 'name' => 'ExcludeOtherSession', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Specifies whether to exclude call records already annotated by other Jobs. The default value is false if this parameter is not specified.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ConversationTimeStartFilter', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Start time for filtering conversations by time ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1683302400000', + ], + ], + [ + 'name' => 'ConversationTimeEndFilter', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'End time for filtering conversations by time', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1682956800000', + ], + ], + [ + 'name' => 'SamplingType', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Sampling type. '."\n" + ."\n" + .'- 1: Full volume '."\n" + .'- 2: Percentage '."\n" + .'- 3: Custom quantity ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SamplingRate', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Sampling rate '."\n" + ."\n" + .'> This parameter takes effect only when SamplingType is 2 and is Required in that case; otherwise, creation will fail. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SamplingCount', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Custom sampling quantity '."\n" + .'> This parameter takes effect only when SamplingType is 3 and is Required in that case; otherwise, creation will fail. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'AnnotationMissionName', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Task Name of the annotation Job', + 'type' => 'string', + 'required' => false, + 'example' => '询问卖车-标注任务-20230506-112934', + ], + ], + [ + 'name' => 'AnnotationMissionDebugDataSourceList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'List of annotation data sources '."\n" + ."\n" + .'> This parameter serves the same purpose as AnnotationMissionDebugDataSourceListJsonString. You can use either one. ', + 'type' => 'array', + 'items' => [ + 'description' => 'Business data list '."\n" + ."\n" + .'**Enumeration values:** '."\n" + .'- 1: Outbound job '."\n" + .'- 2: Testing job ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'AnnotationMissionDebugDataSourceListJsonString', + 'in' => 'query', + 'schema' => [ + 'description' => 'Debug data in JSON format '."\n" + .'> This parameter serves the same purpose as AnnotationMissionDebugDataSourceList. You can use either one. The format is [1], [2], or [1,2]. You can include multiple filter conditions in the array. The corresponding enumeration values are as follows: '."\n" + ."\n" + .'- 1: Outbound job '."\n" + .'- 2: Testing job ', + 'type' => 'string', + 'required' => false, + 'example' => '[1]', + 'title' => '', + ], + ], + [ + 'name' => 'ChatbotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Chatbot ID '."\n" + ."\n" + .'> You can obtain it from the DescribeScript API. ', + 'type' => 'string', + 'required' => false, + 'example' => 'chatbot-cn-fqEnFZBYnb', + 'title' => '', + ], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Agent ID'."\n" + ."\n" + .'> You can obtain it from the DescribeInstance API.', + 'type' => 'string', + 'required' => false, + 'example' => '1168702', + 'title' => '', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'Workspace key '."\n" + ."\n" + .'> You can obtain this from the DescribeInstance API. ', + 'type' => 'string', + 'required' => false, + 'example' => '9137ab9c27044921860030adf8590ec4_p_outbound_public', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<CreateAnnotationMissionResponse>', + 'description' => 'BaseResponse<CreateAnnotationMissionResponse>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Whether the API invocation succeeded. true: succeeded. false: failed to invoke. ', + 'type' => 'boolean', + 'example' => 'True', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Additional information. The value is interpreted as follows: if the request is normal, returns "success"; if the request is abnormal, returns the specific error code. ', + 'type' => 'string', + 'example' => '执行失败：查找元素或操作超时,outTaskId:trademark_regnew_public_cn-uax33hol2uu,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Returned data. ', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Whether the operation succeeded ', + 'type' => 'boolean', + 'example' => 'True', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Additional information. The value is interpreted as follows: if the request is normal, returns "success"; if the request is abnormal, returns the specific error code. ', + 'type' => 'string', + 'example' => '执行失败：查找元素或操作超时,outTaskId:trademark_regnew_public_cn-uax33hol2uu,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID. ', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Create an annotation job ', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:CreateAnnotationMission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'CreateBatchJobs' => [ + 'summary' => 'Batch create outbound call jobs. This operation is deprecated.', + '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' => 'Instance ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', + 'title' => '', + ], + ], + [ + 'name' => 'BatchJobName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Batch job name ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '第一个作业组', + 'title' => '', + ], + ], + [ + 'name' => 'BatchJobDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'Batch job description ', + 'type' => 'string', + 'required' => false, + 'example' => '描述', + 'title' => '', + ], + ], + [ + 'name' => 'ScenarioId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID ', + 'type' => 'string', + 'required' => false, + 'example' => 'c6a668d1-3145-4048-9101-cb3678bb8884', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID ', + 'type' => 'string', + 'required' => false, + 'example' => 'b9ff4e88-65f9-4eb3-987c-11ba51f3f24d', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'StrategyJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job execution policy in JSON format (Required) ', + '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}', + 'title' => '', + ], + ], + [ + 'name' => 'JobFilePath', + 'in' => 'query', + 'schema' => [ + 'description' => 'URL for downloading the batch job Excel file '."\n" + ."\n" + .'> You can obtain this parameter from the Folder field returned by the GetJobDataUploadParams API ', + 'type' => 'string', + 'required' => false, + 'example' => '52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx', + 'title' => '', + ], + ], + [ + 'name' => 'Submitted', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether to submit. false indicates submission, and true indicates draft status ', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of calling numbers ', + 'type' => 'array', + 'items' => [ + 'description' => 'Calling number ', + 'type' => 'string', + 'required' => false, + 'example' => '["4008013260"]', + 'title' => '', + ], + 'required' => false, + 'example' => '["95187"]', + 'maxItems' => 99, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'BatchJob' => [ + 'description' => 'Job group information', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'Creation Time of the job group', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579068424000', + 'title' => '', + ], + 'ScenarioId' => [ + 'description' => 'Scenario ID of the job group', + 'type' => 'string', + 'example' => '6cea9bed-63e6-439e-ae4c-b3333efff53d', + 'title' => '', + ], + 'JobGroupName' => [ + 'description' => 'Job group name', + 'type' => 'string', + 'example' => '批量作业01', + 'title' => '', + ], + 'BatchJobId' => [ + 'description' => 'Job group ID', + 'type' => 'string', + 'example' => '5a7e8b09-baf9-4cab-b540-c971f47a7146', + 'title' => '', + ], + 'JobFilePath' => [ + 'description' => 'Key of the uploaded Excel file', + 'type' => 'string', + 'example' => '52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx', + 'title' => '', + ], + 'JobGroupDescription' => [ + 'description' => 'Job group description ', + 'type' => 'string', + 'example' => '第一个批量作业', + 'title' => '', + ], + 'CallingNumbers' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'List of calling numbers ', + 'type' => 'string', + 'example' => '["4008013260 "]', + 'title' => '', + ], + 'description' => 'List of calling numbers ', + 'title' => '', + 'example' => '', + ], + 'Strategy' => [ + 'description' => 'Job execution policy', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Policy Type', + 'type' => 'string', + 'example' => 'Repeatable', + 'title' => '', + ], + 'StrategyName' => [ + 'description' => 'Policy name ', + 'type' => 'string', + 'example' => '策略', + 'title' => '', + ], + 'MaxAttemptsPerDay' => [ + 'description' => 'Maximum number of redial attempts after a failed call per day ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'title' => '', + ], + 'FollowUpStrategy' => [ + 'description' => 'Follow-up handling policy for outbound calls not completed in the previous epoch.', + 'type' => 'string', + 'example' => 'CONTINUE', + 'title' => '', + ], + 'EndTime' => [ + 'description' => 'Overall end time of the schedule policy', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2209702074000', + 'title' => '', + ], + 'Customized' => [ + 'description' => 'Custom policy information ', + 'type' => 'string', + 'example' => '{}', + 'title' => '', + ], + 'IsTemplate' => [ + 'description' => 'Indicates whether it is a template', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'Start time for job group execution', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578550074000', + 'title' => '', + ], + 'StrategyId' => [ + 'description' => 'Policy ID', + 'type' => 'string', + 'example' => 'f718798d-96be-40e4-bef6-317b54855708', + 'title' => '', + ], + 'RoutingStrategy' => [ + 'description' => 'Calling number recording policy ', + 'type' => 'string', + 'example' => 'LocalFirst', + 'title' => '', + ], + 'MinAttemptInterval' => [ + 'description' => 'Minimum retry interval', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'StrategyDescription' => [ + 'description' => 'Policy description ', + 'type' => 'string', + 'example' => '作业执行策略', + 'title' => '', + ], + 'RepeatBy' => [ + 'description' => 'Repetition mode: Once for no repetition, Day for daily repetition, Week for weekly repetition, Month for monthly repetition', + 'type' => 'string', + 'example' => 'Once', + 'title' => '', + ], + 'WorkingTime' => [ + 'description' => 'Execution time segments within a day for the job', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'End Time', + 'type' => 'string', + 'example' => '12:00:00', + 'title' => '', + ], + 'BeginTime' => [ + 'description' => 'Start Time', + 'type' => 'string', + 'example' => '09:00:00', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RepeatDays' => [ + 'description' => 'List of days for repeated execution. ', + 'type' => 'array', + 'items' => [ + 'description' => 'Repeat execution day ', + 'type' => 'string', + 'example' => '[1,2,3,4,5]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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 \\"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}","type":"json"}]', + 'title' => 'Batch Create Outbound Call Jobs – Deprecated ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateBatchJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateBatchRepeatJob' => [ + 'summary' => 'Copy an existing task group to reinitiate an outbound call job. ', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2bfa5ae4-7185-4227-a3b8-328f26f11be1', + 'title' => '', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job name', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '24', + 'title' => '', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job group description', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '测试3', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '0fe7f71c-8771-42ef-9bb1-19aa16ae7120', + 'title' => '', + ], + ], + [ + 'name' => 'SourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job group ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c4f8a3d3-2e94-4bd4-aef8-e35f663d4847', + 'title' => '', + ], + ], + [ + 'name' => 'FilterStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job group status', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Succeeded,NoInteraction,Failed,Cancelled', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job execution policy', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"maxAttemptsPerDay\\":1,\\"minAttemptInterval\\":1,\\"routingStrategy\\":\\"LocalFirst\\"}', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'RecallStrategyJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'Redial policy in JSON format ', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"emptyNumberIgnore\\":false,\\"inArrearsIgnore\\":false,\\"outOfServiceIgnore\\":false}', + 'title' => '', + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Calling number', + 'type' => 'array', + 'items' => [ + 'description' => 'Calling number', + 'type' => 'string', + 'required' => false, + 'example' => '03737075611', + 'title' => '', + ], + 'required' => false, + 'example' => '[]', + 'maxItems' => 100, + 'title' => '', + ], + ], + [ + 'name' => 'RingingDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'Ringing duration', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '25', + 'title' => '', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job priority', + 'type' => 'string', + 'required' => false, + 'example' => '10', + 'title' => '', + ], + ], + [ + 'name' => 'MinConcurrency', + 'in' => 'query', + 'schema' => [ + 'description' => 'Minimum concurrency', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + 'title' => '', + ], + ], + [ + 'name' => 'FlashSmsExtras', + 'in' => 'query', + 'schema' => [ + 'description' => 'Configuration parameters for flash SMS push, in JSON format, containing configuration information for third-party flash SMS. '."\n" + .'- templateId: Flash SMS Template ID. '."\n" + .'- configId: Flash SMS configuration ID.', + 'type' => 'string', + 'required' => false, + 'example' => '{"templateId":"10471","configId":"8037f524-6ff2-4dbe-bb28-f59234ea7a64"}'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'RecallCallingNumber', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'maxItems' => 100, + 'description' => 'List of caller numbers for redialing ', + 'type' => 'array', + 'items' => [ + 'description' => 'Caller number for redialing ', + 'type' => 'string', + 'required' => false, + 'example' => '4008013260', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP error code ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message ', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID ', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'JobGroup' => [ + 'description' => 'Job group information ', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Job group ID ', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'RingingDuration' => [ + 'description' => 'Ringing duration ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + 'title' => '', + ], + 'Priority' => [ + 'description' => 'Job priority ', + 'type' => 'string', + 'example' => '3', + 'title' => '', + ], + 'MinConcurrency' => [ + 'description' => 'Minimum concurrency ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Copy a task group to reinitiate an outbound call ', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-06-24T02:14:42.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-01-04T12:35:21.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2021-12-22T12:30:34.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2021-12-22T12:30:34.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateBatchRepeatJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateBeebotIntent' => [ + 'summary' => 'CreateBeebotIntent', + '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' => 'Instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a', + 'title' => '', + ], + ], + [ + 'name' => 'IntentDefinition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Intent definition description', + 'type' => 'object', + 'properties' => [ + 'IntentName' => [ + 'description' => 'Intent name'."\n" + ."\n" + .'> This serves as the intent code and is a UUID.', + 'type' => 'string', + 'required' => true, + 'example' => '知道了', + 'title' => '', + ], + 'AliasName' => [ + 'description' => 'Intent alias', + 'type' => 'string', + 'required' => false, + 'example' => '嗯明白了', + 'title' => '', + ], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n", + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'BeebotRequestId' => [ + 'description' => 'Internal request ID', + 'type' => 'string', + 'example' => '497CFAFF-48CC-161A-AD2C-252DED569037', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'IntentId' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10717802', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Small Model API] Create a Beemind Bot Intent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateBeebotIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateBeebotIntentLgf' => [ + 'summary' => 'CreateBeebotIntentLgf', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'LgfDefinition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'LGF definition information', + 'type' => 'object', + 'properties' => [ + 'IntentId' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10717802', + 'title' => '', + ], + 'RuleText' => [ + 'description' => 'Intent configuration', + 'type' => 'string', + 'required' => true, + 'example' => '我是一个问法模版', + 'title' => '', + ], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Response message', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP error code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'LgfId' => [ + 'description' => 'Utterance template ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5666117', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'True', + 'title' => '', + ], + 'BeebotRequestId' => [ + 'description' => 'Internal request ID', + 'type' => 'string', + 'example' => '497CFAFF-48CC-161A-AD2C-252DED569037', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API prompt message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Small Model API] Create an intent utterance template for a Beembot', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateBeebotIntentLgf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateBeebotIntentUserSay' => [ + 'summary' => 'CreateBeebotIntentUserSay', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'UserSayDefinition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'User utterance definition description', + 'type' => 'object', + 'properties' => [ + 'IntentId' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10717802', + 'title' => '', + ], + 'Content' => [ + 'description' => 'User utterance', + 'type' => 'string', + 'required' => true, + 'example' => '你知道xxxxx么？', + 'title' => '', + ], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'UserSayId' => [ + 'description' => 'User utterance ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17448458', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Is succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'BeebotRequestId' => [ + 'description' => 'Internal request ID', + 'type' => 'string', + 'example' => '0B219FCB-EC71-1F08-BB1B-0E87C20158C8', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Small Model API] Create User Utterances for a Beembot Intent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateBeebotIntentUserSay', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateDialogueFlow' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', + 'title' => '', + ], + ], + [ + 'name' => 'DialogueName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Conversation flow name', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '主流程', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd0bf93dd-1a54-4f00-819e-c75502d38681', + 'title' => '', + ], + ], + [ + 'name' => 'DialogueFlowType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow type. Valid values: SubFlow (child flow) and MainFlow (main flow)', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MainFlow', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'DialogueFlowId' => [ + 'description' => 'Conversation flow ID', + 'type' => 'string', + 'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Create Conversation Flow – Legacy Canvas API', + 'summary' => 'Create a conversation flow using the legacy canvas API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateDialogueFlow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateDownloadUrl' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'DownloadTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Download task ID. '."\n" + .'> You can obtain this parameter from the TaskId field in the response of the ListDownloadTasks API.', + 'type' => 'string', + 'required' => true, + 'example' => '137da36b41304bcd999a0a7895dc6881', + 'title' => '', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => 'File ID. '."\n" + .'> You can obtain this parameter from the FileId field in the response of the ListDownloadTasks API.', + 'type' => 'string', + 'required' => true, + 'example' => '6f91885fa24b4c408d8f4eb392fd8ae6', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'FileHttpUrl' => [ + 'description' => 'File URL', + 'type' => 'string', + 'example' => 'http://www.xxx.com/xxx', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'EC08CC41-6870-5594-939A-F758F057898F', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Create a download file URL', + 'summary' => 'Create a URL link for a Download Hub job.', + 'changeSet' => [ + [ + 'createdAt' => '2021-11-24T13:00:44.000Z', + 'description' => 'OpenAPI offline', + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateDownloadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'CreateGlobalQuestion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'GlobalQuestionName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name of the global question', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '未识别全局问题', + 'title' => '', + ], + ], + [ + 'name' => 'GlobalQuestionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Type of the global question', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'COMMON', + 'title' => '', + ], + ], + [ + 'name' => 'Questions', + 'in' => 'query', + 'schema' => [ + 'description' => 'Global question', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["未识别的用户问题"]', + 'title' => '', + ], + ], + [ + 'name' => 'Answers', + 'in' => 'query', + 'schema' => [ + 'description' => 'Answer to the global question', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["你好,您可以再说一遍吗","不好意思我刚才没有听清"]', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'GlobalQuestionId' => [ + 'description' => 'Global question ID', + 'type' => 'string', + 'example' => 'a546b616-724b-437f-bdb3-629a30c98567', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '56666881-887A-530A-B679-C3B6B6B142C0', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Legacy Canvas API] Create Global Question', + 'summary' => 'Create a global question in the legacy canvas scenario.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateGlobalQuestion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance name.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '第一个实例', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance description.', + 'type' => 'string', + 'required' => false, + 'example' => '这个是第一的实例', + 'title' => '', + ], + ], + [ + 'name' => 'MaxConcurrentConversation', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum concurrent conversations for the instance.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 14 => '14', + ], + 'example' => '4', + 'title' => '', + ], + ], + [ + 'name' => 'NluServiceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service type.'."\n" + ."\n" + .'> If this parameter is not specified, the default value is Managed.'."\n" + ."\n" + .'- DialogStudio: Conversation Engine 3.0.'."\n" + ."\n" + .'- Authorized: Public Cloud Conversation Bot. This refers to the Intelligent Speech Interaction product service purchased by public cloud customers (a private customer service). Authorization is completed via Scenario Management > Edit > Invoke Service > Custom Service.'."\n" + ."\n" + .'- Provided: On Premises Deployment Conversation Bot.'."\n" + ."\n" + .'- Managed: Legacy outbound calling canvas. This is the default Intelligent Speech Interaction product service (public service) for Intelligent Outbound Calling products.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Authorized' => '', + 'Provided' => '', + ], + 'example' => 'DialogStudio', + 'enum' => [ + 'Managed', + 'Authorized', + 'Provided', + 'Baseme', + 'Ant', + 'Notification', + 'MyBankJustice', + 'DialogStudio', + ], + 'title' => '', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n" + ."\n" + .'> You can obtain this from the Resource Management document. For more information, see the following link: https://api.aliyun.com/document/ResourceManager/2020-03-31/ListResourceGroups', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmwd4qr3z773y', + 'title' => '', + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of calling numbers.'."\n" + ."\n" + .'> This parameter is left empty by default.', + 'type' => 'array', + 'items' => [ + 'description' => 'A calling number.'."\n" + ."\n" + .'> This parameter is left empty by default.', + 'type' => 'string', + 'required' => false, + 'example' => '4008013260', + 'title' => '', + ], + 'required' => false, + 'maxItems' => 99, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'The status code.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message. ', + 'type' => 'string', + 'example' => '无', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID. ', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Instance' => [ + 'description' => 'Business instance information. ', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'Creation Time, in milliseconds. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578469042851', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Business instance ID. ', + 'type' => 'string', + 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', + 'title' => '', + ], + 'CreatorId' => [ + 'description' => 'Creator ID. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '435986', + 'title' => '', + ], + 'OwnerName' => [ + 'description' => 'Owner name. ', + 'type' => 'string', + 'example' => 'xxxx', + 'title' => '', + ], + 'InstanceDescription' => [ + 'description' => 'Business instance description. ', + 'type' => 'string', + 'example' => '这个是第一个实例', + 'title' => '', + ], + 'InstanceName' => [ + 'description' => 'Business instance name. ', + 'type' => 'string', + 'example' => '第一个实例', + 'title' => '', + ], + 'CreatorName' => [ + 'description' => 'Creator name. ', + 'type' => 'string', + 'example' => 'xxx', + 'title' => '', + ], + 'ResourceGroupId' => [ + 'description' => 'Resource group ID. ', + 'type' => 'string', + 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', + 'title' => '', + ], + 'MaxConcurrentConversation' => [ + 'description' => 'Maximum concurrent conversations for the instance. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Create a business instance', + 'summary' => 'Create an Intelligent Outbound Call business instance. ', + 'changeSet' => [ + [ + 'createdAt' => '2022-06-28T12:45:55.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-06-22T02:25:50.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateInstanceBindNumber' => [ + 'summary' => 'Attach a number to a business instance.', + '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' => 'The number to attach (Required)'."\n" + ."\n" + .'> For the list of numbers, refer to the Number parameter returned by the ListAllTenantBindNumberBinding API.', + 'type' => 'string', + 'required' => true, + 'example' => '15005059355', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'InstanceList', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'List of Intelligent Outbound Calling instance IDs'."\n" + ."\n" + .'> Modifying this parameter overwrites the previous value. Setting this parameter to empty clears the number attachment list.', + 'type' => 'string', + 'required' => false, + 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf'."\n" + .',123*****09,456*****08', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<CreateInstanceBindNumberResponse>', + 'description' => 'BaseResponse<CreateInstanceBindNumberResponse>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Returned data', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'List of number data', + 'type' => 'array', + 'items' => [ + 'description' => 'List of number data', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => '96b847ad-2683-4794-b7b4-7ef094fb81f6', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the attachment succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Attach a number to an instance', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-03-01T12:36:05.000Z', + 'description' => 'OpenAPI offline', + ], + ], + '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' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateIntent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'docRequired' => true, + 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'docRequired' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'IntentName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent name', + 'docRequired' => true, + 'example' => '是本人', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'IntentDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent description', + 'example' => '确定是本人的意图', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'Utterances', + 'in' => 'query', + 'schema' => [ + 'description' => 'User utterances', + 'docRequired' => true, + 'example' => '["是","是的","是啊","嗯嗯","是我","是我，有事吗","对，是","对的","对是我",""]', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'Keywords', + 'in' => 'query', + 'schema' => [ + 'description' => 'Keyword', + 'example' => '["是","是的"]', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'IntentId' => [ + 'description' => 'Intent ID', + 'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Legacy Canvas API] Create Intent', + 'summary' => 'Create a trigger intent in the legacy canvas scenario.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateJobDataParsingTask' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94038', + 'abilityTreeNodes' => [ + 'FEATUREoutboundbot7ZIYMY', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobFilePath', + 'in' => 'query', + 'schema' => [ + 'description' => 'File Path of the job'."\n" + ."\n" + .'> This parameter corresponds to the Folder value returned by the GetJobDataUploadParams API.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'UPLOADED/JOB/024f8cf0-c842-4c01-b74b-c8667e4579c7/e5897675-91f0-4e53-8af8-7e1ce4f2c089_KDC HR- 外呼话术2- 外呼名单模板 - Copy.xlsx', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'b3865dc3-40fa-4afd-9fe4-dc7cda305a24', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'JobDataParsingTaskId' => [ + 'description' => 'The ID of the uploaded job.'."\n" + ."\n" + .'> This parameter will be used as the JobDataParsingTaskId parameter in the DescribeJobDataParsingTaskProgress API.', + 'type' => 'string', + 'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Create a Data Parsing job', + 'summary' => 'Create a Data Parsing job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateJobDataParsingTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateJobGroup' => [ + 'summary' => 'Create a job group.', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task name.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '第一个任务', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task description.', + 'type' => 'string', + 'required' => false, + 'example' => '任务描述', + 'title' => '', + ], + ], + [ + 'name' => 'ScenarioId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Deprecated', + 'type' => 'string', + 'required' => false, + 'example' => 'b9ff4e88-65f9-4eb3-987c-11ba51f3f24d'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'b9ff4e88-65f9-4eb3-987c-11ba51f3f24d', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'StrategyJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job execution policy. '."\n" + .'- repeatBy: Recurrence type. Options are Once (no recurrence), Week (weekly recurrence), and Month (monthly recurrence). '."\n" + .'- startTime: Policy start time for time-based execution. '."\n" + .'- endTime: Policy end time for time-based execution. '."\n" + .'> Execution modes are as follows: '."\n" + .'> - If no start or end time is specified, the job executes immediately. '."\n" + .'> - If start and end times are provided, the job executes based on the schedule, and a recurrence type (repeatBy) must be selected. '."\n" + .'- workingTime: Allowed outbound calling time segment. '."\n" + .'- maxAttemptsPerDay: Maximum number of call attempts per day for numbers under this job. '."\n" + .'- minAttemptInterval: Minimum time interval between retry calls for a number, in minutes. '."\n" + .'- routingStrategy: Number routing strategy. Options are None (not specified), LocalFirst (local city numbers prioritized), and LocalProvinceFirst (local province numbers prioritized). '."\n" + .'- repeatDays: Execution dates corresponding to the recurrence type. If repeatBy is Week, 0 represents Sunday and 1–6 represent Monday through Saturday. If repeatBy is Month, values 1–31 represent the 1st through the 31st day of the month; months without the specified date skip execution (for example, if the 30th is selected, February skips execution). '."\n" + .'- repeatable: Whether loop task is enabled, 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"}', + 'title' => '', + ], + ], + [ + 'name' => 'RecallStrategyJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'Redial policy in JSON format. The default value of parameters in the JSON is false.'."\n" + ."\n" + .'- **emptyNumberIgnore**: Do not make outbound calls to nonexistent numbers.'."\n" + .'- **inArrearsIgnore**: Do not make outbound calls for overdue payments.'."\n" + .'- **outOfServiceIgnore**: Do not make outbound calls to out-of-service numbers.', + 'type' => 'string', + 'required' => false, + 'example' => '{"emptyNumberIgnore":true,"inArrearsIgnore":true,"outOfServiceIgnore":true}', + 'title' => '', + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of caller numbers. If not specified, all numbers attached to the instance are selected by default.', + 'type' => 'array', + 'items' => [ + 'description' => 'Caller number.', + 'type' => 'string', + 'required' => false, + 'example' => '4008013260', + 'title' => '', + ], + 'required' => false, + 'maxItems' => 99, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'RingingDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'Optimal ringing duration. Default value is 25.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '25', + 'title' => '', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job group priority. Valid values:'."\n" + .'- **Urgent**: Urgent job.'."\n" + .'- **Daily**: Daily job.', + 'type' => 'string', + 'required' => false, + 'example' => 'Daily', + 'enum' => [ + 'Daily', + 'Urgent', + ], + 'title' => '', + ], + ], + [ + 'name' => 'MinConcurrency', + 'in' => 'query', + 'schema' => [ + 'description' => 'Concurrent guarantee value. '."\n" + .'- When a job starts, it is guaranteed a minimum of N concurrent executions. '."\n" + .'- The sum of concurrent guarantee values for jobs with the same priority must not exceed the instance concurrency limit. '."\n" + .'- If the concurrent guarantee value is configured as 0, the system intelligently assigns idle concurrency resources.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'FlashSmsExtras', + 'in' => 'query', + 'schema' => [ + 'description' => 'Configuration parameters for flash SMS push, in JSON format, containing third-party flash SMS configuration information. '."\n" + .'- templateId: Flash SMS Template ID. '."\n" + .'- configId: Flash SMS configuration ID. '."\n" + .'- templateContent: Flash SMS Content. '."\n" + ."\n" + .'> Obtain the value of templateContent from the partner providing the flash SMS capability.', + 'type' => 'string', + 'required' => false, + 'example' => '{"templateId":"104xx","configId":"8037f524-6fxxxxx", "templateContent": "【智能外呼机器人】给您来电，敬请接听！"}', + 'title' => '', + ], + ], + [ + 'name' => 'RecallCallingNumber', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'maxItems' => 99, + 'description' => 'List of caller numbers for redial.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of caller numbers used for redial when the first call fails. If not specified, it defaults to the same list as the original caller numbers.', + 'type' => 'string', + 'required' => false, + 'example' => '["4008013260"]', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP return code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Message.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'JobGroup' => [ + 'description' => 'Job information.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Task status.', + 'type' => 'string', + 'example' => 'Scheduling', + 'title' => '', + ], + 'ScenarioId' => [ + 'description' => 'Scenario ID.', + 'type' => 'string', + 'example' => '6cea9bed-63e6-439e-ae4c-b3333efff53d', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Task ID.', + 'type' => 'string', + 'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9', + 'title' => '', + ], + 'CreationTime' => [ + 'description' => 'Creation Time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578550074361', + 'title' => '', + ], + 'JobGroupName' => [ + 'description' => 'Task Name.', + 'type' => 'string', + 'example' => '第一个作业组', + 'title' => '', + ], + 'JobFilePath' => [ + 'description' => 'OSS path of the job file. '."\n" + .'> If empty, it is not returned.', + 'type' => 'string', + 'example' => 'UPLOADED/JOB/b3865dc3-40fa-4afd-9fe4-dc7cda305a24/229eac13-379d-4abe-96e0-8cf026b56c0b_template (1).xlsx', + 'title' => '', + ], + 'JobGroupDescription' => [ + 'description' => 'Task description.', + 'type' => 'string', + 'example' => '第一个的作业组', + 'title' => '', + ], + 'JobDataParsingTaskId' => [ + 'description' => 'The ID of the asynchronous parsing operation in the backend corresponding to the uploaded job file. '."\n" + .'> If empty, it is not returned.', + 'type' => 'string', + 'example' => '744ff448-2b4c-40d4-94ca-51f246905b0f', + 'title' => '', + ], + 'ScriptName' => [ + 'description' => 'Scenario name.', + 'type' => 'string', + 'example' => '话术', + 'title' => '', + ], + 'ScriptVersion' => [ + 'description' => 'Script scenario version.', + 'type' => 'string', + 'example' => '1628425608429', + 'title' => '', + ], + 'ModifyTime' => [ + 'description' => 'Updated At.', + 'type' => 'string', + 'example' => '1628425608429', + 'title' => '', + ], + 'CallingNumbers' => [ + 'description' => 'List of calling numbers.', + 'type' => 'array', + 'items' => [ + 'description' => 'Calling number.', + 'type' => 'string', + 'example' => '["4008013260"]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ExportProgress' => [ + 'description' => 'Export progress. '."\n" + .'> This field is deprecated in the current parameter.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Job export status. [Deprecated]', + 'type' => 'string', + 'example' => 'FINISHED', + 'title' => '', + ], + 'FileHttpUrl' => [ + 'description' => 'File URL. [Deprecated]', + 'type' => 'string', + 'example' => 'https://***.oss-cn-shanghai.aliyuncs.com/sample', + 'title' => '', + ], + 'Progress' => [ + 'description' => 'Progress. [Deprecated]', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Strategy' => [ + 'description' => 'Job scheduling policy.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Policy Type.', + 'type' => 'string', + 'example' => 'Repeatable', + 'title' => '', + ], + 'StrategyName' => [ + 'description' => 'Policy Name.', + 'type' => 'string', + 'example' => '催收策略', + 'title' => '', + ], + 'MaxAttemptsPerDay' => [ + 'description' => 'The maximum number of attempts per day when a call in the job fails to connect.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'title' => '', + ], + 'FollowUpStrategy' => [ + 'description' => 'Post-execution handling method after the epoch ends (this field is deprecated).', + 'type' => 'string', + 'example' => 'CONTINUE', + 'title' => '', + ], + 'EndTime' => [ + 'description' => 'End Time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2209702074000', + 'title' => '', + ], + 'Customized' => [ + 'description' => 'Custom policy data', + 'type' => 'string', + 'example' => '{}', + 'title' => '', + ], + 'IsTemplate' => [ + 'description' => 'Indicates whether it is a template.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'Start Time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578550074000', + 'title' => '', + ], + 'StrategyId' => [ + 'description' => 'Policy ID.', + 'type' => 'string', + 'example' => 'cc9a436e-03b0-4ada-8364-77ec2290aa39', + 'title' => '', + ], + 'RoutingStrategy' => [ + 'description' => 'Number routing policy.'."\n" + .'- None: No special rule.'."\n" + .'- LocalFirst: Local city numbers are prioritized.'."\n" + .'- LocalProvinceFirst: Numbers from the same province are prioritized.', + 'type' => 'string', + 'example' => 'LocalFirst', + 'title' => '', + ], + 'MinAttemptInterval' => [ + 'description' => 'Calling interval.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'title' => '', + ], + 'StrategyDescription' => [ + 'description' => 'Policy Description', + 'type' => 'string', + 'example' => '催收策略', + 'title' => '', + ], + 'RepeatBy' => [ + 'description' => 'Repetition mode: "once" for no repetition, "day" for daily repetition, "week" for weekly repetition, and "month" for monthly repetition.', + 'type' => 'string', + 'example' => 'Once', + 'title' => '', + ], + 'WorkingTime' => [ + 'description' => 'Time window for policy execution.', + 'type' => 'array', + 'items' => [ + 'description' => 'Time window for policy execution.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'Start Time of the window.', + 'type' => 'string', + 'example' => '12:00:00', + 'title' => '', + ], + 'BeginTime' => [ + 'description' => 'End Time of the window.', + 'type' => 'string', + 'example' => '09:00:00', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RepeatDays' => [ + 'description' => 'Days on which execution repeats.'."\n" + .'- If the recurrence **RepeatBy** is set to **Week**, 0 represents Sunday, and 1–6 represent Monday through Saturday, respectively.'."\n" + .'- If the recurrence **RepeatBy** is set to **Month**, values 1–31 represent the 1st through the 31st day of the month. Months that do not contain the specified date will not execute the task. For example, if the 30th is selected, the task will not run in February.', + 'type' => 'array', + 'items' => [ + 'description' => 'Days on which execution repeats.', + 'type' => 'string', + 'example' => '[1,2,3,4,5]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'RecallStrategy' => [ + 'description' => 'Redial policy.', + 'type' => 'object', + 'properties' => [ + 'EmptyNumberIgnore' => [ + 'description' => 'Do not make outbound calls to nonexistent numbers.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'InArrearsIgnore' => [ + 'description' => 'Do not make outbound calls to numbers with overdue payment.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'OutOfServiceIgnore' => [ + 'description' => 'Do not make outbound calls to numbers that are out of service.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'RingingDuration' => [ + 'description' => 'Ringing duration.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + 'title' => '', + ], + 'Priority' => [ + 'description' => 'Job group priority. Valid values: '."\n" + .'- **Urgent**: Urgent job. '."\n" + .'- **Daily**: Daily job.', + 'type' => 'string', + 'example' => 'Daily', + 'title' => '', + ], + 'MinConcurrency' => [ + 'description' => 'Concurrent guarantee value. '."\n" + .'When the job starts, it guarantees a minimum of N concurrent instances. '."\n" + .'The sum of concurrent guarantee values for jobs with the same priority must not exceed the instance concurrency limit. '."\n" + .'If the concurrent guarantee value is set to 0, the system intelligently assigns available idle concurrency.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + 'RecallCallingNumbers' => [ + 'description' => 'List of recall calling numbers', + 'type' => 'array', + 'items' => [ + 'description' => 'List of recall calling numbers, used for redialing when the first call fails. If not specified, it defaults to the same list as the calling numbers.', + 'type' => 'string', + 'example' => '["4008013260"]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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 \\"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}","type":"json"}]', + 'title' => 'Create an outbound call task group', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-06-24T02:14:42.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2024-01-04T12:35:21.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-06-28T12:45:55.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2021-12-22T12:30:34.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2021-12-22T12:30:34.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateJobGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'CreateJobGroupExportTask' => [ + 'summary' => 'Create an outbound job group export task.', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID (Required)', + 'type' => 'string', + 'required' => false, + 'example' => 'baf6dfdc-eb79-4c63-ab19-c56388b1fbdd', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'Option', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Runtime parameters for the import job', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'Specifies whether to ignore recordings. '."\n" + .'- Default value: empty. Text and recordings are exported. '."\n" + .'- IgnoreRecording: Recordings are ignored.', + 'example' => 'IgnoreRecording', + 'title' => '', + ], + 'required' => false, + 'example' => '[]', + 'maxItems' => 99, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Error code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'TaskId' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'example' => '744b27f3-437f-4a8c-a181-f668e492fd24', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Create an outbound job group export task', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateJobGroupExportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateScript' => [ + 'summary' => 'Create a scenario.', + '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' => 'Instance ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script Name ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '课程满意度回访', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script description ', + 'type' => 'string', + 'required' => false, + 'example' => '课程回复话术', + 'title' => '', + ], + ], + [ + 'name' => 'Industry', + 'in' => 'query', + 'schema' => [ + 'description' => 'Associated industry ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '教育', + 'title' => '', + ], + ], + [ + 'name' => 'Scene', + 'in' => 'query', + 'schema' => [ + 'description' => 'Associated scenario ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '回访', + 'title' => '', + ], + ], + [ + 'name' => 'ChatbotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'When the NluServiceType of the instance is Authorized or Provided, you must use this field to specify the instance ID of the chatbot to which the script is attached. ', + 'type' => 'string', + 'required' => false, + 'example' => 'chatbot-cn-IfaUfqaUnb', + 'title' => '', + ], + ], + [ + 'name' => 'AsrConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'ASR configuration and parameter definitions '."\n" + ."\n" + .'- **appKey**: Alibaba Cloud account appKey. '."\n" + .'- **maxEndSilence**: Speech endpoint detection duration. '."\n" + .'- **silenceTimeout**: Silence timeout, in seconds. The system times out after the user remains silent for N seconds. '."\n" + ."\n" + .'- **engine**: Service to invoke; valid values: [`ali`, `xunfei`] '."\n" + .'- **nlsServiceType**: Service type to invoke; valid values: [`Managed`, `Authorized`] '."\n" + .'- **engineXunfei**: Configuration required when the engine is set to `xunfei`. '."\n" + .'> When `engine` is set to `ali` and `nlsServiceType` is `Authorized`, a custom service provided by Alibaba Cloud is used. When `engine` is `ali` and `nlsServiceType` is `Managed`, the default service is used. When `engine` is `xunfei` and `nlsServiceType` is `Authorized`, the service provider is Xunfei, and the corresponding Xunfei configuration must be provided, for example: `{"uuid":"ed2xxxxxxxxx","globalMaxEndSilence":700,"globalMaxEndSilenceEnable":true}` '."\n" + ."\n" + .'- **globalMaxEndSilence**: Silence detection duration, in milliseconds. '."\n" + ."\n" + .'- **globalMaxEndSilenceEnable**: Silence detection toggle, enabled by default. '."\n" + ."\n" + .'- **speechNoiseThreshold**: Noise filtering threshold ', + '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" + .'}', + 'title' => '', + ], + ], + [ + 'name' => 'TtsConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'TTS configuration parameters: '."\n" + ."\n" + .'- **voice**: Voice speaker. '."\n" + .'- **volume**: Volume, range: 0–100. Default Value: 50. '."\n" + .'- **speechRate**: Speech rate, range: -500–500. Default Value: 0. '."\n" + .'- **pitchRate**: Pitch, range: -500–500. Default Value: 0. '."\n" + ."\n" + .'- **globalInterruptible**: Speech interruption configuration. '."\n" + .'- **engine**: Invoked service; options: [ali, volc, xunfei]. xunfei is not supported in LLM scenarios. '."\n" + .'- **nlsServiceType**: Service Type; options: [Managed, Authorized]. '."\n" + .'- **engineXunfei**: Configuration when the service provider is xunfei. '."\n" + ."\n" + .'> 1. When engine is ali and nlsServiceType is Authorized, a Custom service is used. '."\n" + .'> 2. When engine is ali and nlsServiceType is Managed, the default service is used. '."\n" + .'> 3. When engine is xunfei (applicable only in non-LLM scenarios) and nlsServiceType is Authorized, the service provider is xunfei, and engineXunfei must be configured as {"pitchRate":50,"speechRate":50,"voice":"aisjiuxu","volume":50}. '."\n" + .'> 4. When engine is volc and nlsServiceType is Authorized, the service used is 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" + .'}', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptContent', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'For notification-type instances, pass in a list of scripts. '."\n" + .'Deprecated. ', + 'type' => 'array', + 'items' => [ + 'description' => 'For notification-type instances, pass in a list of scripts. '."\n" + .'Deprecated. ', + 'type' => 'string', + 'required' => false, + 'example' => '您好，您昨晚在李佳琦直播间下单的娜薇诗椰子水二代精华2支装还未付款，超时未支付会自动关闭订单，活动错过不再有奥。', + 'title' => '', + ], + 'required' => false, + 'example' => '[]', + 'maxItems' => 100, + 'title' => '', + ], + ], + [ + 'name' => 'ScriptWaveform', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'For notification-type instances, specify a list of script audio files. '."\n" + .'Deprecated. ', + 'type' => 'array', + 'items' => [ + 'description' => 'For notification-type instances, specify a list of script audio files. '."\n" + .'Deprecated. ', + 'type' => 'string', + 'required' => false, + 'example' => '[]', + 'title' => '', + ], + 'required' => false, + 'example' => '[]', + 'maxItems' => 100, + 'title' => '', + ], + ], + [ + 'name' => 'MiniPlaybackEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Follow-up utterance configuration Toggle (applicable only in non-LLM scenarios) ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'NewBargeInEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Graceful interruption toggle (applicable to small models) ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'LongWaitEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intelligent sentence segmentation Toggle (applicable only in non-LLM scenarios) ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'EmotionEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Emotion detection configuration Toggle (applicable only in non-LLM scenarios) ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'Access key for the robot workspace ', + 'type' => 'string', + 'required' => false, + 'example' => '9137ab9c27044921860030adf8590ec4_p_outbound_public', + 'title' => '', + ], + ], + [ + 'name' => 'AgentLlm', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether the robot workspace is an LLM workspace ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Robot workspace ID ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1198938', + 'title' => '', + ], + ], + [ + 'name' => 'NluEngine', + 'in' => 'query', + 'schema' => [ + 'enumValueTitles' => [ + 'Prompts' => 'Text Input Pattern ', + 'SSE_FUNCTION' => 'Function Compute Service Pattern ', + ], + 'description' => 'NLU engine (applicable only in LLM scenarios; empty for non-LLM scenarios). '."\n" + ."\n" + .'- Prompts: LLM scenario. '."\n" + .'- SSE_FUNCTION: Function Compute pattern. '."\n" + .'- BeeBot: pipeline pattern. ', + 'type' => 'string', + 'required' => false, + 'example' => 'Prompts', + 'title' => '', + ], + ], + [ + 'name' => 'NluAccessType', + 'in' => 'query', + 'schema' => [ + 'description' => 'NLU access method (applicable only to LLM scenarios). Enumeration: `Managed`—uses the public Alibaba Cloud account for access. Leave empty for non-LLM scenarios. ', + 'type' => 'string', + 'required' => false, + 'example' => 'Managed', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptNluProfileJsonString', + 'in' => 'query', + 'schema' => [ + 'description' => '> When nluEngine is set to SSE_FUNUNCTION, you must provide the corresponding configuration.'."\n" + ."\n" + .'Function Compute service mode configuration:'."\n" + ."\n" + .'- fcRegion: Function Compute region '."\n" + .'- fcFunction: Function name '."\n" + ."\n" + .'- fcHttpTriggerUrl: Function trigger URL', + 'type' => 'string', + 'required' => false, + 'example' => '{"fcRegion":"cn-shanghai","fcFunction":"waihu_test","fcHttpTriggerUrl":"https://waihu-test.xxxxxxxxxxx.cn-shanghai-vpc.fcapp.run"}', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID ', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message ', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Script' => [ + 'description' => 'Script information', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Job status. Valid values:'."\n" + ."\n" + .'- **DRAFTED**: Draft.'."\n" + .'- **INITIALIZE_IN_PROGRESS**: Initializing.'."\n" + .'- **PUBLISHED**: Published.'."\n" + .'- **PUBLISH_IN_PROGRESS**: Publishing.'."\n" + .'- **ROLLBACK_IN_PROGRESS**: Rolling back.'."\n" + .'- **EXAMINE_IN_PROGRESS**: Pending review.'."\n" + .'- **PUBLISHED_AND_EXAMINE_IN_PROGRESS**: Published and pending review.'."\n" + .'- **PUBLISH_FAILED**: Publish failed.'."\n" + .'- **ROLLBACK_FAILED**: Rollback failed.'."\n" + .'- **IMPORT_IN_PROGRESS**: Importing.'."\n" + .'- **IMPORT_FAILED**: Import failed.', + 'type' => 'string', + 'example' => 'DRAFTED', + 'title' => '', + ], + 'UpdateTime' => [ + 'description' => 'Script update time (in milliseconds)', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578474045152', + 'title' => '', + ], + 'Industry' => [ + 'description' => 'Industry', + 'type' => 'string', + 'example' => '教育', + 'title' => '', + ], + 'ScriptDescription' => [ + 'description' => 'Script description', + 'type' => 'string', + 'example' => '课程满意度回访', + 'title' => '', + ], + 'IsDrafted' => [ + 'description' => 'Indicates whether the script is a draft.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'DebugStatus' => [ + 'description' => 'Script debug status ', + 'type' => 'string', + 'example' => 'DRAFTED', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Script ID', + 'type' => 'string', + 'example' => '8c58d3e0-bf27-4685-a5a5-65872ec5abc4', + 'title' => '', + ], + 'IsDebugDrafted' => [ + 'description' => 'Indicates whether the script is a debug draft ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ScriptName' => [ + 'description' => 'Script name', + 'type' => 'string', + 'example' => '课程满意度回访', + 'title' => '', + ], + 'Scene' => [ + 'description' => 'Associated scenario ', + 'type' => 'string', + 'example' => '回访', + 'title' => '', + ], + 'NluEngine' => [ + 'description' => 'NLU engine (applicable only to LLM scenarios). Enumeration: Prompts—used for LLM scenarios. This field is empty for non-LLM scenarios.', + 'type' => 'string', + 'example' => 'Prompts', + 'title' => '', + ], + 'NluAccessType' => [ + 'description' => 'NLU access method (applicable only to LLM scenarios). Enumeration: Managed—uses an Alibaba public account for access. This field is empty for non-LLM scenarios.', + 'type' => 'string', + 'example' => 'Managed', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '', + ], + ], + ], + 'title' => 'Create Scenario ', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-25T07:27:13.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-08-06T12:39:33.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2024-04-25T12:17:46.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2023-01-09T10:51:59.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2022-08-09T13:08:14.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-06-21T12:54:40.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2021-12-22T12:30:26.000Z', + 'description' => 'Request parameters changed', + ], + ], + '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}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreateScriptWaveform' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'Instance ID', + 'example' => '2bfa5ae4-7185-4227-a3b8-328f26f11be1', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'Scenario ID', + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptContent', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'Script text to be broadcast in the recording', + 'example' => '您好，您昨晚在李佳琦直播间下单的娜薇诗椰子水二代精华2支装还未付款，超时未支付会自动关闭订单，活动错过不再有奥。', + 'title' => '', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'Recording file ID'."\n" + ."\n" + .'> Obtain this parameter from the Folder parameter in the GetJobDataUploadParams API.', + 'example' => '6f91885fa24b4c408d8f4eb392fd8ae6', + 'title' => '', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'Recording file name', + 'example' => 'faaf8508-9542-4ac4-84a2-0ddcbb5f79a6 (2).json', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => 'HTTP status code', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'type' => 'string', + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'type' => 'boolean', + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'type' => 'string', + 'description' => 'Status code', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'type' => 'string', + 'description' => 'Script information', + 'example' => 'Success', + 'title' => '', + ], + 'ScriptWaveformId' => [ + 'type' => 'string', + 'description' => 'Script recording ID', + 'example' => 'df8216aa-d8f6-4501-864f-f8334d946561', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Deprecated] Create a scene audio recording in the legacy canvas', + 'summary' => 'Create a recording of the script for voice broadcasting.', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateScriptWaveform', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateTag' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'docRequired' => true, + 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'docRequired' => true, + 'example' => '0fe7f71c-8771-42ef-9bb1-19aa16ae7120', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'TagName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Tag name', + 'docRequired' => true, + 'example' => '研究生', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'TagGroup', + 'in' => 'query', + 'schema' => [ + 'description' => 'Tag group information', + 'docRequired' => true, + 'example' => '目标学历', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API response message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'TagId' => [ + 'description' => 'Tag ID', + 'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Create Label – For Use in Legacy Canvas', + 'summary' => 'Create a label for use in the legacy canvas.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'CreateTaskExportTask' => [ + 'summary' => 'Create an asynchronous task to export outbound call history.', + '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' => 'Instance ID ', + 'type' => 'string', + 'required' => true, + 'example' => '1dcb09c5-d5db-4397-bf65-db854463beea', + 'title' => '', + ], + ], + [ + 'name' => 'TaskCreateTimeGte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Start time for task creation time search ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1646496000000', + 'title' => '', + ], + ], + [ + 'name' => 'TaskCreateTimeLte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Creation Time search end time for Job', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1646582400000', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID ', + 'type' => 'string', + 'required' => false, + 'example' => 'cb731aee-0a5b-4c2b-924c-d9e82eb1d8d7', + 'title' => '', + ], + ], + [ + 'name' => 'HasAnswered', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether there was an acknowledgement', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'HasHangUpByRejection', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether the call was hung up due to rejection', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'HasReachedEndOfFlow', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether the conversation has ended ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupNameQuery', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task Name ', + 'type' => 'string', + 'required' => false, + 'example' => '测试_20220217_160147', + 'title' => '', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job ID ', + 'type' => 'string', + 'required' => false, + 'example' => '82097dd5-54df-475f-beba-eec8f4b7a3e1', + 'title' => '', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Called number', + 'type' => 'string', + 'required' => false, + 'example' => '11111111111', + 'title' => '', + ], + ], + [ + 'name' => 'UserIdMatch', + 'in' => 'query', + 'schema' => [ + 'description' => 'User ID ', + 'type' => 'string', + 'required' => false, + 'example' => '82097dd5-54df-475f-beba-eec8f4b7a3e1', + 'title' => '', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'required' => false, + 'example' => '64ebe700-91b4-49cb-b457-0b7c0b598a86', + 'title' => '', + ], + ], + [ + 'name' => 'ActualTimeGte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Start time (inclusive) for dialing time search', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1646496000000', + 'title' => '', + ], + ], + [ + 'name' => 'ActualTimeLte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Call Time search end time (inclusive)', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1646582400000', + 'title' => '', + ], + ], + [ + 'name' => 'RecordingDurationGte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Start time for ringing duration search ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + 'title' => '', + ], + ], + [ + 'name' => 'RecordingDurationLte', + 'in' => 'query', + 'schema' => [ + 'description' => 'End time for ringing duration search ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + 'title' => '', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page index (starting from 0)', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page size', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'title' => '', + ], + ], + [ + 'name' => 'OtherId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Other ID ', + 'type' => 'string', + 'required' => false, + 'example' => '64ebe700-91b4-49cb-b457-0b7c0b598a86', + 'title' => '', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'Sorting field', + 'type' => 'string', + 'required' => false, + 'example' => 'actualTime', + 'title' => '', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'Sorting order: asc for ascending, desc for descending ', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + 'title' => '', + ], + ], + [ + 'name' => 'CallDurationGte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Minimum call duration for search ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + 'title' => '', + ], + ], + [ + 'name' => 'CallDurationLte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Maximum call duration for search ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + 'title' => '', + ], + ], + [ + 'name' => 'JobStatusStringList', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job status', + 'type' => 'string', + 'required' => false, + 'example' => 'Succeeded', + 'title' => '', + ], + ], + [ + 'name' => 'TaskStatusStringList', + 'in' => 'query', + 'schema' => [ + 'description' => 'Call status ', + 'type' => 'string', + 'required' => false, + 'example' => 'Succeeded,Failed', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptNameQuery', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario Name', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + 'title' => '', + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'C377C5FF-4F94-1B23-89D0-50C560623EE4', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => '[]', + 'title' => '', + ], + 'TaskId' => [ + 'description' => 'Export job ID', + 'type' => 'string', + 'example' => 'a7d6dcff1b8b40f4a8b769a9c24e7852', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'TaskExport.ExceedExportMaxLimit', + 'errorMessage' => 'exceed export max limit 500000, Please reselect the query conditions.', + 'description' => 'The number is too large, more than 500000, please re-screen and download', + ], + ], + 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' => 'Export Outbound Call History', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-14T13:09:53.000Z', + 'description' => 'Error codes changed, Request parameters changed', + ], + [ + 'createdAt' => '2022-06-23T04:15:37.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-03-01T12:35:58.000Z', + 'description' => 'OpenAPI offline', + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateTaskExportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '100', + 'countWindow' => 1, + 'regionId' => '*', + 'api' => 'CreateTaskExportTask', + ], + ], + ], + ], + 'DeleteAgentProfiles' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AgentProfileIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Collection of agent configuration IDs', + 'type' => 'array', + 'items' => [ + 'description' => 'Agent configuration ID', + 'type' => 'string', + 'required' => false, + 'example' => '3d7d253cfb77476da0cf3681bcf7b4e8', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'AppIp', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'app_ip (system field, optional)', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<String>', + 'description' => 'BaseResponse<String>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API prompt message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Returned data', + 'type' => 'string', + 'example' => '{}', + 'title' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Delete agent configuration (deprecated)', + 'summary' => 'Delete an LLM-based robot.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteAgentProfiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DeleteAllNumberDistrictInfo' => [ + 'summary' => 'Delete the number geolocation database. This operation is deprecated.', + '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 status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Deprecated] Delete all number geolocation information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteAllNumberDistrictInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DeleteBeebotIntent' => [ + 'summary' => 'DeleteBeebotIntent', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10717802', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n", + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'BeebotRequestId' => [ + 'description' => 'Internal request ID', + 'type' => 'string', + 'example' => '497CFAFF-48CC-161A-AD2C-252DED569037', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'IntentId' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10717802'."\n", + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Small Model API] Delete Beemind Bot Intent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteBeebotIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DeleteBeebotIntentLgf' => [ + 'summary' => 'DeleteBeebotIntentLgf', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10717802', + 'title' => '', + ], + ], + [ + 'name' => 'LgfId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Utterance template ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5666117', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'LgfId' => [ + 'description' => 'Utterance template ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5666117', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'BeebotRequestId' => [ + 'description' => 'Internal request ID', + 'type' => 'string', + 'example' => '0B219FCB-EC71-1F08-BB1B-0E87C20158C8', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Small Model API] Delete an utterance template for a Beemind bot intent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteBeebotIntentLgf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DeleteBeebotIntentUserSay' => [ + 'summary' => 'DeleteBeebotIntentUserSay', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent ID', + 'type' => 'string', + 'required' => true, + 'example' => '10717802', + 'title' => '', + ], + ], + [ + 'name' => 'UserSayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'User utterance ID', + 'type' => 'string', + 'required' => true, + 'example' => '17448458', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n", + 'title' => '', + ], + 'UserSayId' => [ + 'description' => 'User utterance ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17448458', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'BeebotRequestId' => [ + 'description' => 'Internal request ID', + 'type' => 'string', + 'example' => '0B219FCB-EC71-1F08-BB1B-0E87C20158C8', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Small Model API] Delete Beemind Intent User Utterances', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteBeebotIntentUserSay', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DeleteContactBlockList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94048', + 'abilityTreeNodes' => [ + 'FEATUREoutboundbotQHO52V', + ], + ], + 'parameters' => [ + [ + 'name' => 'ContactBlockListId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Contact list ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c6320d3c-fa45-4011-b3b1-acdfabe3a8c6', + 'title' => '', + ], + ], + [ + 'name' => 'Operator', + 'in' => 'query', + 'schema' => [ + 'description' => 'Operator information', + 'type' => 'string', + 'required' => false, + 'example' => '160131', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c6320d3c-fa45-4011-b3b1-acdfabe3a8c6', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'AffectedRows' => [ + 'description' => 'Number of affected rows [Deprecated]', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Delete a Do-Not-Call List', + 'summary' => 'Delete a Do-Not-Call list.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteContactBlockList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DeleteContactWhiteList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '94049', + 'abilityTreeNodes' => [ + 'FEATUREoutboundbotN899BL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ContactWhiteListId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Contact whitelist ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '08c32b67-43cd-4d6a-b7ea-d057xxxxxxxx', + 'title' => '', + ], + ], + [ + 'name' => 'Operator', + 'in' => 'query', + 'schema' => [ + 'description' => 'Operator information', + 'type' => 'string', + 'required' => false, + 'example' => '测试人', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'AffectedRows' => [ + 'description' => 'Number of affected rows [Deprecated]', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Delete outbound call whitelist', + 'summary' => 'Delete a global outbound call policy whitelist.', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-12T12:45:01.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteContactWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DeleteDialogueFlow' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd7c28efb-47f7-4a85-a522-5038e30a0b98', + 'title' => '', + ], + ], + [ + 'name' => 'DialogueFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Conversation flow ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'caab25d1-1f30-4996-8135-0036f5661b43', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the invocation succeeded.'."\n" + .'- **true**: The invocation succeeded.'."\n" + .'- **false**: Failed to invoke.'."\n", + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Delete Conversation Flow – Legacy Canvas API', + 'summary' => 'Delete a conversation flow using the legacy canvas API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteDialogueFlow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DeleteGlobalQuestion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0fe7f71c-8771-42ef-9bb1-19aa16ae7120', + 'title' => '', + ], + ], + [ + 'name' => 'GlobalQuestionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Global question ID'."\n" + ."\n" + .'> Obtain it by calling the ListGlobalQuestions API.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '35f1361e-4377-494c-9f10-4274bda0317f', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Legacy Canvas API] Delete Global Question', + 'summary' => 'Delete a global question in a legacy canvas scenario.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteGlobalQuestion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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 of the instance to delete', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Delete Business Instance', + 'summary' => 'Delete an Intelligent Outbound Call business instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DeleteIntent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID of the intent', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID of the intent to delete', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c21fb0ec-fb5e-476f-a6bf-81a892739c8d'."\n", + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Succes', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n", + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Delete Intent – Legacy Canvas API', + 'summary' => 'Delete an intent using the legacy canvas API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DeleteJobGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID.', + 'docRequired' => true, + 'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job ID.', + 'docRequired' => true, + 'example' => 'fc1fb484-4fe8-4031-b662-5b87ea88590b', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code.', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Error message.', + 'example' => '无', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Delete a job', + 'summary' => 'Delete a job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteJobGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'The instance ID.', + 'docRequired' => true, + 'example' => '33014787-cc13-49d3-ab2f-a98aa8f15fbb', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'OutboundCallNumberId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number ID.', + 'docRequired' => true, + 'example' => 'ffa367e0-58f3-43b6-9615-c63db99c5add', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'The status code returned by the API.', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'The message returned by the API.', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the query succeeded:'."\n" + ."\n" + .'- true: Succeeded.'."\n" + .'- false: Failed.', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Delete Outbound Call Number – Deprecated', + 'summary' => 'Deletes an outbound call number. This API is deprecated.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteCabOutboundCallNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DeleteScript' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'b3d5ac22-9643-49c6-aa84-777f6656f9f5', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID of the script to delete', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '5c589560-6b9d-4415-a3e0-049c4ff05f56', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the invocation succeeded. true: The invocation succeeded. false: The invocation failed.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Delete a script', + 'summary' => 'Delete a script.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Instance ID to which the recording belongs', + 'type' => 'string', + 'required' => true, + 'example' => '1eefcb81-cd58-4143-8180-6a962d79d708', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID to which the recording belongs', + 'type' => 'string', + 'required' => true, + 'example' => 'dcc42f0d-cfd8-4866-9bbf-002042503745', + 'title' => '', + ], + ], + [ + 'name' => 'UuidsJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'List of recording IDs. If empty, all recordings are selected by default.'."\n" + ."\n" + .'> You can obtain the recording IDs from the ListScriptRecording API.', + 'type' => 'string', + 'required' => false, + 'example' => '["d17d5bfa-4972-4389-9718-f9602edabe48"]', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '56666881-887A-530A-B679-C3B6B6B142C0', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Small Model API] Delete recordings in a small model scenario', + 'summary' => 'Delete uploaded recordings in a small model scenario.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteScriptRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'DeleteScriptWaveform' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'Instance ID', + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'Scenario ID', + 'example' => 'b9ff4e88-65f9-4eb3-987c-11ba51f3f24d', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptWaveformId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'ID of the recording to delete', + 'example' => 'df8216aa-d8f6-4501-864f-f8334d946561', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => 'HTTP status code', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'type' => 'string', + 'description' => 'API status code', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'type' => 'string', + 'description' => 'API message', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'type' => 'string', + 'description' => 'Request ID', + 'example' => '0FD69531-F82C-542D-A5E7-CB54544041C5', + 'title' => '', + ], + 'Success' => [ + 'type' => 'boolean', + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Deprecated] Delete script recording', + 'summary' => 'Delete script recording.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteScriptWaveform', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DescribeBeebotIntent' => [ + 'summary' => 'DescribeBeebotIntent', + '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' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scenario ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The intent ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10717802', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'BeebotRequestId' => [ + 'description' => 'Internal request ID', + 'type' => 'string', + 'example' => '0B219FCB-EC71-1F08-BB1B-0E87C20158C8', + 'title' => '', + ], + 'Code' => [ + 'description' => 'The API status code.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'IntentId' => [ + 'description' => 'The intent ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10717802'."\n", + 'title' => '', + ], + 'Intent' => [ + 'description' => 'Intent information', + 'type' => 'object', + 'properties' => [ + 'IntentId' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10717802', + 'title' => '', + ], + 'IntentName' => [ + 'description' => 'Name', + 'type' => 'string', + 'example' => '知道了', + 'title' => '', + ], + 'AliasName' => [ + 'description' => 'Alias', + 'type' => 'string', + 'example' => '嗯明白了', + 'title' => '', + ], + 'CreateUserName' => [ + 'description' => 'Account name of the creator', + 'type' => 'string', + 'example' => '[email protected]', + 'title' => '', + ], + 'CreateUserId' => [ + 'description' => 'Creator user ID', + 'type' => 'string', + 'example' => '1252504', + 'title' => '', + ], + 'ModifyUserId' => [ + 'description' => 'Updated By user ID', + 'type' => 'string', + 'example' => '1252504', + 'title' => '', + ], + 'ModifyUserName' => [ + 'description' => 'Account name of the user who updated the intent', + 'type' => 'string', + 'example' => '[email protected]'."\n", + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time', + 'type' => 'string', + 'example' => '2025-04-21 10:29:59.+0800', + 'title' => '', + ], + 'ModifyTime' => [ + 'description' => 'Updated At', + 'type' => 'string', + 'example' => '2025-04-21 15:52:57.+0800', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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\\": \\"[email protected]\\",\\n \\"CreateUserId\\": \\"1252504\\",\\n \\"ModifyUserId\\": \\"1252504\\",\\n \\"ModifyUserName\\": \\"[email protected]\\\\n\\",\\n \\"CreateTime\\": \\"2025-04-21 10:29:59.+0800\\",\\n \\"ModifyTime\\": \\"2025-04-21 15:52:57.+0800\\"\\n }\\n}","type":"json"}]', + 'title' => '[Get Small Model API] Obtain the intent of the XiaoMi chatbot.', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeBeebotIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DescribeDialogueNodeStatistics' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'aeff669b-388f-4619-82af-81e177df5628', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job group ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a3c670d1-01bf-491d-b9aa-759b1a82f47c', + 'title' => '', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => 'Limit for displaying statistics ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '999', + 'minimum' => '0', + 'example' => '30', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'GroupId' => [ + 'description' => 'Task group ID ', + 'type' => 'string', + 'example' => 'f06f7c9f-2895-4b30-a8c2-6ecccb9c9f89', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'TotalCompleted' => [ + 'description' => 'Number of completed jobs in the task group ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79', + 'title' => '', + ], + 'NoAnswerDialogueNodes' => [ + 'description' => 'No-answer edge zones', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NoAnswerNum' => [ + 'description' => 'No-answer quantity', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + 'GroupId' => [ + 'description' => 'Task group ID ', + 'type' => 'string', + 'example' => 'f06f7c9f-2895-4b30-a8c2-6ecccb9c9f89', + 'title' => '', + ], + 'NodeName' => [ + 'description' => 'Edge zone name', + 'type' => 'string', + 'example' => 'xxx', + 'title' => '', + ], + 'HangUpNum' => [ + 'description' => 'Hang-up quantity', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79', + 'title' => '', + ], + 'HitNum' => [ + 'description' => 'Hit quantity', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + 'title' => '', + ], + 'Id' => [ + 'description' => 'id', + 'type' => 'string', + 'example' => '123', + 'title' => '', + ], + 'NodeId' => [ + 'description' => 'Edge zone ID', + 'type' => 'string', + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '[]', + 'title' => '', + ], + 'HangUpDialogueNodes' => [ + 'description' => 'Hang-up edge zones ', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'HangUpNum' => [ + 'description' => 'Number of hang-ups ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + 'NodeId' => [ + 'description' => 'Edge zone ID ', + 'type' => 'string', + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79', + 'title' => '', + ], + 'NodeName' => [ + 'description' => 'Edge zone name ', + 'type' => 'string', + 'example' => 'xxx', + 'title' => '', + ], + 'RateDisplay' => [ + 'description' => 'Quantity percentage ', + 'type' => 'string', + 'example' => '100%', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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\\": \\"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}","type":"json"}]', + 'title' => 'Query dialogue node data statistics ', + 'summary' => 'Returns the statistics information of job labels.', + 'changeSet' => [ + [ + 'createdAt' => '2024-07-22T12:24:23.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2023-03-07T14:46:39.000Z', + 'description' => 'Response parameters changed, Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeDialogueNodeStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '9eb8fe4f-b286-4834-9688-2c9b171e223e', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '1364f208-982d-4d0c-89aa-d56e22b47589', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'DsReports' => [ + 'description' => 'Conversation flow information, in the format: key:{value: Count}', + 'type' => 'string', + 'example' => '"{\\"标签1\\":{\\"标签值1\\":2},\\"标签2\\":{\\"标签值1\\":2},\\"标签3\\":{\\"标签值1\\":1,\\"标签值2\\":1}}"', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Obtain tag statistics for job group hits', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeGroupDsReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'DescribeGlobalQuestion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '7cefbff0-8d50-4d6f-b93c-73cee23c1555', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'b7ee988b-2837-4bc1-9d56-f76e7c831f60', + 'title' => '', + ], + ], + [ + 'name' => 'GlobalQuestionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Global question ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'e851e242-ad67-4507-96a2-d4114564dcec', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'GlobalQuestion' => [ + 'description' => 'Global question information', + 'type' => 'object', + 'properties' => [ + 'GlobalQuestionId' => [ + 'description' => 'Global script ID', + 'type' => 'string', + 'example' => 'f160ec2e-94f2-4c03-87be-ece5b52d5dd9', + 'title' => '', + ], + 'Answers' => [ + 'description' => 'Answer responses', + 'type' => 'string', + 'example' => '["你好,我是你的专属客服顾问."]', + 'title' => '', + ], + 'GlobalQuestionType' => [ + 'description' => 'Global script type', + 'type' => 'string', + 'example' => 'COMMON', + 'title' => '', + ], + 'GlobalQuestionName' => [ + 'description' => 'Global question name', + 'type' => 'string', + 'example' => '你是谁-全局问题', + 'title' => '', + ], + 'Questions' => [ + 'description' => 'Global questions', + 'type' => 'string', + 'example' => ' ["你是谁","你叫什么"]', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'example' => '290e06a5-6de2-4cc8-8a9c-72b7c152256c', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Legacy Canvas API] Returns data of a global question', + 'summary' => 'Returns data of a global question in the legacy canvas scenario.', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeGlobalQuestion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DescribeGroupExecutingInfo' => [ + 'summary' => 'Returns the task execution status within a task group.', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '3640dda7-e5b1-4b3e-9ccf-da4fc5402e11', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'GroupId' => [ + 'description' => 'Task group ID', + 'type' => 'string', + 'example' => 'b24d321a-2a74-4dd1-a0ba-4ab09cef6652', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => 'c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4', + 'title' => '', + ], + 'ExecutingInfo' => [ + 'description' => 'Execution information', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'End Time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640087774563', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'Start Time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640087774563', + 'title' => '', + ], + 'HangUpByClientNum' => [ + 'description' => 'Number of times hung up by the customer', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'CreatorName' => [ + 'description' => 'Deprecated', + 'type' => 'string', + 'example' => 'xxx', + 'title' => '', + ], + 'TransferByNoAnswer' => [ + 'description' => 'No acknowledgement', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'FinishedNum' => [ + 'description' => 'Number of completed executions', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'TransferByIntentNum' => [ + 'description' => 'Intent recognition', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'CallNum' => [ + 'description' => 'Number of outbound calls', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'CallFailedNum' => [ + 'description' => 'Number of call failures', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'NoInteractionNum' => [ + 'description' => 'Number of no-interaction occurrences.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'JobsProgress' => [ + 'description' => 'Execution progress', + 'type' => 'object', + 'properties' => [ + 'SchedulingNum' => [ + 'description' => 'Number of jobs being scheduled', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'TotalCompletedNum' => [ + 'description' => 'Total quantity completed', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'FailedNum' => [ + 'description' => 'Number of failed jobs', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'PausedNum' => [ + 'description' => 'Number of pauses', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'CancelledNum' => [ + 'description' => 'Number of cancelled jobs', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'TotalJobs' => [ + 'description' => 'Total number of jobs', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'TotalNotAnsweredNum' => [ + 'description' => 'Quantity with no acknowledgement', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'ExecutingNum' => [ + 'description' => 'Number of jobs being executed', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + 'TalkTurnsDistribution' => [ + 'type' => 'string', + 'description' => '', + 'example' => '{"total":"5","5":"4"}'."\n", + 'title' => '', + ], + 'DurationDistribution' => [ + 'type' => 'string', + 'description' => '', + 'example' => '{"max":"40","1":"1","total":"40","min":"40"}', + 'title' => '', + ], + 'AvgTalkTime' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => '', + 'example' => '258', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '', + ], + ], + ], + 'title' => 'Return job execution status', + 'changeSet' => [ + [ + 'createdAt' => '2024-11-28T14:29:58.000Z', + 'description' => 'Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeGroupExecutingInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + '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"}]', + 'translator' => 'machine', + ], + 'DescribeInstance' => [ + 'summary' => 'Query Intelligent Outbound Calling business instance information. ', + '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' => 'The instance ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'The status code.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message. ', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID. ', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Instance' => [ + 'description' => 'Business instance information. ', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'Creation Time. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578469042851', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Business instance ID. ', + 'type' => 'string', + 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', + 'title' => '', + ], + 'CreatorId' => [ + 'description' => 'Creator ID. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '435986', + 'title' => '', + ], + 'OwnerName' => [ + 'description' => 'Business instance owner name. ', + 'type' => 'string', + 'example' => 'xxxx', + 'title' => '', + ], + 'InstanceDescription' => [ + 'description' => 'Business instance description. ', + 'type' => 'string', + 'example' => '这个是第一个实例', + 'title' => '', + ], + 'InstanceName' => [ + 'description' => 'Business instance name. ', + 'type' => 'string', + 'example' => '第一个实例', + 'title' => '', + ], + 'CreatorName' => [ + 'description' => 'Creator name. ', + 'type' => 'string', + 'example' => 'xxx', + 'title' => '', + ], + 'ResourceGroupId' => [ + 'description' => 'Resource group ID. ', + 'type' => 'string', + 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', + 'title' => '', + ], + 'MaxConcurrentConversation' => [ + 'description' => 'Maximum concurrent conversations for the instance. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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 \\"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}","type":"json"}]', + 'title' => 'Query business instance information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DescribeIntent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'instance ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'scenario ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'intent ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10717802', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '327FEE69-F173-5B2F-9F3B-DCC6182D7BA0', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Intent' => [ + 'description' => 'Intent information', + 'type' => 'object', + 'properties' => [ + 'Utterances' => [ + 'description' => 'List of user utterances that trigger the intent', + 'type' => 'string', + 'example' => '["ok","好的","好吧","好嘞","可以","行啊","行吧","那行","知道了","我看一下","能的","等会吧","等一下","马上还","等一会","过两天","我会想办法处理"]', + 'title' => '', + ], + 'IntentDescription' => [ + 'description' => 'Instance Description', + 'type' => 'string', + 'example' => '同意还款意图', + 'title' => '', + ], + 'UpdateTime' => [ + 'description' => 'Update Time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578469042851', + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578469042851', + 'title' => '', + ], + 'Keywords' => [ + 'description' => 'Keywords of the intent, which can be used to filter and find intents in the List API', + 'type' => 'string', + 'example' => '["还款"]', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'example' => '6ef95fd5-558f-4ee8-af34-b2ede087a87c', + 'title' => '', + ], + 'IntentId' => [ + 'description' => 'Intent ID', + 'type' => 'string', + 'example' => '10722701', + 'title' => '', + ], + 'IntentName' => [ + 'description' => 'Intent Name', + 'type' => 'string', + 'example' => '统一还款', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Retrieve an Intent – Legacy Canvas API', + 'summary' => 'Retrieve an intent using the legacy canvas API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DescribeIntentStatistics' => [ + 'summary' => 'Query the intent statistics information under a task group.', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c3c92de8-e4bd-4db4-a962-50f8acce40bc', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job group ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '040355a9-e80c-4308-b85c-aa5b9fd25246', + 'title' => '', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of statistics entries to display (Required)', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + 'docRequired' => true, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'GroupId' => [ + 'description' => 'Group ID to which the instance belongs.', + 'type' => 'string', + 'example' => '0c3f352f-d045-491d-9ce7-11f2d2b7775d', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'ProcessIntentNum' => [ + 'description' => 'Total count of flow intents ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '123', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID ', + 'type' => 'string', + 'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e', + 'title' => '', + ], + 'GlobalIntentNum' => [ + 'description' => 'Total number of global intents', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'ProcessIntents' => [ + 'description' => 'List of intent information', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Type'."\n" + ."\n" + .'- GlobalIntent(0): global intent'."\n" + ."\n" + .'- ProcessIntent(1): flow intent', + 'type' => 'string', + 'example' => 'ProcessIntent', + 'title' => '', + ], + 'GroupId' => [ + 'description' => 'Task group ID ', + 'type' => 'string', + 'example' => '0c3f352f-d045-491d-9ce7-11f2d2b7775d', + 'title' => '', + ], + 'HitAfterNoAnswer' => [ + 'description' => 'Hits followed by no acknowledgement ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID ', + 'type' => 'string', + 'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e', + 'title' => '', + ], + 'HitNum' => [ + 'description' => 'Hit quantity ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'IntentId' => [ + 'description' => 'Intent ID ', + 'type' => 'string', + 'example' => '12343', + 'title' => '', + ], + 'IntentName' => [ + 'description' => 'Intent name ', + 'type' => 'string', + 'example' => '请假意图', + 'title' => '', + ], + 'RateDisplay' => [ + 'type' => 'string', + 'description' => 'Quantity percentage ', + 'example' => '33.33%', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '[]', + 'title' => '', + ], + 'GlobalIntents' => [ + 'description' => 'Array of global events', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Type'."\n" + ."\n" + .'GlobalIntent(0): global intent'."\n" + ."\n" + .'ProcessIntent(1): flow intent', + 'type' => 'string', + 'example' => 'GlobalIntent', + 'title' => '', + ], + 'GroupId' => [ + 'description' => 'Task group ID', + 'type' => 'string', + 'example' => '0c3f352f-d045-491d-9ce7-11f2d2b7775d', + 'title' => '', + ], + 'HitAfterNoAnswer' => [ + 'description' => 'Hits followed by no acknowledgement', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e', + 'title' => '', + ], + 'HitNum' => [ + 'description' => 'Hit quantity', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '11', + 'title' => '', + ], + 'IntentId' => [ + 'description' => 'Intent ID', + 'type' => 'string', + 'example' => '21343425', + 'title' => '', + ], + 'IntentName' => [ + 'description' => 'Intent name', + 'type' => 'string', + 'example' => '请假意图', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '[]', + 'title' => '', + ], + 'IntentsAfterNoAnswer' => [ + 'description' => 'List of unrecognized intent information', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e', + 'title' => '', + ], + 'GroupId' => [ + 'type' => 'string', + 'description' => 'Task group ID', + 'example' => 'b24d321a-2a74-4dd1-a0ba-4ab09cef6652', + 'title' => '', + ], + 'HitAfterNoAnswer' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => 'Hits with no acknowledgement after matching', + 'example' => '1', + 'title' => '', + ], + 'IntentId' => [ + 'type' => 'string', + 'description' => 'Intent ID', + 'example' => '10398032', + 'title' => '', + ], + 'IntentName' => [ + 'type' => 'string', + 'description' => 'Intent name', + 'example' => '请假意图', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query intent statistics information', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-07-22T12:24:23.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2023-03-07T14:46:39.000Z', + 'description' => 'Response parameters changed, Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeIntentStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DescribeJob' => [ + 'summary' => 'Returns the conversation data of a job.', + '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' => 'Instance ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c8a2b7f2-ad1a-4865-b872-d0080d9802d9', + 'title' => '', + ], + ], + [ + 'name' => 'WithScript', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether to return job scenario information.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API prompt message.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Job' => [ + 'description' => 'Job information.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Job status. '."\n" + .'- Scheduling, '."\n" + .'- Executing, '."\n" + .'- Succeeded, '."\n" + .'- Paused, '."\n" + .'- Failed, '."\n" + .'- Cancelled, '."\n" + .'- Drafted (Draft state, a temporary state during file import);', + 'type' => 'string', + 'example' => 'Succeeded', + 'title' => '', + ], + 'ActualTime' => [ + 'description' => 'Actual running time of the job. [Deprecated] ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640068026385', + 'title' => '', + ], + 'Priority' => [ + 'description' => 'Job priority. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'DsReport' => [ + 'description' => 'Job hit label status. [Deprecated]', + 'type' => 'string', + 'example' => '-', + 'title' => '', + ], + 'NextExecutionTime' => [ + 'description' => 'The time when the job will be executed next.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640068026385', + 'title' => '', + ], + 'FailureReason' => [ + 'description' => 'Reason for job failure.', + 'type' => 'string', + 'example' => 'NoAnswer', + 'title' => '', + ], + 'SystemPriority' => [ + 'description' => 'System priority of the job.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID. ', + 'type' => 'string', + 'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28', + 'title' => '', + ], + 'CalledNumber' => [ + 'description' => 'Called number. ', + 'type' => 'string', + 'example' => '137****7777', + 'title' => '', + ], + 'ReferenceId' => [ + 'description' => 'Business ID of the job, defined by the business party.'."\n" + ."\n" + .'> This is the uploaded ContactId value.', + 'type' => 'string', + 'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Job ID.', + 'type' => 'string', + 'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8', + 'title' => '', + ], + 'ScenarioId' => [ + 'description' => 'Scenario ID. ', + 'type' => 'string', + 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150', + 'title' => '', + ], + 'StrategyId' => [ + 'description' => 'Policy ID. ', + 'type' => 'string', + 'example' => 'c8a2b7f2-ad1a-4865-b872-d0080d9802d9', + 'title' => '', + ], + 'EndReason' => [ + 'description' => 'Call termination reason. Valid values:'."\n" + ."\n" + .'- **1**: FINISHED (Normal completion).'."\n" + .'- **2**: CHATBOT_HANGUP_AFTER_NOANSWER (Bot hangs up after unrecognized input).'."\n" + .'- **3**: CHATBOT_HANGUP_AFTER_SILENCE (Bot hangs up due to silence timeout).'."\n" + .'- **4**: CLIENT_HANGUP_AFTER_NOANSWER (User hangs up after unrecognized input).'."\n" + .'- **5**: CLIENT_HANGUP (User hangs up without reason).'."\n" + .'- **6**: TRANSFER_BY_INTENT (Transferred to agent due to intent match).'."\n" + .'- **7**: TRANSFER_AFTER_NOANSWER (Transferred to agent after unrecognized input).'."\n" + .'- **8**: NO_INTERACTION (No interaction from user side).'."\n" + .'- **9**: ERROR (System exception interruption).'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID.', + 'type' => 'string', + 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', + 'title' => '', + ], + 'Contacts' => [ + 'description' => 'Contact information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PhoneNumber' => [ + 'description' => 'Phone number.', + 'type' => 'string', + 'example' => '1358****8888', + 'title' => '', + ], + 'State' => [ + 'description' => 'Contact status. [Deprecated]', + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'ContactId' => [ + 'description' => 'Contact ID. System-generated.', + 'type' => 'string', + 'example' => 'db3db762-e421-44c9-9a01-cb423470757c', + 'title' => '', + ], + 'Honorific' => [ + 'description' => 'Contact honorific. Consistent with the contact name.', + 'type' => 'string', + 'example' => '张先生', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID.', + 'type' => 'string', + 'example' => '72dcd26b-f12d-4c27-b3af-18f6aed5b160', + 'title' => '', + ], + 'ContactName' => [ + 'description' => 'Contact name.', + 'type' => 'string', + 'example' => '张三', + 'title' => '', + ], + 'Role' => [ + 'description' => 'Contact role. [Deprecated]', + 'type' => 'string', + 'example' => '*', + 'title' => '', + ], + 'ReferenceId' => [ + 'description' => 'The business ID of the contact.', + 'type' => 'string', + 'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '[]', + 'title' => '', + ], + 'Extras' => [ + 'description' => 'Business parameters. '."\n" + ."\n" + .'> TenantId and ServiceId are system-generated. All other parameters are custom and passed in as references. ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Business parameter name.', + 'type' => 'string', + 'example' => 'djrq', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Business parameter value.', + 'type' => 'string', + 'example' => '2019-08-21 09:49:59.0', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '[]', + 'title' => '', + ], + 'Summary' => [ + 'description' => 'Label data for the conversation business:'."\n" + .'- In LLM scenarios: label hit data after the conversation ends.'."\n" + .'- In small model scenarios: variable value data after the conversation ends.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SummaryName' => [ + 'description' => 'Tag name.', + 'type' => 'string', + 'example' => 'score', + 'title' => '', + ], + 'Category' => [ + 'description' => 'Category of the conversation summary (historical field, no longer used) [Deprecated]', + 'type' => 'string', + 'example' => '{}', + 'title' => '', + ], + 'Content' => [ + 'description' => 'Tag value', + 'type' => 'string', + 'example' => '5', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '[]', + 'title' => '', + ], + 'Tasks' => [ + 'description' => 'Call List. ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Task Status, with the following possible values: '."\n" + .'(Note: The **Succeeded** status has been further categorized by specific reasons. The generic **Succeeded**: 1 (Connected) status will no longer be displayed; instead, only the detailed reason types will be returned.)'."\n" + ."\n" + .'- **Executing**: 0 (Calling in progress). '."\n" + .'- **Succeeded**: 1 (Connected). '."\n" + .'- **NoAnswer**: 2 (Not connected – No answer). '."\n" + .'- **NotExist**: 3 (Not connected – Nonexistent number). '."\n" + .'- **Busy**: 4 (Not connected – Busy line). '."\n" + .'- **Cancelled**: 5 (Not dialed – Job stopped). '."\n" + .'- **Failed**: 6 (Failed). '."\n" + .'- **NotConnected**: 7 (Not connected – Unable to reach). '."\n" + .'- **PoweredOff**: 8 (Not connected – Powered off). '."\n" + .'- **OutOfService**: 9 (Not connected – Called party suspended). '."\n" + .'- **InArrears**: 10 (Not connected – Called party has overdue payment). '."\n" + .'- **EmptyNumber**: 11 (Not dialed – Nonexistent number, not called). '."\n" + .'- **PerDayCallCountLimit**: 12 (Not dialed – Exceeded daily call limit). '."\n" + .'- **ContactBlockList**: 13 (Not dialed – Blacklist). '."\n" + .'- **CallerNotRegistered**: 14 (Not dialed – Caller number not registered). '."\n" + .'- **Terminated**: 15 (Not dialed – Terminated). '."\n" + .'- **VerificationCancelled**: 16 (Not dialed – Cancelled due to failed pre-call authentication). '."\n" + .'- **OutOfServiceNoCall**: 17 (Not dialed – Called party suspended, not called). '."\n" + .'- **InArrearsNoCall**: 18 (Not dialed – Called party has overdue payment, not called). '."\n" + .'- **CallingNumberNotExist**: 19 (Not dialed – Caller number does not exist). '."\n" + .'- **SucceededFinish**: 20 (Connected – Normal completion). '."\n" + .'- **SucceededChatbotHangUpAfterNoAnswer**: 21 (Connected – Bot hung up after unrecognized input). '."\n" + .'- **SucceededChatbotHangUpAfterSilence**: 22 (Connected – Bot hung up after silence timeout). '."\n" + .'- **SucceededClientHangUpAfterNoAnswer**: 23 (Connected – User hung up after unrecognized input). '."\n" + .'- **SucceededClientHangUp**: 24 (Connected – User hung up without reason). '."\n" + .'- **SucceededTransferByIntent**: 25 (Connected – Transferred to agent due to intent match). '."\n" + .'- **SucceededTransferAfterNoAnswer**: 26 (Connected – Transferred to agent after unrecognized input). '."\n" + .'- **SucceededInoInterAction**: 27 (Connected – No interaction from user side). '."\n" + .'- **SucceededError**: 28 (Connected – Interrupted by system exception). '."\n" + .'- **SucceededSpecialInterceptVoiceAssistant**: 29 (Connected – Intercepted under special condition – Voice assistant). '."\n" + .'- **SucceededSpecialInterceptExtensionNumberTransfer**: 30 (Connected – Intercepted under special condition – Extension transfer). '."\n" + .'- **SucceededSpecialInterceptCustomSpecialIntercept**: 31 (Connected – Intercepted under special condition – Custom intercept). '."\n" + .'- **HighRiskSipCode**: 32 (Not dialed – High-risk, not called).'."\n", + 'type' => 'string', + 'example' => 'SucceededTransferByIntent', + 'title' => '', + ], + 'PlanedTime' => [ + 'description' => 'Scheduled calling time. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579068424883', + 'title' => '', + ], + 'ChatbotId' => [ + 'description' => 'ID of the chatbot used for the conversation. ', + 'type' => 'string', + 'example' => '1234', + 'title' => '', + ], + 'ActualTime' => [ + 'description' => 'Actual running time. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579068424883', + 'title' => '', + ], + 'CalledNumber' => [ + 'description' => 'Called number. ', + 'type' => 'string', + 'example' => '135****8888', + 'title' => '', + ], + 'EndTime' => [ + 'description' => 'Actual end time. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579068424883', + 'title' => '', + ], + 'ScenarioId' => [ + 'description' => 'Scenario ID. ', + 'type' => 'string', + 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150', + 'title' => '', + ], + 'EndReason' => [ + 'description' => 'Completion reason.', + 'type' => 'string', + 'example' => 'FINISHED', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID. ', + 'type' => 'string', + 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', + 'title' => '', + ], + 'CallId' => [ + 'description' => 'SIP call ID. ', + 'type' => 'string', + 'example' => '1528189846043', + 'title' => '', + ], + 'CallingNumber' => [ + 'description' => 'Calling number.', + 'type' => 'string', + 'example' => '0571****3106', + 'title' => '', + ], + 'Brief' => [ + 'description' => 'Business result (historical field, no longer used).', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'Duration' => [ + 'description' => 'Conversation duration. This field is not returned if unavailable. '."\n" + ."\n" + .'> This data is returned in the ActionParams parameter of the last object in the Conversation list. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120', + 'title' => '', + ], + 'TaskId' => [ + 'description' => 'Call ID. ', + 'type' => 'string', + 'example' => 'ff44709e-39a6-43ba-959b-20fcabe3e496', + 'title' => '', + ], + 'Conversation' => [ + 'description' => 'List of conversation texts for the job. ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ActionParams' => [ + 'description' => 'Instruction parameters. '."\n" + ."\n" + .'- When the interruption capability is Enabled, you can obtain the text content already spoken by the robot in the robot\'s dialogue text by using the answer parameter value, for example: '."\n" + .' - {"abortDialogueInfo":{"abortDialogueType":"Interrupted","answer":"This is the interrupted text information","sequenceId":"xxxxx"},"streamEnd":true} ', + 'type' => 'string', + 'example' => '{}', + 'title' => '', + ], + 'Action' => [ + 'description' => 'Instruction. ', + 'type' => 'string', + 'example' => 'Broadcast', + 'title' => '', + ], + 'Timestamp' => [ + 'description' => 'Creation Time of the summary.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579068424883', + 'title' => '', + ], + 'Speaker' => [ + 'description' => 'Indicates who spoke in the conversation: "Robot" for the robot or "Contact" for the contact.', + 'type' => 'string', + 'example' => 'Robot', + 'title' => '', + ], + 'Script' => [ + 'description' => 'Conversation text. ', + 'type' => 'string', + 'example' => '你好，我是**客服', + 'title' => '', + ], + 'Summary' => [ + 'description' => 'Dialogue summary data (Historical Data, no longer used). [Deprecated] ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SummaryName' => [ + 'description' => 'Summary name. ', + 'type' => 'string', + 'example' => 'score', + 'title' => '', + ], + 'Category' => [ + 'description' => 'Dialogue summary category (Historical field, no longer used). ', + 'type' => 'string', + 'example' => '{}', + 'title' => '', + ], + 'Content' => [ + 'description' => 'Summary Content. ', + 'type' => 'string', + 'example' => '5', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '[]', + 'title' => '', + ], + 'SequenceId' => [ + 'description' => 'Session ID.', + 'type' => 'string', + 'example' => 'fd279983-93b9-b13b-9a34-64e5df473225', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '[]', + 'title' => '', + ], + 'Contact' => [ + 'description' => 'Contact information.', + 'type' => 'object', + 'properties' => [ + 'PhoneNumber' => [ + 'description' => 'Phone number. ', + 'type' => 'string', + 'example' => '1351****8888', + 'title' => '', + ], + 'State' => [ + 'description' => 'Contact status. [Deprecated] ', + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'ContactId' => [ + 'description' => 'Contact ID. Generated by the system. ', + 'type' => 'string', + 'example' => 'db3db762-e421-44c9-9a01-cb423470757c', + 'title' => '', + ], + 'Honorific' => [ + 'description' => 'Contact honorific. Must be consistent with the contact\'s name.', + 'type' => 'string', + 'example' => '张先生', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID [Deprecated] ', + 'type' => 'string', + 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', + 'title' => '', + ], + 'ContactName' => [ + 'description' => 'Contact name ', + 'type' => 'string', + 'example' => '张三', + 'title' => '', + ], + 'Role' => [ + 'description' => 'Contact role [deprecated].', + 'type' => 'string', + 'example' => '*', + 'title' => '', + ], + 'ReferenceId' => [ + 'description' => 'Operational System ID of the contact. '."\n" + ."\n" + .'> Custom uploaded by the customer via the ContactId parameter. ', + 'type' => 'string', + 'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + 'HangUpDirection' => [ + 'description' => 'Party that hung up the call. '."\n" + .'- client: Customer '."\n" + .'- ivr: Robot ', + 'type' => 'string', + 'example' => 'client', + 'title' => '', + ], + 'RingingDuration' => [ + 'description' => 'Ringing duration. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25', + 'title' => '', + ], + 'SipCode' => [ + 'description' => 'SIP status code of the call job. ', + 'type' => 'string', + 'example' => '200', + 'title' => '', + ], + 'RealRingingDuration' => [ + 'description' => 'Actual ringing duration. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25', + 'title' => '', + ], + 'SipDuration' => [ + 'description' => 'SIP signaling duration. [Deprecated] ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '[]', + 'title' => '', + ], + 'CallingNumbers' => [ + 'description' => 'List of calling numbers.', + 'type' => 'array', + 'items' => [ + 'description' => 'Calling number.', + 'type' => 'string', + 'example' => '["0571****3106"]', + 'title' => '', + ], + 'example' => '["057126883106"]', + 'title' => '', + ], + 'Script' => [ + 'description' => 'Script scenario.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Status. ', + 'type' => 'string', + 'example' => 'DRAFTED', + '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' => '已发布待审核状态', + ], + 'title' => '', + ], + 'UpdateTime' => [ + 'description' => 'Update Time. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578881227000', + 'title' => '', + ], + 'ChatbotId' => [ + 'description' => 'Chatbot ID. ', + 'type' => 'string', + 'example' => 'chatbot-cn-EJfqqa***', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Script ID. ', + 'type' => 'string', + 'example' => '810b5872-57f0-4b27-80ab-7b3f4d8a6374', + 'title' => '', + ], + 'IsDebugDrafted' => [ + 'description' => 'Indicates whether the debug version is in Draft status. ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Industry' => [ + 'description' => 'Industry. ', + 'type' => 'string', + 'example' => '金融', + 'title' => '', + ], + 'ScriptDescription' => [ + 'description' => 'Script description. ', + 'type' => 'string', + 'example' => '催收话术', + 'title' => '', + ], + 'MiniPlaybackConfigEnabled' => [ + 'description' => 'Toggle for tone continuity feature. No response [Deprecated] ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'IsDrafted' => [ + 'description' => 'Indicates whether the script is in Draft status. ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'TtsConfig' => [ + 'description' => 'TTS configuration for the script. [Deprecated] ', + 'type' => 'string', + 'example' => '{\\"voice\\":\\"xiaobei\\",\\"volume\\":\\"50\\",\\"speechRate\\":\\"-150\\",\\"pitchRate\\":\\"0\\"}', + 'title' => '', + ], + 'DebugStatus' => [ + 'description' => 'Debug status. ', + 'type' => 'string', + 'example' => 'DRAFTED', + 'title' => '', + ], + 'AsrConfig' => [ + 'description' => 'ASR configuration for the script. [Deprecated] ', + 'type' => 'string', + 'example' => '{\\"AppKey\\":\\"3GHttnsvir1FeWWb\\"}', + 'title' => '', + ], + 'Scene' => [ + 'description' => 'Scenario. ', + 'type' => 'string', + 'example' => '催收', + 'title' => '', + ], + 'Name' => [ + 'description' => 'Script name. ', + 'type' => 'string', + 'example' => '催收话术', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Returns the conversation data of a job', + 'changeSet' => [ + [ + 'createdAt' => '2024-07-22T12:44:38.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2023-04-25T13:37:59.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2021-11-24T13:01:16.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2021-11-24T13:01:16.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'DescribeJobDataParsingTaskProgress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94070', + 'abilityTreeNodes' => [ + 'FEATUREoutboundbot7ZIYMY', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobDataParsingTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job data analytics task ID'."\n" + ."\n" + .'> You can obtain this parameter value by calling the CreateJobDataParsingTask API.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '50d5e164-9365-4261-980e-3d979c2c948c', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c209abb3-6804-4a75-b2c7-dd55c8c61b6a', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Progress' => [ + 'description' => 'Progress', + 'type' => 'object', + 'properties' => [ + 'FailErrorCode' => [ + 'description' => 'Failure error code', + 'type' => 'string', + 'example' => 'Permission.JobStatus', + 'title' => '', + ], + 'Status' => [ + 'description' => 'Job status '."\n" + .'- Pending: Pending '."\n" + .'- InProgress: In progress '."\n" + .'- Finished: Finished '."\n" + .'- PartialFinished: Partially finished '."\n" + .'- Failed: Failed', + 'type' => 'string', + 'example' => 'Pending', + 'title' => '', + ], + 'HandledJobCount' => [ + 'description' => 'Number of jobs being processed', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + 'TotalJobCount' => [ + 'description' => 'Total number of jobs', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'title' => '', + ], + 'FailReason' => [ + 'description' => 'Failure reason', + 'type' => 'string', + 'example' => 'CreateCorpus', + 'title' => '', + ], + 'FeedbackUrl' => [ + 'type' => 'string', + 'description' => 'Download URL for the file containing records of parsing failures [Deprecated]', + 'example' => 'xxxx', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Returns the progress information of a job', + 'summary' => 'Retrieve the parsing progress of the uploaded job file.', + 'changeSet' => [ + [ + 'createdAt' => '2022-01-12T12:20:58.000Z', + 'description' => 'Response parameters changed', + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeJobDataParsingTaskProgress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'DescribeJobGroup' => [ + 'summary' => 'Query Intelligent Outbound Call Job Data.', + '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' => 'Instance ID', + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID', + 'docRequired' => true, + 'example' => '46a9ad0c-3e11-44da-a9a7-2c21bf5ce185', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'BriefTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Filter condition (historical parameter, deprecated).', + 'items' => [ + 'description' => 'Filter condition, business result.', + 'example' => '回访成功', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + 'maxItems' => 99, + 'required' => false, + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code.', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message.', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded.', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'JobGroup' => [ + 'description' => 'Job information.', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'Creation Time.', + 'example' => '1578881227404', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'Status' => [ + 'description' => 'Task Status.', + 'example' => 'Completed', + 'type' => 'string', + 'title' => '', + ], + 'JobGroupName' => [ + 'description' => 'Task group name.', + 'example' => '催收作业组', + 'type' => 'string', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Script scenario ID.', + 'example' => '49f00b0d-78ac-4d51-91de-a9e8e92b8470', + 'type' => 'string', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Task group ID.', + 'example' => '46a9ad0c-3e11-44da-a9a7-2c21bf5ce185', + 'type' => 'string', + 'title' => '', + ], + 'ScenarioId' => [ + 'description' => 'Scenario ID (legacy canvas parameter; for the new canvas, the scenario ID is the same as ScriptId).', + 'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8', + 'type' => 'string', + 'title' => '', + ], + 'JobFilePath' => [ + 'description' => 'OSS Filekey after job list upload. [Deprecated]', + 'example' => 'da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx', + 'type' => 'string', + 'title' => '', + ], + 'JobGroupDescription' => [ + 'description' => 'Job description.', + 'example' => '催收作业组', + 'type' => 'string', + 'title' => '', + ], + 'JobDataParsingTaskId' => [ + 'description' => 'Job list parsing operation ID. [Deprecated]', + 'example' => 'da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx', + 'type' => 'string', + 'title' => '', + ], + 'ScriptName' => [ + 'description' => 'Scenario name.', + 'example' => '催收话术', + 'type' => 'string', + 'title' => '', + ], + 'ModifyTime' => [ + 'description' => 'Updated At.', + 'example' => '1578881227404', + 'type' => 'string', + 'title' => '', + ], + 'ScriptVersion' => [ + 'description' => 'Script scenario version number.', + 'example' => '49f00b0d-78ac-4d51-91de-a9e8e92b8470', + 'type' => 'string', + 'title' => '', + ], + 'CallingNumbers' => [ + 'description' => 'List of calling numbers.', + 'items' => [ + 'description' => 'List of calling numbers.', + 'example' => '["1****6"]', + 'type' => 'string', + 'title' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'ExportProgress' => [ + 'description' => 'Export progress [deprecated]'."\n" + ."\n" + .'> This information is obtained from the ListJobGroups API.', + 'properties' => [ + 'Status' => [ + 'description' => 'Export status [deprecated]', + 'example' => 'FINISHED', + 'type' => 'string', + 'title' => '', + ], + 'FileHttpUrl' => [ + 'description' => 'File URL [deprecated]', + 'example' => 'https://oss-cn-shanghai.aliyuncs.com/xx.zip', + 'type' => 'string', + 'title' => '', + ], + 'Progress' => [ + 'description' => 'Export progress [deprecated]', + 'example' => '1', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'Progress' => [ + 'description' => 'Job progress details.', + 'properties' => [ + 'TotalNotAnswered' => [ + 'description' => 'Deprecated', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Status' => [ + 'description' => 'Overall job execution status. [Deprecated]', + 'example' => 'Executing', + 'type' => 'string', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'Time when execution started. [Deprecated]', + 'example' => '1578881227404', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'Failed' => [ + 'description' => 'Number of failed jobs.', + 'example' => '0', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Executing' => [ + 'description' => 'Number of executing jobs.', + 'example' => '2', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'TotalJobs' => [ + 'description' => 'Total number of jobs', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'TotalCompleted' => [ + 'description' => 'Total number of completed jobs', + 'example' => '2', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Duration' => [ + 'description' => 'Job running time. [Deprecated]', + 'example' => '1000', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Scheduling' => [ + 'description' => 'Number of jobs in scheduling', + 'example' => '5', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Paused' => [ + 'description' => 'Number of paused jobs', + 'example' => '0', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Cancelled' => [ + 'description' => 'Number of cancelled jobs', + 'example' => '0', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Briefs' => [ + 'description' => 'Business result information [Deprecated]', + 'items' => [ + 'properties' => [ + 'Key' => [ + 'description' => 'Result name', + 'example' => 'score', + 'type' => 'string', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Result Value', + 'example' => '5', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'Categories' => [ + 'description' => 'Statistics information in key-value format. [Deprecated]', + 'items' => [ + 'properties' => [ + 'Key' => [ + 'description' => 'Custom statistics information field name.', + 'example' => 'success', + 'type' => 'string', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Custom statistics information value.', + 'example' => '10', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'Strategy' => [ + 'description' => 'Execution policy of the job.', + 'properties' => [ + 'Type' => [ + 'description' => 'Policy type', + 'example' => 'Repeatable', + 'type' => 'string', + 'title' => '', + ], + 'StrategyName' => [ + 'description' => 'Policy name', + 'example' => '催收策略名字', + 'type' => 'string', + 'title' => '', + ], + 'MaxAttemptsPerDay' => [ + 'description' => 'Maximum number of calls per day when the call is not answered', + 'example' => '2', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'FollowUpStrategy' => [ + 'description' => 'The handling method after the execution epoch ends (historical parameter, no longer used).', + 'example' => 'NONE', + 'type' => 'string', + 'title' => '', + ], + 'EndTime' => [ + 'description' => 'The overall end time of the schedule policy', + 'example' => '1579881227404', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'Customized' => [ + 'description' => 'Custom data of the policy (historical parameter, no longer used).', + 'example' => '{}', + 'type' => 'string', + 'title' => '', + ], + 'IsTemplate' => [ + 'description' => 'Indicates whether it is a template.', + 'example' => 'false', + 'type' => 'boolean', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'The overall start time of the policy', + 'example' => '1578881227404', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'StrategyId' => [ + 'description' => 'Policy ID', + 'example' => 'a2bff22c-2604-4df2-83d6-5952e2438c5a', + 'type' => 'string', + 'title' => '', + ], + 'RoutingStrategy' => [ + 'description' => 'Number routing policy', + 'example' => 'LocalFirst', + 'type' => 'string', + 'title' => '', + ], + 'MinAttemptInterval' => [ + 'description' => 'The interval between retries', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'StrategyDescription' => [ + 'description' => 'Policy description', + 'example' => '催收策略', + 'type' => 'string', + 'title' => '', + ], + 'RepeatBy' => [ + 'description' => 'The job repetition method', + 'example' => 'Once', + 'type' => 'string', + 'title' => '', + ], + 'WorkingTime' => [ + 'description' => 'Working time segments.', + 'items' => [ + 'properties' => [ + 'EndTime' => [ + 'description' => 'Start Time.', + 'example' => '12:00:00', + 'type' => 'string', + 'title' => '', + ], + 'BeginTime' => [ + 'description' => 'End Time.', + 'example' => '09:00:00', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'RepeatDays' => [ + 'description' => 'Dates for recurrence, used in conjunction with RepeatBy. '."\n" + .'- If the recurrence is "weekly," 0 represents Sunday, and 1–6 represent Monday through Saturday, respectively. '."\n" + .'- If the recurrence is "monthly," 1–31 represent the 1st to the 31st day of the month. Months that do not contain the specified date will not execute the task. For example, if the 30th is selected, the task will not run in February.', + 'items' => [ + 'description' => 'Days for recurrence', + 'example' => '[1,2,3,4,5]', + 'type' => 'string', + 'title' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'Repeatable' => [ + 'description' => 'Indicates whether it is a loop task.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'RecallStrategy' => [ + 'description' => 'Recall policy.', + 'properties' => [ + 'EmptyNumberIgnore' => [ + 'description' => 'Do not make outbound calls to nonexistent numbers.', + 'example' => 'false', + 'type' => 'boolean', + 'title' => '', + ], + 'InArrearsIgnore' => [ + 'description' => 'Do not make outbound calls to numbers with overdue payments.', + 'example' => 'false', + 'type' => 'boolean', + 'title' => '', + ], + 'OutOfServiceIgnore' => [ + 'description' => 'Do not make outbound calls to numbers that are out of service.', + 'example' => 'false', + 'type' => 'boolean', + 'title' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'Result' => [ + 'description' => 'Statistics information (historical parameter, no longer provided). [Deprecated]', + 'properties' => [ + 'TimeoutHangupNum' => [ + 'description' => 'Quantity of timeout hang-ups [Deprecated]', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'FinishedNum' => [ + 'description' => 'Quantity completed [Deprecated]', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'NoInteractNum' => [ + 'description' => 'Quantity with no interaction [Deprecated]', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'ClientHangupNum' => [ + 'description' => 'Quantity of customer hang-ups [Deprecated]', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'UnrecognizedNum' => [ + 'description' => 'Number of unrecognized responses [Deprecated]', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'RingingDuration' => [ + 'description' => 'Ringing duration', + 'example' => '30', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'Priority' => [ + 'description' => 'Priority', + 'example' => '1', + 'type' => 'string', + 'title' => '', + ], + 'MinConcurrency' => [ + 'description' => 'Minimum concurrency', + 'example' => '1', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'FlashSmsExtras' => [ + 'description' => 'Configuration parameters for flash SMS push, in JSON format, containing configuration information for third-party flash SMS.', + 'type' => 'object', + 'properties' => [ + 'ConfigId' => [ + 'description' => 'Flash SMS configuration ID.', + 'type' => 'string', + 'example' => 'bebe23e6e2604f50bbeb12900c07703d', + 'title' => '', + ], + 'TemplateId' => [ + 'description' => 'Flash SMS Template ID.', + 'type' => 'string', + 'example' => 'e080d737-5c0b-4350-b7d4-1162530579e7', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'RecallCallingNumbers' => [ + 'description' => 'List of recall calling numbers used when the initial call fails to connect. If not specified, the default is the same as the primary calling number list.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of recall calling numbers.', + 'type' => 'string', + 'example' => '["1****6"]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ScriptNluEngine' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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 \\"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}","type":"json"}]', + 'title' => 'Query outbound call task group', + 'changeSet' => [ + [ + 'createdAt' => '2024-07-22T12:44:38.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2024-06-24T02:14:42.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2024-01-04T12:35:21.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2021-12-22T12:30:34.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2021-12-22T12:30:34.000Z', + 'description' => 'Response parameters changed', + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetJobGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'DescribeJobGroupExportTaskProgress' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94072', + 'abilityTreeNodes' => [ + 'FEATUREoutboundbot7ZIYMY', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => false, + 'example' => 'b3dbfb82-1ae6-4e73-b717-f494727d2af3', + 'title' => '', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'required' => false, + 'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'FileHttpUrl' => [ + 'description' => 'File URL', + 'type' => 'string', + 'example' => 'http://xxx.xx.com/xx', + 'title' => '', + ], + 'Progress' => [ + 'description' => 'Export progress', + 'type' => 'number', + 'format' => 'float', + 'example' => '45.0', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Deprecated] Retrieve Task Group Export Job Progress', + 'summary' => 'Retrieves the progress of a task group export job. This API is deprecated and can be replaced by ListDownloadTasks.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeJobGroupExportTaskProgress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DescribeScript' => [ + 'summary' => 'Returns information about a script.', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '38d2e8ed-04e9-4dac-83b5-a8e57642ef13', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bee7e5b1-5d9a-4389-aa7e-bbbee5353a16', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Script' => [ + 'description' => 'Script', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Script status', + 'type' => 'string', + 'example' => 'DRAFTED', + 'title' => '', + ], + 'UpdateTime' => [ + 'description' => 'Update Time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578881227000', + 'title' => '', + ], + 'ChatbotId' => [ + 'description' => 'Chatbot ID', + 'type' => 'string', + 'example' => 'd31794e2a51f47d2901b4094d88311d7', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Script ID', + 'type' => 'string', + 'example' => '810b5872-57f0-4b27-80ab-7b3f4d8a6374', + 'title' => '', + ], + 'IsDebugDrafted' => [ + 'description' => 'Indicates whether the debug version is in Draft status.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Industry' => [ + 'description' => 'Industry', + 'type' => 'string', + 'example' => '金融', + 'title' => '', + ], + 'ScriptDescription' => [ + 'description' => 'Script description', + 'type' => 'string', + 'example' => '催收话术', + 'title' => '', + ], + 'MiniPlaybackEnable' => [ + 'description' => 'Toggle for tone continuity configuration', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'IsDrafted' => [ + 'description' => 'Indicates whether the script is in Draft status.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'TtsConfig' => [ + 'description' => 'TTS configuration for the script', + '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" + .'}', + 'title' => '', + ], + 'DebugStatus' => [ + 'description' => 'Debug status of the script', + 'type' => 'string', + 'example' => 'DRAFTED', + 'title' => '', + ], + 'AsrConfig' => [ + 'description' => 'ASR configuration', + '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" + .'}', + 'title' => '', + ], + 'Scene' => [ + 'description' => 'Scenario', + 'type' => 'string', + 'example' => '催收', + 'title' => '', + ], + 'ScriptName' => [ + 'description' => 'Script Name', + 'type' => 'string', + 'example' => '催收话术', + 'title' => '', + ], + 'NewBargeInEnable' => [ + 'description' => 'Graceful interruption configuration toggle', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'LongWaitEnable' => [ + 'description' => 'Toggle for Intelligent Sentence Segmentation configuration', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'EmotionEnable' => [ + 'description' => 'Toggle for emotion detection configuration', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'AgentId' => [ + 'description' => 'Access key for the robot workspace', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1218333', + 'title' => '', + ], + 'AgentKey' => [ + 'description' => 'Access key for the chatbot workspace', + 'type' => 'string', + 'example' => '14791f5f226b4878b3d9b676a0291234', + 'title' => '', + ], + 'AgentLlm' => [ + 'description' => 'Indicates whether the chatbot workspace is an LLM workspace.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ChatConfig' => [ + 'description' => 'Chat configuration', + '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}}', + 'title' => '', + ], + 'NluEngine' => [ + 'description' => 'NLU engine (applicable only to LLM scenarios)'."\n" + ."\n" + .'- Prompts – Text input pattern '."\n" + .'- SSE_FUNCTION – Function Compute service pattern', + 'type' => 'string', + 'example' => 'Prompts', + 'title' => '', + ], + 'NluProfile' => [ + 'description' => 'Configuration for Function Compute service pattern', + 'type' => 'object', + 'properties' => [ + 'FcFunction' => [ + 'description' => 'Service Name of the function', + 'type' => 'string', + 'example' => 'sanfang_test', + 'title' => '', + ], + 'FcRegion' => [ + 'description' => 'Region of the Function Compute service', + 'type' => 'string', + 'example' => 'cn-shanghai', + 'title' => '', + ], + 'FcHttpTriggerUrl' => [ + 'description' => 'Function Compute trigger', + 'type' => 'string', + 'example' => 'http://sanfang_test-xxxxxx.cn-shanghai-vpc.fcapp.run', + 'title' => '', + ], + 'SupportBeebotPrompts' => [ + 'type' => 'boolean', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'LabelConfig' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + 'NlsConfig' => [ + 'description' => 'Deprecated', + 'type' => 'string', + 'example' => 'none', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[{"errorExample":"","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\\": false\\n },\\n \\"LabelConfig\\": \\"\\"\\n },\\n \\"NlsConfig\\": \\"none\\"\\n}","type":"json"}]', + 'title' => 'Retrieve information about a script', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-22T14:21:12.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2025-06-12T11:39:29.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2025-04-25T07:27:13.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2024-08-06T12:39:33.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2024-04-25T12:17:46.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2022-09-20T13:53:36.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2022-06-21T12:54:40.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2022-03-01T12:42:07.000Z', + 'description' => 'Response parameters changed', + ], + ], + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0fe7f71c-8771-42ef-9bb1-19aa16ae7120', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptVoiceConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario voice configuration ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2a07b634-e15d-445f-bbcb-fc4ea2df7b87', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ScriptVoiceConfig' => [ + 'description' => 'Scenario voice configuration information', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Recording type'."\n" + ."\n" + .'- WAVEFORM: Recording'."\n" + .'- TTS: Text-to-speech', + 'type' => 'string', + 'example' => 'TTS', + 'title' => '', + ], + 'ScriptVoiceConfigId' => [ + 'description' => 'Scenario voice configuration ID', + 'type' => 'string', + 'example' => '2a07b634-e15d-445f-bbcb-fc4ea2df7b87', + 'title' => '', + ], + 'ScriptContent' => [ + 'description' => 'Script content', + 'type' => 'string', + 'example' => '你的花呗欠款逾期了需要处理，你现在能处理一下吗？', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => '291cfc6a-8703-4bdd-a99d-9cba32d5288a', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'example' => '947e0875-b5d4-4b33-b18c-7b2cf85bcb4f', + 'title' => '', + ], + 'ScriptWaveformRelation' => [ + 'description' => 'Script recording data. This field has a value only when Type is WAVEFORM.', + 'type' => 'string', + 'example' => '[{"ScriptContent":"请问你是","ScriptWaveformId":"07db2f0a-acb2-4e68-b9f4-66397414f50c"},{"ScriptContent":"吗？","ScriptWaveformId":"c2a69440-03e3-406e-b0a9-a9791fccb31b"}]', + 'title' => '', + ], + 'Source' => [ + 'description' => 'Script source', + 'type' => 'string', + 'example' => 'DIALOGUE_FLOW', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Legacy canvas API] Returns a scenario voice configuration', + 'summary' => 'Returns a scenario voice configuration in the legacy canvas scenario.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeScriptVoiceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DescribeTTSConfig' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'docRequired' => true, + 'example' => '0ec0c897-b92c-40e4-9ad7-e6e4f5ce13bb', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'docRequired' => true, + 'example' => 'd7fbd0a0-27bc-49c4-a456-ecb75e79122b', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => 'f765d3ee-ec03-4765-b235-6877501d99d1', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'TTSConfig' => [ + 'description' => 'TTS configuration', + 'properties' => [ + 'Voice' => [ + 'description' => 'TTS model', + 'example' => 'xiaoyun', + 'type' => 'string', + 'title' => '', + ], + 'SpeechRate' => [ + 'description' => 'Speech rate', + 'example' => '-150', + 'type' => 'string', + 'title' => '', + ], + 'Volume' => [ + 'description' => 'Volume', + 'example' => '100', + 'type' => 'string', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'example' => '947e0875-b5d4-4b33-b18c-7b2cf85bcb4f', + 'type' => 'string', + 'title' => '', + ], + 'NlsServiceType' => [ + 'description' => 'Service Type', + 'example' => 'Managed', + 'type' => 'string', + 'title' => '', + ], + 'AppKey' => [ + 'type' => 'string', + 'description' => 'AppKey for invoking TTS', + 'example' => 'p2SjSj4zxxxxxxxx', + 'title' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '[Deprecated] Query TTS configuration information', + 'summary' => 'Query TTS configuration information.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2022-03-01T12:42:07.000Z', + 'description' => 'Response parameters changed, Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeTTSConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DescribeTTSDemo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a8eccb3c-2b26-4b6d-a54f-696b953e33a6', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '5ab2d935-306c-478a-88bf-d08e4e25c1b7', + 'title' => '', + ], + ], + [ + 'name' => 'Voice', + 'in' => 'query', + 'schema' => [ + 'description' => 'Voice speaker information, such as aixia, siyue, or xiaoyun. For a complete list of available voices, see https://ai.aliyun.com/nls/tts. ', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'aixia', + 'title' => '', + ], + ], + [ + 'name' => 'Text', + 'in' => 'query', + 'schema' => [ + 'description' => 'Text content', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '测试', + 'title' => '', + ], + ], + [ + 'name' => 'SpeechRate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Speech rate '."\n" + .'An integer between -500 and 500. Default value is 0. '."\n" + ."\n" + .'A value greater than 0 increases the speech rate. '."\n" + ."\n" + .'A value less than 0 decreases the speech rate. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '500', + 'minimum' => '-500', + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => [ + 'description' => 'Volume'."\n" + .'An integer between [0, 100]. Default value is 50.'."\n" + ."\n" + .'A value greater than 50 increases the volume.'."\n" + ."\n" + .'A value less than 50 decreases the volume.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '50', + 'title' => '', + ], + ], + [ + 'name' => 'PitchRate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Pitch'."\n" + .'An integer between [-500, 500]. Default value is 0.'."\n" + ."\n" + .'A value greater than 0 raises the pitch.'."\n" + ."\n" + .'A value less than 0 lowers the pitch.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'AppKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'Voice service type'."\n" + ."\n" + .'- When **ali** is used as the custom service, this field stores the appKey of the Intelligent Speech Interaction product project.'."\n" + ."\n" + .'- When **xunfei** is used as the custom service provider, this field stores the corresponding appKey.', + 'type' => 'string', + 'required' => false, + 'example' => 'xusi*******RnP7', + 'title' => '', + ], + ], + [ + 'name' => 'SecretKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'AccessKey secret (SK) of the namespace.'."\n" + ."\n" + .'> When engine is set to xunfei, you must provide its SK here.', + 'type' => 'string', + 'required' => false, + 'example' => 'OTdhNDE3Z********zQ****', + 'title' => '', + ], + ], + [ + 'name' => 'AccessKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The AccessKey (AK) of this namespace. '."\n" + .'> When the engine is xunfei, you must provide its AK here. ', + 'type' => 'string', + 'required' => false, + 'example' => '5d0f37**********ef56db601****', + 'title' => '', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'enumValueTitles' => [ + 'xunfei' => 'xunfei ', + 'volc' => 'volc ', + 'ali' => 'ali ', + ], + 'description' => 'Storage engine. Valid values are ali, volc, and xunfei. '."\n" + ."\n" + .'- Use **ali** when using the default service or a custom service provided by Alibaba. '."\n" + .'- Use **volc** when using the doubao service. '."\n" + .'- Use **xunfei** when using xunfei as the service provider (only supported in small model scenarios). ', + 'type' => 'string', + 'required' => false, + 'example' => 'ali', + 'title' => '', + ], + ], + [ + 'name' => 'NlsServiceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Service Type '."\n" + .'Managed: The default Intelligent Speech Interaction service for Intelligent Outbound Calling products (public service). '."\n" + .'Authorized: The Intelligent Speech Interaction service purchased by the public cloud customer (customer private service), authorized via Scenario Management > Edit > Invoke Service > Custom Service. '."\n" + ."\n" + .'> When using Alibaba\'s Intelligent Speech Interaction service—i.e., when Alibaba is specified as the custom service provider—you must set this parameter to Authorized. ', + 'type' => 'string', + 'required' => false, + 'example' => 'Authorized', + 'title' => '', + ], + ], + [ + 'name' => 'AliCustomizedVoice', + 'in' => 'query', + 'schema' => [ + 'description' => 'Alibaba customized voice, which is the voice invocation ID', + 'type' => 'string', + 'required' => false, + 'example' => 'voice-e1be3a6', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'AuditionUrl' => [ + 'description' => 'Audition file URL', + 'type' => 'string', + 'example' => 'http://XXX/XXX', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '', + ], + ], + ], + 'title' => 'TTS Audition', + 'summary' => 'Time Tunnel试听。', + 'requestParamsDescription' => '<details>'."\n" + .'<summary>Doubao Voice Tones</summary>'."\n" + ."\n" + .'- Multi-emotion:'."\n" + .' - Beijing Xiaoye: zh_male_beijingxiaoye_emo_v2_mars_bigtts'."\n" + .' - Gentle Girlfriend: zh_female_roumeinvyou_emo_v2_mars_bigtts'."\n" + .' - Sunny Youth: zh_male_yangguangqingnian_emo_v2_mars_bigtts'."\n" + .' - Charming Girlfriend: zh_female_meilinvyou_emo_v2_mars_bigtts'."\n" + .' - Cheerful Sisi: zh_female_shuangkuaisisi_emo_v2_mars_bigtts'."\n" + .'- General-purpose scenarios:'."\n" + .' - Cancan / Shiny: zh_female_cancan_mars_bigtts'."\n" + .' - Fresh Female Voice: zh_female_qingxinnvsheng_mars_bigtts'."\n" + .' - Cheerful Sisi / Skye: zh_female_shuangkuaisisi_moon_bigtts'."\n" + .' - Warm Ahu / Alvin: zh_male_wennuanahu_moon_bigtts'."\n" + .' - Youthful Zixin / Brayan: zh_male_shaonianzixin_moon_bigtts'."\n" + .' - Intellectual Female Voice: zh_female_zhixingnvsheng_mars_bigtts'."\n" + .' - Crisp Male College Student: zh_male_qingshuangnanda_mars_bigtts'."\n" + .' - Girl Next Door: zh_female_linjianvhai_moon_bigtts'."\n" + .' - Knowledgeable Uncle: zh_male_yuanboxiaoshu_moon_bigtts'."\n" + .' - Sunny Youth: zh_male_yangguangqingnian_moon_bigtts'."\n" + .' - Sweet Xiao Yuan: zh_female_tianmeixiaoyuan_moon_bigtts'."\n" + .' - Clear Zizi: zh_female_qingchezizi_moon_bigtts'."\n" + .' - Narrator Xiaoming: zh_male_jieshuoxiaoming_moon_bigtts'."\n" + .' - Cheerful Older Sister: zh_female_kailangjiejie_moon_bigtts'."\n" + .' - Boy Next Door: zh_male_linjiananhai_moon_bigtts'."\n" + .' - Sweet Yueyue: zh_female_tianmeiyueyue_moon_bigtts'."\n" + .' - Inspirational Speaker: zh_female_xinlingjitang_moon_bigtts'."\n" + .' - Refined and Gentle: ICL_zh_female_zhixingwenwan_tob'."\n" + .' - Warm and Thoughtful: ICL_zh_male_nuanxintitie_tob'."\n" + .' - Soft and Elegant: ICL_zh_female_wenrouwenya_tob'."\n" + .' - Cheerful and Lively: ICL_zh_male_kailangqingkuai_tob'."\n" + .' - Energetic and Outgoing: ICL_zh_male_huoposhuanglang_tob'."\n" + .' - Frank Young Man: ICL_zh_male_shuaizhenxiaohuo_tob'."\n" + .' - Gentle Young Man: zh_male_wenrouxiaoge_mars_bigtts'."\n" + .'- Multilingual:'."\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" + .' - Kazune (Harmony) / Javier or Álvaro: multi_male_jingqiangkanye_moon_bigtts'."\n" + .' - Haruko (Sunny) / Esmeralda: multi_female_shuangkuaisisi_moon_bigtts'."\n" + .' - Hiroshi (Hiroshi) / Roberto: multi_male_wanqudashu_moon_bigtts'."\n" + .' - Akemi (Akemi): multi_female_gaolengyujie_moon_bigtts'."\n" + .' - Amanda: en_female_amanda_mars_bigtts'."\n" + .' - Jackson: en_male_jackson_mars_bigtts'."\n" + .'- Fun Accents:'."\n" + .' - Beijing-style Talkative Guy / Harmony: zh_male_jingqiangkanye_moon_bigtts'."\n" + .' - Taiwanese Xiao He: zh_female_wanwanxiaohe_moon_bigtts'."\n" + .' - Bay Area Uncle: zh_female_wanqudashu_moon_bigtts'."\n" + .' - Cute Sichuan Girl: zh_female_daimengchuanmei_moon_bigtts'."\n" + .' - Guangzhou Dege: zh_male_guozhoudege_moon_bigtts'."\n" + .' - Beijing Xiaoye: zh_male_beijingxiaoye_moon_bigtts'."\n" + .' - Haoyu Young Man: zh_male_haoyuxiaoge_moon_bigtts'."\n" + .' - Guangxi Yuanzhou: zh_male_guangxiyuanzhou_moon_bigtts'."\n" + .' - Meituo Jieer: zh_female_meituojieer_moon_bigtts'."\n" + .' - Yuzhou Zixuan: zh_male_yuzhouzixuan_moon_bigtts'."\n" + .'- Role assumption:'."\n" + .' - Adorable Baby Boy: zh_male_naiqimengwa_mars_bigtts'."\n" + .' - Granny: zh_female_popo_mars_bigtts'."\n" + .' - Cool and Aloof Older Sister: zh_female_gaolengyujie_moon_bigtts'."\n" + .' - Tsundere CEO: zh_male_aojiaobazong_moon_bigtts'."\n" + .' - Charming Girlfriend: zh_female_meilinvyou_moon_bigtts'."\n" + .' - Late-night Podcaster: zh_male_shenyeboke_moon_bigtts'."\n" + .' - Gentle Girlfriend: zh_female_sajiaonvyou_moon_bigtts'."\n" + .' - Coquettish Junior: zh_female_yuanqinvyou_moon_bigtts'."\n" + .' - Frail Girl: ICL_zh_female_bingruoshaonv_tob'."\n" + .' - Lively Girl: ICL_zh_female_huoponvhai_tob'."\n" + .' - Dongfang Haoran: zh_male_dongfanghaoran_moon_bigtts'."\n" + .' - "Green Tea" Young Man: ICL_zh_male_lvchaxiaoge_tob'."\n" + .' - Delicate Lolita: ICL_zh_female_jiaoruoluoli_tob'."\n" + .' - Cold and Distant: ICL_zh_male_lengdanshuli_tob'."\n" + .' - Honest and Steady: ICL_zh_male_hanhoudunshi_tob'."\n" + .' - Arrogant and Overbearing: ICL_zh_male_aiqilingren_tob'."\n" + .' - Playful and Willful: ICL_zh_female_huopodiaoman_tob'."\n" + .' - Obsessive and Stubborn: ICL_zh_male_guzhibingjiao_tob'."\n" + .' - Affectionate and Clingy: ICL_zh_male_sajiaonianren_tob'."\n" + .' - Proud and Sweet-voiced: ICL_zh_female_aomanjiaosheng_tob'."\n" + .' - Carefree and Unrestrained: ICL_zh_male_xiaosasuixing_tob'."\n" + .' - Cunning Nobleman: ICL_zh_male_fuheigongzi_tob'."\n" + .' - Eerie and Mysterious: ICL_zh_male_guiyishenmi_tob'."\n" + .' - Cultured and Talented Scholar: ICL_zh_male_ruyacaijun_tob'."\n" + .' - Obsessive "White Lotus": ICL_zh_male_bingjiaobailian_tob'."\n" + .' - Upright Youth: ICL_zh_male_zhengzhiqingnian_tob'."\n" + .' - Adorably Dignified Queen: ICL_zh_female_jiaohannvwang_tob'."\n" + .' - Obsessive and Cute Girl: ICL_zh_female_bingjiaomengmei_tob'."\n" + .' - Naive Young Man: ICL_zh_male_qingsenaigou_tob'."\n" + .' - Innocent Classmate: ICL_zh_male_chunzhenxuedi_tob'."\n" + .' - Caring Senior: ICL_zh_female_nuanxinxuejie_tob'."\n" + .' - Lovely Girl: ICL_zh_female_keainvsheng_tob'."\n" + .' - Mature Older Sister: ICL_zh_female_chengshujiejie_tob'."\n" + .' - Obsessive Older Sister: ICL_zh_female_bingjiaojiejie_tob'."\n" + .' - Indecisive Sect Leader: ICL_zh_male_youroubangzhu_tob'."\n" + .' - Indecisive Nobleman: ICL_zh_male_yourougongzi_tob'."\n" + .' - Alluring Older Sister: ICL_zh_female_wumeiyujie_tob'."\n" + .' - Playful Princess: ICL_zh_female_tiaopigongzhu_tob'."\n" + .' - Tsundere Girlfriend: ICL_zh_female_aojiaonvyou_tob'."\n" + .' - Thoughtful Boyfriend: ICL_zh_male_tiexinnanyou_tob'."\n" + .' - Young General: ICL_zh_male_shaonianjiangjun_tob'."\n" + .' - Caring Girlfriend: ICL_zh_female_tiexinnvyou_tob'."\n" + .' - Obsessive Older Brother: ICL_zh_male_bingjiaogege_tob'."\n" + .' - Genius Male Deskmate: ICL_zh_male_xuebanantongzhuo_tob'."\n" + .' - Humorous Uncle: ICL_zh_male_youmoshushu_tob'."\n" + .' - Sexy Older Sister: ICL_zh_female_xingganyujie_tob'."\n" + .' - Tomboy: ICL_zh_female_jiaxiaozi_tob'."\n" + .' - Stern Boss: ICL_zh_male_lengjunshangsi_tob'."\n" + .' - Gentle Male Deskmate: ICL_zh_male_wenrounantongzhuo_tob'."\n" + .' - Obsessive Younger Brother: ICL_zh_male_bingjiaodidi_tob'."\n" + .' - Witty Grandpa: ICL_zh_male_youmodaye_tob'."\n" + .' - Arrogant Young Master: ICL_zh_male_aomanshaoye_tob'."\n" + .' - Mysterious Mage: ICL_zh_male_shenmifashi_tob'."\n" + .'- Video dubbing:'."\n" + .' - Kind Grandma: ICL_zh_female_heainainai_tob'."\n" + .' - Neighbor Auntie: ICL_zh_female_linjuayi_tob'."\n" + .' - Gentle Xiaoya: zh_female_wenrouxiaoya_moon_bigtts'."\n" + .' - Child Prodigy Voice: zh_male_tiancaitongsheng_mars_bigtts'."\n" + .' - Monkey King: zh_male_sunwukong_mars_bigtts'."\n" + .' - Xiong Er: zh_male_xionger_mars_bigtts'."\n" + .' - Peppa Pig: zh_female_peiqi_mars_bigtts'."\n" + .' - Empress Wu Zetian: zh_female_wuzetian_mars_bigtts'."\n" + .' - Gu Jie: zh_female_gujie_mars_bigtts'."\n" + .' - Chibi Maruko-chan: zh_female_yingtaowanzi_mars_bigtts'."\n" + .' - Commercial Narration: zh_male_chunhui_mars_bigtts'."\n" + .' - Children\'s Storytelling: zh_female_shaoergushi_mars_bigtts'."\n" + .' - Silang: zh_male_silang_mars_bigtts'."\n" + .' - Magnetic Male Narrator / Morgan: zh_male_jieshuonansheng_mars_bigtts'."\n" + .' - Inspirational Little Sister / Hope: zh_female_jitangmeimei_mars_bigtts'."\n" + .' - Thoughtful Female Voice / Candy: zh_female_tiexinnvsheng_mars_bigtts'."\n" + .' - Playful Female Voice: zh_female_qiaopinvsheng_mars_bigtts'."\n" + .' - Cute Girl / Cutey: zh_female_mengyatou_mars_bigtts'."\n" + .' - Lazy绵Bao: zh_male_lanxiaoyang_mars_bigtts'."\n" + .' - Bright-voiced Cutie: zh_male_dongmanhaimian_mars_bigtts'."\n" + .'- Audiobook reading:'."\n" + .' - Mystery Narration: zh_male_changtianyi_mars_bigtts'."\n" + .' - Cultured Young Man: zh_male_ruyaqingnian_mars_bigtts'."\n" + .' - Dominant Middle-aged Man: zh_male_baqiqingshu_mars_bigtts'."\n" + .' - Qingcang: zh_male_qingcang_mars_bigtts'."\n" + .' - Energetic Young Man: zh_male_yangguangqingnian_mars_bigtts'."\n" + .' - Ancient-style Young Lady: zh_female_gufengshaoyu_mars_bigtts'."\n" + .' - Gentle and Graceful Lady: zh_female_wenroushunv_mars_bigtts'."\n" + .' - Anti-hustle Youth: zh_male_fanjuanqingnian_mars_bigtts'."\n" + ."\n\n" + .'</details>', + 'changeSet' => [ + [ + 'createdAt' => '2024-08-28T12:13:12.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-02-04T14:18:22.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2023-03-07T13:33:57.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2021-12-15T07:48:20.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeTTSDemo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'translator' => 'machine', + ], + 'DescribeTagHitsSummary' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '292eba45-df08-4065-87e7-7e587a1ce4ce', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '5391EB13-A0E7-402D-A407-B99D4ABAF22A', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'TagGroups' => [ + 'description' => 'Tag group information', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagGroupIndex' => [ + 'description' => 'Tag group index', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'TagGroup' => [ + 'description' => 'Tag group name', + 'type' => 'string', + 'example' => '标签组', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'example' => '8a4c6d3d-5ed6-44ca-b779-16c20f8862be', + 'title' => '', + ], + 'Id' => [ + 'description' => 'ID', + 'type' => 'string', + 'example' => '8bb6f8ca-85a3-49f8-86a5-3127902a2156', + 'title' => '', + ], + ], + 'description' => 'Tag group information', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TagHitsList' => [ + 'description' => 'Hit tag information', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HitCount' => [ + 'description' => 'Hit count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'TagGroup' => [ + 'description' => 'Tag group name', + 'type' => 'string', + 'example' => '当前学历', + 'title' => '', + ], + 'TagName' => [ + 'description' => 'Tag name', + 'type' => 'string', + 'example' => '本科', + 'title' => '', + ], + ], + 'description' => 'Hit tag information', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query tag statistics—Legacy canvas API', + 'summary' => 'Query tag statistics using the legacy canvas API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeTagHitsSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DescribeTenantBindNumber' => [ + 'summary' => 'List of number binding instances under the tenant.', + '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' => 'The bound number (Required)'."\n" + ."\n" + .'> Query the binding status of the specified number across all instances. Obtain the number from the response parameters of ListAllTenantBindNumberBinding.', + 'type' => 'string', + 'required' => true, + 'example' => '15005059355', + 'docRequired' => true, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<TenantBindNumberResponse>', + 'description' => 'BaseResponse<TenantBindNumberResponse>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'Job group description', + 'type' => 'array', + 'items' => [ + 'description' => 'Data', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'instance ID', + 'type' => 'string', + 'example' => 'e2d7a184-7d6c-45d4-ac24-34ab48f54669', + 'title' => '', + ], + 'InstanceName' => [ + 'description' => 'Instance name', + 'type' => 'string', + 'example' => 'xxxx', + 'title' => '', + ], + 'IsBinding' => [ + 'title' => '', + 'description' => 'Indicates whether the instance is in the attached state.', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '1364f208-982d-4d0c-89aa-d56e22b47589', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Number binding status under the tenant', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-03-01T12:36:05.000Z', + 'description' => 'OpenAPI offline', + ], + ], + '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' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'Dialogue' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'call ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1528189846043', + 'title' => '', + ], + ], + [ + 'name' => 'CallType', + 'in' => 'query', + 'schema' => [ + 'description' => 'call type, usually Outbound', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Outbound', + 'title' => '', + ], + ], + [ + 'name' => 'ScenarioId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => false, + 'example' => '6cea9bed-63e6-439e-ae4c-b3333efff53d', + 'title' => '', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'required' => false, + 'example' => 'ff44709e-39a6-43ba-959b-20fcabe3e496', + 'title' => '', + ], + ], + [ + 'name' => 'Utterance', + 'in' => 'query', + 'schema' => [ + 'description' => 'User utterance', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '是的', + 'title' => '', + ], + ], + [ + 'name' => 'ActionKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'action to be executed for outbound calls, such as Hangup', + 'type' => 'string', + 'required' => false, + 'example' => 'broadcast', + 'title' => '', + ], + ], + [ + 'name' => 'ActionParams', + 'in' => 'query', + 'schema' => [ + 'description' => 'parameters required to execute the action (deprecated)', + 'type' => 'string', + 'required' => false, + 'example' => '""', + 'title' => '', + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'calling number', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1***6', + 'title' => '', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Called number', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '135****4353', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => '场景id', + 'type' => 'string', + 'required' => false, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API prompt message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Feedback' => [ + 'description' => 'Returned conversation information', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => 'Instruction to IVR', + 'type' => 'string', + 'example' => 'broadcast', + 'title' => '', + ], + 'ActionParams' => [ + 'description' => 'Instruction parameters', + 'type' => 'string', + 'example' => '""', + 'title' => '', + ], + 'Content' => [ + 'description' => 'Conversation text', + 'type' => 'string', + 'example' => '你好，我是**客服', + 'title' => '', + ], + 'Interruptible' => [ + 'description' => 'Indicates whether the playback can be interrupted.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ContentParams' => [ + 'description' => '已废弃', + 'type' => 'string', + 'example' => '“”', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Converse with the robot', + 'summary' => 'The robot conversation API for CC callback outbound calls. (Deprecated.)', + 'changeSet' => [ + [ + 'createdAt' => '2024-07-22T12:24:22.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2022-12-29T14:17:10.000Z', + 'description' => 'Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:Dialogue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DownloadRecording' => [ + 'summary' => 'Download call recordings.', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', + 'title' => '', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Call ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '744b27f3-437f-4a8c-a181-f668e492fd24', + 'title' => '', + ], + ], + [ + 'name' => 'NeedVoiceSliceRecording', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether to query segmented recordings', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API prompt message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'DownloadParams' => [ + 'description' => 'Document download URL', + 'type' => 'object', + 'properties' => [ + 'SignatureUrl' => [ + 'description' => 'A URL pointing to the recording file for HTTP download', + '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', + 'title' => '', + ], + 'FileName' => [ + 'description' => 'Recording file name, usually a UUID', + 'type' => 'string', + 'example' => '281eb174-3865-41c1-9274-7b6813edadab.wav', + 'title' => '', + ], + 'VoiceSliceRecordingListJson' => [ + 'description' => 'List of segmented recordings, including file names and file URLs', + '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"}]', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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 \\"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}","type":"json"}]', + 'title' => 'Download call recordings', + 'changeSet' => [ + [ + 'createdAt' => '2022-08-09T13:09:46.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DownloadCabRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'b3865dc3-40fa-4afd-9fe4-dc7cda305a24', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID where the recording is located', + 'type' => 'string', + 'required' => true, + 'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17', + 'title' => '', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique ID of the recording', + 'type' => 'string', + 'required' => true, + 'example' => '5feaab8a-97fd-4720-8108-79e017f2d3ac', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API prompt message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'DownloadParams' => [ + 'description' => 'Parameters', + 'type' => 'object', + 'properties' => [ + 'SignatureUrl' => [ + 'description' => 'A URL pointing to the recording file. You can use this URL for playback or download.', + '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', + 'title' => '', + ], + 'FileName' => [ + 'description' => 'Recording file name', + 'type' => 'string', + 'example' => '281eb174-3865-41c1-9274-7b6813edadab.wav', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Small Model API] Download Recording (Obtain Recording URL)', + 'summary' => 'Download a recording (obtain the recording URL), dedicated to small model scenarios.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DownloadScriptRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'DuplicateScript' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'docRequired' => true, + 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'SourceScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Source scenario ID', + 'docRequired' => true, + 'example' => '6114e7e8-4140-48d9-b46d-65ea29f13fe8', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'New scenario name', + 'docRequired' => true, + 'example' => '复制的催收话术', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'example' => 'True', + 'type' => 'boolean', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID', + 'example' => '6114e7e8-4140-48d9-b46d-65ea29f13fe8', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Legacy Canvas API] Copy Script', + 'summary' => 'Copy a new script from an existing one (for legacy canvas only).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:DuplicateScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ExportScript' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'DownloadParams' => [ + 'description' => 'Signed URL information for downloading the script (returned only for legacy canvas)', + 'type' => 'object', + 'properties' => [ + 'SignatureUrl' => [ + 'description' => 'Download URL (returned only for legacy canvas)', + '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', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Create an export scenario job', + 'summary' => 'Export a scenario.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:ExportScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GenerateUploadUrl' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '130155', + 'abilityTreeNodes' => [ + 'FEATUREoutboundbotQHO52V', + ], + ], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'Upload URL key', + 'type' => 'string', + 'required' => false, + 'example' => '3b9b5dc6d67ee9fa', + 'title' => '', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => 'File name, including the extension.', + 'type' => 'string', + 'required' => false, + 'example' => 'faaf8508-9542-4ac4-84a2-0ddcbb5f79a6 (2).json', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<OssUploadParams>', + 'description' => 'BaseResponse<OssUploadParams>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'True', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'object', + 'properties' => [ + 'AccessId' => [ + 'description' => 'OSS access ID', + 'type' => 'string', + 'example' => 'LTAIvKWEr4******', + 'title' => '', + ], + 'Policy' => [ + 'description' => 'Upload policy', + 'type' => 'string', + 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0yNlQwMzo0ODo1My4wMzVaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJ1cGxvYWQvZmlsZS84NzRkNzM3MS03OTFiLTQyODEtOTM1Yy02Mzc2MzBhMzc3ODUvIl1dfQ==",', + 'title' => '', + ], + 'Signature' => [ + 'description' => 'Signature information', + 'type' => 'string', + 'example' => 'I6d1ONWVuTj5i0Kz4Vn+V0lC6v4=', + 'title' => '', + ], + 'Folder' => [ + 'description' => 'Upload folder', + 'type' => 'string', + 'example' => 'pload/file/874d7371-791b-4281-935c-637630a37785/874d7371-791b-4281-935c-637630a37785_9bd7916d-a340-4925-a911-92390cbe0f33.json', + 'title' => '', + ], + 'Host' => [ + 'description' => 'Upload server URL', + 'type' => 'string', + 'example' => 'https://cloudagentbot-online.oss-cn-hangzhou.aliyuncs.com', + 'title' => '', + ], + 'Expire' => [ + 'description' => 'Expiration time (seconds)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1742960933', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'True', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Upload a hotword list file', + 'summary' => 'Upload a hotword list file.', + 'changeSet' => [ + [ + 'createdAt' => '2022-04-08T07:53:32.000Z', + 'description' => 'OpenAPI offline', + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:GenerateUploadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'GetAfterAnswerDelayPlayback' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'EntryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Policy level (Required)'."\n" + ."\n" + .'- 2: instance', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'AfterAnswerDelayPlayback' => [ + 'description' => 'Latency of the response', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query the delay time for audio playback after the call is answered', + 'summary' => 'Obtain the delay time for audio playback after the call is answered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetAfterAnswerDelayPlayback', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => '0ec0c897-b92c-40e4-9ad7-e6e4f5ce13bb', + ], + ], + [ + 'name' => 'AgentProfileId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'agent profile id', + 'description' => 'Agent profile ID. '."\n" + .'> You can obtain the agent profile ID of an already created scenario from the ChatbotId response parameter of DescribeScript.', + 'type' => 'string', + 'required' => true, + 'example' => 'd31794e2a51f47d2901b4094d88311d7', + ], + ], + [ + 'name' => 'AppIp', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'app_ip (system field, optional)', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<AgentProfile>', + 'description' => 'BaseResponse<AgentProfile>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'is succeeded', + 'type' => 'boolean', + 'example' => 'True', + 'title' => '', + ], + 'Code' => [ + 'description' => 'response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Return message.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Returned data', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '', + 'description' => 'Creation Time', + 'type' => 'string', + 'example' => '1741338619000', + ], + 'UpdateTime' => [ + 'title' => '', + 'description' => 'Updated At', + 'type' => 'string', + 'example' => '1741338619000', + ], + 'AgentProfileId' => [ + 'title' => 'agent profile id', + 'description' => 'agent configuration ID', + 'type' => 'string', + 'example' => 'd31794e2a51f47d2901b4094d88311d7', + ], + 'InstanceId' => [ + 'title' => '', + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => '7f04f92c-ccfc-4f8f-a816-6902023be5c6', + ], + 'ScriptId' => [ + 'title' => 'script id', + 'description' => 'scenario ID', + 'type' => 'string', + 'example' => 'd13ad2d3-3fe6-4352-b38b-bd6559047de8', + ], + 'AgentType' => [ + 'title' => 'agent type', + 'description' => 'agent type', + 'type' => 'string', + 'example' => '""', + ], + 'PromptJson' => [ + 'title' => 'prompt json', + 'description' => 'agent configuration', + 'type' => 'string', + 'example' => '{"name":"小x","gender":"男","age":18,"role":"游戏推广员","communicationStyle":["亲切"],"goals":"你好","background":"不是很好","openingPrompt":"你好，我是xxx"}'."\n", + ], + 'Prompt' => [ + 'title' => 'prompt', + 'description' => 'prompt (professional mode)', + 'type' => 'string', + 'example' => '""', + ], + 'AgentProfileTemplateId' => [ + 'title' => 'agent template id', + 'description' => 'agent configuration template ID', + 'type' => 'string', + 'example' => 'default-survey', + ], + 'Model' => [ + 'title' => '', + 'description' => 'model ID', + 'type' => 'string', + 'example' => 'model_002', + ], + 'ModelConfig' => [ + 'title' => 'model config', + 'description' => 'Model Configuration', + 'type' => 'string', + 'example' => '{}', + ], + 'System' => [ + 'title' => '', + 'description' => 'Indicates whether it is a system template.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'LabelsJson' => [ + 'title' => 'labels', + 'description' => 'Tag Description', + 'type' => 'string', + 'example' => '[{\\"name\\":\\"是否送达\\",\\"description\\":\\"购买的家电是否已经送达\\",\\"valueList\\":\\"[\\\\\\"是\\\\\\",\\\\\\"否\\\\\\"]\\"},{\\"name\\":\\"预约上门时间\\",\\"description\\":\\"收集客户期望的上门安装时间\\",\\"valueList\\":\\"[]\\"}]'."\n", + ], + 'VariablesJson' => [ + 'title' => 'variables', + 'description' => 'Variable configuration', + 'type' => 'string', + 'example' => '[{\\"name\\":\\"name\\",\\"description\\":\\"客户姓名\\"},{\\"name\\":\\"gender\\",\\"description\\":\\"客户性别\\"}]'."\n", + ], + 'Scenario' => [ + 'title' => '', + 'description' => 'scenario', + 'type' => 'string', + 'example' => '测试场景', + ], + 'Description' => [ + 'title' => '', + 'description' => 'Description', + 'type' => 'string', + 'example' => '这是一个大模型机器人', + ], + 'InstructionJson' => [ + 'description' => 'instruction configuration', + 'type' => 'string', + 'example' => '[{"type":"TransferToAgent","instructions":[{"code":"Transfer0","skillGroupId":"123","skillGroupName":"123"}],"timeoutEnable":false},{"type":"CollectNumber","instructions":[]}]'."\n", + 'title' => '', + ], + 'ApiPluginJson' => [ + 'description' => 'API plugin configuration', + 'type' => 'string', + 'example' => '[]', + 'title' => '', + ], + 'NluConfigJson' => [ + 'description' => 'NLU configuration. Parameter configuration:'."\n" + .'- chatbotInstanceId: LLM-based XiaoMi bot instance ID'."\n" + .'- faqCategoryIds: Attached FAQ category IDs'."\n" + .'- llmAgentId: XiaoMi LLM workspace ID'."\n" + .'- llmAgentKey: XiaoMi LLM workspace key'."\n" + .'- llmAgentInstanceId: XiaoMi LLM workspace instance 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", + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '7A573837-3AD3-54CF-930A-07A3287042C2', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Retrieve agent configuration', + 'summary' => 'Retrieve the agent configuration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetAgentProfile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GetAgentProfileTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AgentProfileTemplateId', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'Agent Template ID', + 'type' => 'string', + 'required' => true, + 'example' => 'default-survey', + ], + ], + [ + 'name' => 'AppIp', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'app_ip (system field; optional)', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<AgentProfileTemplate>', + 'description' => 'BaseResponse<AgentProfileTemplate>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '', + 'description' => 'Creation Time', + 'type' => 'string', + 'example' => '1720766491000', + ], + 'UpdateTime' => [ + 'title' => '', + 'description' => 'Updated At', + 'type' => 'string', + 'example' => '1720766491000', + ], + 'AgentProfileTemplateId' => [ + 'title' => 'agent template id', + 'description' => 'Agent template ID', + 'type' => 'string', + 'example' => 'default-survey', + ], + 'Name' => [ + 'title' => 'agent profile template name', + 'description' => 'Agent configuration template name', + 'type' => 'string', + 'example' => '问卷调查', + ], + 'Description' => [ + 'title' => 'agent profile template description', + 'description' => 'Agent configuration template description', + 'type' => 'string', + 'example' => '说明', + ], + 'PromptSchema' => [ + 'title' => 'prompt schema', + 'description' => 'Agent template configuration', + '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<copy>技能1:核验用户身份\\n技能2:进行活动推荐\\n技能3:确认用户参与意向并礼貌挂机<copy>",'."\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<copy>根据预先设定的问题逻辑推进调研：\\n1. 总体满意度：“首先，请问您对我们服务的整体满意度如何评价？非常满意、满意、一般、不满意还是非常不满意？”\\n2. 服务亮点（若上一题为正面评价）：“很高兴听到您的满意！请问哪些方面让您感到特别满意呢？”\\n3. 改进建议（若上一题为负面评价）：“非常抱歉给您带来了不便。您认为我们在哪方面可以做得更好？”\\n4. 服务效率：“在服务响应速度和服务完成的时效性上，您的感受是怎样的？”\\n5. 员工态度：“对于服务人员的专业度和态度，您有何评价？”\\n6. 再次选择意愿：“基于此次体验，您未来是否会考虑再次使用我们的服务？”</copy>",'."\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<copy>你需要记住你的角色信息，并始终遵循。\\n- 在整个通话过程中，保持语气的中立性和友好性，避免对受访者产生引导性影响。\\n- 每轮对话不超过50个字，确保信息传达的高效性。\\n- 严格遵守调研伦理，保证受访者信息的匿名性和隐私安全。\\n- 避免在电话中深入讨论涉及个人隐私或具体服务细节的问题。\\n- 用户询问的问题与目标或流程无关时， 请礼貌拒绝，并引导到目标问题上。\\n- 只回复与本次任务相关的问题；对于不知道的问题，请不要胡乱回复，需要礼貌回复“不清楚”，并引导到目标问题上。</copy>",'."\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" + .'}', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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<copy>技能1:核验用户身份\\\\\\\\n技能2:进行活动推荐\\\\\\\\n技能3:确认用户参与意向并礼貌挂机<copy>\\\\\\",\\\\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<copy>根据预先设定的问题逻辑推进调研：\\\\\\\\n1. 总体满意度：“首先，请问您对我们服务的整体满意度如何评价？非常满意、满意、一般、不满意还是非常不满意？”\\\\\\\\n2. 服务亮点（若上一题为正面评价）：“很高兴听到您的满意！请问哪些方面让您感到特别满意呢？”\\\\\\\\n3. 改进建议（若上一题为负面评价）：“非常抱歉给您带来了不便。您认为我们在哪方面可以做得更好？”\\\\\\\\n4. 服务效率：“在服务响应速度和服务完成的时效性上，您的感受是怎样的？”\\\\\\\\n5. 员工态度：“对于服务人员的专业度和态度，您有何评价？”\\\\\\\\n6. 再次选择意愿：“基于此次体验，您未来是否会考虑再次使用我们的服务？”</copy>\\\\\\",\\\\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<copy>你需要记住你的角色信息，并始终遵循。\\\\\\\\n- 在整个通话过程中，保持语气的中立性和友好性，避免对受访者产生引导性影响。\\\\\\\\n- 每轮对话不超过50个字，确保信息传达的高效性。\\\\\\\\n- 严格遵守调研伦理，保证受访者信息的匿名性和隐私安全。\\\\\\\\n- 避免在电话中深入讨论涉及个人隐私或具体服务细节的问题。\\\\\\\\n- 用户询问的问题与目标或流程无关时， 请礼貌拒绝，并引导到目标问题上。\\\\\\\\n- 只回复与本次任务相关的问题；对于不知道的问题，请不要胡乱回复，需要礼貌回复“不清楚”，并引导到目标问题上。</copy>\\\\\\",\\\\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' => 'Obtain agent configuration template (deprecated)', + 'summary' => 'Retrieve the agent configuration template.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetAgentProfileTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => '', + 'description' => 'Annotation job ID ', + 'type' => 'string', + 'required' => false, + 'example' => '50e53ac8-24a4-46d5-b174-ee88867f4780', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<GetAnnotationMissionSummaryResponse>', + 'description' => 'BaseResponse<GetAnnotationMissionSummaryResponse>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the invocation succeeded. true: The invocation succeeded. false: Failed to invoke. ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Additional information. The value is as follows: If the request is normal, returns "success". If the request is abnormal, returns the specific error code.', + 'type' => 'string', + 'example' => 'You are not authorized to perform this action. CDR:View privileges are required.', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Data.', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionId' => [ + 'title' => '', + 'description' => 'Annotation job ID.', + 'type' => 'string', + 'example' => 'b3f2c931-5180-43ca-b4aa-2baee2d73c8b', + ], + 'IntentSummaryInfo' => [ + 'title' => '', + 'description' => 'Semantics annotation statistics information', + 'type' => 'object', + 'properties' => [ + 'IntentUserSayCount' => [ + 'description' => 'Chat count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'AnnotationCorrectCount' => [ + 'description' => 'Number of correct chats', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'MatchErrorCount' => [ + 'description' => 'Number Of Error in detection', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'AnnotationInvalid' => [ + 'description' => 'Invalid data', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'NoAnnotation' => [ + 'description' => 'Unannotated', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ChatTotalCount' => [ + 'description' => 'Total number of chats', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'TranslationUnrecognizedCount' => [ + 'description' => 'Count of unrecognized translations', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'IntentionNotCoveredCount' => [ + 'description' => 'Uncovered intents', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + ], + 'example' => '', + ], + 'AsrSummaryInfo' => [ + 'title' => '', + 'description' => 'Speech annotation statistics information.', + 'type' => 'object', + 'properties' => [ + 'WordErrorRate' => [ + 'description' => 'Word error rate, in units of 0.01%, typically used for English', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'CharacterErrorRate' => [ + 'description' => 'Character error rate, in units of 0.01%', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'SentenceErrorRate' => [ + 'description' => 'Sentence error rate, in units of 0.01%', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'AnnotationInvalid' => [ + 'description' => 'Invalid data', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'NoAnnotation' => [ + 'description' => 'Not annotated', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ChatTotalCount' => [ + 'description' => 'Total chat count.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'AddVocabularyDataCount' => [ + 'description' => 'Count of adding hotwords.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'AddCustomizationDataCount' => [ + 'description' => 'Count of adding language model data.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'CharacterCorrectRate' => [ + 'description' => 'Character accuracy rate, in units of 0.01%', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + ], + 'example' => '', + ], + 'TagSummaryInfo' => [ + 'title' => '', + 'description' => 'Custom tags and quantities', + 'type' => 'object', + 'properties' => [ + 'TagSummaryInfoDetailList' => [ + 'description' => 'Tag list', + 'type' => 'array', + 'items' => [ + 'description' => 'List of tags ', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'Tag name ', + 'type' => 'string', + 'example' => '知晓率1_复制', + 'title' => '', + ], + 'Count' => [ + 'description' => 'Quantity of tags ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the invocation succeeded. true: The invocation succeeded. false: Failed to invoke. ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Additional information. The value is as follows: If the request is normal, returns "success". If the request is abnormal, returns the specific error code.', + 'type' => 'string', + 'example' => 'You are not authorized to perform this action. CDR:View privileges are required.', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Obtain annotation job statistics information ', + 'summary' => 'null', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetAnnotationMissionSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + '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' => 'Instance ID '."\n" + ."\n" + .'> If this parameter is not specified, the default tags of the tenant are returned. ', + 'type' => 'string', + 'required' => false, + 'example' => '4eee9bf8-1319-468f-ac82-83c50ae389f8', + 'title' => '', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of records per page. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<GetAnnotationMissionTagInfoListResponse>', + 'description' => 'BaseResponse<GetAnnotationMissionTagInfoListResponse>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the API call succeeded. true: The call succeeded. false: The call failed. ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'CDR \'job-efbaeefc-4d45-4e79-83f7-b33b0769c969\' doesn\'t exists.', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Returned data', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionTagInfoList' => [ + 'description' => 'Tag list', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag list', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionTagInfoId' => [ + 'description' => 'Tag ID ', + 'type' => 'string', + 'example' => 'e1ee87ea-ebad-4079-aebb-1c56a4ef0c06', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID.', + 'type' => 'string', + 'example' => '3c3b8d1d-deff-48d9-9318-addc80ae5b1e', + 'title' => '', + ], + 'TenantId' => [ + 'description' => 'Tenant ID.', + 'type' => 'string', + 'example' => 'DING_ORG_dingbd9daecdb7aaed3bffe93478753d9884', + 'title' => '', + ], + 'AnnotationMissionTagInfoName' => [ + 'description' => 'Tag Name ', + 'type' => 'string', + 'example' => '用户投诉', + 'title' => '', + ], + 'AnnotationMissionTagInfoDescription' => [ + 'description' => 'Tag Description ', + 'type' => 'string', + 'example' => '用户投诉', + 'title' => '', + ], + 'Delete' => [ + 'description' => 'Indicates whether the tag is deleted.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the API call succeeded. true: The call succeeded. false: The call failed. ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'CDR \'job-efbaeefc-4d45-4e79-83f7-b33b0769c969\' doesn\'t exists.', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Obtain the annotation tag list ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetAnnotationMissionTagInfoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'summary' => '', + ], + 'GetAsrServerInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '94091', + 'abilityTreeNodes' => [ + 'FEATUREoutboundbotR6RNHS', + ], + ], + 'parameters' => [ + [ + 'name' => 'EntryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => false, + 'example' => '024f8cf0-c842-4c01-b74b-c8667e4579c7', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Policy level', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Deprecated] Obtain information such as the ASR model list and hotword list', + 'summary' => 'Obtain information such as the ASR model list and hotword list. This API is deprecated.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetAsrServerInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GetAssignJobsAsyncResult' => [ + 'summary' => 'Obtain the upload result of an asynchronous outbound call job.', + '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' => 'Asynchronous task ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dc79b0f9-a781-4305-85e2-d5d56679ae69', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Return information.', + 'type' => 'object', + 'properties' => [ + 'Timeout' => [ + 'description' => 'Indicates whether the asynchronous job has timed out.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Valid' => [ + 'description' => 'Indicates whether the result has been fully generated.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Task group ID.', + 'type' => 'string', + 'example' => 'd3550dd1-360d-4fe5-b4b2-667a4a664dab', + 'title' => '', + ], + 'JobsId' => [ + 'description' => 'List of job IDs.', + 'type' => 'array', + 'items' => [ + 'description' => 'Job ID.', + 'type' => 'string', + 'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Obtain the Result of Asynchronously Creating an Outbound Call Job', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetAssignJobsAsyncResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GetBaseStrategyPeriod' => [ + 'summary' => 'Obtain the global outbound calling time segments in the outbound calling system.', + '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' => 'Instance ID', + 'docRequired' => true, + 'example' => '024f8cf0-c842-4c01-b74b-c8667e4579c7', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Policy level. The default value is 2.'."\n" + .'- 0: System'."\n" + .'- 1: tenant'."\n" + .'- 2: instance', + 'example' => '2', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Is successful', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'OnlyWeekdays' => [ + 'description' => 'Is weekend only', + 'example' => 'false', + 'type' => 'boolean', + 'title' => '', + ], + 'OnlyWorkdays' => [ + 'description' => 'Is workday only', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'WorkingTime' => [ + 'description' => 'Policy execution time segment', + 'example' => '[]', + 'items' => [ + 'properties' => [ + 'EndTime' => [ + 'description' => 'End Time', + 'example' => '00:00:00', + 'type' => 'string', + 'title' => '', + ], + 'BeginTimeMillis' => [ + 'description' => 'Daily start time in milliseconds', + 'example' => '0', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'EndTimeMillis' => [ + 'description' => 'Daily end time in milliseconds', + 'example' => '0', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'BeginTime' => [ + 'description' => 'Start Time', + 'example' => '00:00:00', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Obtain global outbound calling time segments', + 'changeSet' => [ + [ + 'createdAt' => '2023-03-08T14:50:30.000Z', + 'description' => 'Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetBaseStrategyPeriod', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GetConcurrentConversationQuota' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RemainingConcurrent' => [ + 'description' => 'Remaining concurrency', + 'example' => '2', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'MaxConcurrent' => [ + 'description' => 'maxConcurrent', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Obtain the remaining concurrency under the caller\'s account', + 'summary' => 'Obtain the remaining concurrency under the caller\'s account.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetConcurrentConversationQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GetContactBlockList' => [ + 'summary' => 'Retrieve the outbound call blocklist.', + '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' => 'Page number (Required)', + 'example' => '1', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of entries (Required)', + 'example' => '10', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'CountTotalRow', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether to display the total number of entries', + 'example' => 'true', + 'required' => false, + 'type' => 'boolean', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'docRequired' => true, + 'example' => '846e20ae-e113-4231-a792-cb354187c9f6', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'ContactBlocklistList' => [ + 'description' => 'Contact list', + 'example' => '{}', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'Page number', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Number of entries per page', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'example' => '100', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'List' => [ + 'description' => 'Array data', + 'example' => '[]', + 'items' => [ + 'properties' => [ + 'ContactBlockListId' => [ + 'description' => 'Unique key of the outbound call blocklist', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'CreationTime' => [ + 'description' => 'Creation Time', + 'example' => '1640077685465', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'Remark' => [ + 'description' => 'Remark', + 'example' => 'xxxx', + 'type' => 'string', + 'title' => '', + ], + 'PhoneNumber' => [ + 'description' => 'Phone number', + 'example' => '1388888888', + 'type' => 'string', + 'title' => '', + ], + 'Operator' => [ + 'description' => 'Operator', + 'example' => 'xxx', + 'type' => 'string', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Name' => [ + 'description' => 'Name', + 'example' => 'xxx', + 'type' => 'string', + 'title' => '', + ], + 'Creator' => [ + 'description' => 'Creator', + 'example' => 'xxx', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + ], + ], + 'type' => 'object', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Retrieve the outbound call blocklist', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetContactBlockList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GetContactWhiteList' => [ + 'summary' => 'Obtain the global outbound call policy whitelist.', + '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' => 'Page number ', + 'example' => '1', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of entries per page ', + 'example' => '10', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'CountTotalRow', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether the total number of entries is required ', + 'example' => 'true', + 'required' => false, + 'type' => 'boolean', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID ', + 'docRequired' => true, + 'example' => '2a830781-324e-4568-ae96-309f93090fe1', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code ', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded ', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'ContactWhitelistList' => [ + 'description' => 'Contact list', + 'example' => '{}', + 'properties' => [ + 'PageSize' => [ + 'description' => 'Number per page', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'Page number', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'example' => '100', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'List' => [ + 'description' => 'Contact list', + 'example' => '{}', + 'items' => [ + 'properties' => [ + 'CreationTime' => [ + 'description' => 'Creation Time', + 'example' => '1640174411848', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'Remark' => [ + 'description' => 'Remark ', + 'example' => 'xxxx', + 'type' => 'string', + 'title' => '', + ], + 'PhoneNumber' => [ + 'description' => 'Phone number ', + 'example' => '13959999999', + 'type' => 'string', + 'title' => '', + ], + 'Operator' => [ + 'description' => 'Operator', + 'example' => 'xxx', + 'type' => 'string', + 'title' => '', + ], + 'ContactWhiteListId' => [ + 'description' => 'Whitelist ID ', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Name' => [ + 'description' => 'Name ', + 'example' => '张三', + 'type' => 'string', + 'title' => '', + ], + 'Creator' => [ + 'description' => 'Creator ', + 'example' => '测试123', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + ], + ], + 'type' => 'object', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Obtain the outbound call whitelist list ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetContactWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GetCurrentConcurrency' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'docRequired' => true, + 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'CurrentConcurrency' => [ + 'description' => 'Current concurrency', + 'example' => '12', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'MaxConcurrentConversation' => [ + 'description' => 'Maximum concurrency', + 'example' => '5', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Obtain the current concurrency of the instance', + 'summary' => 'Obtain the current concurrency of the instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetCurrentConcurrency', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GetEmptyNumberNoMoreCallsInfo' => [ + 'summary' => 'Queries the Toggle for the nonexistent number no-more-calls feature at the global dimension.', + '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' => 'Instance ID', + 'docRequired' => true, + 'example' => 'db3e679b-7d5e-4d9b-828a-345adca455f3', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Policy level. The default value is 2 for business instances.'."\n" + ."\n" + .'- 0: System '."\n" + .'- 1: Tenant '."\n" + .'- 2: Instance', + 'example' => '2', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'EmptyNumberNoMoreCalls' => [ + 'description' => 'Nonexistent number no-more-calls', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Deprecated] Query the Toggle for the nonexistent number no-more-calls feature at the global dimension', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetEmptyNumberNoMoreCallsInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GetJobDataUploadParams' => [ + 'summary' => 'Obtain job data upload parameters.', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '4eee9bf8-1319-468f-ac82-83c50ae389f8', + 'title' => '', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => 'File name', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SHUKE_ZA_ol_2_开场白.wav', + 'title' => '', + ], + ], + [ + 'name' => 'UniqueId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique business ID (prevents file name duplication; if left blank, the system automatically adds one)', + 'type' => 'string', + 'required' => false, + 'example' => 'sas_siema_1477832102462645_siem_f07e90c2c147cf8cf1549ccb974e1956', + 'title' => '', + ], + ], + [ + 'name' => 'Path', + 'in' => 'query', + 'schema' => [ + 'description' => 'Relative path of file storage', + 'type' => 'string', + 'required' => false, + 'example' => '//airwaybill/1237185904146124802', + 'title' => '', + ], + ], + [ + 'name' => 'BusiType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business type', + 'type' => 'string', + 'required' => false, + 'example' => 'SCRIPT_RECORDING', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'True', + 'title' => '', + ], + 'UploadParams' => [ + 'description' => 'List of upload parameters', + 'type' => 'object', + 'properties' => [ + 'Signature' => [ + 'description' => 'Signature information', + 'type' => 'string', + 'example' => 'MD4CHQCiECtjdsP+fstJDcqsPt+GbWxSWPzGQxeQiblzAh0AuidaKc5JY5AkHFIE+qiQI3izJQQbpUoG0paPTw==', + 'title' => '', + ], + 'Host' => [ + 'description' => 'Upload server URL', + 'type' => 'string', + 'example' => 'https://cloudagentbot-online.oss-cn-hangzhou.aliyuncs.com', + 'title' => '', + ], + 'Policy' => [ + 'description' => 'Upload policy', + 'type' => 'string', + 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0xM1QwODo0NToyNy4zMzFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiVVBMT0FERUQvU0NSSVBULzEzNmEwNTVlLTNkMDctNDZjNi04NTNhLTczMWIzYTI5NzNkZS8iXV19', + 'title' => '', + ], + 'Folder' => [ + 'description' => 'Upload folder'."\n" + ."\n" + .'> The value of this parameter will be used in the request parameters of many APIs.', + 'type' => 'string', + 'example' => 'UPLOADED/SCRIPT/136a055e-***-46c6-853a-731b3a2973de/18dc6d79-338f-413c-a5a8-dcce5f05b41a_9bd7916d-a340-4925-a911-92390cbe0f33.json', + 'title' => '', + ], + 'AccessId' => [ + 'description' => 'OSS Access ID', + 'type' => 'string', + 'example' => 'LTAI****************', + 'title' => '', + ], + 'Expire' => [ + 'description' => 'Expiration time (seconds)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1741855527', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Obtain job data upload parameters', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetJobDataUploadParams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GetMaxAttemptsPerDay' => [ + 'summary' => 'Query the daily call limit for the called number.', + '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' => 'Instance ID', + 'docRequired' => true, + 'example' => '2bfa5ae4-7185-4227-a3b8-328f26f11be1', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Policy level. The default value is 2 for business instances.'."\n" + ."\n" + .'- 0: System '."\n" + .'- 1: Tenant '."\n" + .'- 2: Instance', + 'example' => '2', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'MaxAttemptsPerDay' => [ + 'description' => 'Maximum number of retries after a failed call', + 'example' => '2', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query the daily call limit for the called number', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetMaxAttemptsPerDay', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GetNumberDistrictInfoTemplateDownloadUrl' => [ + 'summary' => 'Obtain the download link for the number library template. This API is deprecated.', + '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 status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'FileHttpUrl' => [ + 'description' => 'File URL', + 'type' => 'string', + 'example' => 'http://xxx.xx.com/xx', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Deprecated] Obtain the download link for the number location template', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetRealtimeConcurrencyReport' => [ + 'summary' => 'GetRealtimeConcurrencyReport', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '207103', + 'abilityTreeNodes' => [ + 'FEATUREoutboundbot3SV6AU', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => false, + 'example' => '85bf7efa-a07c-498a-850e-99a5849b8589', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID', + 'type' => 'string', + 'required' => false, + 'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of entries per page', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Reports' => [ + 'description' => 'Report details.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'Total count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Number of entries per page', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'List' => [ + 'description' => 'Collection of report data', + 'type' => 'array', + 'items' => [ + 'description' => 'Report information', + 'type' => 'object', + 'properties' => [ + 'ReportDate' => [ + 'description' => 'Report generation time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743474900488', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => '85bf7efa-a07c-498a-850e-99a5849b8589', + 'title' => '', + ], + 'InstanceName' => [ + 'description' => 'Instance name', + 'type' => 'string', + 'example' => '智能外呼场景', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9', + 'title' => '', + ], + 'JobGroupName' => [ + 'description' => 'Job Name.', + 'type' => 'string', + 'example' => '第一个作业组'."\n", + 'title' => '', + ], + 'OccupiedConcurrencyCount' => [ + 'description' => 'Occupied concurrent value', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + 'MaxConcurrencyLimit' => [ + 'description' => 'Configured maximum concurrency limit', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + 'title' => '', + ], + 'MinConcurrencyLimit' => [ + 'description' => 'Minimum Concurrency Limit of the job', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'ReportDate' => [ + 'description' => 'Report generation time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743474900488', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query the current concurrency list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetRealtimeConcurrencyReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GetSummaryInfo' => [ + 'summary' => 'Overview of outbound call instances.', + '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' => 'List of instance IDs', + 'example' => '[]', + 'items' => [ + 'required' => false, + 'type' => 'string', + 'description' => 'Instance ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n", + 'title' => '', + ], + 'maxItems' => 99, + 'required' => false, + 'type' => 'array', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'AgentBotInstanceSummaryList' => [ + 'description' => 'List of instances', + 'example' => '[]', + 'items' => [ + 'properties' => [ + 'TotalCallCount' => [ + 'description' => 'Total number of outbound calls', + 'example' => '12', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'TotalCallTime' => [ + 'description' => 'Total call duration', + 'example' => '10', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'UsedRecordingStorageSpace' => [ + 'description' => 'Used recording storage space (MB)', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Overview of Outbound Call Instances', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetSummaryInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GetTaskByUuid' => [ + 'summary' => 'Retrieve a job by 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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '024f8cf0-c842-4c01-b74b-c8667e4579c7', + 'title' => '', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '15160071061', + 'title' => '', + ], + ], + [ + 'name' => 'WithConversations', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to include conversation information.'."\n" + ."\n" + .'> If this parameter is not specified, the default value is false.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Task' => [ + 'description' => 'Job information', + 'type' => 'object', + 'properties' => [ + 'JobGroupId' => [ + 'description' => 'Job group ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'EndTime' => [ + 'description' => 'End time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640090211434', + 'title' => '', + ], + 'PlannedTime' => [ + 'description' => 'Planned running time of the job [Deprecated]', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640090211434', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID ', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'CallId' => [ + 'description' => 'Call ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'CallingNumber' => [ + 'description' => 'Calling number ', + 'type' => 'string', + 'example' => '057190294', + 'title' => '', + ], + 'ActualTime' => [ + 'description' => 'Actual running time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640090211434', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'CalledNumber' => [ + 'description' => 'Called number', + 'type' => 'string', + 'example' => '13777777777', + 'title' => '', + ], + 'Id' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'example' => '2', + 'title' => '', + ], + 'Conversations' => [ + 'description' => 'List of conversation information ', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Speaker' => [ + 'description' => 'Speaker of the dialogue: Robot or Contact. ', + 'type' => 'string', + 'example' => 'Robot', + 'title' => '', + ], + 'Script' => [ + 'description' => 'Dialogue text. ', + 'type' => 'string', + 'example' => '你好，我是**客服', + 'title' => '', + ], + 'Timestamp' => [ + 'description' => 'Summary creation time. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579068424883', + 'title' => '', + ], + 'Action' => [ + 'description' => 'Instruction '."\n" + .'- BeginDialogue: Begin dialogue '."\n" + .'- Dialogue: Dialogue '."\n" + .'- AbortDialogue: Abort dialogue '."\n" + .'- SilenceTimeout: Silence timeout '."\n" + .'- CollectedNumber: Collected number '."\n" + .'- EndDialogue: End dialogue '."\n" + .'- Broadcast: Broadcast '."\n" + .'- HangUp: Hang up '."\n" + .'- Authorize: Authorization '."\n" + .'- TransferToAgent: Transfer to agent '."\n" + .'- TransferToIVR: Transfer to IVR '."\n" + .'- RedirectToPage: Redirection to page '."\n" + .'- CollectNumber: Collect number '."\n" + .'- WaitOnAsyncTask: Wait on asynchronous task '."\n" + .'- Error: Fault ', + 'type' => 'string', + 'example' => 'Broadcast', + 'title' => '', + ], + 'SequenceId' => [ + 'description' => 'Session ID. ', + 'type' => 'string', + 'example' => 'fd279983-93b9-b13b-9a34-64e5df473225', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'EndReason' => [ + 'description' => 'End reason '."\n" + .'- FINISHED(1, "Normal completion"), '."\n" + .'- CHATBOT_HANGUP_AFTER_NOANSWER(2, "Bot hangs up after unrecognized input"), '."\n" + .'- CHATBOT_HANGUP_AFTER_SILENCE(3, "Bot hangs up due to silence timeout"), '."\n" + .'- CLIENT_HANGUP_AFTER_NOANSWER(4, "User hangs up after unrecognized input"), '."\n" + .'- CLIENT_HANGUP(5, "User hangs up without reason"), '."\n" + .'- TRANSFER_BY_INTENT(6, "Transferred to agent due to intent hit"), '."\n" + .'- TRANSFER_AFTER_NOANSWER(7, "Transferred to agent after unrecognized input"), '."\n" + .'- INO_INTERACTION(8, "No interaction from user side"), '."\n" + .'- ERROR(9, "System Exception break"), '."\n" + .'- SPECIAL_INTERCEPT_VOICE_ASSISTANT(10, "Special case Block – Voice assistant"), '."\n" + .'- SPECIAL_INTERCEPT_EXTENSION_NUMBER_TRANSFER(11, "Special case Block – Extension transfer") '."\n" + ."\n" + .'><notice>This parameter is of type string and returns enumeration values such as FINISHED.</notice>', + 'type' => 'string', + 'format' => 'int32', + 'example' => 'FINISHED', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'The returned message.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'True', + 'title' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Obtain a job by job ID', + 'changeSet' => [ + [ + 'createdAt' => '2025-11-18T12:11:46.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2025-01-22T05:51:38.000Z', + 'description' => 'Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetTaskByUuid', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'GetVersion' => [ + 'summary' => 'Obtain Application Version information.', + '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' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '1364f208-982d-4d0c-89aa-d56e22b47589', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Version' => [ + 'description' => 'Version', + 'example' => 'v2.4.1.xxxxxxx_release', + 'type' => 'string', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Obtain Application Version information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ImportScript' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'Instance ID', + 'example' => '00b37342-e759-4fe5-b296-aef775933af0', + 'title' => '', + ], + ], + [ + 'name' => 'SignatureUrl', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'URL of the scenario JSON file used for import.'."\n" + ."\n" + .'> The value of this parameter is the Folder parameter obtained from the GetJobDataUploadParams API.', + 'example' => 'UPLOADED/SCRIPT/136a055e-***-46c6-853a-731b3a2973de/18dc6d79-338f-413c-a5a8-dcce5f05b41a_9bd7916d-a340-4925-a911-92390cbe0f33.json'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'NluEngine', + 'in' => 'query', + 'schema' => [ + 'description' => 'NLU engine (applicable only to LLM scenarios).'."\n" + ."\n" + .'Enumeration:'."\n" + .'- Prompts: LLM scenario.'."\n" + .'- Empty for non-LLM scenarios.', + 'type' => 'string', + 'required' => false, + 'example' => 'Prompts', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => 'HTTP status code.', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'type' => 'string', + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'type' => 'boolean', + 'description' => 'Indicates whether the invocation succeeded.'."\n" + .'- **true**: The invocation succeeded.'."\n" + .'- **false**: Failed to invoke.'."\n", + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'type' => 'string', + 'description' => 'API status code', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'type' => 'string', + 'description' => 'API message', + 'example' => 'Success', + 'title' => '', + ], + 'ScriptId' => [ + 'type' => 'string', + 'description' => 'Outbound scenario ID', + 'example' => 'd7fbd0a0-27bc-49c4-a456-ecb75e79122b', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Import scenario', + 'summary' => 'Import a scenario.', + 'changeSet' => [ + [ + 'createdAt' => '2024-08-06T12:39:33.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:ImportScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2d350e38-f561-49b0-85d3-b90d9fc7e052', + 'title' => '', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '6bc0585c-0a8a-46d8-b042-23570bbb4855', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Alibaba Cloud account ID to which the instance belongs', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1864632921948620', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Job timeout', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:InflightTaskTimeout', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListAgentProfiles' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'instance id', + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'script id', + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => false, + 'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95'."\n", + ], + ], + [ + 'name' => 'AppIp', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'app_ip (system field, optional)', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<List<AgentProfile>>', + 'description' => 'BaseResponse<List<AgentProfile>>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Prompt message of the return result. ', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Returned data ', + 'type' => 'array', + 'items' => [ + 'description' => 'Returned data ', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '', + 'description' => 'Creation Time ', + 'type' => 'string', + 'example' => '1721701525327', + ], + 'UpdateTime' => [ + 'title' => '', + 'description' => 'Updated At', + 'type' => 'string', + 'example' => '1721701525327'."\n", + ], + 'AgentProfileId' => [ + 'title' => 'agent profile id', + 'description' => 'Agent configuration ID ', + 'type' => 'string', + 'example' => '37ca3ca1ac4b4e57adf3da5b5d939d04', + ], + 'InstanceId' => [ + 'title' => '', + 'description' => 'Instance ID ', + 'type' => 'string', + 'example' => 'e49ad122-15a1-443a-a102-84a78a93be79', + ], + 'ScriptId' => [ + 'title' => 'script id', + 'description' => 'Scenario ID ', + 'type' => 'string', + 'example' => '43972417-0657-452a-81c2-c59d8245a9b2', + ], + 'AgentType' => [ + 'title' => 'agent type', + 'description' => 'agent type', + 'type' => 'string', + 'example' => '“”', + ], + 'PromptJson' => [ + 'title' => 'prompt json', + 'description' => 'Agent configuration ', + 'type' => 'string', + 'example' => '{"name":"小x","gender":"男","age":18,"role":"游戏推广员","communicationStyle":["亲切"],"goals":"你好","background":"不是很好","openingPrompt":"你好，我是xxx"}'."\n", + ], + 'Prompt' => [ + 'title' => 'prompt', + 'description' => 'Prompt (Professional Mode)', + 'type' => 'string', + 'example' => '“”', + ], + 'AgentProfileTemplateId' => [ + 'title' => 'agent template id', + 'description' => 'Agent template ID ', + 'type' => 'string', + 'example' => 'default-survey'."\n", + ], + 'Model' => [ + 'title' => '', + 'description' => 'Model ID', + 'type' => 'string', + 'example' => 'model_002', + ], + 'ModelConfig' => [ + 'title' => 'model config', + 'description' => 'Model Configuration ', + 'type' => 'string', + 'example' => '{}', + ], + 'System' => [ + 'title' => '', + 'description' => 'Indicates whether it is a system template ', + 'type' => 'boolean', + 'example' => 'false', + ], + 'LabelsJson' => [ + 'title' => 'labels', + 'description' => 'Tag Description ', + 'type' => 'string', + 'example' => '[{\\"name\\":\\"是否送达\\",\\"description\\":\\"购买的家电是否已经送达\\",\\"valueList\\":\\"[\\\\\\"是\\\\\\",\\\\\\"否\\\\\\"]\\"},{\\"name\\":\\"预约上门时间\\",\\"description\\":\\"收集客户期望的上门安装时间\\",\\"valueList\\":\\"[]\\"}]'."\n", + ], + 'VariablesJson' => [ + 'title' => 'variables', + 'description' => 'Variable configuration ', + 'type' => 'string', + 'example' => '[{\\"name\\":\\"name\\",\\"description\\":\\"客户姓名\\"},{\\"name\\":\\"gender\\",\\"description\\":\\"客户性别\\"}]'."\n", + ], + 'Scenario' => [ + 'title' => '', + 'description' => 'Scenario ', + 'type' => 'string', + 'example' => '测试场景', + ], + 'Description' => [ + 'title' => '', + 'description' => 'Description ', + 'type' => 'string', + 'example' => '这是一个充满智慧的智能体。', + ], + 'InstructionJson' => [ + 'description' => 'Instruction configuration', + 'type' => 'string', + 'example' => '[{"type":"TransferToAgent","instructions":[{"code":"Transfer0","skillGroupId":"123","skillGroupName":"123"}],"timeoutEnable":false},{"type":"CollectNumber","instructions":[]}]'."\n", + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID ', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Obtain the agent configuration list (Deprecated)', + 'summary' => 'Obtain the historical publish list of agent configurations under this LLM scenario. ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListAgentProfiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListAllTenantBindNumberBinding' => [ + 'summary' => 'List of tenant-bound numbers.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<ListAllTenantBindNumberBindingResponse>', + 'description' => 'BaseResponse<ListAllTenantBindNumberBindingResponse>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded ', + 'type' => 'boolean', + 'example' => 'True', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Data', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => 'Array', + 'type' => 'array', + 'items' => [ + 'description' => 'Returned object', + 'type' => 'object', + 'properties' => [ + 'BindingId' => [ + 'description' => 'Binding ID', + 'type' => 'string', + 'example' => 'b5bfb844-ce85-4779-bc8f-161fba46aa07', + 'title' => '', + ], + 'Number' => [ + 'description' => 'Number', + 'type' => 'string', + 'example' => '15005059355', + 'title' => '', + ], + 'TrunkName' => [ + 'description' => 'Trunk Name ', + 'type' => 'string', + 'example' => '小码-公共', + 'title' => '', + ], + 'SerializedParams' => [ + 'description' => 'Policy', + 'type' => 'string', + 'example' => '{\\"rateLimitPeriod\\":\\"1\\",\\"rateLimitCount\\":\\"1\\"}', + 'title' => '', + ], + 'InstanceNameList' => [ + 'description' => 'List of instance names', + 'type' => 'array', + 'items' => [ + 'description' => 'List of instance names', + 'type' => 'string', + 'example' => 'discover', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'BillingType' => [ + 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'A4BEAB4B-C810-5386-B72A-1A35FF1E6B15', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'List of numbers attached to the tenant', + 'changeSet' => [ + [ + 'createdAt' => '2022-06-21T12:21:40.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2022-03-01T12:36:05.000Z', + 'description' => 'OpenAPI offline', + ], + ], + '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' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListAnnotationMission' => [ + 'summary' => 'Obtain the annotation job list.', + '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' => '', + 'description' => 'Annotation job ID ', + 'type' => 'string', + 'required' => false, + 'example' => '0943abcb-bd7d-4ace-8cf7-97d39d4dd0b9', + ], + ], + [ + 'name' => 'AnnotationMissionName', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Annotation job name ', + 'type' => 'string', + 'required' => false, + 'example' => '全景服务场景-标注任务-20230316-103253', + ], + ], + [ + 'name' => 'AnnotationStatusListFilter', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '', + 'description' => 'Annotation status filter condition [Historical parameter, deprecated] ', + 'type' => 'array', + 'items' => [ + 'description' => 'Filter condition [Deprecated] ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '[1]', + 'title' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'example' => '', + ], + ], + [ + 'name' => 'AnnotationStatusListStringFilter', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Filter condition for annotation status '."\n" + ."\n" + .'> Format: [1]. Multiple choice is supported. The meanings of specific array values are as follows: '."\n" + ."\n" + .'- 1: In progress '."\n" + .'- 2: Completed '."\n" + .'- 3: Shutdown '."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[1]', + ], + ], + [ + 'name' => 'CreateTimeStartFilter', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Annotation job creation filter start time ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1661961600000', + ], + ], + [ + 'name' => 'CreateTimeEndFilter', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'End time for filtering annotation jobs by creation time', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1673280000000', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of entries displayed per page ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID ', + 'type' => 'string', + 'required' => false, + 'example' => '191ef468-75a2-4004-9441-a5c31bf5cd9d', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<GetAnnotationMissionListResponse>', + 'description' => 'BaseResponse<GetAnnotationMissionListResponse>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the invocation succeeded. true: The invocation succeeded. false: Failed to Invocate. ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Additional information. The value is as follows: If the request is normal, returns "success". If the request is abnormal, returns the specific error code.', + 'type' => 'string', + 'example' => 'CDR \'job-c7b8a817-b8e8-40f3-b7ad-f28dcea218ff\' doesn\'t exists.', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Data', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionList' => [ + 'description' => 'Annotation job list', + 'type' => 'array', + 'items' => [ + 'description' => 'Annotation job', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionDataSourceType' => [ + 'description' => 'Annotation data source. 1: Outbound call, 2: Navigation', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'instance ID', + 'type' => 'string', + 'example' => '32be9d94-1346-4c4a-a4d0-ccd379f87013', + 'title' => '', + ], + 'AnnotationMissionId' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9', + 'title' => '', + ], + 'AnnotationMissionName' => [ + 'description' => 'Task Name ', + 'type' => 'string', + 'example' => '体验场景--移车-标注任务-20230220-141347', + 'title' => '', + ], + 'AnnotationStatus' => [ + 'description' => 'Annotation status '."\n" + .'- 1: In progress '."\n" + .'- 2: Completed '."\n" + .'- 3: Shutdown', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1676170339515', + 'title' => '', + ], + 'SessionTotalCount' => [ + 'description' => 'Total number of annotation jobs', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'SessionFinishCount' => [ + 'description' => 'Number of completed annotation sessions ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'FinishTime' => [ + 'description' => 'Completion time of the annotation job', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1683443903785', + 'title' => '', + ], + 'ExcludeOtherMissionSession' => [ + 'description' => 'Whether to exclude call records already annotated by other jobs', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'SessionEndReasonFilterList' => [ + 'description' => 'List of call termination types used when creating the job: '."\n" + .'- 1: Normal completion '."\n" + .'- 2: Bot hang-up after failed detection '."\n" + .'- 3: Hang-up due to silence timeout '."\n" + .'- 4: User hang-up after failed detection '."\n" + .'- 5: User hang-up without reason '."\n" + .'- 6: Hit intent and transferred to human agent '."\n" + .'- 7: Failed detection and transferred to human agent '."\n" + .'- 8: No interaction from user side '."\n" + .'- 9: System Exception break '."\n" + .'- 10: Hit intent and transferred to IVR '."\n" + .'- 11: Failed detection and transferred to IVR '."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Call termination type used when creating the job ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[1]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ConversationTimeStartFilter' => [ + 'description' => 'Start time of the conversation time filter condition for the annotation job', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1683216000000', + 'title' => '', + ], + 'ConversationTimeEndFilter' => [ + 'description' => 'End time of the conversation time filter condition for the annotation job', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1684511999000', + 'title' => '', + ], + 'SamplingType' => [ + 'description' => 'Sampling type', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'SamplingRate' => [ + 'description' => 'Sampling ratio', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'SamplingCount' => [ + 'description' => 'Maximum limit for sampling quantity', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'SamplingDescription' => [ + 'description' => 'Sampling description', + 'type' => 'string', + 'example' => '标注', + 'title' => '', + ], + 'AnnotationMissionDebugDataSourceList' => [ + 'description' => 'List of annotation debug data sources'."\n" + ."\n" + .'> Note: An additional category 0 will be included in the return value, for example: [0,1], [0,2], or [0,1,2].', + 'type' => 'array', + 'items' => [ + 'description' => 'Annotate debug data source'."\n" + ."\n" + .'- 1: Outbound call job '."\n" + .'- 2: Testing job', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '[1]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'PageIndex' => [ + 'description' => 'Page index', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Number of entries displayed per page', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + 'title' => '', + ], + 'TotalPageCount' => [ + 'description' => 'Total number of pages', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the invocation succeeded. true: The invocation succeeded. false: Failed to Invocate. ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Additional information. The value is as follows: If the request is normal, returns "success". If the request is abnormal, returns the specific error code.', + 'type' => 'string', + 'example' => 'CDR \'job-c7b8a817-b8e8-40f3-b7ad-f28dcea218ff\' doesn\'t exists.', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Retrieve Annotation Job List ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListAnnotationMission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Job ID ', + 'type' => 'string', + 'required' => true, + 'example' => '8434a4b0-41fc-41b1-aa75-bbd1f2ab0c8d', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'AnnotationMissionSessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Annotation Job chat instance ID'."\n" + ."\n" + .'> Obtain it by calling the SaveAnnotationMissionSessionList API.', + 'type' => 'string', + 'required' => false, + 'example' => '8434a4b0-41fc-41b1-aa75-bbd1f2ab0c8d'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page index', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + 'default' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of records displayed per page. ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => [ + 'description' => 'Environment'."\n" + ."\n" + .'> Default value is 2.'."\n" + ."\n" + .'**Enumeration values**'."\n" + .'- 0: NONE'."\n" + .'- 1: Private Cloud'."\n" + .'- 2: Public Cloud', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'IncludeStatusListJsonString', + 'in' => 'query', + 'schema' => [ + 'description' => 'List of included statuses '."\n" + ."\n" + .'> Format: [1]. Specify the exact enumeration values in the array.'."\n" + ."\n" + .'**Enumeration values** '."\n" + .'- 1: Detected correctly '."\n" + .'- 2: Detection fault '."\n" + .'- 8: Invalid data '."\n" + .'- 4: Intent not covered '."\n" + .'- 16: Misrecognized translation ', + 'type' => 'string', + 'required' => false, + 'example' => '[1]', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<GetAnnotationMissionSessionListResponse>', + 'description' => 'BaseResponse<GetAnnotationMissionSessionListResponse>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the invocation succeeded. true: The invocation succeeded. false: The invocation failed. ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Additional information. The value is interpreted as follows: If the request is normal, returns "success". If the request is abnormal, returns the specific error code.', + 'type' => 'string', + 'example' => 'bp.java.nopowerContact', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Data', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionId' => [ + 'description' => 'Job ID ', + 'type' => 'string', + 'example' => 'b3f2c931-5180-43ca-b4aa-2baee2d73c8b', + 'title' => '', + ], + 'AnnotationMissionSessionList' => [ + 'description' => 'Session list', + 'type' => 'array', + 'items' => [ + 'description' => 'Session', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionSessionId' => [ + 'description' => 'ID', + 'type' => 'string', + 'example' => '64ba5ac9-a4e1-4333-b03c-9d4a588c9f6c'."\n", + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1691117009000', + 'title' => '', + ], + 'ModifiedTime' => [ + 'description' => 'Updated At', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1677987898384', + 'title' => '', + ], + 'AnnotationMissionId' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'example' => '64ba5ac9-a4e1-4333-b03c-9d4a588c9f6c', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'example' => '408d6c4d-23e2-41f6-bbdd-f919a8297aa4', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Task group ID', + 'type' => 'string', + 'example' => '2f642da1-b00b-4dd6-ac7d-dcbeefd13ff3', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID ', + 'type' => 'string', + 'example' => '42da7cde-a5e8-45cc-b9d2-828711d95b30', + 'title' => '', + ], + 'SessionId' => [ + 'description' => 'For outbound calling systems, this is taskId; for navigation, it is conversationId. ', + 'type' => 'string', + 'example' => '40669e52-c1c8-487f-9593-29749086bdc9', + 'title' => '', + ], + 'AnnotationStatus' => [ + 'description' => 'Annotation status'."\n" + ."\n" + .'- 0: Undone (UNDO)'."\n" + .'- 1: In progress (DOING)'."\n" + .'- 2: Completed (DONE)'."\n" + .'- 3: Canceled (CLOSED)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'AnnotationMissionChatList' => [ + 'description' => 'Chat list', + 'type' => 'array', + 'items' => [ + 'description' => 'chat object', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionChatId' => [ + 'description' => 'chat id', + 'type' => 'string', + 'example' => '40669e52-c1c8-487f-9593-29749086bdc9'."\n", + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1682216045619', + 'title' => '', + ], + 'ModifiedTime' => [ + 'description' => 'Updated At ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1571649300000', + 'title' => '', + ], + 'AnnotationMissionId' => [ + 'description' => 'Job ID ', + 'type' => 'string', + 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f', + 'title' => '', + ], + 'AnnotationMissionSessionId' => [ + 'description' => 'Session ID ', + 'type' => 'string', + 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID ', + 'type' => 'string', + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573', + 'title' => '', + ], + 'SequenceId' => [ + 'description' => 'Sequence ID', + 'type' => 'string', + 'example' => '380578077', + 'title' => '', + ], + 'OccurTime' => [ + 'description' => 'Trigger Time ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1682390676403', + 'title' => '', + ], + 'Answer' => [ + 'description' => 'Bot response content ', + 'type' => 'string', + 'example' => '{\'Answer\': u\'\\u53c2\\u8003\\u6587\\u6863\\uff1ahttps://help.aliyun.com/document_detail/215402.html\', \'QuestionId\': 371159, \'Uuid\': \'ac14000116781568127896224d0044\'}', + 'title' => '', + ], + 'AnnotationStatus' => [ + 'description' => 'Chat annotation status '."\n" + .'- 0: Not started (UNDO) '."\n" + .'- 1: In progress (DOING) '."\n" + .'- 2: Completed (DONE) '."\n" + .'- 3: Canceled (CLOSED) ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'IntentAnnotationStatus' => [ + 'title' => '', + 'description' => 'Semantics annotation status '."\n" + .'- 0: Undone (UNDO) '."\n" + .'- 1: In progress (DOING) '."\n" + .'- 2: Completed (DONE) '."\n" + .'- 3: Canceled (CLOSED) ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AsrAnnotationStatus' => [ + 'title' => '', + 'description' => 'ASR annotation status '."\n" + .'- 0: Undone (UNDO) '."\n" + .'- 1: In progress (DOING) '."\n" + .'- 2: Done (DONE) '."\n" + .'- 3: Canceled (CLOSED)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TagAnnotationStatus' => [ + 'title' => '', + 'description' => 'Label annotation status '."\n" + .'- 0: Undone (UNDO) '."\n" + .'- 1: In progress (DOING) '."\n" + .'- 2: Completed (DONE) '."\n" + .'- 3: Canceled (CLOSED) ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SubStatus' => [ + 'title' => '', + 'description' => 'Annotation action: 1 correct, 20 match fault not optimized, 21 match fault optimized, 3 not overwritten, 4 invalid ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TranslationError' => [ + 'description' => 'Translation error identity '."\n" + .'- 0: No '."\n" + .'- 1: Yes ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'AnnotationAsrResult' => [ + 'description' => 'Manually annotated ASR text result, used for computing character accuracy rate ', + 'type' => 'string', + 'example' => '[]', + 'title' => '', + ], + 'OriginalAsrResult' => [ + 'description' => 'ASR Classification Result ', + 'type' => 'string', + 'example' => '[]', + 'title' => '', + ], + 'AnnotationMissionChatIntentUserSayInfoList' => [ + 'description' => 'List of chat intents ', + 'type' => 'array', + 'items' => [ + 'description' => 'Chat intent ', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionChatIntentUserSayInfoId' => [ + 'description' => 'id', + 'type' => 'string', + 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1682216045619', + 'title' => '', + ], + 'ModifiedTime' => [ + 'description' => 'Updated At', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1682216045619', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID ', + 'type' => 'string', + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", + 'title' => '', + ], + 'AnnotationMissionId' => [ + 'description' => 'Annotation Job ID', + 'type' => 'string', + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", + 'title' => '', + ], + 'AnnotationMissionSessionId' => [ + 'description' => 'Session ID', + 'type' => 'string', + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", + 'title' => '', + ], + 'AnnotationMissionChatId' => [ + 'description' => 'chat id', + 'type' => 'string', + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", + 'title' => '', + ], + 'Content' => [ + 'description' => 'Modified user utterance', + 'type' => 'string', + 'example' => '[]', + 'title' => '', + ], + 'IntentId' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11234112', + 'title' => '', + ], + 'DialogId' => [ + 'description' => 'Dialog ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '29921312', + 'title' => '', + ], + 'BotId' => [ + 'description' => 'Bot ID', + 'type' => 'string', + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", + 'title' => '', + ], + 'Delete' => [ + 'description' => 'Deleted ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Create' => [ + 'description' => 'Created', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AnnotationMissionChatVocabularyInfoList' => [ + 'description' => 'Table of hot word annotation information for the annotation mission chat', + 'type' => 'array', + 'items' => [ + 'description' => 'Hot word annotation information for the annotation job chat', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionChatVocabularyInfoId' => [ + 'description' => 'id', + 'type' => 'string', + 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1675218421941', + 'title' => '', + ], + 'ModifiedTime' => [ + 'description' => 'Updated At ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1676272557653', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'instance ID', + 'type' => 'string', + 'example' => '818961ce-d9ba-4f88-89ca-2a04b24bdf01', + 'title' => '', + ], + 'AnnotationMissionId' => [ + 'description' => 'Job ID ', + 'type' => 'string', + 'example' => 'b3f2c931-5180-43ca-b4aa-2baee2d73c8b', + 'title' => '', + ], + 'AnnotationMissionSessionId' => [ + 'description' => 'Session ID ', + 'type' => 'string', + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", + 'title' => '', + ], + 'AnnotationMissionChatId' => [ + 'description' => 'chat id', + 'type' => 'string', + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", + 'title' => '', + ], + 'VocabularyId' => [ + 'description' => 'Hot word ID ', + 'type' => 'string', + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", + 'title' => '', + ], + 'Vocabulary' => [ + 'description' => 'Hot word annotation content', + 'type' => 'string', + 'example' => '[]', + 'title' => '', + ], + 'VocabularyName' => [ + 'description' => 'Vocabulary name ', + 'type' => 'string', + 'example' => '名称', + 'title' => '', + ], + 'VocabularyDescription' => [ + 'description' => 'Description ', + 'type' => 'string', + 'example' => '描述', + 'title' => '', + ], + 'VocabularyWeight' => [ + 'description' => 'Hot word weight [-6, 5] ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'Delete' => [ + 'description' => 'Deleted', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Create' => [ + 'description' => 'Created ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AnnotationMissionChatCustomizationDataInfoList' => [ + 'description' => 'Table of language model annotation information for the annotation job chat ', + 'type' => 'array', + 'items' => [ + 'description' => 'Language model annotation information for the annotation job chat ', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionChatCustomizationDataInfoId' => [ + 'description' => 'id', + 'type' => 'string', + 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1682216045619', + 'title' => '', + ], + 'ModifiedTime' => [ + 'description' => 'Updated At ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1679552585384', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID ', + 'type' => 'string', + 'example' => 'd3fbfca8-4208-4d4b-a53a-c4dba5e43a66', + 'title' => '', + ], + 'AnnotationMissionId' => [ + 'description' => 'Job ID ', + 'type' => 'string', + 'example' => '2f03b24a-fda2-4501-90ba-0a9a59f8dd9d', + 'title' => '', + ], + 'AnnotationMissionSessionId' => [ + 'description' => 'Session ID ', + 'type' => 'string', + 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", + 'title' => '', + ], + 'AnnotationMissionChatId' => [ + 'description' => 'chat id', + 'type' => 'string', + 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", + 'title' => '', + ], + 'CustomizationDataId' => [ + 'description' => 'id', + 'type' => 'string', + 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", + 'title' => '', + ], + 'Content' => [ + 'description' => 'Voice annotation text ', + 'type' => 'string', + 'example' => '抱歉哈，可能给您造成困扰了，这边先不打扰您，祝您生活愉快，再见', + 'title' => '', + ], + 'CustomizationDataName' => [ + 'description' => 'Name ', + 'type' => 'string', + 'example' => '默认数据', + 'title' => '', + ], + 'CustomizationDataDescription' => [ + 'description' => 'Description ', + 'type' => 'string', + 'example' => '默认数据', + 'title' => '', + ], + 'CustomizationDataWeight' => [ + 'description' => 'Language model data weight ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Delete' => [ + 'description' => 'Indicates whether it has been deleted. ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Create' => [ + 'description' => 'Is creation ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AnnotationMissionChatTagInfoList' => [ + 'description' => 'List of tag mapping relationships attached to the annotated chat', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag mapping relationship attached to the annotated chat', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionChatTagInfoId' => [ + 'description' => 'id', + 'type' => 'string', + 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1686797050000', + 'title' => '', + ], + 'ModifiedTime' => [ + 'description' => 'Updated At', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1679019660000', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => '32be9d94-1346-4c4a-a4d0-ccd379f87013', + 'title' => '', + ], + 'AnnotationMissionId' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'example' => 'e7272cbb-a60d-4b41-b5c4-8863edc0b8f7', + 'title' => '', + ], + 'AnnotationMissionSessionId' => [ + 'description' => 'Session ID ', + 'type' => 'string', + 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", + 'title' => '', + ], + 'AnnotationMissionChatId' => [ + 'description' => 'chat id', + 'type' => 'string', + 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", + 'title' => '', + ], + 'AnnotationMissionTagInfoId' => [ + 'description' => 'tag id', + 'type' => 'string', + 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", + 'title' => '', + ], + 'AnnotationMissionTagInfoName' => [ + 'description' => 'Tag name ', + 'type' => 'string', + 'example' => '标签', + 'title' => '', + ], + 'Delete' => [ + 'description' => 'Delete', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Create' => [ + 'description' => 'Creation', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Version' => [ + 'description' => 'Version number', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'DebugConversation' => [ + 'description' => 'Debug conversation ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the invocation succeeded. true: The invocation succeeded. false: The invocation failed. ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Additional information. The value is interpreted as follows: If the request is normal, returns "success". If the request is abnormal, returns the specific error code.', + 'type' => 'string', + 'example' => 'bp.java.nopowerContact', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Obtain the list of chat instances for an annotation job ', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListAnnotationMissionSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => '024f8cf0-c842-4c01-b74b-c8667e4579c7', + 'title' => '', + ], + ], + [ + 'name' => 'UuidsJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'List of UUIDs of API plugins', + 'type' => 'string', + 'required' => false, + 'example' => '["d17d5bfa-4972-4389-9718-f9602edabe48"]', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of entries to display per page', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ApiPlugins' => [ + 'description' => 'API plugin list', + 'type' => 'array', + 'items' => [ + 'description' => 'API plugin configuration', + 'type' => 'object', + 'properties' => [ + 'DraftedConfigJson' => [ + 'description' => 'Draft configuration', + '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" + .'}', + 'title' => '', + ], + 'Status' => [ + 'description' => 'Status.'."\n" + ."\n" + .'- Drafted: Draft'."\n" + .'- Published: Published'."\n" + .'- PublishedAndEdited: Published (Edited)', + 'type' => 'string', + 'enumValueTitles' => [ + 'Drafted' => 'Drafted', + 'Published' => 'Published', + 'PublishedAndEdited' => 'PublishedAndEdited', + ], + 'example' => 'Drafted', + 'title' => '', + ], + 'Type' => [ + 'description' => 'Type', + 'type' => 'string', + 'enumValueTitles' => [ + 'Function' => 'Function', + ], + 'example' => 'Function', + 'title' => '', + ], + 'PublishedConfigJson' => [ + 'description' => 'Published configuration', + '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" + .'}', + 'title' => '', + ], + 'Uuid' => [ + 'description' => 'Unique identifier of the plugin', + 'type' => 'string', + 'example' => 'e1a3c448-20cf-4586-8aa2-4cdca75f7c20', + 'title' => '', + ], + 'Description' => [ + 'description' => 'Description.', + 'type' => 'string', + 'example' => '这个插件是用来xxx.....', + 'title' => '', + ], + 'GmtCreate' => [ + 'description' => 'Creation Time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1666230851000', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => '7c0e5b5e-a839-4999-8301-2c7d07a1f16f', + 'title' => '', + ], + 'GmtModified' => [ + 'description' => 'Update Time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1641891940000', + 'title' => '', + ], + 'Name' => [ + 'description' => 'Plugin name', + 'type' => 'string', + 'example' => '这是一个插件', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'PageSize' => [ + 'description' => 'Number of entries per page', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total number of entries', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query the API plugin list', + 'summary' => 'Query the API plugin list.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListApiPlugins', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListBeebotIntent' => [ + 'summary' => 'ListBeebotIntent', + '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' => 'Instance ID ', + 'type' => 'string', + 'required' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID ', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'IntentName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent Name '."\n" + ."\n" + .'> This is the intent code, a unique identifier. ', + 'type' => 'string', + 'required' => false, + 'example' => '知道了', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of entries per page ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'BeebotRequestId' => [ + 'description' => 'Internal request ID', + 'type' => 'string', + 'example' => '497CFAFF-48CC-161A-AD2C-252DED569037', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response Code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Number of entries per page', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'Intents' => [ + 'description' => 'Intent list', + 'type' => 'array', + 'items' => [ + 'description' => 'Intent information', + 'type' => 'object', + 'properties' => [ + 'IntentId' => [ + 'description' => 'Intent ID ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10717802'."\n", + 'title' => '', + ], + 'IntentName' => [ + 'description' => 'Intent Name'."\n" + ."\n" + .'> This is the intent code, a unique identifier.', + 'type' => 'string', + 'example' => '知道了', + 'title' => '', + ], + 'AliasName' => [ + 'description' => 'Intent alias', + 'type' => 'string', + 'example' => '嗯明白了', + 'title' => '', + ], + 'ModifyUserId' => [ + 'description' => 'User ID of the modifier', + 'type' => 'string', + 'example' => '1252504', + 'title' => '', + ], + 'ModifyUserName' => [ + 'description' => 'Modify Account Name ', + 'type' => 'string', + 'example' => '[email protected]'."\n", + 'title' => '', + ], + 'CreateUserName' => [ + 'description' => 'Create Account Name ', + 'type' => 'string', + 'example' => '[email protected]'."\n", + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time', + 'type' => 'string', + 'example' => '2025-04-21 16:03:15.+0800', + 'title' => '', + ], + 'CreateUserId' => [ + 'description' => 'Create User ID ', + 'type' => 'string', + 'example' => '1252504', + 'title' => '', + ], + 'ModifyTime' => [ + 'description' => 'Updated At', + 'type' => 'string', + 'example' => '2025-04-21 16:03:15.+0800', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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\\": \\"[email protected]\\\\n\\",\\n \\"CreateUserName\\": \\"[email protected]\\\\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' => 'List XiaoMi Bot Intents (Small Model API) ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListBeebotIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListBeebotIntentLgf' => [ + 'summary' => 'ListBeebotIntentLgf', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent ID', + 'type' => 'string', + 'required' => true, + 'example' => '10717802', + 'title' => '', + ], + ], + [ + 'name' => 'LgfText', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent utterance template', + 'type' => 'string', + 'required' => false, + 'example' => '我是一个问法模版'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of items', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'BeebotRequestId' => [ + 'description' => 'Internal request ID', + 'type' => 'string', + 'example' => '497CFAFF-48CC-161A-AD2C-252DED569037', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'Lgfs' => [ + 'description' => 'List of LGF descriptions', + 'type' => 'array', + 'items' => [ + 'description' => 'LGF list item', + 'type' => 'object', + 'properties' => [ + 'LgfId' => [ + 'description' => 'Utterance template ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5666117', + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time', + 'type' => 'string', + 'example' => '2025-04-21 10:54:18.+0800', + 'title' => '', + ], + 'ModifyTime' => [ + 'description' => 'Updated At', + 'type' => 'string', + 'example' => '2025-04-21 10:54:18.+0800', + 'title' => '', + ], + 'RuleText' => [ + 'description' => 'Content of the utterance template', + 'type' => 'string', + 'example' => '我是一个问法模版'."\n", + 'title' => '', + ], + 'IntentId' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10717802', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '【Small Model API】List XiaoMi Bot Intent Utterance Templates', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListBeebotIntentLgf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListBeebotIntentUserSay' => [ + 'summary' => 'ListBeebotIntentUserSay', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent ID', + 'type' => 'string', + 'required' => true, + 'example' => '10717802', + 'title' => '', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => 'Keyword in the utterance content', + 'type' => 'string', + 'required' => false, + 'example' => '知道', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of items displayed per page.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '0956D5DA-0978-5DC9-94B0-C68527DA7475', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'BeebotRequestId' => [ + 'description' => 'Internal request ID', + 'type' => 'string', + 'example' => 'D7BBFCDF-59B0-1ADA-BCA3-4B77F642DDFB', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Number of items per page', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'UserSays' => [ + 'description' => 'List of user utterances', + 'type' => 'array', + 'items' => [ + 'description' => 'User utterance', + 'type' => 'object', + 'properties' => [ + 'UserSayId' => [ + 'description' => 'Utterance ID', + 'type' => 'string', + 'example' => '17448458', + 'title' => '', + ], + 'Content' => [ + 'description' => 'Content', + 'type' => 'string', + 'example' => '你知道xxxx么？', + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time', + 'type' => 'string', + 'example' => '2025-04-21 14:16:05.+0800', + 'title' => '', + ], + 'ModifyTime' => [ + 'description' => 'Updated At', + 'type' => 'string', + 'example' => '2025-04-21 14:16:05.+0800', + 'title' => '', + ], + 'IntentId' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10717802', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Small Model API] List User Utterances for XiaoMi Bot', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListBeebotIntentUserSay', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Page number ', + 'docRequired' => true, + 'example' => '1', + 'format' => 'int32', + 'maximum' => '10000', + 'minimum' => '1', + 'required' => true, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of items '."\n" + ."\n" + .'> The value of this parameter must be less than or equal to 50. ', + 'docRequired' => true, + 'example' => '10', + 'format' => 'int32', + 'maximum' => '1000', + 'minimum' => '1', + 'required' => true, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'Access key for the agent workspace '."\n" + ."\n" + .'> This parameter is obtained from ListChatbotAgents. If left empty, agents from all workspaces are queried. ', + 'type' => 'string', + 'required' => false, + 'example' => '9137ab9c27044921860030adf8590ec4_p_outbound_public', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code ', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code ', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message ', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID ', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded ', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Bots' => [ + 'description' => 'List of bot information ', + 'items' => [ + 'description' => 'List of bot information ', + 'properties' => [ + 'Introduction' => [ + 'description' => 'Bot remark ', + 'example' => '这是直播的描述', + 'type' => 'string', + 'title' => '', + ], + 'Avatar' => [ + 'description' => 'URL of the profile picture ', + 'example' => 'https://ccrm.wengine.cn/ccrm/system/common/fileDownload/noToken?fileId=975cdeaa064846e3b6004abd9ba1d7c8', + 'type' => 'string', + 'title' => '', + ], + 'TimeZone' => [ + 'description' => 'Time zone of the bot, refer to "Common - Time Zone Codes" ', + 'example' => 'Asia/Shanghai', + 'type' => 'string', + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time ', + 'example' => '2022-01-18T02:36:00Z', + 'type' => 'string', + 'title' => '', + ], + 'LanguageCode' => [ + 'description' => 'Language of the bot service, such as zh-cn or en-us ', + 'example' => 'zh-cn', + 'type' => 'string', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'instance ID ', + 'example' => 'e874fcf0-d2f4-4e62-9377-b6f35fe55210', + 'type' => 'string', + 'title' => '', + ], + 'Name' => [ + 'description' => 'Bot name ', + 'example' => '智能回访2', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'PageSize' => [ + 'description' => 'Count ', + 'example' => '10', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'Page number ', + 'example' => '5', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count ', + 'example' => '100', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query the list of Chatbot agents in the Alibaba Cloud public cloud version ', + 'summary' => 'Query the list of public cloud instances of Cloud XiaoMi bots. ', + 'changeSet' => [ + [ + 'createdAt' => '2024-04-25T12:17:46.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListChatbotInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListDialogueFlows' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'instance ID', + 'docRequired' => true, + 'example' => 'b5b0a30f-69e7-4147-98b5-553fc526361d', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'scenario ID', + 'docRequired' => true, + 'example' => 'd7c28efb-47f7-4a85-a522-5038e30a0b98', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP return code.', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API prompt message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the invocation succeeded.'."\n" + .'- **true**: The invocation succeeded.'."\n" + .'- **false**: Failed to invoke.', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'DialogueFlows' => [ + 'description' => 'List of conversation flow data', + 'items' => [ + 'properties' => [ + 'DialogueFlowDefinition' => [ + 'description' => 'Conversation flow data', + '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"]}]}', + 'type' => 'string', + 'title' => '', + ], + 'DialogueFlowType' => [ + 'description' => 'Flow type.'."\n" + .'- SubFlow: child flow type'."\n" + .'- MainFlow: main flow type', + 'example' => 'MainFlow', + 'type' => 'string', + 'title' => '', + ], + 'DialogueFlowId' => [ + 'description' => 'Conversation flow ID', + 'example' => 'dae01529-3c3e-458e-b07a-97643d09ebb9', + 'type' => 'string', + 'title' => '', + ], + 'DialogueFlowName' => [ + 'description' => 'Conversation flow name', + 'example' => '主流程', + 'type' => 'string', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Outbound scenario ID', + 'example' => '2d5aa451-661f-4f08-b0c4-28eec78decc4', + 'type' => 'string', + 'title' => '', + ], + 'ScriptVersion' => [ + 'description' => 'Scenario version number', + 'example' => '1569220563549', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => 'List of conversation flow data', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Legacy canvas API] Query the conversation flow list under a scenario', + 'summary' => 'Queries the list of conversation flows under a script in the legacy canvas scenario.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListDialogueFlows', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListDownloadTasks' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'enumValueTitles' => [ + 1 => '1', + ], + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of entries ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '50', + 'minimum' => '1', + 'enumValueTitles' => [ + 5 => '5', + ], + 'example' => '10', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => 'Instance ID. ', + 'type' => 'string', + 'required' => false, + 'example' => 'ae4572af-376f-439f-8970-38764acbaa91', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '904CFA7B-8AD9-50FF-9B3E-404B20B9EE31', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded. ', + 'type' => 'boolean', + 'example' => 'True', + 'title' => '', + ], + 'DownloadTasks' => [ + 'description' => 'List of download jobs', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Page size', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + 'title' => '', + ], + 'List' => [ + 'description' => 'Array of download jobs', + 'type' => 'array', + 'items' => [ + 'description' => 'Array of download jobs', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Export status. '."\n" + .'- Pending: Pending '."\n" + .'- InProgress: In progress '."\n" + .'- Finished: Finished '."\n" + .'- Failed: Failed '."\n" + .'- Expired: Expired '."\n" + .'- Cancelled: Cancelled', + 'type' => 'string', + 'example' => 'Empty', + 'title' => '', + ], + 'Title' => [ + 'description' => 'Title', + 'type' => 'string', + 'example' => 'GUI-TEST-新建风险', + 'title' => '', + ], + 'ExpireTime' => [ + 'description' => 'Expiration time ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646792941', + 'title' => '', + ], + 'TaskId' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'example' => '6b0e547e-501c-480a-812f-d27e28e74f9a', + 'title' => '', + ], + 'DownloadTaskFiles' => [ + 'description' => 'List of download task files ', + 'type' => 'array', + 'items' => [ + 'description' => 'List of download task files ', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'File status '."\n" + .'- Pending: Pending '."\n" + .'- InProgress: In progress '."\n" + .'- Finished: Finished '."\n" + .'- Failed: Failed '."\n" + .'- Expired: Expired '."\n" + .'- Cancelled: Cancelled ', + 'type' => 'string', + 'example' => 'Empty', + 'title' => '', + ], + 'Title' => [ + 'description' => 'Title ', + 'type' => 'string', + 'example' => 'GUI-TEST-新建风险', + 'title' => '', + ], + 'Progress' => [ + 'description' => 'Completion progress [Deprecated] ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'FileId' => [ + 'description' => 'File ID ', + 'type' => 'string', + 'example' => '01f8d11abdb9406996c0c46e7*******', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Job Download List ', + 'summary' => 'View the Download Hub list.', + 'changeSet' => [ + [ + 'createdAt' => '2023-06-20T13:56:47.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2021-11-24T13:00:44.000Z', + 'description' => 'OpenAPI offline', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListDownloadTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListFlashSmsTemplates' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID.', + 'type' => 'string', + 'required' => true, + 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', + 'title' => '', + ], + ], + [ + 'name' => 'ProviderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flash SMS provider ID.'."\n" + ."\n" + .'- Uincall: Beijing Uincall Communication Co., Ltd.'."\n" + .'- ShangHaiTianNan: Shanghai TianNan'."\n" + .'- HeDao: Galaxis', + 'type' => 'string', + 'required' => true, + 'example' => 'Uincall', + 'title' => '', + ], + ], + [ + 'name' => 'ConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flash SMS configuration ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'fe542524-9585-4cc7-be54-c8782ed7f60e', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '无', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => 'EC08CC41-6870-5594-939A-F758F057898F', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the invocation succeeded. true: The invocation succeeded. false: Failed to invoke.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'Flash SMS template.', + 'type' => 'object', + 'properties' => [ + 'TemplateName' => [ + 'description' => 'Template Name.', + 'type' => 'string', + 'example' => '模板1', + 'title' => '', + ], + 'TemplateId' => [ + 'description' => 'Flash SMS Template ID.', + 'type' => 'string', + 'example' => '17*******************01', + 'title' => '', + ], + 'TemplateContent' => [ + 'description' => 'Template Content.', + 'type' => 'string', + 'example' => '您好，xxx来电。', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Retrieve Flash SMS Templates', + 'summary' => 'Use ListFlashSmsTemplates to retrieve flash SMS templates.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListFlashSmsTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListGlobalQuestions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'docRequired' => true, + 'example' => 'dd8c2b62-4660-457f-9597-6723b5722aff', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'docRequired' => true, + 'example' => 'f63b0dfc-848a-42f3-9329-8854e232e977', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number for paging', + 'docRequired' => true, + 'example' => '1', + 'format' => 'int32', + 'required' => true, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of entries to display per page.', + 'docRequired' => true, + 'example' => '10', + 'format' => 'int32', + 'required' => true, + 'type' => 'integer', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code.', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'GlobalQuestions' => [ + 'description' => 'Global question data', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'Page number', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Page size', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'List' => [ + 'description' => 'Array of global questions', + 'items' => [ + 'properties' => [ + 'GlobalQuestionId' => [ + 'description' => 'Global question ID', + 'example' => '53c27755-d41e-46a6-bb3c-4f66f257d50c', + 'type' => 'string', + 'title' => '', + ], + 'Answers' => [ + 'description' => 'Response to the global question', + 'example' => '["你好,您可以再说一遍吗","不好意思我刚才没有听清"]', + 'type' => 'string', + 'title' => '', + ], + 'GlobalQuestionType' => [ + 'description' => 'Global question type'."\n" + ."\n" + .'- SYSTEM: System '."\n" + .'- COMMON: Common', + 'example' => 'SYSTEM', + 'type' => 'string', + 'title' => '', + ], + 'GlobalQuestionName' => [ + 'description' => 'Global question name', + 'example' => '未识别', + 'type' => 'string', + 'title' => '', + ], + 'Questions' => [ + 'description' => 'List of global questions', + 'example' => '["测试问题1","测试问题2"]', + 'type' => 'string', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID', + 'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Legacy Canvas API] Query the List of Global Questions', + 'summary' => 'Query the list of key questions. This is an old canvas API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:ListGlobalQuestions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'The resource group ID. '."\n" + .'> You can obtain this from the Resource Management document via the source API. For more information, see: https://api.aliyun.com/document/ResourceManager/2020-03-31/ListResourceGroups', + 'example' => 'rg-acfm3iugit3uw7a', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of tags of business instances. '."\n" + .'>You can obtain it by calling the ListResourceTags API.', + 'items' => [ + 'properties' => [ + 'Key' => [ + 'description' => 'Tag key of the instance.', + 'example' => 'name', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Tag value of the instance.', + 'example' => 'xxx', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + 'required' => false, + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'maxItems' => 20, + 'required' => false, + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'Name of the Intelligent outbound call instance', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page size', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'The response code.', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'The API message.', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Instances' => [ + 'description' => 'List of business instances. ', + 'items' => [ + 'properties' => [ + 'CreationTime' => [ + 'description' => 'Creation Time.', + 'example' => ' 1578469042851', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Business instance ID. ', + 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', + 'type' => 'string', + 'title' => '', + ], + 'OwnerName' => [ + 'description' => 'Account name. ', + 'example' => 'xxx', + 'type' => 'string', + 'title' => '', + ], + 'CreatorId' => [ + 'description' => 'The creator ID.', + 'example' => '34234', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'InstanceDescription' => [ + 'description' => 'The description of the Intelligent Outbound Call business instance.', + 'example' => '这是一个实例', + 'type' => 'string', + 'title' => '', + ], + 'InstanceName' => [ + 'description' => 'Name of the Intelligent Outbound Calling business instance. ', + 'example' => '回访', + 'type' => 'string', + 'title' => '', + ], + 'ResourceGroupId' => [ + 'description' => 'Resource group ID. ', + 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', + 'type' => 'string', + 'title' => '', + ], + 'CreatorName' => [ + 'description' => 'The creator name.', + 'example' => 'xxx', + 'type' => 'string', + 'title' => '', + ], + 'MaxConcurrentConversation' => [ + 'description' => 'Maximum allowed outbound call concurrency. ', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'ResourceTags' => [ + 'description' => 'Tag information. ', + 'example' => '[]', + 'items' => [ + 'properties' => [ + 'Key' => [ + 'description' => 'Tag key. ', + 'example' => 'age', + 'type' => 'string', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Tag value. ', + 'example' => '20', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + ], + 'IsPreset' => [ + 'type' => 'boolean', + 'description' => 'Indicates whether the instance is a system preset instance.', + 'example' => 'false', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'TotalCount' => [ + 'description' => 'The total number of instances.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'The page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'The page size for paging.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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 \\"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}","type":"json"}]', + 'title' => 'Query the list of business instances.', + 'summary' => 'Query the list of Intelligent Outbound Calling business instances. ', + 'changeSet' => [ + [ + 'createdAt' => '2024-04-22T12:31:34.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2022-09-27T13:02:34.000Z', + 'description' => 'Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListIntentions' => [ + 'summary' => 'Query intents in the annotation center.', + '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' => 'Bot ID'."\n" + ."\n" + .'> You can obtain this parameter from the DescribeScript API. The corresponding parameter is ChatbotId.', + 'type' => 'string', + 'required' => false, + 'example' => 'chatbot-cn-n7QmzrUnNe', + 'title' => '', + ], + ], + [ + 'name' => 'UserNick', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent name'."\n" + ."\n" + .'> You can use a keyword to perform a fuzzy query as a filter condition.', + 'type' => 'string', + 'required' => false, + 'example' => '知道', + 'title' => '', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => 'page number', + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => 'page size', + 'description' => 'Number of entries', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10717802', + 'title' => '', + ], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => [ + 'description' => 'Environment'."\n" + ."\n" + .'- 1: Private Cloud'."\n" + .'- 2: Public Cloud', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + 'title' => '', + ], + ], + [ + 'name' => 'AnnotationMissionDataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Source of annotation data.'."\n" + ."\n" + .'- 1: Outbound call'."\n" + .'- 2: Navigation', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", + 'docRequired' => true, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<QueryIntentsResponse>', + 'description' => 'BaseResponse<QueryIntentsResponse>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Returned data', + 'type' => 'object', + 'properties' => [ + 'IntentList' => [ + 'description' => 'Intent list', + 'type' => 'array', + 'items' => [ + 'description' => 'Intent data', + 'type' => 'object', + 'properties' => [ + 'BotId' => [ + 'description' => 'Bot ID [Deprecated]', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'chatbot-cn-n7QmzrUnNe'."\n", + 'title' => '', + ], + 'DialogId' => [ + 'description' => 'Conversation flow ID', + 'type' => 'string', + 'example' => '50099', + 'title' => '', + ], + 'Name' => [ + 'description' => 'Intent name', + 'type' => 'string', + 'example' => '知道了', + 'title' => '', + ], + 'Alias' => [ + 'description' => 'Intent alias', + 'type' => 'array', + 'items' => [ + 'description' => 'Intent alias', + 'type' => 'string', + 'example' => '嗯明白了', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Id' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10717802', + 'title' => '', + ], + 'BotName' => [ + 'description' => 'bot Name', + 'type' => 'string', + 'example' => '111', + 'title' => '', + ], + 'Language' => [ + 'description' => 'Language'."\n" + ."\n" + .'- English en-us'."\n" + .'- Chinese zh-cn', + 'type' => 'string', + 'example' => 'zh-cn'."\n", + 'title' => '', + ], + 'Type' => [ + 'description' => 'Intent type: '."\n" + .'- 0: Normal intent; '."\n" + .'- 1: UNKNOWN; '."\n" + .'- 2: TableQA intent; '."\n" + .'- 3: Generated from standard intent', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'TableId' => [ + 'description' => 'Table ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '43258', + 'title' => '', + ], + 'UserSay' => [ + 'description' => 'User utterance list', + 'type' => 'array', + 'items' => [ + 'description' => 'User utterance data', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Utterance ID', + 'type' => 'string', + 'example' => '17448458', + 'title' => '', + ], + 'FromId' => [ + 'description' => 'Source ID'."\n" + .'><notice>Invalid content></notice>', + 'type' => 'string', + 'example' => '1234567', + 'title' => '', + ], + 'Strict' => [ + 'description' => 'Whether to use strict matching', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'UserSayData' => [ + 'description' => 'Utterance list', + 'type' => 'array', + 'items' => [ + 'description' => 'Utterance data', + 'type' => 'object', + 'properties' => [ + 'SlotId' => [ + 'description' => 'Slot identity', + 'type' => 'string', + 'example' => '9ec31b50-32b8-11eb-9478-19d2d885afdb'."\n", + 'title' => '', + ], + 'Text' => [ + 'description' => 'Expression', + 'type' => 'string', + 'example' => '知道', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RuleCheck' => [ + 'description' => 'LGF intent expression', + 'type' => 'array', + 'items' => [ + 'description' => 'lgf intent expression ', + 'type' => 'object', + 'properties' => [ + 'Strict' => [ + 'description' => 'is strict match ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Text' => [ + 'description' => 'expression value ', + 'type' => 'string', + 'example' => '知道', + 'title' => '', + ], + 'Warning' => [ + 'description' => 'warning message ', + 'type' => 'array', + 'items' => [ + 'description' => 'warning message ', + 'type' => 'string', + 'example' => '“”', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Error' => [ + 'description' => 'error message ', + 'type' => 'array', + 'items' => [ + 'description' => 'error message ', + 'type' => 'string', + 'example' => '“”', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Slot' => [ + 'description' => 'Intent slot information', + 'type' => 'array', + 'items' => [ + 'description' => 'Intent slot information', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Unique slot identity', + 'type' => 'string', + 'example' => '9ec31b50-32b8-11eb-9478-19d2d885afdb'."\n", + 'title' => '', + ], + 'Name' => [ + 'description' => 'Slot Name', + 'type' => 'string', + 'example' => '知道', + 'title' => '', + ], + 'IsArray' => [ + 'description' => 'Is array:'."\n" + ."\n" + .'- true: Yes'."\n" + .'- false: No', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'IsEncrypt' => [ + 'description' => 'Whether encrypted'."\n" + .'><notice>Invalid content></notice>', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'IsInteractive' => [ + 'description' => 'Is interactive'."\n" + .'><notice>Invalid content></notice>', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Slot tagging Result', + 'type' => 'string', + 'example' => '@知道', + 'title' => '', + ], + 'Tags' => [ + 'description' => 'Slot tagging labels', + 'type' => 'array', + 'items' => [ + 'description' => 'Slot tagging labels', + 'type' => 'object', + 'properties' => [ + 'UserSayId' => [ + 'description' => 'Unique identity of the intent expression corresponding to the label', + 'type' => 'string', + 'example' => '17448458', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Tagging result of the intent expression corresponding to the label', + 'type' => 'string', + 'example' => '你知道xxxx？', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Question' => [ + 'description' => 'Slot follow-up question script', + 'type' => 'array', + 'items' => [ + 'description' => 'Slot follow-up question script', + 'type' => 'string', + 'example' => '你知道？', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'IsNecessary' => [ + 'description' => 'Is the slot Required:'."\n" + ."\n" + .'- true: Yes'."\n" + .'- false: No', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'LifeSpan' => [ + 'description' => 'Slot lifecycle', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'FeedbackType' => [ + 'description' => 'Feedback type'."\n" + .'><notice>Invalid content></notice>', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'FeedbackFunctions' => [ + 'description' => 'Follow-up question function'."\n" + .'><notice>Invalid content></notice>', + 'type' => 'array', + 'items' => [ + 'description' => 'Follow-up question function', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Description' => [ + 'description' => 'Follow-up question description ', + 'type' => 'string', + 'example' => 'GA setup for HPC cn4-HPC-EndUserServer-GlobalAccelerator', + 'title' => '', + ], + 'Function' => [ + 'description' => 'Follow-up question function', + 'type' => 'string', + 'example' => 'count', + 'title' => '', + ], + 'Name' => [ + 'description' => 'Function Name', + 'type' => 'string', + 'example' => '方欣云呼系统每日拨测_2024年11月', + 'title' => '', + ], + 'AliyunService' => [ + 'description' => 'Alibaba Cloud service', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'AliyunFunction' => [ + 'description' => 'Alibaba Cloud function name', + 'type' => 'string', + 'example' => 'test', + 'title' => '', + ], + 'EndPoint' => [ + 'description' => 'Access edge zone', + 'type' => 'string', + 'example' => 'cn-hangzhou.log.aliyuncs.com', + 'title' => '', + ], + 'Type' => [ + 'description' => 'Follow-up question type ', + 'type' => 'string', + 'example' => 'cluster', + 'title' => '', + ], + 'Switch' => [ + 'description' => 'Feature toggle. Valid values: '."\n" + .'- **on**: Enabled '."\n" + .'- **off**: shutdown ', + 'type' => 'array', + 'items' => [ + 'description' => 'Branch type ', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'Condition ID ', + 'type' => 'string', + 'example' => 'b9932604-08ae-4525-bbe5-c8cce3066070', + 'title' => '', + ], + 'Label' => [ + 'description' => 'Follow-up question label ', + 'type' => 'string', + 'example' => 'SQL_SUB_QUERY', + 'title' => '', + ], + 'Type' => [ + 'description' => 'Type ', + 'type' => 'string', + 'example' => 'PASSKEY', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Conditional value ', + 'type' => 'string', + 'example' => 'BASE_VALIDATE_FILTER_SWITCH', + 'title' => '', + ], + 'Name' => [ + 'description' => 'Condition name ', + 'type' => 'string', + 'example' => '测试0609_20241021_101018_复制_复制_复制', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Params' => [ + 'description' => 'Parameter ', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '{"type":2}', + 'description' => 'Parameter content ', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'BotId' => [ + 'description' => 'Bot ID', + 'type' => 'string', + 'example' => 'chatbot-cn-n7QmzrUnNe'."\n", + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => '', + ], + ], + ], + 'title' => 'Query intents in the annotation center list', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListIntentions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + '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"}]', + 'translator' => 'machine', + ], + 'ListIntents' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'docRequired' => true, + 'example' => 'b9ff4e88-65f9-4eb3-987c-11ba51f3f24d', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition: intent keyword', + 'example' => '还款', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number', + 'docRequired' => true, + 'example' => '1', + 'format' => 'int32', + 'required' => true, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of items', + 'docRequired' => true, + 'example' => '10', + 'format' => 'int32', + 'required' => true, + 'type' => 'integer', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status Code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Intents' => [ + 'description' => 'Intent list', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'Page number', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Page size', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'example' => '20', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'List' => [ + 'description' => 'Array of intents', + 'items' => [ + 'properties' => [ + 'Utterances' => [ + 'description' => 'User utterances that trigger the intent', + 'example' => '["ok","好的","好吧","好嘞","可以","行啊","行吧","那行","知道了","我看一下","能的","等会吧","等一下","马上还","等一会","过两天","我会想办法处理"]', + 'type' => 'string', + 'title' => '', + ], + 'IntentDescription' => [ + 'description' => 'Instance description', + 'example' => '同意还款意图', + 'type' => 'string', + 'title' => '', + ], + 'UpdateTime' => [ + 'description' => 'Intent Update Time', + 'example' => '1578469042851', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time', + 'example' => '1578469042851', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'Keywords' => [ + 'description' => 'Intent keywords', + 'example' => '["还款"]', + 'type' => 'string', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Script ID', + 'example' => '6ef95fd5-558f-4ee8-af34-b2ede087a87c', + 'type' => 'string', + 'title' => '', + ], + 'IntentId' => [ + 'description' => 'Intent ID', + 'example' => 'a8494b35-eefb-4c8a-887b-b60d2f0fa57a', + 'type' => 'string', + 'title' => '', + ], + 'IntentName' => [ + 'description' => 'Intent name', + 'example' => '统一还款', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => 'Intent information', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query Intent List – Legacy Canvas API', + 'summary' => 'Query the intent list. This is a legacy canvas API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListIntents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Business ID. ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', + 'title' => '', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter by task group creation time (start). ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1578965079000', + 'title' => '', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter by the end of task group creation time.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1579965079000', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of records per page.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '100', + 'example' => '10', + 'title' => '', + ], + ], + [ + 'name' => 'AsyncQuery', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to asynchronously retrieve the query result. ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'SearchText', + 'in' => 'query', + 'schema' => [ + 'description' => 'Search keyword ', + 'type' => 'string', + 'required' => false, + 'example' => '面试', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupStatusFilter', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition: Filter by job status. You can select multiple statuses simultaneously, separated by commas, with a logical OR relationship. '."\n" + .'Valid values: '."\n" + .'- **Draft**: Draft. '."\n" + .'- **Scheduling**: Scheduling. '."\n" + .'- **Executing**: Executing. '."\n" + .'- **Completed**: Completed. '."\n" + .'- **Paused**: Suspended. '."\n" + .'- **Failed**: Failed. '."\n" + .'- **Cancelled**: Cancelled. '."\n" + .'- **Initializing**: Initializing. ', + 'type' => 'string', + 'required' => false, + 'example' => 'Draft', + 'title' => '', + ], + ], + [ + 'name' => 'OnlyMinConcurrencyEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'View jobs with effective concurrency guarantee values. ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the invocation succeeded. true: The invocation succeeded. false: The invocation failed.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'AsyncTaskId' => [ + 'description' => 'Asynchronous query ID. If the query is asynchronous, you can use this ID to retrieve the query result.', + 'type' => 'string', + 'example' => '6243d904-939d-42ce-a8e4-886a139e77a3'."\n", + 'title' => '', + ], + 'JobGroups' => [ + 'description' => 'Job list.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'Page number.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Number of items per page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total number of records.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'List' => [ + 'description' => 'Array.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Execution status. Valid values:'."\n" + ."\n" + .'- **Draft**: Draft.'."\n" + .'- **Scheduling**: Scheduling.'."\n" + .'- **Executing**: Executing.'."\n" + .'- **Completed**: Completed.'."\n" + .'- **Paused**: Suspended.'."\n" + .'- **Failed**: Failed.'."\n" + .'- **Cancelled**: Cancelled.'."\n" + .'- **Initializing**: Initializing.', + 'type' => 'string', + 'example' => 'Draft', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Job ID. ', + 'type' => 'string', + 'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9', + 'title' => '', + ], + 'CreationTime' => [ + 'description' => 'Creation Time. ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578550074361', + 'title' => '', + ], + 'JobGroupName' => [ + 'description' => 'Job group name.', + 'type' => 'string', + 'example' => '催收作业组', + 'title' => '', + ], + 'TotalCallNum' => [ + 'description' => 'Total call count. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Script ID. ', + 'type' => 'string', + 'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9', + 'title' => '', + ], + 'JobGroupDescription' => [ + 'description' => 'Job Description. ', + 'type' => 'string', + 'example' => '催收的作业组', + 'title' => '', + ], + 'JobDataParsingTaskId' => [ + 'description' => 'ID of the jobFile parsing task. [Deprecated]', + 'type' => 'string', + 'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9', + 'title' => '', + ], + 'ScriptName' => [ + 'description' => 'Script Name. ', + 'type' => 'string', + 'example' => '话术名称', + 'title' => '', + ], + 'ScriptVersion' => [ + 'description' => 'Script Version. ', + 'type' => 'string', + 'example' => 'd9e828ac-744b-4dd3-848a-17a3da9167b8', + 'title' => '', + ], + 'ModifyTime' => [ + 'description' => 'Updated At, in milliseconds.', + 'type' => 'string', + 'example' => '1578550074361', + 'title' => '', + ], + 'Progress' => [ + 'description' => 'Job statistics information.', + 'type' => 'object', + 'properties' => [ + 'TotalNotAnswered' => [ + 'description' => 'Deprecated', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Status' => [ + 'description' => '> This parameter is no longer returned.'."\n" + ."\n" + .'Execution status. Valid values:'."\n" + ."\n" + .'- **Draft**: Draft.'."\n" + .'- **Scheduling**: Scheduling.'."\n" + .'- **Executing**: Executing.'."\n" + .'- **Completed**: Completed.'."\n" + .'- **Paused**: Suspended.'."\n" + .'- **Failed**: Failed.'."\n" + .'- **Cancelled**: Cancelled.'."\n" + .'- **Initializing**: Initialization.', + 'type' => 'string', + 'example' => 'Scheduling', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'Start Time. [Deprecated]', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578550074361', + 'title' => '', + ], + 'FailedNum' => [ + 'description' => 'Number of failed jobs.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'PausedNum' => [ + 'description' => 'Number of suspended jobs.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'CancelledNum' => [ + 'description' => 'Number of cancelled jobs.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'TotalJobs' => [ + 'description' => 'Total number of jobs.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + 'TotalCompleted' => [ + 'description' => 'Number of completed jobs up to the current time.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'title' => '', + ], + 'Duration' => [ + 'description' => 'Total execution duration so far. [Deprecated]', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1578550074361', + 'title' => '', + ], + 'ExecutingNum' => [ + 'description' => 'Number of jobs currently executing.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'Scheduling' => [ + 'description' => 'Number of jobs being scheduled.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + 'ExportProgress' => [ + 'description' => 'Export progress.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Export job status. Valid values:'."\n" + ."\n" + .'- **PENDING**: Waiting.'."\n" + .'- **IN_PROGRESS**: In progress.'."\n" + .'- **FINISHED**: Finished.'."\n" + .'- **FAILED**: Failed.', + 'type' => 'string', + 'example' => 'PENDING', + 'title' => '', + ], + 'FileHttpUrl' => [ + 'description' => 'Deprecated.', + 'type' => 'string', + 'example' => 'http://www.xxx.com/xxx', + 'title' => '', + ], + 'Progress' => [ + 'description' => 'Progress.', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + 'Strategy' => [ + 'description' => 'Policy. [Deprecated] '."\n" + ."\n" + .'> To view job policy information, you can invoke the DescribeJobGroup API. ', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'Policy end time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2209702074000', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'Policy start time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578550074000', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + 'MinConcurrency' => [ + 'description' => 'Minimum concurrent job count guarantee. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query job list', + 'summary' => 'Query the outbound call job list.', + 'changeSet' => [ + [ + 'createdAt' => '2025-02-15T02:02:23.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-06-24T02:14:42.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2022-07-07T08:05:17.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-07-07T02:56:19.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-06-22T02:25:50.000Z', + 'description' => 'Request parameters changed, Error codes changed', + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListJobGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '10', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListJobGroups', + ], + ], + ], + ], + 'ListJobGroupsAsync' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '94122', + 'abilityTreeNodes' => [ + 'FEATUREoutboundbot7ZIYMY', + ], + ], + 'parameters' => [ + [ + 'name' => 'AsyncTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'When ListJobGroup is invoked in asynchronous mode, the value of AsyncTaskId returned by ListJobGroup. You can use this ID to retrieve the result of the asynchronous query.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '6243d904-939d-42ce-a8e4-886a139e77a3', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Timeout' => [ + 'description' => 'Indicates whether a timeout occurred. ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID. ', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded. ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Vaild' => [ + 'description' => 'Indicates whether it is valid.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code. ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API response message. ', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Number of entries per page. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'Page number. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count. ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'JobGroups' => [ + 'description' => 'Job list. ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Task status. ', + 'type' => 'string', + 'example' => 'Scheduling', + 'title' => '', + ], + 'CreationTime' => [ + 'description' => 'Creation Time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640316786259', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Job ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'JobGroupName' => [ + 'description' => 'Job name.', + 'type' => 'string', + 'example' => 'xxx', + 'title' => '', + ], + 'TotalCallNum' => [ + 'description' => 'Total call count.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Script ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'JobGroupDescription' => [ + 'description' => 'Job description.', + 'type' => 'string', + 'example' => 'xxx', + 'title' => '', + ], + 'JobDataParsingTaskId' => [ + 'description' => 'The ID of the jobFile parsing task. [Deprecated]', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'ScriptName' => [ + 'description' => 'Script name.', + 'type' => 'string', + 'example' => 'xxxx', + 'title' => '', + ], + 'ScriptVersion' => [ + 'description' => 'Script version.', + 'type' => 'string', + 'example' => '111', + 'title' => '', + ], + 'ModifyTime' => [ + 'description' => 'Updated At, in milliseconds. ', + 'type' => 'string', + 'example' => '1640316786259', + 'title' => '', + ], + 'Strategy' => [ + 'description' => 'Policy. [Deprecated]'."\n" + ."\n" + .'> To view job policy information, you can invoke the DescribeJobGroup API.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'Policy end time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640316786259', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'Policy start time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640316786259', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + 'Progress' => [ + 'description' => 'Statistics information of the job. ', + 'type' => 'object', + 'properties' => [ + 'TotalNotAnswered' => [ + 'description' => 'The number of jobs that were not answered. [Deprecated]', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Status' => [ + 'description' => 'Execution status. Valid values:'."\n" + ."\n" + .'- Draft: Draft.'."\n" + .'- Scheduling: Scheduling.'."\n" + .'- Executing: Executing.'."\n" + .'- Completed: Completed.'."\n" + .'- Paused: Suspended.'."\n" + .'- Failed: Failed.'."\n" + .'- Cancelled: Cancelled.'."\n" + .'- Initializing: Initialization.', + 'type' => 'string', + 'example' => 'Scheduling', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'Start Time. [Deprecated]', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640316786259', + 'title' => '', + ], + 'FailedNum' => [ + 'description' => 'Number of failed jobs.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'PausedNum' => [ + 'description' => 'Number of paused jobs.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'CancelledNum' => [ + 'description' => 'Number of cancelled jobs.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'TotalCompleted' => [ + 'description' => 'Number of completed jobs.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'TotalJobs' => [ + 'description' => 'Total number of jobs.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'Duration' => [ + 'description' => 'Total execution duration so far. [Deprecated]', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + 'title' => '', + ], + 'Scheduling' => [ + 'description' => 'Number of jobs in scheduling.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + 'ExecutingNum' => [ + 'description' => 'Number of executing jobs.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + 'ExportProgress' => [ + 'description' => 'Export progress.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Status.', + 'type' => 'string', + 'example' => 'PENDING', + 'title' => '', + ], + 'FileHttpUrl' => [ + 'description' => 'Download URL. [Deprecated]', + 'type' => 'string', + 'example' => 'http://www.xxx.com/xxx'."\n", + 'title' => '', + ], + 'Progress' => [ + 'description' => 'Progress.', + 'type' => 'string', + 'example' => '50', + 'title' => '', + ], + ], + 'example' => '{}', + 'title' => '', + ], + 'MinConcurrency' => [ + 'description' => 'Minimum concurrency.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Asynchronous query job list', + 'summary' => 'Asynchronously retrieve the outbound call job list. When the Async parameter is specified in the ListJobGroup API request, use this API to obtain the asynchronous ListJobGroup result. ', + 'changeSet' => [ + [ + 'createdAt' => '2024-06-24T02:14:42.000Z', + 'description' => 'Response parameters changed, Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListJobGroupsAsync', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListJobs' => [ + 'summary' => 'Query multiple jobs.', + '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' => 'Instance ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of job IDs. Note: The number of child items must be less than or equal to 99. ', + 'type' => 'array', + 'items' => [ + 'description' => 'Job ID ', + 'type' => 'string', + 'required' => false, + 'example' => '24fb9a8d-f20e-4ee2-a11c-094dda68c5cc', + 'title' => '', + ], + 'required' => true, + 'example' => '24fb9a8d-f20e-4ee2-a11c-094dda68c5cc', + 'maxItems' => 99, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Jobs' => [ + 'description' => 'Job array', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Job status. Valid values:'."\n" + ."\n" + .'- **Scheduling**: Scheduling.'."\n" + .'- **Executing**: Executing.'."\n" + .'- **Succeeded**: Succeeded.'."\n" + .'- **Paused**: Suspended.'."\n" + .'- **Failed**: Failed.'."\n" + .'- **Cancelled**: Cancelled.'."\n" + .'- **Drafted**: Draft.', + 'type' => 'string', + 'example' => 'Succeeded', + 'title' => '', + ], + 'ScenarioId' => [ + 'description' => 'Business ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Job group ID ', + 'type' => 'string', + 'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8', + 'title' => '', + ], + 'StrategyId' => [ + 'description' => 'Policy ID ', + 'type' => 'string', + 'example' => 'c8a2b7f2-ad1a-4865-b872-d0080d9802d9', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', + 'title' => '', + ], + 'Priority' => [ + 'description' => 'Job Priority ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => ' 5', + 'title' => '', + ], + 'SystemPriority' => [ + 'description' => 'System Priority', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'FailureReason' => [ + 'description' => 'Job failure reason', + 'type' => 'string', + 'example' => 'NoAnswer', + 'title' => '', + ], + 'ReferenceId' => [ + 'description' => 'Business ID of the job, defined by the business party. '."\n" + ."\n" + .'> This is the uploaded ContactId value.', + 'type' => 'string', + 'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28', + 'title' => '', + ], + 'Contacts' => [ + 'description' => 'List of contacts', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PhoneNumber' => [ + 'description' => 'Phone number', + 'type' => 'string', + 'example' => '135****8888', + 'title' => '', + ], + 'State' => [ + 'description' => 'Status [Deprecated]', + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'ContactId' => [ + 'description' => 'Contact ID. Automatically generated by the system', + 'type' => 'string', + 'example' => 'db3db762-e421-44c9-9a01-cb423470757c', + 'title' => '', + ], + 'Honorific' => [ + 'description' => 'Honorific. Same as the contact name', + 'type' => 'string', + 'example' => '张先生', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID [Deprecated]', + 'type' => 'string', + 'example' => '72dcd26b-f12d-4c27-b3af-18f6aed5b160', + 'title' => '', + ], + 'ContactName' => [ + 'description' => 'Contact name', + 'type' => 'string', + 'example' => '张三', + 'title' => '', + ], + 'Role' => [ + 'description' => 'Contact role [Deprecated]', + 'type' => 'string', + 'example' => '*', + 'title' => '', + ], + 'ReferenceId' => [ + 'description' => 'Third-party system ID of the contact', + 'type' => 'string', + 'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Extras' => [ + 'description' => 'List of business parameters. '."\n" + ."\n" + .'> Note: TenantId and ServiceId are system-generated. All other parameters are custom and provided as reference. ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Business parameter key ', + 'type' => 'string', + 'example' => 'name', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Business parameter value ', + 'type' => 'string', + 'example' => '张三', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Summary' => [ + 'description' => 'Label data for conversation jobs:'."\n" + ."\n" + .'In LLM scenarios: tag hit data after conversation completion.'."\n" + ."\n" + .'In small model scenarios: variable value data after conversation completion.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SummaryName' => [ + 'description' => 'Label name.', + 'type' => 'string', + 'example' => 'score', + 'title' => '', + ], + 'Category' => [ + 'description' => 'Conversation summary category', + 'type' => 'string', + 'example' => ' {}', + 'title' => '', + ], + 'Content' => [ + 'description' => 'Tag value', + 'type' => 'string', + 'example' => '5', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Tasks' => [ + 'description' => 'Task list', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Task Status, with the following possible values: '."\n" + .'(Note: The **Succeeded** status has been further categorized by specific reasons. The generic **Succeeded**: 1 (Answered) status will no longer be displayed; instead, only the detailed reason types will be returned.)'."\n" + ."\n" + .'- **Executing**: 0 (Calling in progress). '."\n" + .'- **Succeeded**: 1 (Answered). '."\n" + .'- **NoAnswer**: 2 (Not answered – No one picked up). '."\n" + .'- **NotExist**: 3 (Not answered – Nonexistent number). '."\n" + .'- **Busy**: 4 (Not answered – Line busy). '."\n" + .'- **Cancelled**: 5 (Not dialed – Job stopped). '."\n" + .'- **Failed**: 6 (Failed). '."\n" + .'- **NotConnected**: 7 (Not answered – Unable to connect). '."\n" + .'- **PoweredOff**: 8 (Not answered – Powered off). '."\n" + .'- **OutOfService**: 9 (Not answered – Called party suspended). '."\n" + .'- **InArrears**: 10 (Not answered – Called party has overdue payment). '."\n" + .'- **EmptyNumber**: 11 (Not dialed – Nonexistent number, not called). '."\n" + .'- **PerDayCallCountLimit**: 12 (Not dialed – Exceeded daily call limit). '."\n" + .'- **ContactBlockList**: 13 (Not dialed – Blacklist). '."\n" + .'- **CallerNotRegistered**: 14 (Not dialed – Caller number not registered). '."\n" + .'- **Terminated**: 15 (Not dialed – Terminated). '."\n" + .'- **VerificationCancelled**: 16 (Not dialed – Cancelled due to failed pre-call authentication). '."\n" + .'- **OutOfServiceNoCall**: 17 (Not dialed – Called party suspended, not called). '."\n" + .'- **InArrearsNoCall**: 18 (Not dialed – Called party has overdue payment, not called). '."\n" + .'- **CallingNumberNotExist**: 19 (Not dialed – Caller number does not exist). '."\n" + .'- **SucceededFinish**: 20 (Answered – Normal completion). '."\n" + .'- **SucceededChatbotHangUpAfterNoAnswer**: 21 (Answered – Bot hung up after unrecognized input). '."\n" + .'- **SucceededChatbotHangUpAfterSilence**: 22 (Answered – Bot hung up after silence timeout). '."\n" + .'- **SucceededClientHangUpAfterNoAnswer**: 23 (Answered – User hung up after unrecognized input). '."\n" + .'- **SucceededClientHangUp**: 24 (Answered – User hung up without reason). '."\n" + .'- **SucceededTransferByIntent**: 25 (Answered – Transferred to agent due to intent match). '."\n" + .'- **SucceededTransferAfterNoAnswer**: 26 (Answered – Transferred to agent after unrecognized input). '."\n" + .'- **SucceededInoInterAction**: 27 (Answered – No interaction from user side). '."\n" + .'- **SucceededError**: 28 (Answered – Interrupted due to system exception). '."\n" + .'- **SucceededSpecialInterceptVoiceAssistant**: 29 (Answered – Intercepted under special condition – Voice assistant). '."\n" + .'- **SucceededSpecialInterceptExtensionNumberTransfer**: 30 (Answered – Intercepted under special condition – Extension transfer). '."\n" + .'- **SucceededSpecialInterceptCustomSpecialIntercept**: 31 (Answered – Intercepted under special condition – Custom interception). '."\n" + .'- **HighRiskSipCode**: 32 (Not dialed – High-risk, not called).'."\n", + 'type' => 'string', + 'example' => 'Succeeded', + 'title' => '', + ], + 'PlanedTime' => [ + 'description' => 'Planned execution time of the task ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579068424883', + 'title' => '', + ], + 'ChatbotId' => [ + 'description' => 'Chatbot ID', + 'type' => 'string', + 'example' => ' 1234', + 'title' => '', + ], + 'ActualTime' => [ + 'description' => 'Actual running time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579068424883', + 'title' => '', + ], + 'CalledNumber' => [ + 'description' => 'Called number', + 'type' => 'string', + 'example' => '135****8888', + 'title' => '', + ], + 'ScenarioId' => [ + 'description' => 'Scenario ID. Historical parameter. [Deprecated]', + 'type' => 'string', + 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID ', + 'type' => 'string', + 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', + 'title' => '', + ], + 'CallId' => [ + 'description' => 'Call ID', + 'type' => 'string', + 'example' => '1528189846043', + 'title' => '', + ], + 'CallingNumber' => [ + 'description' => 'Calling number', + 'type' => 'string', + 'example' => '0571****3106', + 'title' => '', + ], + 'Brief' => [ + 'description' => 'Business result. Historical parameter [Deprecated]', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + 'Duration' => [ + 'description' => 'Duration.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => ' 120', + 'title' => '', + ], + 'TaskId' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'example' => 'ff44709e-39a6-43ba-959b-20fcabe3e496', + 'title' => '', + ], + 'Conversation' => [ + 'description' => 'Conversation List', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Speaker' => [ + 'description' => 'Speaker of the utterance: "Robot" for the bot, "Contact" for the contact', + 'type' => 'string', + 'example' => 'Robot', + 'title' => '', + ], + 'Timestamp' => [ + 'description' => 'UNIX timestamp when the conversation text was stored', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579068424883', + 'title' => '', + ], + 'Script' => [ + 'description' => 'Conversation text', + 'type' => 'string', + 'example' => '你好，我是**客服', + 'title' => '', + ], + 'Summary' => [ + 'description' => 'Summary information. [Deprecated]', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SummaryName' => [ + 'description' => 'Summary Name', + 'type' => 'string', + 'example' => '是本人', + 'title' => '', + ], + 'Category' => [ + 'description' => 'category', + 'type' => 'string', + 'example' => '标签', + 'title' => '', + ], + 'Content' => [ + 'description' => 'Summary content', + 'type' => 'string', + 'example' => '是', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Contact' => [ + 'description' => 'Contact for the job', + 'type' => 'object', + 'properties' => [ + 'PhoneNumber' => [ + 'description' => 'Phone number', + 'type' => 'string', + 'example' => '135****8888', + 'title' => '', + ], + 'State' => [ + 'description' => 'Status.', + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'ContactId' => [ + 'description' => 'Contact ID', + 'type' => 'string', + 'example' => 'db3db762-e421-44c9-9a01-cb423470757c', + 'title' => '', + ], + 'Honorific' => [ + 'description' => 'Honorific title of the contact. If not specified, it is the same as the contact name.', + 'type' => 'string', + 'example' => '张先生', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID. Deprecated ', + 'type' => 'string', + 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', + 'title' => '', + ], + 'ContactName' => [ + 'description' => 'Contact name ', + 'type' => 'string', + 'example' => '张三', + 'title' => '', + ], + 'Role' => [ + 'description' => 'Role.', + 'type' => 'string', + 'example' => '*', + 'title' => '', + ], + 'ReferenceId' => [ + 'description' => 'Third-party system ID of the contact', + 'type' => 'string', + 'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CallingNumbers' => [ + 'description' => 'List of calling numbers', + 'type' => 'array', + 'items' => [ + 'description' => 'List of calling numbers', + 'type' => 'string', + 'example' => '["0571****3106"]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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 {\\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}","type":"json"}]', + 'title' => 'Query multiple jobs ', + 'changeSet' => [ + [ + 'createdAt' => '2024-07-24T07:36:11.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListJobsByGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job group ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'de48407d-309e-451a-81ec-6fb11f8fdbf3', + 'title' => '', + ], + ], + [ + 'name' => 'JobStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job status ', + 'type' => 'string', + 'required' => false, + 'example' => 'Succeeded', + 'title' => '', + ], + ], + [ + 'name' => 'JobFailureReason', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job failure reason ', + 'type' => 'string', + 'required' => false, + 'example' => 'NoAnswer', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of entries per page ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code ', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Jobs' => [ + 'description' => 'Job array', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Page size', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '18', + 'title' => '', + ], + 'List' => [ + 'description' => 'Job list', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Job status. '."\n" + .'- Scheduling(0, "Scheduling") '."\n" + .'- Executing(1, "Executing") '."\n" + .'- Succeeded(2, "End - Reached") '."\n" + .'- Paused(3, "Paused") '."\n" + .'- Failed(4, "End - Not Reached") '."\n" + .'- Cancelled(5, "Cancelled - Manual Intervention") '."\n" + .'- Drafted(6, "Draft")', + 'type' => 'string', + 'example' => 'Succeeded', + 'title' => '', + ], + 'ScenarioId' => [ + 'description' => 'Scenario ID (historical parameter)', + 'type' => 'string', + 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8', + 'title' => '', + ], + 'StrategyId' => [ + 'description' => 'Policy ID', + 'type' => 'string', + 'example' => 'c8a2b7f2-ad1a-4865-b872-d0080d9802d9', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID ', + 'type' => 'string', + 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', + 'title' => '', + ], + 'Priority' => [ + 'description' => 'Priority', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'SystemPriority' => [ + 'description' => 'System Priority', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'FailureReason' => [ + 'description' => 'Failure reason. '."\n" + .'- Unknown (unknown fault), '."\n" + .'- NoAnswer (no answer), '."\n" + .'- InvalidStrategy (invalid policy; policy configuration incorrect), '."\n" + .'- TimeUp (timeout detected during scheduling), '."\n" + .'- NoStrategy (policy is empty or not found), '."\n" + .'- CallFailed (call failed), '."\n" + .'- PerDayCallCountLimit (daily call count limit for the number reached), '."\n" + .'- ContactBlockList (contact is on the outbound call block list), '."\n" + .'- EmptyNumber (nonexistent number; no further outbound calls), '."\n" + .'- JobPerDayCallCountLimit (daily call count limit for the job reached), '."\n" + .'- VerificationCancelled (cancelled due to failed pre-call authentication), '."\n" + .'- ContactSuspended (calling suspended), '."\n" + .'- InArrears (overdue payment), '."\n" + .'- OutOfService (service suspended), '."\n" + .'- NoneRepeatableJobMaxAttemptCountLimit (job has reached maximum attempt count); ', + 'type' => 'string', + 'example' => 'NoAnswer', + 'title' => '', + ], + 'ReferenceId' => [ + 'description' => 'Third-party system ID', + 'type' => 'string', + 'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28', + 'title' => '', + ], + 'Contacts' => [ + 'description' => 'Contact List', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PhoneNumber' => [ + 'description' => 'Contact phone number.', + 'type' => 'string', + 'example' => '134********', + 'title' => '', + ], + 'State' => [ + 'description' => 'Deprecated.', + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'ContactId' => [ + 'description' => 'Contact ID. (Automatically generated by the system.)', + 'type' => 'string', + 'example' => 'db3db762-e421-44c9-9a01-cb423470757c', + 'title' => '', + ], + 'Honorific' => [ + 'description' => 'Contact honorific. (Consistent with the contact\'s name)', + 'type' => 'string', + 'example' => '张先生', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID. (Deprecated.)', + 'type' => 'string', + 'example' => '72dcd26b-f12d-4c27-b3af-18f6aed5b160', + 'title' => '', + ], + 'ContactName' => [ + 'description' => 'Contact name.', + 'type' => 'string', + 'example' => '张三', + 'title' => '', + ], + 'Role' => [ + 'description' => 'Deprecated', + 'type' => 'string', + 'example' => '*', + 'title' => '', + ], + 'ReferenceId' => [ + 'description' => 'Third-party system ID of the contact, uploaded by the customer.', + 'type' => 'string', + 'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34', + 'title' => '', + ], + ], + 'description' => 'Contact information.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Extras' => [ + 'description' => 'Business Data'."\n" + ."\n" + .'> TenantId and ServiceId are system-generated. All other parameters are custom and provided as reference.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Business parameter name', + 'type' => 'string', + 'example' => '性别', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Business parameter value', + 'type' => 'string', + 'example' => '男', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Summary' => [ + 'description' => 'Conversation summary. [Deprecated]'."\n" + ."\n" + .'> You can obtain it by using the DescribeJob API.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SummaryName' => [ + 'description' => 'Summary name ', + 'type' => 'string', + 'example' => 'score', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Job group ID', + 'type' => 'string', + 'example' => '88e56cfb-33f8-477a-907c-0fe83292d924', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID. ', + 'type' => 'string', + 'example' => 'f102a853-5f5a-47fb-8869-b31ea74a9620', + 'title' => '', + ], + 'Category' => [ + 'description' => 'Conversation summary category', + 'type' => 'string', + 'example' => '{}', + 'title' => '', + ], + 'TaskId' => [ + 'description' => 'Call ID.', + 'type' => 'string', + 'example' => 'b0f35dd1-0337-402e-9c4f-3a6c2426950a', + 'title' => '', + ], + 'Content' => [ + 'description' => 'Summary content of the conversation ', + 'type' => 'string', + 'example' => '5', + 'title' => '', + ], + 'ConversationDetailId' => [ + 'description' => 'Call record ID', + 'type' => 'string', + 'example' => '62a860f5-a8b3-4b75-9512-c7e04bb7c8bc', + 'title' => '', + ], + 'SummaryId' => [ + 'description' => 'Summary ID ', + 'type' => 'string', + 'example' => '680f1905-81ae-4aab-99dd-2964dfb767fa', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CallingNumbers' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'Calling number ', + 'type' => 'string', + 'example' => '0571****3106', + 'title' => '', + ], + 'description' => 'List of calling numbers ', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query jobs by job group ', + 'summary' => 'Query jobs by job group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListJobsByGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page size', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'OutboundCallNumbers' => [ + 'description' => 'Number list', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'List' => [ + 'description' => 'List of number data', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Number' => [ + 'description' => 'Number', + 'type' => 'string', + 'example' => '10088', + 'title' => '', + ], + 'OutboundCallNumberId' => [ + 'description' => 'Number ID', + 'type' => 'string', + 'example' => ' fa0e21e9-caab-4629-9121-1e341243d599', + 'title' => '', + ], + 'RateLimitCount' => [ + 'description' => 'Time Range for Rate Limiting, in seconds', + 'type' => 'string', + 'example' => '10', + 'title' => '', + ], + 'RateLimitPeriod' => [ + 'description' => 'Rate Limiting count', + 'type' => 'string', + 'example' => '100', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query the list of outbound call numbers', + 'summary' => 'Query the list of outbound call caller numbers.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListOutboundCallNumbers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListResourceTags' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number', + 'docRequired' => true, + 'example' => '1', + 'format' => 'int32', + 'required' => true, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of entries', + 'docRequired' => true, + 'example' => '10', + 'format' => 'int32', + 'required' => true, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'resource type', + 'docRequired' => true, + 'example' => 'instance', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message prompt', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'ResourceTags' => [ + 'description' => 'Resource tag information', + 'example' => '{}', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'Page number', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Count per page', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'example' => '100', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'List' => [ + 'description' => 'List of resource tags', + 'example' => '[]', + 'items' => [ + 'properties' => [ + 'Key' => [ + 'description' => 'Resource tag key', + 'example' => 'name', + 'type' => 'string', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Resource tag value', + 'example' => 'xxx', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + ], + ], + 'type' => 'object', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query Instance Resource Tags', + 'summary' => 'Query tags of instance business resources.', + 'changeSet' => [ + [ + 'createdAt' => '2024-07-24T07:36:10.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListResourceTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListScriptPublishHistories' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'b0f35dd1-0337-402e-9c4f-3a6c2426950a', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of entries per page', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'is Succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ScriptPublishHistories' => [ + 'description' => 'History list', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Count per page', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'List' => [ + 'description' => 'Data array', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PublishTime' => [ + 'description' => 'Published At', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578965079000', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'example' => '29420f65-8f1f-4009-b2f8-f4f7b5d59090', + 'title' => '', + ], + 'Description' => [ + 'description' => 'Publish description', + 'type' => 'string', + 'example' => '第一次发布', + 'title' => '', + ], + 'ScriptVersion' => [ + 'description' => 'Script version', + 'type' => 'string', + 'example' => '1578965079000', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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 \\"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}","type":"json"}]', + 'title' => 'Query the publish history list of outbound call small model scenarios', + 'summary' => 'Query the list of outbound call publishing history.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListScriptPublishHistories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Instance ID to which the recording belongs ', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'c209abb3-6804-4a75-b2c7-dd55c8c61b6a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID to which the recording belongs ', + 'type' => 'string', + 'required' => true, + 'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'UuidsJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'List of recording IDs '."\n" + ."\n" + .'> That is, a list of Unique recording IDs. If not specified, all recordings are displayed. ', + 'type' => 'string', + 'required' => false, + 'example' => '["d17d5bfa-4972-4389-9718-f9602edabe48"]', + 'title' => '', + ], + ], + [ + 'name' => 'StatesJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'Recording status:'."\n" + ."\n" + .'- Validating: 1 '."\n" + .'- Validation failed: 2 '."\n" + .'- Processing: 3 '."\n" + .'- Processing failed: 4 '."\n" + .'- Reviewing: 5 '."\n" + .'- Review failed: 6 '."\n" + .'- Publish failed: 7 '."\n" + .'- Published: 8 '."\n" + .'- Pending publish: 9', + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' "8"'."\n" + .']', + 'title' => '', + ], + ], + [ + 'name' => 'Search', + 'in' => 'query', + 'schema' => [ + 'description' => 'Search criteria: you can query by recording Name or Content ', + 'type' => 'string', + 'required' => false, + 'example' => '您好', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of entries displayed per page ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + 'title' => '', + ], + ], + [ + 'name' => 'RefIdsJson', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'List of recording IDs (in JSON format), identical to UuidsJson ', + 'example' => '["d9fad189-760b-47b9-837f-aeabb4fc9109\\"]', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID ', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n", + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message ', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Number of entries per page ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'PageNumber' => [ + 'description' => 'Page number ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99', + 'title' => '', + ], + 'ScriptRecordings' => [ + 'description' => 'List of recordings ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RecordingContent' => [ + 'description' => 'Recording content ', + 'type' => 'string', + 'example' => '您好！', + 'title' => '', + ], + 'State' => [ + 'description' => 'Recording status.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + 'title' => '', + ], + 'StorageUuid' => [ + 'description' => 'Storage UUID ', + 'type' => 'string', + 'example' => '393674ed-3b5d-db44-0fda-615d05210178'."\n", + 'title' => '', + ], + 'StateExtend' => [ + 'description' => 'Status extension ', + 'type' => 'string', + 'example' => '无', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID ', + 'type' => 'string', + 'example' => 'ff0fb845-9f90-46d3-9716-d36b8a1e753a', + 'title' => '', + ], + 'GmtModified' => [ + 'description' => 'Update Time ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1654601332000', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'The ID of the scenario to which the recording belongs.', + 'type' => 'string', + 'example' => '6019b692-fd9e-4adb-8877-cef6a297b234', + 'title' => '', + ], + 'Uuid' => [ + 'description' => 'Unique ID of the recording.', + 'type' => 'string', + 'example' => '0a77386e-6402-8d23-4adf-6ec13b3f404d'."\n", + 'title' => '', + ], + 'GmtUpload' => [ + 'description' => 'Time when the recording was uploaded.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1654601332000', + 'title' => '', + ], + 'RecordingDuration' => [ + 'description' => 'Recording duration, in seconds.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'RecordingName' => [ + 'description' => 'Recording name ', + 'type' => 'string', + 'example' => 'hello.wav', + 'title' => '', + ], + 'GmtCreate' => [ + 'description' => 'Creation Time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1744963749000', + 'title' => '', + ], + 'InnerId' => [ + 'description' => 'The ID of the recording file under the instance.', + 'type' => 'string', + 'example' => '000003'."\n", + 'title' => '', + ], + 'RefId' => [ + 'type' => 'string', + 'description' => 'Unique ID of the recording.', + 'example' => '0a77386e-6402-8d23-4adf-6ec13b3f404d'."\n", + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '【Small Model API】Query Recording File List', + 'summary' => 'Query the list of recording files for use in small model scenarios. ', + 'changeSet' => [ + [ + 'createdAt' => '2023-03-30T12:41:10.000Z', + 'description' => 'Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListScriptRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListScriptVoiceConfigs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'scenario ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'f95c7ca6-872c-4765-8493-165a8dfc682d', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'page number', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'number', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '20', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ScriptVoiceConfigs' => [ + 'description' => 'List of script voice recordings', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Number of items per page', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + 'title' => '', + ], + 'List' => [ + 'description' => 'Array of script voice recordings', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Voice type', + 'type' => 'string', + 'example' => 'TTS', + 'title' => '', + ], + 'ScriptVoiceConfigId' => [ + 'description' => 'voice configuration ID', + 'type' => 'string', + 'example' => '2c8fa91f-9856-4145-90f2-08252f09bc18', + 'title' => '', + ], + 'ScriptContent' => [ + 'description' => 'Script text content', + 'type' => 'string', + 'example' => '请问你是 @name 吗', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'instance ID', + 'type' => 'string', + 'example' => 'bdd49242-114c-4045-b1d1-25ccc1756c75', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'script ID', + 'type' => 'string', + 'example' => 'a7441a05-43bb-4a2d-acb0-365f245d7a5b', + 'title' => '', + ], + 'ScriptWaveformRelation' => [ + 'description' => 'relational data of script audio configuration', + 'type' => 'string', + 'example' => '""', + 'title' => '', + ], + 'Source' => [ + 'description' => 'script source', + 'type' => 'string', + 'example' => 'DIALOGUE_FLOW', + 'title' => '', + ], + ], + 'description' => 'Array of script voice recordings', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Legacy canvas API] Query scenario voice configuration List', + 'summary' => 'Queries the list of scenario voices in the old canvas scenario.', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListScriptVoiceConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListScripts' => [ + 'summary' => 'Query the script list.', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bdd49242-114c-4045-b1d1-25ccc1756c75', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + 'minimum' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of entries displayed per page', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script name', + 'type' => 'string', + 'required' => false, + 'example' => '课程满意度回访', + 'title' => '', + ], + ], + [ + 'name' => 'NluEngine', + 'in' => 'query', + 'schema' => [ + 'description' => 'NLU bot engine.'."\n" + ."\n" + .'- If left unspecified, queries scenarios using small models.'."\n" + ."\n" + .'- If set to "Prompts", queries text-input pattern under LLM scenarios.'."\n" + ."\n" + .'- If set to "SSE_FUNCTION", queries Function Compute pattern under LLM scenarios.', + 'type' => 'string', + 'required' => false, + 'example' => 'Prompts', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Scripts' => [ + 'description' => 'Script list', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Page size', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + 'title' => '', + ], + 'List' => [ + 'description' => 'Script array', + 'type' => 'array', + 'items' => [ + 'description' => 'Script array', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Script status', + 'type' => 'string', + 'example' => 'DRAFTED', + 'title' => '', + ], + 'UpdateTime' => [ + 'description' => 'Update Time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578965079000', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Script ID ', + 'type' => 'string', + 'example' => '8d6a6e41-8093-49af-a9d1-0281878758ac', + 'title' => '', + ], + 'IsDebugDrafted' => [ + 'description' => 'Indicates whether the debug version is in Draft status ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Industry' => [ + 'description' => 'Industry ', + 'type' => 'string', + 'example' => '金融', + 'title' => '', + ], + 'ScriptDescription' => [ + 'description' => 'Script Description ', + 'type' => 'string', + 'example' => '电话销售话术', + 'title' => '', + ], + 'IsDrafted' => [ + 'description' => 'Indicates whether it is a Draft ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'DebugStatus' => [ + 'description' => 'Debug status ', + 'type' => 'string', + 'example' => 'DRAFTED', + 'title' => '', + ], + 'MiniPlaybackEnable' => [ + 'description' => 'Toggle for follow-up utterance configuration', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'RejectReason' => [ + 'description' => 'Review failure reason', + 'type' => 'string', + 'example' => '话术用语不合规', + 'title' => '', + ], + 'Scene' => [ + 'description' => 'Scenario ', + 'type' => 'string', + 'example' => '电销', + 'title' => '', + ], + 'ScriptName' => [ + 'description' => 'Script name', + 'type' => 'string', + 'example' => '电话销售话术', + 'title' => '', + ], + 'NewBargeInEnable' => [ + 'description' => 'Toggle for graceful interruption configuration; always false for LLMs ', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'LongWaitEnable' => [ + 'description' => 'Toggle for long pause configuration. This value is always false for LLMs.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'EmotionEnable' => [ + 'description' => 'Toggle for emotion detection configuration. This is always false for LLM scenarios.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'IsPreset' => [ + 'description' => 'Indicates whether it is a Preset scenario', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'AgentKey' => [ + 'description' => 'Access key for the robot workspace ', + 'type' => 'string', + 'example' => '14791f5f226b4878b3d9b676a0291234', + 'title' => '', + ], + 'AgentLlm' => [ + 'description' => 'Indicates whether the agent workspace is an LLM workspace.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'agentId' => [ + 'description' => 'Agent workspace ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1160195', + 'title' => '', + ], + 'NluEngine' => [ + 'description' => 'The bot engine. This field is empty for small model scenarios and returns "Prompts" for LLM scenarios.', + 'type' => 'string', + 'example' => '空或者Prompts', + 'title' => '', + ], + 'NluAccessType' => [ + 'description' => 'The bot access type. This field is empty for small model scenarios and returns "Managed" for LLM scenarios.', + 'type' => 'string', + 'example' => '空或者Managed', + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578965079000', + 'title' => '', + ], + 'NluProfile' => [ + 'description' => 'Function Compute service pattern configuration', + 'type' => 'object', + 'properties' => [ + 'FcFunction' => [ + 'description' => 'Function service name', + 'type' => 'string', + 'example' => 'sanfang_test', + 'title' => '', + ], + 'FcRegion' => [ + 'description' => 'Function service region', + 'type' => 'string', + 'example' => 'cn-shanghai'."\n", + 'title' => '', + ], + 'FcHttpTriggerUrl' => [ + 'description' => 'Function Compute trigger', + 'type' => 'string', + 'example' => 'http://sanfang_test-xxxxxx.cn-shanghai-vpc.fcapp.run'."\n", + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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 \\"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}","type":"json"}]', + 'title' => 'Query script list', + 'changeSet' => [ + [ + 'createdAt' => '2025-04-25T07:27:13.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2025-03-26T03:20:42.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-08-06T12:39:33.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2024-04-25T12:17:46.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2022-09-27T13:02:34.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2022-06-21T12:54:40.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2021-12-22T12:30:26.000Z', + 'description' => 'Response parameters changed', + ], + ], + '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' => 'Deprecated', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'resource type', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'INSTANCE', + 'enumValueTitles' => [ + 'INSTANCE' => 'INSTANCE', + ], + 'title' => '', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token for starting the next query', + 'type' => 'string', + 'required' => false, + 'example' => 'b949ae1f-01dc-4191-ae5a-70fbe6772fd8', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of resource IDs. The value range of n is [1, 50].', + 'type' => 'array', + 'items' => [ + 'description' => 'Resource ID. If the resource type is INSTANCE, specify the instance ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'af651b72-4a64-4340-ae7f-2cf0054d32f9', + 'title' => '', + ], + 'required' => false, + 'example' => 'ResourceId.1=b949ae1f-01dc-4191-ae5a-70fbe6772fd8', + 'maxItems' => 51, + 'title' => '', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag key. The value range for n is [1, 20].', + 'type' => 'string', + 'required' => false, + 'example' => 'Tag.1.Key=key1', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Tag value. The value range for n is [1, 20].', + 'type' => 'string', + 'required' => false, + 'example' => 'Tag.1.Value=value1', + 'title' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'NextToken' => [ + 'description' => 'The token for starting the next query', + 'type' => 'string', + 'example' => 'b949ae1f-01dc-4191-ae5a-70fbe6772fd8', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'TagResources' => [ + 'description' => 'List of resources', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'Resource type', + 'type' => 'string', + 'example' => 'instance', + 'title' => '', + ], + 'TagValue' => [ + 'description' => 'Tag value', + 'type' => 'string', + 'example' => 'value1', + 'title' => '', + ], + 'ResourceId' => [ + 'description' => 'Resource ID', + 'type' => 'string', + 'example' => 'b949ae1f-01dc-4191-ae5a-70fbe6772fd8', + 'title' => '', + ], + 'TagKey' => [ + 'description' => 'Tag key', + 'type' => 'string', + 'example' => 'key1', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => '[Deprecated] Query the relationship between resources and tags', + 'summary' => 'Query the relationship between resources and tags.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2024-07-24T07:36:09.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListTagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ListTags' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'docRequired' => true, + 'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'docRequired' => true, + 'example' => '8a4c6d3d-5ed6-44ca-b779-16c20f8862be', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code.', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message prompt', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded.', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'TagGroups' => [ + 'description' => 'List of tag groups', + 'items' => [ + 'properties' => [ + 'TagGroupId' => [ + 'description' => 'Tag Group ID', + 'example' => '38c03261-9fe8-4b9b-8c3b-983a60319012', + 'type' => 'string', + 'title' => '', + ], + 'TagGroupIndex' => [ + 'description' => 'Tag Group Index', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'TagGroup' => [ + 'description' => 'Tag Group Name', + 'example' => '当前学历', + 'type' => 'string', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID', + 'example' => '365b955d-6f4d-4ab5-a6e1-9a301307f4b1', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => 'List of tag groups', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'Tags' => [ + 'description' => 'List of tags', + 'items' => [ + 'properties' => [ + 'TagGroup' => [ + 'description' => 'Tag Group Name', + 'example' => '当前学历', + 'type' => 'string', + 'title' => '', + ], + 'TagName' => [ + 'description' => 'Tag Name', + 'example' => '本科', + 'type' => 'string', + 'title' => '', + ], + 'TagIndex' => [ + 'description' => 'Tag Index', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID', + 'example' => '8a4c6d3d-5ed6-44ca-b779-16c20f8862be', + 'type' => 'string', + 'title' => '', + ], + 'TagId' => [ + 'description' => 'Tag ID', + 'example' => 'd62be647-6202-4b1f-9708-0baeec552635', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query Tags under a Script – Legacy Canvas API', + 'summary' => 'Query tags under a script, legacy canvas API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', + ], + ], + [ + 'name' => 'AgentProfileId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'agent profile id', + 'description' => 'agent profile ID'."\n" + ."\n" + .'> You can obtain the agent profile ID of an already created scenario from the ChatbotId response parameter of the DescribeScript operation.', + 'type' => 'string', + 'required' => true, + 'example' => '37ca3ca1ac4b4e57adf3da5b5d939d04', + ], + ], + [ + 'name' => 'PromptJson', + 'in' => 'formData', + 'schema' => [ + 'title' => 'prompt json', + 'description' => 'agent configuration', + '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' => 'prompt (Professional mode)', + 'type' => 'string', + 'required' => false, + 'example' => '\\n名称：安妮 \\n身份：游戏推广员\\n背景：通过电话向玩家宣传最新福利活动，确保每一位玩家都能及时掌握信息，享受游戏的乐趣。\\n技能：作为游戏客服，向用户推荐限时游戏福利活动，强调福利亮点并告知参与流程。\\n约束条件：你需要记住你是安妮，来自于热门游戏客服团队，专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服，需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性，同时语言平易近人，确保玩家轻松理解活动内容。\\n明确活动的起止时间，确保玩家不会混淆。\\n强调活动的重点奖励和参与方式，提升玩家的参与兴趣。', + ], + ], + [ + 'name' => 'Model', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'model ID', + 'type' => 'string', + 'required' => false, + 'example' => 'model_001', + ], + ], + [ + 'name' => 'ModelConfig', + 'in' => 'formData', + 'schema' => [ + 'title' => 'model config', + 'description' => 'Model Configuration', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'VariablesJson', + 'in' => 'formData', + 'schema' => [ + 'title' => 'variables', + 'description' => 'Variable Configuration', + 'type' => 'string', + 'required' => false, + 'example' => '[{'."\n" + .' "name": "开始时间",'."\n" + .' "description": "开始时间"'."\n" + .'}, {'."\n" + .' "name": "结束时间",'."\n" + .' "description": "结束时间"'."\n" + .'}]', + ], + ], + [ + 'name' => 'LabelsJson', + 'in' => 'formData', + 'schema' => [ + 'title' => 'labels', + 'description' => 'Tag Description', + 'type' => 'string', + 'required' => false, + 'example' => '[{'."\n" + .' "name": "是否满意",'."\n" + .' "description": "对介绍的游戏内容是否感兴趣",'."\n" + .' "valueList": "[\\"有兴趣\\",\\"没兴趣\\"]"'."\n" + .'}]', + ], + ], + [ + 'name' => 'Scenario', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'scenario', + 'type' => 'string', + 'required' => false, + 'example' => '测试场景', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'Description', + 'type' => 'string', + 'required' => false, + 'example' => '第一版本提交审核', + ], + ], + [ + 'name' => 'InstructionJson', + 'in' => 'formData', + 'schema' => [ + 'description' => 'instruction configuration', + '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" + .'}]', + 'title' => '', + ], + ], + [ + 'name' => 'ApiPluginJson', + 'in' => 'formData', + 'schema' => [ + 'description' => 'API plugin configuration'."\n" + ."\n" + .'> If you need to attach multiple APIs, retrieve the UUIDs of the APIs by calling ListApiPlugins, and enter them in the format [{"uuid":"xxx"},{"uuid":"xxxx"},...].', + 'type' => 'string', + 'required' => false, + 'example' => '[{"uuid":"a55d171da96c41a************"},{"uuid":"d41a3e5195d1402********"}]', + 'title' => '', + ], + ], + [ + 'name' => 'FaqCategoryIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'FAQ Folder ID', + 'type' => 'array', + 'items' => [ + 'description' => 'FAQ Folder ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30000474726', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<AgentProfile>', + 'description' => 'BaseResponse<AgentProfile>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status Code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Returned data', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '', + 'description' => 'Creation Time', + 'type' => 'string', + 'example' => '1721356124220', + ], + 'UpdateTime' => [ + 'title' => '', + 'description' => 'Updated At', + 'type' => 'string', + 'example' => '1715416630.0', + ], + 'AgentProfileId' => [ + 'title' => 'agent profile id', + 'description' => 'Agent configuration ID ', + 'type' => 'string', + 'example' => '3d7d253cfb77476da0cf3681bcf7b4e8', + ], + 'InstanceId' => [ + 'title' => '', + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => '788066f2-f160-458e-a3bb-83e1c9d5606d', + ], + 'ScriptId' => [ + 'title' => 'script id', + 'description' => 'Scenario 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' => 'Agent configuration ', + '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' => 'Prompt (Professional Mode)', + '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' => '', + 'description' => 'Model ID', + 'type' => 'string', + 'example' => 'model_002', + ], + 'ModelConfig' => [ + 'title' => 'model config', + 'description' => 'Model Configuration ', + 'type' => 'string', + 'example' => '""', + ], + 'System' => [ + 'title' => '', + 'description' => 'Indicates whether it is a system template. ', + 'type' => 'boolean', + 'example' => 'true', + ], + 'LabelsJson' => [ + 'title' => 'labels', + 'description' => 'Tag Description', + 'type' => 'string', + 'example' => '[{'."\n" + .' "name": "是否满意",'."\n" + .' "description": "对介绍的游戏内容是否感兴趣",'."\n" + .' "valueList": "[\\"有兴趣\\",\\"没兴趣\\"]"'."\n" + .'}]', + ], + 'VariablesJson' => [ + 'title' => 'variables', + 'description' => 'Variable configuration', + 'type' => 'string', + 'example' => '[{'."\n" + .' "name": "开始时间",'."\n" + .' "description": "开始时间"'."\n" + .'}, {'."\n" + .' "name": "结束时间",'."\n" + .' "description": "结束时间"'."\n" + .'}]', + ], + 'Scenario' => [ + 'title' => '', + 'description' => 'Scenario ', + 'type' => 'string', + 'example' => 'default', + ], + 'Description' => [ + 'title' => '', + 'description' => 'Description', + 'type' => 'string', + 'example' => '这是一个大模型场景', + ], + 'InstructionJson' => [ + 'description' => 'Instruction Configuration', + '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" + .'}]', + 'title' => '', + ], + 'ApiPluginJson' => [ + 'description' => 'API plugin configuration ', + 'type' => 'string', + 'example' => '[]', + 'title' => '', + ], + 'NluConfigJson' => [ + 'description' => 'NLU configuration, parameter configuration:'."\n" + ."\n" + .'- chatbotInstanceId: instance ID of the Xiaomi LLM chatbot'."\n" + .'- faqCategoryIds: IDs of attached FAQ categories'."\n" + .'- llmAgentId: Workspace ID of the Xiaomi LLM'."\n" + .'- llmAgentKey: Workspace key of the Xiaomi LLM'."\n" + .'- llmAgentInstanceId: Instance ID of the Xiaomi LLM workspace', + '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" + .'}', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Modify Agent Configuration', + 'summary' => 'Modify the agent configuration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyAgentProfile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ModifyAnnotationMission' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '129327', + 'abilityTreeNodes' => [ + 'FEATUREoutboundbotQHO52V', + ], + ], + 'parameters' => [ + [ + 'name' => 'AnnotationMissionId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Annotation job ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'c88cc004-de69-4eee-aa5f-2efed533a54e', + ], + ], + [ + 'name' => 'AnnotationMissionName', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Annotation job name.', + 'type' => 'string', + 'required' => false, + 'example' => '询问卖车-标注任务-20230506-112934', + ], + ], + [ + 'name' => 'AnnotationStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Annotation job status', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'enumValueTitles' => [ + 1 => ' 进行中', + ' 已完成', + ' 已关闭', + ], + ], + ], + [ + 'name' => 'Delete', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Delete the job.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<ModifyAnnotationMissionResponse>', + 'description' => 'BaseResponse<ModifyAnnotationMissionResponse>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the invocation succeeded. true: The invocation succeeded. false: Failed to invoke.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'The operation is not allowed. User state (DIALING) does not meet expectations (READY).', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Returned data', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => 'The operation is not allowed. User state (DIALING) does not meet expectations (READY).', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Modify Annotation Job', + 'summary' => 'Modify the status and name of an annotation job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyAnnotationMission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ModifyBatchJobs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job group ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c6a668d1-3145-4048-9101-cb3678bb8884', + 'title' => '', + ], + ], + [ + 'name' => 'BatchJobName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job name', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '催收作业组', + 'title' => '', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'Description of the job group', + 'type' => 'string', + 'required' => false, + 'example' => '这是催收作业组-01', + 'title' => '', + ], + ], + [ + 'name' => 'ScenarioId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'c6a668d1-3145-4048-9101-cb3678bb8884', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'Policy in JSON format', + '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}', + 'title' => '', + ], + ], + [ + 'name' => 'JobFilePath', + 'in' => 'query', + 'schema' => [ + 'description' => 'Download URL of the job Excel file', + 'type' => 'string', + 'required' => false, + 'example' => '52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx', + 'title' => '', + ], + ], + [ + 'name' => 'Submitted', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to submit the job. If false, the job is submitted. If true, it is saved as a draft.', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'type' => 'string', + 'required' => false, + 'example' => '7d820242-f4f0-4d2e-ae35-b424c41cbc5b', + 'title' => '', + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Calling numbers', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'Calling number', + 'required' => false, + 'example' => '["0591***212"]', + 'title' => '', + ], + 'required' => false, + 'example' => '["95187"]', + 'maxItems' => 99, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'HTTP status code of the API', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'JobGroup' => [ + 'description' => 'Job group information', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'Creation Time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579068424000', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Job group ID', + 'type' => 'string', + 'example' => '5a7e8b09-baf9-4cab-b540-c971f47a7146', + 'title' => '', + ], + 'ScenarioId' => [ + 'description' => 'Scenario ID.', + 'type' => 'string', + 'example' => '6cea9bed-63e6-439e-ae4c-b3333efff53d', + 'title' => '', + ], + 'JobGroupName' => [ + 'description' => 'Job group name', + 'type' => 'string', + 'example' => '第一个催收作业组', + 'title' => '', + ], + 'JobFilePath' => [ + 'description' => 'File key of the uploaded job file', + 'type' => 'string', + 'example' => '52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx', + 'title' => '', + ], + 'JobGroupDescription' => [ + 'description' => 'Job group description', + 'type' => 'string', + 'example' => '第一个催收作业组', + 'title' => '', + ], + 'CallingNumbers' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'List of calling numbers', + 'type' => 'string', + 'example' => '["1****6"]', + 'title' => '', + ], + 'description' => 'List of calling numbers', + 'title' => '', + 'example' => '', + ], + 'Strategy' => [ + 'description' => 'Execution policy', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Policy Type.', + 'type' => 'string', + 'example' => 'Repeatable', + 'title' => '', + ], + 'StrategyName' => [ + 'description' => 'Policy Name.', + 'type' => 'string', + 'example' => '催收策略', + 'title' => '', + ], + 'MaxAttemptsPerDay' => [ + 'description' => 'Maximum number of retry attempts per day after a failure', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'title' => '', + ], + 'FollowUpStrategy' => [ + 'description' => 'Follow-up handling method after the epoch ends.', + 'type' => 'string', + 'example' => 'CONTINUE', + 'title' => '', + ], + 'EndTime' => [ + 'description' => 'End Time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2209702074000', + 'title' => '', + ], + 'Customized' => [ + 'description' => 'Custom policy data.', + 'type' => 'string', + 'example' => '{}', + 'title' => '', + ], + 'IsTemplate' => [ + 'description' => 'Indicates whether it is a template', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'Start Time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578550074000', + 'title' => '', + ], + 'StrategyId' => [ + 'description' => 'Policy ID.', + 'type' => 'string', + 'example' => 'f718798d-96be-40e4-bef6-317b54855708', + 'title' => '', + ], + 'RoutingStrategy' => [ + 'description' => 'Number routing policy.', + 'type' => 'string', + 'example' => 'LocalFirst', + 'title' => '', + ], + 'MinAttemptInterval' => [ + 'description' => 'Recency between repeated attempts.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'StrategyDescription' => [ + 'description' => 'Policy description', + 'type' => 'string', + 'example' => '催收作业执行策略', + 'title' => '', + ], + 'RepeatBy' => [ + 'description' => 'Method of repeat execution.', + 'type' => 'string', + 'example' => 'Once', + 'title' => '', + ], + 'WorkingTime' => [ + 'description' => 'Time segments during which the policy is executed', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'End time.', + 'type' => 'string', + 'example' => '1581997093000', + 'title' => '', + ], + 'BeginTime' => [ + 'description' => 'Start Time.', + 'type' => 'string', + 'example' => '1581937093000', + 'title' => '', + ], + ], + 'description' => 'Time segment during which the policy is executed', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RepeatDays' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'Days for repeated execution', + 'type' => 'string', + 'example' => '[1,2,3,4,5]', + 'title' => '', + ], + 'description' => 'Days for repeated execution', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Modify a job group (including jobs) – Deprecated', + 'summary' => 'Modifies a job (including the job itself). This operation is deprecated.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyBatchJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ModifyBeebotIntent' => [ + 'summary' => 'ModifyBeebotIntent', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10717802', + 'title' => '', + ], + ], + [ + 'name' => 'IntentDefinition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Intent definition', + 'type' => 'object', + 'properties' => [ + 'IntentName' => [ + 'description' => 'Intent name', + 'type' => 'string', + 'required' => true, + 'example' => '知道了么', + 'title' => '', + ], + 'AliasName' => [ + 'description' => 'Intent alias', + 'type' => 'string', + 'required' => false, + 'example' => '嗯明白了', + 'title' => '', + ], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Response information', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP return code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '8785D26A-7406-50A1-9653-1313C292E23B', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'BeebotRequestId' => [ + 'description' => 'Internal request ID', + 'type' => 'string', + 'example' => 'A1F21BF2-CB21-1968-8039-C74699E7DDEB', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'IntentId' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10717802', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Small Model API] Modify Beemind Bot Intent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyBeebotIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ModifyBeebotIntentLgf' => [ + 'summary' => 'ModifyBeebotIntentLgf', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'LgfId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Utterance template ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5666117', + 'title' => '', + ], + ], + [ + 'name' => 'LgfDefinition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Utterance template definition', + 'type' => 'object', + 'properties' => [ + 'IntentId' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10717802', + 'title' => '', + ], + 'RuleText' => [ + 'description' => 'Intent configuration', + 'type' => 'string', + 'required' => true, + 'example' => '我是一个问法模版'."\n", + 'title' => '', + ], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '302C67BD-19FF-5B66-A45D-F95544604155', + 'title' => '', + ], + 'LgfId' => [ + 'description' => 'Utterance template ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5666117', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'BeebotRequestId' => [ + 'description' => 'Internal request ID', + 'type' => 'string', + 'example' => 'A1F21BF2-CB21-1968-8039-C74699E7DDEB', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Small Model API] Modify the Beebot intent utterance template', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyBeebotIntentLgf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ModifyBeebotIntentUserSay' => [ + 'summary' => 'ModifyBeebotIntentUserSay', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'UserSayId', + 'in' => 'query', + 'schema' => [ + 'description' => 'User utterance ID', + 'type' => 'string', + 'required' => true, + 'example' => '17448458', + 'title' => '', + ], + ], + [ + 'name' => 'UserSayDefinition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'User utterance definition', + 'type' => 'object', + 'properties' => [ + 'IntentId' => [ + 'description' => 'Intent ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10717802', + 'title' => '', + ], + 'Content' => [ + 'description' => 'User utterance content', + 'type' => 'string', + 'required' => true, + 'example' => '你知道xxxxx么？'."\n", + 'title' => '', + ], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Response content', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'UserSayId' => [ + 'description' => 'User utterance ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17448458', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'BeebotRequestId' => [ + 'description' => 'Internal request ID', + 'type' => 'string', + 'example' => 'A1F21BF2-CB21-1968-8039-C74699E7DDEB', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Small Model API] Modify Beebot intent user utterances', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyBeebotIntentUserSay', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Instance ID', + 'docRequired' => true, + 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'docRequired' => true, + 'example' => 'b0f35dd1-0337-402e-9c4f-3a6c2426950a', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'DialogueFlowId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Conversation flow ID', + 'docRequired' => true, + 'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'DialogueFlowDefinition', + 'in' => 'query', + 'schema' => [ + 'description' => 'Conversation flow Data', + '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}]}', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'IsDrafted', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether the flow is in Draft status', + 'docRequired' => true, + 'example' => 'true', + 'required' => false, + 'type' => 'boolean', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'DialogueFlowDefinition' => [ + 'description' => 'Conversation flow Data', + '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}]}', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request Succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'DialogueFlowId' => [ + 'description' => 'Conversation flow ID', + 'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf', + 'type' => 'string', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Succcess', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Modify a conversation flow—Legacy canvas API', + 'summary' => 'Modify a conversation flow using the legacy canvas API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:SaveDialogueFlow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ModifyEmptyNumberNoMoreCallsInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '94146', + 'abilityTreeNodes' => [ + 'FEATUREoutboundbotVYZEH6', + ], + ], + 'parameters' => [ + [ + 'name' => 'EntryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'docRequired' => true, + 'example' => '6cc9f5ca-2cb6-4cc7-a46b-2bbfd3e61b22', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Policy level. The default value is 2 for business instances.'."\n" + ."\n" + .'- 0: System '."\n" + .'- 1: Tenant '."\n" + .'- 2: Instance', + 'example' => '2', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'EmptyNumberNoMoreCalls', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether to stop outbound calls to nonexistent numbers', + 'example' => 'true', + 'required' => false, + 'type' => 'boolean', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Deprecated] Save the toggle for the feature that stops outbound calls to nonexistent numbers at the global dimension', + 'summary' => 'Save the toggle for the feature that stops outbound calls to nonexistent numbers at the global dimension.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyEmptyNumberNoMoreCallsInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ModifyGlobalQuestion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0fe7f71c-8771-42ef-9bb1-19aa16ae7120', + 'title' => '', + ], + ], + [ + 'name' => 'GlobalQuestionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Global question ID. This parameter is the unique value of the source global question.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ad80de88-1661-445a-92ec-bf88dc45d581', + 'title' => '', + ], + ], + [ + 'name' => 'GlobalQuestionName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Global question name', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '未识别全局问题', + 'title' => '', + ], + ], + [ + 'name' => 'GlobalQuestionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Global question type', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'COMMON', + 'title' => '', + ], + ], + [ + 'name' => 'Questions', + 'in' => 'query', + 'schema' => [ + 'description' => 'List of questions', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["你是谁","你叫什么"]', + 'title' => '', + ], + ], + [ + 'name' => 'Answers', + 'in' => 'query', + 'schema' => [ + 'description' => 'List of response scripts', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["你好,我是你的专属客服顾问."]', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'DialogueQuestionId' => [ + 'description' => 'Global question ID', + 'type' => 'string', + 'example' => 'ad80de88-1661-445a-92ec-bf88dc45d581', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Legacy Canvas API] Modify a Global Question', + 'summary' => 'Modify a global question in the legacy canvas API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyGlobalQuestion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ModifyInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business instance ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business instance name.', + 'type' => 'string', + 'required' => false, + 'example' => '新实例', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business instance description.', + 'type' => 'string', + 'required' => false, + 'example' => '这是新的实例', + 'title' => '', + ], + ], + [ + 'name' => 'MaxConcurrentConversation', + 'in' => 'query', + 'schema' => [ + 'description' => 'Maximum concurrent conversations.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '5', + 'title' => '', + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of calling numbers.'."\n" + ."\n" + .'> Leave empty by default.', + 'type' => 'array', + 'items' => [ + 'description' => 'Calling number.'."\n" + ."\n" + .'> Leave empty by default.', + 'type' => 'string', + 'required' => false, + 'example' => '1**********', + 'title' => '', + ], + 'required' => false, + 'example' => '["95187"]', + 'maxItems' => 99, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Instance' => [ + 'description' => 'Business instance information.', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'Creation Time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578469042851', + 'title' => '', + ], + 'InstanceName' => [ + 'description' => 'Business instance name.', + 'type' => 'string', + 'example' => '第一个实例', + 'title' => '', + ], + 'CreatorName' => [ + 'description' => 'Creator name.', + 'type' => 'string', + 'example' => 'xxx', + 'title' => '', + ], + 'MaxConcurrentConversation' => [ + 'description' => 'Maximum concurrent conversations.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + 'title' => '', + ], + 'OwnerName' => [ + 'description' => 'Owner name.', + 'type' => 'string', + 'example' => 'xxx', + 'title' => '', + ], + 'CreatorId' => [ + 'description' => 'Creator ID.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123123', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Business instance ID.', + 'type' => 'string', + 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', + 'title' => '', + ], + 'InstanceDescription' => [ + 'description' => 'Business instance description.', + 'type' => 'string', + 'example' => '这是第一个实例', + 'title' => '', + ], + ], + 'example' => '{\'InstanceId\': \'ob369xifpi2074\', \'AutoUpgradeObVersion\': False}', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Modify a business instance', + 'summary' => 'Modify an Intelligent Outbound Calling business instance.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ModifyIntent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID.', + 'docRequired' => true, + 'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3'."\n", + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'docRequired' => true, + 'example' => '9b70486f-b1c2-429c-8a24-62798015ab1b', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'IntentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent ID', + 'docRequired' => true, + 'example' => '3b9a2b33-50d4-4576-8c68-22498f4bf731', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'IntentName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent name', + 'docRequired' => true, + 'example' => '车险如何办理', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'IntentDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intent description', + 'example' => '询问车险意图', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'Utterances', + 'in' => 'query', + 'schema' => [ + 'description' => 'User utterances', + 'docRequired' => true, + 'example' => '["车险如何办理"]', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'Keywords', + 'in' => 'query', + 'schema' => [ + 'description' => 'Keyword', + 'example' => '[]', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded.', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'IntentId' => [ + 'description' => 'Intent ID', + 'example' => '3b9a2b33-50d4-4576-8c68-22498f4bf731', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Modify Intent – Legacy Canvas API', + 'summary' => 'Modify an intent in a legacy canvas scenario using the legacy canvas API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ModifyJobGroup' => [ + 'summary' => 'Modify an Intelligent outbound calling job.', + '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' => 'Instance ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '3edc0260-6f7c-4de4-8535-09372240618b', + 'title' => '', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job name.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '修改后的作业组', + 'title' => '', + ], + ], + [ + 'name' => 'ScenarioId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID. (This is a legacy parameter; use ScriptId going forward.)'."\n" + ."\n" + .'> This parameter is now deprecated. You can pass any value, but it is recommended to keep it consistent with scriptId.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'c6a668d1-3145-4048-9101-cb3678bb8884', + 'title' => '', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job description.', + 'type' => 'string', + 'required' => false, + 'example' => '修改后的作业组', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task execution policy.'."\n" + ."\n" + .'- repeatBy: Recurrence type. Once (no recurrence), Day (daily recurrence), Week (weekly recurrence), Month (monthly recurrence).'."\n" + .'- startTime: Start time of the policy.'."\n" + .'- endTime: End time of the policy.'."\n" + .'- workingTime: Allowed outbound calling time segment.'."\n" + .'- maxAttemptsPerDay: Maximum number of call attempts per day for each number under this job.'."\n" + .'- minAttemptInterval: Minimum interval between retry calls for a number, in minutes.'."\n" + .'- routingStrategy: Number routing strategy. None (not specified), LocalFirst (prioritize numbers from the same city), LocalProvinceFirst (prioritize numbers from the same province).'."\n" + .'- repeatDays: Execution dates corresponding to the recurrence type. If repeatBy is Week, 0 represents Sunday and 1–6 represent Monday through Saturday respectively. If repeatBy is Month, values 1–31 represent the 1st through the 31st day of the month; months without the specified date will skip execution (for example, if the 30th is selected, February will not execute).'."\n" + .'- repeatable: Whether loop task is enabled, 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", + 'title' => '', + ], + ], + [ + 'name' => 'RecallStrategyJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'Redial strategy JSON', + 'type' => 'string', + 'required' => false, + 'example' => '{"emptyNumberIgnore":false,"inArrearsIgnore":false,"outOfServiceIgnore":false}', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario script ID.', + 'type' => 'string', + 'required' => false, + 'example' => '5a3940ce-a12f-4222-9f0f-605a9b89ea7c', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Calling number.', + 'type' => 'array', + 'items' => [ + 'description' => 'Calling number.', + 'type' => 'string', + 'required' => false, + 'example' => '4008013260', + 'title' => '', + ], + 'required' => false, + 'maxItems' => 99, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'JobGroupStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task status. Valid values:'."\n" + .'- Draft: Draft.'."\n" + .'- Paused: Paused.', + 'type' => 'string', + 'required' => true, + 'example' => 'Draft', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'RingingDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'Optimal ringing duration.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '25', + 'title' => '', + ], + ], + [ + 'name' => 'MinConcurrency', + 'in' => 'query', + 'schema' => [ + 'description' => 'Minimum concurrency guarantee '."\n" + .'When the job starts, at least N concurrent calls are guaranteed. '."\n" + .'The sum of minimum concurrency guarantees for jobs with the same priority must not exceed the instance\'s maximum concurrency. '."\n" + .'If the minimum concurrency guarantee is set to 0, the system intelligently assigns available idle concurrency.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job group priority. Valid values:'."\n" + .'- **Urgent**: Urgent job.'."\n" + .'- **Daily**: Daily job.', + 'type' => 'string', + 'required' => false, + 'example' => 'Daily', + 'title' => '', + ], + ], + [ + 'name' => 'FlashSmsExtras', + 'in' => 'query', + 'schema' => [ + 'description' => 'Configuration parameters for flash SMS push, in JSON format, containing third-party flash SMS configuration information.'."\n" + ."\n" + .'templateId: Flash SMS template ID. '."\n" + .'configId: Flash SMS configuration ID.', + 'type' => 'string', + 'required' => false, + 'example' => '{"templateId":"10471","configId":"8037f524-6ff2-4dbe-bb28-f59234ea7a64"}'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'RecallCallingNumber', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'maxItems' => 99, + 'description' => 'List of redial calling numbers', + 'type' => 'array', + 'items' => [ + 'description' => 'Redial calling number', + 'type' => 'string', + 'required' => false, + 'example' => '4008013260', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code.', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message.', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'JobGroup' => [ + 'description' => 'Job information.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Status.', + 'type' => 'string', + 'example' => 'Scheduling', + 'title' => '', + ], + 'ScenarioId' => [ + 'description' => 'Scenario ID. '."\n" + ."\n" + .'> The parameter returned here is historical. The actual ScriptID can be obtained from the DescribeJobGroup API.', + 'type' => 'string', + 'example' => '6cea9bed-63e6-439e-ae4c-b3333efff53d', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Job ID.', + 'type' => 'string', + 'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9', + 'title' => '', + ], + 'CreationTime' => [ + 'description' => 'Creation Time'."\n" + ."\n" + .'> Can be returned by the DescribeJobGroup API.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578550074361', + 'title' => '', + ], + 'JobGroupName' => [ + 'description' => 'Job name.', + 'type' => 'string', + 'example' => '第一个催收', + 'title' => '', + ], + 'JobFilePath' => [ + 'description' => 'OSS storage path of the job file. [Deprecated]', + 'type' => 'string', + 'example' => 'UPLOADED/JOB/d481cebe-0bb6-4d13-9649-42ce5074fb75/6c7d9132-98e1-4f08-8a76-8a266c7532fd_job_template - 副本.xlsx', + 'title' => '', + ], + 'JobGroupDescription' => [ + 'description' => 'Job description.', + 'type' => 'string', + 'example' => '催收的作业组', + 'title' => '', + ], + 'JobDataParsingTaskId' => [ + 'description' => 'The parsing task ID corresponding to the outbound calling job file. [Deprecated]', + 'type' => 'string', + 'example' => 'e37d28cb-0413-4816-85ed-fd354d025ea3', + 'title' => '', + ], + 'ScriptName' => [ + 'description' => 'Script Name.', + 'type' => 'string', + 'example' => '话术', + 'title' => '', + ], + 'ScriptVersion' => [ + 'description' => 'Script version.', + 'type' => 'string', + 'example' => '1628425608429', + 'title' => '', + ], + 'ModifyTime' => [ + 'description' => 'Updated At. '."\n" + .'> This can be returned by the DescribeJobGroup API.', + 'type' => 'string', + 'example' => '1628425608429', + 'title' => '', + ], + 'CallingNumbers' => [ + 'description' => 'List of calling numbers.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of calling numbers.', + 'type' => 'string', + 'example' => '["4008013260"]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ExportProgress' => [ + 'description' => 'Export information (historical parameter, no longer used).', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Status', + 'type' => 'string', + 'example' => 'FINISHED', + 'title' => '', + ], + 'FileHttpUrl' => [ + 'description' => 'File URL', + 'type' => 'string', + 'example' => 'https://***.oss-cn-shanghai.aliyuncs.com/sample', + 'title' => '', + ], + 'Progress' => [ + 'description' => 'Progress', + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Strategy' => [ + 'description' => 'Outbound call policy.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Policy Type.', + 'type' => 'string', + 'example' => 'Repeatable', + 'title' => '', + ], + 'StrategyName' => [ + 'description' => 'Policy Name.', + 'type' => 'string', + 'example' => '催收策略', + 'title' => '', + ], + 'MaxAttemptsPerDay' => [ + 'description' => 'Maximum number of attempts per day.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + 'title' => '', + ], + 'FollowUpStrategy' => [ + 'description' => 'Handling method after the execution epoch ends (historical parameter, no longer used).', + 'type' => 'string', + 'example' => 'CONTINUE', + 'title' => '', + ], + 'EndTime' => [ + 'description' => 'End Time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2209702074000', + 'title' => '', + ], + 'Customized' => [ + 'description' => 'Custom policy data (historical parameter, no longer used).', + 'type' => 'string', + 'example' => '{}', + 'title' => '', + ], + 'IsTemplate' => [ + 'description' => 'Indicates whether it is a template (historical parameter, no longer used).', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'StartTime' => [ + 'description' => 'Start Time.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578550074000', + 'title' => '', + ], + 'StrategyId' => [ + 'description' => 'Policy ID.', + 'type' => 'string', + 'example' => 'f718798d-96be-40e4-bef6-317b54855708', + 'title' => '', + ], + 'RoutingStrategy' => [ + 'description' => 'Number routing policy.', + 'type' => 'string', + 'example' => 'LocalFirst', + 'title' => '', + ], + 'MinAttemptInterval' => [ + 'description' => 'Recency between retries after a failure.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'StrategyDescription' => [ + 'description' => 'Policy description.', + 'type' => 'string', + 'example' => '催收作业执行策略', + 'title' => '', + ], + 'RepeatBy' => [ + 'description' => 'Repeat execution mode: Once for no repeat, Day for daily repeat, Week for weekly repeat, Month for monthly repeat.', + 'type' => 'string', + 'example' => 'Once', + 'title' => '', + ], + 'WorkingTime' => [ + 'description' => 'Time periods during which outbound calls are allowed.', + 'type' => 'array', + 'items' => [ + 'description' => 'Working time period.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'End Time.', + 'type' => 'string', + 'example' => '12:00:00', + 'title' => '', + ], + 'BeginTime' => [ + 'description' => 'Start Time.', + 'type' => 'string', + 'example' => '09:00:00', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RepeatDays' => [ + 'description' => 'Days for repeated execution.'."\n" + ."\n" + .'If the recurrence RepeatBy is set to week, 0 represents Sunday, and 1–6 represent Monday through Saturday, respectively. '."\n" + .'If the recurrence RepeatBy is set to month, 1–31 represent the 1st through the 31st day of the month. Months that do not contain the specified date will not execute the task. For example, if the 30th is selected, the task will not run in February.', + 'type' => 'array', + 'items' => [ + 'description' => 'Days for repeated execution.', + 'type' => 'string', + 'example' => '[1,2,3,4,5]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'RecallStrategy' => [ + 'description' => 'Recall policy', + 'type' => 'object', + 'properties' => [ + 'EmptyNumberIgnore' => [ + 'description' => 'Do not make outbound calls to nonexistent numbers.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'InArrearsIgnore' => [ + 'description' => 'Do not make outbound calls for overdue payment numbers.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'OutOfServiceIgnore' => [ + 'description' => 'Do not make outbound calls to numbers that are out of service.', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'RingingDuration' => [ + 'description' => 'Ringing duration.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25', + 'title' => '', + ], + 'Priority' => [ + 'description' => 'Job group priority. Valid values: '."\n" + ."\n" + .'Urgent: urgent job. '."\n" + .'Daily: daily job.', + 'type' => 'string', + 'example' => 'Daily', + 'title' => '', + ], + 'MinConcurrency' => [ + 'description' => 'Concurrent guarantee value. '."\n" + .'When the job starts, it guarantees a minimum of N concurrent calls. '."\n" + .'The sum of concurrent guarantee values for jobs with the same priority must not exceed the instance concurrency limit. '."\n" + .'If the concurrent guarantee value is set to 0, the system intelligently assigns available idle concurrency.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + 'FlashSmsExtras' => [ + 'description' => 'Configuration parameters for flash SMS push, in JSON format, containing configuration information for third-party flash SMS.'."\n" + ."\n" + .'templateId: Flash SMS template ID. '."\n" + .'configId: Flash SMS configuration ID.', + 'type' => 'string', + 'example' => '{"configId":"3157b3c8-3a3e-4ea9-894b-9c8a6", "templateId":"1234"}', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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 \\"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}","type":"json"}]', + 'title' => 'Modify job data', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-06-24T02:14:42.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-01-04T12:35:21.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2021-12-22T12:30:34.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2021-12-22T12:30:34.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyJobGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ModifyOutboundCallNumber' => [ + 'summary' => 'Modifies the outbound call number. This API is deprecated.', + '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' => 'Instance ID', + 'docRequired' => true, + 'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'Number', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number to be modified', + 'docRequired' => true, + 'example' => '10088xxx', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'RateLimitPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'Time Range for Rate Limiting, in seconds', + 'docRequired' => true, + 'example' => '100', + 'format' => 'int32', + 'required' => true, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'RateLimitCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'Count of Rate Limiting rules', + 'docRequired' => true, + 'example' => '10', + 'format' => 'int32', + 'required' => true, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'OutboundCallNumberId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number ID ', + 'docRequired' => true, + 'example' => 'fa0e21e9-caab-4629-9121-1e341243d599', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'OutboundCallNumber' => [ + 'description' => 'Number information', + 'properties' => [ + 'Number' => [ + 'description' => 'Outbound call number', + 'example' => '10088xxxx', + 'type' => 'string', + 'title' => '', + ], + 'OutboundCallNumberId' => [ + 'description' => 'Number ID', + 'example' => 'fa0e21e9-caab-4629-9121-1e341243d599', + 'type' => 'string', + 'title' => '', + ], + 'RateLimitCount' => [ + 'description' => 'Rate Limiting epoch', + 'example' => '10', + 'type' => 'string', + 'title' => '', + ], + 'RateLimitPeriod' => [ + 'description' => 'Rate Limiting count', + 'example' => '100', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Modify Outbound Call Number – Deprecated', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyCabOutboundCallNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ModifyScript' => [ + 'summary' => 'Modify script information.', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c6320d3c-fa45-4011-b3b1-acdfabe3a8c6', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c153d0d8-ba04-41c0-8632-453944c9dd0b', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script name', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '续费提醒', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script description', + 'type' => 'string', + 'required' => false, + 'example' => '返工回访话术', + 'title' => '', + ], + ], + [ + 'name' => 'Industry', + 'in' => 'query', + 'schema' => [ + 'description' => 'Industry', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '电商', + 'title' => '', + ], + ], + [ + 'name' => 'Scene', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario information', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '回访', + 'title' => '', + ], + ], + [ + 'name' => 'ChatbotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Chatbot ID', + 'type' => 'string', + 'required' => false, + 'example' => 'chatbot-cn-iFZfi7eq6e', + 'title' => '', + ], + ], + [ + 'name' => 'AsrConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'ASR configuration, parameter definitions'."\n" + ."\n" + .'- **appKey**: Alibaba Cloud account appKey. '."\n" + .'- **maxEndSilence**: Speech endpoint detection duration. '."\n" + .'- **silenceTimeout**: Silence timeout in seconds. The session times out after the user remains silent for N seconds. '."\n" + ."\n" + .'- **engine**: Service to invoke; options are [`ali`, `xunfei`]. '."\n" + .'- **nlsServiceType**: Service type to invoke: '."\n" + .' - **Managed**: Public cloud NLS service. '."\n" + .' - **Authorized**: Authorized NLS service. '."\n" + .' - **Provided**: NLS service provided by the customer using AccessKey/SecretKey. '."\n" + .' - **Apes**: Private Cloud service. '."\n" + .'- **engineXunfei**: Configuration required when the engine is set to `xunfei`. '."\n" + .'> When `engine` is set to `ali` and `nlsServiceType` is `Authorized`, a custom service provided by `ali` is used. When `engine` is `ali` and `nlsServiceType` is `Managed`, the default service is used. When `engine` is `xunfei` and `nlsServiceType` is `Authorized`, the service provider is `xunfei`, and the following `xunfei` configuration must be provided: `{"uuid":"ed2xxxxxxxxx","globalMaxEndSilence":700,"globalMaxEndSilenceEnable":true}`.'."\n" + ."\n" + .'- **globalMaxEndSilence**: Silence detection threshold, in milliseconds. '."\n" + ."\n" + .'- **globalMaxEndSilenceEnable**: Toggle for silence detection. Enabled by default. '."\n" + ."\n" + .'- **speechNoiseThreshold**: Noise filtering threshold. '."\n", + '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" + .'}', + 'title' => '', + ], + ], + [ + 'name' => 'TtsConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'TTS configuration parameters'."\n" + ."\n" + .'- **voice**: Speaker.'."\n" + .'- **volume**: Volume, range: 0–100. Default value: 50.'."\n" + .'- **speechRate**: Speech rate, range: -500–500. Default value: 0.'."\n" + .'- **pitchRate**: Pitch, range: -500–500. Default value: 0.'."\n" + ."\n" + .'- **globalInterruptible**: Speech interruption configuration.'."\n" + .'- **engine**: Invoked service; options: [ali, volc, xunfei]. xunfei is not supported in LLM scenarios.'."\n" + .'- **nlsServiceType**: Service type for invocation'."\n" + .' - Managed: Public cloud NLS service'."\n" + .' - Authorized: Authorized NLS service'."\n" + .' - Provided: Customer-provided NLS service via AccessKey/SecretKey'."\n" + .' - Apes: Private Cloud service'."\n" + .'- **engineXunfei**: Configuration when the service provider is xunfei.'."\n" + ."\n" + .'> 1. When engine is set to ali and nlsServiceType is Authorized, a custom service is used. '."\n" + .'> 2. When the service provider is ali, engine is ali, and nlsServiceType is Managed, the default service is used. '."\n" + .'> 3. When engine is xunfei (applicable only to small-model scenarios) and nlsServiceType is Authorized, the service provider is xunfei, and engineXunfei must be configured as {"pitchRate":50,"speechRate":50,"voice":"aisjiuxu","volume":50}. '."\n" + .'> 4. When engine is volc and nlsServiceType is Authorized, the service used is 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" + .'}', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptContent', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'For notification-type instances, pass a list of scripts. '."\n" + .'Deprecated.', + 'type' => 'array', + 'items' => [ + 'description' => 'For notification-type instances, pass a list of scripts. '."\n" + .'Deprecated.', + 'type' => 'string', + 'required' => false, + 'example' => '您好，您昨晚在李佳琦直播间下单的娜薇诗椰子水二代精华2支装还未付款，超时未支付会自动关闭订单，活动错过不再有奥。', + 'title' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ScriptWaveform', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Deprecated. Previously used to pass a list of voice prompts for notification-type instances. ', + 'type' => 'array', + 'items' => [ + 'description' => 'Deprecated. Previously used to pass a list of voice prompts for notification-type instances. ', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'title' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'NewBargeInEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Graceful interruption toggle (for small models)', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'LongWaitEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Intelligent sentence segmentation toggle (small model)', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'MiniPlaybackEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Follow-up utterance configuration toggle (small model)', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'MiniPlaybackConfigListJsonString', + 'in' => 'query', + 'schema' => [ + 'description' => 'Tone transition configuration. Customization is not currently supported, and this parameter does not need to be passed by default. (Deprecated)', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'title' => '', + ], + ], + [ + 'name' => 'NlsConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'Deprecated', + 'type' => 'string', + 'required' => false, + 'example' => '无', + 'title' => '', + ], + ], + [ + 'name' => 'EmotionEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Emotion detection configuration toggle', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'Access key for the robot workspace ', + 'type' => 'string', + 'required' => false, + 'example' => '9137ab9c27044921860030adf8590ec4_p_outbound_public', + 'title' => '', + ], + ], + [ + 'name' => 'AgentLlm', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether the chatbot workspace is an LLM workspace', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Robot workspace ID'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1198938', + 'title' => '', + ], + ], + [ + 'name' => 'NluEngine', + 'in' => 'query', + 'schema' => [ + 'description' => 'NLU engine (applicable only to LLM scenarios)'."\n" + ."\n" + .'> The scenario pattern cannot be modified after the scenario is created.'."\n" + ."\n" + .'Enumeration:'."\n" + .'- Prompts: Text-filling pattern.'."\n" + .'- SSE_FUNCTION: Function Compute pattern.'."\n" + .'- Empty for non-LLM scenarios.', + 'type' => 'string', + 'required' => false, + 'example' => 'Prompts', + 'title' => '', + ], + ], + [ + 'name' => 'NluAccessType', + 'in' => 'query', + 'schema' => [ + 'description' => 'NLU access method (applicable only to LLM scenarios)'."\n" + ."\n" + .'Enumeration:'."\n" + .'- Managed: Access using Alibaba public account.'."\n" + .'- Empty for non-LLM scenarios.', + 'type' => 'string', + 'required' => false, + 'example' => 'Managed', + 'title' => '', + ], + ], + [ + 'name' => 'ChatConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'Call configuration '."\n" + .'- **silenceConfig**: Silence configuration '."\n" + .' - **silenceReplyTimeout**: Silence reply timeout, in milliseconds. '."\n" + .' - **silenceTimeoutMaxCount**: Number of consecutive silence timeouts after which the call is disconnected. '."\n" + .' - **silenceTimeoutMaxCountEnable**: Toggle to disconnect the call after repeated silence timeouts. '."\n" + .'- **hangupConfig**: Hang-up configuration '."\n" + .' - **aiHangupEnable**: AI hang-up. Values: `true` or `false`. '."\n" + .' - **delayHangup**: Delayed hang-up, maximum value is 10. '."\n" + .' - **hangupMaxRounds**: Maximum number of interaction rounds, up to 100. '."\n" + .' - **hangupMaxRoundsBroadcast**: Broadcast message played before hanging up due to maximum rounds. '."\n" + .' - **hangupMaxRoundsEnable**: Toggle to enforce the maximum interaction rounds limit (`true`/`false`). '."\n" + .'- **securityInterceptConfig**: Security interception configuration '."\n" + .' - **broadcast**: Broadcast message played upon interception. '."\n" + .'- **specialInterceptConfig**: Special-case interception '."\n" + .' - **specialInterceptEnable**: Toggle for special-case interception. '."\n" + .' - **specialIntercepts**: Special cases: '."\n" + .' - **voiceAssistant**: Voice assistant. '."\n" + .' - **extensionNumberTransfer**: Extension number transfer. '."\n" + .'- **transitionConfig**: Transition phrase model configuration '."\n" + .' - **transitionSwitch**: Toggle for the transition phrase model. '."\n", + '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}}', + 'title' => '', + ], + ], + [ + 'name' => 'LabelConfig', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'Script' => [ + 'description' => 'Script information', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Script status', + 'type' => 'string', + 'example' => 'PUBLISHED', + 'title' => '', + ], + 'UpdateTime' => [ + 'description' => 'Update Time', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1578881227000', + 'title' => '', + ], + 'Industry' => [ + 'description' => 'Industry', + 'type' => 'string', + 'example' => '政务', + 'title' => '', + ], + 'ScriptDescription' => [ + 'description' => 'Script description', + 'type' => 'string', + 'example' => '返工回访话术', + 'title' => '', + ], + 'IsDrafted' => [ + 'description' => 'Is draft', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'DebugStatus' => [ + 'description' => 'Script debug status', + 'type' => 'string', + 'example' => 'DRAFTED', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Script ID', + 'type' => 'string', + 'example' => 'c153d0d8-ba04-41c0-8632-453944c9dd0b', + 'title' => '', + ], + 'IsDebugDrafted' => [ + 'description' => 'Is debug draft', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ScriptName' => [ + 'description' => 'Script name', + 'type' => 'string', + 'example' => '回访话术', + 'title' => '', + ], + 'Scene' => [ + 'description' => 'Scenario', + 'type' => 'string', + 'example' => '回访', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Modify script information', + 'changeSet' => [ + [ + 'createdAt' => '2025-06-12T11:39:29.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-08-06T12:39:33.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-04-25T12:17:46.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-09-20T13:53:36.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-08-09T13:08:14.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-06-21T12:54:40.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-03-01T12:42:07.000Z', + 'description' => 'Request parameters changed', + ], + ], + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'bdd49242-114c-4045-b1d1-25ccc1756c75', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1d7a26e0-628b-4c3c-9918-7f2e23273f54', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptVoiceConfigId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario voice configuration ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'e15cc646-50e5-4bc0-87ec-e4f2d1063b90', + 'title' => '', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'Recording type'."\n" + ."\n" + .'- WAVEFORM: Recording'."\n" + .'- TTS: Text-to-speech', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TTS', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptWaveformRelation', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script recording data. Required when Type is WAVEFORM.'."\n" + ."\n" + .'> Obtain the ScriptWaveformId parameter by calling the CreateScriptWaveform API. ScriptContent represents the name of the scenario voice.', + 'type' => 'string', + 'required' => false, + 'example' => '[{"ScriptContent":"请问你是","ScriptWaveformId":"07db2f0a-acb2-4e68-b9f4-66397414f50c"},{"ScriptContent":"吗？","ScriptWaveformId":"c2a69440-03e3-406e-b0a9-a9791fccb31b"}]', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API prompt message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ScriptVoiceConfig' => [ + 'description' => 'Script voice configuration information', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Broadcast type', + 'type' => 'string', + 'example' => 'WAVEFORM', + 'title' => '', + ], + 'ScriptVoiceConfigId' => [ + 'description' => 'Scene audio configuration ID', + 'type' => 'string', + 'example' => '4ddea690-6534-4c88-9cbd-0b5882ec64c0', + 'title' => '', + ], + 'ScriptContent' => [ + 'description' => 'Text corresponding to the audio', + 'type' => 'string', + 'example' => '你好', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => 'bdd49242-114c-4045-b1d1-25ccc1756c75', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scene ID', + 'type' => 'string', + 'example' => '1d7a26e0-628b-4c3c-9918-7f2e23273f54', + 'title' => '', + ], + 'ScriptWaveformRelation' => [ + 'description' => 'Relational data of the recording correspondence', + 'type' => 'string', + 'example' => '[{"ScriptContent":"你好","ScriptWaveformId":"6facc560-9f25-420f-bb0b-99f4299ad0d5"},{"ScriptContent":"吗","ScriptWaveformId":"76f48266-e253-4f44-ab4f-f64f7d38f1b4"}]', + 'title' => '', + ], + 'Source' => [ + 'description' => 'Script source', + 'type' => 'string', + 'example' => 'DIALOGUE_FLOW', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Legacy canvas API] Modify scenario voice configuration', + 'summary' => 'Modify the scene audio configuration in an old canvas scenario.', + 'description' => '****', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyScriptVoiceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ModifyTTSConfig' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '27244bae-e446-4811-bb1d-f8a07b525af0', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'scenario ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1f1a2ba0-b3e7-4ff9-baf1-6dc8aeac0791', + 'title' => '', + ], + ], + [ + 'name' => 'Voice', + 'in' => 'query', + 'schema' => [ + 'description' => 'Voice information, such as: aixia / siyue / xiaoyun', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'aixia', + 'title' => '', + ], + ], + [ + 'name' => 'SpeechRate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Speech rate: an integer between [-500, 500]. Default Value is 0.'."\n" + ."\n" + .'A value greater than 0 speeds up speech.'."\n" + ."\n" + .'A value less than 0 slows down speech.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => [ + 'description' => 'Volume: an integer between [0, 100]. Default Value is 50.'."\n" + ."\n" + .'A value greater than 50 increases the volume.'."\n" + ."\n" + .'A value less than 50 decreases the volume.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '100', + 'title' => '', + ], + ], + [ + 'name' => 'NlsServiceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Service Type '."\n" + .'Managed: The default Intelligent Speech Interaction service for Intelligent Outbound Calling products (public service). '."\n" + .'Authorized: A private Intelligent Speech Interaction service purchased by public cloud customers (customer private service), authorized via Scenario Management > Edit > Invoke Service > Custom Service.', + 'type' => 'string', + 'required' => false, + 'example' => 'Managed', + 'title' => '', + ], + ], + [ + 'name' => 'AppKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'When the Voice Service Type (nlsServiceType) is set to Authorized, this field stores the appKey of the Intelligent Speech Interaction product project.', + 'type' => 'string', + 'required' => false, + 'example' => '99****Aw', + 'title' => '', + ], + ], + [ + '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 status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API prompt message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => 'f765d3ee-ec03-4765-b235-6877501d99d1', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'TTSConfig' => [ + 'description' => 'TTS Configuration Information', + 'type' => 'object', + 'properties' => [ + 'Voice' => [ + 'description' => 'Speech synthesis model', + 'type' => 'string', + 'example' => 'xiaoyun', + 'title' => '', + ], + 'TTSConfigId' => [ + 'description' => 'Configuration ID', + 'type' => 'string', + 'example' => '2a07b634-e15d-445f-bbcb-fc4ea2df7b87', + 'title' => '', + ], + 'SpeechRate' => [ + 'description' => 'Speech rate', + 'type' => 'string', + 'example' => '50', + 'title' => '', + ], + 'Volume' => [ + 'description' => 'Volume', + 'type' => 'string', + 'example' => '100', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'example' => '291cfc6a-8703-4bdd-a99d-9cba32d5288a', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'example' => '947e0875-b5d4-4b33-b18c-7b2cf85bcb4f', + 'title' => '', + ], + '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', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Modify the TTS configuration of a legacy canvas scenario (dedicated to legacy canvas, deprecated)', + 'summary' => 'Modify the TTS configuration for an old canvas scenario.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2024-07-24T07:36:03.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2023-03-07T13:33:57.000Z', + 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2022-03-01T12:42:07.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyTTSConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ModifyTagGroups' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cd560e89-0459-4c8a-ad98-47d713e4abd6', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '365b955d-6f4d-4ab5-a6e1-9a301307f4b1', + 'title' => '', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => [ + 'description' => 'List of tags ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"TagGroup":"多层次","ScriptId":"b4d0dcc8-892d-43234-987c9d-3568e5faa62f","TagGroupIndex":0,"Id":"56728a30-c392-453a-a287-31af8301150f"}]', + 'title' => '', + ], + ], + [ + 'name' => 'TagGroups', + 'in' => 'query', + 'schema' => [ + 'description' => 'Tag Group information ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"TagName":"111","TagGroup":"多层次","ScriptId":"b4d0dcc8-892d-4323-8c9d-3568e5faa62f","showInput":true,"Id":"a683fa32-91c5-457e-9ddf-aa8549d14ce0"}]', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '5a865b03-d2b9-4ef9-be98-f21fa0d93744', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'TagGroups' => [ + 'description' => 'List of tag groups', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagGroupId' => [ + 'description' => 'Tag group ID', + 'type' => 'string', + 'example' => '54629be9-0746-464a-ab59-4830242cf644', + 'title' => '', + ], + 'TagGroupIndex' => [ + 'description' => 'Tag group index', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'TagGroup' => [ + 'description' => 'Tag group name', + 'type' => 'string', + 'example' => '标签组', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'example' => '365b955d-6f4d-4ab5-a6e1-9a301307f4b1', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Tags' => [ + 'description' => 'List of tags', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagGroup' => [ + 'description' => 'Tag Group name ', + 'type' => 'string', + 'example' => '当前学历', + 'title' => '', + ], + 'TagName' => [ + 'description' => 'Tag name', + 'type' => 'string', + 'example' => '本科', + 'title' => '', + ], + 'TagIndex' => [ + 'description' => 'Tag index', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID ', + 'type' => 'string', + 'example' => '8a4c6d3d-5ed6-44ca-b779-16c20f8862be', + 'title' => '', + ], + 'TagId' => [ + 'description' => 'Unique tag ID ', + 'type' => 'string', + 'example' => '19b23e92-4ee3-4129-8c2e-e1968670d887', + 'title' => '', + ], + ], + 'description' => 'List of tags', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Modify Tag Group – Legacy Canvas API ', + 'summary' => 'Modify a tag group using the legacy canvas API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyTagGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'PublishScript' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ID of the scenario to publish', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '3677fe8b-276f-4541-babf-b9d3082a31ba', + 'title' => '', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'Description of this scenario publishing operation', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '本次发布了xxxx内容', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Deprecated] Publish script', + 'summary' => 'Publish a scenario.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:PublishScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'PublishScriptForDebug' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0bfe34e5-a7fa-4aac-91d4-bd798518dffc', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '5a865b03-d2b9-4ef9-be98-f21fa0d93744', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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}","type":"json"}]', + 'title' => 'Publish script to debug environment', + 'summary' => 'Publish script (debug version).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:PublishScriptForDebug', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'QueryJobs' => [ + 'summary' => 'Query the job list.', + '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' => 'Instance ID.', + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScenarioId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID. This parameter is deprecated. ', + 'example' => 'b0f35dd1-0337-402e-9c4f-3a6c2426950a', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID. ', + 'example' => '994b8baf-7ef8-480c-b141-b7b6db77c4df', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition. Start Time. The default value is 0, which indicates the start of the current day (00:00).', + 'example' => '1579068424883', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition. The end time. Default value: 0, which indicates the current time. ', + 'example' => '1579077794665', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'TimeAlignment', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query by start time, end time, or job creation time. Valid values: start, end, job_create. ', + 'example' => 'start', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition. Contact name.', + 'example' => '张三', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition. Contact phone number.', + 'example' => '135****8888', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Paging ordinal number.', + 'docRequired' => true, + 'example' => '1', + 'format' => 'int32', + 'required' => true, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page size. ', + 'docRequired' => true, + 'example' => '10', + 'format' => 'int32', + 'required' => true, + 'type' => 'integer', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'Response code. ', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'HTTP status code. ', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message.', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded. ', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Jobs' => [ + 'description' => 'Job data.', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'Page number.', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Paging size.', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total number of data entries.', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'List' => [ + 'description' => 'Job array.', + 'items' => [ + 'properties' => [ + 'Status' => [ + 'description' => 'Job status. '."\n" + .'- Scheduling(0, "Scheduling") '."\n" + .'- Executing(1, "Executing") '."\n" + .'- Succeeded(2, "End - Reached") '."\n" + .'- Paused(3, "Paused") '."\n" + .'- Failed(4, "End - Not Reached") '."\n" + .'- Cancelled(5, "Cancelled - Manual Intervention") '."\n" + .'- Drafted(6, "Draft")', + 'example' => 'Succeeded', + 'type' => 'string', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Job ID.', + 'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8', + 'type' => 'string', + 'title' => '', + ], + 'ScenarioId' => [ + 'description' => 'Scenario ID. Historical parameter. [Deprecated]', + 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150', + 'type' => 'string', + 'title' => '', + ], + 'StrategyId' => [ + 'description' => 'Policy ID. ', + 'example' => 'c8a2b7f2-ad1a-4865-b872-d0080d9802d9', + 'type' => 'string', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID. ', + 'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8', + 'type' => 'string', + 'title' => '', + ], + 'Priority' => [ + 'description' => 'Priority. ', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'FailureReason' => [ + 'description' => 'Failure reason. '."\n" + .'- Unknown (unknown fault), '."\n" + .'- NoAnswer (no answer), '."\n" + .'- InvalidStrategy (invalid policy, Configuration Incorrect), '."\n" + .'- TimeUp (timeout detected during schedule), '."\n" + .'- NoStrategy (policy is empty or not found), '."\n" + .'- CallFailed (call failed), '."\n" + .'- PerDayCallCountLimit (daily call count limit for the number reached), '."\n" + .'- ContactBlockList (contact on do-not-call list), '."\n" + .'- EmptyNumber (nonexistent number, no further calls), '."\n" + .'- JobPerDayCallCountLimit (daily call count limit for the job reached), '."\n" + .'- VerificationCancelled (cancelled because authentication failed before call), '."\n" + .'- ContactSuspended (suspended), '."\n" + .'- InArrears (overdue payment), '."\n" + .'- OutOfService (service suspended);', + 'example' => 'NoAnswer', + 'type' => 'string', + 'title' => '', + ], + 'ReferenceId' => [ + 'description' => 'Associated business ID.', + 'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28', + 'type' => 'string', + 'title' => '', + ], + 'Contacts' => [ + 'description' => 'Contact information. This parameter is deprecated.'."\n" + ."\n" + .'> You can obtain it through the DescribeJob API.', + 'items' => [ + 'properties' => [ + 'PhoneNumber' => [ + 'description' => 'Phone number.', + 'example' => '135****8888', + 'type' => 'string', + 'title' => '', + ], + 'State' => [ + 'description' => 'Status. '."\n" + .'- Available (Normal), '."\n" + .'- WrongNumber (fault), '."\n" + .'- DoesNotExist (nonexistent number), '."\n" + .'- Suspended (suspended); ', + 'example' => 'Available', + 'type' => 'string', + 'title' => '', + ], + 'ContactId' => [ + 'description' => 'Contact ID.', + 'example' => 'db3db762-e421-44c9-9a01-cb423470757c', + 'type' => 'string', + 'title' => '', + ], + 'Honorific' => [ + 'description' => 'Honorific.', + 'example' => '张先生', + 'type' => 'string', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID.', + 'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8'."\n", + 'type' => 'string', + 'title' => '', + ], + 'ContactName' => [ + 'description' => 'Contact name.', + 'example' => '张三', + 'type' => 'string', + 'title' => '', + ], + 'Role' => [ + 'description' => 'Role.', + 'example' => '*', + 'type' => 'string', + 'title' => '', + ], + 'ReferenceId' => [ + 'description' => 'Associated business ID.', + 'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'Extras' => [ + 'description' => 'Business Data, displaying the label collection status in LLM scenarios.'."\n" + ."\n" + .'> Keys equal to TenantId or ServiceId are system parameters.', + 'items' => [ + 'properties' => [ + 'Key' => [ + 'description' => 'Business Data key', + 'example' => 'djrq', + 'type' => 'string', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Business Data value', + 'example' => '2019-08-21 09:49:59.0', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'Summary' => [ + 'description' => 'Conversation summary. (Historical field, no longer used.) [Deprecated]', + 'items' => [ + 'properties' => [ + 'SummaryName' => [ + 'description' => 'Summary name.', + 'example' => 'score', + 'type' => 'string', + 'title' => '', + ], + 'GroupId' => [ + 'description' => 'Job ID. ', + 'example' => 'ba1ba502-d044-48c0-b710-0f1f840a7c53', + 'type' => 'string', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID.', + 'example' => 'b72425bd-7871-4050-838e-033d80d754b7'."\n", + 'type' => 'string', + 'title' => '', + ], + 'Category' => [ + 'description' => 'Category', + 'example' => '{}', + 'type' => 'string', + 'title' => '', + ], + 'TaskId' => [ + 'description' => 'Call ID.', + 'example' => '9fdf7a81-6781-4ab8-92fb-1d4231ef365e', + 'type' => 'string', + 'title' => '', + ], + 'Content' => [ + 'description' => 'Content', + 'example' => '5', + 'type' => 'string', + 'title' => '', + ], + 'ConversationDetailId' => [ + 'description' => 'Call record ID', + 'example' => '098b9b09-9223-4a8b-a422-99726f0457f3', + 'type' => 'string', + 'title' => '', + ], + 'SummaryId' => [ + 'description' => 'Summary ID', + 'example' => 'dc67d544-df06-4625-ae48-13e3c9f72d8a', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'Tasks' => [ + 'description' => 'Call list. This parameter is deprecated.'."\n" + ."\n" + .'> You can obtain it through the searchTask API.', + 'items' => [ + 'properties' => [ + 'Status' => [ + 'description' => 'Task Status. Valid values are as follows (note: the Succeeded status has been further categorized by reason; the generic "Succeeded: 1 (Answered)" status will not be displayed. Instead, specific sub-reasons will be returned):'."\n" + ."\n" + .'- Executing: 0 (Calling in progress).'."\n" + .'- Succeeded: 1 (Answered).'."\n" + .'- NoAnswer: 2 (Not answered – no one picked up).'."\n" + .'- NotExist: 3 (Not answered – nonexistent number).'."\n" + .'- Busy: 4 (Not answered – line busy).'."\n" + .'- Cancelled: 5 (Not dialed – job stopped).'."\n" + .'- Failed: 6 (Failed).'."\n" + .'- NotConnected: 7 (Not answered – unable to connect).'."\n" + .'- PoweredOff: 8 (Not answered – powered off).'."\n" + .'- OutOfService: 9 (Not answered – callee out of service).'."\n" + .'- InArrears: 10 (Not answered – callee has overdue payment).'."\n" + .'- EmptyNumber: 11 (Not dialed – nonexistent number, call not placed).'."\n" + .'- PerDayCallCountLimit: 12 (Not dialed – daily call limit exceeded).'."\n" + .'- ContactBlockList: 13 (Not dialed – on blacklist).'."\n" + .'- CallerNotRegistered: 14 (Not dialed – caller number not registered).'."\n" + .'- Terminated: 15 (Not dialed – terminated).'."\n" + .'- VerificationCancelled: 16 (Not dialed – canceled due to failed pre-call authentication).'."\n" + .'- OutOfServiceNoCall: 17 (Not dialed – callee out of service, call not placed).'."\n" + .'- InArrearsNoCall: 18 (Not dialed – callee has overdue payment, call not placed).'."\n" + .'- CallingNumberNotExist: 19 (Not dialed – caller number does not exist).'."\n" + .'- SucceededFinish: 20 (Answered – completed normally).'."\n" + .'- SucceededChatbotHangUpAfterNoAnswer: 21 (Answered – chatbot hung up after unrecognized input).'."\n" + .'- SucceededChatbotHangUpAfterSilence: 22 (Answered – chatbot hung up after silence timeout).'."\n" + .'- SucceededClientHangUpAfterNoAnswer: 23 (Answered – user hung up after unrecognized input).'."\n" + .'- SucceededClientHangUp: 24 (Answered – user hung up without reason).'."\n" + .'- SucceededTransferByIntent: 25 (Answered – transferred to agent due to intent hit).'."\n" + .'- SucceededTransferAfterNoAnswer: 26 (Answered – transferred to agent after unrecognized input).'."\n" + .'- SucceededInoInterAction: 27 (Answered – no interaction from user side).'."\n" + .'- SucceededError: 28 (Answered – interrupted due to system exception).'."\n" + .'- SucceededSpecialInterceptVoiceAssistant: 29 (Answered – intercepted under special condition – voice assistant).'."\n" + .'- SucceededSpecialInterceptExtensionNumberTransfer: 30 (Answered – intercepted under special condition – extension transfer).'."\n" + .'- SucceededSpecialInterceptCustomSpecialIntercept: 31 (Answered – intercepted under special condition – custom interception).'."\n" + .'- HighRiskSipCode: 32 (Not dialed – high-risk, call not placed).', + 'example' => 'Succeeded', + 'type' => 'string', + 'title' => '', + ], + 'PlanedTime' => [ + 'description' => 'Planned outbound call time.', + 'example' => '1579068424883', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'ChatbotId' => [ + 'description' => 'Chatbot ID.', + 'example' => '1234', + 'type' => 'string', + 'title' => '', + ], + 'ActualTime' => [ + 'description' => 'Actual call time.', + 'example' => '1579068424883', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'CalledNumber' => [ + 'description' => 'Called number.', + 'example' => '135****8888', + 'type' => 'string', + 'title' => '', + ], + 'ScenarioId' => [ + 'description' => 'Scenario ID.', + 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150', + 'type' => 'string', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID. ', + 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', + 'type' => 'string', + 'title' => '', + ], + 'CallId' => [ + 'description' => 'SIP call ID.', + 'example' => '1528189846043', + 'type' => 'string', + 'title' => '', + ], + 'CallingNumber' => [ + 'description' => 'Calling number.', + 'example' => '0571****3106', + 'type' => 'string', + 'title' => '', + ], + 'Brief' => [ + 'description' => 'Summary (historical field, no longer used)', + 'example' => '1', + 'type' => 'string', + 'title' => '', + ], + 'Duration' => [ + 'description' => 'Call duration.', + 'example' => '120', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'TaskId' => [ + 'description' => 'Call ID.', + 'example' => 'ff44709e-39a6-43ba-959b-20fcabe3e496', + 'type' => 'string', + 'title' => '', + ], + 'Contact' => [ + 'description' => 'Contact information.', + 'properties' => [ + 'PhoneNumber' => [ + 'description' => 'Contact phone number.', + 'example' => '135****8888', + 'type' => 'string', + 'title' => '', + ], + 'State' => [ + 'description' => 'Status.', + 'example' => 'Available', + 'type' => 'string', + 'title' => '', + ], + 'ContactId' => [ + 'description' => 'Contact ID.', + 'example' => 'db3db762-e421-44c9-9a01-cb423470757c', + 'type' => 'string', + 'title' => '', + ], + 'Honorific' => [ + 'description' => 'Honorific.', + 'example' => '张先生', + 'type' => 'string', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID. ', + 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', + 'type' => 'string', + 'title' => '', + ], + 'ContactName' => [ + 'description' => 'Contact name. ', + 'example' => '张三', + 'type' => 'string', + 'title' => '', + ], + 'Role' => [ + 'description' => 'Role.', + 'example' => '*', + 'type' => 'string', + 'title' => '', + ], + 'ReferenceId' => [ + 'description' => 'Business association ID.', + 'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'CallingNumbers' => [ + 'description' => 'List of calling numbers. ', + 'items' => [ + 'description' => 'List of calling numbers. ', + 'example' => '["0571****3106"]', + 'type' => 'string', + 'title' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'TagHits' => [ + 'description' => 'Tag hit information in the small model scenario. ', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'description' => 'Tag Name. ', + 'type' => 'string', + 'example' => '有意向', + 'title' => '', + ], + 'TagGroup' => [ + 'description' => 'Tag Group name. ', + 'type' => 'string', + 'example' => '意向收集', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[{"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\\": 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}","type":"json"}]', + 'title' => 'Query job list ', + 'changeSet' => [ + [ + 'createdAt' => '2023-10-20T07:45:12.000Z', + 'description' => 'Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:ListJobStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'QueryJobsWithResult' => [ + 'summary' => 'Query jobs by task result.', + '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' => 'Page number '."\n" + ."\n" + .'><notice>This parameter is Required></notice> ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page size '."\n" + .'><notice>This parameter is Required></notice> ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '10', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ad16fc35-d824-4102-a606-2be51c1aa6dd', + 'title' => '', + ], + ], + [ + 'name' => 'QueryText', + 'in' => 'query', + 'schema' => [ + 'description' => 'Search content; you can search by phone number ', + 'type' => 'string', + 'required' => false, + 'example' => '1882020****', + 'title' => '', + ], + ], + [ + 'name' => 'JobStatusFilter', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job status filter '."\n" + .'- Scheduling: Scheduling. '."\n" + .'- Executing: Executing. '."\n" + .'- Succeeded: Ended – Reached. '."\n" + .'- Paused: Paused. '."\n" + .'- Failed: Ended – Not reached. '."\n" + .'- Cancelled: Cancelled – Manual intervention. ', + 'type' => 'string', + 'required' => false, + 'example' => 'Succeeded', + 'title' => '', + ], + ], + [ + 'name' => 'HasAnsweredFilter', + 'in' => 'query', + 'schema' => [ + 'description' => 'Is answered ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'HasHangUpByRejectionFilter', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether the call was hung up due to rejection ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'HasReachedEndOfFlowFilter', + 'in' => 'query', + 'schema' => [ + 'description' => 'Is completed ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID ', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '9d53cd72-4050-4419-8c17-acc0bf158147', + 'title' => '', + ], + ], + [ + 'name' => 'TaskStatusFilter', + 'in' => 'query', + 'schema' => [ + 'description' => 'Call status. Valid values: ["Executing","Succeeded"]. Separate multiple values with commas. '."\n" + .'Value range: '."\n" + .'(Note: The **Succeeded** status has been subdivided by reason. The generic **Succeeded**: 1 (Answered) status will not be displayed; instead, only the specific subdivided reason types will be returned.)'."\n" + ."\n" + .'- **Executing**: 0 (Dialing in progress). '."\n" + .'- **Succeeded**: 1 (Answered). '."\n" + .'- **NoAnswer**: 2 (Not answered – No one picked up). '."\n" + .'- **NotExist**: 3 (Not answered – Nonexistent number). '."\n" + .'- **Busy**: 4 (Not answered – Line busy). '."\n" + .'- **Cancelled**: 5 (Not dialed – Job stopped). '."\n" + .'- **Failed**: 6 (Failed). '."\n" + .'- **NotConnected**: 7 (Not answered – Unable to connect). '."\n" + .'- **PoweredOff**: 8 (Not answered – Powered off). '."\n" + .'- **OutOfService**: 9 (Not answered – Called party suspended). '."\n" + .'- **InArrears**: 10 (Not answered – Called party has overdue payment). '."\n" + .'- **EmptyNumber**: 11 (Not dialed – Nonexistent number, no call placed). '."\n" + .'- **PerDayCallCountLimit**: 12 (Not dialed – Exceeded daily call limit). '."\n" + .'- **ContactBlockList**: 13 (Not dialed – Blacklist). '."\n" + .'- **CallerNotRegistered**: 14 (Not dialed – Caller number not registered). '."\n" + .'- **Terminated**: 15 (Not dialed – Terminated). '."\n" + .'- **VerificationCancelled**: 16 (Not dialed – Cancelled due to failed pre-call authentication). '."\n" + .'- **OutOfServiceNoCall**: 17 (Not dialed – Called party suspended, no call placed). '."\n" + .'- **InArrearsNoCall**: 18 (Not dialed – Called party has overdue payment, no call placed). '."\n" + .'- **CallingNumberNotExist**: 19 (Not dialed – Caller number does not exist). '."\n" + .'- **SucceededFinish**: 20 (Answered – Normal completion). '."\n" + .'- **SucceededChatbotHangUpAfterNoAnswer**: 21 (Answered – Bot hung up after rejection). '."\n" + .'- **SucceededChatbotHangUpAfterSilence**: 22 (Answered – Bot hung up after silence timeout). '."\n" + .'- **SucceededClientHangUpAfterNoAnswer**: 23 (Answered – User hung up after rejection). '."\n" + .'- **SucceededClientHangUp**: 24 (Answered – User hung up without reason). '."\n" + .'- **SucceededTransferByIntent**: 25 (Answered – Transferred to agent due to intent hit). '."\n" + .'- **SucceededTransferAfterNoAnswer**: 26 (Answered – Transferred to agent after rejection). '."\n" + .'- **SucceededInoInterAction**: 27 (Answered – No interaction from user side). '."\n" + .'- **SucceededError**: 28 (Answered – Interrupted by system exception). '."\n" + .'- **SucceededSpecialInterceptVoiceAssistant**: 29 (Answered – Intercepted under special condition – Voice assistant). '."\n" + .'- **SucceededSpecialInterceptExtensionNumberTransfer**: 30 (Answered – Intercepted under special condition – Extension transfer). '."\n" + .'- **SucceededSpecialInterceptCustomSpecialIntercept**: 31 (Answered – Intercepted under special condition – Custom intercept). '."\n" + .'- **HighRiskSipCode**: 32 (Not dialed – High-risk, no call placed).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["Executing"]', + 'title' => '', + ], + ], + [ + 'name' => 'JobFailureReasonsFilter', + 'in' => 'query', + 'schema' => [ + 'description' => 'List of job failure reasons ', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'NoAnswer' => '', + 'PerDayCallCountLimit' => '', + 'InArrears' => '', + 'OutOfService' => '', + 'NoStrategy' => '', + 'EmptyNumber' => '', + 'JobPerDayCallCountLimit' => '', + 'NoneRepeatableJobMaxAttemptCountLimit' => '', + 'ContactSuspended' => '', + 'VerificationCancelled' => '', + 'Unknown' => '', + 'InvalidStrategy' => '', + 'TimeUp' => '', + 'CallFailed' => '', + 'ContactBlockList' => '', + ], + 'example' => '["NoAnswer"]', + 'title' => '', + ], + ], + [ + 'name' => 'StartActualTimeFilter', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition for call start time ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1579055782000', + 'title' => '', + ], + ], + [ + 'name' => 'EndActualTimeFilter', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition for call end time', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1579055783000', + 'title' => '', + ], + ], + [ + 'name' => 'LabelsJson', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'maxItems' => 100, + 'description' => 'Tag filtering conditions for calls '."\n" + ."\n" + .'> This condition supports filtering only by labels that have specific enumeration tag values configured—that is, labels with explicitly defined tag values in the LLM scenario. ', + 'type' => 'array', + 'items' => [ + 'description' => 'The labels and corresponding tag values to filter by. '."\n" + ."\n" + .'> Filters all calls that match the specified labels and their corresponding tag values. '."\n" + .'For example: {"ValueList":["Satisfied","Dissatisfied"],"Name":"Satisfaction"} indicates filtering all call records where the "Satisfaction" label has a tag value of either "Satisfied" or "Dissatisfied". ', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "ValueList": ['."\n" + .' "满意",'."\n" + .' "不满意"'."\n" + .' ],'."\n" + .' "Name": "是否满意"'."\n" + .' }', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '9bdaa1d1-a036-4451-ab11-ca0373679091', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'VariableNames' => [ + 'description' => 'Tag names to be collected', + 'type' => 'array', + 'items' => [ + 'description' => 'Full set of tag keys', + 'type' => 'string', + 'example' => '是否已经接通', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Jobs' => [ + 'description' => 'Job', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Page size', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'PageCount' => [ + 'description' => 'Total number of pages', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'RowCount' => [ + 'description' => 'Total number of entries ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'List' => [ + 'description' => 'Job list', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Job status. '."\n" + .'- Scheduling(0, "Scheduling") '."\n" + .'- Executing(1, "Executing") '."\n" + .'- Succeeded(2, "Ended - Reached") '."\n" + .'- Paused(3, "Paused") '."\n" + .'- Failed(4, "Ended - Not Reached") '."\n" + .'- Cancelled(5, "Cancelled - Manual Intervention") '."\n" + .'- Drafted(6, "Draft")', + 'type' => 'string', + 'example' => 'Succeeded', + 'title' => '', + ], + 'StatusName' => [ + 'description' => 'Job status name', + 'type' => 'string', + 'example' => '结束-已触达', + 'title' => '', + ], + 'JobFailureReason' => [ + 'description' => 'Job failure reason ', + '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时生效）', + 'title' => '', + ], + 'Id' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'example' => 'cc231a1d-3c05-4739-8926-193ecf4097ba', + 'title' => '', + ], + 'LatestTask' => [ + 'description' => 'Latest call ', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Call status ', + 'type' => 'string', + 'example' => 'Succeeded', + 'title' => '', + ], + 'TaskEndReason' => [ + 'description' => 'Call result ', + 'type' => 'string', + 'example' => 'FINISHED', + 'title' => '', + ], + 'HasAnswered' => [ + 'description' => 'Is answered ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'CallDuration' => [ + 'description' => 'Call duration', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40000', + 'title' => '', + ], + 'HasReachedEndOfFlow' => [ + 'description' => 'Indicates whether the flow has ended', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'StatusName' => [ + 'description' => 'Call status name', + 'type' => 'string', + 'example' => '未呼出-超出每日上限', + 'title' => '', + ], + 'CallTime' => [ + 'description' => 'Call time ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1615363297000', + 'title' => '', + ], + 'CallDurationDisplay' => [ + 'description' => 'Call duration ', + 'type' => 'string', + 'example' => '40', + 'title' => '', + ], + 'HasHangUpByRejection' => [ + 'description' => 'Is hung up due to rejection ', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'Extras' => [ + 'description' => 'Tag names to collect', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Key', + 'type' => 'string', + 'example' => '是否已经接通', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Value', + 'type' => 'string', + 'example' => '是', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TagHits' => [ + 'description' => 'Tag hit information [returned by the old canvas] ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'description' => 'Tag Name ', + 'type' => 'string', + 'example' => '猫幼年期,猫幼年期', + 'title' => '', + ], + 'TagGroup' => [ + 'description' => 'Tag Group', + 'type' => 'string', + 'example' => '动物', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Contact' => [ + 'description' => 'Contact', + 'type' => 'object', + 'properties' => [ + 'Round' => [ + 'description' => 'Round ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '151', + 'title' => '', + ], + 'JobUuid' => [ + 'description' => 'Job ID ', + 'type' => 'string', + 'example' => 'cc231a1d-3c05-4739-8926-193ecf4097ba'."\n", + 'title' => '', + ], + 'PreferredPhoneNumber' => [ + 'description' => 'The phone number specified by the callee during the conversation. If provided, this number will be actually dialed. '."\n" + .'> Customized by the Customer and passed in JSON format when invoking the API to execute an outbound calling job. ', + 'type' => 'string', + 'example' => '134123****', + 'title' => '', + ], + 'PhoneNumber' => [ + 'description' => 'The contact\'s phone number ', + 'type' => 'string', + 'example' => '1882020****', + 'title' => '', + ], + 'State' => [ + 'description' => 'The contact\'s status, '."\n" + .'such as Normal (Available), WrongNumber, or nonexistent number (DoesNotExist). '."\n" + .'> Customized by the Customer and passed in JSON format when invoking the API to execute an outbound calling job. ', + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'Honorific' => [ + 'description' => 'Honorific title for the contact. If not provided, it defaults to the same value as the name.'."\n" + ."\n" + .'> Customized by the customer and passed via JSON when executing the outbound call task through an API call.', + 'type' => 'string', + 'example' => '张先生', + 'title' => '', + ], + 'Name' => [ + 'description' => 'Contact name, such as Zhang San ', + 'type' => 'string', + 'example' => '张三', + 'title' => '', + ], + 'Role' => [ + 'description' => 'The role of this contact in the outbound call task. If not specified, no distinction is made. In debt collection scenarios, contact roles can include borrower, co-borrower, guarantor, etc.'."\n" + ."\n" + .'> Customized by the customer and passed via JSON when invoking the API.', + 'type' => 'string', + 'example' => '借款人', + 'title' => '', + ], + 'Id' => [ + 'description' => 'Contact ID, a UUID generated by the System when uploading the outbound calling list ', + 'type' => 'string', + 'example' => '63860deb-6218-45df-b1e0-76f2b166e790', + 'title' => '', + ], + 'ReferenceId' => [ + 'description' => 'A contact ID uploaded by the customer. This ID must be provided by the business party to avoid ambiguity caused by duplicate names.', + 'type' => 'string', + 'example' => 'C01', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HasLastPlaybackCompleted' => [ + 'description' => 'Indicates whether the playback was completed when the call ended ', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'DialExceptionCodes' => [ + 'description' => 'Call abnormal codes', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'Error code', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '0', + 'title' => '', + ], + 'Hint' => [ + 'description' => 'Error hint message', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => '无', + 'title' => '', + ], + ], + 'description' => 'Call abnormal code', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Labels' => [ + 'description' => 'Label information that can be used as Filter Conditions. '."\n" + ."\n" + .'> Displays all label information with enumeration values in this task group ', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'Label name ', + 'type' => 'string', + 'example' => '是否满意', + 'title' => '', + ], + 'ValueList' => [ + 'description' => 'List of tag values. ', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag value.', + 'type' => 'string', + 'example' => '["否","是"]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query jobs by task result ', + 'changeSet' => [ + [ + 'createdAt' => '2025-09-10T13:09:37.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2025-07-15T09:08:02.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-11-13T14:08:15.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-02-04T14:24:42.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-09-20T13:54:30.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-06-22T02:25:49.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2021-11-24T13:02:02.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2021-11-24T13:02:02.000Z', + 'description' => 'Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:QueryJobsWithResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'QueryScriptWaveforms' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'instance ID', + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'Scenario ID ', + 'example' => '5ab2d935-306c-478a-88bf-d08e4e25c1b7', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptContent', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'description' => 'Scenario audio Name', + 'example' => '抱歉打扰您了,稍后会有客户经理与您联系啊,再见!'."\n", + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int32', + 'description' => 'HTTP status code', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'type' => 'string', + 'description' => 'API status code', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'type' => 'string', + 'description' => 'API message', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'type' => 'string', + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'type' => 'boolean', + 'description' => 'is Succeeded', + 'example' => 'true', + 'title' => '', + ], + 'ScriptWaveforms' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ScriptContent' => [ + 'type' => 'string', + 'description' => 'Scenario audio Name', + 'example' => '测试', + 'title' => '', + ], + 'ScriptWaveformId' => [ + 'type' => 'string', + 'description' => 'Scenario audio recording ID', + 'example' => '444df4-009c-4791-a720-e7ac4f9821a1'."\n", + 'title' => '', + ], + 'FileName' => [ + 'type' => 'string', + 'description' => 'Recording file Name', + 'example' => 'SHUKE_ZA_ol_32_邀约.wav', + 'title' => '', + ], + 'ScriptId' => [ + 'type' => 'string', + 'description' => 'Scenario ID', + 'example' => '25b26ce1-009c-4791-a720-e7ac4f9821a1', + 'title' => '', + ], + 'FileId' => [ + 'type' => 'string', + 'description' => 'File key in OSS', + 'example' => 'UPLOADED/RECORDING/a8xxxxx-2b26-4b6d-a54f-696b95xxx1/a6bf591a-cf6d-4xxxxxx.wav', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'List of recordings for scenario audio'."\n" + ."\n" + .'> Recording data is returned only when the audio type is a recording; no data is returned if the audio is generated by speech synthesis.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Deprecated] Query the list of scenario audio recording files on the legacy canvas', + 'summary' => 'Legacy canvas API for querying the list of recordings for script texts.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:QueryScriptWaveforms', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'QueryScriptsByStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', + 'title' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page size for paging', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + 'title' => '', + ], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of statuses', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'Valid values for scenario status:'."\n" + .'- **DRAFTED**: Draft'."\n" + .'- **INITIALIZE_IN_PROGRESS**: Initializing'."\n" + .'- **PUBLISHED**: Published'."\n" + .'- **PUBLISH_IN_PROGRESS**: Publishing'."\n" + .'- **ROLLBACK_IN_PROGRESS**: Rolling back'."\n" + .'- **EXAMINE_IN_PROGRESS**: Pending review'."\n" + .'- **PUBLISHED_AND_EXAMINE_IN_PROGRESS**: Published and pending review'."\n" + .'- **PUBLISH_FAILED**: Publish failed'."\n" + .'- **ROLLBACK_FAILED**: Rollback failed'."\n" + .'- **IMPORT_IN_PROGRESS**: Importing'."\n" + .'- **IMPORT_FAILED**: Import failed', + 'required' => false, + 'example' => 'PUBLISHED', + 'title' => '', + ], + 'required' => true, + 'example' => '', + 'maxItems' => 10, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Scripts' => [ + 'description' => 'Scenario List', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Page size', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'TotalCount' => [ + 'description' => 'Total count', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + 'title' => '', + ], + 'List' => [ + 'description' => 'List of scenario information', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Status of the application version. Valid values:'."\n" + .'- **DRAFTED**: Draft'."\n" + .'- **INITIALIZE_IN_PROGRESS**: Initializing'."\n" + .'- **PUBLISHED**: Published'."\n" + .'- **PUBLISH_IN_PROGRESS**: Publishing'."\n" + .'- **ROLLBACK_IN_PROGRESS**: Rolling back'."\n" + .'- **EXAMINE_IN_PROGRESS**: Pending Review'."\n" + .'- **PUBLISHED_AND_EXAMINE_IN_PROGRESS**: Published and pending review'."\n" + .'- **PUBLISH_FAILED**: Publish failed'."\n" + .'- **ROLLBACK_FAILED**: Rollback failed'."\n" + .'- **IMPORT_IN_PROGRESS**: Importing'."\n" + .'- **IMPORT_FAILED**: Import failed', + 'type' => 'string', + 'example' => 'PUBLISHED', + 'title' => '', + ], + 'UpdateTime' => [ + 'description' => 'Update Time ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579055782000', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID ', + 'type' => 'string', + 'example' => 'fa0e21e9-caab-4629-9121-1e341243d599', + 'title' => '', + ], + 'AppliedVersion' => [ + 'description' => 'Version ID ', + 'type' => 'string', + 'example' => '1579055782000', + 'title' => '', + ], + 'IsDebugDrafted' => [ + 'description' => 'Indicates whether the debug version is in Draft status ', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'Industry' => [ + 'description' => 'Industry', + 'type' => 'string', + 'example' => '通用', + 'title' => '', + ], + 'ScriptDescription' => [ + 'description' => 'Script Description ', + 'type' => 'string', + 'example' => '销售话术', + 'title' => '', + ], + 'IsDrafted' => [ + 'description' => 'Indicates whether the version is in Draft status ', + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'DebugStatus' => [ + 'description' => 'Debug status ', + 'type' => 'string', + 'example' => 'PUBLISHED', + 'title' => '', + ], + 'DebugVersion' => [ + 'description' => 'Debug Version', + 'type' => 'string', + 'example' => '01bb2df2-a273-42bb-a214-d3c626b13296', + 'title' => '', + ], + 'Scene' => [ + 'description' => 'Scenario ', + 'type' => 'string', + 'example' => '电销', + 'title' => '', + ], + 'ScriptName' => [ + 'description' => 'Scenario Name ', + 'type' => 'string', + 'example' => '销售话术', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query scenario information by scenario status', + 'summary' => 'Query scenario information based on scenario status.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:QueryScriptsByStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'RecordFailure' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '9ab43460-c0b9-40e2-8447-48d82c97fc67', + 'title' => '', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Call ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '4f21446e-324e-46f2-bf62-7f341fb004ea', + 'title' => '', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd2295c0e-3bc3-48a5-9f56-b185db2be909', + 'title' => '', + ], + ], + [ + 'name' => 'ActualTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'Call Start Time', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1579055782000', + 'title' => '', + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Calling number', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10086', + 'title' => '', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Called number', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '135815****', + 'title' => '', + ], + ], + [ + 'name' => 'DispositionCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Reason for failure:'."\n" + .'- nonexistent number (NotExists)'."\n" + .'- Busy (Busy)'."\n" + .'- Not answered (NotAnswered)', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'NotExists', + 'title' => '', + ], + ], + [ + 'name' => 'ExceptionCodes', + 'in' => 'query', + 'schema' => [ + 'description' => 'Error encoding when the outbound call fails:'."\n" + .'- nonexistent number (NotExists)'."\n" + .'- Busy (Busy)'."\n" + .'- Not answered (NotAnswered)', + 'type' => 'string', + 'required' => false, + 'example' => 'NotExists', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Submit IVR call failure record – Deprecated', + 'summary' => 'CC submits the reason for call failure to the outbound calling Operational System. This API is deprecated.', + 'changeSet' => [ + [ + 'createdAt' => '2021-11-24T13:02:02.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:RecordFailure', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'ResumeJobs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition indicating whether to restart all jobs', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'ScenarioId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition: scenario ID (historical parameter, deprecated)', + 'type' => 'string', + 'required' => false, + 'example' => 'b016fbdb-b81c-4c06-8870-cb36b8783b6d', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition: task group ID', + 'type' => 'string', + 'required' => false, + 'example' => 'de48407d-309e-451a-81ec-6fb11f8fdbf3', + 'title' => '', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of job IDs'."\n" + ."\n" + .'> This parameter is required when the value of All is false.', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'Job ID', + 'required' => false, + 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', + 'title' => '', + ], + 'required' => false, + 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', + 'maxItems' => 99, + 'title' => '', + ], + ], + [ + 'name' => 'JobReferenceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Third-party ID of the job'."\n" + ."\n" + .'> This is the ReferenceId provided by the customer when uploading the outbound call list.', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'description' => 'Third-party ID of the job', + 'required' => false, + 'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28', + 'title' => '', + ], + 'required' => false, + 'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28', + 'maxItems' => 99, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Restart a paused job', + 'summary' => 'Restart a paused job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:ResumeJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Instance ID'."\n", + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'docRequired' => true, + 'example' => '303523b1-0094-4ebe-b9ed-c23d11c91d61', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'RollbackVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Version to roll back to'."\n" + ."\n" + .'> For valid values, see the ListScriptPublishHistories API.', + 'docRequired' => true, + 'example' => '1578965079000', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code'."\n", + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'True', + 'type' => 'boolean', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Roll back a published scenario (small models only)', + 'summary' => 'Roll back a published small model scenario.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:RollbackScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'SaveAfterAnswerDelayPlayback' => [ + 'summary' => 'Save the delay playback time after answering.', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '980116ec-2d3d-4747-8059-dc25e7af8501', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Policy level (Required).'."\n" + .'- 2: instance', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '2', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'AfterAnswerDelayPlayback', + 'in' => 'query', + 'schema' => [ + 'description' => 'Playback time for delayed playback. The default value is 0 if this parameter is not specified.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Save the delay playback time after answering.', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-01-12T12:20:26.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:SaveAfterAnswerDelayPlayback', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'SaveAnnotationMissionSessionList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '130001', + 'abilityTreeNodes' => [ + 'FEATUREoutboundbotQHO52V', + ], + ], + 'parameters' => [ + [ + 'name' => 'AnnotationMissionSessionListJsonString', + 'in' => 'query', + 'schema' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatVocabularyInfoList_items_properties_AnnotationMissionChatVocabularyInfoId_description]ID', + '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}]', + 'title' => '', + ], + ], + [ + 'name' => 'UserNick', + 'in' => 'query', + 'schema' => [ + 'description' => 'User nickname', + 'type' => 'string', + 'required' => false, + 'example' => '用户', + 'title' => '', + ], + ], + [ + 'name' => 'AnnotationMissionSessionList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatCustomizationDataInfoList_items_properties_InstanceId_type]string', + 'type' => 'array', + 'items' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatCustomizationDataInfoList_items_properties_CreateTime_type]integer', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionSessionId' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatCustomizationDataInfoList_items_properties_Content_type]string', + 'type' => 'string', + 'required' => false, + 'example' => 'c88cc004-de69-4eee-aa5f-2efed533a54e'."\n", + 'title' => '', + ], + 'CreateTime' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatCustomizationDataInfoList_items_properties_AnnotationMissionId_type]string', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2023-04-14T02:01:23Z', + 'title' => '', + ], + 'ModifiedTime' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatCustomizationDataInfoList_items_properties_CustomizationDataName_type]string', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1683858248778', + 'title' => '', + ], + 'AnnotationMissionId' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatCustomizationDataInfoList_items_properties_ModifiedTime_type]integer', + 'type' => 'string', + 'required' => false, + 'example' => 'c88cc004-de69-4eee-aa5f-2efed533a54e', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatCustomizationDataInfoList_items_properties_CustomizationDataId_type]string', + 'type' => 'string', + 'required' => false, + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Scenario ID', + 'type' => 'string', + 'required' => false, + 'example' => 'e4f32632-2e56-4399-9fec-47bdbaeefdf6', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatCustomizationDataInfoList_items_properties_AnnotationMissionSessionId_type]string', + 'type' => 'string', + 'required' => false, + 'example' => '29e669bd-a9d1-4529-98cd-c2b0549bcf53', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'required' => false, + 'example' => '593aaf5e-1275-4add-9990-22696385dc6e', + 'title' => '', + ], + 'SessionId' => [ + 'description' => 'For outbound calling systems, this is taskId; for navigation, this is conversationId', + 'type' => 'string', + 'required' => false, + 'example' => 'e6271044-b4b2-4ad8-ade4-c720be023538', + 'title' => '', + ], + 'AnnotationStatus' => [ + 'description' => 'Annotation status '."\n" + .'- 0: UNDO '."\n" + .'- 1: DOING '."\n" + .'- 2: DONE '."\n" + .'- 3: CLOSED', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + 'AnnotationMissionChatList' => [ + 'description' => 'Chat list ', + 'type' => 'array', + 'items' => [ + 'description' => 'Chat list ', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionChatId' => [ + 'description' => 'chat id', + 'type' => 'string', + 'required' => false, + 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n", + 'title' => '', + ], + 'CreateTime' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatIntentUserSayInfoList_items_properties_CreateTime_description]Creation Time', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1679629770336', + 'title' => '', + ], + 'ModifiedTime' => [ + 'description' => 'Updated At', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1629360780000', + 'title' => '', + ], + 'AnnotationMissionId' => [ + 'description' => 'Annotation Job ID', + 'type' => 'string', + 'required' => false, + 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9', + 'title' => '', + ], + 'AnnotationMissionSessionId' => [ + 'description' => 'Session ID', + 'type' => 'string', + 'required' => false, + 'example' => 'c88cc004-de69-4eee-aa5f-2efed533a54e'."\n", + 'title' => '', + ], + 'InstanceId' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatIntentUserSayInfoList_items_properties_InstanceId_description]instance ID', + 'type' => 'string', + 'required' => false, + 'example' => '5ec263fa-c8de-46f4-b844-6fb8275bb645', + 'title' => '', + ], + 'SequenceId' => [ + 'description' => 'The serial number of the current round of session interaction', + 'type' => 'string', + 'required' => false, + 'example' => '1475140522', + 'title' => '', + ], + 'OccurTime' => [ + 'description' => 'Trigger time', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1682493047418', + 'title' => '', + ], + 'Answer' => [ + 'description' => '[parameters_UserNick_schema_description]User nickname', + 'type' => 'string', + 'required' => false, + 'example' => '{\'Answer\': u\'\\u53c2\\u8003\\u6587\\u6863\\uff1ahttps://help.aliyun.com/document_detail/181325.html\', \'QuestionId\': 372858, \'Uuid\': \'ac14000516762684770197536d0044\'}', + 'title' => '', + ], + 'AnnotationStatus' => [ + 'description' => '[parameters_AnnotationMissionDataSourceType_schema_type]integer', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + 'IntentAnnotationStatus' => [ + 'title' => '', + 'description' => 'Semantics annotation status '."\n" + .'- 0: Not started (UNDO) '."\n" + .'- 1: In progress (DOING) '."\n" + .'- 2: Completed (DONE) '."\n" + .'- 3: Canceled (CLOSED) ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'AsrAnnotationStatus' => [ + 'title' => '', + 'description' => 'ASR annotation status '."\n" + .'- 0: Undone (UNDO) '."\n" + .'- 1: In progress (DOING) '."\n" + .'- 2: Done (DONE) '."\n" + .'- 3: Canceled (CLOSED) ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'TagAnnotationStatus' => [ + 'title' => '', + 'description' => '[parameters_Environment_schema_type]integer', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'SubStatus' => [ + 'title' => '', + 'description' => 'Annotation action: 1 correct, 20 mismatch error not optimized, 21 mismatch error optimized, 3 not overwritten, 4 invalid ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'TranslationError' => [ + 'description' => 'Translation error indicator '."\n" + .'- 0: No '."\n" + .'- 1: Yes ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + 'AnnotationAsrResult' => [ + 'description' => 'Manually annotated ASR text result, used for computing character accuracy rate', + 'type' => 'string', + 'required' => false, + 'example' => '[]', + 'title' => '', + ], + 'OriginalAsrResult' => [ + 'description' => 'ASR classification result ', + 'type' => 'string', + 'required' => false, + 'example' => '[]', + 'title' => '', + ], + 'AnnotationMissionChatIntentUserSayInfoList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionChatIntentUserSayInfoId' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'ID', + 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n", + 'title' => '', + ], + 'CreateTime' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'description' => 'Creation Time', + 'example' => '1683858248778', + 'title' => '', + ], + 'ModifiedTime' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'description' => 'Updated At', + 'example' => '1683858248778', + 'title' => '', + ], + 'InstanceId' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'instance ID', + 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n", + 'title' => '', + ], + 'AnnotationMissionId' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'Annotation Job ID ', + 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n", + 'title' => '', + ], + 'AnnotationMissionSessionId' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'session ID', + 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n", + 'title' => '', + ], + 'AnnotationMissionChatId' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'Chat ID ', + 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n", + 'title' => '', + ], + 'Content' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'Content ', + 'example' => '[]', + 'title' => '', + ], + 'IntentId' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'description' => 'Intent ID', + 'example' => '119839', + 'title' => '', + ], + 'DialogId' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'description' => 'Dialog ID', + 'example' => '2991201'."\n", + 'title' => '', + ], + 'BotId' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'Bot ID', + 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n", + 'title' => '', + ], + 'Delete' => [ + 'type' => 'boolean', + 'required' => false, + 'description' => 'delete', + 'example' => 'false', + 'title' => '', + ], + 'Create' => [ + 'type' => 'boolean', + 'required' => false, + 'description' => 'Creation ', + 'example' => 'false', + 'title' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'description' => 'List', + 'title' => '', + 'example' => '', + ], + 'AnnotationMissionChatVocabularyInfoList' => [ + 'description' => 'Table of hot word annotation information for the annotation job chat', + 'type' => 'array', + 'items' => [ + 'description' => 'Table of hot word annotation information for the annotation job chat', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionChatVocabularyInfoId' => [ + 'description' => 'id', + 'type' => 'string', + 'required' => false, + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1677552860720', + 'title' => '', + ], + 'ModifiedTime' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_SessionId_type]string', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1679283408230', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'instance ID', + 'type' => 'string', + 'required' => false, + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573', + 'title' => '', + ], + 'AnnotationMissionId' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_JobId_type]string', + 'type' => 'string', + 'required' => false, + 'example' => '977a45dc-b636-4407-9e98-9f572c709ada', + 'title' => '', + ], + 'AnnotationMissionSessionId' => [ + 'description' => 'session ID', + 'type' => 'string', + 'required' => false, + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", + 'title' => '', + ], + 'AnnotationMissionChatId' => [ + 'description' => 'chat id', + 'type' => 'string', + 'required' => false, + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", + 'title' => '', + ], + 'VocabularyId' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AsrAnnotationStatus_type]integer', + 'type' => 'string', + 'required' => false, + 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", + 'title' => '', + ], + 'Vocabulary' => [ + 'description' => 'Hot word annotation content', + 'type' => 'string', + 'required' => false, + 'example' => '[]', + 'title' => '', + ], + 'VocabularyName' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_ScriptId_type]string', + 'type' => 'string', + 'required' => false, + 'example' => '咨询', + 'title' => '', + ], + 'VocabularyDescription' => [ + 'description' => 'Description', + 'type' => 'string', + 'required' => false, + 'example' => '售后咨询', + 'title' => '', + ], + 'VocabularyWeight' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_SequenceId_type]string', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + 'Delete' => [ + 'description' => 'Delete', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + 'Create' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationStatus_type]integer', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', + ], + 'AnnotationMissionChatCustomizationDataInfoList' => [ + 'description' => '[parameters_UserNick_in]query', + 'type' => 'array', + 'items' => [ + 'description' => '[parameters_AgentId_schema_type]string', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionChatCustomizationDataInfoId' => [ + 'description' => 'id', + 'type' => 'string', + 'required' => false, + 'example' => 'b598a47a-7c03-45fb-af6b-343950dd9512'."\n", + 'title' => '', + ], + 'CreateTime' => [ + 'description' => 'Creation Time', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1682316909210', + 'title' => '', + ], + 'ModifiedTime' => [ + 'description' => 'Updated At', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1673438100000', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => '实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'b598a47a-7c03-45fb-af6b-343950dd9512', + 'title' => '', + ], + 'AnnotationMissionId' => [ + 'description' => 'Annotation Job ID', + 'type' => 'string', + 'required' => false, + 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f', + 'title' => '', + ], + 'AnnotationMissionSessionId' => [ + 'description' => 'Session ID', + 'type' => 'string', + 'required' => false, + 'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n", + 'title' => '', + ], + 'AnnotationMissionChatId' => [ + 'description' => 'chat id', + 'type' => 'string', + 'required' => false, + 'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n", + 'title' => '', + ], + 'CustomizationDataId' => [ + 'description' => 'id', + 'type' => 'string', + 'required' => false, + 'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n", + 'title' => '', + ], + 'Content' => [ + 'description' => 'Content', + 'type' => 'string', + 'required' => false, + 'example' => '现在呢主动邀请到您，机会非常难得，而且额度放着不用，也是不收费的，可以当作咱们的备用金，最快5分钟就能到账，建议您可以先把额度免费领取下来呢。 ', + 'title' => '', + ], + 'CustomizationDataName' => [ + 'description' => 'Name', + 'type' => 'string', + 'required' => false, + 'example' => '默认数据', + 'title' => '', + ], + 'CustomizationDataDescription' => [ + 'description' => '描述', + 'type' => 'string', + 'required' => false, + 'example' => '默认数据描述', + 'title' => '', + ], + 'CustomizationDataWeight' => [ + 'description' => 'Language model data weight', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + 'Delete' => [ + 'description' => '删除', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + 'Create' => [ + 'description' => 'Creation', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', + ], + 'AnnotationMissionChatTagInfoList' => [ + 'description' => 'List of tag mapping relationships attached to annotated chat messages ', + 'type' => 'array', + 'items' => [ + 'description' => 'List of tag mapping relationships attached to annotated chat messages ', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionChatTagInfoId' => [ + 'description' => 'id', + 'type' => 'string', + 'required' => false, + 'example' => 'id', + 'title' => '', + ], + 'CreateTime' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_SubStatus_title]Annotation action: 1 correct, 20 mismatch error not optimized, 21 mismatch error optimized, 3 not overwritten, 4 invalid ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1679710866060', + 'title' => '', + ], + 'ModifiedTime' => [ + 'description' => 'Updated At ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1679710866060', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationAsrResult_type]string', + 'type' => 'string', + 'required' => false, + 'example' => '32be9d94-1346-4c4a-a4d0-ccd379f87013', + 'title' => '', + ], + 'AnnotationMissionId' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatId_type]string ', + 'type' => 'string', + 'required' => false, + 'example' => '977a45dc-b636-4407-9e98-9f572c709ada', + 'title' => '', + ], + 'AnnotationMissionSessionId' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_IntentAnnotationStatus_description]Semantics annotation status '."\n" + .'- 0: Not started (UNDO) '."\n" + .'- 1: In progress (DOING) '."\n" + .'- 2: Completed (DONE) '."\n" + .'- 3: Canceled (CLOSED) ', + 'type' => 'string', + 'required' => false, + 'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n", + 'title' => '', + ], + 'AnnotationMissionChatId' => [ + 'description' => 'chat id', + 'type' => 'string', + 'required' => false, + 'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n", + 'title' => '', + ], + 'AnnotationMissionTagInfoId' => [ + 'description' => 'tag id', + 'type' => 'string', + 'required' => false, + 'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n", + 'title' => '', + ], + 'AnnotationMissionTagInfoName' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_OriginalAsrResult_type]string ', + 'type' => 'string', + 'required' => false, + 'example' => '-', + 'title' => '', + ], + 'Delete' => [ + 'description' => 'Delete ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + 'Create' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_TranslationError_type]integer ', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Environment', + 'in' => 'query', + 'schema' => [ + 'description' => 'Environment '."\n" + .'- 0: NONE '."\n" + .'- 1: Private Cloud '."\n" + .'- 2: Public Cloud', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'AnnotationMissionDataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Source of annotation data: 1 for outbound calling, 2 for navigation', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Agent ID. '."\n" + ."\n" + .'> You can obtain it through the DescribeInstance API.', + 'type' => 'string', + 'required' => false, + 'example' => '1198938', + 'title' => '', + ], + ], + [ + 'name' => 'AgentKey', + 'in' => 'query', + 'schema' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatVocabularyInfoList_items_properties_VocabularyDescription_type]string', + 'type' => 'string', + 'required' => false, + 'example' => '9137ab9c27044921860030adf8590ec4_p_outbound_public', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<SaveAnnotationMissionSessionListResponse>', + 'description' => 'BaseResponse<SaveAnnotationMissionSessionListResponse>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatVocabularyInfoList_items_properties_InstanceId_description]instance ID', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatVocabularyInfoList_items_properties_Vocabulary_description]Hot word annotation content', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_type]object ', + 'type' => 'string', + 'example' => '执行失败：查找元素或操作超时,outTaskId:trademark_regnew_public_cn-zz4310rp1lb,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821', + 'title' => '', + ], + 'Data' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatTagInfoList_items_properties_Delete_type]boolean ', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatVocabularyInfoList_description]Table of hot word annotation information for the annotation job chat', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Message' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatTagInfoList_items_properties_ModifiedTime_type]integer', + 'type' => 'string', + 'example' => '执行失败：查找元素或操作超时,outTaskId:trademark_regnew_public_cn-zz4310rp1lb,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821', + 'title' => '', + ], + 'SaveAnnotationMissionSessionListRequest' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionSessionId_description]Session ID', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionSessionListJsonString' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_OccurTime_description]Trigger time', + 'type' => 'string', + 'example' => '[]', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'MessageList' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatVocabularyInfoList_items_description]Table of hot word annotation information for the annotation job chat', + 'type' => 'array', + 'items' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatVocabularyInfoList_items_properties_Delete_description]Delete', + 'type' => 'string', + 'example' => '[]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatTagInfoList_items_type]object ', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatTagInfoList_type]array ', + 'type' => 'string', + 'example' => '76E93048-F90F-57B7-BD46-6097611A706D', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionChatList_items_properties_AnnotationMissionChatVocabularyInfoList_items_properties_VocabularyDescription_description]Description', + 'summary' => '[parameters_AnnotationMissionSessionList_schema_items_properties_AnnotationMissionSessionId_type]string ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:SaveAnnotationMissionSessionList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'SaveAnnotationMissionTagInfoList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '129330', + 'abilityTreeNodes' => [ + 'FEATUREoutboundbotQHO52V', + ], + ], + 'parameters' => [ + [ + 'name' => 'AnnotationMissionTagInfoListJsonString', + 'in' => 'query', + 'schema' => [ + 'description' => 'Tag JSON data'."\n" + ."\n" + .'> The specific parameters in the JSON are the same as those in AnnotationMissionTagInfoList. You can specify either one.', + 'type' => 'string', + 'required' => false, + 'example' => '[{"delete":false, "InstanceId":"00b37342-e759-4fe5-b296-aef775933af0", "AnnotationMissionTagInfoName":"测试数据1", "AnnotationMissionTagInfoDescription":"测试"}]', + 'title' => '', + ], + ], + [ + 'name' => 'AnnotationMissionTagInfoList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of tags'."\n" + ."\n" + .'> This parameter is equivalent to AnnotationMissionTagInfoListJsonString. You only need to specify one of them.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of tags', + 'type' => 'object', + 'properties' => [ + 'AnnotationMissionTagInfoId' => [ + 'description' => 'tag id', + 'type' => 'string', + 'required' => false, + 'example' => 'bdbff6a5-1f68-4b41-8d37-6ff805ce165a'."\n", + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => false, + 'example' => 'bdbff6a5-1f68-4b41-8d37-6ff805ce165a', + 'title' => '', + ], + 'TenantId' => [ + 'description' => 'Tenant ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'bdbff6a5-1f68-4b41-8d37-6ff805ce165a'."\n", + 'title' => '', + ], + 'AnnotationMissionTagInfoName' => [ + 'description' => 'Tag Name', + 'type' => 'string', + 'required' => false, + 'example' => '标签', + 'title' => '', + ], + 'AnnotationMissionTagInfoDescription' => [ + 'description' => 'Tag Description', + 'type' => 'string', + 'required' => false, + 'example' => '标签描述', + 'title' => '', + ], + 'Delete' => [ + 'description' => 'Indicates whether to delete the tag.'."\n" + ."\n" + .'> Set this parameter to true to delete the tag or to false to add the tag.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Reset', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to recover the default tag value', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResponse<SaveAnnotationMissionTagInfoListResponse>', + 'description' => 'BaseResponse<SaveAnnotationMissionTagInfoListResponse>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the API call succeeded. true: The call succeeded. false: The call failed.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => '执行失败：查找元素或操作超时，outTaskId：trademark_regnew_public_cn-uax33hol2uu,flowId：null，nodeUUID：541b6c71-8cce-4ab0-af84-713ca9741821', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Data', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'ExecCount' => [ + 'description' => 'Number of successful executions', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => '执行失败：查找元素或操作超时，outTaskId：trademark_regnew_public_cn-uax33hol2uu，flowId：null，nodeUUID：541b6c71-8cce-4ab0-af84-713ca9741821', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP status code.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '1B356EDC-F69A-53B0-B4AF-2AC42200684E', + 'title' => '', + ], + ], + 'example' => '', + ], + ], + ], + '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' => 'Save annotation tag mapping', + 'summary' => 'Save instance tags in batch.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:SaveAnnotationMissionTagInfoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'SaveBaseStrategyPeriod' => [ + 'summary' => 'Edit the global callable time segments in system administration.', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'fe51eca2-a904-4b4d-b3ff-31be334b9500', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Policy level (Required) '."\n" + .'- 2: instance', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '2', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'OnlyWeekdays', + 'in' => 'query', + 'schema' => [ + 'description' => 'Call only from Monday to Friday. Defaults to false if left empty.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'WorkingTimeFramesJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'Running time', + 'type' => 'string', + 'required' => false, + 'example' => '[{"beginTime":"09:00:00","endTime":"21:00:00"}]', + 'title' => '', + ], + ], + [ + 'name' => 'WorkingTime', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Running time [Deprecated]', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'Running time', + 'example' => '[]', + 'title' => '', + ], + 'required' => false, + 'example' => '[]', + 'maxItems' => 99, + 'title' => '', + ], + ], + [ + 'name' => 'OnlyWorkdays', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + 'description' => 'Call only on non-holidays. Defaults to false if left empty.', + 'example' => 'false', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Edit Global Callable Time Segments', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2024-07-22T12:24:25.000Z', + 'description' => 'Response parameters changed', + ], + [ + 'createdAt' => '2023-03-08T14:50:30.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2022-01-12T12:20:26.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:SaveBaseStrategyPeriod', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'SaveContactBlockList' => [ + 'summary' => 'Add a "Do Not Call List" for the instance.', + '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' => 'A JSON-formatted string of the Do Not Call List (Required)'."\n" + ."\n" + .'- phonenumber: Phone number '."\n" + .'- remark: Remark '."\n" + .'- name: Name '."\n" + .'- creator: Creator ', + 'example' => '[{"phoneNumber":"132322","remark":"123321","name":"ccc1","creator":"ccc222"}]', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID (Required)', + 'example' => 'c3c92de8-e4bd-4db4-a962-50f8acce40bc', + 'required' => true, + 'type' => 'string', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'ContactBlockListList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of contact information [Deprecated]', + 'example' => '[]', + 'items' => [ + 'required' => false, + 'type' => 'string', + 'description' => 'List of contact information [Deprecated]', + 'example' => '[]', + 'title' => '', + ], + 'maxItems' => 99, + 'required' => false, + 'type' => 'array', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'AffectedRows' => [ + 'description' => 'Number of affected rows', + 'example' => '5', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Save Do Not Call List', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-01-12T12:20:26.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:SaveContactBlockList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'SaveContactWhiteList' => [ + 'summary' => 'Save the outbound call whitelist.', + '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' => 'Instance ID (Required)', + 'docRequired' => true, + 'example' => 'c415bb6c-2e6f-46aa-afd9-3b65b6dbe2bc', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ContactWhiteListsJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whitelist list (Required)', + 'example' => '[{"phoneNumber":"132322","remark":"123321","name":"ccc1","creator":"ccc222"}]', + 'required' => true, + 'type' => 'string', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'ContactWhiteListList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Contact whitelist list [Deprecated]', + 'example' => '{}', + 'items' => [ + 'required' => false, + 'type' => 'string', + 'description' => 'Outbound call whitelist [Deprecated]', + 'example' => '{}', + 'title' => '', + ], + 'maxItems' => 99, + 'required' => false, + 'type' => 'array', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'AffectedRows' => [ + 'description' => 'Number of affected rows', + 'example' => '1', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Save the outbound call whitelist', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:23.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-01-12T12:20:26.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:SaveContactWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'SaveEffectiveDays' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '94172', + 'abilityTreeNodes' => [ + 'FEATUREoutboundbot7ZIYMY', + ], + ], + 'parameters' => [ + [ + 'name' => 'EntryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'e90b5b8e-c8b4-4182-b28d-a5aa81685e49', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Policy level', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'title' => '', + ], + ], + [ + 'name' => 'EffectiveDays', + 'in' => 'query', + 'schema' => [ + 'description' => 'Effective period', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Save the Validity Period of the Basic Policy – Deprecated', + 'summary' => 'Save the validity period of the basic policy. This operation is deprecated.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'SaveMaxAttemptsPerDay' => [ + 'summary' => 'Save the daily call limit for the called number.', + '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' => 'Instance ID', + 'docRequired' => true, + 'example' => 'c8bf820a-6a8a-47bc-99bf-97593df8faa8', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'StrategyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Policy level (Required) '."\n" + .'- 2: instance', + 'example' => '2', + 'format' => 'int32', + 'required' => true, + 'type' => 'integer', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'MaxAttemptsPerDay', + 'in' => 'query', + 'schema' => [ + 'description' => 'Maximum number of redial attempts per day. Default value is 3 if not specified.', + 'example' => '3', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Save the daily call limit for the called number', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + [ + 'createdAt' => '2022-01-12T12:20:26.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:SaveMaxAttemptsPerDay', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'SearchTask' => [ + 'summary' => 'Search for jobs.', + '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' => 'Instance ID ', + 'example' => 'd481cebe-0bb6-4d13-9649-42ce5074fb75', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'TaskCreateTimeGte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job start time'."\n" + ."\n" + .'> This parameter must be used together with the job end time parameter TaskCreateTimeLte. Otherwise, it will be invalid.', + 'example' => '1646792941', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'TaskCreateTimeLte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job end time '."\n" + .'> This parameter must be used together with the job start time parameter TaskCreateTimeGte. Otherwise, it will be invalid.', + 'example' => '1646792941', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID ', + 'example' => '3a30ae7c-27b2-4305-9444-7185ced9d51f', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupNameQuery', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job group name ', + 'example' => '国寿财住院保续保_20220301_134130', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job ID ', + 'example' => '11994321-e6bc-47bb-8b1c-8eef8f2f768b', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Called Number', + 'example' => '15126426342', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'UserIdMatch', + 'in' => 'query', + 'schema' => [ + 'description' => 'User ID, the unique identifier of the user '."\n" + ."\n" + .'> This field is provided when uploading an outbound call list. '."\n" + .'> - If uploaded via JSON, the User ID corresponds to the value of referenceId. '."\n" + .'> - If uploaded via an Excel file, the User ID corresponds to the value of contactId. ', + 'example' => 'C01', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task ID', + 'example' => '744b27f3-437f-4a8c-a181-f668e492fd24', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ActualTimeGte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Call Start Time', + 'example' => '1646582400000', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'ActualTimeLte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Call End Time', + 'example' => '1643126399000', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'RecordingDurationGte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Minimum ringing duration for search ', + 'example' => '10', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'RecordingDurationLte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Maximum ringing duration for search', + 'example' => '60', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page index'."\n" + ."\n" + .'> The page index for this API starts from 0 by default.', + 'example' => '2', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of items'."\n" + ."\n" + .'> When this parameter is empty, the default value is 10.', + 'example' => '10', + 'format' => 'int32', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'OtherId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Other ID'."\n" + ."\n" + .'**Includes the following:**'."\n" + ."\n" + .'- sessionID'."\n" + ."\n" + .'- taskid'."\n" + ."\n" + .'- jobid', + 'example' => 'AVD-2021-39685', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'Sorting method. The default is actualTime.', + 'example' => 'actualTime', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'SortOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'Sorting order. Valid values: '."\n" + ."\n" + .'- asc (ascending) '."\n" + ."\n" + .'- desc (default): descending ', + 'example' => 'desc', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'CallDurationGte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Minimum call duration for search, in milliseconds ', + 'example' => '12341155', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'CallDurationLte', + 'in' => 'query', + 'schema' => [ + 'description' => 'Maximum call duration for search, in milliseconds ', + 'example' => '12341155', + 'format' => 'int64', + 'required' => false, + 'type' => 'integer', + 'title' => '', + ], + ], + [ + 'name' => 'JobStatusStringList', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job status. Separate multiple values with commas. When this field is not empty, it overwrites jobStatusList.'."\n" + ."\n" + .'- Scheduling: Scheduling.'."\n" + .'- Executing: Executing.'."\n" + .'- Succeeded: End – Reached.'."\n" + .'- Paused: Paused.'."\n" + .'- Failed: End – Not Reached.'."\n" + .'- Cancelled: Cancelled.', + 'example' => 'Succeeded', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'TaskStatusStringList', + 'in' => 'query', + 'schema' => [ + 'description' => 'Call status. Separate multiple values with commas. '."\n" + .'Value range: '."\n" + .'(Note: The **Succeeded** status has been subdivided by reason. The generic **Succeeded**: 1 (Answered) status will not be returned. Instead, only the specific subdivided reason types will be returned.)'."\n" + ."\n" + .'- **Executing**: 0 (Calling).'."\n" + .'- **Succeeded**: 1 (Answered).'."\n" + .'- **NoAnswer**: 2 (Not answered – No response).'."\n" + .'- **NotExist**: 3 (Not answered – Nonexistent number).'."\n" + .'- **Busy**: 4 (Not answered – Line busy).'."\n" + .'- **Cancelled**: 5 (Not dialed – Job stopped).'."\n" + .'- **Failed**: 6 (Failed).'."\n" + .'- **NotConnected**: 7 (Not answered – Unable to connect).'."\n" + .'- **PoweredOff**: 8 (Not answered – Powered off).'."\n" + .'- **OutOfService**: 9 (Not answered – Called party out of service).'."\n" + .'- **InArrears**: 10 (Not answered – Called party has overdue payment).'."\n" + .'- **EmptyNumber**: 11 (Not dialed – Nonexistent number, no call made).'."\n" + .'- **PerDayCallCountLimit**: 12 (Not dialed – Exceeded daily call limit).'."\n" + .'- **ContactBlockList**: 13 (Not dialed – Blacklist).'."\n" + .'- **CallerNotRegistered**: 14 (Not dialed – Caller number not registered).'."\n" + .'- **Terminated**: 15 (Not dialed – Terminated).'."\n" + .'- **VerificationCancelled**: 16 (Not dialed – Cancelled due to pre-call authentication failure).'."\n" + .'- **OutOfServiceNoCall**: 17 (Not dialed – Called party out of service, no call made).'."\n" + .'- **InArrearsNoCall**: 18 (Not dialed – Called party has overdue payment, no call made).'."\n" + .'- **CallingNumberNotExist**: 19 (Not dialed – Caller number does not exist).'."\n" + .'- **SucceededFinish**: 20 (Answered – Normal completion).'."\n" + .'- **SucceededChatbotHangUpAfterNoAnswer**: 21 (Answered – Bot hung up after unrecognized input).'."\n" + .'- **SucceededChatbotHangUpAfterSilence**: 22 (Answered – Bot hung up after silence timeout).'."\n" + .'- **SucceededClientHangUpAfterNoAnswer**: 23 (Answered – User hung up after unrecognized input).'."\n" + .'- **SucceededClientHangUp**: 24 (Answered – User hung up without reason).'."\n" + .'- **SucceededTransferByIntent**: 25 (Answered – Transferred to agent due to intent hit).'."\n" + .'- **SucceededTransferAfterNoAnswer**: 26 (Answered – Transferred to agent after unrecognized input).'."\n" + .'- **SucceededInoInterAction**: 27 (Answered – No interaction from user side).'."\n" + .'- **SucceededError**: 28 (Answered – Interrupted due to system exception).'."\n" + .'- **SucceededSpecialInterceptVoiceAssistant**: 29 (Answered – Intercepted under special condition – Voice assistant).'."\n" + .'- **SucceededSpecialInterceptExtensionNumberTransfer**: 30 (Answered – Intercepted under special condition – Extension transfer).'."\n" + .'- **SucceededSpecialInterceptCustomSpecialIntercept**: 31 (Answered – Intercepted under special condition – Custom intercept).'."\n" + .'- **HighRiskSipCode**: 32 (Not dialed – High-risk, no call made)', + 'example' => 'Executing', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptNameQuery', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario Name', + 'example' => '国寿财', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Calling number ', + 'type' => 'string', + 'required' => false, + 'example' => '051085500215', + 'title' => '', + ], + ], + [ + 'name' => 'LabelsJson', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'maxItems' => 100, + 'description' => 'Tag filtering conditions for calls '."\n" + ."\n" + .'> This condition supports filtering only by tags that have specific enumeration tag values configured, specifically those tags with explicit tag values configured in the LLM scenario. ', + 'type' => 'array', + 'items' => [ + 'description' => 'Tags to filter and their corresponding tag values. '."\n" + ."\n" + .'> Filters all calls that match specific tags and their specific tag values. '."\n" + .'For example: {"ValueList":["Satisfied","Dissatisfied"],"Name":"Satisfaction"} indicates filtering all calls where the "Satisfaction" tag has the value "Satisfied" or "Dissatisfied". ', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "ValueList": ['."\n" + .' "满意",'."\n" + .' "不满意"'."\n" + .' ],'."\n" + .' "Name": "是否满意"'."\n" + .' }', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'PageIndex' => [ + 'description' => 'Page number', + 'example' => '0', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded.', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Request status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'PageSize' => [ + 'description' => 'Number of items per page', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Total' => [ + 'description' => 'Total number of items', + 'example' => '2', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'SearchTaskInfoList' => [ + 'description' => 'Job list', + 'example' => '[]', + 'items' => [ + 'description' => 'Job List ', + 'properties' => [ + 'JobGroupName' => [ + 'description' => 'Job group name', + 'example' => '85成新（有笔记划线）2021_11_14_18_00_51', + 'type' => 'string', + 'title' => '', + ], + 'UserId' => [ + 'description' => 'User ID', + 'example' => '12334134', + 'type' => 'string', + 'title' => '', + ], + 'ActualTime' => [ + 'description' => 'Actual running time', + 'example' => '1643436089677', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'CalledNumber' => [ + 'description' => 'Called number ', + 'example' => '15205879599', + 'type' => 'string', + 'title' => '', + ], + 'TaskStatusString' => [ + 'description' => 'Task Status '."\n" + .'Value range: '."\n" + .'(Note: The **Succeeded** status has been further categorized by reason. The generic **Succeeded**: 1 (Connected) status will no longer be displayed. Subsequent responses will always return a specific detailed reason.)'."\n" + ."\n" + .'- **Executing**: 0 (Calling in progress). '."\n" + .'- **Succeeded**: 1 (Connected). '."\n" + .'- **NoAnswer**: 2 (Not connected – No answer). '."\n" + .'- **NotExist**: 3 (Not connected – Nonexistent number). '."\n" + .'- **Busy**: 4 (Not connected – Line busy). '."\n" + .'- **Cancelled**: 5 (Not dialed – Job stopped). '."\n" + .'- **Failed**: 6 (Failed). '."\n" + .'- **NotConnected**: 7 (Not connected – Unable to reach). '."\n" + .'- **PoweredOff**: 8 (Not connected – Powered off). '."\n" + .'- **OutOfService**: 9 (Not connected – Called party suspended). '."\n" + .'- **InArrears**: 10 (Not connected – Called party has overdue payment). '."\n" + .'- **EmptyNumber**: 11 (Not dialed – Nonexistent number, not called). '."\n" + .'- **PerDayCallCountLimit**: 12 (Not dialed – Exceeded daily call limit). '."\n" + .'- **ContactBlockList**: 13 (Not dialed – Blacklist). '."\n" + .'- **CallerNotRegistered**: 14 (Not dialed – Caller number not registered). '."\n" + .'- **Terminated**: 15 (Not dialed – Terminated). '."\n" + .'- **VerificationCancelled**: 16 (Not dialed – Cancelled due to failed pre-call authentication). '."\n" + .'- **OutOfServiceNoCall**: 17 (Not dialed – Called party suspended, not called). '."\n" + .'- **InArrearsNoCall**: 18 (Not dialed – Called party has overdue payment, not called). '."\n" + .'- **CallingNumberNotExist**: 19 (Not dialed – Caller number does not exist). '."\n" + .'- **SucceededFinish**: 20 (Connected – Normal completion). '."\n" + .'- **SucceededChatbotHangUpAfterNoAnswer**: 21 (Connected – Bot hung up after unrecognized input). '."\n" + .'- **SucceededChatbotHangUpAfterSilence**: 22 (Connected – Bot hung up after silence timeout). '."\n" + .'- **SucceededClientHangUpAfterNoAnswer**: 23 (Connected – User hung up after unrecognized input). '."\n" + .'- **SucceededClientHangUp**: 24 (Connected – User hung up without reason). '."\n" + .'- **SucceededTransferByIntent**: 25 (Connected – Transferred to agent due to intent match). '."\n" + .'- **SucceededTransferAfterNoAnswer**: 26 (Connected – Transferred to agent after unrecognized input). '."\n" + .'- **SucceededInoInterAction**: 27 (Connected – No interaction from user side). '."\n" + .'- **SucceededError**: 28 (Connected – Interrupted due to system exception). '."\n" + .'- **SucceededSpecialInterceptVoiceAssistant**: 29 (Connected – Intercepted under special condition – Voice assistant). '."\n" + .'- **SucceededSpecialInterceptExtensionNumberTransfer**: 30 (Connected – Intercepted under special condition – Extension transfer). '."\n" + .'- **SucceededSpecialInterceptCustomSpecialIntercept**: 31 (Connected – Intercepted under special condition – Custom intercept). '."\n" + .'- **HighRiskSipCode**: 32 (Not dialed – High-risk, not called).'."\n", + 'example' => 'Executing', + 'type' => 'string', + 'title' => '', + ], + 'TaskStatusName' => [ + 'description' => 'Call status display content '."\n" + .'Value range '."\n" + .'(Note: The **Succeeded** status has been further categorized by reason and will no longer be displayed as **Succeeded**: 1 (Answered). Subsequent responses will use specific detailed reason types.)'."\n" + ."\n" + .'- **Executing**: 0 (Calling in progress). '."\n" + .'- **Succeeded**: 1 (Answered). '."\n" + .'- **NoAnswer**: 2 (Not answered – No response). '."\n" + .'- **NotExist**: 3 (Not answered – Nonexistent number). '."\n" + .'- **Busy**: 4 (Not answered – Line busy). '."\n" + .'- **Cancelled**: 5 (Not dialed – Job stopped). '."\n" + .'- **Failed**: 6 (Failed). '."\n" + .'- **NotConnected**: 7 (Not answered – Unable to connect). '."\n" + .'- **PoweredOff**: 8 (Not answered – Powered off). '."\n" + .'- **OutOfService**: 9 (Not answered – Called party suspended). '."\n" + .'- **InArrears**: 10 (Not answered – Called party has overdue payment). '."\n" + .'- **EmptyNumber**: 11 (Not dialed – Nonexistent number, not called). '."\n" + .'- **PerDayCallCountLimit**: 12 (Not dialed – Exceeded daily call limit). '."\n" + .'- **ContactBlockList**: 13 (Not dialed – Blacklist). '."\n" + .'- **CallerNotRegistered**: 14 (Not dialed – Caller number not registered). '."\n" + .'- **Terminated**: 15 (Not dialed – Terminated). '."\n" + .'- **VerificationCancelled**: 16 (Not dialed – Cancelled due to pre-call authentication failure). '."\n" + .'- **OutOfServiceNoCall**: 17 (Not dialed – Called party suspended, not called). '."\n" + .'- **InArrearsNoCall**: 18 (Not dialed – Called party has overdue payment, not called). '."\n" + .'- **CallingNumberNotExist**: 19 (Not dialed – Caller number does not exist). '."\n" + .'- **SucceededFinish**: 20 (Answered – Normal completion). '."\n" + .'- **SucceededChatbotHangUpAfterNoAnswer**: 21 (Answered – Bot hung up after unrecognized input). '."\n" + .'- **SucceededChatbotHangUpAfterSilence**: 22 (Answered – Bot hung up after silence timeout). '."\n" + .'- **SucceededClientHangUpAfterNoAnswer**: 23 (Answered – User hung up after unrecognized input). '."\n" + .'- **SucceededClientHangUp**: 24 (Answered – User hung up without reason). '."\n" + .'- **SucceededTransferByIntent**: 25 (Answered – Transferred to agent due to intent match). '."\n" + .'- **SucceededTransferAfterNoAnswer**: 26 (Answered – Transferred to agent after unrecognized input). '."\n" + .'- **SucceededInoInterAction**: 27 (Answered – No interaction from user side). '."\n" + .'- **SucceededError**: 28 (Answered – Call interrupted due to system exception). '."\n" + .'- **SucceededSpecialInterceptVoiceAssistant**: 29 (Answered – Intercepted under special circumstances – Voice assistant). '."\n" + .'- **SucceededSpecialInterceptExtensionNumberTransfer**: 30 (Answered – Intercepted under special circumstances – Extension transfer). '."\n", + 'example' => '正在拨打', + 'type' => 'string', + 'title' => '', + ], + 'JobStatus' => [ + 'description' => 'Job status'."\n" + ."\n\n" + ."\n" + .'- 0: Scheduling'."\n" + .'- 1: Executing'."\n" + .'- 2: Succeeded'."\n" + .'- 3: Paused'."\n" + .'- 4: Failed'."\n" + .'- 5: Cancelled', + 'example' => '0', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'DialException' => [ + 'description' => 'Abnormal condition', + 'example' => '[{"code":"OutboundCallError.SipCodeError", "params":[{"key":"SipCode","value":"500"}]}]', + 'type' => 'string', + 'title' => '', + ], + 'UserName' => [ + 'description' => 'Username', + 'example' => 'xxx', + 'type' => 'string', + 'title' => '', + ], + 'CallDurationDisplay' => [ + 'description' => 'Call duration', + 'example' => '47″', + 'type' => 'string', + 'title' => '', + ], + 'HasAnswered' => [ + 'description' => 'Whether there is an acknowledgement ', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'JobStatusName' => [ + 'description' => 'Job status display content'."\n" + ."\n" + .'- 0: Scheduling'."\n" + .'- 1: Executing'."\n" + .'- 2: Succeeded'."\n" + .'- 3: Paused'."\n" + .'- 4: Failed'."\n" + .'- 5: Cancelled', + 'example' => '调度中', + 'type' => 'string', + 'title' => '', + ], + 'CallDuration' => [ + 'description' => 'Call duration, in milliseconds. ', + 'example' => '46000', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'TaskCreateTime' => [ + 'description' => 'Job creation time', + 'example' => '1646792941', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'JobStatusString' => [ + 'description' => 'Job Status'."\n" + ."\n" + .'- Scheduling: Scheduling (0)'."\n" + .'- Executing: Executing (1)'."\n" + .'- Succeeded: End – Reached (2)'."\n" + .'- Paused: Paused (3)'."\n" + .'- Failed: Failed – Busy (4)'."\n" + .'- Cancelled: Cancelled (5)', + 'example' => 'Scheduling', + 'type' => 'string', + 'title' => '', + ], + 'HasReachedEndOfFlow' => [ + 'description' => 'Conversation completed', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'InstanceId' => [ + 'description' => 'Instance ID', + 'example' => '73df6283-26b2-402d-bad0-ffa489923ea1', + 'type' => 'string', + 'title' => '', + ], + 'HasHangUpByRejection' => [ + 'description' => 'Hang up due to rejection ', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'TaskEndReason' => [ + 'description' => 'Reason for job termination'."\n" + ."\n" + .'- FINISHED(1, "Normal completion"),'."\n" + ."\n" + .'- CHATBOT_HANGUP_AFTER_NOANSWER(2, "Chatbot hang-up after no answer"),'."\n" + .'- CHATBOT_HANGUP_AFTER_SILENCE(3, "Chatbot hang-up due to silence timeout"),'."\n" + .'- CLIENT_HANGUP_AFTER_NOANSWER(4, "User hang-up after no answer"),'."\n" + .'- CLIENT_HANGUP(5, "User hang-up without reason"),'."\n" + .'- TRANSFER_BY_INTENT(6, "Transfer to agent after intent hit"),'."\n" + .'- TRANSFER_AFTER_NOANSWER(7, "Transfer to agent after no answer"),'."\n" + .'- NO_INTERACTION(8, "No interaction from user side"),'."\n" + .'- ERROR(9, "System Exception break"),'."\n" + ."\n" + .'- SPECIAL_INTERCEPT_VOICE_ASSISTANT(10, "Special case interception – voice assistant"),'."\n" + .'- SPECIAL_INTERCEPT_EXTENSION_NUMBER_TRANSFER(11, "Special case interception – extension number transfer");', + 'example' => 'OutOfService', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'JobGroupId' => [ + 'description' => 'Job group ID', + 'example' => '37db3113-ad34-4ba3-b930-468f016bbf95', + 'type' => 'string', + 'title' => '', + ], + 'TaskStatus' => [ + 'description' => 'Value range '."\n" + .'(Note: The **Succeeded** status has been further categorized by reason. The generic **Succeeded**: 1 (Connected) status will not be displayed. Subsequent responses will only show specific sub-reason types.)'."\n" + ."\n" + .'- **Executing**: 0 (Calling in progress). '."\n" + .'- **Succeeded**: 1 (Connected). '."\n" + .'- **NoAnswer**: 2 (Not connected – No answer). '."\n" + .'- **NotExist**: 3 (Not connected – Nonexistent number). '."\n" + .'- **Busy**: 4 (Not connected – Line busy). '."\n" + .'- **Cancelled**: 5 (Not dialed – Job stopped). '."\n" + .'- **Failed**: 6 (Failed). '."\n" + .'- **NotConnected**: 7 (Not connected – Unable to reach). '."\n" + .'- **PoweredOff**: 8 (Not connected – Powered off). '."\n" + .'- **OutOfService**: 9 (Not connected – Called party suspended). '."\n" + .'- **InArrears**: 10 (Not connected – Called party has overdue payment). '."\n" + .'- **EmptyNumber**: 11 (Not dialed – Nonexistent number, no call made). '."\n" + .'- **PerDayCallCountLimit**: 12 (Not dialed – Exceeded daily call limit). '."\n" + .'- **ContactBlockList**: 13 (Not dialed – Blacklist). '."\n" + .'- **CallerNotRegistered**: 14 (Not dialed – Caller number not registered). '."\n" + .'- **Terminated**: 15 (Not dialed – Terminated). '."\n" + .'- **VerificationCancelled**: 16 (Not dialed – Cancelled due to failed pre-call authentication). '."\n" + .'- **OutOfServiceNoCall**: 17 (Not dialed – Called party suspended, no call made). '."\n" + .'- **InArrearsNoCall**: 18 (Not dialed – Called party has overdue payment, no call made). '."\n" + .'- **CallingNumberNotExist**: 19 (Not dialed – Caller number does not exist). '."\n" + .'- **SucceededFinish**: 20 (Connected – Normal completion). '."\n" + .'- **SucceededChatbotHangUpAfterNoAnswer**: 21 (Connected – Bot hung up after unrecognized input). '."\n" + .'- **SucceededChatbotHangUpAfterSilence**: 22 (Connected – Bot hung up after silence timeout). '."\n" + .'- **SucceededClientHangUpAfterNoAnswer**: 23 (Connected – User hung up after unrecognized input). '."\n" + .'- **SucceededClientHangUp**: 24 (Connected – User hung up without reason). '."\n" + .'- **SucceededTransferByIntent**: 25 (Connected – Transferred to agent due to intent match). '."\n" + .'- **SucceededTransferAfterNoAnswer**: 26 (Connected – Transferred to agent after unrecognized input). '."\n" + .'- **SucceededInoInterAction**: 27 (Connected – No interaction from user side). '."\n" + .'- **SucceededError**: 28 (Connected – Interrupted due to system exception). '."\n" + .'- **SucceededSpecialInterceptVoiceAssistant**: 29 (Connected – Blocked under special circumstances – Voice assistant). '."\n" + .'- **SucceededSpecialInterceptExtensionNumberTransfer**: 30 (Connected – Blocked under special circumstances – Extension transfer). ', + 'example' => '0', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'JobId' => [ + 'description' => 'Job ID', + 'example' => '6203248e-e652-4ef8-a1eb-586ed7b54dc2', + 'type' => 'string', + 'title' => '', + ], + 'RecordingDuration' => [ + 'description' => 'Ringing duration, in seconds.', + 'example' => '10', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'TaskId' => [ + 'description' => 'Job ID ', + 'example' => '479aea04-3a92-4ac3-935d-c8798c667850', + 'type' => 'string', + 'title' => '', + ], + 'DialExceptionOld' => [ + 'description' => 'Abnormal condition', + 'example' => '["OutboundCallError.SipTrunkError"]', + 'type' => 'string', + 'title' => '', + ], + 'DialExceptionCodes' => [ + 'description' => 'Field used for displaying remarks on the page ', + 'items' => [ + 'description' => 'List of API exception codes ', + 'example' => '[ { "code":"OutboundCallError.SipCodeError", "hint":"线路侧异常码:480, 首先确定主叫和被叫正确，其次再联系号码和线路的供应商处理!" } ]', + 'type' => 'string', + 'title' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'HasLastPlaybackCompleted' => [ + 'description' => 'Whether the last playback was completed before hang-up', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'ScriptName' => [ + 'description' => 'Scenario Name', + 'example' => '慢病线索', + 'type' => 'string', + 'title' => '', + ], + 'CallingNumber' => [ + 'description' => 'Calling number', + 'type' => 'string', + 'example' => '02152739269', + 'title' => '', + ], + 'Labels' => [ + 'description' => 'The label hit status of the current outbound call', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'K' => [ + 'description' => 'Tag Name', + 'type' => 'string', + 'example' => '是否满意', + 'title' => '', + ], + 'V' => [ + 'description' => 'The hit tag value', + 'type' => 'string', + 'example' => '是', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + ], + 'VariableNames' => [ + 'description' => 'Full set of tag name keys', + 'type' => 'array', + 'items' => [ + 'description' => 'Full set of tag keys', + 'type' => 'string', + 'example' => '["是否满意","是否是本人","是否收到"]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Labels' => [ + 'description' => 'Tag information that can be used as filter conditions.'."\n" + ."\n" + .'> Displays all tags with enumeration values in this task group.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'Tag Name', + 'type' => 'string', + 'example' => '是否满意', + 'title' => '', + ], + 'ValueList' => [ + 'description' => 'List of tag values', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag value', + 'type' => 'string', + 'example' => '["否","是"]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Search Job', + 'changeSet' => [ + [ + 'createdAt' => '2025-09-10T13:09:37.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2025-07-14T12:16:13.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + [ + 'createdAt' => '2021-11-24T13:03:33.000Z', + 'description' => 'OpenAPI offline', + ], + [ + 'createdAt' => '2021-11-24T13:03:33.000Z', + 'description' => 'Request parameters changed, Response parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:SearchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'StartJob' => [ + 'summary' => 'Initiate a call directly without going through the CDN mapping system. This API is available only to whitelist users.', + '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' => 'Instance ID', + 'docRequired' => true, + 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID', + 'example' => '4f21446e-324e-46f2-bf62-7f341fb004ea', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScenarioId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID, used for compatibility with the legacy outbound calling feature. This parameter is optional.', + 'docRequired' => false, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'JobJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job data, including the following content:'."\n" + ."\n" + .'extras // Optional additional information'."\n" + .'- key // Key of the custom variable content'."\n" + .'- value // Value of the custom variable content'."\n" + ."\n" + .'contacts // Required field; callee contact information'."\n" + .'- phoneNumber // Required field; callee phone number'."\n" + .'- referenceId // Required field; contact ID (user-defined), primarily used to avoid duplicate names'."\n" + .'- role // Optional field; role of this contact in the outbound call scenario; if unspecified, no distinction is made'."\n" + .'- honorific // Optional field; honorific title for the contact'."\n" + .'- name // Optional field; contact name', + '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" + .'}', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Scenario ID (Required)', + 'example' => '1eeae263-54ca-4a52-ae14-62da58f3c473', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of calling numbers', + 'example' => '10086', + 'items' => [ + 'type' => 'string', + 'description' => 'Calling number', + 'required' => false, + 'example' => '05710*******', + 'title' => '', + ], + 'maxItems' => 99, + 'required' => false, + 'type' => 'array', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '8a621aa1-d2e7-43f3-b54d-8830af73c468', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the invocation succeeded. true: The invocation succeeded. false: Failed to invoke.', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'TaskIds' => [ + 'description' => 'Mapping between third-party contact IDs and outbound calling system task IDs', + 'items' => [ + 'properties' => [ + 'Key' => [ + 'description' => 'Third-party ID of the contact', + 'example' => 'c93cdd1c-f9b5-4758-be43-7a237a7eaa1d', + 'type' => 'string', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Task ID in the outbound calling system', + 'example' => '62229628-45d8-41bd-a80f-6e4c0a39f79b', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'CallIds' => [ + 'description' => 'List of call IDs', + 'items' => [ + 'properties' => [ + 'Key' => [ + 'description' => 'Third-party ID of the contact', + 'example' => 'c93cdd1c-f9b5-4758-be43-7a237a7eaa1d', + 'type' => 'string', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Call ID of the job', + 'example' => '62229628-45d8-41bd-a80f-6e4c0a39f79b', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Create a job', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:StartJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'SubmitBatchJobs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID', + 'docRequired' => true, + 'example' => '6b3ea2a1-32b3-4041-842b-9bde5de9dda0', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Submit a job group in Draft status for execution – Deprecated', + 'summary' => 'Submit a job group in Draft status for execution. This operation is deprecated.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:SubmitBatchJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'SubmitRecording' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job ID', + 'docRequired' => true, + 'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceRecording', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script recording data', + 'example' => '{"contactId":"3d35c0487cc041abb7ad0ce61752601f","duration":27,"fileName":"ce2659e5-a20b-4f8e-91b5-5cd909c6b96e_3d35c0487cc041abb7ad0ce61752601f.wav","filePath":"oss://ForCompatibility/waveforms/","startTime":1579057583670,"type":"Source"}', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'MergedRecording', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script recording data', + 'docRequired' => true, + 'example' => '{"contactId":"3d35c0487cc041abb7ad0ce61752601f","duration":27,"fileName":"ce2659e5-a20b-4f8e-91b5-5cd909c6b96e_3d35c0487cc041abb7ad0ce61752601f.wav","filePath":"oss://ForCompatibility/waveforms/","startTime":1579057583670,"type":"Merged"}', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message.', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded.', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Submit Call Recordings to Outbound Calls – Deprecated', + 'summary' => 'Submit call recordings to outbound calls. This API is deprecated.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:SubmitRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'SubmitScriptReview' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID', + 'docRequired' => true, + 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'Description', + 'docRequired' => true, + 'example' => '第一版本提交审核', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => 'Source of the submission for review', + 'type' => 'string', + 'required' => false, + 'example' => 'MAINSITE', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Submit a scenario for publish review', + 'summary' => 'Submit a scenario for publish review.', + 'changeSet' => [ + [ + 'createdAt' => '2023-06-20T12:50:03.000Z', + 'description' => 'Request parameters changed, Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:SubmitScriptReview', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'SuspendCall' => [ + 'summary' => 'Stop calls based on the list data.', + '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' => 'Instance ID (Required)', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a5fc6490-ef1e-4666-870a-07a4e586c414', + 'title' => '', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID (Required)', + 'type' => 'string', + 'required' => false, + 'example' => 'f745881b-343d-43e4-9c51-31b7b063031c', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'CalledNumbers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of called numbers', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'description' => 'List of called numbers', + 'example' => '15107137208', + 'title' => '', + ], + 'required' => false, + 'example' => '[]', + 'maxItems' => 99, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Stop calls based on the list data.', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:23.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:SuspendCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'SuspendCallWithFile' => [ + 'summary' => 'Stop calling based on file data.', + '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' => 'Instance ID (Required)', + 'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e', + 'required' => false, + 'type' => 'string', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Task group ID (Required)', + 'example' => '0197261b-30e6-467b-83d6-7f72af868b03', + 'required' => false, + 'type' => 'string', + 'docRequired' => true, + 'title' => '', + ], + ], + [ + 'name' => 'FilePath', + 'in' => 'query', + 'schema' => [ + 'description' => 'File Path (Required)'."\n" + ."\n" + .'> You can obtain the value of this parameter by invoking the GetJobDataUploadParams API to upload a file and retrieving the Folder response parameter, then passing it into FilePath.', + 'example' => 'xxxx', + 'required' => false, + 'type' => 'string', + 'docRequired' => true, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Stop calling based on file data', + 'changeSet' => [ + [ + 'createdAt' => '2025-07-30T08:33:24.000Z', + 'description' => 'Request parameters changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:SuspendCallWithFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'SuspendJobs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Instance ID.', + 'docRequired' => true, + 'example' => 'ef4c09ac-2f5c-49e7-9d33-5d85249cee10', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition indicating whether to pause all jobs.', + 'docRequired' => true, + 'example' => 'false', + 'required' => true, + 'type' => 'boolean', + 'title' => '', + ], + ], + [ + 'name' => 'ScenarioId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition: scenario ID (historical parameter, deprecated).', + 'example' => '4b6dd926-3cc3-4111-a333-15d9b006fe81', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'JobGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter condition: task group ID.', + 'example' => '6b3ea2a1-32b3-4041-842b-9bde5de9dda0', + 'required' => false, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of job IDs.'."\n" + ."\n" + .'> When All is false, JobId is required.', + 'example' => '11994321-e6bc-47bb-8b1c-8eef8f2f768b', + 'items' => [ + 'type' => 'string', + 'description' => 'Job ID.', + 'required' => false, + 'example' => '11994321-e6bc-47bb-8b1c-8eef8f2f768b', + 'title' => '', + ], + 'maxItems' => 99, + 'required' => false, + 'type' => 'array', + 'title' => '', + ], + ], + [ + 'name' => 'JobReferenceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Third-party ID of the job.'."\n" + ."\n" + .'> This corresponds to the ReferenceId uploaded by the customer when uploading the outbound calling list.', + 'example' => 'de3ab269-6746-477c-b13d-bd49f13202c2', + 'items' => [ + 'type' => 'string', + 'description' => 'Third-party ID of the job.', + 'required' => false, + 'example' => 'de3ab269-6746-477c-b13d-bd49f13202c2', + 'title' => '', + ], + 'maxItems' => 99, + 'required' => false, + 'type' => 'array', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code.', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '1364f208-982d-4d0c-89aa-d56e22b47589', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Pause Job', + 'summary' => 'Pause a job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:SuspendJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'TagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Deprecated', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Resource type', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'INSTANCE', + 'enumValueTitles' => [ + 'INSTANCE' => 'INSTANCE', + ], + 'title' => '', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of resource IDs. The value range of n is [1, 50].', + 'type' => 'array', + 'items' => [ + 'description' => 'Resource ID. When the resource type is INSTANCE, specify the instance ID.', + 'type' => 'string', + 'required' => false, + 'example' => '254EB005-EEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'required' => true, + 'example' => 'ResourceId.1=b949ae1f-01dc-4191-ae5a-70fbe6772fd8', + 'maxItems' => 51, + 'title' => '', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of tags. '."\n" + .'If the key and value differ from existing tags, a new tag is created. '."\n" + .'> You can obtain the tags of instances by calling the ListResourceTags API.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag key. The value range of n is [1, 20].', + 'type' => 'string', + 'required' => false, + 'example' => 'Tag.1.Key=key1', + 'title' => '', + ], + 'Value' => [ + 'description' => 'Tag value. The value range of n is [1, 20].', + 'type' => 'string', + 'required' => false, + 'example' => 'Tag.1.Value=value1', + 'title' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 21, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Status code of the API', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Message returned by the API', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Add tags to instance resources', + 'summary' => 'Add tags to instance resources.', + 'description' => '**', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + [ + 'createdAt' => '2024-07-22T12:24:25.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'TaskPreparing' => [ + 'summary' => 'Prepare to execute the job.', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '33040b9a-b04b-452f-b554-cd6f3a15f850', + 'title' => '', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c9e42cd7-ba99-4872-9802-e05719ab051c', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceOwnerId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Account ID of the instance owner', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1971226538081821', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Succes', + 'title' => '', + ], + 'TaskId' => [ + 'description' => 'Job ID', + 'type' => 'string', + 'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Prepare to execute the job', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:TaskPreparing', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', + 'title' => '', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Call ID'."\n" + ."\n" + .'> You can obtain it by calling the DescribeJob API.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1528189846043', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Stop Call', + 'summary' => 'Stop a call during the call procedure.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:TerminateCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'UntagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Region', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Resource type. Default value: INSTANCE.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'INSTANCE', + 'enumValueTitles' => [ + 'INSTANCE' => 'INSTANCE', + ], + 'title' => '', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to delete all tags. This parameter takes effect only when TagKey.N is empty. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'Default value: false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of resource IDs. By default, this is a list of instance IDs. The value range for n is 1 to 50.', + 'type' => 'array', + 'items' => [ + 'description' => 'Resource ID. By default, this is an instance ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'ResourceId.1=b949ae1f-01dc-4191-ae5a-70fbe6772fd8', + 'title' => '', + ], + 'required' => true, + 'maxItems' => 51, + 'example' => '', + 'title' => '', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of tag keys. The value range for n is 1 to 20.', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag key', + 'type' => 'string', + 'required' => false, + 'example' => 'TagKey.1=key1', + 'title' => '', + ], + 'required' => false, + 'maxItems' => 21, + 'example' => '', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Returned data', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Code' => [ + 'description' => 'API status code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded.', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Delete resource tags', + 'summary' => 'Delete resource tags.', + 'changeSet' => [ + [ + 'createdAt' => '2024-07-22T12:24:24.000Z', + 'description' => 'Error codes changed', + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:UntagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'Instance ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c209abb3-6804-4a75-b2c7-dd55c8c61b6a', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'type' => 'string', + 'required' => true, + 'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95', + 'title' => '', + ], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Key of the file in OSS', + 'type' => 'string', + 'required' => true, + 'example' => 'cab_script_recording/upload/88a56c18-3dc8-4338-9116-911deb169780/hello.wav', + 'title' => '', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => 'File name', + 'type' => 'string', + 'required' => true, + 'example' => 'hello.wav', + 'title' => '', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => 'Text content of the recording file', + 'type' => 'string', + 'required' => true, + 'example' => '您好', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + 'title' => '', + ], + 'Uuid' => [ + 'description' => 'Unique ID of the recording', + 'type' => 'string', + 'example' => '5feaab8a-97fd-4720-8108-79e017f2d3ac', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Return code', + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Message' => [ + 'description' => 'API message', + 'type' => 'string', + 'example' => 'Success', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[Deprecated] Upload script recording', + 'summary' => 'Upload a recording file.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:UploadScriptRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + 'WithdrawScriptReview' => [ + 'summary' => 'Revoke script review.', + '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' => 'Instance ID', + 'docRequired' => true, + 'example' => '38d2e8ed-04e9-4dac-83b5-a8e57642ef13', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + [ + 'name' => 'ScriptId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Script ID', + 'docRequired' => true, + 'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503', + 'required' => true, + 'type' => 'string', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'properties' => [ + 'HttpStatusCode' => [ + 'description' => 'HTTP status code', + 'example' => '200', + 'format' => 'int32', + 'type' => 'integer', + 'title' => '', + ], + 'Code' => [ + 'description' => 'Response code', + 'example' => 'OK', + 'type' => 'string', + 'title' => '', + ], + 'Message' => [ + 'description' => 'Response message', + 'example' => 'Success', + 'type' => 'string', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', + 'type' => 'string', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation succeeded', + 'example' => 'true', + 'type' => 'boolean', + 'title' => '', + ], + 'Script' => [ + 'description' => 'Script information', + 'properties' => [ + 'Status' => [ + 'description' => 'Application Version status', + 'example' => 'PUBLISHED', + 'type' => 'string', + 'title' => '', + ], + 'UpdateTime' => [ + 'description' => 'Update Time', + 'example' => '1578881227000', + 'format' => 'int64', + 'type' => 'integer', + 'title' => '', + ], + 'Industry' => [ + 'description' => 'Industry', + 'example' => '金融', + 'type' => 'string', + 'title' => '', + ], + 'ScriptDescription' => [ + 'description' => 'Script Description', + 'example' => '销售话术', + 'type' => 'string', + 'title' => '', + ], + 'IsDrafted' => [ + 'description' => 'Indicates whether the Application Version is in Draft status', + 'example' => 'false', + 'type' => 'boolean', + 'title' => '', + ], + 'DebugStatus' => [ + 'description' => 'Debug status', + 'example' => 'PUBLISHED', + 'type' => 'string', + 'title' => '', + ], + 'ScriptId' => [ + 'description' => 'Script ID', + 'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503', + 'type' => 'string', + 'title' => '', + ], + 'IsDebugDrafted' => [ + 'description' => 'Indicates whether the debug version is in Draft status', + 'example' => 'false', + 'type' => 'boolean', + 'title' => '', + ], + 'ScriptName' => [ + 'description' => 'Script Name', + 'example' => '销售话术', + 'type' => 'string', + 'title' => '', + ], + 'Scene' => [ + 'description' => 'Scenario', + 'example' => '电销', + 'type' => 'string', + 'title' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Revoke script review', + 'description' => '****', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:WithdrawScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shanghai', + 'regionName' => 'China (Shanghai)', + 'areaId' => 'asiaPacific', + 'areaName' => 'Asia Pacific', + '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' => 'No permission to operate the instance', + ], + [ + 'code' => 'Permission.Task', + 'message' => 'you are not permitted to operate this task.', + 'http_code' => 403, + 'description' => 'No permission to operate the task.', + ], + [ + 'code' => 'TaskExport.ExceedExportMaxLimit', + 'message' => 'exceed export max limit 500000, Please reselect the query conditions.', + 'http_code' => 404, + 'description' => 'The number is too large, more than 500000, please re-screen and download', + ], + ], + 'changeSet' => [ + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'GetTaskByUuid', + ], + ], + 'createdAt' => '2025-11-18T12:12:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'ListScripts', + ], + ], + 'createdAt' => '2025-03-26T03:21:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'ListJobGroups', + ], + ], + 'createdAt' => '2025-02-15T02:02:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Error codes changed', + 'api' => 'DeleteContactWhiteList', + ], + ], + 'createdAt' => '2025-02-12T12:45:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'GetTaskByUuid', + ], + ], + 'createdAt' => '2025-01-22T05:52:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeGroupExecutingInfo', + ], + ], + 'createdAt' => '2024-11-28T14:30:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'QueryJobsWithResult', + ], + ], + 'createdAt' => '2024-11-13T14:08:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'DescribeTTSDemo', + ], + ], + 'createdAt' => '2024-08-28T12:13:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'CreateScript', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeScript', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'ImportScript', + ], + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'ListScripts', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'ModifyScript', + ], + ], + 'createdAt' => '2024-08-06T12:39:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Error codes changed', + 'api' => 'ListJobs', + ], + [ + 'description' => 'Error codes changed', + 'api' => 'ListResourceTags', + ], + ], + 'createdAt' => '2024-07-24T07:36:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeJob', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeJobGroup', + ], + ], + 'createdAt' => '2024-07-22T12:44:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Error codes changed', + 'api' => 'ChangeResourceGroup', + ], + ], + 'createdAt' => '2024-07-22T12:44:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'CreateBatchRepeatJob', + ], + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'CreateJobGroup', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeJobGroup', + ], + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'ListJobGroups', + ], + [ + 'description' => 'Response parameters changed, Error codes changed', + 'api' => 'ListJobGroupsAsync', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'ModifyJobGroup', + ], + ], + 'createdAt' => '2024-06-24T02:15:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'CreateScript', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeScript', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'ListChatbotInstances', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'ListScripts', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'ModifyScript', + ], + ], + 'createdAt' => '2024-04-25T12:18:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'ListInstances', + ], + ], + 'createdAt' => '2024-04-22T12:31:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'QueryJobsWithResult', + ], + ], + 'createdAt' => '2024-02-04T14:24:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'DescribeTTSDemo', + ], + ], + 'createdAt' => '2024-02-04T14:18:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'CreateBatchRepeatJob', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'CreateJobGroup', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeJobGroup', + ], + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'ModifyJobGroup', + ], + ], + 'createdAt' => '2024-01-04T12:35:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'QueryJobs', + ], + ], + 'createdAt' => '2023-10-20T07:45:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'ListDownloadTasks', + ], + ], + 'createdAt' => '2023-06-20T13:58:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed, Error codes changed', + 'api' => 'SubmitScriptReview', + ], + ], + 'createdAt' => '2023-06-20T12:51:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeJob', + ], + ], + 'createdAt' => '2023-04-25T13:38:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'ListScriptRecording', + ], + ], + 'createdAt' => '2023-03-30T12:41:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed, Response parameters changed', + 'api' => 'DescribeDialogueNodeStatistics', + ], + [ + 'description' => 'Response parameters changed, Response parameters changed', + 'api' => 'DescribeIntentStatistics', + ], + ], + 'createdAt' => '2023-03-24T08:24:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeTTSDemo', + ], + [ + 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed', + 'api' => 'ModifyTTSConfig', + ], + ], + 'createdAt' => '2023-03-24T08:24:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'GetBaseStrategyPeriod', + ], + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'SaveBaseStrategyPeriod', + ], + ], + 'createdAt' => '2023-03-24T08:24:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'CreateScript', + ], + ], + 'createdAt' => '2023-01-09T10:52:38.000Z', + 'description' => '屏蔽参数MiniPlaybackConfigListJsonString', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'Dialogue', + ], + ], + 'createdAt' => '2022-12-29T14:17:32.000Z', + 'description' => '发布录音管理功能', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'CreateInstance', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'CreateJobGroup', + ], + ], + 'createdAt' => '2022-10-17T02:12:27.000Z', + 'description' => '对接网商自建司法调解机器人', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'CreateTaskExportTask', + ], + ], + 'createdAt' => '2022-10-17T02:12:18.000Z', + 'description' => 'CreateTaskExportTask接口的instanceId改为必填，否则如果不传 instanceId 有风险会查到别的实例下的数据。', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'ListInstances', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'ListScripts', + ], + ], + 'createdAt' => '2022-09-27T13:03:09.000Z', + 'description' => '外呼概览页pop网关接口变更', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'QueryJobsWithResult', + ], + ], + 'createdAt' => '2022-09-20T13:55:17.000Z', + 'description' => '外呼3.3软电话免登录体验 通话状态筛选相关接口发布', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeScript', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'ModifyScript', + ], + ], + 'createdAt' => '2022-09-20T13:54:12.000Z', + 'description' => '情绪识别产品化', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'DownloadRecording', + ], + ], + 'createdAt' => '2022-08-09T13:10:11.000Z', + 'description' => '支持分段录音试听', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'CreateScript', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'ModifyScript', + ], + ], + 'createdAt' => '2022-08-09T13:09:03.000Z', + 'description' => '音义一体设置优化', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'ListJobGroups', + ], + ], + 'createdAt' => '2022-07-07T08:05:38.000Z', + 'description' => '修改pageSize最大值', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'ListJobGroups', + ], + ], + 'createdAt' => '2022-07-07T02:56:34.000Z', + 'description' => '增加参数校验', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'CreateInstance', + ], + [ + 'description' => 'Request parameters changed, Error codes changed', + 'api' => 'ListJobGroups', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'QueryJobsWithResult', + ], + ], + 'createdAt' => '2022-06-22T02:26:32.000Z', + 'description' => '3.1版本公有云发布', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'CreateScript', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeScript', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'ListScripts', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'ModifyScript', + ], + ], + 'createdAt' => '2022-06-21T12:55:33.000Z', + 'description' => '音义一体发布公有云', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'ListAllTenantBindNumberBinding', + ], + ], + 'createdAt' => '2022-06-21T12:22:40.000Z', + 'description' => '3.1迭代运维控制台功能', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'DescribeTTSDemo', + ], + ], + 'createdAt' => '2022-05-24T12:30:27.000Z', + 'description' => '修复场景试听设置语调不生效问题', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'DescribeJob', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'GetInstanceConfig', + ], + ], + 'createdAt' => '2022-04-20T06:15:08.000Z', + 'description' => '标注中心外呼网关发布', + ], + [ + 'apis' => [ + [ + 'description' => 'OpenAPI offline', + 'api' => 'GenerateUploadUrl', + ], + ], + 'createdAt' => '2022-04-11T03:34:29.000Z', + 'description' => '标注中心', + ], + [ + 'apis' => [ + [ + 'description' => 'OpenAPI offline', + 'api' => 'CreateTaskExportTask', + ], + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'SearchTask', + ], + ], + 'createdAt' => '2022-03-01T16:04:51.000Z', + 'description' => '届远12月迭代外呼接口api变更', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeScript', + ], + [ + 'description' => 'Response parameters changed, Error codes changed', + 'api' => 'DescribeTTSConfig', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'ModifyScript', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'ModifyTTSConfig', + ], + ], + 'createdAt' => '2022-03-01T16:04:27.000Z', + 'description' => '外呼STS方式调用ASR 和 TTS', + ], + [ + 'apis' => [ + [ + 'description' => 'OpenAPI offline', + 'api' => 'CreateInstanceBindNumber', + ], + [ + 'description' => 'OpenAPI offline', + 'api' => 'DescribeTenantBindNumber', + ], + [ + 'description' => 'OpenAPI offline', + 'api' => 'ListAllTenantBindNumberBinding', + ], + ], + 'createdAt' => '2022-03-01T16:02:38.000Z', + 'description' => '租户绑定号码', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'CreateBatchRepeatJob', + ], + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'CreateJobGroup', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeJobDataParsingTaskProgress', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeJobGroup', + ], + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'ModifyJobGroup', + ], + ], + 'createdAt' => '2022-01-12T12:23:31.000Z', + 'description' => '届远11月迭代外呼接口变更', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'SaveAfterAnswerDelayPlayback', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'SaveBaseStrategyPeriod', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'SaveContactBlockList', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'SaveContactWhiteList', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'SaveMaxAttemptsPerDay', + ], + ], + 'createdAt' => '2022-01-12T12:21:25.000Z', + 'description' => '账号状态变更提示', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'CreateScript', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'ListScripts', + ], + ], + 'createdAt' => '2021-12-22T12:32:42.000Z', + 'description' => '智能打断产品化发布', + ], + [ + 'apis' => [ + [ + 'description' => 'Request parameters changed', + 'api' => 'CreateBatchRepeatJob', + ], + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'CreateJobGroup', + ], + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeJobGroup', + ], + [ + 'description' => 'Request parameters changed, Response parameters changed', + 'api' => 'ModifyJobGroup', + ], + ], + 'createdAt' => '2021-12-22T12:31:31.000Z', + 'description' => '外呼九月迭代新增重拨策略', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'QueryJobsWithResult', + ], + ], + 'createdAt' => '2021-12-22T12:29:10.000Z', + 'description' => '届远9月迭代任务查询接口--新增挂断时完成播放字段', + ], + [ + 'apis' => [ + [ + 'description' => 'OpenAPI offline', + 'api' => 'SearchTask', + ], + ], + 'createdAt' => '2021-11-24T13:04:59.000Z', + 'description' => '外呼日志中心搜索接口', + ], + [ + 'apis' => [ + [ + 'description' => 'OpenAPI offline', + 'api' => 'GetInstanceConfig', + ], + ], + 'createdAt' => '2021-11-24T13:04:28.000Z', + 'description' => '外呼实例配置接口发布', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'DescribeJob', + ], + ], + 'createdAt' => '2021-11-24T13:03:47.000Z', + 'description' => '修改了通话详情查询的api，增加了“挂断方”字段', + ], + [ + 'apis' => [ + [ + 'description' => 'Response parameters changed', + 'api' => 'QueryJobsWithResult', + ], + [ + 'description' => 'Request parameters changed', + 'api' => 'RecordFailure', + ], + ], + 'createdAt' => '2021-11-24T13:03:36.000Z', + 'description' => '公有云支持异常码', + ], + [ + 'apis' => [ + [ + 'description' => 'OpenAPI offline', + 'api' => 'CreateDownloadUrl', + ], + [ + 'description' => 'OpenAPI offline', + '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' => 'Outbound Bot', + 'ramCodes' => [ + 'outboundbot', + ], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'ModifyBeebotIntent', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyBeebotIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDialogueNodeStatistics', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeDialogueNodeStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:ChangeResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GenerateUploadUrl', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:GenerateUploadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SaveAnnotationMissionSessionList', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:SaveAnnotationMissionSessionList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyEmptyNumberNoMoreCallsInfo', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyEmptyNumberNoMoreCallsInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ImportScript', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:ImportScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListJobs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'WithdrawScriptReview', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:WithdrawScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteScript', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeIntentStatistics', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeIntentStatistics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListScriptVoiceConfigs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListScriptVoiceConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetAgentProfile', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetAgentProfile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteAgentProfiles', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteAgentProfiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteOutboundCallNumber', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteCabOutboundCallNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateBeebotIntent', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateBeebotIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SuspendCallWithFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:SuspendCallWithFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListIntentions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListIntentions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UploadScriptRecording', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:UploadScriptRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListAnnotationMission', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListAnnotationMission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateDownloadUrl', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateDownloadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyIntent', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListOutboundCallNumbers', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListOutboundCallNumbers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateBeebotIntentLgf', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateBeebotIntentLgf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetBaseStrategyPeriod', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetBaseStrategyPeriod', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeIntent', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteAllNumberDistrictInfo', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteAllNumberDistrictInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListAgentProfiles', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListAgentProfiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListChatbotInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListChatbotInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CancelJobs', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CancelJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'InflightTaskTimeout', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:InflightTaskTimeout', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyAgentProfile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyAgentProfile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListTags', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListBeebotIntentLgf', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListBeebotIntentLgf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SaveContactBlockList', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:SaveContactBlockList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetSummaryInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetSummaryInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'QueryScriptWaveforms', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:QueryScriptWaveforms', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListGlobalQuestions', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:ListGlobalQuestions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetCurrentConcurrency', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetCurrentConcurrency', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteBeebotIntentLgf', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteBeebotIntentLgf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeDsReports', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeGroupDsReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SearchTask', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:SearchTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListTagResources', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListTagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateDialogueFlow', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateDialogueFlow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'TerminateCall', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:TerminateCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListBeebotIntentUserSay', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListBeebotIntentUserSay', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateScriptWaveform', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateScriptWaveform', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListAnnotationMissionSession', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListAnnotationMissionSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetContactWhiteList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetContactWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetAfterAnswerDelayPlayback', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetAfterAnswerDelayPlayback', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteContactBlockList', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteContactBlockList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListAllTenantBindNumberBinding', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListAllTenantBindNumberBinding', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateJobDataParsingTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateJobDataParsingTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteJobGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteJobGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetMaxAttemptsPerDay', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetMaxAttemptsPerDay', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListScriptPublishHistories', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListScriptPublishHistories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListBeebotIntent', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListBeebotIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DownloadRecording', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DownloadCabRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListResourceTags', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListResourceTags', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyTTSConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyTTSConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'QueryScriptsByStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:QueryScriptsByStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateJobGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateJobGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetVersion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyScriptVoiceConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyScriptVoiceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SaveAfterAnswerDelayPlayback', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:SaveAfterAnswerDelayPlayback', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeJobGroupExportTaskProgress', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeJobGroupExportTaskProgress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetRealtimeConcurrencyReport', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetRealtimeConcurrencyReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'RollbackScript', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:RollbackScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyAnnotationMission', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyAnnotationMission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'PublishScriptForDebug', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:PublishScriptForDebug', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'QueryJobsWithResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:QueryJobsWithResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListScriptRecording', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListScriptRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SubmitBatchJobs', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:SubmitBatchJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteGlobalQuestion', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteGlobalQuestion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyOutboundCallNumber', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyCabOutboundCallNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeTTSDemo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeTTSDemo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeGroupExecutingInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeGroupExecutingInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBeebotIntentLgf', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyBeebotIntentLgf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateTaskExportTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateTaskExportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteDialogueFlow', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteDialogueFlow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SubmitScriptReview', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:SubmitScriptReview', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetConcurrentConversationQuota', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetConcurrentConversationQuota', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateBatchRepeatJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateBatchRepeatJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SaveContactWhiteList', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:SaveContactWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeScriptVoiceConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeScriptVoiceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBatchJobs', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyBatchJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SuspendCall', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:SuspendCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetAnnotationMissionTagInfoList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetAnnotationMissionTagInfoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetEmptyNumberNoMoreCallsInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetEmptyNumberNoMoreCallsInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyBeebotIntentUserSay', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyBeebotIntentUserSay', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeJobDataParsingTaskProgress', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeJobDataParsingTaskProgress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'UntagResources', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:UntagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetJobDataUploadParams', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetJobDataUploadParams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteIntent', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'StartJob', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:StartJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListJobsByGroup', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListJobsByGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyGlobalQuestion', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyGlobalQuestion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ResumeJobs', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:ResumeJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyTagGroups', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyTagGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteContactWhiteList', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteContactWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateJobGroupExportTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateJobGroupExportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SaveMaxAttemptsPerDay', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:SaveMaxAttemptsPerDay', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'RecordFailure', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:RecordFailure', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + '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' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetAnnotationMissionSummary', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetAnnotationMissionSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeTTSConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeTTSConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'TaskPreparing', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:TaskPreparing', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListApiPlugins', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListApiPlugins', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateIntent', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetAsrServerInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetAsrServerInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListDownloadTasks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListDownloadTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SuspendJobs', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:SuspendJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListDialogueFlows', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListDialogueFlows', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListFlashSmsTemplates', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListFlashSmsTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteBeebotIntentUserSay', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteBeebotIntentUserSay', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateGlobalQuestion', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateGlobalQuestion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteInstance', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateAnnotationMission', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:CreateAnnotationMission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SaveAnnotationMissionTagInfoList', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:SaveAnnotationMissionTagInfoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'AssignJobs', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:AssignJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'PublishScript', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:PublishScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateTag', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateTag', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyDialogueFlow', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:SaveDialogueFlow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListJobGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListJobGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetAgentProfileTemplate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetAgentProfileTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ExportScript', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:ExportScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteScriptWaveform', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteScriptWaveform', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'AssignJobsAsync', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:AssignJobsAsync', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DeleteBeebotIntent', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'outboundbot:DeleteBeebotIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeBeebotIntent', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeBeebotIntent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ListJobGroupsAsync', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'outboundbot:ListJobGroupsAsync', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeGlobalQuestion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeGlobalQuestion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetAssignJobsAsyncResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetAssignJobsAsyncResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DuplicateScript', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:DuplicateScript', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'Dialogue', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:Dialogue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateBeebotIntentUserSay', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateBeebotIntentUserSay', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetTaskByUuid', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetTaskByUuid', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateBatchJobs', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateBatchJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DownloadScriptRecording', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DownloadScriptRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeTagHitsSummary', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:DescribeTagHitsSummary', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SubmitRecording', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'outboundbot:SubmitRecording', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'DescribeJobGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetJobGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'SaveBaseStrategyPeriod', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:SaveBaseStrategyPeriod', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'GetContactBlockList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'outboundbot:GetContactBlockList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'ModifyJobGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'outboundbot:ModifyJobGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + [ + 'apiName' => 'CreateInstanceBindNumber', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'outboundbot:CreateInstanceBindNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'OutboundBot', + 'resourceType' => 'All Resource', + 'arn' => '*', + ], + ], + ], + ], + ], + 'resourceTypes' => [ + [ + 'validationType' => 'always', + 'resourceType' => 'Instance', + 'arn' => 'acs:outboundbot:{#regionId}:{#accountId}:instance/{#InstanceId}', + ], + ], + ], +]; |