'1.0',
'info' => ['style' => 'RPC', 'product' => 'OutboundBot', 'version' => '2019-12-26'],
'directories' => [
[
'children' => ['SaveBaseStrategyPeriod', 'SaveMaxAttemptsPerDay', 'SaveContactWhiteList', 'SaveContactBlockList', 'SaveAfterAnswerDelayPlayback', 'GetMaxAttemptsPerDay', 'GetContactWhiteList', 'GetContactBlockList', 'GetBaseStrategyPeriod', 'GetAfterAnswerDelayPlayback', 'DeleteContactWhiteList', 'DeleteContactBlockList'],
'type' => 'directory',
'title' => 'System management',
],
[
'children' => ['GetSummaryInfo', 'ModifyInstance', 'DescribeInstance'],
'type' => 'directory',
'title' => 'Instance management',
],
[
'children' => ['ListScriptVariables', 'ModifyAgentProfile', 'ListApiPlugins', 'ImportScript', 'GetAgentProfile', 'DeleteScriptRecording', 'CreateAgentProfile', 'RollbackScript', 'ListScriptPublishHistories', 'ModifyScript', 'SubmitScriptReview', 'WithdrawScriptReview', 'QueryScriptsByStatus', 'DescribeScript'],
'type' => 'directory',
'title' => 'Scenario management',
],
[
'children' => ['DescribeGroupExecutingInfo', 'DescribeDsReports', 'CreateBatchRepeatJob', 'ListFlashSmsTemplates', 'GetJobDataUploadParams', 'CreateDownloadUrl', 'ListDownloadTasks', 'ListJobsByGroup', 'CreateJobGroupExportTask', 'DeleteJobGroup', 'ListJobGroupsAsync', 'ListJobGroups', 'ModifyJobGroup', 'DescribeJobGroup', 'CreateJobGroup'],
'type' => 'directory',
'title' => 'Outbound task group management',
],
[
'children' => ['CreateTenantKey', 'GetPublicKey', 'SearchTask', 'QueryJobsWithResult', 'GetTaskByUuid', 'GetAssignJobsAsyncResult', 'CreateTaskExportTask', 'CreateJobDataParsingTask', 'AssignJobsAsync', 'AssignJobs', 'SuspendJobs', 'ResumeJobs', 'CancelJobs', 'QueryJobs', 'ListJobs', 'DescribeJobDataParsingTaskProgress', 'DescribeJob', 'StartJob'],
'type' => 'directory',
'title' => 'Outbound task management',
],
[
'children' => ['ListScriptRecording', 'DownloadScriptRecording', 'DownloadRecording'],
'type' => 'directory',
'title' => 'Call recording',
],
[
'children' => ['TerminateCall', 'SuspendCallWithFile', 'SuspendCall', 'Dialogue', 'DescribeDialogueNodeStatistics'],
'type' => 'directory',
'title' => 'Dialogue-based outbound call',
],
[
'children' => ['DescribeTTSDemo'],
'type' => 'directory',
'title' => 'Scenario voice configuration',
],
[
'children' => ['ListOutboundCallNumbers', 'CreateInstanceBindNumber', 'DescribeTenantBindNumber', 'ListAllTenantBindNumberBinding'],
'type' => 'directory',
'title' => 'Number management',
],
[
'children' => ['ModifyAnnotationMission', 'ListIntentions', 'SaveAnnotationMissionTagInfoList', 'GetAnnotationMissionTagInfoList', 'SaveAnnotationMissionSessionList', 'ListAnnotationMissionSession', 'GetAnnotationMissionSummary', 'ListAnnotationMission', 'CreateAnnotationMission'],
'type' => 'directory',
'title' => 'Annotation',
],
[
'children' => ['DescribeBeebotIntent', 'DescribeIntentStatistics', 'ListBeebotIntentLgf', 'ListBeebotIntentUserSay', 'DeleteBeebotIntentUserSay', 'DeleteBeebotIntentLgf', 'DeleteBeebotIntent', 'ModifyBeebotIntentUserSay', 'ModifyBeebotIntentLgf', 'ModifyBeebotIntent', 'CreateBeebotIntentUserSay', 'CreateBeebotIntentLgf', 'CreateBeebotIntent', 'ListBeebotIntent'],
'type' => 'directory',
'title' => 'Intent management (small model API)',
],
[
'children' => ['GetCurrentConcurrency', 'GetRealtimeConcurrencyReport', 'GetConcurrentConversationQuota'],
'type' => 'directory',
'title' => 'Concurrency',
],
[
'children' => ['GenerateUploadUrl'],
'type' => 'directory',
'title' => 'Hot word management',
],
[
'children' => [
'CreateDialogueFlow', 'DeleteDialogueFlow', 'ModifyDialogueFlow', 'ListDialogueFlows', 'ListTags', 'CreateTag', 'DescribeTagHitsSummary', 'ModifyTagGroups', 'DeleteIntent', 'ModifyIntent', 'DescribeIntent', 'ListIntents', 'ListGlobalQuestions', 'DuplicateScript', 'CreateGlobalQuestion', 'ModifyScriptVoiceConfig', 'ModifyGlobalQuestion', 'DescribeScriptVoiceConfig', 'CreateIntent', 'ListScriptVoiceConfigs',
'DeleteGlobalQuestion', 'DescribeGlobalQuestion',
],
'type' => 'directory',
'title' => 'Legacy canvas (deprecated)',
],
[
'children' => ['ListChatbotInstances', 'ChangeResourceGroup', 'CreateInstance', 'CreateScript', 'DeleteInstance', 'DeleteScript', 'ExportScript', 'ListInstances', 'ListResourceTags', 'ListScripts', 'ListTagResources', 'PublishScript', 'TagResources', 'UntagResources'],
'type' => 'directory',
'title' => 'Others',
],
[
'children' => [
'GetVersion', 'TaskPreparing', 'InflightTaskTimeout', 'PublishScriptForDebug', 'ListAgentProfiles', 'GetAgentProfileTemplate', 'DeleteAgentProfiles', 'ModifyOutboundCallNumber', 'ModifyTTSConfig', 'SubmitRecording', 'GetAsrServerInfo', 'DescribeJobGroupExportTaskProgress', 'RecordFailure', 'CreateBatchJobs', 'GetNumberDistrictInfoTemplateDownloadUrl', 'SaveEffectiveDays', 'DeleteAllNumberDistrictInfo', 'UploadScriptRecording', 'GetEmptyNumberNoMoreCallsInfo', 'ModifyEmptyNumberNoMoreCallsInfo',
'ModifyBatchJobs', 'DeleteOutboundCallNumber', 'QueryScriptWaveforms', 'DescribeTTSConfig', 'DeleteScriptWaveform', 'SubmitBatchJobs', 'CreateScriptWaveform',
],
'type' => 'directory',
'title' => 'Deprecated',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AssignJobs' => [
'summary' => 'Creates outbound call jobs in batches.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => ['description' => 'The job group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95', 'title' => ''],
],
[
'name' => 'StrategyJson',
'in' => 'query',
'schema' => ['description' => 'The execution strategy for the job group.'."\n"
."\n"
.'- `repeatBy`: The recurrence type. Valid values: `Once` (runs once), `Day` (repeats daily), `Week` (repeats weekly), and `Month` (repeats monthly).'."\n"
."\n"
.'- `startTime`: The start time of the strategy.'."\n"
."\n"
.'- `endTime`: The end time of the strategy.'."\n"
."\n"
.'- `workingTime`: The time windows during which calls can be made.'."\n"
."\n"
.'- `maxAttemptsPerDay`: The maximum daily call attempts per phone number.'."\n"
."\n"
.'- `minAttemptInterval`: The minimum interval between call retries, in minutes.'."\n"
."\n"
.'- `routingStrategy`: The number routing strategy. Valid values: `None` (no preference), `LocalFirst` (prioritizes numbers in the same city), and `LocalProvinceFirst` (prioritizes numbers in the same province).'."\n"
."\n"
.'- `repeatDays`: The specific days on which the job runs, based on the `repeatBy` type. If `repeatBy` is set to `Week`, `0` represents Sunday, and `1` through `6` represent Monday through Saturday. If `repeatBy` is set to `Month`, values from `1` to `31` represent the days of the month. If a month does not have a specified day (for example, February 30), the job is skipped for that month.'."\n"
."\n"
.'- `repeatable`: Specifies whether the job is recurring. Valid values are `true` and `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' => 'The roster type.'."\n"
."\n"
.'If you create jobs by calling this API, you can omit this parameter. The default value is `json`. If you upload a contact list file, set this parameter to `excel`.', 'type' => 'string', 'required' => false, 'example' => 'json', 'title' => ''],
],
[
'name' => 'JobDataParsingTaskId',
'in' => 'query',
'schema' => ['description' => 'The ID of the data parsing task for the outbound call job.'."\n"
."\n"
.'You can omit this parameter if you create jobs by calling this API.'."\n"
."\n"
.'> If you create jobs by uploading a file, you must call the `CreateJobDataParsingTask` operation to obtain a value for this parameter.', 'type' => 'string', 'required' => false, 'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95', 'title' => ''],
],
[
'name' => 'IsAsynchrony',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the task is asynchronous.'."\n"
."\n"
.'You can omit this parameter if you create jobs by calling this API. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'These numbers are displayed as the caller ID to the contact.'."\n"
."\n"
.'> If unspecified, all available calling numbers are used.',
'type' => 'array',
'items' => ['description' => 'A calling number.', 'type' => 'string', 'required' => false, 'example' => '4008013260', 'title' => ''],
'required' => false,
'maxItems' => 99,
'example' => '',
'title' => '',
],
],
[
'name' => 'JobsJson',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '>'."\n"
."\n"
.'This parameter is required.'."\n"
."\n"
.'>'."\n"
."\n"
.'The job data, a JSON array where each object represents a contact. For formatting details, see the example.'."\n"
."\n"
.'The array can contain up to 99 elements.',
'type' => 'array',
'items' => ['description' => '`extras`: (Optional) A container for additional information.'."\n"
."\n"
.'- `key`: The key of a custom variable.'."\n"
."\n"
.'- `value`: The value of the custom variable.'."\n"
."\n"
.'`contacts`: (Required) Information about the contact.'."\n"
."\n"
.'- `phoneNumber`: (Required) The phone number of the contact. If number encryption is required, provide the encrypted phone number.'."\n"
."\n"
.'- `referenceId`: (Required) A user-defined unique ID for the contact, used to prevent duplicate entries.'."\n"
."\n"
.'- `role`: (Optional) The role of the contact in the outbound call. If not specified, no role is assigned.'."\n"
."\n"
.'- `honorific`: (Optional) The honorific title for the contact.'."\n"
."\n"
.'- `name`: (Optional) The name of the contact.'."\n"
."\n"
.'- `encryptedAesKey`: (Optional) The encrypted AES key. This is used when uploading an encrypted phone number.', 'type' => 'string', 'docRequired' => true, '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"
.'}', 'title' => ''],
'required' => false,
'maxItems' => 99,
'example' => '',
'docRequired' => true,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'JobGroupId' => ['description' => 'The job group ID.', 'type' => 'string', 'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'JobsId' => [
'description' => 'A list of job IDs.',
'type' => 'array',
'items' => ['description' => 'The 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' => ''],
],
],
'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"}]',
'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' => '*'],
],
],
],
],
],
'AssignJobsAsync' => [
'summary' => 'Asynchronously creates outbound jobs.',
'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' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the job group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95', 'title' => ''],
],
[
'name' => 'StrategyJson',
'in' => 'formData',
'schema' => ['description' => 'A JSON string that defines the job group execution strategy. This object has the following properties:'."\n"
."\n"
.'- `repeatBy`'."\n"
."\n"
.'Specifies the repetition frequency. Valid values include `Once` (does not repeat), `Day` (repeats daily), `Week` (repeats weekly), and `Month` (repeats monthly).'."\n"
."\n"
.'- `startTime`'."\n"
."\n"
.'The start time of the execution strategy.'."\n"
."\n"
.'- `endTime`'."\n"
."\n"
.'The end time of the execution strategy.'."\n"
."\n"
.'- `workingTime`'."\n"
."\n"
.'The time range during which outbound calls can be made.'."\n"
."\n"
.'- `maxAttemptsPerDay`'."\n"
."\n"
.'The maximum number of daily call attempts for a single phone number.'."\n"
."\n"
.'- `minAttemptInterval`'."\n"
."\n"
.'The minimum interval between retry attempts, in minutes.'."\n"
."\n"
.'- `routingStrategy`'."\n"
."\n"
.'The routing strategy for calling numbers. Valid values: `None` (not specified), `LocalFirst` (prioritizes numbers in the same city), and `LocalProvinceFirst` (prioritizes numbers in the same province).'."\n"
."\n"
.'- `repeatDays`'."\n"
."\n"
.'The days on which the job repeats. If `repeatBy` is set to `Week`, valid values are `0` for Sunday and `1` to `6` for Monday to Saturday. If `repeatBy` is set to `Month`, valid values are `1` to `31`. If a specified day does not exist in a given month (e.g., February 30), the job is skipped for that month.'."\n"
."\n"
.'- `repeatable`'."\n"
."\n"
.'Specifies whether to enable recurring jobs. Valid values: `true` and `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' => 'The list of calling numbers to be displayed to callees.'."\n"
."\n"
.'> If you omit this parameter, the system uses all available calling numbers by default.',
'type' => 'array',
'items' => ['description' => 'A calling number.', 'type' => 'string', 'required' => false, 'example' => '4008013260', 'title' => ''],
'required' => false,
'maxItems' => 99,
'title' => '',
'example' => '',
],
],
[
'name' => 'JobsJson',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => 'A JSON array containing job data. For the required format, see the example.'."\n"
."\n"
.'Each JSON object in the array represents a job for a single contact.',
'type' => 'array',
'items' => ['description' => 'A JSON object representing a single job. This object contains the following properties:'."\n"
."\n"
.'- `key`: The name of the custom variable.'."\n"
."\n"
.'- `value`: The value of the custom variable.'."\n"
."\n"
.'`contacts`: (Required) A list containing the contact information for the callee.'."\n"
."\n"
.'- `phoneNumber`: (Required) The phone number of the callee. If number encryption is required, provide the encrypted phone number.'."\n"
."\n"
.'- `referenceId`: (Required) A user-defined unique identifier for the contact. This ID helps prevent duplicate entries.'."\n"
."\n"
.'- `role`: (Optional) The contact\'s role. If unspecified, no role is assigned.'."\n"
."\n"
.'- `honorific`: (Optional) The contact\'s honorific (e.g., Mr., Ms.).'."\n"
."\n"
.'- `name`: (Optional) The contact\'s name.'."\n"
."\n"
.'- `encryptedAesKey`: (Optional) The encrypted AES key. Use this when number encryption is enabled.', 'type' => 'string', 'docRequired' => true, '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"
.'}', 'title' => ''],
'required' => true,
'maxItems' => 10000,
'docRequired' => true,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The API response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'AsyncTaskId' => ['description' => 'The 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' => 'The 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' => 'A filter condition. The scenario ID.'."\n"
."\n"
.'> Obtain this ID by calling the DescribeJobGroup operation.', 'type' => 'string', 'required' => false, 'example' => '35641113-b2f6-464e-a772-25c25554798b', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => ['description' => 'A filter condition. The task group ID.', 'type' => 'string', 'required' => false, 'example' => '9f84892d-721a-4069-9975-668c8164d64e', 'title' => ''],
],
[
'name' => 'JobId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'A filter condition. The job ID.'."\n"
."\n"
.'> The JobId parameter is required when the All parameter is set to false.',
'type' => 'array',
'items' => ['description' => 'The ID of the job to cancel.', 'type' => 'string', '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' => 'A filter condition. The reference ID of the job.'."\n"
."\n"
.'> This is the ReferenceId that you specified when you uploaded the contact list.',
'type' => 'array',
'items' => ['description' => 'The third-party ID of the job.', 'type' => 'string', 'required' => false, 'example' => 'C01', 'title' => ''],
'required' => false,
'example' => '4a875676-b136-4087-88b4-de67c61fed69',
'maxItems' => 99,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', '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' => 'Cancels jobs that are pending or in progress. This operation cannot cancel jobs that are 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' => 'The ID of the resource.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ResourceId.1=b949ae1f-01dc-4191-ae5a-70fbe6772fd8', 'title' => ''],
],
[
'name' => 'NewResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the new resource group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rg-aeky6wvb7yzabqy', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', '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' => 'Changes the resource group of a resource.',
'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' => '', 'description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a'],
],
[
'name' => 'PromptJson',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'Agent configuration in Normal 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' => '', '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' => '', 'description' => 'Agent profile template ID (unique value)', 'type' => 'string', 'required' => true, 'example' => 'default-survey'],
],
[
'name' => 'Model',
'in' => 'formData',
'schema' => ['description' => 'Model ID (unique value)', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'model_001'],
],
[
'name' => 'ModelConfig',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'Model configuration (deprecated)', 'type' => 'string', 'required' => false, 'example' => '""'],
],
[
'name' => 'ScriptId',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'Scenario ID', 'type' => 'string', 'required' => true, 'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17'],
],
[
'name' => 'LabelsJson',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'Label description', 'type' => 'string', 'required' => false, 'example' => '[{'."\n"
.' "name": "是否满意",'."\n"
.' "description": "对介绍的游戏内容是否感兴趣",'."\n"
.' "valueList": "[\\"有兴趣\\",\\"没兴趣\\"]"'."\n"
.'}]'],
],
[
'name' => 'VariablesJson',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'Variable configuration', 'type' => 'string', 'required' => false, 'example' => '[{'."\n"
.' "name": "开始时间",'."\n"
.' "description": "开始时间"'."\n"
.'}, {'."\n"
.' "name": "结束时间",'."\n"
.' "description": "结束时间"'."\n"
.'}]'],
],
[
'name' => 'Scenario',
'in' => 'formData',
'schema' => ['description' => 'Scenario', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '测试场景'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => 'Description', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '描述当前智能体的功能'],
],
[
'name' => 'AppIp',
'in' => 'formData',
'schema' => ['description' => 'app\\_ip (system field) — optional', 'type' => 'string', 'title' => '', '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' => '',
'description' => 'BaseResponse',
'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' => 'Response message', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Data' => [
'description' => 'Response data',
'type' => 'object',
'properties' => [
'CreateTime' => ['description' => 'Creation time', 'type' => 'string', 'title' => '', 'example' => '1739333534000'],
'UpdateTime' => ['description' => 'Last update time', 'type' => 'string', 'title' => '', 'example' => '1737077564000'],
'AgentProfileId' => ['title' => '', 'description' => 'Agent profile ID', 'type' => 'string', 'example' => 'd31794e2a51f47d2901b4094d88311d7'],
'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'title' => '', 'example' => '1e16c663-0339-4064-9d57-07f772e78f21'],
'ScriptId' => ['title' => '', 'description' => 'Scenario ID', 'type' => 'string', 'example' => 'd13ad2d3-3fe6-4352-b38b-bd6559047de8'],
'AgentType' => ['title' => '', 'description' => 'Agent type', 'type' => 'string', 'example' => '“”'],
'PromptJson' => ['title' => '', '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' => '', 'description' => 'Prompt (professional mode)', 'type' => 'string', 'example' => '\\n名称:安妮 \\n身份:游戏推广员\\n背景:通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。\\n技能:作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。\\n约束条件:你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\n明确活动的起止时间,确保玩家不会混淆。\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。'],
'AgentProfileTemplateId' => ['title' => '', 'description' => 'Agent profile template ID', 'type' => 'string', 'example' => 'default-survey'],
'Model' => ['description' => 'Model ID', 'type' => 'string', 'title' => '', 'example' => 'model_001'],
'ModelConfig' => ['title' => '', 'description' => 'Model configuration', 'type' => 'string', 'example' => '""'],
'System' => ['description' => 'Indicates whether this is a system template', 'type' => 'boolean', 'title' => '', 'example' => 'True'],
'LabelsJson' => ['title' => '', 'description' => 'Label description', 'type' => 'string', 'example' => '[{'."\n"
.' "name": "是否满意",'."\n"
.' "description": "对介绍的游戏内容是否感兴趣",'."\n"
.' "valueList": "[\\"有兴趣\\",\\"没兴趣\\"]"'."\n"
.'}]'],
'VariablesJson' => ['title' => '', 'description' => 'Variable configuration', 'type' => 'string', 'example' => '[{'."\n"
.' "name": "开始时间",'."\n"
.' "description": "开始时间"'."\n"
.'}, {'."\n"
.' "name": "结束时间",'."\n"
.' "description": "结束时间"'."\n"
.'}]'],
'Scenario' => ['description' => 'Scenario', 'type' => 'string', 'title' => '', 'example' => '场景'],
'Description' => ['description' => 'Description', 'type' => 'string', 'title' => '', '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' => 'You can 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' => 'Creates an annotation task.',
'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' => ['description' => 'The data type of the annotation task.'."\n"
."\n"
.'- 1: Outbound call', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'title' => '', 'required' => true, 'example' => '1'],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The outbound scenario ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '6236f21e-2e04-4dad-a47b-ae77e6a48325'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'bf3b51a5-e88a-4636-98b0-1a34725a085b', 'title' => ''],
],
[
'name' => 'Finished',
'in' => 'query',
'schema' => ['description' => 'Indicates whether the business process ended normally.'."\n"
."\n"
.'> This parameter takes effect only when \\`SessionEndReasonFilterList\\` is not specified.'."\n"
.'>'."\n"
.'> - \\`true\\`: The call record is normal.'."\n"
.'>'."\n"
.'> - \\`false\\`: The call did not end normally.', 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''],
],
[
'name' => 'SessionEndReasonFilterList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '',
'description' => 'The filter condition for call completion statuses.'."\n"
."\n"
.'> This parameter has the same function as \\`SessionEndReasonFilterListJsonString\\`. You can specify either of them.',
'type' => 'array',
'items' => ['description' => 'The keyword filtering rule.'."\n"
."\n"
.'**Enumeration values for filtering call records**'."\n"
."\n"
.'- 1: The call ended normally.'."\n"
."\n"
.'- 2: The bot hung up after a recognition failure.'."\n"
."\n"
.'- 3: The call was hung up due to a silence timeout.'."\n"
."\n"
.'- 4: The user hung up after a recognition failure.'."\n"
."\n"
.'- 5: The user hung up for no reason.'."\n"
."\n"
.'- 6: The call was transferred to a manual agent after an intent was hit.'."\n"
."\n"
.'- 7: The call was transferred to a manual agent after a recognition failure.'."\n"
."\n"
.'- 8: No interaction from the user.'."\n"
."\n"
.'- 9: The call was interrupted by a system exception.'."\n"
."\n"
.'- 10: The call was transferred to an IVR after an intent was hit.'."\n"
."\n"
.'- 11: The call was transferred to an IVR after a recognition failure.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'required' => false,
'maxItems' => 10,
'example' => '',
],
],
[
'name' => 'SessionEndReasonFilterListJsonString',
'in' => 'query',
'schema' => ['description' => 'The filter condition for call completion statuses.'."\n"
."\n"
.'> This parameter has the same function as \\`SessionEndReasonFilterList\\`. You can specify either of them. The format is \\`\\[1]\\` or \\`\\[1,2]\\`. You can specify multiple filter conditions in the array. The enumeration values for the filter conditions are as follows.'."\n"
."\n"
.'**Enumeration values for filtering call records**'."\n"
."\n"
.'- 1: The call ended normally.'."\n"
."\n"
.'- 2: The bot hung up after a recognition failure.'."\n"
."\n"
.'- 3: The call was hung up due to a silence timeout.'."\n"
."\n"
.'- 4: The user hung up after a recognition failure.'."\n"
."\n"
.'- 5: The user hung up for no reason.'."\n"
."\n"
.'- 6: The call was transferred to a manual agent after an intent was hit.'."\n"
."\n"
.'- 7: The call was transferred to a manual agent after a recognition failure.'."\n"
."\n"
.'- 8: No interaction from the user.'."\n"
."\n"
.'- 9: The call was interrupted by a system exception.'."\n"
."\n"
.'- 10: The call was transferred to an IVR after an intent was hit.'."\n"
."\n"
.'- 11: The call was transferred to an IVR after a recognition failure.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '[1]'],
],
[
'name' => 'ExcludeOtherSession',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to exclude call records that have been annotated in other tasks. If you do not specify this parameter, the default value is \\`false\\`.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'],
],
[
'name' => 'ConversationTimeStartFilter',
'in' => 'query',
'schema' => ['description' => 'The start time for filtering calls.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1683302400000'],
],
[
'name' => 'ConversationTimeEndFilter',
'in' => 'query',
'schema' => ['description' => 'The end time for filtering calls.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1682956800000'],
],
[
'name' => 'SamplingType',
'in' => 'query',
'schema' => ['description' => 'The sampling type.'."\n"
."\n"
.'- 1: Full data'."\n"
."\n"
.'- 2: Percentage'."\n"
."\n"
.'- 3: Custom amount', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'],
],
[
'name' => 'SamplingRate',
'in' => 'query',
'schema' => ['description' => 'The sampling percentage.'."\n"
."\n"
.'> This parameter is required and takes effect only when \\`SamplingType\\` is set to 2. Otherwise, the task fails to be created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'],
],
[
'name' => 'SamplingCount',
'in' => 'query',
'schema' => ['description' => 'The custom sampling amount.'."\n"
."\n"
.'> This parameter is required and takes effect only when \\`SamplingType\\` is set to 3. Otherwise, the task fails to be created.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'],
],
[
'name' => 'AnnotationMissionName',
'in' => 'query',
'schema' => ['description' => 'The name of the annotation task.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '询问卖车-标注任务-20230506-112934'],
],
[
'name' => 'AnnotationMissionDebugDataSourceList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The list of annotation data sources.'."\n"
."\n"
.'> This parameter has the same function as \\`AnnotationMissionDebugDataSourceListJsonString\\`. You can specify either of them.',
'type' => 'array',
'items' => ['description' => 'The list of business data.'."\n"
."\n"
.'**Enumeration values:**'."\n"
."\n"
.'- 1: Outbound call task'."\n"
."\n"
.'- 2: Test task', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'AnnotationMissionDebugDataSourceListJsonString',
'in' => 'query',
'schema' => ['description' => 'The JSON string for the test data.'."\n"
."\n"
.'> This parameter has the same function as \\`AnnotationMissionDebugDataSourceList\\`. You can specify either of them. The format is \\`\\[1]\\`, \\`\\[2]\\`, or \\`\\[1,2]\\`. You can specify multiple filter conditions in the array. The enumeration values are as follows:'."\n"
."\n"
.'- 1: Outbound call task'."\n"
."\n"
.'- 2: Test task', 'type' => 'string', 'required' => false, 'example' => '[1]', 'title' => ''],
],
[
'name' => 'ChatbotId',
'in' => 'query',
'schema' => ['description' => 'The bot ID.'."\n"
."\n"
.'> You can obtain this ID from the \\`DescribeScript\\` operation.', 'type' => 'string', 'required' => false, 'example' => 'chatbot-cn-fqEnFZBYnb', 'title' => ''],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['description' => 'The agent ID.'."\n"
."\n"
.'> You can obtain this ID from the \\`DescribeInstance\\` operation.', 'type' => 'string', 'required' => false, 'example' => '1168702', 'title' => ''],
],
[
'name' => 'AgentKey',
'in' => 'query',
'schema' => ['description' => 'The workspace key.'."\n"
."\n"
.'> You can obtain this key from the \\`DescribeInstance\\` operation.', 'type' => 'string', 'required' => false, 'example' => '9137ab9c27044921860030adf8590ec4_p_outbound_public', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse\\',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the call was successful. \\`true\\`: The call was successful. \\`false\\`: The call failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Code' => ['description' => 'The status code of the API.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'Additional information. If the request is successful, \\`success\\` is returned. If the request fails, a specific error code is returned.', 'type' => 'string', 'example' => '执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-uax33hol2uu,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Message' => ['description' => 'Additional information. If the request is successful, \\`success\\` is returned. If the request fails, a specific error code is returned.', 'type' => 'string', 'example' => '执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-uax33hol2uu,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821', 'title' => ''],
],
'title' => '',
'example' => '',
],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The 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' => 'Deprecated. Do not use this operation to batch-create outbound calling jobs.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREoutboundbotQHO52V'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', 'title' => ''],
],
[
'name' => 'BatchJobName',
'in' => 'query',
'schema' => ['description' => 'Name of the batch job.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '第一个作业组', 'title' => ''],
],
[
'name' => 'BatchJobDescription',
'in' => 'query',
'schema' => ['description' => 'Description of the batch job.', 'type' => 'string', 'required' => false, 'example' => '描述', 'title' => ''],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => ['description' => 'ID of the scenario.', 'type' => 'string', 'required' => false, 'example' => 'c6a668d1-3145-4048-9101-cb3678bb8884', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'ID of the script.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'b9ff4e88-65f9-4eb3-987c-11ba51f3f24d', 'title' => ''],
],
[
'name' => 'StrategyJson',
'in' => 'query',
'schema' => ['description' => 'JSON string that defines the job execution policy. 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' => 'Path to the Excel file that contains the batch job data.'."\n"
."\n"
.'> Get this value from the Folder parameter in the response of the GetJobDataUploadParams operation.', '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 the job is submitted. Set to false to submit the job. Set to true to save it as a draft.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false', 'title' => ''],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'List of caller numbers.',
'type' => 'array',
'items' => ['description' => 'Caller 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' => 'Response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'ID of the request.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'BatchJob' => [
'description' => 'Information about the job group.',
'type' => 'object',
'properties' => [
'CreationTime' => ['description' => 'Time when the job group was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579068424000', 'title' => ''],
'ScenarioId' => ['description' => 'ID of the scenario for the job group.', 'type' => 'string', 'example' => '6cea9bed-63e6-439e-ae4c-b3333efff53d', 'title' => ''],
'JobGroupName' => ['description' => 'Name of the job group.', 'type' => 'string', 'example' => '批量作业01', 'title' => ''],
'BatchJobId' => ['description' => 'ID of the job group.', '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' => 'Description of the job group.', 'type' => 'string', 'example' => '第一个批量作业', 'title' => ''],
'CallingNumbers' => [
'type' => 'array',
'items' => ['description' => 'A list of calling numbers.', 'type' => 'string', 'example' => '["4008013260 "]', 'title' => ''],
'description' => 'List of caller numbers.',
'title' => '',
'example' => '',
],
'Strategy' => [
'description' => 'Job execution policy.',
'type' => 'object',
'properties' => [
'Type' => ['description' => 'Type of the policy.', 'type' => 'string', 'example' => 'Repeatable', 'title' => ''],
'StrategyName' => ['description' => 'Name of the policy.', 'type' => 'string', 'example' => '策略', 'title' => ''],
'MaxAttemptsPerDay' => ['description' => 'Maximum number of retries per day after a failed call.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'FollowUpStrategy' => ['description' => 'Action to take for outbound calls that were not completed in the previous cycle.', 'type' => 'string', 'example' => 'CONTINUE', 'title' => ''],
'EndTime' => ['description' => 'End time of the scheduling policy.', 'type' => 'integer', 'format' => 'int64', 'example' => '2209702074000', 'title' => ''],
'Customized' => ['description' => 'Custom information for the policy.', 'type' => 'string', 'example' => '{}', 'title' => ''],
'IsTemplate' => ['description' => 'Indicates whether the policy is a template.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'StartTime' => ['description' => 'Start time when the job group begins execution.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578550074000', 'title' => ''],
'StrategyId' => ['description' => 'ID of the policy.', 'type' => 'string', 'example' => 'f718798d-96be-40e4-bef6-317b54855708', 'title' => ''],
'RoutingStrategy' => ['description' => 'Recording policy for caller numbers.', 'type' => 'string', 'example' => 'LocalFirst', 'title' => ''],
'MinAttemptInterval' => ['description' => 'Minimum interval between retries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'StrategyDescription' => ['description' => 'Description of the policy.', 'type' => 'string', 'example' => '作业执行策略', 'title' => ''],
'RepeatBy' => ['description' => 'How often the job repeats. Valid values: Once, Day, Week, and Month.', 'type' => 'string', 'example' => 'Once', 'title' => ''],
'WorkingTime' => [
'description' => 'Time periods during which the job runs each day.',
'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 on which the job repeats.',
'type' => 'array',
'items' => ['description' => 'Day on which the job repeats.', '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 task.',
'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, 'docRequired' => true, 'example' => '{\\"maxAttemptsPerDay\\":1,\\"minAttemptInterval\\":1,\\"routingStrategy\\":\\"LocalFirst\\"}', 'title' => ''],
],
[
'name' => 'RecallStrategyJson',
'in' => 'query',
'schema' => ['description' => 'Redial policy JSON', '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, including configuration information for third-party flash SMS.'."\n"
."\n"
.'- Template ID: Flash SMS template ID.'."\n"
."\n"
.'- Config ID: 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' => 'Redial calling number list',
'type' => 'array',
'items' => ['description' => 'Redial phone number', '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 request was successful.', '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' => 'Creates an intent for a small-model scenario.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => true, 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a', 'title' => ''],
],
[
'name' => 'IntentDefinition',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The description of the intent.',
'type' => 'object',
'properties' => [
'IntentName' => ['description' => 'The intent name.'."\n"
."\n"
.'> This is the intent code. It serves as a unique identifier.', 'type' => 'string', 'required' => true, 'example' => '知道了', 'title' => ''],
'AliasName' => ['description' => 'The intent alias.', 'type' => 'string', 'required' => false, 'example' => '嗯明白了', 'title' => ''],
],
'required' => true,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n", 'title' => ''],
'Success' => ['description' => 'Indicates whether the call succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'BeebotRequestId' => ['description' => 'The internal request ID.', 'type' => 'string', 'example' => '497CFAFF-48CC-161A-AD2C-252DED569037', 'title' => ''],
'Code' => ['description' => 'The API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The API message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'IntentId' => ['description' => 'The 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' => 'Creates a user utterance template for an intent in a small model scenario.',
'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' => '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' => 'LgfDefinition',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The LGF definition.',
'type' => 'object',
'properties' => [
'IntentId' => ['description' => 'The 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' => 'The data returned.',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'LgfId' => ['description' => 'The ID of the user utterance template.', 'type' => 'integer', 'format' => 'int64', 'example' => '5666117', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'BeebotRequestId' => ['description' => 'The internal request ID.', 'type' => 'string', 'example' => '497CFAFF-48CC-161A-AD2C-252DED569037', 'title' => ''],
'Code' => ['description' => 'The status code of the API call.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned for the API call.', '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' => 'Creates a user utterance for an intent in a small model scenario.',
'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' => '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' => 'UserSayDefinition',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The definition of the user utterance.',
'type' => 'object',
'properties' => [
'IntentId' => ['description' => 'The intent ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10717802', 'title' => ''],
'Content' => ['description' => 'The user utterance.', 'type' => 'string', 'required' => true, 'example' => '你知道xxxxx么?', 'title' => ''],
],
'required' => true,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'UserSayId' => ['description' => 'The user utterance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '17448458', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'BeebotRequestId' => ['description' => 'The internal request ID.', 'type' => 'string', 'example' => '0B219FCB-EC71-1F08-BB1B-0E87C20158C8', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response 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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', 'title' => ''],
],
[
'name' => 'DialogueName',
'in' => 'query',
'schema' => ['description' => 'The dialogue flow name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '主流程', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd0bf93dd-1a54-4f00-819e-c75502d38681', 'title' => ''],
],
[
'name' => 'DialogueFlowType',
'in' => 'query',
'schema' => ['description' => 'The type of the dialogue flow. Use `MainFlow` for a main flow or `SubFlow` for a subflow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MainFlow', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'DialogueFlowId' => ['description' => 'The dialogue flow ID.', 'type' => 'string', 'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code returned for the request.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned by the request.', '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' => 'This legacy canvas API creates a dialogue flow.',
'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' => 'The download task ID.'."\n"
.'> This parameter is obtained from the TaskId response parameter of the ListDownloadTasks operation.', 'type' => 'string', 'required' => true, 'example' => '137da36b41304bcd999a0a7895dc6881', 'title' => ''],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => ['description' => 'The file ID.'."\n"
.'> This parameter is obtained from the FileId response parameter of the ListDownloadTasks operation.', 'type' => 'string', 'required' => true, 'example' => '6f91885fa24b4c408d8f4eb392fd8ae6', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'FileHttpUrl' => ['description' => 'The file URL.', 'type' => 'string', 'example' => 'http://www.xxx.com/xxx', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EC08CC41-6870-5594-939A-F758F057898F', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned by the API.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create download file URL',
'summary' => 'Creates a URL for a download center task.',
'changeSet' => [
['createdAt' => '2021-11-24T13:00:44.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateDownloadUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'CreateGlobalQuestion' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", 'title' => ''],
],
[
'name' => 'GlobalQuestionName',
'in' => 'query',
'schema' => ['description' => 'The name of the global question.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '未识别全局问题', 'title' => ''],
],
[
'name' => 'GlobalQuestionType',
'in' => 'query',
'schema' => ['description' => 'The type of the global question.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'COMMON', 'title' => ''],
],
[
'name' => 'Questions',
'in' => 'query',
'schema' => ['description' => 'The questions that trigger the global question.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["未识别的用户问题"]', 'title' => ''],
],
[
'name' => 'Answers',
'in' => 'query',
'schema' => ['description' => 'The answers to the global question.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["你好,您可以再说一遍吗","不好意思我刚才没有听清"]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'GlobalQuestionId' => ['description' => 'The ID of the global question.', 'type' => 'string', 'example' => 'a546b616-724b-437f-bdb3-629a30c98567', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '56666881-887A-530A-B679-C3B6B6B142C0', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code of the request.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
],
'description' => 'The returned data.',
'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' => 'Creates a global question in a legacy canvas.',
'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 name of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '第一个实例', 'title' => ''],
],
[
'name' => 'InstanceDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the instance.', 'type' => 'string', 'required' => false, 'example' => '这个是第一的实例', 'title' => ''],
],
[
'name' => 'MaxConcurrentConversation',
'in' => 'query',
'schema' => [
'description' => 'The maximum number of concurrent conversations for the instance.',
'enumValueTitles' => [14 => '14'],
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '4',
'title' => '',
],
],
[
'name' => 'NluServiceType',
'in' => 'query',
'schema' => [
'description' => 'The service type.'."\n"
."\n"
.'> If you do not specify this parameter, the default value is Managed.'."\n"
."\n"
.'- DialogStudio: Conversation Engine 3.0.'."\n"
."\n"
.'- Authorized: A chatbot for the public cloud. This value is used when a public cloud customer purchases a private Intelligent Speech Interaction service and grants authorization. To grant authorization, go to Scenario Management, click Edit, and then select Custom Service in the Invoke Service section.'."\n"
."\n"
.'- Provided: A chatbot for on-premises deployment.'."\n"
."\n"
.'- Managed: The legacy outbound call canvas. This is the default public Intelligent Speech Interaction service for the outbound call product.',
'enumValueTitles' => ['Authorized' => 'A chatbot for the public cloud.', 'Provided' => 'A chatbot for on-premises deployment.'],
'type' => 'string',
'required' => false,
'enum' => ['Managed', 'Authorized', 'Provided', 'Baseme', 'Ant', 'Notification', 'MyBankJustice', 'DialogStudio'],
'example' => 'DialogStudio',
'title' => '',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group.'."\n"
."\n"
.'> You can call the ListResourceGroups operation to obtain this ID. For more information, see the Resource Management documentation at 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 optional.',
'type' => 'array',
'items' => ['description' => 'A calling number.'."\n"
."\n"
.'> This parameter is optional.', 'type' => 'string', 'required' => false, 'example' => '4008013260', 'title' => ''],
'required' => false,
'maxItems' => 99,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Instance' => [
'description' => 'The information about the instance.',
'type' => 'object',
'properties' => [
'CreationTime' => ['description' => 'The time when the instance was created. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578469042851', 'title' => ''],
'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', 'title' => ''],
'CreatorId' => ['description' => 'The ID of the user who created the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '435986', 'title' => ''],
'OwnerName' => ['description' => 'The name of the instance owner.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
'InstanceDescription' => ['description' => 'The description of the instance.', 'type' => 'string', 'example' => '这个是第一个实例', 'title' => ''],
'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => '第一个实例', 'title' => ''],
'CreatorName' => ['description' => 'The name of the user who created the instance.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', 'title' => ''],
'MaxConcurrentConversation' => ['description' => 'The maximum number of 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' => 'Creates an outbound call 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' => 'Binds 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 bind (required).'."\n"
."\n"
.'> For the list of numbers, see the Number parameter returned by the ListAllTenantBindNumberBinding API.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '15005059355', 'title' => ''],
],
[
'name' => 'InstanceList',
'in' => 'query',
'schema' => ['description' => 'List of outbound calling instance IDs.'."\n"
."\n"
.'> Modifying this parameter overwrites previous parameters. Setting this parameter to empty clears the number binding list.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf'."\n"
.',123*****09,456*****08'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the operation was successful.', '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 binding was successful.', '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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", 'title' => ''],
],
[
'name' => 'IntentName',
'in' => 'query',
'schema' => ['description' => 'The name of the intent. This name must be unique within the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '是本人', 'title' => ''],
],
[
'name' => 'IntentDescription',
'in' => 'query',
'schema' => ['description' => 'A description of the intent.', 'type' => 'string', 'required' => false, 'example' => '确定是本人的意图', 'title' => ''],
],
[
'name' => 'Utterances',
'in' => 'query',
'schema' => ['description' => 'A JSON-formatted string containing an array of sample utterances that trigger this intent.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["是","是的","是啊","嗯嗯","是我","是我,有事吗","对,是","对的","对是我",""]', 'title' => ''],
],
[
'name' => 'Keywords',
'in' => 'query',
'schema' => ['description' => 'A JSON-formatted string containing an array of keywords that help identify the intent.', 'type' => 'string', 'required' => false, 'example' => '["是","是的"]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'IntentId' => ['description' => 'The ID of the created intent.', 'type' => 'string', 'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf', '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' => 'Creates an intent in a legacy canvas script.',
'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' => 'Path to the file that contains the job data.'."\n"
."\n"
.'> This value is the Folder parameter returned by the GetJobDataUploadParams operation.', '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 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' => ''],
'JobDataParsingTaskId' => ['description' => 'ID of the uploaded job data parsing task.'."\n"
."\n"
.'> Use this value as the JobDataParsingTaskId parameter in DescribeJobDataParsingTaskProgress.', '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' => 'Creates a job data parsing task.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateJobDataParsingTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateJobGroup' => [
'summary' => 'Creates 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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', 'title' => ''],
],
[
'name' => 'JobGroupName',
'in' => 'query',
'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '第一个任务', 'title' => ''],
],
[
'name' => 'JobGroupDescription',
'in' => 'query',
'schema' => ['description' => 'The 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' => 'The scenario ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'b9ff4e88-65f9-4eb3-987c-11ba51f3f24d', 'title' => ''],
],
[
'name' => 'StrategyJson',
'in' => 'query',
'schema' => ['description' => 'The task execution strategy. '."\n"
.'- repeatBy: the repeat type. Valid values: Once (no repeat), Week (repeat weekly), and Month (repeat monthly). '."\n"
.'- startTime: the strategy start time for time-based execution.'."\n"
.'- endTime: the strategy end time for time-based execution. '."\n"
.'> The execution mode is determined as follows:'."\n"
.'> - If no strategy start time or end time is specified, the task is executed immediately.'."\n"
.'> - If a strategy time is specified, the task is executed based on the schedule. You must also specify the repeat type repeatBy.'."\n"
.'- workingTime: the time window during which outbound calls can be made.'."\n"
.'- maxAttemptsPerDay: the maximum number of call attempts per day for each number in the task.'."\n"
.'- minAttemptInterval: the retry interval for a number, in minutes.'."\n"
.'- routingStrategy: the number strategy. Valid values: None (not specified), LocalFirst (local city numbers preferred), and LocalProvinceFirst (local province numbers preferred).'."\n"
.'- repeatDays: the execution days corresponding to the repeat type. If RepeatBy is set to Week, 0 indicates Sunday and 1-6 indicate Monday through Saturday. If RepeatBy is set to Month, 1-31 indicate the 1st through 31st day. The task is not executed in months that do not have the specified day. For example, if the 30th is selected, the task is not executed in February.'."\n"
.'- repeatable: specifies whether to enable cyclic tasks. Valid values: true and 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' => 'The redial strategy in JSON format. Parameter values default to false.'."\n"
."\n"
.'- **emptyNumberIgnore**: does not call nonexistent numbers.'."\n"
.'- **inArrearsIgnore**: does not call numbers with overdue payments.'."\n"
.'- **outOfServiceIgnore**: does not call numbers that are out of service.', 'type' => 'string', 'required' => false, 'example' => '{"emptyNumberIgnore":true,"inArrearsIgnore":true,"outOfServiceIgnore":true}', 'title' => ''],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of calling numbers. If not specified, all numbers bound to the instance are selected by default.',
'type' => 'array',
'items' => ['description' => 'The calling number.', 'type' => 'string', 'required' => false, 'example' => '4008013260', 'title' => ''],
'required' => false,
'maxItems' => 99,
'title' => '',
'example' => '',
],
],
[
'name' => 'RingingDuration',
'in' => 'query',
'schema' => ['description' => 'The optimal ringing duration. Default value: 25.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25', 'title' => ''],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => [
'description' => 'The job group priority. Valid values:'."\n"
.'- **Urgent**: urgent task.'."\n"
.'- **Daily**: daily task.',
'type' => 'string',
'enum' => ['Daily', 'Urgent'],
'required' => false,
'example' => 'Daily',
'title' => '',
],
],
[
'name' => 'MinConcurrency',
'in' => 'query',
'schema' => ['description' => 'The guaranteed concurrency value. '."\n"
.'- When the task starts, a minimum of N concurrent calls are guaranteed.'."\n"
.'- The sum of guaranteed concurrency values for tasks with the same priority cannot exceed the instance concurrency. '."\n"
.'- If the guaranteed concurrency value is set to 0, the system intelligently allocates idle concurrency.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'FlashSmsExtras',
'in' => 'query',
'schema' => ['description' => 'The configuration parameters for flash SMS in JSON format, including third-party flash SMS configuration information. '."\n"
.'- templateId: the flash SMS template ID. '."\n"
.'- configId: the flash SMS configuration ID.'."\n"
.'- templateContent: the flash SMS content.'."\n"
."\n"
.'> Obtain the value of templateContent from the corresponding flash SMS capability provider.', 'type' => 'string', 'required' => false, 'example' => '{"templateId":"104xx","configId":"8037f524-6fxxxxx", "templateContent": "【智能外呼机器人】给您来电,敬请接听!"}', 'title' => ''],
],
[
'name' => 'RecallCallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of redial calling numbers.',
'type' => 'array',
'items' => ['description' => 'The list of redial calling numbers. These are the calling numbers used for redialing when the first call attempt fails. If not specified, the default calling number list is used.', 'type' => 'string', 'required' => false, 'example' => '["4008013260"]', 'title' => ''],
'required' => false,
'maxItems' => 99,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The prompt message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'JobGroup' => [
'description' => 'The task information.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'Scheduling', 'title' => ''],
'ScenarioId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => '6cea9bed-63e6-439e-ae4c-b3333efff53d', 'title' => ''],
'JobGroupId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9', 'title' => ''],
'CreationTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578550074361', 'title' => ''],
'JobGroupName' => ['description' => 'The task name.', 'type' => 'string', 'example' => '第一个作业组', 'title' => ''],
'JobFilePath' => ['description' => 'The OSS path of the task file.'."\n"
.'> No value is returned if this field is empty.', 'type' => 'string', 'example' => 'UPLOADED/JOB/b3865dc3-40fa-4afd-9fe4-dc7cda305a24/229eac13-379d-4abe-96e0-8cf026b56c0b_template (1).xlsx', 'title' => ''],
'JobGroupDescription' => ['description' => 'The task description.', 'type' => 'string', 'example' => '第一个的作业组', 'title' => ''],
'JobDataParsingTaskId' => ['description' => 'The ID of the background asynchronous parsing operation for the uploaded task file.'."\n"
.'> No value is returned if this field is empty.', 'type' => 'string', 'example' => '744ff448-2b4c-40d4-94ca-51f246905b0f', 'title' => ''],
'ScriptName' => ['description' => 'The dialog flow scenario name.', 'type' => 'string', 'example' => '话术', 'title' => ''],
'ScriptVersion' => ['description' => 'The dialog flow scenario version.', 'type' => 'string', 'example' => '1628425608429', 'title' => ''],
'ModifyTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '1628425608429', 'title' => ''],
'CallingNumbers' => [
'description' => 'The list of calling numbers.',
'type' => 'array',
'items' => ['description' => 'The calling number.', 'type' => 'string', 'example' => '["4008013260"]', 'title' => ''],
'title' => '',
'example' => '',
],
'ExportProgress' => [
'description' => 'The export progress.'."\n"
.'> This field is deprecated.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The task export status. [Deprecated]', 'type' => 'string', 'example' => 'FINISHED', 'title' => ''],
'FileHttpUrl' => ['description' => 'The file URL. [Deprecated]', 'type' => 'string', 'example' => 'https://***.oss-cn-shanghai.aliyuncs.com/sample', 'title' => ''],
'Progress' => ['description' => 'The progress. [Deprecated]', 'type' => 'string', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Strategy' => [
'description' => 'The task scheduling strategy.',
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The strategy type.', 'type' => 'string', 'example' => 'Repeatable', 'title' => ''],
'StrategyName' => ['description' => 'The strategy name.', 'type' => 'string', 'example' => '催收策略', 'title' => ''],
'MaxAttemptsPerDay' => ['description' => 'The maximum number of daily call attempts when calls in the task are not connected.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'FollowUpStrategy' => ['description' => 'The follow-up action after the execution cycle ends. This field is no longer in use.', 'type' => 'string', 'example' => 'CONTINUE', 'title' => ''],
'EndTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2209702074000', 'title' => ''],
'Customized' => ['description' => 'The custom data of the strategy.', 'type' => 'string', 'example' => '{}', 'title' => ''],
'IsTemplate' => ['description' => 'Indicates whether this is a template.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'StartTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578550074000', 'title' => ''],
'StrategyId' => ['description' => 'The strategy ID.', 'type' => 'string', 'example' => 'cc9a436e-03b0-4ada-8364-77ec2290aa39', 'title' => ''],
'RoutingStrategy' => ['description' => 'The number strategy. Valid values:'."\n"
.'- None: no special rules.'."\n"
.'- LocalFirst: local city numbers preferred.'."\n"
.'- LocalProvinceFirst: local province numbers preferred.', 'type' => 'string', 'example' => 'LocalFirst', 'title' => ''],
'MinAttemptInterval' => ['description' => 'The interval between call attempts.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'StrategyDescription' => ['description' => 'The strategy description.', 'type' => 'string', 'example' => '催收策略', 'title' => ''],
'RepeatBy' => ['description' => 'The repeat execution mode. Valid values: once (no repeat), day (repeat daily), week (repeat weekly), and month (repeat monthly).', 'type' => 'string', 'example' => 'Once', 'title' => ''],
'WorkingTime' => [
'description' => 'The strategy execution time window.',
'type' => 'array',
'items' => [
'description' => 'The strategy execution time window.',
'type' => 'object',
'properties' => [
'EndTime' => ['description' => 'The window end time.', 'type' => 'string', 'example' => '12:00:00', 'title' => ''],
'BeginTime' => ['description' => 'The window start time.', 'type' => 'string', 'example' => '09:00:00', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RepeatDays' => [
'description' => 'The repeat execution days.'."\n"
.'- If **RepeatBy** is set to **Week**, 0 indicates Sunday and 1-6 indicate Monday through Saturday.'."\n"
.'- If **RepeatBy** is set to **Month**, 1-31 indicate the 1st through 31st day. The task is not executed in months that do not have the specified day. For example, if the 30th is selected, the task is not executed in February.',
'type' => 'array',
'items' => ['description' => 'The repeat execution day.', 'type' => 'string', 'example' => '[1,2,3,4,5]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'RecallStrategy' => [
'description' => 'The redial strategy.',
'type' => 'object',
'properties' => [
'EmptyNumberIgnore' => ['description' => 'Indicates whether nonexistent numbers are excluded from redialing.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'InArrearsIgnore' => ['description' => 'Indicates whether numbers with overdue payments are excluded from redialing.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'OutOfServiceIgnore' => ['description' => 'Indicates whether out-of-service numbers are excluded from redialing.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RingingDuration' => ['description' => 'The ringing duration.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
'Priority' => ['description' => 'The job group priority. Valid values:'."\n"
.'- **Urgent**: urgent task.'."\n"
.'- **Daily**: daily task.', 'type' => 'string', 'example' => 'Daily', 'title' => ''],
'MinConcurrency' => ['description' => 'The guaranteed concurrency value. When the task starts, a minimum of N concurrent calls are guaranteed. The sum of guaranteed concurrency values for tasks with the same priority cannot exceed the instance concurrency. If the guaranteed concurrency value is set to 0, the system intelligently allocates idle concurrency.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'RecallCallingNumbers' => [
'description' => 'The list of redial calling numbers.',
'type' => 'array',
'items' => ['description' => 'The list of redial calling numbers. These are the calling numbers used for redialing when the first call attempt fails. If not specified, the default calling number list is used.', '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' => ''],
],
],
'title' => 'Create an outbound 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'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateJobGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'CreateJobGroupExportTask' => [
'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' => 'Job group ID. Required.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'baf6dfdc-eb79-4c63-ab19-c56388b1fbdd', 'title' => ''],
],
[
'name' => 'Option',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'Parameters that control task execution for the import.',
'type' => 'array',
'items' => ['description' => 'Whether to ignore call recordings.'."\n"
."\n"
.'- Default: empty. Export both transcripts and recordings.'."\n"
."\n"
.'- IgnoreRecording: Skip recordings.', 'type' => 'string', 'required' => false, '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 request succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'Error code', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'TaskId' => ['description' => 'Task 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' => ''],
],
],
'title' => 'Create an outbound job group export task',
'summary' => 'Creates an export task for an outbound job group.',
'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' => '*'],
],
],
],
],
'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"}]',
],
'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' => 'Industry', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '教育', 'title' => ''],
],
[
'name' => 'Scene',
'in' => 'query',
'schema' => ['description' => 'Scenario', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '回访', 'title' => ''],
],
[
'name' => 'ChatbotId',
'in' => 'query',
'schema' => ['description' => 'If the NluServiceType of the instance is Authorized or Provided, specify the ID of the chatbot instance to which the script needs to be attached using this field.', 'type' => 'string', 'required' => false, 'example' => 'chatbot-cn-IfaUfqaUnb', 'title' => ''],
],
[
'name' => 'AsrConfig',
'in' => 'query',
'schema' => ['description' => 'ASR configuration. Parameter definitions:'."\n"
."\n"
.'- **appKey**: Alibaba Cloud account appKey.'."\n"
."\n"
.'- **maxEndSilence**: Voice endpoint detection duration.'."\n"
."\n"
.'- **silenceTimeout**: Silence timeout. Unit: seconds. The user times out after N seconds of silence.'."\n"
."\n"
.'- **engine**: Invoke service; \\[ali, xunfei]'."\n"
."\n"
.'- **nlsServiceType**: Invoke service type \\[Managed, Authorized]'."\n"
."\n"
.'- **engineXunfei**: If the caller is xunfei, enter the corresponding configuration.'."\n"
."\n"
.'> If you select ali as the engine and Authorized as the nlsServiceType, a custom service is used, and the service provider is ali. If you select ali as the engine and Managed as the nlsServiceType, the default service is used. If you select xunfei as the engine and Authorized as the nlsServiceType, xunfei is the service provider. You must enter the xunfei configuration: {"uuid":"ed2xxxxxxxxx","globalMaxEndSilence":700,"globalMaxEndSilenceEnable":true}'."\n"
."\n"
.'- **globalMaxEndSilence**: Silence detection. Unit: milliseconds.'."\n"
."\n"
.'- **globalMaxEndSilenceEnable**: Silence detection switch. 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. Parameter definitions:'."\n"
."\n"
.'- **voice**: Speaker.'."\n"
."\n"
.'- **volume**: Volume. Value range: 0 to 100. Default value: 50.'."\n"
."\n"
.'- **speechRate**: Speech rate. Value range: -500 to 500. Default value: 0.'."\n"
."\n"
.'- **pitchRate**: Pitch rate. Value range: -500 to 500. Default value: 0.'."\n"
."\n"
.'- **globalInterruptible**: Voice interruption configuration.'."\n"
.' -**engine**: Invoke service; \\[ali, volc, xunfei]. Large Language Model (LLM) scenarios do not support xunfei.'."\n"
."\n"
.'- **nlsServiceType**: Service type. \\[Managed, Authorized]'."\n"
."\n"
.'- **engineXunfei**: Configuration when the service provider is xunfei.'."\n"
."\n"
.'> 1\\. If you select ali as the engine and Authorized as the nlsServiceType, a custom service is used. 2. If the service provider is ali, and you select ali as the engine and Managed as the nlsServiceType, the default service is used. 3. If you select xunfei as the engine (applicable to small model scenarios) and Authorized as the nlsServiceType, xunfei is the service provider. You must enter the engineXunfei configuration: {"pitchRate":50,"speechRate":50,"voice":"aisjiuxu","volume":50}. 4. If you select volc as the engine and Authorized as the nlsServiceType, it applies to 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 instances, pass in the script list. Deprecated.',
'type' => 'array',
'items' => ['description' => 'For notification instances, pass in the script list. Deprecated.', 'type' => 'string', 'required' => false, 'example' => '您好,您昨晚在李佳琦直播间下单的娜薇诗椰子水二代精华2支装还未付款,超时未支付会自动关闭订单,活动错过不再有奥。', 'title' => ''],
'required' => false,
'example' => '[]',
'maxItems' => 100,
'title' => '',
],
],
[
'name' => 'ScriptWaveform',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'For notification instances, pass in the script voice list. Deprecated.',
'type' => 'array',
'items' => ['description' => 'For notification instances, pass in the script voice list. Deprecated.', 'type' => 'string', 'required' => false, 'example' => '[]', 'title' => ''],
'required' => false,
'example' => '[]',
'maxItems' => 100,
'title' => '',
],
],
[
'name' => 'MiniPlaybackEnable',
'in' => 'query',
'schema' => ['description' => 'Connective phrase configuration switch (applicable to small models)', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'NewBargeInEnable',
'in' => 'query',
'schema' => ['description' => 'Graceful interruption configuration switch (applicable to small models)', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'LongWaitEnable',
'in' => 'query',
'schema' => ['description' => 'Intelligent sentence segmentation configuration switch (applicable to small models)', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'EmotionEnable',
'in' => 'query',
'schema' => ['description' => 'Emotion detection configuration switch (applicable to small models)', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'AgentKey',
'in' => 'query',
'schema' => ['description' => 'Robot workspace access Key', 'type' => 'string', 'required' => false, 'example' => '9137ab9c27044921860030adf8590ec4_p_outbound_public', 'title' => ''],
],
[
'name' => 'AgentLlm',
'in' => 'query',
'schema' => ['description' => 'Is the robot workspace a Large Language Model (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' => [
'description' => 'NLU engine (applicable only to Large Language Model (LLM) scenarios). This field is empty for non-LLM scenarios.'."\n"
."\n"
.'- Prompts - Large Language Model (LLM) scenario,'."\n"
."\n"
.'- SSE\\_FUNCTION - Function Compute pattern.'."\n"
."\n"
.'- BeeBot - Workflow pattern.',
'enumValueTitles' => ['Prompts' => 'Text entry pattern', 'SSE_FUNCTION' => 'Function Compute service pattern'],
'type' => 'string',
'required' => false,
'example' => 'Prompts',
'title' => '',
],
],
[
'name' => 'NluAccessType',
'in' => 'query',
'schema' => ['description' => 'NLU access method (applicable only to Large Language Model (LLM) scenarios). Enumeration: Managed - Access using an Alibaba public account. This field is empty for non-LLM scenarios.', 'type' => 'string', 'required' => false, 'example' => 'Managed', 'title' => ''],
],
[
'name' => 'ScriptNluProfileJsonString',
'in' => 'query',
'schema' => ['description' => '> If nluEngine is SSE\\_FUNCTION, you must pass in the corresponding configuration.'."\n"
."\n"
.'Function Compute service pattern configuration'."\n"
."\n"
.'- fcRegion: Function service region'."\n"
."\n"
.'- fcFunction: Function service name'."\n"
."\n"
.'- fcHttpTriggerUrl Function service trigger', '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 operation was successful.', '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"
."\n"
.'- **INITIALIZE\\_IN\\_PROGRESS**: Initializing.'."\n"
."\n"
.'- **PUBLISHED**: Published.'."\n"
."\n"
.'- **PUBLISH\\_IN\\_PROGRESS**: Publishing.'."\n"
."\n"
.'- **ROLLBACK\\_IN\\_PROGRESS**: Rolling back.'."\n"
."\n"
.'- **EXAMINE\\_IN\\_PROGRESS**: Pending review.'."\n"
."\n"
.'- **PUBLISHED\\_AND\\_EXAMINE\\_IN\\_PROGRESS**: Published and pending review.'."\n"
."\n"
.'- **PUBLISH\\_FAILED**: Publish failed.'."\n"
."\n"
.'- **ROLLBACK\\_FAILED**: Rollback failed.'."\n"
."\n"
.'- **IMPORT\\_IN\\_PROGRESS**: Importing.'."\n"
."\n"
.'- **IMPORT\\_FAILED**: Import failed.', 'type' => 'string', 'example' => 'DRAFTED', 'title' => ''],
'UpdateTime' => ['description' => 'Script update time (unit: 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' => 'Is 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' => 'Is debug draft', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ScriptName' => ['description' => 'Script name', 'type' => 'string', 'example' => '课程满意度回访', 'title' => ''],
'Scene' => ['description' => 'Scenario', 'type' => 'string', 'example' => '回访', 'title' => ''],
'NluEngine' => ['description' => 'NLU engine (applicable only to Large Language Model (LLM) scenarios). Enumeration: Prompts - Large Language Model (LLM) scenario. This field is empty for non-LLM scenarios.', 'type' => 'string', 'example' => 'Prompts', 'title' => ''],
'NluAccessType' => ['description' => 'NLU access method (applicable only to Large Language Model (LLM) scenarios). Enumeration: Managed - Access using an Alibaba public account. 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' => ''],
],
],
'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"}]',
'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}'],
],
],
],
],
],
'CreateScriptWaveform' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2bfa5ae4-7185-4227-a3b8-328f26f11be1', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'Scenario ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", 'title' => ''],
],
[
'name' => 'ScriptContent',
'in' => 'query',
'schema' => ['description' => 'The text of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '您好,您昨晚在李佳琦直播间下单的娜薇诗椰子水二代精华2支装还未付款,超时未支付会自动关闭订单,活动错过不再有奥。', 'title' => ''],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => ['description' => 'The ID of the recording file.'."\n"
."\n"
.'> Obtain this ID from the Folder parameter of the GetJobDataUploadParams operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6f91885fa24b4c408d8f4eb392fd8ae6', 'title' => ''],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => ['description' => 'The name of the recording file.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'faaf8508-9542-4ac4-84a2-0ddcbb5f79a6 (2).json', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'Script information', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'ScriptWaveformId' => ['description' => 'The ID of the script waveform.', 'type' => 'string', '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' => 'Creates a recording for the broadcast script.',
'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' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The ID of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0fe7f71c-8771-42ef-9bb1-19aa16ae7120', 'title' => ''],
],
[
'name' => 'TagName',
'in' => 'query',
'schema' => ['description' => 'The tag name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '研究生', 'title' => ''],
],
[
'name' => 'TagGroup',
'in' => 'query',
'schema' => ['description' => 'The tag group name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '目标学历', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code returned for the request.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'TagId' => ['description' => 'The tag ID.', 'type' => 'string', 'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf', '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' => 'Creates a tag 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' => [
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => '1dcb09c5-d5db-4397-bf65-db854463beea', 'title' => ''],
],
[
'name' => 'TaskCreateTimeGte',
'in' => 'query',
'schema' => ['description' => 'The start time for searching by task creation time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1646496000000', 'title' => ''],
],
[
'name' => 'TaskCreateTimeLte',
'in' => 'query',
'schema' => ['description' => 'The end time for searching by task creation time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1646582400000', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => ['description' => 'The job group ID.', 'type' => 'string', 'required' => false, 'example' => 'cb731aee-0a5b-4c2b-924c-d9e82eb1d8d7', 'title' => ''],
],
[
'name' => 'HasAnswered',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the call was answered.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'HasHangUpByRejection',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the call was hung up due to rejection.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'HasReachedEndOfFlow',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the conversation was completed.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'JobGroupNameQuery',
'in' => 'query',
'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => false, 'example' => '测试_20220217_160147', 'title' => ''],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => '82097dd5-54df-475f-beba-eec8f4b7a3e1', 'title' => ''],
],
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => ['description' => 'The called number.', 'type' => 'string', 'required' => false, 'example' => '11111111111', 'title' => ''],
],
[
'name' => 'UserIdMatch',
'in' => 'query',
'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => '82097dd5-54df-475f-beba-eec8f4b7a3e1', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => '64ebe700-91b4-49cb-b457-0b7c0b598a86', 'title' => ''],
],
[
'name' => 'ActualTimeGte',
'in' => 'query',
'schema' => ['description' => 'The start time (inclusive) for searching by call time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1646496000000', 'title' => ''],
],
[
'name' => 'ActualTimeLte',
'in' => 'query',
'schema' => ['description' => 'The end time (inclusive) for searching by call time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1646582400000', 'title' => ''],
],
[
'name' => 'RecordingDurationGte',
'in' => 'query',
'schema' => ['description' => 'The minimum ringing duration for the search.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'RecordingDurationLte',
'in' => 'query',
'schema' => ['description' => 'The maximum ringing duration for the search.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => ['description' => 'The page number. Pages start from 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'OtherId',
'in' => 'query',
'schema' => ['description' => 'The other ID.', 'type' => 'string', 'required' => false, 'example' => '64ebe700-91b4-49cb-b457-0b7c0b598a86', 'title' => ''],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => 'The field by which to sort the results.', 'type' => 'string', 'required' => false, 'example' => 'actualTime', 'title' => ''],
],
[
'name' => 'SortOrder',
'in' => 'query',
'schema' => ['description' => 'The sort order. Valid values:'."\n"
.'- asr: ascending order'."\n"
.'- desc: descending order', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''],
],
[
'name' => 'CallDurationGte',
'in' => 'query',
'schema' => ['description' => 'The minimum call duration for the search.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'CallDurationLte',
'in' => 'query',
'schema' => ['description' => 'The maximum call duration for the search.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'JobStatusStringList',
'in' => 'query',
'schema' => ['description' => 'The job status.', 'type' => 'string', 'required' => false, 'example' => 'Succeeded', 'title' => ''],
],
[
'name' => 'TaskStatusStringList',
'in' => 'query',
'schema' => ['description' => 'The call status.', 'type' => 'string', 'required' => false, 'example' => 'Succeeded,Failed', 'title' => ''],
],
[
'name' => 'ScriptNameQuery',
'in' => 'query',
'schema' => ['description' => 'The scenario name.', 'type' => 'string', 'required' => false, 'example' => '测试', 'title' => ''],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C377C5FF-4F94-1B23-89D0-50C560623EE4', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '[]', 'title' => ''],
'TaskId' => ['description' => 'The export task 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' => ''],
],
],
'title' => 'Export outbound call history',
'summary' => 'Creates an asynchronous task to 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'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTaskExportTask'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateTaskExportTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'CreateTenantKey' => [
'summary' => 'Creates a key.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREoutboundbotN899BL'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code returned.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
],
'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 an asymmetric encryption key pair',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]',
],
'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 profile IDs',
'type' => 'array',
'items' => ['description' => 'Agent profile ID', 'type' => 'string', 'required' => false, 'example' => '3d7d253cfb77476da0cf3681bcf7b4e8', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'AppIp',
'in' => 'formData',
'schema' => ['description' => 'app\\_ip (system field, optional)', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '127.0.0.1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the operation was successful', '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' => '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' => 'Deletes Large Language Model (LLM) agents.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteAgentProfiles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeleteAllNumberDistrictInfo' => [
'summary' => 'Deletes all entries from the number district 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' => 'Interface message', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Success status', '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' => 'Delete an intent in a small-model scenario.',
'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' => 'Deletes utterance templates for intents in small model scenarios.',
'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' => 'Is successful', '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' => 'Delete user queries for intents in the small-model scenario.',
'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 Say 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 Say ID', 'type' => 'integer', 'format' => 'int64', 'example' => '17448458', 'title' => ''],
'Success' => ['description' => 'Success', '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 block 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' => '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' => 'You can 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 response 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' => 'Deletes the global outbound calling 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' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The ID of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd7c28efb-47f7-4a85-a522-5038e30a0b98', 'title' => ''],
],
[
'name' => 'DialogueFlowId',
'in' => 'query',
'schema' => ['description' => 'The ID of the dialogue flow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'caab25d1-1f30-4996-8135-0036f5661b43', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.'."\n"
."\n"
.'- **true**: The request was successful.'."\n"
."\n"
.'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => 'The data returned.',
'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' => 'Deletes a dialogue flow. This is a 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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0fe7f71c-8771-42ef-9bb1-19aa16ae7120', 'title' => ''],
],
[
'name' => 'GlobalQuestionId',
'in' => 'query',
'schema' => ['description' => 'The global question ID.'."\n"
."\n"
.'> You can call the ListGlobalQuestions operation to obtain the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '35f1361e-4377-494c-9f10-4274bda0317f', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', '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' => 'Deletes a global question from a legacy canvas script.',
'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' => 'The 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' => 'Deletes an Intelligent Outbound Calling 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' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The ID of the script that contains the intent.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17'."\n", 'title' => ''],
],
[
'name' => 'IntentId',
'in' => 'query',
'schema' => ['description' => 'The 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' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Succes', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n", 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => 'The response object.',
'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' => 'Deletes an intent. This is a legacy 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' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the job group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'fc1fb484-4fe8-4031-b662-5b87ea88590b', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message. The value is `Success` for a successful request. Otherwise, an error message is returned.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', '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' => 'Deletes a job group.',
'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' => 'Instance ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '33014787-cc13-49d3-ab2f-a98aa8f15fbb', 'title' => ''],
],
[
'name' => 'OutboundCallNumberId',
'in' => 'query',
'schema' => ['description' => 'Number ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ffa367e0-58f3-43b6-9615-c63db99c5add', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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:'."\n"
."\n"
.'- true: succeeded.'."\n"
."\n"
.'- false: failed.', 'type' => 'boolean', 'example' => 'true', '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' => [],
],
'DeleteScript' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b3d5ac22-9643-49c6-aa84-777f6656f9f5', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The 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' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call succeeded. A value of true indicates success. A value of false indicates failure.', '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' => 'Deletes a specified 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' => 'The ID of the instance to which the recording belongs.', 'type' => 'string', 'required' => true, 'example' => '1eefcb81-cd58-4143-8180-6a962d79d708', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The ID of the scenario to which the recording belongs.', 'type' => 'string', 'required' => true, 'example' => 'dcc42f0d-cfd8-4866-9bbf-002042503745', 'title' => ''],
],
[
'name' => 'UuidsJson',
'in' => 'query',
'schema' => ['description' => 'A list of recording IDs. If this parameter is empty, all recordings are selected by default.'."\n"
."\n"
.'> Obtain the recording IDs from the ListScriptRecording operation.', 'type' => 'string', 'required' => false, 'example' => '["d17d5bfa-4972-4389-9718-f9602edabe48"]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned by the API.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '56666881-887A-530A-B679-C3B6B6B142C0', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call was successful.', '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' => 'Deletes uploaded recordings for 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' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'Scenario ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b9ff4e88-65f9-4eb3-987c-11ba51f3f24d', 'title' => ''],
],
[
'name' => 'ScriptWaveformId',
'in' => 'query',
'schema' => ['description' => 'Deleted recording ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'df8216aa-d8f6-4501-864f-f8334d946561', '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' => '0FD69531-F82C-542D-A5E7-CB54544041C5', 'title' => ''],
'Success' => ['description' => 'Success', '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\\": \\"0FD69531-F82C-542D-A5E7-CB54544041C5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '[Deprecated] Delete script recording',
'summary' => 'Delete a 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' => 'Retrieves the intent in the small model scenario.',
'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' => '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', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call 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' => ''],
'IntentId' => ['description' => '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' => 'Intent name', 'type' => 'string', 'example' => '知道了', 'title' => ''],
'AliasName' => ['description' => 'Intent alias', 'type' => 'string', 'example' => '嗯明白了', 'title' => ''],
'CreateUserName' => ['description' => 'Creator account name', 'type' => 'string', 'example' => 'xxx@voice-navigator-testonaliyun.com', 'title' => ''],
'CreateUserId' => ['description' => 'Creator user ID', 'type' => 'string', 'example' => '1252504', 'title' => ''],
'ModifyUserId' => ['description' => 'Modifier user ID', 'type' => 'string', 'example' => '1252504', 'title' => ''],
'ModifyUserName' => ['description' => 'Modifier account name', 'type' => 'string', 'example' => 'xxx@voice-navigator-testonaliyun.com'."\n", 'title' => ''],
'CreateTime' => ['description' => 'Creation time', 'type' => 'string', 'example' => '2025-04-21 10:29:59.+0800', 'title' => ''],
'ModifyTime' => ['description' => 'Modification time', '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\\": \\"xxx@voice-navigator-testonaliyun.com\\",\\n \\"CreateUserId\\": \\"1252504\\",\\n \\"ModifyUserId\\": \\"1252504\\",\\n \\"ModifyUserName\\": \\"xxx@voice-navigator-testonaliyun.com\\\\n\\",\\n \\"CreateTime\\": \\"2025-04-21 10:29:59.+0800\\",\\n \\"ModifyTime\\": \\"2025-04-21 15:52:57.+0800\\"\\n }\\n}","type":"json"}]',
'title' => '[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' => 'Task 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 success', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'TotalCompleted' => ['description' => 'Number of completed tasks 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 nodes',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NoAnswerNum' => ['description' => 'Number of no-answers', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'GroupId' => ['description' => 'Task group ID', 'type' => 'string', 'example' => 'f06f7c9f-2895-4b30-a8c2-6ecccb9c9f89', 'title' => ''],
'NodeName' => ['description' => 'Node name', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'HangUpNum' => ['description' => 'Number of hang-ups', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79', 'title' => ''],
'HitNum' => ['description' => 'Number of hits', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
'Id' => ['description' => 'ID, unique identifier', 'type' => 'string', 'example' => '123', 'title' => ''],
'NodeId' => ['description' => 'Node ID', 'type' => 'string', 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '[]',
'title' => '',
],
'HangUpDialogueNodes' => [
'description' => 'Hang-up nodes',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'HangUpNum' => ['description' => 'Number of hang-ups', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'NodeId' => ['description' => 'Node ID', 'type' => 'string', 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79', 'title' => ''],
'NodeName' => ['description' => 'Node name', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'RateDisplay' => ['description' => 'Proportion of quantity', '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' => 'Retrieves performance statistics for task 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' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94063',
'abilityTreeNodes' => ['FEATUREoutboundbotN899BL'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => ['description' => 'The job group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9eb8fe4f-b286-4834-9688-2c9b171e223e', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1364f208-982d-4d0c-89aa-d56e22b47589', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'DsReports' => ['description' => 'The dialog flow information in the format of 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' => ''],
],
],
'title' => 'Retrieve job group label hit statistics',
'summary' => 'Queries the label hit statistics for a job group.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'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"}]',
],
'DescribeGlobalQuestion' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7cefbff0-8d50-4d6f-b93c-73cee23c1555', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The ID of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b7ee988b-2837-4bc1-9d56-f76e7c831f60', 'title' => ''],
],
[
'name' => 'GlobalQuestionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the global question.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e851e242-ad67-4507-96a2-d4114564dcec', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'GlobalQuestion' => [
'description' => 'The details of the global question.',
'type' => 'object',
'properties' => [
'GlobalQuestionId' => ['description' => 'The ID of the global question.', 'type' => 'string', 'example' => 'f160ec2e-94f2-4c03-87be-ece5b52d5dd9', 'title' => ''],
'Answers' => ['description' => 'The answers to the global question.', 'type' => 'string', 'example' => '["你好,我是你的专属客服顾问."]', 'title' => ''],
'GlobalQuestionType' => ['description' => 'The type of the global question.', 'type' => 'string', 'example' => 'COMMON', 'title' => ''],
'GlobalQuestionName' => ['description' => 'The name of the global question.', 'type' => 'string', 'example' => '你是谁-全局问题', 'title' => ''],
'Questions' => ['description' => 'The questions mapped to this global question.', 'type' => 'string', 'example' => ' ["你是谁","你叫什么"]', 'title' => ''],
'ScriptId' => ['description' => 'The ID of the script.', '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' => 'Retrieves the details of a global question in a legacy canvas script.',
'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 execution status of tasks in 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 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' => ''],
'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 calls hung up by customers', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'CreatorName' => ['description' => 'Deprecated', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'TransferByNoAnswer' => ['description' => 'No answer', '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 failed calls', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'NoInteractionNum' => ['description' => 'Number of calls with no interaction', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'JobsProgress' => [
'description' => 'Execution progress',
'type' => 'object',
'properties' => [
'SchedulingNum' => ['description' => 'Number of tasks being scheduled', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'TotalCompletedNum' => ['description' => 'Total number of completed tasks', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'FailedNum' => ['description' => 'Number of failed tasks', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'PausedNum' => ['description' => 'Number of paused tasks', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'CancelledNum' => ['description' => 'Number of canceled tasks', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'TotalJobs' => ['description' => 'Total number of jobs', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'TotalNotAnsweredNum' => ['description' => 'Number of unanswered calls', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'ExecutingNum' => ['description' => 'Number of executing jobs', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
],
'example' => '{}',
'title' => '',
],
'TalkTurnsDistribution' => ['description' => 'Distribution of conversation rounds'."\n"
."\n"
.'- total: total number of conversation rounds involved'."\n"
."\n"
.'- number: specific round number'."\n"
."\n"
.'> * Example: {"total":"5","5":"1"} means 5 conversation rounds were involved, and 1 call had 5 user turns.', 'type' => 'string', 'example' => '{"total":"5","5":"4"}'."\n", 'title' => ''],
'DurationDistribution' => ['description' => 'Call duration distribution', 'type' => 'string', 'example' => '{"max":"40","1":"1","total":"40","min":"40"}', 'title' => ''],
'AvgTalkTime' => ['description' => 'Average talk time', 'type' => 'integer', 'format' => 'int32', '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' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"GroupId\\": \\"b24d321a-2a74-4dd1-a0ba-4ab09cef6652\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"InstanceId\\": \\"c46001bc-3ead-4bfd-9a69-4b5b66a4a3f4\\",\\n \\"ExecutingInfo\\": {\\n \\"EndTime\\": 1640087774563,\\n \\"StartTime\\": 1640087774563,\\n \\"HangUpByClientNum\\": 5,\\n \\"CreatorName\\": \\"xxx\\",\\n \\"TransferByNoAnswer\\": 5,\\n \\"FinishedNum\\": 5,\\n \\"TransferByIntentNum\\": 5,\\n \\"CallNum\\": 5,\\n \\"CallFailedNum\\": 5,\\n \\"NoInteractionNum\\": 1,\\n \\"JobsProgress\\": {\\n \\"SchedulingNum\\": 5,\\n \\"TotalCompletedNum\\": 5,\\n \\"FailedNum\\": 5,\\n \\"PausedNum\\": 5,\\n \\"CancelledNum\\": 5,\\n \\"TotalJobs\\": 5,\\n \\"TotalNotAnsweredNum\\": 5,\\n \\"ExecutingNum\\": 5\\n },\\n \\"TalkTurnsDistribution\\": \\"{\\\\\\"total\\\\\\":\\\\\\"5\\\\\\",\\\\\\"5\\\\\\":\\\\\\"4\\\\\\"}\\\\n\\",\\n \\"DurationDistribution\\": \\"{\\\\\\"max\\\\\\":\\\\\\"40\\\\\\",\\\\\\"1\\\\\\":\\\\\\"1\\\\\\",\\\\\\"total\\\\\\":\\\\\\"40\\\\\\",\\\\\\"min\\\\\\":\\\\\\"40\\\\\\"}\\",\\n \\"AvgTalkTime\\": 258\\n }\\n}","type":"json"}]',
'title' => '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' => '*'],
],
],
],
],
],
'DescribeInstance' => [
'summary' => 'Queries the information of an outbound robot business instance.',
'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' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Instance' => [
'description' => 'The business instance information.',
'type' => 'object',
'properties' => [
'CreationTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578469042851', 'title' => ''],
'InstanceId' => ['description' => 'The business instance ID.', 'type' => 'string', 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', 'title' => ''],
'CreatorId' => ['description' => 'The creator ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '435986', 'title' => ''],
'OwnerName' => ['description' => 'The name of the business instance owner.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
'InstanceDescription' => ['description' => 'The description of the business instance.', 'type' => 'string', 'example' => '这个是第一个实例', 'title' => ''],
'InstanceName' => ['description' => 'The name of the business instance.', 'type' => 'string', 'example' => '第一个实例', 'title' => ''],
'CreatorName' => ['description' => 'The name of the creator.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', 'title' => ''],
'MaxConcurrentConversation' => ['description' => 'The maximum concurrency of 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' => ''],
],
],
'title' => 'Query business instance information',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'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"}]',
],
'DescribeIntent' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The ID of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17'."\n", 'title' => ''],
],
[
'name' => 'IntentId',
'in' => 'query',
'schema' => ['description' => 'The ID of the intent.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10717802', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '327FEE69-F173-5B2F-9F3B-DCC6182D7BA0', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Intent' => [
'description' => 'The details of the intent.',
'type' => 'object',
'properties' => [
'Utterances' => ['description' => 'A list of utterances that trigger the intent.', 'type' => 'string', 'example' => '["ok","好的","好吧","好嘞","可以","行啊","行吧","那行","知道了","我看一下","能的","等会吧","等一下","马上还","等一会","过两天","我会想办法处理"]', 'title' => ''],
'IntentDescription' => ['description' => 'The description of the intent.', 'type' => 'string', 'example' => '同意还款意图', 'title' => ''],
'UpdateTime' => ['description' => 'The time when the intent was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578469042851', 'title' => ''],
'CreateTime' => ['description' => 'The time when the intent was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578469042851', 'title' => ''],
'Keywords' => ['description' => 'The keywords for the intent. You can use these keywords to filter intents during list operations.', 'type' => 'string', 'example' => '["还款"]', 'title' => ''],
'ScriptId' => ['description' => 'The ID of the script.', 'type' => 'string', 'example' => '6ef95fd5-558f-4ee8-af34-b2ede087a87c', 'title' => ''],
'IntentId' => ['description' => 'The ID of the intent.', 'type' => 'string', 'example' => '10722701', 'title' => ''],
'IntentName' => ['description' => 'The name of the intent.', 'type' => 'string', 'example' => '统一还款', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => 'The data returned.',
'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' => 'Retrieves the details of an intent. This is a 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' => 'Queries the performance statistics of intents for 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 to display (required)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '5', '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 of the instance.', 'type' => 'string', 'example' => '0c3f352f-d045-491d-9ce7-11f2d2b7775d', 'title' => ''],
'Success' => ['description' => 'Success', '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 count of global intents', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'ProcessIntents' => [
'description' => 'Intent information list',
'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' => 'Hit after 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 count', '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' => ['description' => 'Percentage', 'type' => 'string', 'example' => '33.33%', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '[]',
'title' => '',
],
'GlobalIntents' => [
'description' => 'Global intent array',
'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' => 'Hit after 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 count', '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' => 'Rejected intent information list',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e', 'title' => ''],
'GroupId' => ['description' => 'Task group ID', 'type' => 'string', 'example' => 'b24d321a-2a74-4dd1-a0ba-4ab09cef6652', 'title' => ''],
'HitAfterNoAnswer' => ['description' => 'No acknowledgement is received after a hit.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'IntentId' => ['description' => 'Intent ID', 'type' => 'string', 'example' => '10398032', 'title' => ''],
'IntentName' => ['description' => 'Intent name', 'type' => 'string', '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' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94069',
'abilityTreeNodes' => ['FEATUREoutboundbot7ZIYMY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c8a2b7f2-ad1a-4865-b872-d0080d9802d9', 'title' => ''],
],
[
'name' => 'WithScript',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to return task scenario information.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Job' => [
'description' => 'The job information.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The job status. Valid values:'."\n"
."\n"
.'- Scheduling: the job is being scheduled.'."\n"
.'- Executing: the job is being executed.'."\n"
.'- Succeeded: the job succeeded.'."\n"
.'- Paused: the job is paused.'."\n"
.'- Failed: the job failed.'."\n"
.'- Cancelled: the job is cancelled.'."\n"
.'- Drafted: the job is in draft state, which is a temporary state during file import.', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''],
'ActualTime' => ['description' => 'The actual execution time of the job. This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640068026385', 'title' => ''],
'Priority' => ['description' => 'The job priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'DsReport' => ['description' => 'The tag hit information of the task. This parameter is deprecated.', 'type' => 'string', 'example' => '-', 'title' => ''],
'NextExecutionTime' => ['description' => 'The next execution time of the task.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640068026385', 'title' => ''],
'FailureReason' => ['description' => 'The reason for the job failure.', 'type' => 'string', 'example' => 'NoAnswer', 'title' => ''],
'SystemPriority' => ['description' => 'The system priority of the job.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28', 'title' => ''],
'CalledNumber' => ['description' => 'The called number.', 'type' => 'string', 'example' => '137****7777', 'title' => ''],
'ReferenceId' => ['description' => 'The business ID of the job, which is custom-defined by the business side.'."\n"
."\n"
.'> This is the ContactId value that was uploaded.', 'type' => 'string', 'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28', 'title' => ''],
'JobGroupId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8', 'title' => ''],
'ScenarioId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150', 'title' => ''],
'StrategyId' => ['description' => 'The policy ID.', 'type' => 'string', 'example' => 'c8a2b7f2-ad1a-4865-b872-d0080d9802d9', 'title' => ''],
'EndReason' => ['description' => 'The reason why the call ended. Valid values:'."\n"
."\n"
.'- **1**: FINISHED. The call ended normally.'."\n"
.'- **2**: CHATBOT_HANGUP_AFTER_NOANSWER. The robot hung up after unrecognized input.'."\n"
.'- **3**: CHATBOT_HANGUP_AFTER_SILENCE. The robot hung up due to silence timeout.'."\n"
.'- **4**: CLIENT_HANGUP_AFTER_NOANSWER. The user hung up after unrecognized input.'."\n"
.'- **5**: CLIENT_HANGUP. The user hung up without reason.'."\n"
.'- **6**: TRANSFER_BY_INTENT. The call was transferred to a human agent because an intent was matched.'."\n"
.'- **7**: TRANSFER_AFTER_NOANSWER. The call was transferred to a human agent after unrecognized input.'."\n"
.'- **8**: INO_INTERACTION. No interaction from the user side.'."\n"
.'- **9**: ERROR. The call was interrupted due to a system error.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', 'title' => ''],
'Contacts' => [
'description' => 'The contact information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '1358****8888', 'title' => ''],
'State' => ['description' => 'The contact state. This parameter is deprecated.', 'type' => 'string', 'example' => 'Available', 'title' => ''],
'ContactId' => ['description' => 'The contact ID. This value is generated by the system.', 'type' => 'string', 'example' => 'db3db762-e421-44c9-9a01-cb423470757c', 'title' => ''],
'Honorific' => ['description' => 'The honorific of the contact. This value is the same as the contact name.', 'type' => 'string', 'example' => '张先生', 'title' => ''],
'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '72dcd26b-f12d-4c27-b3af-18f6aed5b160', 'title' => ''],
'ContactName' => ['description' => 'The contact name.', 'type' => 'string', 'example' => '张三', 'title' => ''],
'Role' => ['description' => 'The contact role. This parameter is 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' => 'The business parameters.'."\n"
."\n"
.'> TenantId and ServiceId are generated by the system. Other parameters are custom-defined and passed in by the user.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The name of the business parameter.', 'type' => 'string', 'example' => 'djrq', 'title' => ''],
'Value' => ['description' => 'The value of the business parameter.', 'type' => 'string', 'example' => '2019-08-21 09:49:59.0', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '[]',
'title' => '',
],
'Summary' => [
'description' => 'The conversation business tag data:'."\n"
.'- In large model scenarios: the tag hit data after the conversation ends.'."\n"
."\n"
.'- In small model scenarios: the variable value data after the conversation ends.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SummaryName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => 'score', 'title' => ''],
'Category' => ['description' => 'The conversation summary category. This parameter is deprecated.', 'type' => 'string', 'example' => '{}', 'title' => ''],
'Content' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '5', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '[]',
'title' => '',
],
'Tasks' => [
'description' => 'The call list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The task status. Valid values:'."\n"
."\n"
.'(Note: The **Succeeded** status has been subdivided into specific reasons. The **Succeeded**: 1 (Connected) status is no longer returned. Instead, the specific sub-reason type is returned.)'."\n"
."\n"
.'- **Executing**: 0. The call is being made.'."\n"
.'- **Succeeded**: 1. The call is connected.'."\n"
.'- **NoAnswer**: 2. Not connected - no answer.'."\n"
.'- **NotExist**: 3. Not connected - nonexistent number.'."\n"
.'- **Busy**: 4. Not connected - busy.'."\n"
.'- **Cancelled**: 5. Not dialed - task stopped.'."\n"
.'- **Failed**: 6. Failed.'."\n"
.'- **NotConnected**: 7. Not connected - unreachable.'."\n"
.'- **PoweredOff**: 8. Not connected - powered off.'."\n"
.'- **OutOfService**: 9. Not connected - callee out of service.'."\n"
.'- **InArrears**: 10. Not connected - callee has overdue payment.'."\n"
.'- **EmptyNumber**: 11. Not dialed - nonexistent number, no outbound call.'."\n"
.'- **PerDayCallCountLimit**: 12. Not dialed - daily limit exceeded.'."\n"
.'- **ContactBlockList**: 13. Not dialed - blacklisted.'."\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 verification failure.'."\n"
.'- **OutOfServiceNoCall**: 17. Not dialed - callee out of service, no outbound call.'."\n"
.'- **InArrearsNoCall**: 18. Not dialed - callee has overdue payment, no outbound call.'."\n"
.'- **CallingNumberNotExist**: 19. Not dialed - caller number does not exist.'."\n"
.'- **SucceededFinish**: 20. Connected - ended normally.'."\n"
.'- **SucceededChatbotHangUpAfterNoAnswer**: 21. Connected - robot hung up after unrecognized input.'."\n"
.'- **SucceededChatbotHangUpAfterSilence**: 22. Connected - robot hung up due to 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 human agent by intent match.'."\n"
.'- **SucceededTransferAfterNoAnswer**: 26. Connected - transferred to human agent after unrecognized input.'."\n"
.'- **SucceededInoInterAction**: 27. Connected - no interaction from user side.'."\n"
.'- **SucceededError**: 28. Connected - interrupted due to system error.'."\n"
.'- **SucceededSpecialInterceptVoiceAssistant**: 29. Connected - special interception by voice assistant.'."\n"
.'- **SucceededSpecialInterceptExtensionNumberTransfer**: 30. Connected - special interception by extension number transfer.'."\n"
.'- **SucceededSpecialInterceptCustomSpecialIntercept**: 31. Connected - special interception by custom interception.'."\n"
.'- **HighRiskSipCode**: 32. Not dialed - high risk, no outbound call.', 'type' => 'string', 'example' => 'SucceededTransferByIntent', 'title' => ''],
'PlanedTime' => ['description' => 'The planned call time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579068424883', 'title' => ''],
'ChatbotId' => ['description' => 'The chatbot ID for the conversation.', 'type' => 'string', 'example' => '1234', 'title' => ''],
'ActualTime' => ['description' => 'The actual execution time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579068424883', 'title' => ''],
'CalledNumber' => ['description' => 'The called number.', 'type' => 'string', 'example' => '135****8888', 'title' => ''],
'EndTime' => ['description' => 'The actual end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579068424883', 'title' => ''],
'ScenarioId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150', 'title' => ''],
'EndReason' => ['description' => 'The reason why the call ended.', 'type' => 'string', 'example' => 'FINISHED', 'title' => ''],
'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', 'title' => ''],
'CallId' => ['description' => 'SIP call id。', 'type' => 'string', 'example' => '1528189846043', 'title' => ''],
'CallingNumber' => ['description' => 'The calling number.', 'type' => 'string', 'example' => '0571****3106', 'title' => ''],
'Brief' => ['description' => 'The business result. This parameter is deprecated.', 'type' => 'string', 'example' => '1', 'title' => ''],
'Duration' => ['description' => 'The conversation duration. This field is not returned.'."\n"
."\n"
.'> This data is returned in the ActionParams parameter of the last element in the Conversation list.', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'title' => ''],
'TaskId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'ff44709e-39a6-43ba-959b-20fcabe3e496', 'title' => ''],
'Conversation' => [
'description' => 'The conversation text list of the task.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ActionParams' => ['description' => 'The action parameters.'."\n"
."\n"
.'- When the interruption feature is enabled, you can retrieve the text that the robot has already played back from the answer value in the robot conversation text. Example:'."\n"
.' - {"abortDialogueInfo":{"abortDialogueType":"Interrupted","answer":"这是打断文本信息","sequenceId":"xxxxx"},"streamEnd":true}",', 'type' => 'string', 'example' => '{}', 'title' => ''],
'Action' => ['description' => 'The action.', 'type' => 'string', 'example' => 'Broadcast', 'title' => ''],
'Timestamp' => ['description' => 'The time when the summary was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579068424883', 'title' => ''],
'Speaker' => ['description' => 'The speaker of the conversation. Valid values: Robot (robot) and Contact (contact).', 'type' => 'string', 'example' => 'Robot', 'title' => ''],
'Script' => ['description' => 'The conversation text.', 'type' => 'string', 'example' => '你好,我是**客服', 'title' => ''],
'Summary' => [
'description' => 'The conversation summary data. This parameter is deprecated.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SummaryName' => ['description' => 'The summary name.', 'type' => 'string', 'example' => 'score', 'title' => ''],
'Category' => ['description' => 'The conversation summary category. This parameter is deprecated.', 'type' => 'string', 'example' => '{}', 'title' => ''],
'Content' => ['description' => 'The summary content.', 'type' => 'string', 'example' => '5', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '[]',
'title' => '',
],
'SequenceId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => 'fd279983-93b9-b13b-9a34-64e5df473225', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '[]',
'title' => '',
],
'Contact' => [
'description' => 'The contact information.',
'type' => 'object',
'properties' => [
'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '1351****8888', 'title' => ''],
'State' => ['description' => 'The contact state. This parameter is deprecated.', 'type' => 'string', 'example' => 'Available', 'title' => ''],
'ContactId' => ['description' => 'The contact ID. This value is generated by the system.', 'type' => 'string', 'example' => 'db3db762-e421-44c9-9a01-cb423470757c', 'title' => ''],
'Honorific' => ['description' => 'The honorific of the contact. This value is the same as the contact name.', 'type' => 'string', 'example' => '张先生', 'title' => ''],
'JobId' => ['description' => 'The job ID. This parameter is deprecated.', 'type' => 'string', 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', 'title' => ''],
'ContactName' => ['description' => 'The contact name.', 'type' => 'string', 'example' => '张三', 'title' => ''],
'Role' => ['description' => 'The contact role. This parameter is deprecated.', 'type' => 'string', 'example' => '*', 'title' => ''],
'ReferenceId' => ['description' => 'The business system ID of the contact.'."\n"
."\n"
.'> This value is custom-uploaded by the customer through the ContactId parameter.', 'type' => 'string', 'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34', 'title' => ''],
],
'example' => '{}',
'title' => '',
],
'HangUpDirection' => ['description' => 'The party that hung up. Valid values:'."\n"
.'- client: the customer.'."\n"
.'- ivr: the robot.', 'type' => 'string', 'example' => 'client', 'title' => ''],
'RingingDuration' => ['description' => 'The ringing duration.', 'type' => 'integer', 'format' => 'int64', 'example' => '25', 'title' => ''],
'SipCode' => ['description' => 'The SIP status code of the call task.', 'type' => 'string', 'example' => '200', 'title' => ''],
'RealRingingDuration' => ['description' => 'The actual ringing duration.', 'type' => 'integer', 'format' => 'int64', 'example' => '25', 'title' => ''],
'SipDuration' => ['description' => 'The SIP signaling duration. This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'example' => '25', 'title' => ''],
'TotalDuration' => ['type' => 'integer', 'format' => 'int64', 'example' => '10', 'description' => '', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '[]',
'title' => '',
],
'CallingNumbers' => [
'description' => 'The list of calling numbers.',
'type' => 'array',
'items' => ['description' => 'The calling number.', 'type' => 'string', 'example' => '["0571****3106"]', 'title' => ''],
'example' => '["057126883106"]',
'title' => '',
],
'Script' => [
'description' => 'The script scenario.',
'type' => 'object',
'properties' => [
'Status' => [
'description' => 'The status.',
'enumValueTitles' => [
'IMPORT_FAILED' => 'Import failed.', 'PUBLISHED' => 'Published.', 'EXAMINE_IN_PROGRESS' => 'Pending review.', 'IMPORT_IN_PROGRESS' => 'Importing.', 'ROLLBACK_IN_PROGRESS' => 'Rolling back.', 'PUBLISH_IN_PROGRESS' => 'Publishing.', 'DRAFTED' => 'Draft.', 'INITIALIZE_IN_PROGRESS' => 'Initializing.', 'ROLLBACK_FAILED' => 'Rollback failed.', 'PUBLISH_FAILED' => 'Publish failed.',
'PUBLISHED_AND_EXAMINE_IN_PROGRESS' => 'Published and pending review.',
],
'type' => 'string',
'example' => 'DRAFTED',
'title' => '',
],
'UpdateTime' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578881227000', 'title' => ''],
'ChatbotId' => ['description' => 'The chatbot ID.', 'type' => 'string', 'example' => 'chatbot-cn-EJfqqa***', 'title' => ''],
'ScriptId' => ['description' => 'The script ID.', 'type' => 'string', 'example' => '810b5872-57f0-4b27-80ab-7b3f4d8a6374', 'title' => ''],
'IsDebugDrafted' => ['description' => 'Indicates whether the debug version is in draft state.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Industry' => ['description' => 'The industry.', 'type' => 'string', 'example' => '金融', 'title' => ''],
'ScriptDescription' => ['description' => 'The script description.', 'type' => 'string', 'example' => '催收话术', 'title' => ''],
'MiniPlaybackConfigEnabled' => ['description' => 'Specifies whether the tone bridging feature is enabled. This parameter is not returned. This parameter is deprecated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'IsDrafted' => ['description' => 'Indicates whether the script is in draft state.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'TtsConfig' => ['description' => 'The TTS configuration of the script. This parameter is deprecated.', 'type' => 'string', 'example' => '{\\"voice\\":\\"xiaobei\\",\\"volume\\":\\"50\\",\\"speechRate\\":\\"-150\\",\\"pitchRate\\":\\"0\\"}', 'title' => ''],
'DebugStatus' => ['description' => 'The debug status.', 'type' => 'string', 'example' => 'DRAFTED', 'title' => ''],
'AsrConfig' => ['description' => 'The ASR configuration of the script. This parameter is deprecated.', 'type' => 'string', 'example' => '{\\"AppKey\\":\\"3GHttnsvir1FeWWb\\"}', 'title' => ''],
'Scene' => ['description' => 'The scene.', 'type' => 'string', 'example' => '催收', 'title' => ''],
'Name' => ['description' => 'The 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' => ''],
],
],
'title' => 'Return conversation data of a job',
'summary' => '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'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'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 \\"TotalDuration\\": 10\\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"}]',
],
'DescribeJobDataParsingTaskProgress' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94070',
'abilityTreeNodes' => ['FEATUREoutboundbot7ZIYMY'],
],
'parameters' => [
[
'name' => 'JobDataParsingTaskId',
'in' => 'query',
'schema' => ['description' => 'The job data analytics node ID.'."\n"
."\n"
.'> This parameter value is obtained from the CreateJobDataParsingTask operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '50d5e164-9365-4261-980e-3d979c2c948c', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c209abb3-6804-4a75-b2c7-dd55c8c61b6a', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Progress' => [
'description' => 'The progress information.',
'type' => 'object',
'properties' => [
'FailErrorCode' => ['description' => 'The error code for the failure.', 'type' => 'string', 'example' => 'Permission.JobStatus', 'title' => ''],
'Status' => ['description' => 'The job status. Valid values:'."\n"
.'- Pending: pending.'."\n"
.'- InProgress: in progress.'."\n"
.'- Finished: finished.'."\n"
.'- PartialFinished: partially finished.'."\n"
.'- Failed: failed.', 'type' => 'string', 'example' => 'Pending', 'title' => ''],
'HandledJobCount' => ['description' => 'The number of jobs being processed.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'TotalJobCount' => ['description' => 'The total number of jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'FailReason' => ['description' => 'The failure reason.', 'type' => 'string', 'example' => 'CreateCorpus', 'title' => ''],
'FeedbackUrl' => ['description' => 'The download URL of the parsing failure record file. [Deprecated]', 'type' => 'string', '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' => ''],
],
],
'title' => 'Return progress information of a job',
'summary' => 'Retrieves the parsing progress of an uploaded job file.',
'changeSet' => [
['createdAt' => '2022-01-12T12:20:58.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeJobDataParsingTaskProgress',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'DescribeJobGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94071',
'abilityTreeNodes' => ['FEATUREoutboundbot7ZIYMY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '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' => '46a9ad0c-3e11-44da-a9a7-2c21bf5ce185', 'title' => ''],
],
[
'name' => 'BriefTypes',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'Filter condition. This parameter is deprecated.',
'items' => ['description' => 'Filter condition. Business result.', 'type' => 'string', 'required' => false, 'example' => '回访成功', 'title' => ''],
'maxItems' => 99,
'required' => false,
'type' => 'array',
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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' => ''],
'JobGroup' => [
'description' => 'Job information.',
'properties' => [
'CreationTime' => ['description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578881227404', 'title' => ''],
'Status' => ['description' => 'Job status.', 'type' => 'string', 'example' => 'Completed', 'title' => ''],
'JobGroupName' => ['description' => 'Job group name.', 'type' => 'string', 'example' => '催收作业组', 'title' => ''],
'ScriptId' => ['description' => 'Script scenario ID.', 'type' => 'string', 'example' => '49f00b0d-78ac-4d51-91de-a9e8e92b8470', 'title' => ''],
'JobGroupId' => ['description' => 'Job group ID.', 'type' => 'string', 'example' => '46a9ad0c-3e11-44da-a9a7-2c21bf5ce185', 'title' => ''],
'ScenarioId' => ['description' => 'Scenario ID. This is a legacy canvas parameter. For new canvases, this value is the same as ScriptId.', 'type' => 'string', 'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8', 'title' => ''],
'JobFilePath' => ['description' => 'OSS file key for the uploaded job list. This parameter is deprecated.', 'type' => 'string', 'example' => 'da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx', 'title' => ''],
'JobGroupDescription' => ['description' => 'Job description.', 'type' => 'string', 'example' => '催收作业组', 'title' => ''],
'JobDataParsingTaskId' => ['description' => 'Job list parsing task ID. This parameter is deprecated.', 'type' => 'string', 'example' => 'da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx', 'title' => ''],
'ScriptName' => ['description' => 'Script scenario name.', 'type' => 'string', 'example' => '催收话术', 'title' => ''],
'ModifyTime' => ['description' => 'Modification time.', 'type' => 'string', 'example' => '1578881227404', 'title' => ''],
'ScriptVersion' => ['description' => 'Script scenario version number.', 'type' => 'string', 'example' => '49f00b0d-78ac-4d51-91de-a9e8e92b8470', 'title' => ''],
'CallingNumbers' => [
'description' => 'Caller number list.',
'items' => ['description' => 'Caller number list.', 'type' => 'string', 'example' => '["1****6"]', 'title' => ''],
'type' => 'array',
'title' => '',
'example' => '',
],
'ExportProgress' => [
'description' => 'Export progress. This field is deprecated.'."\n"
."\n"
.'> Get this information from the ListJobGroups API instead.',
'properties' => [
'Status' => ['description' => 'Export status. This field is deprecated.', 'type' => 'string', 'example' => 'FINISHED', 'title' => ''],
'FileHttpUrl' => ['description' => 'File URL. This field is deprecated.', 'type' => 'string', 'example' => 'https://oss-cn-shanghai.aliyuncs.com/xx.zip', 'title' => ''],
'Progress' => ['description' => 'Export progress. This field is deprecated.', 'type' => 'string', 'example' => '1', 'title' => ''],
],
'type' => 'object',
'title' => '',
'example' => '',
],
'Progress' => [
'description' => 'Job progress.',
'properties' => [
'TotalNotAnswered' => ['description' => 'This field is deprecated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Status' => ['description' => 'Overall job execution status. This field is deprecated.', 'type' => 'string', 'example' => 'Executing', 'title' => ''],
'StartTime' => ['description' => 'Start time of execution. This field is deprecated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578881227404', 'title' => ''],
'Failed' => ['description' => 'Number of failed jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Executing' => ['description' => 'Number of jobs in execution.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'TotalJobs' => ['description' => 'Total number of jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCompleted' => ['description' => 'Total number of completed jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'Duration' => ['description' => 'Job execution time. This field is deprecated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''],
'Scheduling' => ['description' => 'Number of jobs being scheduled.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'Paused' => ['description' => 'Number of paused jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Cancelled' => ['description' => 'Number of cancelled jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'Briefs' => [
'description' => 'Business result information. This field is deprecated.',
'items' => [
'properties' => [
'Key' => ['description' => 'Business result name.', 'type' => 'string', 'example' => 'score', 'title' => ''],
'Value' => ['description' => 'Business result value.', 'type' => 'string', 'example' => '5', 'title' => ''],
],
'type' => 'object',
'description' => '',
'title' => '',
'example' => '',
],
'type' => 'array',
'title' => '',
'example' => '',
],
'Categories' => [
'description' => 'Statistics in key-value format. This field is deprecated.',
'items' => [
'properties' => [
'Key' => ['description' => 'Custom statistics field name.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Value' => ['description' => 'Custom statistics value.', 'type' => 'string', 'example' => '10', 'title' => ''],
],
'type' => 'object',
'description' => '',
'title' => '',
'example' => '',
],
'type' => 'array',
'title' => '',
'example' => '',
],
],
'type' => 'object',
'title' => '',
'example' => '',
],
'Strategy' => [
'description' => 'Job execution strategy.',
'properties' => [
'Type' => ['description' => 'Strategy type.', 'type' => 'string', 'example' => 'Repeatable', 'title' => ''],
'StrategyName' => ['description' => 'Strategy name.', 'type' => 'string', 'example' => '催收策略名字', 'title' => ''],
'MaxAttemptsPerDay' => ['description' => 'Maximum number of calls per day when the call is not answered.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'FollowUpStrategy' => ['description' => 'Action to take after the execution period ends. This is a legacy parameter and is no longer used.', 'type' => 'string', 'example' => 'NONE', 'title' => ''],
'EndTime' => ['description' => 'End time of the scheduling strategy.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579881227404', 'title' => ''],
'Customized' => ['description' => 'Custom data for the strategy. This is a legacy parameter and is no longer used.', 'type' => 'string', 'example' => '{}', 'title' => ''],
'IsTemplate' => ['description' => 'Indicates whether this is a template.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'StartTime' => ['description' => 'Start time of the strategy.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578881227404', 'title' => ''],
'StrategyId' => ['description' => 'Strategy ID.', 'type' => 'string', 'example' => 'a2bff22c-2604-4df2-83d6-5952e2438c5a', 'title' => ''],
'RoutingStrategy' => ['description' => 'Phone number routing policy.', 'type' => 'string', 'example' => 'LocalFirst', 'title' => ''],
'MinAttemptInterval' => ['description' => 'Minimum interval between retry attempts.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'StrategyDescription' => ['description' => 'Strategy description.', 'type' => 'string', 'example' => '催收策略', 'title' => ''],
'RepeatBy' => ['description' => 'Job repetition method.', 'type' => 'string', 'example' => 'Once', 'title' => ''],
'WorkingTime' => [
'description' => 'Working hours.',
'items' => [
'properties' => [
'EndTime' => ['description' => 'End time.', 'type' => 'string', 'example' => '12:00:00', 'title' => ''],
'BeginTime' => ['description' => 'End time', 'type' => 'string', 'example' => '09:00:00', 'title' => ''],
],
'type' => 'object',
'description' => '',
'title' => '',
'example' => '',
],
'type' => 'array',
'title' => '',
'example' => '',
],
'RepeatDays' => [
'description' => 'Days on which the job repeats. Use with RepeatBy.'."\n"
."\n"
.'- If the recurrence is weekly, 0 means Sunday, and 1–6 mean Monday through Saturday.'."\n"
."\n"
.'- If the recurrence is monthly, 1–31 mean the 1st through 31st days of the month. Months without the specified day skip the job. For example, if you select the 30th, February skips it.',
'items' => ['description' => 'Day on which the job repeats.', 'type' => 'string', 'example' => '[1,2,3,4,5]', 'title' => ''],
'type' => 'array',
'title' => '',
'example' => '',
],
'Repeatable' => ['description' => 'Indicates whether this is a recurring job.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
'type' => 'object',
'title' => '',
'example' => '',
],
'RecallStrategy' => [
'description' => 'Redial strategy.',
'properties' => [
'EmptyNumberIgnore' => ['description' => 'Do not dial nonexistent numbers.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'InArrearsIgnore' => ['description' => 'Do not dial numbers with overdue payments.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'OutOfServiceIgnore' => ['description' => 'Do not dial out-of-service numbers.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
'type' => 'object',
'title' => '',
'example' => '',
],
'Result' => [
'description' => 'Statistics. This is a legacy parameter and is no longer provided. This field is deprecated.',
'properties' => [
'TimeoutHangupNum' => ['description' => 'Number of calls hung up due to timeout. This field is deprecated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'FinishedNum' => ['description' => 'Number of completed jobs. This field is deprecated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'NoInteractNum' => ['description' => 'Number of calls with no interaction. This field is deprecated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'ClientHangupNum' => ['description' => 'Number of calls hung up by the customer. This field is deprecated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'UnrecognizedNum' => ['description' => 'Number of unrecognized responses. This field is deprecated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'type' => 'object',
'title' => '',
'example' => '',
],
'RingingDuration' => ['description' => 'Ringing duration.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
'Priority' => ['description' => 'Priority.', 'type' => 'string', 'example' => '1', 'title' => ''],
'MinConcurrency' => ['description' => 'Minimum concurrency.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'FlashSmsExtras' => [
'description' => 'Configuration parameters for flash SMS delivery. This is a JSON object that contains third-party flash SMS configuration details.',
'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' => 'Caller number list for redials. These numbers are used only when the first call fails. If not specified, the system uses the main caller number list.',
'type' => 'array',
'items' => ['description' => 'Caller number list for redials.', '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' => ''],
],
],
'title' => 'Query outbound call task group',
'summary' => 'Retrieves data for intelligent outbound call job groups.',
'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'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetJobGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'DescribeJobGroupExportTaskProgress' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '94072',
'abilityTreeNodes' => ['FEATUREoutboundbot7ZIYMY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'b3dbfb82-1ae6-4e73-b717-f494727d2af3', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'FileHttpUrl' => ['description' => 'The file URL.', 'type' => 'string', 'example' => 'http://xxx.xx.com/xx', 'title' => ''],
'Progress' => ['description' => 'The export progress.', 'type' => 'number', 'format' => 'float', 'example' => '45.0', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The 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 task. This operation is deprecated. Use ListDownloadTasks instead.',
'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 call 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 details',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'Script status', 'type' => 'string', 'example' => 'DRAFTED', 'title' => ''],
'UpdateTime' => ['description' => 'Time when the script was last updated', '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' => 'Enables tone continuity', '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' => 'Status of the debug 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' => 'Enables graceful barge-in', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'LongWaitEnable' => ['description' => 'Enables intelligent sentence break', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'EmotionEnable' => ['description' => 'Enables emotion detection', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'AgentId' => ['description' => 'Robot workspace access key', 'type' => 'integer', 'format' => 'int64', 'example' => '1218333', 'title' => ''],
'AgentKey' => ['description' => 'Robot workspace access key', 'type' => 'string', 'example' => '14791f5f226b4878b3d9b676a0291234', 'title' => ''],
'AgentLlm' => ['description' => 'Indicates whether the robot workspace uses a Large Language Model (LLM)', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ChatConfig' => ['description' => 'Call 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 (applies only to LLM scenarios)'."\n"
."\n"
.'- Prompts — Text entry mode'."\n"
."\n"
.'- SSE\\_FUNCTION — Function Compute service mode', 'type' => 'string', 'example' => 'Prompts', 'title' => ''],
'NluProfile' => [
'description' => 'Function Compute service mode 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', 'title' => ''],
'FcHttpTriggerUrl' => ['description' => 'Function service trigger URL', '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' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The ID of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0fe7f71c-8771-42ef-9bb1-19aa16ae7120', 'title' => ''],
],
[
'name' => 'ScriptVoiceConfigId',
'in' => 'query',
'schema' => ['description' => 'The ID of the script voice configuration.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2a07b634-e15d-445f-bbcb-fc4ea2df7b87', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ScriptVoiceConfig' => [
'description' => 'The details of the script voice configuration.',
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The type of the voice configuration. Valid values:'."\n"
."\n"
.'- `WAVEFORM`: A recording.'."\n"
."\n"
.'- `TTS`: Text-to-speech.', 'type' => 'string', 'example' => 'TTS', 'title' => ''],
'ScriptVoiceConfigId' => ['description' => 'The ID of the script voice configuration.', 'type' => 'string', 'example' => '2a07b634-e15d-445f-bbcb-fc4ea2df7b87', 'title' => ''],
'ScriptContent' => ['description' => 'The script content.', 'type' => 'string', 'example' => '你的花呗欠款逾期了需要处理,你现在能处理一下吗?', 'title' => ''],
'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => '291cfc6a-8703-4bdd-a99d-9cba32d5288a', 'title' => ''],
'ScriptId' => ['description' => 'The ID of the script.', 'type' => 'string', 'example' => '947e0875-b5d4-4b33-b18c-7b2cf85bcb4f', 'title' => ''],
'ScriptWaveformRelation' => ['description' => 'The script waveform relation data. Returned 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' => 'The source of the script.', 'type' => 'string', 'example' => 'DIALOGUE_FLOW', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => 'The data returned.',
'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' => 'Describes the voice configuration of a script created in the legacy canvas.',
'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', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0ec0c897-b92c-40e4-9ad7-e6e4f5ce13bb', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'Script ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd7fbd0a0-27bc-49c4-a456-ecb75e79122b', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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' => 'f765d3ee-ec03-4765-b235-6877501d99d1', 'title' => ''],
'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'TTSConfig' => [
'description' => 'TTS configuration',
'properties' => [
'Voice' => ['description' => 'TTS model', 'type' => 'string', 'example' => 'xiaoyun', 'title' => ''],
'SpeechRate' => ['description' => 'Speech rate', 'type' => 'string', 'example' => '-150', 'title' => ''],
'Volume' => ['description' => 'Volume', 'type' => 'string', 'example' => '100', 'title' => ''],
'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'example' => '947e0875-b5d4-4b33-b18c-7b2cf85bcb4f', 'title' => ''],
'NlsServiceType' => ['description' => 'Service type', 'type' => 'string', 'example' => 'Managed', 'title' => ''],
'AppKey' => ['description' => 'AppKey for invoking TTS', 'type' => 'string', '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 the text-to-speech (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' => [
'summary' => 'TTS preview.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREoutboundbotW09IDV'],
],
'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' => 'Script ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '5ab2d935-306c-478a-88bf-d08e4e25c1b7', 'title' => ''],
],
[
'name' => 'Voice',
'in' => 'query',
'schema' => ['description' => 'Voice information, such as aixia, siyue, or xiaoyun. For the complete list of available voices, refer to the voice list below.'."\n"
."\n"
.'> Because the Voice value of a cloned voice is a unique, non-fixed value generated during voice cloning, the specific Voice value cannot be provided at this stage. You must obtain the specific VoiceID from the voice cloning page by calling the ListVoiceClone API.', '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, 500]. Default value: 0.'."\n"
."\n"
.'A value greater than 0 indicates a faster speech rate.'."\n"
."\n"
.'A value less than 0 indicates a slower 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: 50.'."\n"
."\n"
.'A value greater than 50 indicates a higher volume.'."\n"
."\n"
.'A value less than 50 indicates a lower 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: 0.'."\n"
."\n"
.'A value greater than 0 indicates a higher pitch.'."\n"
."\n"
.'A value less than 0 indicates a lower pitch.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'Voice service type.'."\n"
."\n"
.'- When using **ali** as the custom service, this field stores the appKey of the Intelligent Speech Interaction product project.'."\n"
."\n"
.'- When using **xunfei** 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' => 'The AccessKey Secret (SK) for this namespace.'."\n"
."\n"
.'> When the engine is set to xunfei, you must enter the SK.', 'type' => 'string', 'required' => false, 'example' => 'OTdhNDE3Z********zQ****', 'title' => ''],
],
[
'name' => 'AccessKey',
'in' => 'query',
'schema' => ['description' => 'The AccessKey (AK) for this namespace.'."\n"
.'> When the engine is set to xunfei, you must enter the AK.', 'type' => 'string', 'required' => false, 'example' => '5d0f37**********ef56db601****', 'title' => ''],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => [
'description' => 'Storage engine. Valid values: ali, volc, and xunfei.'."\n"
."\n"
.'- When using the default service or selecting Alibaba Cloud as the custom service, set this parameter to **ali**.'."\n"
."\n"
.'- When using the Doubao service, set this parameter to **volc**.'."\n"
.'- When using xunfei as the service provider, set this parameter to **xunfei**. This value can only be used in small model scenarios.',
'enumValueTitles' => ['xunfei' => 'xunfei', 'volc' => 'volc', 'ali' => 'ali'],
'type' => 'string',
'required' => false,
'example' => 'ali',
'title' => '',
],
],
[
'name' => 'NlsServiceType',
'in' => 'query',
'schema' => ['description' => 'Service type.'."\n"
.'Managed: The default Intelligent Speech Interaction product service of the Outbound Bot product (public service).'."\n"
.'Authorized: The Intelligent Speech Interaction product service purchased by the public cloud customer (customer\'s private service), authorized through Script Management > Edit > Call Service > Custom Service.'."\n"
."\n"
.'> When using Alibaba Cloud Intelligent Speech Interaction, that is, when using Alibaba Cloud as the custom service provider, set this parameter to Authorized.', 'type' => 'string', 'required' => false, 'example' => 'Authorized', 'title' => ''],
],
[
'name' => 'AliCustomizedVoice',
'in' => 'query',
'schema' => ['description' => 'Alibaba Cloud customized voice, which is the voice call ID.', 'type' => 'string', 'required' => false, 'example' => 'voice-e1be3a6', 'title' => ''],
],
[
'name' => 'ExtParams',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', '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 request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'API response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'AuditionUrl' => ['description' => 'URL of the preview audio file.', '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 Preview',
'requestParamsDescription' => ''."\n"
.'TTS Default Service Voices
'."\n"
."\n"
.'- Large Model Voices:'."\n"
.' - CV-v3-flash:龙安洋:cosyvoice-v3-flash:longanyang'."\n"
.' - CV-v3-flash:龙安欢:cosyvoice-v3-flash:longanhuan'."\n"
.' - CV-v3-flash:龙呼呼:cosyvoice-v3-flash:longhuhu_v3'."\n"
.' - CV-v3-flash:龙嘉怡:cosyvoice-v3-flash:longjiayi_v3'."\n"
.' - CV-v3-flash:龙安粤:cosyvoice-v3-flash:longanyue_v3'."\n"
.' - CV-v3-flash:龙老铁:cosyvoice-v3-flash:longlaotie_v3'."\n"
.' - CV-v3-flash:龙陕哥:cosyvoice-v3-flash:longshange_v3'."\n"
.' - CV-v3-flash:龙安闽:cosyvoice-v3-flash:longanmin_v3'."\n"
.' - CV-v3-flash:loongkyong:cosyvoice-v3-flash:loongkyong_v3'."\n"
.' - CV-v3-flash:loongtomoka:cosyvoice-v3-flash:loongtomoka_v3'."\n"
.' - CV-v3-flash:龙飞:cosyvoice-v3-flash:longfei_v3'."\n"
.' - CV-v3-flash:龙应笑:cosyvoice-v3-flash:longyingxiao_v3'."\n"
.' - CV-v3-flash:龙应询:cosyvoice-v3-flash:longyingxun_v3'."\n"
.' - CV-v3-flash:龙应静:cosyvoice-v3-flash:longyingjing_v3'."\n"
.' - CV-v3-flash:龙应聆:cosyvoice-v3-flash:longyingling_v3'."\n"
.' - CV-v3-flash:龙应桃:cosyvoice-v3-flash:longyingtao_v3'."\n"
.' - CV-v3-flash:龙小淳:cosyvoice-v3-flash:longxiaochun_v3'."\n"
.' - CV-v3-flash:龙小夏:cosyvoice-v3-flash:longxiaoxia_v3'."\n"
.' - CV-v3-flash:YUMI:cosyvoice-v3-flash:longyumi_v3'."\n"
.' - CV-v3-flash:龙安昀:cosyvoice-v3-flash:longanyun_v3'."\n"
.' - CV-v3-flash:龙安温:cosyvoice-v3-flash:longanwen_v3'."\n"
.' - CV-v3-flash:龙安莉:cosyvoice-v3-flash:longanli_v3'."\n"
.' - CV-v3-flash:龙安朗:cosyvoice-v3-flash:longanlang_v3'."\n"
.' - CV-v3-flash:龙应沐:cosyvoice-v3-flash:longyingmu_v3'."\n"
.' - CV-v3-flash:龙橙:cosyvoice-v3-flash:longcheng_v3'."\n"
.' - CV-v3-flash:龙泽:cosyvoice-v3-flash:longze_v3'."\n"
.' - CV-v3-flash:龙哲:cosyvoice-v3-flash:longzhe_v3'."\n"
.' - CV-v3-flash:龙颜:cosyvoice-v3-flash:longyan_v3'."\n"
.' - CV-v3-flash:龙星:cosyvoice-v3-flash:longxing_v3'."\n"
.' - CV-v3-flash:龙天:cosyvoice-v3-flash:longtian_v3'."\n"
.' - CV-v3-flash:龙婉:cosyvoice-v3-flash:longwan_v3'."\n"
.' - CV-v3-flash:龙嫱:cosyvoice-v3-flash:longqiang_v3'."\n"
.' - CV-v3-flash:龙菲菲:cosyvoice-v3-flash:longfeifei_v3'."\n"
.' - CV-v3-flash:龙浩:cosyvoice-v3-flash:longhao_v3'."\n"
.' - CV-v3-flash:龙安柔:cosyvoice-v3-flash:longanrou_v3'."\n"
.' - CV-v3-flash:龙寒:cosyvoice-v3-flash:longhan_v3'."\n"
.' - CV-v3-flash:龙安智:cosyvoice-v3-flash:longanzhi_v3'."\n"
.' - CV-v3-flash:龙安灵:cosyvoice-v3-flash:longanling_v3'."\n"
.' - CV-v3-flash:龙安雅:cosyvoice-v3-flash:longanya_v3'."\n"
.' - CV-v3-flash:龙安亲:cosyvoice-v3-flash:longanqin_v3'."\n"
.' - CV-v3-flash:龙三叔:cosyvoice-v3-flash:longsanshu_v3'."\n"
.' - CV-v3-flash:龙媛:cosyvoice-v3-flash:longyuan_v3'."\n"
.' - CV-v3-flash:龙悦:cosyvoice-v3-flash:longyue_v3'."\n"
.' - CV-v3-flash:龙修:cosyvoice-v3-flash:longxiu_v3'."\n"
.' - CV-v3-flash:龙楠:cosyvoice-v3-flash:longnan_v3'."\n"
.' - CV-v3-flash:龙婉君:cosyvoice-v3-flash:longwanjun_v3'."\n"
.' - CV-v3-flash:龙逸尘:cosyvoice-v3-flash:longyichen_v3'."\n"
.' - CV-v3-flash:龙老伯:cosyvoice-v3-flash:longlaobo_v3'."\n"
.' - CV-v3-flash:龙老姨:cosyvoice-v3-flash:longlaoyi_v3'."\n"
.' - CV-v3-flash:龙机器:cosyvoice-v3-flash:longjiqi_v3'."\n"
.' - CV-v3-flash:龙猴哥:cosyvoice-v3-flash:longhouge_v3'."\n"
.' - CV-v3-flash:龙黛玉:cosyvoice-v3-flash:longdaiyu_v3'."\n"
.' - CV-v3-flash:龙安宣:cosyvoice-v3-flash:longanxuan_v3'."\n"
.' - CV-v3-flash:龙书:cosyvoice-v3-flash:longshu_v3'."\n"
.' - CV-v3-flash:Bella3.0:cosyvoice-v3-flash:loongbella_v3'."\n"
.' - CV-v3-plus:龙安洋:cosyvoice-v3-plus:longanyang'."\n"
.' - CV-v3-plus:龙安欢:cosyvoice-v3-plus:longanhuan'."\n"
.' - CosyVoice:龙橙:CosyVoice:longcheng'."\n"
.' - CosyVoice:龙橙v2:CosyVoice:longcheng_v2'."\n"
.' - CosyVoice:龙哲:CosyVoice:longzhe'."\n"
.' - CosyVoice:龙楠:CosyVoice:longnan'."\n"
.' - CosyVoice:龙颜:CosyVoice:longyan'."\n"
.' - CosyVoice:龙嫱:CosyVoice:longqiang'."\n"
.' - CosyVoice:龙华:CosyVoice:longhua'."\n"
.' - CosyVoice:龙华v2:CosyVoice:longhua_v2'."\n"
.' - CosyVoice:龙星:CosyVoice:longxing'."\n"
.' - CosyVoice:龙津:CosyVoice:longjin'."\n"
.' - CosyVoice:龙寒:CosyVoice:longhan'."\n"
.' - CosyVoice:龙天:CosyVoice:longtian'."\n"
.' - CosyVoice:龙婉v2:CosyVoice:longwan_v2'."\n"
.' - CosyVoice:龙书:CosyVoice:longshuo'."\n"
.' - CosyVoice:Stella2.0:CosyVoice:loongstella'."\n"
.' - CosyVoice:龙小诚:CosyVoice:longxiaocheng'."\n"
.' - CosyVoice:龙小夏:CosyVoice:longxiaoxia'."\n"
.' - CosyVoice:龙小夏v2:CosyVoice:longxiaoxia_v2p1'."\n"
.' - CosyVoice:龙小淳:CosyVoice:longxiaochun'."\n"
.' - CosyVoice:龙小淳v2:CosyVoice:longxiaochun_v2'."\n"
.' - CosyVoice:龙小白:CosyVoice:longxiaobai'."\n"
.' - CosyVoice:龙老铁:CosyVoice:longlaotie'."\n"
.' - CosyVoice:龙悦:CosyVoice:longyue'."\n"
.' - CosyVoice:Bella2.0:CosyVoice:loongbella'."\n"
.' - CosyVoice:Bella2.0v2:CosyVoice:loongbella_v2'."\n"
.' - CosyVoice:龙媛:CosyVoice:longyuan'."\n"
.' - CosyVoice:龙书:CosyVoice:longshu'."\n"
.' - CosyVoice:龙书v2:CosyVoice:longshu_v2'."\n"
.' - CosyVoice:龙婧:CosyVoice:longjing'."\n"
.' - CosyVoice:龙妙:CosyVoice:longmiao'."\n"
.' - CosyVoice:龙应淘:CosyVoice:longyingtao'."\n"
.' - CosyVoice:龙应催:cosyvoice-v2:longyingcui'."\n"
."\n"
.'- Tongyi Qianwen Voices:'."\n"
.' - 芊悦:qwen3-tts-flash-realtime:Cherry'."\n"
.' - 晨煦:qwen3-tts-flash-realtime:Ethan'."\n"
.' - 不吃鱼:qwen3-tts-flash-realtime:Nofish'."\n"
.' - 詹妮弗:qwen3-tts-flash-realtime:Jennifer'."\n"
.' - 甜茶:qwen3-tts-flash-realtime:Ryan'."\n"
.' - 卡捷琳娜:qwen3-tts-flash-realtime:Katerina'."\n"
.' - 墨讲师:qwen3-tts-flash-realtime:Elias'."\n"
.' - 上海-阿珍:qwen3-tts-flash-realtime:Jada'."\n"
.' - 北京-晓东:qwen3-tts-flash-realtime:Dylan'."\n"
.' - 四川-晴儿:qwen3-tts-flash-realtime:Sunny'."\n"
.' - 南京-老李:qwen3-tts-flash-realtime:Li'."\n"
.' - 陕西-秦川:qwen3-tts-flash-realtime:Marcus'."\n"
.' - 闽南-阿杰:qwen3-tts-flash-realtime:Roy'."\n"
.' - 天津-李彼得:qwen3-tts-flash-realtime:Peter'."\n"
.' - 粤语-阿强:qwen3-tts-flash-realtime:Rocky'."\n"
.' - 粤语-阿清:qwen3-tts-flash-realtime:Kiki'."\n"
.' - 四川-程川:qwen3-tts-flash-realtime:Eric'."\n"
.' - 苏瑶:qwen3-tts-flash-realtime:Serena'."\n"
.' - 千雪:qwen3-tts-flash-realtime:Chelsie'."\n"
.' - 茉兔:qwen3-tts-flash-realtime:Momo'."\n"
.' - 十三:qwen3-tts-flash-realtime:Vivian'."\n"
.' - 月白:qwen3-tts-flash-realtime:Moon'."\n"
.' - 四月:qwen3-tts-flash-realtime:Maia'."\n"
.' - 凯:qwen3-tts-flash-realtime:Kai'."\n"
.' - 萌宝:qwen3-tts-flash-realtime:Bella'."\n"
.' - 艾登:qwen3-tts-flash-realtime:Aiden'."\n"
.' - 沧明子:qwen3-tts-flash-realtime:Eldric Sage'."\n"
.' - 乖小妹:qwen3-tts-flash-realtime:Mia'."\n"
.' - 沙小弥:qwen3-tts-flash-realtime:Mochi'."\n"
.' - 燕铮莺:qwen3-tts-flash-realtime:Bellona'."\n"
.' - 田叔:qwen3-tts-flash-realtime:Vincent'."\n"
.' - 萌小姬:qwen3-tts-flash-realtime:Bunny'."\n"
.' - 阿闻:qwen3-tts-flash-realtime:Neil'."\n"
.' - 徐大爷:qwen3-tts-flash-realtime:Arthur'."\n"
.' - 邻家妹妹:qwen3-tts-flash-realtime:Nini'."\n"
.' - 诡婆婆:qwen3-tts-flash-realtime:Ebona'."\n"
.' - 小婉:qwen3-tts-flash-realtime:Seren'."\n"
.' - 顽屁小孩:qwen3-tts-flash-realtime:Pip'."\n"
.' - 少女阿月:qwen3-tts-flash-realtime:Stella'."\n"
.' - 博德加:qwen3-tts-flash-realtime:Bodega'."\n"
.' - 索尼莎:qwen3-tts-flash-realtime:Sonrisa'."\n"
.' - 阿列克:qwen3-tts-flash-realtime:Alek'."\n"
.' - 多尔切:qwen3-tts-flash-realtime:Dolce'."\n"
.' - 素熙:qwen3-tts-flash-realtime:Sohee'."\n"
.' - 小野杏:qwen3-tts-flash-realtime:Ono Anna'."\n"
.' - 莱恩:qwen3-tts-flash-realtime:Lenn'."\n"
.' - 埃米尔安:qwen3-tts-flash-realtime:Emilien'."\n"
.' - 安德雷:qwen3-tts-flash-realtime:Andre'."\n"
.' - 拉迪奥·戈尔:qwen3-tts-flash-realtime:Radio Gol'."\n"
."\n"
.'- General:'."\n"
.' - 知媛:zhiyuan'."\n"
.' - 知悦:zhiyue'."\n"
.' - 知莎:zhistella'."\n"
.' - 知达:zhida'."\n"
.' - 艾琪:aiqi'."\n"
.' - 艾诚:aicheng'."\n"
.' - 艾佳:aijia'."\n"
.' - 思琪:siqi'."\n"
.' - 思佳:sijia'."\n"
.' - 马树:mashu'."\n"
.' - 悦儿:yuer'."\n"
.' - 若兮:ruoxi'."\n"
.' - 艾达:aida'."\n"
.' - 思诚:sicheng'."\n"
.' - 宁儿:ninger'."\n"
.' - 小云:xiaoyun'."\n"
.' - 小刚:xiaogang'."\n"
.' - 瑞琳:ruilin'."\n"
."\n"
.'- Customer Service:'."\n"
.' - 知雅:zhiya'."\n"
.' - 艾悦:aiyue'."\n"
.' - 艾雅:aiya'."\n"
.' - 艾婧:aijing'."\n"
.' - 艾美:aimei'."\n"
.' - 思悦:siyue'."\n"
.' - 艾娜:Aina'."\n"
.' - 艾硕:aishuo'."\n"
.' - 艾雨:aiyu'."\n"
.' - 小美:xiaomei'."\n"
.' - 伊娜:yina'."\n"
.' - 思婧:sijing'."\n"
."\n"
.'- Multi-emotion:'."\n"
.' - 知冰:zhibing_emo'."\n"
.' - 知锋:zhifeng_emo'."\n"
.' - 知妙_多情感:zhimiao_emo'."\n"
.' - 知米_多情感:zhimi_emo'."\n"
.' - 知贝_多情感:zhibei_emo'."\n"
.' - 知燕_多情感:zhiyan_emo'."\n"
.' - 知甜_多情感:zhitian_emo'."\n"
."\n"
.'- Digital Human:'."\n"
.' - 艾夏:aixia'."\n"
.' - 知柜:zhigui'."\n"
.' - 知硕:zhishuo'."\n"
.' - Cally:cally'."\n"
.' - 知小白:zhixiaobai'."\n"
.' - 知小夏:zhixiaoxia'."\n"
.' - 知小妹:zhixiaomei'."\n"
."\n"
.'- Multi-language:'."\n"
.' - Clara:clara'."\n"
.' - Hanna:hanna'."\n"
.' - Waan:waan'."\n"
.' - Camila:camila'."\n"
.' - Perla:perla'."\n"
.' - masha:masha'."\n"
.' - Kyong:kyong'."\n"
.' - Tien:tien'."\n"
.' - 智香:tomoka'."\n"
.' - 智也:tomoya'."\n"
.' - Indah:indah'."\n"
.' - Farah:farah'."\n"
.' - Tala:tala'."\n"
."\n"
.'- Ultra HD:'."\n"
.' - 知甜:zhitian'."\n"
.' - 知青:zhiqing'."\n"
."\n"
.'- Live Streaming:'."\n"
.' - 知猫:zhimao'."\n"
.' - 老妹:laomei'."\n"
.' - 老铁:laotie'."\n"
.' - 小仙:xiaoxian'."\n"
.' - 柜姐:guijie'."\n"
.' - Stella:stella'."\n"
.' - 猫小美:maoxiaomei'."\n"
.' - 巧薇:qiaowei'."\n"
.' - 艾伦:ailun'."\n"
.' - 艾飞:aifei'."\n"
.' - 亚群:yaqun'."\n"
.' - Stanley:stanley'."\n"
.' - Kenny:kenny'."\n"
.' - Rosa:rosa'."\n"
."\n"
.'- Children\'s Voice:'."\n"
.' - 艾彤:aitong'."\n"
.' - 艾薇:aiwei'."\n"
.' - 杰力豆:jielidou'."\n"
.' - 小北:xiaobei'."\n"
.' - 思彤:sitong'."\n"
.' - 艾宝:aibao'."\n"
."\n"
.'- Dialect:'."\n"
.' - Kelly:kelly'."\n"
.' - 佳佳:jiajia'."\n"
.' - 大虎:dahu'."\n"
.' - 艾侃:aikan'."\n"
.' - 桃子:taozi'."\n"
.' - 青青:qingqing'."\n"
.' - 翠姐:cuijie'."\n"
.' - 小泽:xiaoze'."\n"
.' - 姗姗:shanshan'."\n"
.' - 小玥:xiaoyue'."\n"
."\n"
.'- English:'."\n"
.' - Betty:betty'."\n"
.' - Beth:beth'."\n"
.' - Cindy:cindy'."\n"
.' - Donna:donna'."\n"
.' - Eva:eva'."\n"
.' - Brian:brian'."\n"
.' - ava:ava'."\n"
.' - Luca:Luca'."\n"
.' - Luna:Luna'."\n"
.' - Emily:Emily'."\n"
.' - Eric:Eric'."\n"
.' - Annie:annie'."\n"
.' - Andy:Andy'."\n"
.' - William:William'."\n"
.' - Abby:Abby'."\n"
.' - Lydia:Lydia'."\n"
.' - Olivia:Olivia'."\n"
.' - Wendy:Wendy'."\n"
.' - Harry:Harry'."\n"
."\n"
.' '."\n"
.''."\n"
.'Doubao Voices
'."\n"
."\n"
.'- Multi-emotion:'."\n"
.' - 北京小爷:zh_male_beijingxiaoye_emo_v2_mars_bigtts'."\n"
.' - 柔美女友:zh_female_roumeinvyou_emo_v2_mars_bigtts'."\n"
.' - 阳光青年:zh_male_yangguangqingnian_emo_v2_mars_bigtts'."\n"
.' - 魅力女友:zh_female_meilinvyou_emo_v2_mars_bigtts'."\n"
.' - 爽快思思:zh_female_shuangkuaisisi_emo_v2_mars_bigtts'."\n"
.'- General Scenarios:'."\n"
.' - 灿灿/Shiny:zh_female_cancan_mars_bigtts'."\n"
.' - 清新女声\':zh_female_qingxinnvsheng_mars_bigtts'."\n"
.' - 爽快思思/Skye:zh_female_shuangkuaisisi_moon_bigtts'."\n"
.' - 温暖阿虎/Alvin:zh_male_wennuanahu_moon_bigtts'."\n"
.' - 少年梓辛/Brayan:zh_male_shaonianzixin_moon_bigtts'."\n"
.' - 知性女声:zh_female_zhixingnvsheng_mars_bigtts'."\n"
.' - 清爽男大:zh_male_qingshuangnanda_mars_bigtts'."\n"
.' - 邻家女孩:zh_female_linjianvhai_moon_bigtts'."\n"
.' - 渊博小叔:zh_male_yuanboxiaoshu_moon_bigtts'."\n"
.' - 阳光青年:zh_male_yangguangqingnian_moon_bigtts'."\n"
.' - 甜美小源:zh_female_tianmeixiaoyuan_moon_bigtts'."\n"
.' - 清澈梓梓:zh_female_qingchezizi_moon_bigtts'."\n"
.' - 解说小明:zh_male_jieshuoxiaoming_moon_bigtts'."\n"
.' - 开朗姐姐:zh_female_kailangjiejie_moon_bigtts'."\n"
.' - 邻家男孩:zh_male_linjiananhai_moon_bigtts'."\n"
.' - 甜美悦悦:zh_female_tianmeiyueyue_moon_bigtts'."\n"
.' - 心灵鸡汤:zh_female_xinlingjitang_moon_bigtts'."\n"
.' - 知性温婉:ICL_zh_female_zhixingwenwan_tob'."\n"
.' - 暖心体贴:ICL_zh_male_nuanxintitie_tob'."\n"
.' - 温柔文雅:ICL_zh_female_wenrouwenya_tob'."\n"
.' - 开朗轻快:ICL_zh_male_kailangqingkuai_tob'."\n"
.' - 活泼爽朗:ICL_zh_male_huoposhuanglang_tob'."\n"
.' - 率真小伙:ICL_zh_male_shuaizhenxiaohuo_tob'."\n"
.' - 温柔小哥:zh_male_wenrouxiaoge_mars_bigtts'."\n"
.'- Multi-language:'."\n"
.' - Smith:en_male_smith_mars_bigtts'."\n"
.' - Anna:en_female_anna_mars_bigtts'."\n"
.' - Adam:en_male_adam_mars_bigtts'."\n"
.' - Sarah:en_female_sarah_mars_bigtts'."\n"
.' - Dryw:en_male_dryw_mars_bigtts'."\n"
.' - かずね(和音)/Javier or Álvaro:multi_male_jingqiangkanye_moon_bigtts'."\n"
.' - はるこ(晴子)/Esmeralda:multi_female_shuangkuaisisi_moon_bigtts'."\n"
.' - ひろし(広志)/Roberto:multi_male_wanqudashu_moon_bigtts'."\n"
.' - あけみ(朱美):multi_female_gaolengyujie_moon_bigtts'."\n"
.' - Amanda:en_female_amanda_mars_bigtts'."\n"
.' - Jackson:en_male_jackson_mars_bigtts'."\n"
.'- Fun Accents:'."\n"
.' - 京腔侃爷 / Harmony:zh_male_jingqiangkanye_moon_bigtts'."\n"
.' - 湾湾小何:zh_female_wanwanxiaohe_moon_bigtts'."\n"
.' - 湾区大叔:zh_female_wanqudashu_moon_bigtts'."\n"
.' - 呆萌川妹:zh_female_daimengchuanmei_moon_bigtts'."\n"
.' - 广州德哥:zh_male_guozhoudege_moon_bigtts'."\n"
.' - 北京小爷:zh_male_beijingxiaoye_moon_bigtts'."\n"
.' - 浩宇小哥:zh_male_haoyuxiaoge_moon_bigtts'."\n"
.' - 广西远舟:zh_male_guangxiyuanzhou_moon_bigtts'."\n"
.' - 妹坨洁儿:zh_female_meituojieer_moon_bigtts'."\n"
.' - 豫州子轩:zh_male_yuzhouzixuan_moon_bigtts'."\n"
.'- Role-play:'."\n"
.' - 奶气萌娃:zh_male_naiqimengwa_mars_bigtts'."\n"
.' - 婆婆:zh_female_popo_mars_bigtts'."\n"
.' - 高冷御姐:zh_female_gaolengyujie_moon_bigtts'."\n"
.' - 傲娇霸总:zh_male_aojiaobazong_moon_bigtts'."\n"
.' - 魅力女友:zh_female_meilinvyou_moon_bigtts'."\n"
.' - 深夜播客:zh_male_shenyeboke_moon_bigtts'."\n"
.' - 柔美女友:zh_female_sajiaonvyou_moon_bigtts'."\n"
.' - 撒娇学妹:zh_female_yuanqinvyou_moon_bigtts'."\n"
.' - 病弱少女:ICL_zh_female_bingruoshaonv_tob'."\n"
.' - 活泼女孩:ICL_zh_female_huoponvhai_tob'."\n"
.' - 东方浩然:zh_male_dongfanghaoran_moon_bigtts'."\n"
.' - 绿茶小哥:ICL_zh_male_lvchaxiaoge_tob'."\n"
.' - 娇弱萝莉:ICL_zh_female_jiaoruoluoli_tob'."\n"
.' - 冷淡疏离:ICL_zh_male_lengdanshuli_tob'."\n"
.' - 憨厚敦实:ICL_zh_male_hanhoudunshi_tob'."\n"
.' - 傲气凌人:ICL_zh_male_aiqilingren_tob'."\n"
.' - 活泼刁蛮:ICL_zh_female_huopodiaoman_tob'."\n"
.' - 固执病娇:ICL_zh_male_guzhibingjiao_tob'."\n"
.' - 撒娇粘人:ICL_zh_male_sajiaonianren_tob'."\n"
.' - 傲慢娇声:ICL_zh_female_aomanjiaosheng_tob'."\n"
.' - 潇洒随性:ICL_zh_male_xiaosasuixing_tob'."\n"
.' - 腹黑公子:ICL_zh_male_fuheigongzi_tob'."\n"
.' - 诡异神秘:ICL_zh_male_guiyishenmi_tob'."\n"
.' - 儒雅才俊:ICL_zh_male_ruyacaijun_tob'."\n"
.' - 病娇白莲:ICL_zh_male_bingjiaobailian_tob'."\n"
.' - 正直青年:ICL_zh_male_zhengzhiqingnian_tob'."\n"
.' - 娇憨女王:ICL_zh_female_jiaohannvwang_tob'."\n"
.' - 病娇萌妹:ICL_zh_female_bingjiaomengmei_tob'."\n"
.' - 青涩小生:ICL_zh_male_qingsenaigou_tob'."\n"
.' - 纯真学弟:ICL_zh_male_chunzhenxuedi_tob'."\n"
.' - 暖心学姐:ICL_zh_female_nuanxinxuejie_tob'."\n"
.' - 可爱女生:ICL_zh_female_keainvsheng_tob'."\n"
.' - 成熟姐姐:ICL_zh_female_chengshujiejie_tob'."\n"
.' - 病娇姐姐:ICL_zh_female_bingjiaojiejie_tob'."\n"
.' - 优柔帮主:ICL_zh_male_youroubangzhu_tob'."\n"
.' - 优柔公子:ICL_zh_male_yourougongzi_tob'."\n"
.' - 妩媚御姐:ICL_zh_female_wumeiyujie_tob'."\n"
.' - 调皮公主:ICL_zh_female_tiaopigongzhu_tob'."\n"
.' - 傲娇女友:ICL_zh_female_aojiaonvyou_tob'."\n"
.' - 贴心男友:ICL_zh_male_tiexinnanyou_tob'."\n"
.' - 少年将军:ICL_zh_male_shaonianjiangjun_tob'."\n"
.' - 贴心女友:ICL_zh_female_tiexinnvyou_tob'."\n"
.' - 病娇哥哥:ICL_zh_male_bingjiaogege_tob'."\n"
.' - 学霸男同桌:ICL_zh_male_xuebanantongzhuo_tob'."\n"
.' - 幽默叔叔:ICL_zh_male_youmoshushu_tob'."\n"
.' - 性感御姐:ICL_zh_female_xingganyujie_tob'."\n"
.' - 假小子:ICL_zh_female_jiaxiaozi_tob'."\n"
.' - 冷峻上司:ICL_zh_male_lengjunshangsi_tob'."\n"
.' - 温柔男同桌:ICL_zh_male_wenrounantongzhuo_tob'."\n"
.' - 病娇弟弟:ICL_zh_male_bingjiaodidi_tob'."\n"
.' - 幽默大爷:ICL_zh_male_youmodaye_tob'."\n"
.' - 傲慢少爷:ICL_zh_male_aomanshaoye_tob'."\n"
.' - 神秘法师:ICL_zh_male_shenmifashi_tob'."\n"
.'- Video Dubbing:'."\n"
.' - 和蔼奶奶:ICL_zh_female_heainainai_tob'."\n"
.' - 邻居阿姨:ICL_zh_female_linjuayi_tob'."\n"
.' - 温柔小雅:zh_female_wenrouxiaoya_moon_bigtts'."\n"
.' - 天才童声:zh_male_tiancaitongsheng_mars_bigtts'."\n"
.' - 猴哥:zh_male_sunwukong_mars_bigtts'."\n"
.' - 熊二:zh_male_xionger_mars_bigtts'."\n"
.' - 佩奇猪:zh_female_peiqi_mars_bigtts'."\n"
.' - 武则天:zh_female_wuzetian_mars_bigtts'."\n"
.' - 顾姐:zh_female_gujie_mars_bigtts'."\n"
.' - 樱桃丸子:zh_female_yingtaowanzi_mars_bigtts'."\n"
.' - 广告解说:zh_male_chunhui_mars_bigtts'."\n"
.' - 少儿故事:zh_female_shaoergushi_mars_bigtts'."\n"
.' - 四郎:zh_male_silang_mars_bigtts'."\n"
.' - 磁性解说男声 / Morgan:zh_male_jieshuonansheng_mars_bigtts'."\n"
.' - 鸡汤妹妹 / Hope:zh_female_jitangmeimei_mars_bigtts'."\n"
.' - 贴心女声 / Candy:zh_female_tiexinnvsheng_mars_bigtts'."\n"
.' - 俏皮女声:zh_female_qiaopinvsheng_mars_bigtts'."\n"
.' - 萌丫头 / Cutey:zh_female_mengyatou_mars_bigtts'."\n"
.' - 懒音绵宝:zh_male_lanxiaoyang_mars_bigtts'."\n"
.' - 亮嗓萌仔:zh_male_dongmanhaimian_mars_bigtts'."\n"
.'- Audiobook:'."\n"
.' - 悬疑解说:zh_male_changtianyi_mars_bigtts'."\n"
.' - 儒雅青年:zh_male_ruyaqingnian_mars_bigtts'."\n"
.' - 霸气青叔:zh_male_baqiqingshu_mars_bigtts'."\n"
.' - 擎苍:zh_male_qingcang_mars_bigtts'."\n"
.' - 活力小哥:zh_male_yangguangqingnian_mars_bigtts'."\n"
.' - 古风少御:zh_female_gufengshaoyu_mars_bigtts'."\n"
.' - 温柔淑女:zh_female_wenroushunv_mars_bigtts'."\n"
.' - 反卷青年:zh_male_fanjuanqingnian_mars_bigtts'."\n"
."\n\n"
.' ',
'changeSet' => [
['createdAt' => '2024-08-28T12:13:12.000Z', 'description' => '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"}]',
],
'DescribeTagHitsSummary' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => ['description' => 'The job group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '292eba45-df08-4065-87e7-7e587a1ce4ce', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code. `OK` indicates a successful request.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5391EB13-A0E7-402D-A407-B99D4ABAF22A', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'TagGroups' => [
'description' => 'A list of tag groups.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagGroupIndex' => ['description' => 'The index of the tag group.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'TagGroup' => ['description' => 'The tag group name.', 'type' => 'string', 'example' => '标签组', 'title' => ''],
'ScriptId' => ['description' => 'The script ID.', 'type' => 'string', 'example' => '8a4c6d3d-5ed6-44ca-b779-16c20f8862be', 'title' => ''],
'Id' => ['description' => 'The ID of the tag group.', 'type' => 'string', 'example' => '8bb6f8ca-85a3-49f8-86a5-3127902a2156', 'title' => ''],
],
'description' => 'Details of the tag group.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TagHitsList' => [
'description' => 'A list of tag hit statistics.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'HitCount' => ['description' => 'The hit count for the tag.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TagGroup' => ['description' => 'The tag group name.', 'type' => 'string', 'example' => '当前学历', 'title' => ''],
'TagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => '本科', 'title' => ''],
],
'description' => 'Statistics for a tag hit.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => 'The data returned.',
'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' => 'Queries statistics about tag hits. This is a 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' => 'Queries the list of number binding instances under a 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"
.'> Queries the binding status of the specified number across all instances. Obtain the number from the response parameters of ListAllTenantBindNumberBinding.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '15005059355', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The API response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'List' => [
'description' => 'The job group description.',
'type' => 'array',
'items' => [
'description' => 'The data.',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'e2d7a184-7d6c-45d4-ac24-34ab48f54669', 'title' => ''],
'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
'IsBinding' => ['title' => '', 'description' => 'Indicates whether the number is in a bound state.', 'type' => 'boolean', 'example' => 'true'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The 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' => ''],
],
],
'title' => 'Query number binding status under a 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' => [],
'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"}]',
],
'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, typically 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' => 'Task 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 perform for outbound calls. Hangup ends the call.', 'type' => 'string', 'required' => false, 'example' => 'broadcast', 'title' => ''],
],
[
'name' => 'ActionParams',
'in' => 'query',
'schema' => ['description' => 'Parameters required to perform 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' => 'Scenario 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' => 'Interface status code', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'Interface 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 was successful', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Feedback' => [
'description' => 'Returns dialogue information',
'type' => 'object',
'properties' => [
'Action' => ['description' => 'Instruction for IVR', 'type' => 'string', 'example' => 'broadcast', 'title' => ''],
'ActionParams' => ['description' => 'Instruction parameters', 'type' => 'string', 'example' => '""', 'title' => ''],
'Content' => ['description' => 'Dialogue text', 'type' => 'string', 'example' => '你好,我是**客服', 'title' => ''],
'Interruptible' => ['description' => 'Indicates whether the broadcast can be interrupted', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ContentParams' => ['description' => 'Deprecated', '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' => 'This robot dialogue interface handles 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' => 'Downloads a call recording.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94084',
'abilityTreeNodes' => ['FEATUREoutboundbot3SV6AU'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '744b27f3-437f-4a8c-a181-f668e492fd24', 'title' => ''],
],
[
'name' => 'NeedVoiceSliceRecording',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to retrieve voice slice recordings.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'SwapChannels',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to swap the left and right audio channels. The default value is `false`.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DownloadParams' => [
'description' => 'Download parameters for the recording file.',
'type' => 'object',
'properties' => [
'SignatureUrl' => ['description' => 'The signed URL for downloading the recording file.', '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' => 'The name of the recording file, typically a universally unique identifier (UUID).', 'type' => 'string', 'example' => '281eb174-3865-41c1-9274-7b6813edadab.wav', 'title' => ''],
'VoiceSliceRecordingListJson' => ['description' => 'A JSON-formatted string that contains a list of voice slice recordings. Each item in the list includes the file name and URL of a slice.', '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'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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' => 'Recording scenario ID', 'type' => 'string', 'required' => true, 'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17', 'title' => ''],
],
[
'name' => 'Uuid',
'in' => 'query',
'schema' => ['description' => 'Unique recording ID', '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 message', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Success', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DownloadParams' => [
'description' => 'Parameters',
'type' => 'object',
'properties' => [
'SignatureUrl' => ['description' => 'A URL pointing to the recording file. Use this address 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 script recordings by retrieving their URLs. This operation is intended for 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' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', 'title' => ''],
],
[
'name' => 'SourceScriptId',
'in' => 'query',
'schema' => ['description' => 'The ID of the source script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6114e7e8-4140-48d9-b46d-65ea29f13fe8', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name for the new script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '复制的催收话术', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful. A value of true indicates success, while false indicates failure.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'ScriptId' => ['description' => 'The ID of the new script.', 'type' => 'string', 'example' => '6114e7e8-4140-48d9-b46d-65ea29f13fe8', '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' => ''],
],
],
'title' => '[Legacy Canvas API] Copy Script',
'summary' => 'Duplicates an existing script. This operation applies only to the legacy canvas.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:DuplicateScript',
'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 \\"ScriptId\\": \\"6114e7e8-4140-48d9-b46d-65ea29f13fe8\\"\\n}","type":"json"}]',
'translator' => 'machine',
],
'ExportScript' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code of the request.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DownloadParams' => [
'description' => 'The signed URL that you can use to download the script. This parameter is returned only for legacy canvases.',
'type' => 'object',
'properties' => [
'SignatureUrl' => ['description' => 'The download URL. This parameter is returned only for legacy canvases.'."\n"
."\n"
.'> **For modern canvases**: After the scenario is exported, call the **ListDownloadTasks** operation to obtain the \\`TaskId\\` (for example, \\`5d352db754fe430xxxxxxx\\`) and \\`FileId\\` (for example, \\`5d000f3f6eae4228b2731427xxxxxx\\`). Then, call the **CreateDownloadUrl** operation to obtain the download URL.', 'type' => 'string', 'example' => 'http://tiangong-staging.oss-cn-shanghai.aliyuncs.com/record/281eb174-3865-41c1-9274-7b6813edadab.wav?Expires=1578624046&OSSAccessKeyId=LTAI****cqw&Signature=dL2dxWS6VcdZrvG9xOMOBMSP3Fg%3D', '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' => 'Exports 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' => '',
'description' => 'BaseResponse\\',
'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' => 'Response data',
'type' => 'object',
'properties' => [
'AccessId' => ['description' => 'OSS access ID', 'type' => 'string', 'example' => 'LBA******', 'title' => ''],
'Policy' => ['description' => 'Upload policy', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0yNlQwMzo0ODo1My4wMzVaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJ1cGxvYWQvZmlsZS84NzRkNzM3MS03OTFiLTQyODEtOTM1Yy02Mzc2MzBhMzc3ODUvIl1dfQ==",', 'title' => ''],
'Signature' => ['description' => 'Signature', 'type' => 'string', 'example' => 'I6d1ONWVuTj5i0Kz4Vn+V0lC6v4=', 'title' => ''],
'Folder' => ['description' => 'Upload folder path', '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' => 'Time-to-live (TTL) in seconds', 'type' => 'integer', 'format' => 'int32', 'example' => '1742960933', 'title' => ''],
'Success' => ['description' => 'Indicates whether the upload succeeded', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Message' => ['description' => 'API message for the upload', '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\\": \\"LBA******\\",\\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'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:GenerateUploadUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'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' => 'Delay before playing audio after the call is answered, in seconds', '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' => 'Retrieve the delay before audio playback begins after a 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' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => '0ec0c897-b92c-40e4-9ad7-e6e4f5ce13bb'],
],
[
'name' => 'AgentProfileId',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The ID of the agent configuration.'."\n"
."\n"
.'> The agent configuration ID for a created scenario is available in the ChatbotId parameter returned by the DescribeScript operation.', 'type' => 'string', 'required' => true, 'example' => 'd31794e2a51f47d2901b4094d88311d7'],
],
[
'name' => 'AppIp',
'in' => 'formData',
'schema' => ['description' => 'The IP address of the application. This is a system field and is optional.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '127.0.0.1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'CreateTime' => ['description' => 'The time when the configuration was created.', 'type' => 'string', 'title' => '', 'example' => '1741338619000'],
'UpdateTime' => ['description' => 'The time when the configuration was last modified.', 'type' => 'string', 'title' => '', 'example' => '1741338619000'],
'AgentProfileId' => ['title' => '', 'description' => 'The ID of the agent configuration.', 'type' => 'string', 'example' => 'd31794e2a51f47d2901b4094d88311d7'],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => '7f04f92c-ccfc-4f8f-a816-6902023be5c6'],
'ScriptId' => ['title' => '', 'description' => 'The scenario ID.', 'type' => 'string', 'example' => 'd13ad2d3-3fe6-4352-b38b-bd6559047de8'],
'AgentType' => ['title' => '', 'description' => 'The agent type.', 'type' => 'string', 'example' => '""'],
'PromptJson' => ['title' => '', 'description' => 'The agent configuration.', 'type' => 'string', 'example' => '{"name":"小x","gender":"男","age":18,"role":"游戏推广员","communicationStyle":["亲切"],"goals":"你好","background":"不是很好","openingPrompt":"你好,我是xxx"}'."\n"],
'Prompt' => ['title' => '', 'description' => 'The prompt for the professional pattern.', 'type' => 'string', 'example' => '""'],
'AgentProfileTemplateId' => ['title' => '', 'description' => 'The ID of the agent configuration template.', 'type' => 'string', 'example' => 'default-survey'],
'Model' => ['description' => 'The model ID.', 'type' => 'string', 'title' => '', 'example' => 'model_002'],
'ModelConfig' => ['title' => '', 'description' => 'The model configuration.', 'type' => 'string', 'example' => '{}'],
'System' => ['description' => 'Indicates whether the template is a system template.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
'LabelsJson' => ['title' => '', 'description' => 'The description of the labels.', 'type' => 'string', 'example' => '[{\\"name\\":\\"是否送达\\",\\"description\\":\\"购买的家电是否已经送达\\",\\"valueList\\":\\"[\\\\\\"是\\\\\\",\\\\\\"否\\\\\\"]\\"},{\\"name\\":\\"预约上门时间\\",\\"description\\":\\"收集客户期望的上门安装时间\\",\\"valueList\\":\\"[]\\"}]'."\n"],
'VariablesJson' => ['title' => '', 'description' => 'The variable configuration.', 'type' => 'string', 'example' => '[{\\"name\\":\\"name\\",\\"description\\":\\"客户姓名\\"},{\\"name\\":\\"gender\\",\\"description\\":\\"客户性别\\"}]'."\n"],
'Scenario' => ['description' => 'The scenario.', 'type' => 'string', 'title' => '', 'example' => '测试场景'],
'Description' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => '这是一个大模型机器人'],
'InstructionJson' => ['description' => 'The instruction configuration.', 'type' => 'string', 'example' => '[{"type":"TransferToAgent","instructions":[{"code":"Transfer0","skillGroupId":"123","skillGroupName":"123"}],"timeoutEnable":false},{"type":"CollectNumber","instructions":[]}]'."\n", 'title' => ''],
'ApiPluginJson' => ['description' => 'The API plugin configuration.', 'type' => 'string', 'example' => '[]', 'title' => ''],
'NluConfigJson' => ['description' => 'The Natural Language Understanding (NLU) configuration. The parameters are described as follows:'."\n"
."\n"
.'- chatbotInstanceId: The instance ID of the ChatMe LLM agent.'."\n"
."\n"
.'- faqCategoryIds: The IDs of the attached FAQ categories.'."\n"
."\n"
.'- llmAgentId: The ID of the ChatMe LLM workspace.'."\n"
."\n"
.'- llmAgentKey: The key of the ChatMe LLM workspace.'."\n"
."\n"
.'- llmAgentInstanceId: The instance ID of the ChatMe LLM workspace.', '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' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The 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' => 'Retrieves the configuration of an agent.',
'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' => ['description' => 'ID of the agent profile template.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'default-survey'],
],
[
'name' => 'AppIp',
'in' => 'formData',
'schema' => ['description' => 'IP address of the application. This is a system field and is optional.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '127.0.0.1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'BaseResponse\\',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the call 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' => ['description' => 'Time when the template was created.', 'type' => 'string', 'title' => '', 'example' => '1720766491000'],
'UpdateTime' => ['description' => 'Time when the template was last updated.', 'type' => 'string', 'title' => '', 'example' => '1720766491000'],
'AgentProfileTemplateId' => ['title' => '', 'description' => 'ID of the agent profile template.', 'type' => 'string', 'example' => 'default-survey'],
'Name' => ['title' => '', 'description' => 'Name of the agent profile template.', 'type' => 'string', 'example' => '问卷调查'],
'Description' => ['title' => '', 'description' => 'Description of the agent profile template.', 'type' => 'string', 'example' => '说明'],
'PromptSchema' => ['title' => '', 'description' => 'Agent profile 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技能1:核验用户身份\\n技能2:进行活动推荐\\n技能3:确认用户参与意向并礼貌挂机",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "描述机器人包含的能力\\n例如:\\n1.使用客服语气询问客户的产品满意度情况\\n2.需要针对产品的易用性、性能、功能完善度、商品价格这4个纬度进行打分调研",'."\n"
.' "rows": 5,'."\n"
.' "isAutoOptimizePrompt": true,'."\n"
.' "quickOptionsEnabled": true,'."\n"
.' "apiPluginsEnabled": true'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 1000'."\n"
.' },'."\n"
.' "workflow": {'."\n"
.' "displayOrder": 10,'."\n"
.' "displayName": "流程",'."\n"
.' "description": "描述机器人执行任务时,与客户交流的过程。例如\\n根据预先设定的问题逻辑推进调研:\\n1. 总体满意度:“首先,请问您对我们服务的整体满意度如何评价?非常满意、满意、一般、不满意还是非常不满意?”\\n2. 服务亮点(若上一题为正面评价):“很高兴听到您的满意!请问哪些方面让您感到特别满意呢?”\\n3. 改进建议(若上一题为负面评价):“非常抱歉给您带来了不便。您认为我们在哪方面可以做得更好?”\\n4. 服务效率:“在服务响应速度和服务完成的时效性上,您的感受是怎样的?”\\n5. 员工态度:“对于服务人员的专业度和态度,您有何评价?”\\n6. 再次选择意愿:“基于此次体验,您未来是否会考虑再次使用我们的服务?”",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "描述工作流程",'."\n"
.' "rows": 10,'."\n"
.' "isAutoOptimizePrompt": true,'."\n"
.' "quickOptionsEnabled": true,'."\n"
.' "apiPluginsEnabled": true'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 4000'."\n"
.' },'."\n"
.' "constraint": {'."\n"
.' "displayOrder": 11,'."\n"
.' "displayName": "约束",'."\n"
.' "description": "描述对话的约束或整体要求,例如\\n你需要记住你的角色信息,并始终遵循。\\n- 在整个通话过程中,保持语气的中立性和友好性,避免对受访者产生引导性影响。\\n- 每轮对话不超过50个字,确保信息传达的高效性。\\n- 严格遵守调研伦理,保证受访者信息的匿名性和隐私安全。\\n- 避免在电话中深入讨论涉及个人隐私或具体服务细节的问题。\\n- 用户询问的问题与目标或流程无关时, 请礼貌拒绝,并引导到目标问题上。\\n- 只回复与本次任务相关的问题;对于不知道的问题,请不要胡乱回复,需要礼貌回复“不清楚”,并引导到目标问题上。",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "描述机器人交流过程中需要注意的问题,或异常情况下的回复参考\\n例如:\\n1.保持对话的专业客服行业专业术语和礼貌性,维护公司形象\\n2.针对客服的情绪如不耐烦、生气等能够精准识别并及时停止调研",'."\n"
.' "rows": 5,'."\n"
.' "isAutoOptimizePrompt": true'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 1000,'."\n"
.' "defaultValue": "- 当前时间:${currentTimeWithDayOfWeek}。\\n- 星期和日期转换时,请用北京时间。\\n- 如果不知道目标用户(客户)性别,则直接称呼目标用户(客户)姓名,不要尊称xx先生/女士。例如:不知道张三的性别,请直接称呼张三,不要称呼张三先生/女士。\\n- 如果知道目标用户(客户)性别,直接称呼xx先生/女士。\\n- 请严格按照流程步骤逐步执行,并确保所有步骤都已经执行,如果还存在没有执行的步骤,则需要再执行一次。"'."\n"
.' },'."\n"
.' "output": {'."\n"
.' "displayOrder": 1000,'."\n"
.' "displayName": "输出",'."\n"
.' "description": "输出",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "- 无格式\\n",'."\n"
.' "rows": 10,'."\n"
.' "isAutoOptimizePrompt": false'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 2000,'."\n"
.' "defaultValue": "- 无格式\\n",'."\n"
.' "hidden": true'."\n"
.' },'."\n"
.' "aiHangupOutput": {'."\n"
.' "displayOrder": 1001,'."\n"
.' "displayName": "aiHangupOutput",'."\n"
.' "description": "aiHangupOutput",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "- 如果判断会话结束,则礼貌回复并追加#[HangUp]\\n- 如果流程已执行完成,则礼貌回复并追加#[HangUp]\\n- 如果大模型(机器人或者Bot)输出了再见,并且表示希望结束会话,则追加#[HangUp]",'."\n"
.' "rows": 10,'."\n"
.' "isAutoOptimizePrompt": false'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 2000,'."\n"
.' "defaultValue": "- 如果判断会话结束,则礼貌回复并追加#[HangUp]\\n- 如果流程已执行完成,则礼貌回复并追加#[HangUp]\\n- 如果大模型(机器人或者Bot)输出了再见,并且表示希望结束会话,则追加#[HangUp]",'."\n"
.' "hidden": true'."\n"
.' },'."\n"
.' "aiSilenceTimeoutOutput": {'."\n"
.' "displayOrder": 1002,'."\n"
.' "displayName": "aiSilenceTimeoutOutput",'."\n"
.' "description": "aiSilenceTimeoutOutput",'."\n"
.' "dataType": "TEXT",'."\n"
.' "editorType": "MENTIONS_TEXTAREA",'."\n"
.' "attributes": {'."\n"
.' "placeholder": "- 如果用户没有说话,则礼貌回复用户。比如“抱歉,我听不到您讲话,请您再说一遍?“\\n- 如果用户没有说话没有达到${aiSilenceTimeoutMaxCount}次,请不要结束会话,但需要进行礼貌回复。\\n-如果用户没有说话达到${aiSilenceTimeoutMaxCount}次,则礼貌回复结束会话并追加#[HangUp]",'."\n"
.' "rows": 10,'."\n"
.' "isAutoOptimizePrompt": false'."\n"
.' },'."\n"
.' "group": "业务描述",'."\n"
.' "maxLength": 2000,'."\n"
.' "defaultValue": "- 如果用户没有说话,则礼貌回复用户。比如“抱歉,我听不到您讲话,请您再说一遍?“\\n- 如果用户没有说话没有达到${aiSilenceTimeoutMaxCount}次,请不要结束会话,但需要进行礼貌回复。\\n-如果用户没有说话达到${aiSilenceTimeoutMaxCount}次,则礼貌回复结束会话并追加#[HangUp]",'."\n"
.' "hidden": true'."\n"
.' }'."\n"
.' }'."\n"
.'}'],
],
'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技能1:核验用户身份\\\\\\\\n技能2:进行活动推荐\\\\\\\\n技能3:确认用户参与意向并礼貌挂机\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"描述机器人包含的能力\\\\\\\\n例如:\\\\\\\\n1.使用客服语气询问客户的产品满意度情况\\\\\\\\n2.需要针对产品的易用性、性能、功能完善度、商品价格这4个纬度进行打分调研\\\\\\",\\\\n \\\\\\"rows\\\\\\": 5,\\\\n \\\\\\"isAutoOptimizePrompt\\\\\\": true,\\\\n \\\\\\"quickOptionsEnabled\\\\\\": true,\\\\n \\\\\\"apiPluginsEnabled\\\\\\": true\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 1000\\\\n },\\\\n \\\\\\"workflow\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 10,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"流程\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"描述机器人执行任务时,与客户交流的过程。例如\\\\\\\\n根据预先设定的问题逻辑推进调研:\\\\\\\\n1. 总体满意度:“首先,请问您对我们服务的整体满意度如何评价?非常满意、满意、一般、不满意还是非常不满意?”\\\\\\\\n2. 服务亮点(若上一题为正面评价):“很高兴听到您的满意!请问哪些方面让您感到特别满意呢?”\\\\\\\\n3. 改进建议(若上一题为负面评价):“非常抱歉给您带来了不便。您认为我们在哪方面可以做得更好?”\\\\\\\\n4. 服务效率:“在服务响应速度和服务完成的时效性上,您的感受是怎样的?”\\\\\\\\n5. 员工态度:“对于服务人员的专业度和态度,您有何评价?”\\\\\\\\n6. 再次选择意愿:“基于此次体验,您未来是否会考虑再次使用我们的服务?”\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"描述工作流程\\\\\\",\\\\n \\\\\\"rows\\\\\\": 10,\\\\n \\\\\\"isAutoOptimizePrompt\\\\\\": true,\\\\n \\\\\\"quickOptionsEnabled\\\\\\": true,\\\\n \\\\\\"apiPluginsEnabled\\\\\\": true\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 4000\\\\n },\\\\n \\\\\\"constraint\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 11,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"约束\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"描述对话的约束或整体要求,例如\\\\\\\\n你需要记住你的角色信息,并始终遵循。\\\\\\\\n- 在整个通话过程中,保持语气的中立性和友好性,避免对受访者产生引导性影响。\\\\\\\\n- 每轮对话不超过50个字,确保信息传达的高效性。\\\\\\\\n- 严格遵守调研伦理,保证受访者信息的匿名性和隐私安全。\\\\\\\\n- 避免在电话中深入讨论涉及个人隐私或具体服务细节的问题。\\\\\\\\n- 用户询问的问题与目标或流程无关时, 请礼貌拒绝,并引导到目标问题上。\\\\\\\\n- 只回复与本次任务相关的问题;对于不知道的问题,请不要胡乱回复,需要礼貌回复“不清楚”,并引导到目标问题上。\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"描述机器人交流过程中需要注意的问题,或异常情况下的回复参考\\\\\\\\n例如:\\\\\\\\n1.保持对话的专业客服行业专业术语和礼貌性,维护公司形象\\\\\\\\n2.针对客服的情绪如不耐烦、生气等能够精准识别并及时停止调研\\\\\\",\\\\n \\\\\\"rows\\\\\\": 5,\\\\n \\\\\\"isAutoOptimizePrompt\\\\\\": true\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 1000,\\\\n \\\\\\"defaultValue\\\\\\": \\\\\\"- 当前时间:${currentTimeWithDayOfWeek}。\\\\\\\\n- 星期和日期转换时,请用北京时间。\\\\\\\\n- 如果不知道目标用户(客户)性别,则直接称呼目标用户(客户)姓名,不要尊称xx先生/女士。例如:不知道张三的性别,请直接称呼张三,不要称呼张三先生/女士。\\\\\\\\n- 如果知道目标用户(客户)性别,直接称呼xx先生/女士。\\\\\\\\n- 请严格按照流程步骤逐步执行,并确保所有步骤都已经执行,如果还存在没有执行的步骤,则需要再执行一次。\\\\\\"\\\\n },\\\\n \\\\\\"output\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 1000,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"输出\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"输出\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"- 无格式\\\\\\\\n\\\\\\",\\\\n \\\\\\"rows\\\\\\": 10,\\\\n \\\\\\"isAutoOptimizePrompt\\\\\\": false\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 2000,\\\\n \\\\\\"defaultValue\\\\\\": \\\\\\"- 无格式\\\\\\\\n\\\\\\",\\\\n \\\\\\"hidden\\\\\\": true\\\\n },\\\\n \\\\\\"aiHangupOutput\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 1001,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"aiHangupOutput\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"aiHangupOutput\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"- 如果判断会话结束,则礼貌回复并追加#[HangUp]\\\\\\\\n- 如果流程已执行完成,则礼貌回复并追加#[HangUp]\\\\\\\\n- 如果大模型(机器人或者Bot)输出了再见,并且表示希望结束会话,则追加#[HangUp]\\\\\\",\\\\n \\\\\\"rows\\\\\\": 10,\\\\n \\\\\\"isAutoOptimizePrompt\\\\\\": false\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 2000,\\\\n \\\\\\"defaultValue\\\\\\": \\\\\\"- 如果判断会话结束,则礼貌回复并追加#[HangUp]\\\\\\\\n- 如果流程已执行完成,则礼貌回复并追加#[HangUp]\\\\\\\\n- 如果大模型(机器人或者Bot)输出了再见,并且表示希望结束会话,则追加#[HangUp]\\\\\\",\\\\n \\\\\\"hidden\\\\\\": true\\\\n },\\\\n \\\\\\"aiSilenceTimeoutOutput\\\\\\": {\\\\n \\\\\\"displayOrder\\\\\\": 1002,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"aiSilenceTimeoutOutput\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"aiSilenceTimeoutOutput\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"editorType\\\\\\": \\\\\\"MENTIONS_TEXTAREA\\\\\\",\\\\n \\\\\\"attributes\\\\\\": {\\\\n \\\\\\"placeholder\\\\\\": \\\\\\"- 如果用户没有说话,则礼貌回复用户。比如“抱歉,我听不到您讲话,请您再说一遍?“\\\\\\\\n- 如果用户没有说话没有达到${aiSilenceTimeoutMaxCount}次,请不要结束会话,但需要进行礼貌回复。\\\\\\\\n-如果用户没有说话达到${aiSilenceTimeoutMaxCount}次,则礼貌回复结束会话并追加#[HangUp]\\\\\\",\\\\n \\\\\\"rows\\\\\\": 10,\\\\n \\\\\\"isAutoOptimizePrompt\\\\\\": false\\\\n },\\\\n \\\\\\"group\\\\\\": \\\\\\"业务描述\\\\\\",\\\\n \\\\\\"maxLength\\\\\\": 2000,\\\\n \\\\\\"defaultValue\\\\\\": \\\\\\"- 如果用户没有说话,则礼貌回复用户。比如“抱歉,我听不到您讲话,请您再说一遍?“\\\\\\\\n- 如果用户没有说话没有达到${aiSilenceTimeoutMaxCount}次,请不要结束会话,但需要进行礼貌回复。\\\\\\\\n-如果用户没有说话达到${aiSilenceTimeoutMaxCount}次,则礼貌回复结束会话并追加#[HangUp]\\\\\\",\\\\n \\\\\\"hidden\\\\\\": true\\\\n }\\\\n }\\\\n}\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => 'Obtain agent configuration template (deprecated)',
'summary' => 'Retrieves an agent profile 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' => ['description' => 'The ID of the annotation task.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '50e53ac8-24a4-46d5-b174-ee88867f4780'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the call was successful. A value of true indicates a successful call. A value of false indicates a failed call.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The additional information. If the request is successful, success is returned. If the request fails, an error code is returned.', 'type' => 'string', 'example' => 'You are not authorized to perform this action. CDR:View privileges are required.', 'title' => ''],
'Data' => [
'description' => 'The data.',
'type' => 'object',
'properties' => [
'AnnotationMissionId' => ['description' => 'The ID of the annotation task.', 'type' => 'string', 'title' => '', 'example' => 'b3f2c931-5180-43ca-b4aa-2baee2d73c8b'],
'IntentSummaryInfo' => [
'title' => '',
'description' => 'The statistics of semantic tagging.',
'type' => 'object',
'properties' => [
'IntentUserSayCount' => ['description' => 'The number of conversations.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'AnnotationCorrectCount' => ['description' => 'The number of correct chats.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'MatchErrorCount' => ['description' => 'The number of detection errors.', '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' => 'The total number of chats.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TranslationUnrecognizedCount' => ['description' => 'The number of translations that were not recognized.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'IntentionNotCoveredCount' => ['description' => 'The number of uncovered intents.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'example' => '',
],
'AsrSummaryInfo' => [
'title' => '',
'description' => 'The statistics of speech annotation.',
'type' => 'object',
'properties' => [
'WordErrorRate' => ['description' => 'The word error rate. Unit: 0.01%. This parameter is typically used for English.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'CharacterErrorRate' => ['description' => 'The character error rate. Unit: 0.01%.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'SentenceErrorRate' => ['description' => 'The sentence error rate. Unit: 0.01%.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'AnnotationInvalid' => ['description' => 'Data is invalid.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'NoAnnotation' => ['description' => 'Not annotated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'ChatTotalCount' => ['description' => 'The total number of chats.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'AddVocabularyDataCount' => ['description' => 'The number of times hotwords were added.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'AddCustomizationDataCount' => ['description' => 'The number of times language model data was added.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'CharacterCorrectRate' => ['description' => 'The character accuracy rate. Unit: 0.01%.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'example' => '',
],
'TagSummaryInfo' => [
'title' => '',
'description' => 'The custom tags and their quantities.',
'type' => 'object',
'properties' => [
'TagSummaryInfoDetailList' => [
'description' => 'The list of tags.',
'type' => 'array',
'items' => [
'description' => 'The list of tags.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the tag.', 'type' => 'string', 'example' => '知晓率1_复制', 'title' => ''],
'Count' => ['description' => 'The number of tags.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
'Success' => ['description' => 'Indicates whether the call was successful. A value of true indicates a successful call. A value of false indicates a failed call.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The additional information. If the request is successful, success is returned. If the request fails, an error code is returned.', 'type' => 'string', 'example' => 'You are not authorized to perform this action. CDR:View privileges are required.', 'title' => ''],
],
'title' => '',
'example' => '',
],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The 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 you do not specify this parameter, the system returns the default tags for the tenant.', 'type' => 'string', 'required' => false, 'example' => '4eee9bf8-1319-468f-ac82-83c50ae389f8', 'title' => ''],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int32', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse\\',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the call succeeded. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => 'CDR \'job-efbaeefc-4d45-4e79-83f7-b33b0769c969\' doesn\'t exists.', 'title' => ''],
'Data' => [
'description' => 'Response 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. A value of true indicates that the tag is deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Success' => ['description' => 'Indicates whether the call succeeded. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'Response 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' => 'Retrieves information such as the Automatic Speech Recognition (ASR) model list and hotword list. This operation 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' => 'Retrieves the result of an asynchronous outbound call task upload.',
'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' => 'The ID of the asynchronous task.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dc79b0f9-a781-4305-85e2-d5d56679ae69', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Response information.',
'type' => 'object',
'properties' => [
'Timeout' => ['description' => 'Indicates whether the asynchronous task timed out.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The 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' => 'The API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The API message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'JobGroupId' => ['description' => 'The task group ID.', 'type' => 'string', 'example' => 'd3550dd1-360d-4fe5-b4b2-667a4a664dab', 'title' => ''],
'JobsId' => [
'description' => 'The list of job IDs.',
'type' => 'array',
'items' => ['description' => 'The 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' => 'Retrieve the global outbound time periods for 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', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '024f8cf0-c842-4c01-b74b-c8667e4579c7', 'title' => ''],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => ['description' => 'Strategy level. Default value is 2.'."\n"
."\n"
.'- 0: System'."\n"
."\n"
.'- 1: Tenant'."\n"
."\n"
.'- 2: Instance', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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 call 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' => ''],
'OnlyWeekdays' => ['description' => 'Indicates whether the period applies only to weekends', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'OnlyWorkdays' => ['description' => 'Indicates whether the period applies only to weekdays', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'WorkingTime' => [
'description' => 'Time periods when the strategy runs',
'example' => '[]',
'items' => [
'properties' => [
'EndTime' => ['description' => 'End time', 'type' => 'string', 'example' => '00:00:00', 'title' => ''],
'BeginTimeMillis' => ['description' => 'Daily start time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'EndTimeMillis' => ['description' => 'Daily end time, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
'BeginTime' => ['description' => 'Start time', 'type' => 'string', 'example' => '00:00:00', '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', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates if the call 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' => ''],
'RemainingConcurrent' => ['description' => 'Remaining concurrent conversations', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'MaxConcurrent' => ['description' => 'Maximum number of concurrent conversations', '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 \\"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' => 'Retrieves the remaining concurrency for 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' => 'Retrieves the list of contacts blocked for outbound calls.',
'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' => 'The page number. This parameter is required.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries (required)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
[
'name' => 'CountTotalRow',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to return the total number of entries.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '846e20ae-e113-4231-a792-cb354187c9f6', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ContactBlocklistList' => [
'description' => 'The list of blocked contacts.',
'example' => '{}',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'List' => [
'description' => 'The data array.',
'example' => '[]',
'items' => [
'properties' => [
'ContactBlockListId' => ['description' => 'The unique key of the entry in the do-not-call list.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'CreationTime' => ['description' => 'The time when the entry was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640077685465', 'title' => ''],
'Remark' => ['description' => 'The remarks.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
'PhoneNumber' => ['description' => 'The mobile phone number.', 'type' => 'string', 'example' => '1388888888', 'title' => ''],
'Operator' => ['description' => 'The operator.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Name' => ['description' => 'The name of the contact.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'Creator' => ['description' => 'The user who created the entry.', 'type' => 'string', 'example' => 'xxx', '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' => 'Retrieves 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', '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' => ''],
],
[
'name' => 'CountTotalRow',
'in' => 'query',
'schema' => ['description' => 'Whether to return the total count', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2a830781-324e-4568-ae96-309f93090fe1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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' => ''],
'ContactWhitelistList' => [
'description' => 'Contact list',
'example' => '{}',
'properties' => [
'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' => 'int32', 'example' => '100', 'title' => ''],
'List' => [
'description' => 'Contact list',
'example' => '{}',
'items' => [
'properties' => [
'CreationTime' => ['description' => 'Creation time', 'type' => 'integer', 'format' => 'int64', 'example' => '1640174411848', 'title' => ''],
'Remark' => ['description' => 'Remarks', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
'PhoneNumber' => ['description' => 'Mobile phone number', 'type' => 'string', 'example' => '13959999999', 'title' => ''],
'Operator' => ['description' => 'Operator', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'ContactWhiteListId' => ['description' => 'Whitelist ID', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Name' => ['description' => 'Name', 'type' => 'string', 'example' => '张三', 'title' => ''],
'Creator' => ['description' => 'Creator', 'type' => 'string', 'example' => '测试123', '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', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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 call succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'CurrentConcurrency' => ['description' => 'Current concurrency', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
'Code' => ['description' => 'API status code', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'API message', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'MaxConcurrentConversation' => ['description' => 'Maximum concurrency', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'example' => '12f3dd08-0c55-44ce-9b64-e69d35ed3a76', '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' => 'Retrieves the current concurrency of an 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' => 'A query-based feature toggle that disables outbound calls to nonexistent numbers in 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', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'db3e679b-7d5e-4d9b-828a-345adca455f3', 'title' => ''],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => ['description' => 'Strategy level. Set to 2 for business instances.'."\n"
."\n"
.'- 0: System'."\n"
."\n"
.'- 1: Tenant'."\n"
."\n"
.'- 2: Instance', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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' => ''],
'EmptyNumberNoMoreCalls' => ['description' => 'Do Not Call Nonexistent Numbers', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'Response code', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => 'Success', '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' => 'Retrieves the parameters for uploading job data.',
'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 duplicate file names; the system automatically adds one if left blank)', 'type' => 'string', 'required' => false, 'example' => 'sas_siema_1477832102462645_siem_f07e90c2c147cf8cf1549ccb974e1956', 'title' => ''],
],
[
'name' => 'Path',
'in' => 'query',
'schema' => ['description' => 'Relative path for 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' => 'Is successful', '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"
.'> This parameter\'s value is used in request parameters for 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' => 'Retrieves the maximum number of daily call attempts allowed for a specified 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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2bfa5ae4-7185-4227-a3b8-328f26f11be1', 'title' => ''],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => ['description' => 'The policy level. The default value is 2 for a business instance.'."\n"
."\n"
.'- 0: System'."\n"
."\n"
.'- 1: Tenant'."\n"
."\n"
.'- 2: Instance', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'MaxAttemptsPerDay' => ['description' => 'The maximum number of redial attempts after a call fails.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'Code' => ['description' => 'The status code of the API.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned for the API.', 'type' => 'string', 'example' => 'Success', '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' => 'Retrieves the download URL 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' => [],
],
'GetPublicKey' => [
'summary' => 'Obtains the public key of the asymmetric encryption algorithm.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '230365',
'abilityTreeNodes' => ['FEATUREoutboundbotN899BL'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code of the API.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Data' => ['description' => 'The public key.', 'type' => 'string', 'example' => '-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwkftR4j5P9ng+Si/2ydc\\\\/K03NlhpzI4nW3JoNZIZR83P\\nMeyoULt+ivvFI7R++BU413QfX7l5FZnuUrII\\nNNBfFX84m1tmsdythDQmS2soG2sBiGKMv6O5mlBvXi+GA0/GqQ2juEv5DAb0GfOk\\nw8syQDkpNZflUSTnh10qbnDQxIGeisv1S4/Eo00djX48y5N8qXEcz9CUgwQpKQ0s\\nWQIDAQAB\\n-----END PUBLIC KEY-----\\n', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The 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' => ''],
],
],
'title' => 'Obtain the asymmetric encryption public key',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": \\"-----BEGIN PUBLIC KEY-----\\\\\\\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwkftR4j5P9ng+Si/2ydc\\\\\\\\\\\\\\\\/K03NlhpzI4nW3JoNZIZR83P\\\\\\\\nMeyoULt+ivvFI7R++BU413QfX7l5FZnuUrII\\\\\\\\nNNBfFX84m1tmsdythDQmS2soG2sBiGKMv6O5mlBvXi+GA0/GqQ2juEv5DAb0GfOk\\\\\\\\nw8syQDkpNZflUSTnh10qbnDQxIGeisv1S4/Eo00djX48y5N8qXEcz9CUgwQpKQ0s\\\\\\\\nWQIDAQAB\\\\\\\\n-----END PUBLIC KEY-----\\\\\\\\n\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
],
'GetRealtimeConcurrencyReport' => [
'summary' => 'Queries the current concurrency list.',
'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' => 'Page size', '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' => 'Is successful', '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' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'List' => [
'description' => 'Report collection 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 concurrency value', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'MaxConcurrencyLimit' => ['description' => 'Maximum configured concurrency limit', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'MinConcurrencyLimit' => ['description' => 'Minimum concurrency limit for 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' => 'Summary information for 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' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC'."\n", 'title' => ''],
'maxItems' => 99,
'required' => false,
'type' => 'array',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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' => ''],
'AgentBotInstanceSummaryList' => [
'description' => 'List of instances.',
'example' => '[]',
'items' => [
'properties' => [
'TotalCallCount' => ['description' => 'Total number of outbound calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'TotalCallTime' => ['description' => 'Total call duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'UsedRecordingStorageSpace' => ['description' => 'Used recording storage space, in MB.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', '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 task by its 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' => 'Task ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '15160071061', 'title' => ''],
],
[
'name' => 'WithConversations',
'in' => 'query',
'schema' => ['description' => 'Include conversation details'."\n"
."\n"
.'> 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' => 'Task 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 execution time (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' => 'Caller number', 'type' => 'string', 'example' => '057190294', 'title' => ''],
'ActualTime' => ['description' => 'Actual execution time', 'type' => 'integer', 'format' => 'int64', 'example' => '1640090211434', 'title' => ''],
'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'CalledNumber' => ['description' => 'Callee number', 'type' => 'string', 'example' => '13777777777', 'title' => ''],
'Id' => ['description' => 'Task ID', 'type' => 'string', 'example' => '2', 'title' => ''],
'Conversations' => [
'description' => 'List of conversations',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Speaker' => ['description' => 'Who spoke in the conversation. Valid values: Robot or Contact.', 'type' => 'string', 'example' => 'Robot', 'title' => ''],
'Script' => ['description' => 'Conversation text.', 'type' => 'string', 'example' => '你好,我是**客服', 'title' => ''],
'Timestamp' => ['description' => 'Timestamp when the summary was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579068424883', 'title' => ''],
'Action' => ['description' => 'Action type'."\n"
."\n"
.'- Dialogue: Dialogue'."\n"
."\n"
.'- AbortDialogue: Abort a dialogue'."\n"
."\n"
.'- SilenceTimeout: Silence timeout'."\n"
."\n"
.'- CollectedNumber: Collected number'."\n"
."\n"
.'- EndDialogue: End a dialogue'."\n"
."\n"
.'- Broadcast: Greeting message'."\n"
."\n"
.'- HangUp: Hang up'."\n"
."\n"
.'- Authorize: Authorization'."\n"
."\n"
.'- TransferToAgent: Transfer to an agent'."\n"
."\n"
.'- TransferToIVR: Transfer to an IVR system'."\n"
."\n"
.'- RedirectToPage: Redirect to a page'."\n"
."\n"
.'- CollectNumber: Collect a number'."\n"
."\n"
.'- WaitOnAsyncTask: Wait for an asynchronous task'."\n"
."\n"
.'- Error: Error', 'type' => 'string', 'example' => 'Broadcast', 'title' => ''],
'SequenceId' => ['description' => 'Session ID', 'type' => 'string', 'example' => 'fd279983-93b9-b13b-9a34-64e5df473225', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'EndReason' => ['description' => 'Reason the task ended'."\n"
."\n"
.'- FINISHED: Task completed normally'."\n"
."\n"
.'- CHATBOT\\_HANGUP\\_AFTER\\_NOANSWER: Bot hung up after no answer'."\n"
."\n"
.'- CHATBOT\\_HANGUP\\_AFTER\\_SILENCE: Bot hung up after silence timeout'."\n"
."\n"
.'- CLIENT\\_HANGUP\\_AFTER\\_NOANSWER: Client hung up after no answer'."\n"
."\n"
.'- CLIENT\\_HANGUP: Client hung up without reason'."\n"
."\n"
.'- TRANSFER\\_BY\\_INTENT: Transferred to agent after intent match'."\n"
."\n"
.'- TRANSFER\\_AFTER\\_NOANSWER: Transferred to agent after no answer'."\n"
."\n"
.'- INO\\_INTERACTION: No interaction from client'."\n"
."\n"
.'- ERROR: System error interrupted the task'."\n"
."\n"
.'- SPECIAL\\_INTERCEPT\\_VOICE\\_ASSISTANT: Intercepted due to voice assistant'."\n"
."\n"
.'- SPECIAL\\_INTERCEPT\\_EXTENSION\\_NUMBER\\_TRANSFER: Intercepted due to extension number transfer'."\n"
."\n"
.'>'."\n"
."\n"
.'This parameter is a string that returns an enumeration value such as FINISHED.'."\n"
."\n"
.'>', 'type' => 'string', 'example' => 'FINISHED', 'title' => ''],
],
'example' => '{}',
'title' => '',
],
'Code' => ['description' => 'API status code', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request 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' => 'Retrieve the 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', '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 call succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Version' => ['description' => 'Version number', 'type' => 'string', 'example' => 'v2.4.1.xxxxxxx_release', 'title' => ''],
'Code' => ['description' => 'Response code', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => 'Success', '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' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '00b37342-e759-4fe5-b296-aef775933af0', 'title' => ''],
],
[
'name' => 'SignatureUrl',
'in' => 'query',
'schema' => ['description' => 'URL of the scenario JSON file to import.'."\n"
."\n"
.'> This value is the Folder parameter returned by the GetJobDataUploadParams operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'UPLOADED/SCRIPT/136a055e-***-46c6-853a-731b3a2973de/18dc6d79-338f-413c-a5a8-dcce5f05b41a_9bd7916d-a340-4925-a911-92390cbe0f33.json'."\n", 'title' => ''],
],
[
'name' => 'NluEngine',
'in' => 'query',
'schema' => ['description' => 'NLU engine. Applies only to Large Language Model (LLM) scenarios.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- Prompts: LLM scenario.'."\n"
."\n"
.'- Empty: Non-LLM scenario.', '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' => ''],
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call succeeded.'."\n"
."\n"
.'- **true**: The call succeeded.'."\n"
."\n"
.'- **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' => 'Success', 'title' => ''],
'ScriptId' => ['description' => 'Outbound scenario ID.', 'type' => 'string', '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' => 'Task ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6bc0585c-0a8a-46d8-b042-23570bbb4855', 'title' => ''],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => ['description' => 'Alibaba Cloud account ID of the instance owner', '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' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a'],
],
[
'name' => 'ScriptId',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The scenario ID.', 'type' => 'string', 'required' => false, 'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95'."\n"],
],
[
'name' => 'AppIp',
'in' => 'formData',
'schema' => ['description' => 'The IP address of the application. This is an optional system field.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '127.0.0.1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'BaseResponse\\',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'array',
'items' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'CreateTime' => ['description' => 'The time when the configuration was created.', 'type' => 'string', 'title' => '', 'example' => '1721701525327'],
'UpdateTime' => ['description' => 'The time when the configuration was last modified.', 'type' => 'string', 'title' => '', 'example' => '1721701525327'."\n"],
'AgentProfileId' => ['title' => '', 'description' => 'The ID of the agent configuration.', 'type' => 'string', 'example' => '37ca3ca1ac4b4e57adf3da5b5d939d04'],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'e49ad122-15a1-443a-a102-84a78a93be79'],
'ScriptId' => ['title' => '', 'description' => 'The scenario ID.', 'type' => 'string', 'example' => '43972417-0657-452a-81c2-c59d8245a9b2'],
'AgentType' => ['title' => '', 'description' => 'The agent type.', 'type' => 'string', 'example' => '“”'],
'PromptJson' => ['title' => '', 'description' => 'The agent configuration.', 'type' => 'string', 'example' => '{"name":"小x","gender":"男","age":18,"role":"游戏推广员","communicationStyle":["亲切"],"goals":"你好","background":"不是很好","openingPrompt":"你好,我是xxx"}'."\n"],
'Prompt' => ['title' => '', 'description' => 'The prompt for the professional pattern.', 'type' => 'string', 'example' => '“”'],
'AgentProfileTemplateId' => ['title' => '', 'description' => 'The ID of the agent template.', 'type' => 'string', 'example' => 'default-survey'."\n"],
'Model' => ['description' => 'The model ID.', 'type' => 'string', 'title' => '', 'example' => 'model_002'],
'ModelConfig' => ['title' => '', 'description' => 'The model configuration.', 'type' => 'string', 'example' => '{}'],
'System' => ['description' => 'Indicates whether this is a system template.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
'LabelsJson' => ['title' => '', 'description' => 'The label definitions in JSON format.', 'type' => 'string', 'example' => '[{\\"name\\":\\"是否送达\\",\\"description\\":\\"购买的家电是否已经送达\\",\\"valueList\\":\\"[\\\\\\"是\\\\\\",\\\\\\"否\\\\\\"]\\"},{\\"name\\":\\"预约上门时间\\",\\"description\\":\\"收集客户期望的上门安装时间\\",\\"valueList\\":\\"[]\\"}]'."\n"],
'VariablesJson' => ['title' => '', 'description' => 'The variable configuration in JSON format.', 'type' => 'string', 'example' => '[{\\"name\\":\\"name\\",\\"description\\":\\"客户姓名\\"},{\\"name\\":\\"gender\\",\\"description\\":\\"客户性别\\"}]'."\n"],
'Scenario' => ['description' => 'The scenario.', 'type' => 'string', 'title' => '', 'example' => '测试场景'],
'Description' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => '这是一个充满智慧的智能体。'],
'InstructionJson' => ['description' => 'The instruction configuration in JSON format.', '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' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The 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' => 'Retrieves the publication history of an agent configuration in a Large Language Model (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' => 'Lists the phone numbers bound to the tenant.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'BaseResponse\\',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the call succeeded.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Code' => ['description' => 'Status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'API response 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' => 'Phone 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' => 'Lists annotation missions.',
'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' => ['description' => 'Annotation mission ID', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '0943abcb-bd7d-4ace-8cf7-97d39d4dd0b9'],
],
[
'name' => 'AnnotationMissionName',
'in' => 'query',
'schema' => ['description' => 'Annotation mission name', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '全景服务场景-标注任务-20230316-103253'],
],
[
'name' => 'AnnotationStatusListFilter',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '',
'description' => 'Annotation status filter. 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' => ['description' => 'Annotation status filter'."\n"
."\n"
.'> Format: \\[1]. You can specify multiple values. Valid values:'."\n"
."\n"
.'- 1: In progress'."\n"
."\n"
.'- 2: Completed'."\n"
."\n"
.'- 3: Closed', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '[1]'],
],
[
'name' => 'CreateTimeStartFilter',
'in' => 'query',
'schema' => ['description' => 'Start time of the annotation mission creation filter', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1661961600000'],
],
[
'name' => 'CreateTimeEndFilter',
'in' => 'query',
'schema' => ['description' => 'End time of the annotation mission creation filter', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1673280000000'],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'Number of entries per page', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'example' => '10', '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',
'description' => 'BaseResponse\\',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the call succeeded. true: succeeded. false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'Response code', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'Additional information. Returns success for normal requests. Returns a specific error code for abnormal requests.', 'type' => 'string', 'example' => 'CDR \'job-c7b8a817-b8e8-40f3-b7ad-f28dcea218ff\' doesn\'t exists.', 'title' => ''],
'Data' => [
'description' => 'Data',
'type' => 'object',
'properties' => [
'AnnotationMissionList' => [
'description' => 'Annotation mission list',
'type' => 'array',
'items' => [
'description' => 'Annotation mission',
'type' => 'object',
'properties' => [
'AnnotationMissionDataSourceType' => ['description' => 'Annotation data source type. 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' => 'Mission ID', 'type' => 'string', 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9', 'title' => ''],
'AnnotationMissionName' => ['description' => 'Mission name', 'type' => 'string', 'example' => '体验场景--移车-标注任务-20230220-141347', 'title' => ''],
'AnnotationStatus' => ['description' => 'Annotation status'."\n"
."\n"
.'- 1: In progress'."\n"
."\n"
.'- 2: Completed'."\n"
."\n"
.'- 3: Closed', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'CreateTime' => ['description' => 'Creation time', 'type' => 'integer', 'format' => 'int64', 'example' => '1676170339515', 'title' => ''],
'SessionTotalCount' => ['description' => 'Total number of sessions in the annotation mission', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'SessionFinishCount' => ['description' => 'Number of completed sessions in the annotation mission', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'FinishTime' => ['description' => 'Completion time of the annotation mission', 'type' => 'integer', 'format' => 'int64', 'example' => '1683443903785', 'title' => ''],
'ExcludeOtherMissionSession' => ['description' => 'Indicates whether to exclude call records already annotated in other missions', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'SessionEndReasonFilterList' => [
'description' => 'List of session end reason types used when creating the mission'."\n"
."\n"
.'- 1: Normal completion'."\n"
."\n"
.'- 2: Bot hangup after rejection'."\n"
."\n"
.'- 3: Hangup due to silence timeout'."\n"
."\n"
.'- 4: User hangup after rejection'."\n"
."\n"
.'- 5: User hangup without reason'."\n"
."\n"
.'- 6: Transfer to agent after intent match'."\n"
."\n"
.'- 7: Transfer to agent after rejection'."\n"
."\n"
.'- 8: No interaction from user side'."\n"
."\n"
.'- 9: System exception interruption'."\n"
."\n"
.'- 10: Transfer to IVR after intent match'."\n"
."\n"
.'- 11: Transfer to IVR after rejection',
'type' => 'array',
'items' => ['description' => 'Session end reason type used when creating the mission', 'type' => 'integer', 'format' => 'int32', 'example' => '[1]', 'title' => ''],
'title' => '',
'example' => '',
],
'ConversationTimeStartFilter' => ['description' => 'Start time of the conversation time query condition for the annotation mission', 'type' => 'integer', 'format' => 'int64', 'example' => '1683216000000', 'title' => ''],
'ConversationTimeEndFilter' => ['description' => 'End time of the conversation time query condition for the annotation mission', 'type' => 'integer', 'format' => 'int64', 'example' => '1684511999000', 'title' => ''],
'SamplingType' => ['description' => 'Sampling type', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'SamplingRate' => ['description' => 'Sampling rate', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'SamplingCount' => ['description' => 'Maximum sampling count limit', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'SamplingDescription' => ['description' => 'Sampling description', 'type' => 'string', 'example' => '标注', 'title' => ''],
'AnnotationMissionDebugDataSourceList' => [
'description' => 'Annotation debug data source list'."\n"
."\n"
.'> The response includes an extra 0. Valid responses are \\[0,1], \\[0,2], or \\[0,1,2].',
'type' => 'array',
'items' => ['description' => 'Annotation debug data source'."\n"
."\n"
.'- 1: Outbound task'."\n"
."\n"
.'- 2: Test task', 'type' => 'integer', 'format' => 'int32', 'example' => '[1]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageIndex' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'Number of entries 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 call succeeded. true: succeeded. false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'Additional information. Returns success for normal requests. Returns a specific error code for abnormal requests.', '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' => 'The task ID.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '8434a4b0-41fc-41b1-aa75-bbd1f2ab0c8d', 'title' => ''],
],
[
'name' => 'AnnotationMissionSessionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the chat instance for the annotation task.'."\n"
."\n"
.'> Obtain this ID by calling the SaveAnnotationMissionSessionList operation.', 'type' => 'string', 'required' => false, 'example' => '8434a4b0-41fc-41b1-aa75-bbd1f2ab0c8d'."\n", 'title' => ''],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'example' => '3', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of records to display on each page.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Environment',
'in' => 'query',
'schema' => ['description' => 'The environment.'."\n"
."\n"
.'> The default value is 2.'."\n"
."\n"
.'**Enumeration values**'."\n"
."\n"
.'- 0: NONE'."\n"
."\n"
.'- 1: Private cloud'."\n"
."\n"
.'- 2: Public cloud', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'IncludeStatusListJsonString',
'in' => 'query',
'schema' => ['description' => 'The list of statuses to include.'."\n"
."\n"
.'> The format is \\[1]. Fill the array with specific enumeration values.'."\n"
."\n"
.'**Enumeration values**'."\n"
."\n"
.'- 1: Correctly detected'."\n"
."\n"
.'- 2: Incorrectly detected'."\n"
."\n"
.'- 8: Invalid data'."\n"
."\n"
.'- 4: Uncovered intent'."\n"
."\n"
.'- 16: Transcription error', 'type' => 'string', 'required' => false, 'example' => '[1]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the call was successful. A value of \\`true\\` indicates success. A value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code of the API call.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'Additional information. If the call is successful, \\`success\\` is returned. If the call fails, a specific error code is returned.', 'type' => 'string', 'example' => 'bp.java.nopowerContact', 'title' => ''],
'Data' => [
'description' => 'The data.',
'type' => 'object',
'properties' => [
'AnnotationMissionId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'b3f2c931-5180-43ca-b4aa-2baee2d73c8b', 'title' => ''],
'AnnotationMissionSessionList' => [
'description' => 'The list of sessions.',
'type' => 'array',
'items' => [
'description' => 'The session.',
'type' => 'object',
'properties' => [
'AnnotationMissionSessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '64ba5ac9-a4e1-4333-b03c-9d4a588c9f6c'."\n", 'title' => ''],
'CreateTime' => ['description' => 'The time when the session was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1691117009000', 'title' => ''],
'ModifiedTime' => ['description' => 'The time when the session was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1677987898384', 'title' => ''],
'AnnotationMissionId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '64ba5ac9-a4e1-4333-b03c-9d4a588c9f6c', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e', 'title' => ''],
'ScriptId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => '408d6c4d-23e2-41f6-bbdd-f919a8297aa4', 'title' => ''],
'JobGroupId' => ['description' => 'The task group ID.', 'type' => 'string', 'example' => '2f642da1-b00b-4dd6-ac7d-dcbeefd13ff3', 'title' => ''],
'JobId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '42da7cde-a5e8-45cc-b9d2-828711d95b30', 'title' => ''],
'SessionId' => ['description' => 'The ID of the task in the outbound call system, or the ID of the conversation in the navigation system.', 'type' => 'string', 'example' => '40669e52-c1c8-487f-9593-29749086bdc9', 'title' => ''],
'AnnotationStatus' => ['description' => 'The annotation status.'."\n"
."\n"
.'- 0: UNDO'."\n"
."\n"
.'- 1: DOING'."\n"
."\n"
.'- 2: DONE'."\n"
."\n"
.'- 3: CLOSED', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'AnnotationMissionChatList' => [
'description' => 'The list of chats.',
'type' => 'array',
'items' => [
'description' => 'The chat object.',
'type' => 'object',
'properties' => [
'AnnotationMissionChatId' => ['description' => 'The chat ID.', 'type' => 'string', 'example' => '40669e52-c1c8-487f-9593-29749086bdc9'."\n", 'title' => ''],
'CreateTime' => ['description' => 'The time when the chat was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1682216045619', 'title' => ''],
'ModifiedTime' => ['description' => 'The time when the chat was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1571649300000', 'title' => ''],
'AnnotationMissionId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f', 'title' => ''],
'AnnotationMissionSessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '77343553-cbc2-4487-a35c-869f1e86c573', 'title' => ''],
'SequenceId' => ['description' => 'The sequence ID.', 'type' => 'string', 'example' => '380578077', 'title' => ''],
'OccurTime' => ['description' => 'The time when the chat was triggered.', 'type' => 'integer', 'format' => 'int64', 'example' => '1682390676403', 'title' => ''],
'Answer' => ['description' => 'The content of the bot\'s reply.', 'type' => 'string', 'example' => '{\'Answer\': u\'\\u53c2\\u8003\\u6587\\u6863\\uff1ahttps://help.aliyun.com/document_detail/215402.html\', \'QuestionId\': 371159, \'Uuid\': \'ac14000116781568127896224d0044\'}', 'title' => ''],
'AnnotationStatus' => ['description' => 'The annotation status of the chat.'."\n"
."\n"
.'- 0: UNDO'."\n"
."\n"
.'- 1: DOING'."\n"
."\n"
.'- 2: DONE'."\n"
."\n"
.'- 3: CLOSED', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'IntentAnnotationStatus' => ['description' => 'The status of semantic tagging.'."\n"
."\n"
.'- 0: UNDO'."\n"
."\n"
.'- 1: DOING'."\n"
."\n"
.'- 2: DONE'."\n"
."\n"
.'- 3: CLOSED', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
'AsrAnnotationStatus' => ['description' => 'The status of Automatic Speech Recognition (ASR) annotation.'."\n"
."\n"
.'- 0: UNDO'."\n"
."\n"
.'- 1: DOING'."\n"
."\n"
.'- 2: DONE'."\n"
."\n"
.'- 3: CLOSED', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
'TagAnnotationStatus' => ['description' => 'The status of tag annotation.'."\n"
."\n"
.'- 0: UNDO'."\n"
."\n"
.'- 1: DOING'."\n"
."\n"
.'- 2: DONE'."\n"
."\n"
.'- 3: CLOSED', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
'SubStatus' => ['description' => 'The annotation action. 1: Correct. 20: Matching error, not optimized. 21: Matching error, optimized. 3: Uncovered. 4: Invalid.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
'TranslationError' => ['description' => 'Indicates a transcription error.'."\n"
."\n"
.'- 0: No'."\n"
."\n"
.'- 1: Yes', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'AnnotationAsrResult' => ['description' => 'The result of manual ASR annotation, used to calculate character accuracy.', 'type' => 'string', 'example' => '[]', 'title' => ''],
'OriginalAsrResult' => ['description' => 'The ASR result.', 'type' => 'string', 'example' => '[]', 'title' => ''],
'AnnotationMissionChatIntentUserSayInfoList' => [
'description' => 'The list of chat intents.',
'type' => 'array',
'items' => [
'description' => 'The chat intent.',
'type' => 'object',
'properties' => [
'AnnotationMissionChatIntentUserSayInfoId' => ['description' => 'The ID.', 'type' => 'string', 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", 'title' => ''],
'CreateTime' => ['description' => 'The time when the intent was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1682216045619', 'title' => ''],
'ModifiedTime' => ['description' => 'The time when the intent was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1682216045619', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", 'title' => ''],
'AnnotationMissionId' => ['description' => 'The annotation task ID.', 'type' => 'string', 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", 'title' => ''],
'AnnotationMissionSessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", 'title' => ''],
'AnnotationMissionChatId' => ['description' => 'The chat ID.', 'type' => 'string', 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", 'title' => ''],
'Content' => ['description' => 'The modified query.', 'type' => 'string', 'example' => '[]', 'title' => ''],
'IntentId' => ['description' => 'The intent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11234112', 'title' => ''],
'DialogId' => ['description' => 'The dialog ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '29921312', 'title' => ''],
'BotId' => ['description' => 'The 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' => 'The table of hotword annotation information for the annotation task chat.',
'type' => 'array',
'items' => [
'description' => 'The hotword annotation information for the annotation task chat.',
'type' => 'object',
'properties' => [
'AnnotationMissionChatVocabularyInfoId' => ['description' => 'The ID.', 'type' => 'string', 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", 'title' => ''],
'CreateTime' => ['description' => 'The time when the resource was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1675218421941', 'title' => ''],
'ModifiedTime' => ['description' => 'The time when the hotword was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1676272557653', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '818961ce-d9ba-4f88-89ca-2a04b24bdf01', 'title' => ''],
'AnnotationMissionId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'b3f2c931-5180-43ca-b4aa-2baee2d73c8b', 'title' => ''],
'AnnotationMissionSessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", 'title' => ''],
'AnnotationMissionChatId' => ['description' => 'The chat ID.', 'type' => 'string', 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", 'title' => ''],
'VocabularyId' => ['description' => 'The hotword ID.', 'type' => 'string', 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", 'title' => ''],
'Vocabulary' => ['description' => 'The content of the hotword annotation.', 'type' => 'string', 'example' => '[]', 'title' => ''],
'VocabularyName' => ['description' => 'The name of the vocabulary.', 'type' => 'string', 'example' => '名称', 'title' => ''],
'VocabularyDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => '描述', 'title' => ''],
'VocabularyWeight' => ['description' => 'The weight of the hotword. The value ranges from -6 to 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' => 'The table of language model annotation information for the annotation task chat.',
'type' => 'array',
'items' => [
'description' => 'The language model annotation information for the annotation task chat.',
'type' => 'object',
'properties' => [
'AnnotationMissionChatCustomizationDataInfoId' => ['description' => 'The ID.', 'type' => 'string', 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", 'title' => ''],
'CreateTime' => ['description' => 'The time when the information was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1682216045619', 'title' => ''],
'ModifiedTime' => ['description' => 'The time when the information was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1679552585384', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'd3fbfca8-4208-4d4b-a53a-c4dba5e43a66', 'title' => ''],
'AnnotationMissionId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '2f03b24a-fda2-4501-90ba-0a9a59f8dd9d', 'title' => ''],
'AnnotationMissionSessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", 'title' => ''],
'AnnotationMissionChatId' => ['description' => 'The chat ID.', 'type' => 'string', 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", 'title' => ''],
'CustomizationDataId' => ['description' => 'The custom data ID.', 'type' => 'string', 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", 'title' => ''],
'Content' => ['description' => 'The text of the voice annotation.', 'type' => 'string', 'example' => '抱歉哈,可能给您造成困扰了,这边先不打扰您,祝您生活愉快,再见', 'title' => ''],
'CustomizationDataName' => ['description' => 'The name.', 'type' => 'string', 'example' => '默认数据', 'title' => ''],
'CustomizationDataDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => '默认数据', 'title' => ''],
'CustomizationDataWeight' => ['description' => 'The weight of the language model data.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Delete' => ['description' => 'Indicates whether the data is deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Create' => ['description' => 'Indicates whether the data is created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'AnnotationMissionChatTagInfoList' => [
'description' => 'The list of mappings between chat annotation information and attached tags.',
'type' => 'array',
'items' => [
'description' => 'The mapping between chat annotation information and an attached tag.',
'type' => 'object',
'properties' => [
'AnnotationMissionChatTagInfoId' => ['description' => 'The ID of the chat tag information for the comment.', 'type' => 'string', 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", 'title' => ''],
'CreateTime' => ['description' => 'The time when the tag was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1686797050000', 'title' => ''],
'ModifiedTime' => ['description' => 'The time when the tag was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1679019660000', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '32be9d94-1346-4c4a-a4d0-ccd379f87013', 'title' => ''],
'AnnotationMissionId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'e7272cbb-a60d-4b41-b5c4-8863edc0b8f7', 'title' => ''],
'AnnotationMissionSessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", 'title' => ''],
'AnnotationMissionChatId' => ['description' => 'The chat ID.', 'type' => 'string', 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", 'title' => ''],
'AnnotationMissionTagInfoId' => ['description' => 'The tag ID.', 'type' => 'string', 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f'."\n", 'title' => ''],
'AnnotationMissionTagInfoName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => '标签', 'title' => ''],
'Delete' => ['description' => 'Delete.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Create' => ['description' => 'Create', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Version' => ['description' => 'The 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 call was successful. \\`true\\` indicates success. \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'Additional information. If the call is successful, \\`success\\` is returned. If the call fails, a specific error code is returned.', 'type' => 'string', 'example' => 'bp.java.nopowerContact', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
],
'title' => '',
'example' => '',
],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The 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' => 'API plugin unique identifiers', '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 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 prompt message', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates success', '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'."\n"
."\n"
.'- Published'."\n"
."\n"
.'- PublishedAndEdited',
'enumValueTitles' => ['Drafted' => 'Drafted', 'Published' => 'Published', 'PublishedAndEdited' => 'PublishedAndEdited'],
'type' => 'string',
'example' => 'Drafted',
'title' => '',
],
'Type' => [
'description' => 'Type',
'enumValueTitles' => ['Function' => 'Function'],
'type' => 'string',
'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 plugin identifier', '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 displayed 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' => 'Lists API plugins.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListApiPlugins',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListBeebotIntent' => [
'summary' => 'Lists intents for small-model scenarios.',
'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' => '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' => 'IntentName',
'in' => 'query',
'schema' => ['description' => 'The intent name.'."\n"
."\n"
.'> This is the intent code. It uniquely identifies the intent.', 'type' => 'string', 'required' => false, 'example' => '知道了', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'BeebotRequestId' => ['description' => 'The internal request ID.', 'type' => 'string', 'example' => '497CFAFF-48CC-161A-AD2C-252DED569037', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned by the operation.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'Intents' => [
'description' => 'The list of intents.',
'type' => 'array',
'items' => [
'description' => 'The intent information.',
'type' => 'object',
'properties' => [
'IntentId' => ['description' => 'The intent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10717802'."\n", 'title' => ''],
'IntentName' => ['description' => 'The intent name.'."\n"
."\n"
.'> This is the intent code. It uniquely identifies the intent.', 'type' => 'string', 'example' => '知道了', 'title' => ''],
'AliasName' => ['description' => 'The intent alias.', 'type' => 'string', 'example' => '嗯明白了', 'title' => ''],
'ModifyUserId' => ['description' => 'Modify User ID', 'type' => 'string', 'example' => '1252504', 'title' => ''],
'ModifyUserName' => ['description' => 'Modify the account name.', 'type' => 'string', 'example' => 'xxx@voice-navigator-testonaliyun.com'."\n", 'title' => ''],
'CreateUserName' => ['description' => 'The name of the account that created the intent.', 'type' => 'string', 'example' => 'xxx@voice-navigator-testonaliyun.com'."\n", 'title' => ''],
'CreateTime' => ['description' => 'The time when the intent was created.', 'type' => 'string', 'example' => '2025-04-21 16:03:15.+0800', 'title' => ''],
'CreateUserId' => ['description' => 'The ID of the user who created the intent.', 'type' => 'string', 'example' => '1252504', 'title' => ''],
'ModifyTime' => ['description' => 'The time when the intent was last modified.', '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\\": \\"xxx@voice-navigator-testonaliyun.com\\\\n\\",\\n \\"CreateUserName\\": \\"xxx@voice-navigator-testonaliyun.com\\\\n\\",\\n \\"CreateTime\\": \\"2025-04-21 16:03:15.+0800\\",\\n \\"CreateUserId\\": \\"1252504\\",\\n \\"ModifyTime\\": \\"2025-04-21 16:03:15.+0800\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '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' => 'Lists the utterance templates for a specified intent in a scenario.',
'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' => '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' => 'string', 'required' => true, 'example' => '10717802', 'title' => ''],
],
[
'name' => 'LgfText',
'in' => 'query',
'schema' => ['description' => 'The utterance template.', 'type' => 'string', 'required' => false, 'example' => '我是一个问法模版'."\n", 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The 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' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'BeebotRequestId' => ['description' => 'The internal request ID.', 'type' => 'string', 'example' => '497CFAFF-48CC-161A-AD2C-252DED569037', 'title' => ''],
'Code' => ['description' => 'The API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned by the API.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'Lgfs' => [
'description' => 'The list of LGFs.',
'type' => 'array',
'items' => [
'description' => 'The list of LGFs.',
'type' => 'object',
'properties' => [
'LgfId' => ['description' => 'The ID of the utterance template.', 'type' => 'integer', 'format' => 'int64', 'example' => '5666117', 'title' => ''],
'CreateTime' => ['description' => 'The time when the template was created.', 'type' => 'string', 'example' => '2025-04-21 10:54:18.+0800', 'title' => ''],
'ModifyTime' => ['description' => 'The time when the template was last modified.', 'type' => 'string', 'example' => '2025-04-21 10:54:18.+0800', 'title' => ''],
'RuleText' => ['description' => 'The content of the utterance template.', 'type' => 'string', 'example' => '我是一个问法模版'."\n", 'title' => ''],
'IntentId' => ['description' => 'The 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' => 'Lists user utterances for intents in small model scenarios.',
'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' => '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' => 'string', 'required' => true, 'example' => '10717802', 'title' => ''],
],
[
'name' => 'Content',
'in' => 'query',
'schema' => ['description' => 'The keyword in the user utterance.', 'type' => 'string', 'required' => false, 'example' => '知道', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to display on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0956D5DA-0978-5DC9-94B0-C68527DA7475', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'BeebotRequestId' => ['description' => 'The internal request ID.', 'type' => 'string', 'example' => 'D7BBFCDF-59B0-1ADA-BCA3-4B77F642DDFB', 'title' => ''],
'Code' => ['description' => 'The status code of the API.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned for the API call.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'PageSize' => ['description' => 'The number of entries displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'UserSays' => [
'description' => 'The list of user utterances.',
'type' => 'array',
'items' => [
'description' => 'A user utterance.',
'type' => 'object',
'properties' => [
'UserSayId' => ['description' => 'The utterance ID.', 'type' => 'string', 'example' => '17448458', 'title' => ''],
'Content' => ['description' => 'The content of the utterance.', 'type' => 'string', 'example' => '你知道xxxx么?', 'title' => ''],
'CreateTime' => ['description' => 'The time when the utterance was created.', 'type' => 'string', 'example' => '2025-04-21 14:16:05.+0800', 'title' => ''],
'ModifyTime' => ['description' => 'The time when the utterance was last modified.', 'type' => 'string', 'example' => '2025-04-21 14:16:05.+0800', 'title' => ''],
'IntentId' => ['description' => 'The 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.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'Number of items per page.'."\n"
."\n"
.'> The value must be less than or equal to 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
[
'name' => 'AgentKey',
'in' => 'query',
'schema' => ['description' => 'Workspace access key for the chatbot.'."\n"
."\n"
.'> Get this key by calling ListChatbotAgents. If you omit this parameter, the API returns instances from all workspaces.', 'type' => 'string', 'required' => false, 'example' => '9137ab9c27044921860030adf8590ec4_p_outbound_public', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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 call succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Bots' => [
'description' => 'Chatbot list details',
'items' => [
'description' => 'Chatbot instance details.',
'properties' => [
'Introduction' => ['description' => 'Chatbot description.', 'type' => 'string', 'example' => '这是直播的描述', 'title' => ''],
'Avatar' => ['description' => 'Profile picture URL.', 'type' => 'string', 'example' => 'https://ccrm.wengine.cn/ccrm/system/common/fileDownload/noToken?fileId=975cdeaa064846e3b6004abd9ba1d7c8', 'title' => ''],
'TimeZone' => ['description' => 'Time zone of the chatbot. See Common Time Zone Codes.', 'type' => 'string', 'example' => 'Asia/Shanghai', 'title' => ''],
'CreateTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2022-01-18T02:36:00Z', 'title' => ''],
'LanguageCode' => ['description' => 'Language used by the chatbot, such as zh-cn or en-us.', 'type' => 'string', 'example' => 'zh-cn', 'title' => ''],
'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'e874fcf0-d2f4-4e62-9377-b6f35fe55210', 'title' => ''],
'Name' => ['description' => 'Chatbot name.', 'type' => 'string', 'example' => '智能回访2', 'title' => ''],
],
'type' => 'object',
'title' => '',
'example' => '',
],
'type' => 'array',
'title' => '',
'example' => '',
],
'PageSize' => ['description' => 'Number of items per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'PageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
'TotalCount' => ['description' => 'Total number of items.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', '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' => 'Lists the instances of the Yunxiao Mi chatbot service in Alibaba Cloud.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b5b0a30f-69e7-4147-98b5-553fc526361d', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd7c28efb-47f7-4a85-a522-5038e30a0b98', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request succeeded.'."\n"
."\n"
.'- **true**: The request succeeded.'."\n"
."\n"
.'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DialogueFlows' => [
'description' => 'A list of dialogue flows.',
'items' => [
'properties' => [
'DialogueFlowDefinition' => ['description' => 'The dialogue flow data, formatted as a JSON string.', 'type' => 'string', 'example' => '{"transitions":[{"source":"cc31e02b","sourceAnchor":0,"target":"345700de","targetAnchor":0,"id":"16d37c6e","index":1}],"nodes":[{"shape":"start-html","type":"start","size":"170*34","x":180,"y":134,"id":"cc31e02b","index":0,"nodeIndex":0,"content":{"branches":[{"branchName":"发起对话","branchId":"3c50a880-a7bc-11e9-80fc-5917e4f31864"}]},"coordinates":{"x":180,"y":134}},{"shape":"function-html","type":"transfer","size":"170*34","x":606,"y":134,"id":"345700de","nodeIndex":1,"name":"功能节点","script":"你是 @name ma","content":{"action":"Hangup","actionParams":"","label":["test1","test2","test3","test4","test5"]},"coordinates":{"x":606,"y":134},"index":2,"questions":["你是 @联系人姓名 ma"]}]}', 'title' => ''],
'DialogueFlowType' => ['description' => 'The flow type.'."\n"
."\n"
.'- `SubFlow`: The subflow.'."\n"
."\n"
.'- `MainFlow`: The main flow.', 'type' => 'string', 'example' => 'MainFlow', 'title' => ''],
'DialogueFlowId' => ['description' => 'The dialogue flow ID.', 'type' => 'string', 'example' => 'dae01529-3c3e-458e-b07a-97643d09ebb9', 'title' => ''],
'DialogueFlowName' => ['description' => 'The dialogue flow name.', 'type' => 'string', 'example' => '主流程', 'title' => ''],
'ScriptId' => ['description' => 'The outbound script ID.', 'type' => 'string', 'example' => '2d5aa451-661f-4f08-b0c4-28eec78decc4', 'title' => ''],
'ScriptVersion' => ['description' => 'The script version.', 'type' => 'string', 'example' => '1569220563549', 'title' => ''],
],
'type' => 'object',
'description' => 'A dialogue flow.',
'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 dialogue flows of a script in the legacy canvas.',
'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',
'enumValueTitles' => [1 => '1'],
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '1000',
'minimum' => '1',
'example' => '1',
'title' => '',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'Count',
'enumValueTitles' => [5 => '5'],
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '50',
'minimum' => '1',
'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' => 'Success', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'DownloadTasks' => [
'description' => 'Download task list',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'Count', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'TotalCount' => ['description' => 'Total count', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'List' => [
'description' => 'Download task array',
'type' => 'array',
'items' => [
'description' => 'Download task array',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'Export status.'."\n"
."\n"
.'- Pending: Pending'."\n"
."\n"
.'- InProgress: In progress'."\n"
."\n"
.'- Finished: Completed'."\n"
."\n"
.'- Failed: Failed'."\n"
."\n"
.'- Expired: Expired'."\n"
."\n"
.'- Cancelled: Canceled', 'type' => 'string', 'example' => 'Empty', 'title' => ''],
'Title' => ['description' => 'Title', 'type' => 'string', 'example' => 'GUI-TEST-新建风险', 'title' => ''],
'ExpireTime' => ['description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1646792941', 'title' => ''],
'TaskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '6b0e547e-501c-480a-812f-d27e28e74f9a', 'title' => ''],
'DownloadTaskFiles' => [
'description' => 'Download task file list',
'type' => 'array',
'items' => [
'description' => 'Download task file list',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'File status'."\n"
."\n"
.'- Pending: Pending'."\n"
."\n"
.'- InProgress: In progress'."\n"
."\n"
.'- Finished: Completed'."\n"
."\n"
.'- Failed: Failed'."\n"
."\n"
.'- Expired: Expired'."\n"
."\n"
.'- Cancelled: Canceled', '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' => 'Queries the list of download tasks in Download Hub.',
'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' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', 'title' => ''],
],
[
'name' => 'ProviderId',
'in' => 'query',
'schema' => ['description' => 'The ID of the flash SMS provider.'."\n"
."\n"
.'- Uincall: Beijing Uincall Communication Co., Ltd.'."\n"
."\n"
.'- ShangHaiTianNan: Shanghai Tiannan'."\n"
."\n"
.'- HeDao: Galacos', 'type' => 'string', 'required' => true, 'example' => 'Uincall', 'title' => ''],
],
[
'name' => 'ConfigId',
'in' => 'query',
'schema' => ['description' => 'The ID of the flash SMS configuration.', 'type' => 'string', 'required' => true, 'example' => 'fe542524-9585-4cc7-be54-c8782ed7f60e', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'EC08CC41-6870-5594-939A-F758F057898F', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call succeeded. A value of true indicates a successful call. A value of false indicates a failed call.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'array',
'items' => [
'description' => 'A flash SMS template.',
'type' => 'object',
'properties' => [
'TemplateName' => ['description' => 'The name of the template.', 'type' => 'string', 'example' => '模板1', 'title' => ''],
'TemplateId' => ['description' => 'The ID of the flash SMS template.', 'type' => 'string', 'example' => '17*******************01', 'title' => ''],
'TemplateContent' => ['description' => 'The content of the template.', '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' => 'You can call the ListFlashSmsTemplates operation to query 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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dd8c2b62-4660-457f-9597-6723b5722aff', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f63b0dfc-848a-42f3-9329-8854e232e977', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to display on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'GlobalQuestions' => [
'description' => 'The global question data.',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'List' => [
'description' => 'The array of global questions.',
'items' => [
'properties' => [
'GlobalQuestionId' => ['description' => 'The global question ID.', 'type' => 'string', 'example' => '53c27755-d41e-46a6-bb3c-4f66f257d50c', 'title' => ''],
'Answers' => ['description' => 'The replies to the global question.', 'type' => 'string', 'example' => '["你好,您可以再说一遍吗","不好意思我刚才没有听清"]', 'title' => ''],
'GlobalQuestionType' => ['description' => 'The type of the global question.'."\n"
."\n"
.'- SYSTEM: System-defined'."\n"
."\n"
.'- COMMON: General', 'type' => 'string', 'example' => 'SYSTEM', 'title' => ''],
'GlobalQuestionName' => ['description' => 'The name of the global question.', 'type' => 'string', 'example' => '未识别', 'title' => ''],
'Questions' => ['description' => 'The list of global questions.', 'type' => 'string', 'example' => '["测试问题1","测试问题2"]', 'title' => ''],
'ScriptId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => 'aa279896-64a6-4182-864c-4f2b04ec8d17', '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' => 'Queries the list of key questions. This is a legacy canvas interface.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:ListGlobalQuestions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListInstances' => [
'summary' => 'Queries the list of Outbound Bot service instances.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '94119',
'abilityTreeNodes' => ['FEATUREoutboundbotQHO52V'],
],
'parameters' => [
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.'."\n"
.'> You can obtain the source API from the Resource Management documentation. For more information, see: https://api.aliyun.com/document/ResourceManager/2020-03-31/ListResourceGroups', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm3iugit3uw7a', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of tags for the service instances.'."\n"
.'> You can call the ListResourceTags operation to obtain tags.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key of the instance.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''],
'Value' => ['description' => 'The tag value of the instance.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 20,
'title' => '',
'example' => '',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the Outbound Bot instance.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Instances' => [
'description' => 'The list of service instances.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CreationTime' => ['description' => 'The time when the instance was created.', 'type' => 'integer', 'format' => 'int64', 'example' => ' 1578469042851', 'title' => ''],
'InstanceId' => ['description' => 'The service instance ID.', 'type' => 'string', 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', 'title' => ''],
'OwnerName' => ['description' => 'The name of the Alibaba Cloud account.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'CreatorId' => ['description' => 'The ID of the creator.', 'type' => 'integer', 'format' => 'int64', 'example' => '34234', 'title' => ''],
'InstanceDescription' => ['description' => 'The description of the Outbound Bot service instance.', 'type' => 'string', 'example' => '这是一个实例', 'title' => ''],
'InstanceName' => ['description' => 'The name of the Outbound Bot service instance.', 'type' => 'string', 'example' => '回访', 'title' => ''],
'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', 'title' => ''],
'CreatorName' => ['description' => 'The name of the creator.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'MaxConcurrentConversation' => ['description' => 'The maximum number of concurrent outbound calls allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'ResourceTags' => [
'description' => 'The tag information.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'age', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '20', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '[]',
'title' => '',
],
'IsPreset' => ['description' => 'Indicates whether the instance is a system preset instance.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'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 number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', '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' => 'Query service instance list',
'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' => '*'],
],
],
],
],
'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"}]',
],
'ListIntentions' => [
'summary' => 'Query intent for the Annotation Center list.',
'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"
.'> Get this 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"
.'> Use this for fuzzy queries based on keywords.', 'type' => 'string', 'required' => false, 'example' => '知道', 'title' => ''],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => ['title' => 'page number', 'description' => 'Page Number', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => 'page size', 'description' => 'Number.', 'type' => 'integer', 'format' => 'int32', 'default' => '10', 'required' => false, 'example' => '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"
."\n"
.'- 2: Public Cloud', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''],
],
[
'name' => 'AnnotationMissionDataSourceType',
'in' => 'query',
'schema' => ['description' => '>'."\n"
."\n"
.'This parameter is required. Select based on the scenario.'."\n"
."\n"
.'>'."\n"
."\n"
.'Annotation data source.'."\n"
."\n"
.'- 1: Outbound Call'."\n"
."\n"
.'- 2: Navigation', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'Scenario ID', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'c5c5d8c0-c0f1-48a7-be2b-dc46006d888a'."\n", 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Is Success', '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"
."\n"
.'- Chinese (zh-cn)', 'type' => 'string', 'example' => 'zh-cn'."\n", 'title' => ''],
'Type' => ['description' => 'Intent Type:'."\n"
."\n"
.'- 0: Normal intent;'."\n"
."\n"
.'- 1: UNKNOWN;'."\n"
."\n"
.'- 2: TableQA intent;'."\n"
."\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 Say List',
'type' => 'array',
'items' => [
'description' => 'User Say Data',
'type' => 'object',
'properties' => [
'Id' => ['description' => 'The ID of the user utterance.', 'type' => 'string', 'example' => '17448458', 'title' => ''],
'FromId' => ['description' => 'Source ID'."\n"
.'>Invalid content>', 'type' => 'string', 'example' => '1234567', 'title' => ''],
'Strict' => ['description' => 'Is Strict Match', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'UserSayData' => [
'description' => 'User Say List',
'type' => 'array',
'items' => [
'description' => 'User Say Data',
'type' => 'object',
'properties' => [
'SlotId' => ['description' => 'Slot Unique Identifier', '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' => 'Slot Unique Identifier', '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"
."\n"
.'- false: No', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'IsEncrypt' => ['description' => 'Is Encrypted'."\n"
.'>Invalid content>', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'IsInteractive' => ['description' => 'Is Interactive'."\n"
.'>Invalid content>', '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' => 'User Say Unique Identifier for the Label', 'type' => 'string', 'example' => '17448458', 'title' => ''],
'Value' => ['description' => 'The value of the tag is the result of tagging an intent expression.', 'type' => 'string', 'example' => '你知道xxxx?', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Question' => [
'description' => 'Slot Follow-up Question',
'type' => 'array',
'items' => ['description' => 'Slot Follow-up Question', 'type' => 'string', 'example' => '你知道?', 'title' => ''],
'title' => '',
'example' => '',
],
'IsNecessary' => ['description' => 'Is Required Slot:'."\n"
."\n"
.'- true: Yes'."\n"
."\n"
.'- false: No', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'LifeSpan' => ['description' => 'Slot Lifecycle', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'FeedbackType' => ['description' => 'Feedback Type'."\n"
.'>Invalid content>', 'type' => 'string', 'example' => 'test', 'title' => ''],
'FeedbackFunctions' => [
'description' => 'The follow-up question function.'."\n"
.'>This parameter is invalid.>',
'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' => 'Endpoint', 'type' => 'string', 'example' => 'cn-hangzhou.log.aliyuncs.com', 'title' => ''],
'Type' => ['description' => 'Follow-up Question Type', 'type' => 'string', 'example' => 'cluster', 'title' => ''],
'Switch' => [
'description' => 'Feature Switch. Values:'."\n"
."\n"
.'- **on**: Enabled'."\n"
."\n"
.'- **off**: Disabled',
'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' => 'Condition 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' => 'Parameters',
'type' => 'object',
'additionalProperties' => ['description' => 'Parameter Content', 'type' => 'any', 'example' => '{"type":2}', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Success' => ['description' => 'Indicates whether the operation was successful.', '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' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": {\\n \\"IntentList\\": [\\n {\\n \\"BotId\\": 0,\\n \\"DialogId\\": \\"50099\\",\\n \\"Name\\": \\"知道了\\",\\n \\"Alias\\": [\\n \\"嗯明白了\\"\\n ],\\n \\"Id\\": 10717802,\\n \\"BotName\\": \\"111\\",\\n \\"Language\\": \\"zh-cn\\\\n\\",\\n \\"Type\\": 0,\\n \\"TableId\\": 43258,\\n \\"UserSay\\": [\\n {\\n \\"Id\\": \\"17448458\\",\\n \\"FromId\\": \\"1234567\\",\\n \\"Strict\\": true,\\n \\"UserSayData\\": [\\n {\\n \\"SlotId\\": \\"9ec31b50-32b8-11eb-9478-19d2d885afdb\\\\n\\",\\n \\"Text\\": \\"知道\\"\\n }\\n ]\\n }\\n ],\\n \\"RuleCheck\\": [\\n {\\n \\"Strict\\": true,\\n \\"Text\\": \\"知道\\",\\n \\"Warning\\": [\\n \\"“”\\"\\n ],\\n \\"Error\\": [\\n \\"“”\\"\\n ]\\n }\\n ],\\n \\"Slot\\": [\\n {\\n \\"Id\\": \\"9ec31b50-32b8-11eb-9478-19d2d885afdb\\\\n\\",\\n \\"Name\\": \\"知道\\",\\n \\"IsArray\\": false,\\n \\"IsEncrypt\\": false,\\n \\"IsInteractive\\": false,\\n \\"Value\\": \\"@知道\\",\\n \\"Tags\\": [\\n {\\n \\"UserSayId\\": \\"17448458\\",\\n \\"Value\\": \\"你知道xxxx?\\"\\n }\\n ],\\n \\"Question\\": [\\n \\"你知道?\\"\\n ],\\n \\"IsNecessary\\": true,\\n \\"LifeSpan\\": 0,\\n \\"FeedbackType\\": \\"test\\",\\n \\"FeedbackFunctions\\": [\\n {\\n \\"Code\\": \\"OK\\",\\n \\"Description\\": \\"GA setup for HPC cn4-HPC-EndUserServer-GlobalAccelerator\\",\\n \\"Function\\": \\"count\\",\\n \\"Name\\": \\"方欣云呼系统每日拨测_2024年11月\\",\\n \\"AliyunService\\": \\"test\\",\\n \\"AliyunFunction\\": \\"test\\",\\n \\"EndPoint\\": \\"cn-hangzhou.log.aliyuncs.com\\",\\n \\"Type\\": \\"cluster\\",\\n \\"Switch\\": [\\n {\\n \\"Id\\": \\"b9932604-08ae-4525-bbe5-c8cce3066070\\",\\n \\"Label\\": \\"SQL_SUB_QUERY\\",\\n \\"Type\\": \\"PASSKEY\\",\\n \\"Value\\": \\"BASE_VALIDATE_FILTER_SWITCH\\",\\n \\"Name\\": \\"测试0609_20241021_101018_复制_复制_复制\\"\\n }\\n ],\\n \\"Params\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\":2}\\"\\n }\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Success\\": true,\\n \\"Message\\": \\"Success\\",\\n \\"BotId\\": \\"chatbot-cn-n7QmzrUnNe\\\\n\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => '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' => '*'],
],
],
],
],
],
'ListIntents' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b9ff4e88-65f9-4eb3-987c-11ba51f3f24d', 'title' => ''],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => ['description' => 'A keyword to filter intents.', 'type' => 'string', 'required' => false, 'example' => '还款', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Intents' => [
'description' => 'The paginated list of intents.',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of intents.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'List' => [
'description' => 'The list of intents.',
'items' => [
'properties' => [
'Utterances' => ['description' => 'The user utterances that trigger the intent.', 'type' => 'string', 'example' => '["ok","好的","好吧","好嘞","可以","行啊","行吧","那行","知道了","我看一下","能的","等会吧","等一下","马上还","等一会","过两天","我会想办法处理"]', 'title' => ''],
'IntentDescription' => ['description' => 'The description of the intent.', 'type' => 'string', 'example' => '同意还款意图', 'title' => ''],
'UpdateTime' => ['description' => 'The time when the intent was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578469042851', 'title' => ''],
'CreateTime' => ['description' => 'The time when the intent was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578469042851', 'title' => ''],
'Keywords' => ['description' => 'The keywords of the intent.', 'type' => 'string', 'example' => '["还款"]', 'title' => ''],
'ScriptId' => ['description' => 'The script ID.', 'type' => 'string', 'example' => '6ef95fd5-558f-4ee8-af34-b2ede087a87c', 'title' => ''],
'IntentId' => ['description' => 'The intent ID.', 'type' => 'string', 'example' => 'a8494b35-eefb-4c8a-887b-b60d2f0fa57a', 'title' => ''],
'IntentName' => ['description' => 'The intent name.', 'type' => 'string', 'example' => '统一还款', 'title' => ''],
],
'type' => 'object',
'description' => 'Details of an intent.',
'title' => '',
'example' => '',
],
'type' => 'array',
'title' => '',
'example' => '',
],
],
'type' => 'object',
'title' => '',
'example' => '',
],
],
'type' => 'object',
'description' => 'The returned data.',
'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' => 'Retrieves intents from the legacy canvas interface.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start of the time range for the query, based on the creation time of the job group. Specify the time as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1578965079000', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end of the time range for the query, based on the creation time of the job group. Specify the time as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1579965079000', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'example' => '10', 'title' => ''],
],
[
'name' => 'AsyncQuery',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to retrieve the query results asynchronously.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'SearchText',
'in' => 'query',
'schema' => ['description' => 'The search text.', 'type' => 'string', 'required' => false, 'example' => '面试', 'title' => ''],
],
[
'name' => 'JobGroupStatusFilter',
'in' => 'query',
'schema' => ['description' => 'Filters results by job status. To specify multiple statuses, separate them with commas. The statuses are combined with a logical OR. Valid values:'."\n"
."\n"
.'- **Draft**: The job group is a draft.'."\n"
."\n"
.'- **Scheduling**: The job group is being scheduled.'."\n"
."\n"
.'- **Executing**: The job group is executing.'."\n"
."\n"
.'- **Completed**: The job group has completed.'."\n"
."\n"
.'- **Paused**: The job group is paused.'."\n"
."\n"
.'- **Failed**: The job group has failed.'."\n"
."\n"
.'- **Cancelled**: The job group is canceled.'."\n"
."\n"
.'- **Initializing**: The job group is initializing.', 'type' => 'string', 'required' => false, 'example' => 'Draft', 'title' => ''],
],
[
'name' => 'OnlyMinConcurrencyEnabled',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to return only job groups with minimum concurrency enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful. Valid values: `true` and `false`.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'AsyncTaskId' => ['description' => 'The ID of the asynchronous task. You can use this ID to query the status of the task.', 'type' => 'string', 'example' => '6243d904-939d-42ce-a8e4-886a139e77a3'."\n", 'title' => ''],
'JobGroups' => [
'description' => 'The list of job groups.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'List' => [
'description' => 'The list of job groups.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status of the job group. Valid values:'."\n"
."\n"
.'- **Draft**: The job group is a draft.'."\n"
."\n"
.'- **Scheduling**: The job group is being scheduled.'."\n"
."\n"
.'- **Executing**: The job group is running.'."\n"
."\n"
.'- **Completed**: The job group is completed.'."\n"
."\n"
.'- **Paused**: The job group is paused.'."\n"
."\n"
.'- **Failed**: The job group failed.'."\n"
."\n"
.'- **Cancelled**: The job group is canceled.'."\n"
."\n"
.'- **Initializing**: The job group is being initialized.', 'type' => 'string', 'example' => 'Draft', 'title' => ''],
'JobGroupId' => ['description' => 'The ID of the job group.', 'type' => 'string', 'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9', 'title' => ''],
'CreationTime' => ['description' => 'The time when the job group was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578550074361', 'title' => ''],
'JobGroupName' => ['description' => 'The name of the job group.', 'type' => 'string', 'example' => '催收作业组', 'title' => ''],
'TotalCallNum' => ['description' => 'The total number of calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'ScriptId' => ['description' => 'The ID of the script.', 'type' => 'string', 'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9', 'title' => ''],
'JobGroupDescription' => ['description' => 'The description of the job group.', 'type' => 'string', 'example' => '催收的作业组', 'title' => ''],
'JobDataParsingTaskId' => ['description' => 'The ID of the task that parses the job data file. This parameter is deprecated.', 'type' => 'string', 'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9', 'title' => ''],
'ScriptName' => ['description' => 'The name of the script.', 'type' => 'string', 'example' => '话术名称', 'title' => ''],
'ScriptVersion' => ['description' => 'The script version.', 'type' => 'string', 'example' => 'd9e828ac-744b-4dd3-848a-17a3da9167b8', 'title' => ''],
'ModifyTime' => ['description' => 'The time when the job group was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'string', 'example' => '1578550074361', 'title' => ''],
'Progress' => [
'description' => 'The progress of the job group.',
'type' => 'object',
'properties' => [
'TotalNotAnswered' => ['description' => 'This parameter is deprecated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Status' => ['description' => '> This parameter is no longer returned.'."\n"
."\n"
.'The status of the job. Valid values:'."\n"
."\n"
.'- **Draft**: The job is a draft.'."\n"
."\n"
.'- **Scheduling**: The job is being scheduled.'."\n"
."\n"
.'- **Executing**: The job is running.'."\n"
."\n"
.'- **Completed**: The job is completed.'."\n"
."\n"
.'- **Paused**: The job is paused.'."\n"
."\n"
.'- **Failed**: The job failed.'."\n"
."\n"
.'- **Cancelled**: The job is canceled.'."\n"
."\n"
.'- **Initializing**: The job is being initialized.', 'type' => 'string', 'example' => 'Scheduling', 'title' => ''],
'StartTime' => ['description' => 'The start time. This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578550074361', 'title' => ''],
'FailedNum' => ['description' => 'The number of failed jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'PausedNum' => ['description' => 'The number of paused jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'CancelledNum' => ['description' => 'The number of canceled jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'TotalJobs' => ['description' => 'The total number of jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'TotalCompleted' => ['description' => 'The number of completed jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'Duration' => ['description' => 'The total runtime. This parameter is deprecated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1578550074361', 'title' => ''],
'ExecutingNum' => ['description' => 'The number of running jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Scheduling' => ['description' => 'The number of jobs that are being scheduled.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'example' => '{}',
'title' => '',
],
'ExportProgress' => [
'description' => 'The progress of the export task.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status of the export task. Valid values:'."\n"
."\n"
.'- **PENDING**: The task is pending.'."\n"
."\n"
.'- **IN\\_PROGRESS**: The task is in progress.'."\n"
."\n"
.'- **FINISHED**: The task is finished.'."\n"
."\n"
.'- **FAILED**: The task failed.', 'type' => 'string', 'example' => 'PENDING', 'title' => ''],
'FileHttpUrl' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => 'http://www.xxx.com/xxx', 'title' => ''],
'Progress' => ['description' => 'The progress of the export task.', 'type' => 'string', 'example' => '1', 'title' => ''],
],
'example' => '{}',
'title' => '',
],
'Strategy' => [
'description' => 'The calling strategy. This parameter is deprecated.'."\n"
."\n"
.'> To view the strategy for a job group, call the `DescribeJobGroup` operation.',
'type' => 'object',
'properties' => [
'EndTime' => ['description' => 'The end time of the calling window.', 'type' => 'integer', 'format' => 'int64', 'example' => '2209702074000', 'title' => ''],
'StartTime' => ['description' => 'The start time of the calling window.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578550074000', 'title' => ''],
],
'example' => '{}',
'title' => '',
],
'MinConcurrency' => ['description' => 'The minimum number of concurrent calls.', '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' => 'Retrieves the list of outbound call task groups.',
'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'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListJobGroups'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListJobGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListJobGroupsAsync' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '94122',
'abilityTreeNodes' => ['FEATUREoutboundbot7ZIYMY'],
],
'parameters' => [
[
'name' => 'AsyncTaskId',
'in' => 'query',
'schema' => ['description' => 'The value of AsyncTaskId returned by ListJobGroup when the Async mode is used. You can use this ID to retrieve the results 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 the request timed out.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Vaild' => ['description' => 'Indicates whether the result is valid.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'JobGroups' => [
'description' => 'The task list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'Scheduling', 'title' => ''],
'CreationTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640316786259', 'title' => ''],
'JobGroupId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'JobGroupName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'TotalCallNum' => ['description' => 'The total number of calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'ScriptId' => ['description' => 'The script ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'JobGroupDescription' => ['description' => 'The task 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' => 'The script name.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''],
'ScriptVersion' => ['description' => 'The script version.', 'type' => 'string', 'example' => '111', 'title' => ''],
'ModifyTime' => ['description' => 'The modification time, in milliseconds.', 'type' => 'string', 'example' => '1640316786259', 'title' => ''],
'Strategy' => [
'description' => 'The strategy. [Deprecated]'."\n"
."\n"
.'> To view the task strategy information, call the DescribeJobGroup operation.',
'type' => 'object',
'properties' => [
'EndTime' => ['description' => 'The strategy end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640316786259', 'title' => ''],
'StartTime' => ['description' => 'The strategy start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640316786259', 'title' => ''],
],
'example' => '{}',
'title' => '',
],
'Progress' => [
'description' => 'The node statistics information.',
'type' => 'object',
'properties' => [
'TotalNotAnswered' => ['description' => 'The number of unanswered jobs. [Deprecated]', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Status' => ['description' => 'The execution status. Valid values:'."\n"
."\n"
.'- Draft: Draft.'."\n"
.'- Scheduling: Scheduling in progress.'."\n"
.'- Executing: Executing.'."\n"
.'- Completed: Completed.'."\n"
.'- Paused: Paused.'."\n"
.'- Failed: Failed.'."\n"
.'- Cancelled: Cancelled.'."\n"
.'- Initializing: Initializing.', 'type' => 'string', 'example' => 'Scheduling', 'title' => ''],
'StartTime' => ['description' => 'The start time. [Deprecated]', 'type' => 'integer', 'format' => 'int64', 'example' => '1640316786259', 'title' => ''],
'FailedNum' => ['description' => 'The number of failed jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PausedNum' => ['description' => 'The number of paused jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'CancelledNum' => ['description' => 'The number of cancelled jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCompleted' => ['description' => 'The number of completed jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalJobs' => ['description' => 'The total number of jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'Duration' => ['description' => 'The total execution duration so far. [Deprecated]', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''],
'Scheduling' => ['description' => 'The number of jobs being scheduled.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'ExecutingNum' => ['description' => 'The number of jobs being executed.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
],
'example' => '{}',
'title' => '',
],
'ExportProgress' => [
'description' => 'The export progress.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'PENDING', 'title' => ''],
'FileHttpUrl' => ['description' => 'The download URL. [Deprecated]', 'type' => 'string', 'example' => 'http://www.xxx.com/xxx'."\n", 'title' => ''],
'Progress' => ['description' => 'The progress.', 'type' => 'string', 'example' => '50', 'title' => ''],
],
'example' => '{}',
'title' => '',
],
'MinConcurrency' => ['description' => 'The minimum concurrency.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Asynchronously query task group list',
'summary' => 'Asynchronously retrieves the list of outbound call task groups. When the Async parameter is specified in the ListJobGroup operation, use this operation to retrieve the results of the asynchronous ListJobGroup call.',
'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' => '*'],
],
],
],
],
'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"}]',
],
'ListJobs' => [
'summary' => 'Queries 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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'JobId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of job IDs. A maximum of 99 child items are allowed.',
'type' => 'array',
'items' => ['description' => 'The 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' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Jobs' => [
'description' => 'The list of jobs.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The job status. Valid values:'."\n"
."\n"
.'- **Scheduling**: The job is being scheduled.'."\n"
.'- **Executing**: The job is being executed.'."\n"
.'- **Succeeded**: The job succeeded.'."\n"
.'- **Paused**: The job is suspended.'."\n"
.'- **Failed**: The job failed.'."\n"
.'- **Cancelled**: The job is cancelled.'."\n"
.'- **Drafted**: The job is in draft state.', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''],
'ScenarioId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'JobGroupId' => ['description' => 'The job group ID.', 'type' => 'string', 'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8', 'title' => ''],
'StrategyId' => ['description' => 'The strategy ID.', 'type' => 'string', 'example' => 'c8a2b7f2-ad1a-4865-b872-d0080d9802d9', 'title' => ''],
'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', 'title' => ''],
'Priority' => ['description' => 'The job priority.', 'type' => 'integer', 'format' => 'int32', 'example' => ' 5', 'title' => ''],
'SystemPriority' => ['description' => 'The system priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'FailureReason' => ['description' => 'The reason why the job failed.', 'type' => 'string', 'example' => 'NoAnswer', 'title' => ''],
'ReferenceId' => ['description' => 'The business ID of the job, which is custom-defined by the caller.'."\n"
."\n"
.'> This is the ContactId value that was uploaded.', 'type' => 'string', 'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28', 'title' => ''],
'Contacts' => [
'description' => 'The list of contacts.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '135****8888', 'title' => ''],
'State' => ['description' => 'The status. [Deprecated]', 'type' => 'string', 'example' => 'Available', 'title' => ''],
'ContactId' => ['description' => 'The contact ID. This value is automatically generated by the system.', 'type' => 'string', 'example' => 'db3db762-e421-44c9-9a01-cb423470757c', 'title' => ''],
'Honorific' => ['description' => 'The honorific. This value is the same as the contact name.', 'type' => 'string', 'example' => '张先生', 'title' => ''],
'JobId' => ['description' => 'The job ID. [Deprecated]', 'type' => 'string', 'example' => '72dcd26b-f12d-4c27-b3af-18f6aed5b160', 'title' => ''],
'ContactName' => ['description' => 'The contact name.', 'type' => 'string', 'example' => '张三', 'title' => ''],
'Role' => ['description' => 'The contact role. [Deprecated]', 'type' => 'string', 'example' => '*', 'title' => ''],
'ReferenceId' => ['description' => 'The contact ID in the third-party system.', 'type' => 'string', 'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Extras' => [
'description' => 'The list of business parameters.'."\n"
."\n"
.'> TenantId and ServiceId are generated by the system. Other parameters are custom-defined and passed in by the caller.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The key of the business parameter.', 'type' => 'string', 'example' => 'name', 'title' => ''],
'Value' => ['description' => 'The value of the business parameter.', 'type' => 'string', 'example' => '张三', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Summary' => [
'description' => 'The conversation label data.'."\n"
."\n"
.'In large model scenarios, this contains the label hit data after the conversation ends.'."\n"
."\n"
.'In small model scenarios, this contains the variable value data after the conversation ends.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SummaryName' => ['description' => 'The label name.', 'type' => 'string', 'example' => 'score', 'title' => ''],
'Category' => ['description' => 'The conversation summary category.', 'type' => 'string', 'example' => ' {}', 'title' => ''],
'Content' => ['description' => 'The label value.', 'type' => 'string', 'example' => '5', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Tasks' => [
'description' => 'The list of tasks.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The task status. Valid values:'."\n"
.'(Note: The **Succeeded** status has been subdivided into specific reasons. The **Succeeded**: 1 (Connected) status is no longer returned. Instead, a specific sub-reason type is returned.)'."\n"
."\n"
.'- **Executing**: 0 (Dialing).'."\n"
.'- **Succeeded**: 1 (Connected).'."\n"
.'- **NoAnswer**: 2 (Not connected - No answer).'."\n"
.'- **NotExist**: 3 (Not connected - Nonexistent number).'."\n"
.'- **Busy**: 4 (Not connected - Busy).'."\n"
.'- **Cancelled**: 5 (Not dialed - Task stopped).'."\n"
.'- **Failed**: 6 (Failed).'."\n"
.'- **NotConnected**: 7 (Not connected - Unreachable).'."\n"
.'- **PoweredOff**: 8 (Not connected - Powered off).'."\n"
.'- **OutOfService**: 9 (Not connected - Callee out of service).'."\n"
.'- **InArrears**: 10 (Not connected - Callee has overdue payment).'."\n"
.'- **EmptyNumber**: 11 (Not dialed - Nonexistent number, no outbound call).'."\n"
.'- **PerDayCallCountLimit**: 12 (Not dialed - Daily limit exceeded).'."\n"
.'- **ContactBlockList**: 13 (Not dialed - Blacklisted).'."\n"
.'- **CallerNotRegistered**: 14 (Not dialed - Caller number not registered).'."\n"
.'- **Terminated**: 15 (Not dialed - Terminated).'."\n"
.'- **VerificationCancelled**: 16 (Not dialed - Pre-call verification failed, cancelled).'."\n"
.'- **OutOfServiceNoCall**: 17 (Not dialed - Callee out of service, no outbound call).'."\n"
.'- **InArrearsNoCall**: 18 (Not dialed - Callee has overdue payment, no outbound call).'."\n"
.'- **CallingNumberNotExist**: 19 (Not dialed - Caller number does not exist).'."\n"
.'- **SucceededFinish**: 20 (Connected - Normal completion).'."\n"
.'- **SucceededChatbotHangUpAfterNoAnswer**: 21 (Connected - Robot hung up after no recognition).'."\n"
.'- **SucceededChatbotHangUpAfterSilence**: 22 (Connected - Hung up due to silence timeout).'."\n"
.'- **SucceededClientHangUpAfterNoAnswer**: 23 (Connected - User hung up after no recognition).'."\n"
.'- **SucceededClientHangUp**: 24 (Connected - User hung up without reason).'."\n"
.'- **SucceededTransferByIntent**: 25 (Connected - Transferred to agent by intent match).'."\n"
.'- **SucceededTransferAfterNoAnswer**: 26 (Connected - Transferred to agent after no recognition).'."\n"
.'- **SucceededInoInterAction**: 27 (Connected - No interaction from user).'."\n"
.'- **SucceededError**: 28 (Connected - System error interruption).'."\n"
.'- **SucceededSpecialInterceptVoiceAssistant**: 29 (Connected - Special intercept - Voice assistant).'."\n"
.'- **SucceededSpecialInterceptExtensionNumberTransfer**: 30 (Connected - Special intercept - Extension number transfer).'."\n"
.'- **SucceededSpecialInterceptCustomSpecialIntercept**: 31 (Connected - Special intercept - Custom intercept).'."\n"
.'- **HighRiskSipCode**: 32 (Not dialed - High risk, no outbound call).', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''],
'PlanedTime' => ['description' => 'The planned execution time of the task.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579068424883', 'title' => ''],
'ChatbotId' => ['description' => 'The chatbot ID.', 'type' => 'string', 'example' => ' 1234', 'title' => ''],
'ActualTime' => ['description' => 'The actual execution time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579068424883', 'title' => ''],
'CalledNumber' => ['description' => 'The called number.', 'type' => 'string', 'example' => '135****8888', 'title' => ''],
'ScenarioId' => ['description' => 'The scenario ID. This is a legacy parameter. [Deprecated]', 'type' => 'string', 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150', 'title' => ''],
'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', 'title' => ''],
'CallId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => '1528189846043', 'title' => ''],
'CallingNumber' => ['description' => 'The calling number.', 'type' => 'string', 'example' => '0571****3106', 'title' => ''],
'Brief' => ['description' => 'The business result. This is a legacy parameter. [Deprecated]', 'type' => 'string', 'example' => '1', 'title' => ''],
'Duration' => ['description' => 'The duration.', 'type' => 'integer', 'format' => 'int32', 'example' => ' 120', 'title' => ''],
'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'ff44709e-39a6-43ba-959b-20fcabe3e496', 'title' => ''],
'Conversation' => [
'description' => 'The list of conversations.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Speaker' => ['description' => 'The speaker. Valid values: Robot (the robot) and Contact (the contact).', 'type' => 'string', 'example' => 'Robot', 'title' => ''],
'Timestamp' => ['description' => 'The timestamp when the conversation text was stored.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579068424883', 'title' => ''],
'Script' => ['description' => 'The conversation text.', 'type' => 'string', 'example' => '你好,我是**客服', 'title' => ''],
'Summary' => [
'description' => 'The summary information. [Deprecated]',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SummaryName' => ['description' => 'The summary name.', 'type' => 'string', 'example' => '是本人', 'title' => ''],
'Category' => ['description' => 'The category.', 'type' => 'string', 'example' => '标签', 'title' => ''],
'Content' => ['description' => 'The summary content.', 'type' => 'string', 'example' => '是', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Contact' => [
'description' => 'The contact of the task.',
'type' => 'object',
'properties' => [
'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '135****8888', 'title' => ''],
'State' => ['description' => 'The status.', 'type' => 'string', 'example' => 'Available', 'title' => ''],
'ContactId' => ['description' => 'The contact ID.', 'type' => 'string', 'example' => 'db3db762-e421-44c9-9a01-cb423470757c', 'title' => ''],
'Honorific' => ['description' => 'The honorific of the contact. If not specified, this value is the same as the contact name.', 'type' => 'string', 'example' => '张先生', 'title' => ''],
'JobId' => ['description' => 'The job ID. [Deprecated]', 'type' => 'string', 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', 'title' => ''],
'ContactName' => ['description' => 'The contact name.', 'type' => 'string', 'example' => '张三', 'title' => ''],
'Role' => ['description' => 'The role.', 'type' => 'string', 'example' => '*', 'title' => ''],
'ReferenceId' => ['description' => 'The contact ID in the third-party system.', 'type' => 'string', 'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'CallingNumbers' => [
'description' => 'The list of calling numbers.',
'type' => 'array',
'items' => ['description' => 'The list of calling numbers.', 'type' => 'string', 'example' => '["0571****3106"]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query multiple jobs',
'changeSet' => [
['createdAt' => '2024-07-24T07:36:11.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'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"}]',
],
'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 call 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"
."\n"
.'- Scheduling (0)'."\n"
."\n"
.'- Executing (1)'."\n"
."\n"
.'- Succeeded (2)'."\n"
."\n"
.'- Paused (3)'."\n"
."\n"
.'- Failed (4)'."\n"
."\n"
.'- Cancelled (5)'."\n"
."\n"
.'- Drafted (6)', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''],
'ScenarioId' => ['description' => 'Scenario ID (legacy 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' => 'Strategy 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' => 'The failure reason.'."\n"
."\n"
.'- Unknown: An unknown error occurred.'."\n"
."\n"
.'- NoAnswer: The call was not answered.'."\n"
."\n"
.'- InvalidStrategy: The policy is invalid or incorrectly configured.'."\n"
."\n"
.'- TimeUp: The task timed out during scheduling.'."\n"
."\n"
.'- NoStrategy: The policy is empty or was not found.'."\n"
."\n"
.'- CallFailed: The call failed.'."\n"
."\n"
.'- PerDayCallCountLimit: The daily call limit for the phone number was reached.'."\n"
."\n"
.'- ContactBlockList: The phone number is on the blocklist.'."\n"
."\n"
.'- EmptyNumber: The phone number is nonexistent.'."\n"
."\n"
.'- JobPerDayCallCountLimit: The daily call limit for the phone number within the job was reached.'."\n"
."\n"
.'- VerificationCancelled: The call was canceled because it failed pre-call validation.'."\n"
."\n"
.'- ContactSuspended: Calling to the contact is suspended.'."\n"
."\n"
.'- InArrears: The account has an overdue payment.'."\n"
."\n"
.'- OutOfService: The phone number is out of service.'."\n"
."\n"
.'- NoneRepeatableJobMaxAttemptCountLimit: The non-repeatable job reached the maximum number of attempts.', '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' => 'Phone number', 'type' => 'string', 'example' => '134********', 'title' => ''],
'State' => ['description' => 'Deprecated', 'type' => 'string', 'example' => 'Available', 'title' => ''],
'ContactId' => ['description' => 'Contact ID (system-generated)', 'type' => 'string', 'example' => 'db3db762-e421-44c9-9a01-cb423470757c', 'title' => ''],
'Honorific' => ['description' => 'Honorific (same as 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' => 'Deprecated', 'type' => 'string', 'example' => '*', 'title' => ''],
'ReferenceId' => ['description' => 'Contact third-party system ID (uploaded by 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.',
'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"
.'> Use the DescribeJob API to retrieve this data.',
'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' => 'Conversation summary content', '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' => 'Caller number', 'type' => 'string', 'example' => '0571****3106', 'title' => ''],
'description' => 'Caller number list',
'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' => 'Lists 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' => 'ID of the instance.', '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' => 'Number of entries to return on each 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' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'OutboundCallNumbers' => [
'description' => 'List of outbound call numbers.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'Number of entries on the page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'Total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'List' => [
'description' => 'List of outbound call number data.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Number' => ['description' => 'Phone number.', 'type' => 'string', 'example' => '10088', 'title' => ''],
'OutboundCallNumberId' => ['description' => 'ID of the phone number.', 'type' => 'string', 'example' => ' fa0e21e9-caab-4629-9121-1e341243d599', 'title' => ''],
'RateLimitCount' => ['description' => 'Time window for rate limiting, in seconds.', 'type' => 'string', 'example' => '10', 'title' => ''],
'RateLimitPeriod' => ['description' => 'Maximum number of calls allowed in the time window.', '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' => 'List outbound call 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', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'Resource type', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'instance', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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' => ''],
'ResourceTags' => [
'description' => 'Resource tag information',
'example' => '{}',
'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 items', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'List' => [
'description' => 'List of resource tags',
'example' => '[]',
'items' => [
'properties' => [
'Key' => ['description' => 'Tag key', 'type' => 'string', 'example' => 'name', 'title' => ''],
'Value' => ['description' => 'Tag value', 'type' => 'string', 'example' => 'xxx', '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' => 'Lists tags for 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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0f35dd1-0337-402e-9c4f-3a6c2426950a', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ScriptPublishHistories' => [
'description' => 'The script publishing histories.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'List' => [
'description' => 'The data list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PublishTime' => ['description' => 'The publish time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578965079000', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'ScriptId' => ['description' => 'The script ID.', 'type' => 'string', 'example' => '29420f65-8f1f-4009-b2f8-f4f7b5d59090', 'title' => ''],
'Description' => ['description' => 'The description of this published version.', 'type' => 'string', 'example' => '第一次发布', 'title' => ''],
'ScriptVersion' => ['description' => 'The script version.', 'type' => 'string', 'example' => '1578965079000', 'title' => ''],
],
'description' => 'An entry in the data list.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => 'The response data.',
'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' => 'Retrieves the publication history of the small model for outbound calls.',
'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 of the recording',
'enumValueTitles' => [],
'type' => 'string',
'required' => true,
'example' => 'c209abb3-6804-4a75-b2c7-dd55c8c61b6a'."\n",
'title' => '',
],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'Scenario ID of the recording', 'type' => 'string', 'required' => true, 'example' => 'd004cfd2-6a81-491c-83c6-cbe186620c95'."\n", 'title' => ''],
],
[
'name' => 'UuidsJson',
'in' => 'query',
'schema' => ['description' => 'Recording ID list'."\n"
."\n"
.'> This is a list of unique recording IDs. If left blank, all recordings display.', 'type' => 'string', 'required' => false, 'example' => '["d17d5bfa-4972-4389-9718-f9602edabe48"]', 'title' => ''],
],
[
'name' => 'StatesJson',
'in' => 'query',
'schema' => ['description' => 'Recording status'."\n"
."\n"
.'- Validating: 1'."\n"
."\n"
.'- Validation failed: 2'."\n"
."\n"
.'- Processing: 3'."\n"
."\n"
.'- Processing failed: 4'."\n"
."\n"
.'- Reviewing: 5'."\n"
."\n"
.'- Review failed: 6'."\n"
."\n"
.'- Publish failed: 7'."\n"
."\n"
.'- Published: 8'."\n"
."\n"
.'- Pending publish: 9', 'type' => 'string', 'required' => false, 'example' => '['."\n"
.' "8"'."\n"
.']', 'title' => ''],
],
[
'name' => 'Search',
'in' => 'query',
'schema' => ['description' => 'Search criteria: Search 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 per page', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''],
],
[
'name' => 'RefIdsJson',
'in' => 'query',
'schema' => ['description' => 'Recording ID list (JSON format), same as UuidsJson', 'type' => 'string', 'required' => false, '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' => 'Success', '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' => 'Recording list',
'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' => 'State 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' => 'Scenario ID of the recording', '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' => 'Recording upload time', '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 within the instance', 'type' => 'string', 'example' => '000003'."\n", 'title' => ''],
'RefId' => ['description' => 'The unique ID of the recording.', 'type' => 'string', '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. Use this operation 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' => '*'],
],
],
],
],
],
'ListScriptVariables' => [
'summary' => 'Queries the variables that are currently used in a scenario.',
'methods' => ['post'],
'schemes' => ['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' => 'The instance ID (also referred to as the business ID).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2e55ad0f-7a07-420e-a9b0-62d66ba7278a', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => true, 'example' => '62318d71-1128-4fd7-af15-c852cbe26b93', 'title' => ''],
],
[
'name' => 'Sandbox',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the environment is a test environment.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true:测试环境'."\n"
.'false:发布后的正式环境'."\n"
.'默认为false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Variables' => [
'description' => 'The list of variables.',
'type' => 'array',
'items' => [
'description' => 'The variable object.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the variable.', 'type' => 'string', 'example' => 'name', 'title' => ''],
'DisplayName' => ['description' => 'The display name of the variable.', 'type' => 'string', 'example' => '姓名', 'title' => ''],
'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '表示客户的真实姓名', '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' => ''],
],
],
'title' => 'Query the list of variables configured in a scenario',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"Success\\": true,\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"name\\",\\n \\"DisplayName\\": \\"姓名\\",\\n \\"Description\\": \\"表示客户的真实姓名\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListScriptVoiceConfigs' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The ID of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f95c7ca6-872c-4765-8493-165a8dfc682d', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The 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' => 'The paginated list of script voice configurations.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'List' => [
'description' => 'An array of script voice configuration objects.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The voice type.', 'type' => 'string', 'example' => 'TTS', 'title' => ''],
'ScriptVoiceConfigId' => ['description' => 'The ID of the voice configuration.', 'type' => 'string', 'example' => '2c8fa91f-9856-4145-90f2-08252f09bc18', 'title' => ''],
'ScriptContent' => ['description' => 'The text content of the script.', 'type' => 'string', 'example' => '请问你是 @name 吗', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'bdd49242-114c-4045-b1d1-25ccc1756c75', 'title' => ''],
'ScriptId' => ['description' => 'The script ID.', 'type' => 'string', 'example' => 'a7441a05-43bb-4a2d-acb0-365f245d7a5b', 'title' => ''],
'ScriptWaveformRelation' => ['description' => 'The relationship between the script and the audio file.', 'type' => 'string', 'example' => '""', 'title' => ''],
'Source' => ['description' => 'The source of the script.', 'type' => 'string', 'example' => 'DIALOGUE_FLOW', 'title' => ''],
],
'description' => 'The details of a script voice configuration.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => 'The returned data.',
'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' => 'Lists the audio in a legacy canvas scene.',
'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' => 'View 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' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bdd49242-114c-4045-b1d1-25ccc1756c75', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
[
'name' => 'ScriptName',
'in' => 'query',
'schema' => ['description' => 'The name of the script.', 'type' => 'string', 'required' => false, 'example' => '课程满意度回访', 'title' => ''],
],
[
'name' => 'NluEngine',
'in' => 'query',
'schema' => ['description' => 'The NLU engine.'."\n"
."\n"
.'- Leave this parameter empty to query scripts that use small models.'."\n"
."\n"
.'- Set this parameter to `Prompts` to query scripts that use the text completion mode of a large model.'."\n"
."\n"
.'- Set this parameter to `SSE_FUNCTION` to query scripts that use the function calling mode of a large model.'."\n"
."\n"
.'- Set this parameter to `BeeBot` to query scripts that use the workflow configuration mode of a large model.', 'type' => 'string', 'required' => false, 'example' => 'Prompts', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Scripts' => [
'description' => 'The paginated list of scripts.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of scripts.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''],
'List' => [
'description' => 'The list of scripts.',
'type' => 'array',
'items' => [
'description' => 'The list of scripts.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The script status.', 'type' => 'string', 'example' => 'DRAFTED', 'title' => ''],
'UpdateTime' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578965079000', 'title' => ''],
'ScriptId' => ['description' => 'The script ID.', 'type' => 'string', 'example' => '8d6a6e41-8093-49af-a9d1-0281878758ac', 'title' => ''],
'IsDebugDrafted' => ['description' => 'Indicates whether the debug version of the script is a draft.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Industry' => ['description' => 'The industry.', 'type' => 'string', 'example' => '金融', 'title' => ''],
'ScriptDescription' => ['description' => 'The script description.', 'type' => 'string', 'example' => '电话销售话术', 'title' => ''],
'IsDrafted' => ['description' => 'Indicates whether the script is a draft.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DebugStatus' => ['description' => 'The debug status.', 'type' => 'string', 'example' => 'DRAFTED', 'title' => ''],
'MiniPlaybackEnable' => ['description' => 'Indicates whether mini playback is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'RejectReason' => ['description' => 'The rejection reason.', 'type' => 'string', 'example' => '话术用语不合规', 'title' => ''],
'Scene' => ['description' => 'The scene.', 'type' => 'string', 'example' => '电销', 'title' => ''],
'ScriptName' => ['description' => 'The script name.', 'type' => 'string', 'example' => '电话销售话术', 'title' => ''],
'NewBargeInEnable' => ['description' => 'Indicates whether graceful barge-in is enabled. This parameter is always false for LLM-based scripts.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'LongWaitEnable' => ['description' => 'Indicates whether long wait is enabled. This parameter is always false for LLM-based scripts.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'EmotionEnable' => ['description' => 'Indicates whether emotion detection is enabled. This parameter is always false for LLM-based scripts.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'IsPreset' => ['description' => 'Indicates whether the script is for a preset scene.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'AgentKey' => ['description' => 'The agent access key.', 'type' => 'string', 'example' => '14791f5f226b4878b3d9b676a0291234', 'title' => ''],
'AgentLlm' => ['description' => 'Indicates whether the agent is an LLM agent.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'agentId' => ['description' => 'The agent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1160195', 'title' => ''],
'NluEngine' => ['description' => 'The NLU engine, which is set to Prompts for LLM scenarios and is empty for small model scenarios.', 'type' => 'string', 'example' => '空或者Prompts', 'title' => ''],
'NluAccessType' => ['description' => 'The NLU access type, which is set to Managed for LLM scenarios and is empty for small model scenarios.', 'type' => 'string', 'example' => '空或者Managed', 'title' => ''],
'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578965079000', 'title' => ''],
'NluProfile' => [
'description' => 'The Function Compute configuration for function calling mode.',
'type' => 'object',
'properties' => [
'FcFunction' => ['description' => 'The function name.', 'type' => 'string', 'example' => 'sanfang_test', 'title' => ''],
'FcRegion' => ['description' => 'The function region.', 'type' => 'string', 'example' => 'cn-shanghai'."\n", 'title' => ''],
'FcHttpTriggerUrl' => ['description' => 'The URL of the function 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',
'enumValueTitles' => ['INSTANCE' => 'INSTANCE'],
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'INSTANCE',
'title' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token to start the next query', 'type' => 'string', 'required' => false, 'example' => 'b949ae1f-01dc-4191-ae5a-70fbe6772fd8', 'title' => ''],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of resource IDs. The value range of n is \\[1, 50].',
'type' => 'array',
'items' => ['description' => 'The resource ID. If the resource type is INSTANCE, enter 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' => 'The list of tags.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key. The value range of n is \\[1, 20].', 'type' => 'string', 'required' => false, 'example' => 'Tag.1.Key=key1', 'title' => ''],
'Value' => ['description' => 'The 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' => 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 to start the next query', 'type' => 'string', 'example' => 'b949ae1f-01dc-4191-ae5a-70fbe6772fd8', 'title' => ''],
'RequestId' => ['description' => 'The request ID', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call is successful', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code of the API', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message of the API', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'TagResources' => [
'description' => '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 tag relationships for resources.',
'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' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The ID of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8a4c6d3d-5ed6-44ca-b779-16c20f8862be', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'TagGroups' => [
'description' => 'The list of tag groups.',
'items' => [
'properties' => [
'TagGroupId' => ['description' => 'The ID of the tag group.', 'type' => 'string', 'example' => '38c03261-9fe8-4b9b-8c3b-983a60319012', 'title' => ''],
'TagGroupIndex' => ['description' => 'The index of the tag group.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TagGroup' => ['description' => 'The name of the tag group.', 'type' => 'string', 'example' => '当前学历', 'title' => ''],
'ScriptId' => ['description' => 'The ID of the script.', 'type' => 'string', 'example' => '365b955d-6f4d-4ab5-a6e1-9a301307f4b1', 'title' => ''],
],
'type' => 'object',
'description' => 'A tag group.',
'title' => '',
'example' => '',
],
'type' => 'array',
'title' => '',
'example' => '',
],
'Tags' => [
'description' => 'The list of tags.',
'items' => [
'properties' => [
'TagGroup' => ['description' => 'The name of the tag group.', 'type' => 'string', 'example' => '当前学历', 'title' => ''],
'TagName' => ['description' => 'The name of the tag.', 'type' => 'string', 'example' => '本科', 'title' => ''],
'TagIndex' => ['description' => 'The index of the tag.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'ScriptId' => ['description' => 'The ID of the script.', 'type' => 'string', 'example' => '8a4c6d3d-5ed6-44ca-b779-16c20f8862be', 'title' => ''],
'TagId' => ['description' => 'The ID of the tag.', 'type' => 'string', 'example' => 'd62be647-6202-4b1f-9708-0baeec552635', 'title' => ''],
],
'type' => 'object',
'description' => 'A tag.',
'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' => 'Queries the tags of a script. This is a 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' => '', 'description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd'],
],
[
'name' => 'AgentProfileId',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'Agent configuration ID'."\n"
."\n"
.'> Get the agent configuration ID for created scenarios from the ChatbotId return parameter of DescribeScript.', 'type' => 'string', 'required' => true, 'example' => '37ca3ca1ac4b4e57adf3da5b5d939d04'],
],
[
'name' => 'PromptJson',
'in' => 'formData',
'schema' => ['title' => '', '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' => '', 'description' => 'Prompt (Professional Mode)', 'type' => 'string', 'required' => false, 'example' => '\\n名称:安妮 \\n身份:游戏推广员\\n背景:通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。\\n技能:作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。\\n约束条件:你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\n明确活动的起止时间,确保玩家不会混淆。\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。'],
],
[
'name' => 'Model',
'in' => 'formData',
'schema' => ['description' => 'Model ID', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'model_001'],
],
[
'name' => 'ModelConfig',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'Model configuration', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
[
'name' => 'VariablesJson',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'Variable configuration', 'type' => 'string', 'required' => false, 'example' => '[{'."\n"
.' "name": "开始时间",'."\n"
.' "description": "开始时间"'."\n"
.'}, {'."\n"
.' "name": "结束时间",'."\n"
.' "description": "结束时间"'."\n"
.'}]'],
],
[
'name' => 'LabelsJson',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'Label description', 'type' => 'string', 'required' => false, 'example' => '[{'."\n"
.' "name": "是否满意",'."\n"
.' "description": "对介绍的游戏内容是否感兴趣",'."\n"
.' "valueList": "[\\"有兴趣\\",\\"没兴趣\\"]"'."\n"
.'}]'],
],
[
'name' => 'Scenario',
'in' => 'formData',
'schema' => ['description' => 'Scenario', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '测试场景'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => 'Description', 'type' => 'string', 'title' => '', '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 plug-in configuration'."\n"
."\n"
.'> To bind multiple APIs, get the UUIDs of multiple APIs through ListApiPlugins and fill 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 category ID',
'type' => 'array',
'items' => ['description' => 'FAQ category ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30000474726', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', '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' => ['description' => 'Creation time', 'type' => 'string', 'title' => '', 'example' => '1721356124220'],
'UpdateTime' => ['description' => 'Modification time', 'type' => 'string', 'title' => '', 'example' => '1715416630.0'],
'AgentProfileId' => ['title' => '', 'description' => 'Agent configuration ID', 'type' => 'string', 'example' => '3d7d253cfb77476da0cf3681bcf7b4e8'],
'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'title' => '', 'example' => '788066f2-f160-458e-a3bb-83e1c9d5606d'],
'ScriptId' => ['title' => '', 'description' => 'Scenario ID', 'type' => 'string', 'example' => '3eacaec0-64ba-4008-9392-1d419b0d2673'],
'AgentType' => ['title' => '', 'description' => 'Agent Type', 'type' => 'string', 'example' => 'Human'],
'PromptJson' => ['title' => '', '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' => '', 'description' => 'Prompt (Professional Mode)', 'type' => 'string', 'example' => '\\n名称:安妮 \\n身份:游戏推广员\\n背景:通过电话向玩家宣传最新福利活动,确保每一位玩家都能及时掌握信息,享受游戏的乐趣。\\n技能:作为游戏客服,向用户推荐限时游戏福利活动,强调福利亮点并告知参与流程。\\n约束条件:你需要记住你是安妮,来自于热门游戏客服团队,专注于通过电话向玩家宣传最新福利活动。\\n作为主动联系玩家的客服,需要根据玩家是否想了解活动的意图来选择是否介绍。\\n保持通话的专业性,同时语言平易近人,确保玩家轻松理解活动内容。\\n明确活动的起止时间,确保玩家不会混淆。\\n强调活动的重点奖励和参与方式,提升玩家的参与兴趣。'."\n"],
'AgentProfileTemplateId' => ['title' => '', 'description' => 'Agent Template ID', 'type' => 'string', 'example' => 'default-survey'],
'Model' => ['description' => 'Model ID', 'type' => 'string', 'title' => '', 'example' => 'model_002'],
'ModelConfig' => ['title' => '', 'description' => 'Model configuration', 'type' => 'string', 'example' => '""'],
'System' => ['description' => 'Is it a system template?', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
'LabelsJson' => ['title' => '', 'description' => 'Label description', 'type' => 'string', 'example' => '[{'."\n"
.' "name": "是否满意",'."\n"
.' "description": "对介绍的游戏内容是否感兴趣",'."\n"
.' "valueList": "[\\"有兴趣\\",\\"没兴趣\\"]"'."\n"
.'}]'],
'VariablesJson' => ['title' => '', 'description' => 'Variable configuration', 'type' => 'string', 'example' => '[{'."\n"
.' "name": "开始时间",'."\n"
.' "description": "开始时间"'."\n"
.'}, {'."\n"
.' "name": "结束时间",'."\n"
.' "description": "结束时间"'."\n"
.'}]'],
'Scenario' => ['description' => 'Scenario', 'type' => 'string', 'title' => '', 'example' => 'default'],
'Description' => ['description' => 'Description', 'type' => 'string', 'title' => '', '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 plug-in configuration', 'type' => 'string', 'example' => '[]', 'title' => ''],
'NluConfigJson' => ['description' => 'NLU configuration, parameter settings:'."\n"
."\n"
.'- chatbotInstanceId Xiaomi Large Language Model (LLM) robot instance ID'."\n"
."\n"
.'- faqCategoryIds bound FAQ category ID'."\n"
."\n"
.'- llmAgentId Xiaomi Large Language Model (LLM) workspace ID'."\n"
."\n"
.'- llmAgentKey Xiaomi Large Language Model (LLM) workspace key'."\n"
."\n"
.'- llmAgentInstanceId Xiaomi Large Language Model (LLM) workspace instance ID', 'type' => 'string', 'example' => '{'."\n"
.' "chatbotInstanceId": "chatbot-cn-j7eiVJZRmb",'."\n"
.' "faqCategoryIds": [30000474726],'."\n"
.' "llmAgentId": "1246206",'."\n"
.' "llmAgentInstanceId": "outbound_05efb75a-95df-438e-9b9b-8f2c857d5498",'."\n"
.' "llmAgentKey": "d682716514814815ae77757c0bcbda01_p_outbound_public"'."\n"
.'}', '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' => ['description' => 'Annotation task ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'c88cc004-de69-4eee-aa5f-2efed533a54e'],
],
[
'name' => 'AnnotationMissionName',
'in' => 'query',
'schema' => ['description' => 'Annotation task name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '询问卖车-标注任务-20230506-112934'],
],
[
'name' => 'AnnotationStatus',
'in' => 'query',
'schema' => [
'description' => 'Annotation task status.',
'enumValueTitles' => [1 => 'In progress', 'Completed', 'Shutdown'],
'type' => 'integer',
'format' => 'int32',
'title' => '',
'required' => false,
'example' => '2',
],
],
[
'name' => 'Delete',
'in' => 'query',
'schema' => ['description' => 'Delete the task.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse\\\\',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the call succeeded. true: The call succeeded. false: The call failed.', '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' => 'Response 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' => 'Updates the status and name of an annotation task.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => ['description' => 'The job group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c6a668d1-3145-4048-9101-cb3678bb8884', 'title' => ''],
],
[
'name' => 'BatchJobName',
'in' => 'query',
'schema' => ['description' => 'The job name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '催收作业组', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the job group.', 'type' => 'string', 'required' => false, 'example' => '这是催收作业组-01', 'title' => ''],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'c6a668d1-3145-4048-9101-cb3678bb8884', 'title' => ''],
],
[
'name' => 'StrategyJson',
'in' => 'query',
'schema' => ['description' => 'The policy in the 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' => 'The download URL of the Excel file for the job.', '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. \\`false\\` submits the job. \\`true\\` saves the job as a draft.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => false, 'example' => '7d820242-f4f0-4d2e-ae35-b424c41cbc5b', 'title' => ''],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The calling numbers.',
'type' => 'array',
'items' => ['description' => 'A calling number.', 'type' => 'string', 'required' => false, 'example' => '["0591***212"]', 'title' => ''],
'required' => false,
'example' => '["95187"]',
'maxItems' => 99,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code of the API call.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned for the API call.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'JobGroup' => [
'description' => 'The information about the job group.',
'type' => 'object',
'properties' => [
'CreationTime' => ['description' => 'The time when the job group was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579068424000', 'title' => ''],
'JobGroupId' => ['description' => 'The job group ID.', 'type' => 'string', 'example' => '5a7e8b09-baf9-4cab-b540-c971f47a7146', 'title' => ''],
'ScenarioId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => '6cea9bed-63e6-439e-ae4c-b3333efff53d', 'title' => ''],
'JobGroupName' => ['description' => 'The name of the job group.', 'type' => 'string', 'example' => '第一个催收作业组', 'title' => ''],
'JobFilePath' => ['description' => 'The key of the job file after it is uploaded.', 'type' => 'string', 'example' => '52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx', 'title' => ''],
'JobGroupDescription' => ['description' => 'The description of the job group.', 'type' => 'string', 'example' => '第一个催收作业组', 'title' => ''],
'CallingNumbers' => [
'type' => 'array',
'items' => ['description' => 'A list of calling numbers.', 'type' => 'string', 'example' => '["1****6"]', 'title' => ''],
'description' => 'The list of calling numbers.',
'title' => '',
'example' => '',
],
'Strategy' => [
'description' => 'The execution policy.',
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The policy type.', 'type' => 'string', 'example' => 'Repeatable', 'title' => ''],
'StrategyName' => ['description' => 'The policy name.', 'type' => 'string', 'example' => '催收策略', 'title' => ''],
'MaxAttemptsPerDay' => ['description' => 'The maximum number of redials after a call fails.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'FollowUpStrategy' => ['description' => 'The follow-up action after an execution epoch ends.', 'type' => 'string', 'example' => 'CONTINUE', 'title' => ''],
'EndTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2209702074000', 'title' => ''],
'Customized' => ['description' => 'The custom data for the policy.', 'type' => 'string', 'example' => '{}', 'title' => ''],
'IsTemplate' => ['description' => 'Indicates whether the policy is a template.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'StartTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578550074000', 'title' => ''],
'StrategyId' => ['description' => 'The policy ID.', 'type' => 'string', 'example' => 'f718798d-96be-40e4-bef6-317b54855708', 'title' => ''],
'RoutingStrategy' => ['description' => 'The number routing policy.', 'type' => 'string', 'example' => 'LocalFirst', 'title' => ''],
'MinAttemptInterval' => ['description' => 'The interval between redials.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'StrategyDescription' => ['description' => 'The policy description.', 'type' => 'string', 'example' => '催收作业执行策略', 'title' => ''],
'RepeatBy' => ['description' => 'The repeat mode.', 'type' => 'string', 'example' => 'Once', 'title' => ''],
'WorkingTime' => [
'description' => 'The time frames during which the policy is executed.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '1581997093000', 'title' => ''],
'BeginTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '1581937093000', 'title' => ''],
],
'description' => 'A time frame during which the policy is executed.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RepeatDays' => [
'type' => 'array',
'items' => ['description' => 'A day of the week on which to repeat the execution.', 'type' => 'string', 'example' => '[1,2,3,4,5]', 'title' => ''],
'description' => 'The days of the week on which to repeat the 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 batch jobs. 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' => 'Modify the intent for a small-model scenario.',
'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' => 'Return 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' => 'Is successful', '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' => 'Modifies the intent utterance template for a small model scenario.',
'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' => 'Modifies a user utterance for an intent in a Beebot scenario.',
'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' => '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' => 'UserSayId',
'in' => 'query',
'schema' => ['description' => 'The user utterance ID.', 'type' => 'string', 'required' => true, 'example' => '17448458', 'title' => ''],
],
[
'name' => 'UserSayDefinition',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The definition of the user utterance.',
'type' => 'object',
'properties' => [
'IntentId' => ['description' => 'The intent ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10717802', 'title' => ''],
'Content' => ['description' => 'The content of the user utterance.', 'type' => 'string', 'required' => true, 'example' => '你知道xxxxx么?'."\n", 'title' => ''],
],
'required' => true,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response.',
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'UserSayId' => ['description' => 'The user utterance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '17448458', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'BeebotRequestId' => ['description' => 'The internal request ID.', 'type' => 'string', 'example' => 'A1F21BF2-CB21-1968-8039-C74699E7DDEB', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned by the API.', '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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0f35dd1-0337-402e-9c4f-3a6c2426950a', 'title' => ''],
],
[
'name' => 'DialogueFlowId',
'in' => 'query',
'schema' => ['description' => 'The dialogue flow ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf', 'title' => ''],
],
[
'name' => 'DialogueFlowDefinition',
'in' => 'query',
'schema' => ['description' => 'A JSON string that defines the structure and logic of the dialogue flow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"transitions":[{"id":"a91c4023","index":1,"source":"cc31e02b","sourceAnchor":0,"target":"946045be","targetAnchor":0}],"nodes":[{"collectedNumberEnabled":false,"content":{"branches":[{"branchId":"f5450420-09ab-11ea-b107-e9059c6a79d8","branchName":"发起对话"}]},"coordinates":{"x":180,"y":134},"id":"cc31e02b","index":0,"interruptible":false,"nodeIndex":0,"shape":"start-html","size":"170*34","type":"start","x":180,"y":134},{"collectedNumberEnabled":false,"content":{"actionParams":"","action":"Hangup"},"coordinates":{"x":487.65625,"y":155},"id":"946045be","index":2,"interruptible":false,"labels":[],"name":"功能节点","nodeIndex":1,"questions":["好的同学,您的情况已了解了,稍后我们会安排资深顾问老师给您做更详细的留学评估以及升学指导,请留意电话接听"],"script":"好的同学,您的情况已了解了,稍后我们会安排资深顾问老师给您做更详细的留学评估以及升学指导,请留意电话接听","shape":"function-html","size":"170*34","type":"transfer","x":500,"y":182}]}', 'title' => ''],
],
[
'name' => 'IsDrafted',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to save the changes as a draft.', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'DialogueFlowDefinition' => ['description' => 'The JSON string that defines the dialogue flow.', 'type' => 'string', 'example' => '{"transitions":[{"id":"a91c4023","index":1,"source":"cc31e02b","sourceAnchor":0,"target":"946045be","targetAnchor":0}],"nodes":[{"collectedNumberEnabled":false,"content":{"branches":[{"branchId":"f5450420-09ab-11ea-b107-e9059c6a79d8","branchName":"发起对话"}]},"coordinates":{"x":180,"y":134},"id":"cc31e02b","index":0,"interruptible":false,"nodeIndex":0,"shape":"start-html","size":"170*34","type":"start","x":180,"y":134},{"collectedNumberEnabled":false,"content":{"actionParams":"","action":"Hangup"},"coordinates":{"x":487.65625,"y":155},"id":"946045be","index":2,"interruptible":false,"labels":[],"name":"功能节点","nodeIndex":1,"questions":["好的同学,您的情况已了解了,稍后我们会安排资深顾问老师给您做更详细的留学评估以及升学指导,请留意电话接听"],"script":"好的同学,您的情况已了解了,稍后我们会安排资深顾问老师给您做更详细的留学评估以及升学指导,请留意电话接听","shape":"function-html","size":"170*34","type":"transfer","x":500,"y":182}]}', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DialogueFlowId' => ['description' => 'The dialogue flow ID.', 'type' => 'string', 'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Succcess', 'title' => ''],
],
'type' => 'object',
'description' => 'The data returned.',
'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' => 'Modifies a dialogue flow. This is a legacy API for the canvas.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'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', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6cc9f5ca-2cb6-4cc7-a46b-2bbfd3e61b22', 'title' => ''],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => ['description' => 'Policy level. Use 2 for business instances.'."\n"
."\n"
.'- 0: system'."\n"
."\n"
.'- 1: tenant'."\n"
."\n"
.'- 2: instance', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
],
[
'name' => 'EmptyNumberNoMoreCalls',
'in' => 'query',
'schema' => ['description' => 'Enable or disable the nonexistent number no-call feature.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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' => ''],
],
'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' => 'Enables or disables the global no-call feature for nonexistent numbers.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e5035654-1745-484a-8c5b-165f7c7bcd79'."\n", 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0fe7f71c-8771-42ef-9bb1-19aa16ae7120', 'title' => ''],
],
[
'name' => 'GlobalQuestionId',
'in' => 'query',
'schema' => ['description' => 'The unique ID of the global question.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ad80de88-1661-445a-92ec-bf88dc45d581', 'title' => ''],
],
[
'name' => 'GlobalQuestionName',
'in' => 'query',
'schema' => ['description' => 'The global question name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '未识别全局问题', 'title' => ''],
],
[
'name' => 'GlobalQuestionType',
'in' => 'query',
'schema' => ['description' => 'The global question type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'COMMON', 'title' => ''],
],
[
'name' => 'Questions',
'in' => 'query',
'schema' => ['description' => 'A JSON string containing an array of questions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["你是谁","你叫什么"]', 'title' => ''],
],
[
'name' => 'Answers',
'in' => 'query',
'schema' => ['description' => 'A JSON string containing an array of answers.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["你好,我是你的专属客服顾问."]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'DialogueQuestionId' => ['description' => 'The ID of the modified global question.', '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' => 'Modifies a global question in the legacy canvas.',
'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' => 'The ID of the Outbound Bot instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', 'title' => ''],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => false, 'example' => '新实例', 'title' => ''],
],
[
'name' => 'InstanceDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the instance.', 'type' => 'string', 'required' => false, 'example' => '这是新的实例', 'title' => ''],
],
[
'name' => 'MaxConcurrentConversation',
'in' => 'query',
'schema' => ['description' => 'The maximum number of concurrent conversations.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '5', 'title' => ''],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'A list of calling numbers.'."\n"
."\n"
.'> This parameter is optional.',
'type' => 'array',
'items' => ['description' => 'A calling number.'."\n"
."\n"
.'> This parameter is optional.', 'type' => 'string', 'required' => false, 'example' => '1**********', 'title' => ''],
'required' => false,
'example' => '["95187"]',
'maxItems' => 99,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Instance' => [
'description' => 'The instance information.',
'type' => 'object',
'properties' => [
'CreationTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578469042851', 'title' => ''],
'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => '第一个实例', 'title' => ''],
'CreatorName' => ['description' => 'The name of the creator.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'MaxConcurrentConversation' => ['description' => 'The maximum number of concurrent conversations.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'OwnerName' => ['description' => 'The name of the owner.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'CreatorId' => ['description' => 'The ID of the creator.', 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '90515b5-6115-4ccf-83e2-52d5bfaf2ddf', 'title' => ''],
'InstanceDescription' => ['description' => 'The 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' => 'Modifies an Outbound Bot 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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3'."\n", 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9b70486f-b1c2-429c-8a24-62798015ab1b', 'title' => ''],
],
[
'name' => 'IntentId',
'in' => 'query',
'schema' => ['description' => 'The intent ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3b9a2b33-50d4-4576-8c68-22498f4bf731', 'title' => ''],
],
[
'name' => 'IntentName',
'in' => 'query',
'schema' => ['description' => 'The intent name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '车险如何办理', 'title' => ''],
],
[
'name' => 'IntentDescription',
'in' => 'query',
'schema' => ['description' => 'The intent description.', 'type' => 'string', 'required' => false, 'example' => '询问车险意图', 'title' => ''],
],
[
'name' => 'Utterances',
'in' => 'query',
'schema' => ['description' => 'The user utterances. The value must be a JSON array of strings.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["车险如何办理"]', 'title' => ''],
],
[
'name' => 'Keywords',
'in' => 'query',
'schema' => ['description' => 'The keywords. The value must be a JSON array of strings.', 'type' => 'string', 'required' => false, 'example' => '[]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'IntentId' => ['description' => 'The intent ID.', 'type' => 'string', 'example' => '3b9a2b33-50d4-4576-8c68-22498f4bf731', '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' => 'Modifies an intent in the legacy canvas. This is a legacy 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 call task group.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => ['description' => 'The job group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3edc0260-6f7c-4de4-8535-09372240618b', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the job group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '修改后的作业组', 'title' => ''],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => ['description' => 'The scenario ID. (This is a legacy parameter. Use `ScriptId` instead.)'."\n"
."\n"
.'> You can pass any value for this legacy parameter, but we recommend using the same value as `ScriptId` for consistency.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'c6a668d1-3145-4048-9101-cb3678bb8884', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the job group.', 'type' => 'string', 'required' => false, 'example' => '修改后的作业组', 'title' => ''],
],
[
'name' => 'StrategyJson',
'in' => 'query',
'schema' => ['description' => 'A JSON string that defines the execution strategy for the job group.'."\n"
."\n"
.'- `id`: The ID of the job group strategy. You can obtain this ID from the `StrategyId` parameter returned by the `DescribeJobGroup` operation.'."\n"
."\n"
.'- `repeatBy`: The frequency of the job. Valid values: `Once` (does not repeat), `Day` (repeats daily), `Week` (repeats weekly), and `Month` (repeats monthly).'."\n"
."\n"
.'- `startTime`: The start time of the strategy.'."\n"
."\n"
.'- `endTime`: The end time of the strategy.'."\n"
."\n"
.'- `workingTime`: The time windows for making outbound calls.'."\n"
."\n"
.'- `maxAttemptsPerDay`: The maximum number of call attempts per day for a number in this job group.'."\n"
."\n"
.'- `minAttemptInterval`: The minimum interval, in minutes, between call retries to the same number.'."\n"
."\n"
.'- `routingStrategy`: The number routing strategy. Valid values: `None` (not specified), `LocalFirst` (prioritizes numbers in the same city), and `LocalProvinceFirst` (prioritizes numbers in the same province).'."\n"
."\n"
.'- `repeatDays`: The specific days to run the job, based on the `repeatBy` value. If `repeatBy` is `Week`, `0` indicates Sunday, and `1` through `6` indicate Monday through Saturday. If `repeatBy` is `Month`, valid values are `1` through `31`. If a month does not have the specified day (for example, day 30 in February), the job does not run on that day.'."\n"
."\n"
.'- `repeatable`: Whether the job is recurring. Valid values are `true` and `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"},"id":"cdca9ed7-6470-42d0-afb3-a41e08b41383",{"beginTime":"14:00:00","endTime":"15:00:00"}],"repeatable":true,"endTime":1707494400000,"startTime":1706976000000,"repeatBy":"Week"}', 'title' => ''],
],
[
'name' => 'RecallStrategyJson',
'in' => 'query',
'schema' => ['description' => 'A JSON string that defines the recall strategy.', 'type' => 'string', 'required' => false, 'example' => '{"emptyNumberIgnore":false,"inArrearsIgnore":false,"outOfServiceIgnore":false}', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The ID of the script for the scenario.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '5a3940ce-a12f-4222-9f0f-605a9b89ea7c', 'title' => ''],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The calling numbers for the job group.',
'type' => 'array',
'items' => ['description' => 'A calling number.', 'type' => 'string', 'required' => false, 'example' => '4008013260', 'title' => ''],
'required' => false,
'maxItems' => 99,
'title' => '',
'example' => '',
],
],
[
'name' => 'JobGroupStatus',
'in' => 'query',
'schema' => ['description' => 'The status of the job group. Valid values:'."\n"
."\n"
.'- `Draft`: The job group is in a draft state.'."\n"
."\n"
.'- `Paused`: The job group is paused.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'Draft', 'title' => ''],
],
[
'name' => 'RingingDuration',
'in' => 'query',
'schema' => ['description' => 'The optimal ringing duration.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25', 'title' => ''],
],
[
'name' => 'MinConcurrency',
'in' => 'query',
'schema' => ['description' => 'The guaranteed minimum number of concurrent calls for the job group. The sum of this value for all job groups with the same priority cannot exceed the instance\'s total concurrency. If you set this parameter to `0`, the system dynamically allocates available lines from a shared pool.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => ['description' => 'The priority of the job group. Valid values:'."\n"
."\n"
.'- **Urgent**: An urgent job.'."\n"
."\n"
.'- **Daily**: A routine job.', 'type' => 'string', 'required' => false, 'example' => 'Daily', 'title' => ''],
],
[
'name' => 'FlashSmsExtras',
'in' => 'query',
'schema' => ['description' => 'The flash SMS configuration, specified as a JSON string. This may include settings for third-party flash SMS services.'."\n"
."\n"
.'`templateId`: The flash SMS template ID.
'."\n"
.'`configId`: The 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' => 'The recall calling numbers.',
'type' => 'array',
'items' => ['description' => 'A recall calling number.', 'type' => 'string', 'required' => false, 'example' => '4008013260', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The API response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'JobGroup' => [
'description' => 'The job group details.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The job group status.', 'type' => 'string', 'example' => 'Scheduling', 'title' => ''],
'ScenarioId' => ['description' => 'The scenario ID.'."\n"
."\n"
.'> This parameter is deprecated. To obtain the `ScriptId`, call the `DescribeJobGroup` operation.', 'type' => 'string', 'example' => '6cea9bed-63e6-439e-ae4c-b3333efff53d', 'title' => ''],
'JobGroupId' => ['description' => 'The job group ID.', 'type' => 'string', 'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9', 'title' => ''],
'CreationTime' => ['description' => 'The creation time.'."\n"
."\n"
.'> Call the `DescribeJobGroup` operation to obtain this value.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578550074361', 'title' => ''],
'JobGroupName' => ['description' => 'The job group name.', 'type' => 'string', 'example' => '第一个催收', 'title' => ''],
'JobFilePath' => ['description' => 'The job file path. \\[Deprecated]', 'type' => 'string', 'example' => 'UPLOADED/JOB/d481cebe-0bb6-4d13-9649-42ce5074fb75/6c7d9132-98e1-4f08-8a76-8a266c7532fd_job_template - 副本.xlsx', 'title' => ''],
'JobGroupDescription' => ['description' => 'The job group description.', 'type' => 'string', 'example' => '催收的作业组', 'title' => ''],
'JobDataParsingTaskId' => ['description' => 'The data parsing task ID. \\[Deprecated]', 'type' => 'string', 'example' => 'e37d28cb-0413-4816-85ed-fd354d025ea3', 'title' => ''],
'ScriptName' => ['description' => 'The script name.', 'type' => 'string', 'example' => '话术', 'title' => ''],
'ScriptVersion' => ['description' => 'The script version.', 'type' => 'string', 'example' => '1628425608429', 'title' => ''],
'ModifyTime' => ['description' => 'The modification time.'."\n"
."\n"
.'> Call the `DescribeJobGroup` operation to obtain this value.', 'type' => 'string', 'example' => '1628425608429', 'title' => ''],
'CallingNumbers' => [
'description' => 'The list of calling numbers.',
'type' => 'array',
'items' => ['description' => 'A calling number.', 'type' => 'string', 'example' => '["4008013260"]', 'title' => ''],
'title' => '',
'example' => '',
],
'ExportProgress' => [
'description' => 'The export progress. \\[Deprecated]',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The export status.', 'type' => 'string', 'example' => 'FINISHED', 'title' => ''],
'FileHttpUrl' => ['description' => 'The file URL.', 'type' => 'string', 'example' => 'https://***.oss-cn-shanghai.aliyuncs.com/sample', 'title' => ''],
'Progress' => ['description' => 'The progress of the export.', 'type' => 'string', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Strategy' => [
'description' => 'The outbound strategy.',
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The strategy type.', 'type' => 'string', 'example' => 'Repeatable', 'title' => ''],
'StrategyName' => ['description' => 'The strategy name.', 'type' => 'string', 'example' => '催收策略', 'title' => ''],
'MaxAttemptsPerDay' => ['description' => 'The maximum attempts per day.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'FollowUpStrategy' => ['description' => 'The action to take when the execution cycle ends. \\[Deprecated]', 'type' => 'string', 'example' => 'CONTINUE', 'title' => ''],
'EndTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2209702074000', 'title' => ''],
'Customized' => ['description' => 'The customized strategy data. \\[Deprecated]', 'type' => 'string', 'example' => '{}', 'title' => ''],
'IsTemplate' => ['description' => 'Indicates whether the strategy is a template. \\[Deprecated]', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'StartTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578550074000', 'title' => ''],
'StrategyId' => ['description' => 'The strategy ID.', 'type' => 'string', 'example' => 'f718798d-96be-40e4-bef6-317b54855708', 'title' => ''],
'RoutingStrategy' => ['description' => 'The routing strategy.', 'type' => 'string', 'example' => 'LocalFirst', 'title' => ''],
'MinAttemptInterval' => ['description' => 'The minimum attempt interval.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'StrategyDescription' => ['description' => 'The strategy description.', 'type' => 'string', 'example' => '催收作业执行策略', 'title' => ''],
'RepeatBy' => ['description' => 'The repeat mode. Valid values: `Once` (runs only once), `Day` (repeats daily), `Week` (repeats weekly), and `Month` (repeats monthly).', 'type' => 'string', 'example' => 'Once', 'title' => ''],
'WorkingTime' => [
'description' => 'The time windows for making outbound calls.',
'type' => 'array',
'items' => [
'description' => 'A working hours range.',
'type' => 'object',
'properties' => [
'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '12:00:00', 'title' => ''],
'BeginTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '09:00:00', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RepeatDays' => [
'description' => 'The days of the week or month on which the job repeats.'."\n"
."\n"
.'If `RepeatBy` is set to `Week`, valid values are `0` to `6`, where `0` represents Sunday, and `1` to `6` represent Monday to Saturday.'."\n"
.'If `RepeatBy` is set to `Month`, valid values are `1` to `31`. If a month is shorter than the specified day (for example, day 31 in February), the job does not run that month.',
'type' => 'array',
'items' => ['description' => 'A day on which the job repeats.', 'type' => 'string', 'example' => '[1,2,3,4,5]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'RecallStrategy' => [
'description' => 'The recall strategy.',
'type' => 'object',
'properties' => [
'EmptyNumberIgnore' => ['description' => 'Indicates whether to ignore an invalid number.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'InArrearsIgnore' => ['description' => 'Indicates whether to ignore a number in arrears.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'OutOfServiceIgnore' => ['description' => 'Indicates whether to ignore an out-of-service number.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RingingDuration' => ['description' => 'The ringing duration.', 'type' => 'integer', 'format' => 'int64', 'example' => '25', 'title' => ''],
'Priority' => ['description' => 'The job group priority. Valid values:'."\n"
."\n"
.'`Urgent`: For high-priority jobs. `Daily`: For standard-priority jobs.', 'type' => 'string', 'example' => 'Daily', 'title' => ''],
'MinConcurrency' => ['description' => 'The minimum number of concurrent calls to reserve for this job group. The sum of this value for all job groups with the same priority cannot exceed the total concurrency of the instance. If set to 0, the system dynamically allocates idle lines from a shared pool.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'FlashSmsExtras' => ['description' => 'Extra parameters for the flash SMS service. The value is a JSON string that contains the configuration for a third-party provider.'."\n"
."\n"
.'`templateId`: The flash SMS template ID. `configId`: The 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 an 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', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8fa1953f-4a84-46d8-b80c-8ce9cf684fb3', 'title' => ''],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => ['description' => 'The number to modify', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10088xxx', 'title' => ''],
],
[
'name' => 'RateLimitPeriod',
'in' => 'query',
'schema' => ['description' => 'Rate limiting time window, in seconds', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100', 'title' => ''],
],
[
'name' => 'RateLimitCount',
'in' => 'query',
'schema' => ['description' => 'Number of rate limiting rules', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
[
'name' => 'OutboundCallNumberId',
'in' => 'query',
'schema' => ['description' => 'Number ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'fa0e21e9-caab-4629-9121-1e341243d599', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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' => ''],
'OutboundCallNumber' => [
'description' => 'Number information',
'properties' => [
'Number' => ['description' => 'Outbound call number', 'type' => 'string', 'example' => '10088xxxx', 'title' => ''],
'OutboundCallNumberId' => ['description' => 'Number ID', 'type' => 'string', 'example' => 'fa0e21e9-caab-4629-9121-1e341243d599', 'title' => ''],
'RateLimitCount' => ['description' => 'Rate limiting period', 'type' => 'string', 'example' => '10', 'title' => ''],
'RateLimitPeriod' => ['description' => 'Rate limiting count', 'type' => 'string', 'example' => '100', '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' => [],
],
'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' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c6320d3c-fa45-4011-b3b1-acdfabe3a8c6', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The ID of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c153d0d8-ba04-41c0-8632-453944c9dd0b', 'title' => ''],
],
[
'name' => 'ScriptName',
'in' => 'query',
'schema' => ['description' => 'The name of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '续费提醒', 'title' => ''],
],
[
'name' => 'ScriptDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the script.', 'type' => 'string', 'required' => false, 'example' => '返工回访话术', 'title' => ''],
],
[
'name' => 'Industry',
'in' => 'query',
'schema' => ['description' => 'The industry.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '电商', 'title' => ''],
],
[
'name' => 'Scene',
'in' => 'query',
'schema' => ['description' => 'The scenario information.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '回访', 'title' => ''],
],
[
'name' => 'ChatbotId',
'in' => 'query',
'schema' => ['description' => 'The ID of the chatbot.', 'type' => 'string', 'required' => false, 'example' => 'chatbot-cn-iFZfi7eq6e', 'title' => ''],
],
[
'name' => 'AsrConfig',
'in' => 'query',
'schema' => ['description' => 'The ASR configuration. Parameter definitions:'."\n"
."\n"
.'- **appKey**: The Alibaba Cloud account appKey.'."\n"
."\n"
.'- **maxEndSilence**: The duration for voice endpoint detection.'."\n"
."\n"
.'- **silenceTimeout**: The silence timeout. Unit: seconds. The system times out after the user is silent for N seconds.'."\n"
."\n"
.'- **engine**: The service to invoke. Valid values: ali, xunfei.'."\n"
."\n"
.'- **nlsServiceType**: The type of the invoked service.'."\n"
."\n"
.' - Managed: Public cloud NLS service.'."\n"
."\n"
.' - Authorized: Authorized NLS service.'."\n"
."\n"
.' - Provided: NLS service provided by the customer through AS/SK.'."\n"
."\n"
.' - Apes: Private cloud service.'."\n"
."\n"
.'- **engineXunfei**: If the caller is xunfei, fill in the corresponding configuration.'."\n"
."\n"
.'> If engine is set to ali and nlsServiceType is set to Authorized, a custom service is used, and the service provider is ali. If engine is set to ali and nlsServiceType is set to Managed, the default service is used. If engine is set to xunfei and nlsServiceType is set to Authorized, the service provider is xunfei. You must fill in the xunfei configuration, such as {"uuid":"ed2xxxxxxxxx","globalMaxEndSilence":700,"globalMaxEndSilenceEnable":true}.'."\n"
."\n"
.'- **globalMaxEndSilence**: Silence detection. Unit: milliseconds.'."\n"
."\n"
.'- **globalMaxEndSilenceEnable**: The switch for silence detection. Default value: enabled.'."\n"
."\n"
.'- **speechNoiseThreshold**: The 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' => 'The TTS configuration. Parameter definitions:'."\n"
."\n"
.'- **voice**: The voice actor.'."\n"
."\n"
.'- **volume**: The volume. Valid values: 0 to 100. Default value: 50.'."\n"
."\n"
.'- **speechRate**: The speech rate. Valid values: -500 to 500. Default value: 0.'."\n"
."\n"
.'- **pitchRate**: The pitch rate. Valid values: -500 to 500. Default value: 0.'."\n"
."\n"
.'- **globalInterruptible**: The voice interruption configuration.'."\n"
."\n"
.'- **engine**'."\n"
."\n"
.' **nlsServiceType**: The type of the invoked service.'."\n"
."\n"
.' - Managed: Public cloud NLS service.'."\n"
."\n"
.' - Authorized: Authorized NLS service.'."\n"
."\n"
.' - Provided: NLS service provided by the customer through AS/SK.'."\n"
."\n"
.' - Apes: Private cloud service.'."\n"
."\n"
.'- **engineXunfei**: The configuration when the service provider is xunfei.'."\n"
."\n"
.'> 1\\. If engine is set to ali and nlsServiceType is set to Authorized, a custom service is used. 2. If the service provider is ali, and engine is set to ali and nlsServiceType is set to Managed, the default service is used. 3. If engine is set to xunfei (applicable to small model scenarios) and nlsServiceType is set to Authorized, the service provider is xunfei. You must fill in the engineXunfei configuration, such as {"pitchRate":50,"speechRate":50,"voice":"aisjiuxu","volume":50}. 4. If engine is set to volc and nlsServiceType is set to Authorized, it indicates that Doubao is applicable.', '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 instances, pass in the script list. This parameter is deprecated.',
'type' => 'array',
'items' => ['description' => 'For notification instances, pass in the script list. This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => '您好,您昨晚在李佳琦直播间下单的娜薇诗椰子水二代精华2支装还未付款,超时未支付会自动关闭订单,活动错过不再有奥。', 'title' => ''],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'ScriptWaveform',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'For notification instances, pass in the script voice list. This parameter is deprecated.',
'type' => 'array',
'items' => ['description' => 'For notification instances, pass in the script voice list. This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'NewBargeInEnable',
'in' => 'query',
'schema' => ['description' => 'The switch for graceful barge-in configuration (small model).', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'LongWaitEnable',
'in' => 'query',
'schema' => ['description' => 'The switch for intelligent sentence segmentation configuration (small model).', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'MiniPlaybackEnable',
'in' => 'query',
'schema' => ['description' => 'The switch for transition phrase configuration (small model).', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'MiniPlaybackConfigListJsonString',
'in' => 'query',
'schema' => ['description' => 'The configuration for transition phrases. Customization is not supported temporarily. Do not pass this parameter by default. This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''],
],
[
'name' => 'NlsConfig',
'in' => 'query',
'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''],
],
[
'name' => 'EmotionEnable',
'in' => 'query',
'schema' => ['description' => 'The switch for emotion detection configuration.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'AgentKey',
'in' => 'query',
'schema' => ['description' => 'The 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 a Large Language Model (LLM) workspace.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['description' => 'The ID of the robot workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1198938', 'title' => ''],
],
[
'name' => 'NluEngine',
'in' => 'query',
'schema' => ['description' => 'The NLU engine (applicable only to Large Language Model (LLM) scenarios).'."\n"
."\n"
.'> After a scenario is created, you cannot modify the scenario mode.'."\n"
."\n"
.'Enumeration:'."\n"
."\n"
.'- Prompts: Text filling mode.'."\n"
."\n"
.'- SSE\\_FUNCTION: Function Compute mode.'."\n"
."\n"
.'- This parameter is empty for non-LLM scenarios.', 'type' => 'string', 'required' => false, 'example' => 'Prompts', 'title' => ''],
],
[
'name' => 'NluAccessType',
'in' => 'query',
'schema' => ['description' => 'The NLU access method (applicable only to Large Language Model (LLM) scenarios).'."\n"
."\n"
.'Enumeration:'."\n"
."\n"
.'- Managed: Access using an Alibaba Cloud public account.'."\n"
."\n"
.'- This parameter is empty for non-LLM scenarios.', 'type' => 'string', 'required' => false, 'example' => 'Managed', 'title' => ''],
],
[
'name' => 'ChatConfig',
'in' => 'query',
'schema' => ['description' => 'The call configuration.'."\n"
."\n"
.'- silenceConfig: Silence configuration.'."\n"
."\n"
.' - silenceReplyTimeout: The timeout period for silence replies, in milliseconds.'."\n"
."\n"
.' - silenceTimeoutMaxCount: Hang up after several rounds of silence timeout.'."\n"
."\n"
.' - silenceTimeoutMaxCountEnable: Indicates whether to hang up on silence.'."\n"
."\n"
.'- hangupConfig: Hang-up configuration.'."\n"
."\n"
.' - aiHangupEnable: AI hang-up. Valid values: true, false.'."\n"
."\n"
.' - delayHangup: Delayed hang-up. Maximum value: 10.'."\n"
."\n"
.' - hangupMaxRounds: Interaction rounds. Maximum value: 100.'."\n"
."\n"
.' - hangupMaxRoundsBroadcast: The script for hang-up broadcast.'."\n"
."\n"
.' - hangupMaxRoundsEnable: Determine the maximum number of interaction rounds. Valid values: true, false.'."\n"
."\n"
.'- securityInterceptConfig: Security block configuration.'."\n"
."\n"
.' - broadcast: The script for block broadcast.'."\n"
."\n"
.'- specialInterceptConfig: Special case block.'."\n"
."\n"
.' - specialInterceptEnable: The switch for special case block.'."\n"
."\n"
.' - specialIntercepts: Special cases.'."\n"
."\n"
.' - voiceAssistant: Voice assistant.'."\n"
."\n"
.' - extensionNumberTransfer: Extension number transfer.'."\n"
."\n"
.'- transitionConfig: Transition phrase model configuration.'."\n"
."\n"
.' - transitionSwitch: The switch for the transition phrase model.', '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' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status of the API.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'Script' => [
'description' => 'The script information.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status of the script.', 'type' => 'string', 'example' => 'PUBLISHED', 'title' => ''],
'UpdateTime' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578881227000', 'title' => ''],
'Industry' => ['description' => 'The industry.', 'type' => 'string', 'example' => '政务', 'title' => ''],
'ScriptDescription' => ['description' => 'The description of the script.', 'type' => 'string', 'example' => '返工回访话术', 'title' => ''],
'IsDrafted' => ['description' => 'Indicates whether the script is a draft.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DebugStatus' => ['description' => 'The debug status of the script.', 'type' => 'string', 'example' => 'DRAFTED', 'title' => ''],
'ScriptId' => ['description' => 'The ID of the script.', 'type' => 'string', 'example' => 'c153d0d8-ba04-41c0-8632-453944c9dd0b', 'title' => ''],
'IsDebugDrafted' => ['description' => 'Indicates whether the script is a debug draft.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ScriptName' => ['description' => 'The name of the script.', 'type' => 'string', 'example' => '回访话术', 'title' => ''],
'Scene' => ['description' => 'The 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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bdd49242-114c-4045-b1d1-25ccc1756c75', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1d7a26e0-628b-4c3c-9918-7f2e23273f54', 'title' => ''],
],
[
'name' => 'ScriptVoiceConfigId',
'in' => 'query',
'schema' => ['description' => 'The script voice configuration ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e15cc646-50e5-4bc0-87ec-e4f2d1063b90', 'title' => ''],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => 'The audio source type.'."\n"
."\n"
.'- WAVEFORM: A pre-recorded audio file.'."\n"
."\n"
.'- TTS: Audio generated from text using the text-to-speech (TTS) service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TTS', 'title' => ''],
],
[
'name' => 'ScriptWaveformRelation',
'in' => 'query',
'schema' => ['description' => 'Maps script segments to audio recordings. This parameter is required only when Type is set to WAVEFORM.'."\n"
."\n"
.'> To obtain the value for the ScriptWaveformId parameter, call the CreateScriptWaveform operation. The ScriptContent parameter specifies the text that corresponds to the audio segment.', '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' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The API message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ScriptVoiceConfig' => [
'description' => 'The voice configuration for the script.',
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The audio source type.', 'type' => 'string', 'example' => 'WAVEFORM', 'title' => ''],
'ScriptVoiceConfigId' => ['description' => 'The script voice configuration ID.', 'type' => 'string', 'example' => '4ddea690-6534-4c88-9cbd-0b5882ec64c0', 'title' => ''],
'ScriptContent' => ['description' => 'The text that corresponds to the audio.', 'type' => 'string', 'example' => '你好', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'bdd49242-114c-4045-b1d1-25ccc1756c75', 'title' => ''],
'ScriptId' => ['description' => 'The script ID.', 'type' => 'string', 'example' => '1d7a26e0-628b-4c3c-9918-7f2e23273f54', 'title' => ''],
'ScriptWaveformRelation' => ['description' => 'Maps script segments to audio recordings.', 'type' => 'string', 'example' => '[{"ScriptContent":"你好","ScriptWaveformId":"6facc560-9f25-420f-bb0b-99f4299ad0d5"},{"ScriptContent":"吗","ScriptWaveformId":"76f48266-e253-4f44-ab4f-f64f7d38f1b4"}]', 'title' => ''],
'Source' => ['description' => 'The 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' => 'Modifies the voice configuration of a script in a legacy canvas.',
'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 model, such as aixia, siyue, or xiaoyun', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'aixia', 'title' => ''],
],
[
'name' => 'SpeechRate',
'in' => 'query',
'schema' => ['description' => 'Speech rate. An integer between -500 and 500. Default is 0.'."\n"
."\n"
.'A value greater than 0 increases speech speed.'."\n"
."\n"
.'A value less than 0 decreases speech speed.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0', 'title' => ''],
],
[
'name' => 'Volume',
'in' => 'query',
'schema' => ['description' => 'Volume. An integer between 0 and 100. Default is 50.'."\n"
."\n"
.'A value greater than 50 increases volume.'."\n"
."\n"
.'A value less than 50 decreases volume.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '100', 'title' => ''],
],
[
'name' => 'NlsServiceType',
'in' => 'query',
'schema' => ['description' => 'The service type.'."\n"
.'Managed: The default public Intelligent Speech Interaction service for Outbound Bot.'."\n"
.'Authorized: A private Intelligent Speech Interaction service that you have purchased. To grant authorization, navigate to Scenario Management > Edit > Call Service > Custom Service.', 'type' => 'string', 'required' => false, 'example' => 'Managed', 'title' => ''],
],
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'AppKey for your Intelligent Speech Interaction project. Required only when NlsServiceType is Authorized.', 'type' => 'string', 'required' => false, 'example' => '99****Aw', 'title' => ''],
],
[
'name' => 'PitchRate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Pitch. An integer between -500 and 500. Default is 0.'."\n"
."\n"
.'A value greater than 0 raises pitch.'."\n"
."\n"
.'A value less than 0 lowers pitch.', '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 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',
'type' => 'object',
'properties' => [
'Voice' => ['description' => 'Voice 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' => '', 'description' => 'Pitch. An integer between -500 and 500. Default is 0.'."\n"
."\n"
.'A value greater than 0 raises pitch.'."\n"
."\n"
.'A value less than 0 lowers pitch.', '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' => 'Update the text-to-speech (TTS) configuration for an existing 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' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cd560e89-0459-4c8a-ad98-47d713e4abd6', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '365b955d-6f4d-4ab5-a6e1-9a301307f4b1', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => 'The 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' => 'The tag groups to modify.', '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' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '5a865b03-d2b9-4ef9-be98-f21fa0d93744', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'TagGroups' => [
'description' => 'The list of tag groups.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagGroupId' => ['description' => 'The ID of the tag group.', 'type' => 'string', 'example' => '54629be9-0746-464a-ab59-4830242cf644', 'title' => ''],
'TagGroupIndex' => ['description' => 'The position of the tag group.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TagGroup' => ['description' => 'The name of the tag group.', 'type' => 'string', 'example' => '标签组', 'title' => ''],
'ScriptId' => ['description' => 'The script ID.', 'type' => 'string', 'example' => '365b955d-6f4d-4ab5-a6e1-9a301307f4b1', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Tags' => [
'description' => 'The list of tags.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagGroup' => ['description' => 'The name of the tag group.', 'type' => 'string', 'example' => '当前学历', 'title' => ''],
'TagName' => ['description' => 'The name of the tag.', 'type' => 'string', 'example' => '本科', 'title' => ''],
'TagIndex' => ['description' => 'The index of the tag.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'ScriptId' => ['description' => 'The script ID.', 'type' => 'string', 'example' => '8a4c6d3d-5ed6-44ca-b779-16c20f8862be', 'title' => ''],
'TagId' => ['description' => 'The unique ID of the tag.', 'type' => 'string', 'example' => '19b23e92-4ee3-4129-8c2e-e1968670d887', 'title' => ''],
],
'description' => 'The 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' => 'Modifies tag groups for the legacy canvas interface.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The 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' => 'A description of the publication.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '本次发布了xxxx内容', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', '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' => 'Publishing 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' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The ID of the script.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0bfe34e5-a7fa-4aac-91d4-bd798518dffc', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '5a865b03-d2b9-4ef9-be98-f21fa0d93744', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', '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' => 'Publishes the debug version of a script.',
'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' => 'Queries a list of jobs.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => ['description' => 'The scenario ID. This is a legacy parameter and has been deprecated.', 'type' => 'string', 'required' => false, 'example' => 'b0f35dd1-0337-402e-9c4f-3a6c2426950a', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => ['description' => 'The job group ID.', 'type' => 'string', 'required' => false, 'example' => '994b8baf-7ef8-480c-b141-b7b6db77c4df', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The filter condition for the start time. Default value: 0, which indicates the start of the current day.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1579068424883', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The filter condition for the end time. Default value: 0, which indicates the current time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1579077794665', '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.', 'type' => 'string', 'required' => false, 'example' => 'start', 'title' => ''],
],
[
'name' => 'ContactName',
'in' => 'query',
'schema' => ['description' => 'The filter condition for the contact name.', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => ['description' => 'The filter condition for the contact phone number.', 'type' => 'string', 'required' => false, 'example' => '135****8888', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The response code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Jobs' => [
'description' => 'The job data.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'List' => [
'description' => 'The list of jobs.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The job status. Valid values:'."\n"
.'- Scheduling(0): Scheduling.'."\n"
.'- Executing(1): Executing.'."\n"
.'- Succeeded(2): Completed - Reached.'."\n"
.'- Paused(3): Paused.'."\n"
.'- Failed(4): Completed - Not reached.'."\n"
.'- Cancelled(5): Cancelled - Manual intervention.'."\n"
.'- Drafted(6): Draft.', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''],
'JobGroupId' => ['description' => 'The job group ID.', 'type' => 'string', 'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8', 'title' => ''],
'ScenarioId' => ['description' => 'The scenario ID. This is a legacy parameter and has been deprecated.', 'type' => 'string', 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150', 'title' => ''],
'StrategyId' => ['description' => 'The strategy ID.', 'type' => 'string', 'example' => 'c8a2b7f2-ad1a-4865-b872-d0080d9802d9', 'title' => ''],
'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8', 'title' => ''],
'Priority' => ['description' => 'The priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'FailureReason' => ['description' => 'The failure reason. Valid values:'."\n"
.'- Unknown: Unknown error. '."\n"
.'- NoAnswer: No answer.'."\n"
.'- InvalidStrategy: Invalid strategy. The strategy configuration is incorrect.'."\n"
.'- TimeUp: Timeout detected during scheduling.'."\n"
.'- NoStrategy: The strategy is empty or not found.'."\n"
.'- CallFailed: Call failed.'."\n"
.'- PerDayCallCountLimit: Daily call count limit for the number reached.'."\n"
.'- ContactBlockList: The number is on the blocked list.'."\n"
.'- EmptyNumber: Nonexistent number. No further outbound calls.'."\n"
.'- JobPerDayCallCountLimit: Daily call count limit for the number reached.'."\n"
.'- VerificationCancelled: Pre-call verification failed and the call was cancelled.'."\n"
.'- ContactSuspended: Call suspended.'."\n"
.'- InArrears: Overdue payment.'."\n"
.'- OutOfService: Out of service.', 'type' => 'string', 'example' => 'NoAnswer', 'title' => ''],
'ReferenceId' => ['description' => 'The associated business ID.', 'type' => 'string', 'example' => 'd5971d98-7312-4f0e-a918-a17d67133e28', 'title' => ''],
'Contacts' => [
'description' => 'The contact information. This parameter has been deprecated.'."\n"
."\n"
.'> You can retrieve this information by calling the DescribeJob operation.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '135****8888', 'title' => ''],
'State' => ['description' => 'The status. Valid values:'."\n"
.'- Available: Normal.'."\n"
.'- WrongNumber: Wrong number.'."\n"
.'- DoesNotExist: Nonexistent number.'."\n"
.'- Suspended: Call suspended.', 'type' => 'string', 'example' => 'Available', 'title' => ''],
'ContactId' => ['description' => 'The contact ID.', 'type' => 'string', 'example' => 'db3db762-e421-44c9-9a01-cb423470757c', 'title' => ''],
'Honorific' => ['description' => 'The honorific title.', 'type' => 'string', 'example' => '张先生', 'title' => ''],
'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'fce6c599-8ede-40e3-9f78-0928eda7b4e8'."\n", 'title' => ''],
'ContactName' => ['description' => 'The contact name.', 'type' => 'string', 'example' => '张三', 'title' => ''],
'Role' => ['description' => 'The role.', 'type' => 'string', 'example' => '*', 'title' => ''],
'ReferenceId' => ['description' => 'The associated business ID.', 'type' => 'string', 'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Extras' => [
'description' => 'The business data. Displays label collection results for large language model scenarios.'."\n"
."\n"
.'> Keys equal to TenantId or ServiceId are system parameters.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The business data key.', 'type' => 'string', 'example' => 'djrq', 'title' => ''],
'Value' => ['description' => 'The business data value.', 'type' => 'string', 'example' => '2019-08-21 09:49:59.0', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Summary' => [
'description' => 'The conversation summary. This is a legacy field and is no longer in use. Deprecated.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SummaryName' => ['description' => 'The summary name.', 'type' => 'string', 'example' => 'score', 'title' => ''],
'GroupId' => ['description' => 'The job group ID.', 'type' => 'string', 'example' => 'ba1ba502-d044-48c0-b710-0f1f840a7c53', 'title' => ''],
'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'b72425bd-7871-4050-838e-033d80d754b7'."\n", 'title' => ''],
'Category' => ['description' => 'The category.', 'type' => 'string', 'example' => '{}', 'title' => ''],
'TaskId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => '9fdf7a81-6781-4ab8-92fb-1d4231ef365e', 'title' => ''],
'Content' => ['description' => 'The content.', 'type' => 'string', 'example' => '5', 'title' => ''],
'ConversationDetailId' => ['description' => 'The call record ID.', 'type' => 'string', 'example' => '098b9b09-9223-4a8b-a422-99726f0457f3', 'title' => ''],
'SummaryId' => ['description' => 'The summary ID.', 'type' => 'string', 'example' => 'dc67d544-df06-4625-ae48-13e3c9f72d8a', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Tasks' => [
'description' => 'The call list. This parameter has been deprecated.'."\n"
."\n"
.'> You can retrieve this information by calling the searchTask operation.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The task status. Note: The Succeeded status has been subdivided into specific reason types. The Succeeded: 1 (Connected) status is no longer returned. Instead, the specific sub-reason type is returned. Valid values:'."\n"
."\n"
.'- Executing: 0 (Dialing).'."\n"
.'- Succeeded: 1 (Connected).'."\n"
.'- NoAnswer: 2 (Not connected - No answer).'."\n"
."\n"
.'- NotExist: 3 (Not connected - Nonexistent number).'."\n"
."\n"
.'- Busy: 4 (Not connected - Busy).'."\n"
."\n"
.'- Cancelled: 5 (Not dialed - Task stopped).'."\n"
."\n"
.'- Failed: 6 (Failed).'."\n"
."\n"
.'- NotConnected: 7 (Not connected - Unreachable).'."\n"
."\n"
.'- PoweredOff: 8 (Not connected - Powered off).'."\n"
."\n"
.'- OutOfService: 9 (Not connected - Called party out of service).'."\n"
."\n"
.'- InArrears: 10 (Not connected - Called party has overdue payment).'."\n"
."\n"
.'- EmptyNumber: 11 (Not dialed - Nonexistent number).'."\n"
."\n"
.'- PerDayCallCountLimit: 12 (Not dialed - Daily limit exceeded).'."\n"
."\n"
.'- ContactBlockList: 13 (Not dialed - Blocked list).'."\n"
."\n"
.'- CallerNotRegistered: 14 (Not dialed - Caller number not registered).'."\n"
."\n"
.'- Terminated: 15 (Not dialed - Terminated).'."\n"
."\n"
.'- VerificationCancelled: 16 (Not dialed - Pre-call verification failed).'."\n"
."\n"
.'- OutOfServiceNoCall: 17 (Not dialed - Called party out of service).'."\n"
."\n"
.'- InArrearsNoCall: 18 (Not dialed - Called party has overdue payment).'."\n"
."\n"
.'- CallingNumberNotExist: 19 (Not dialed - Caller number does not exist).'."\n"
.'- SucceededFinish: 20 (Connected - Completed normally).'."\n"
."\n"
.'- SucceededChatbotHangUpAfterNoAnswer: 21 (Connected - Robot hung up after no recognition).'."\n"
."\n"
.'- SucceededChatbotHangUpAfterSilence: 22 (Connected - Hung up due to silence timeout).'."\n"
."\n"
.'- SucceededClientHangUpAfterNoAnswer: 23 (Connected - User hung up after no recognition).'."\n"
."\n"
.'- SucceededClientHangUp: 24 (Connected - User hung up without reason).'."\n"
."\n"
.'- SucceededTransferByIntent: 25 (Connected - Transferred to agent by intent).'."\n"
."\n"
.'- SucceededTransferAfterNoAnswer: 26 (Connected - Transferred to agent after no recognition).'."\n"
."\n"
.'- SucceededInoInterAction: 27 (Connected - No interaction from user).'."\n"
."\n"
.'- SucceededError: 28 (Connected - System error interruption).'."\n"
."\n"
.'- SucceededSpecialInterceptVoiceAssistant: 29 (Connected - Special intercept - Voice assistant).'."\n"
."\n"
.'- SucceededSpecialInterceptExtensionNumberTransfer: 30 (Connected - Special intercept - Extension number transfer).'."\n"
.'- SucceededSpecialInterceptCustomSpecialIntercept: 31 (Connected - Special intercept - Custom intercept).'."\n"
.'- HighRiskSipCode: 32 (Not dialed - High risk).', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''],
'PlanedTime' => ['description' => 'The planned outbound call time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579068424883', 'title' => ''],
'ChatbotId' => ['description' => 'The robot ID.', 'type' => 'string', 'example' => '1234', 'title' => ''],
'ActualTime' => ['description' => 'The actual outbound call time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579068424883', 'title' => ''],
'CalledNumber' => ['description' => 'The called number.', 'type' => 'string', 'example' => '135****8888', 'title' => ''],
'ScenarioId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => 'ade80092-03d9-4f4d-ad4f-ab8a247d3150', 'title' => ''],
'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', 'title' => ''],
'CallId' => ['description' => 'SIP call ID。', 'type' => 'string', 'example' => '1528189846043', 'title' => ''],
'CallingNumber' => ['description' => 'The calling number.', 'type' => 'string', 'example' => '0571****3106', 'title' => ''],
'Brief' => ['description' => 'The summary. This is a legacy field and is no longer in use.', 'type' => 'string', 'example' => '1', 'title' => ''],
'Duration' => ['description' => 'The call duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'title' => ''],
'TaskId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'ff44709e-39a6-43ba-959b-20fcabe3e496', 'title' => ''],
'Contact' => [
'description' => 'The contact information.',
'type' => 'object',
'properties' => [
'PhoneNumber' => ['description' => 'The contact phone number.', 'type' => 'string', 'example' => '135****8888', 'title' => ''],
'State' => ['description' => 'The status.', 'type' => 'string', 'example' => 'Available', 'title' => ''],
'ContactId' => ['description' => 'The contact ID.', 'type' => 'string', 'example' => 'db3db762-e421-44c9-9a01-cb423470757c', 'title' => ''],
'Honorific' => ['description' => 'The honorific title.', 'type' => 'string', 'example' => '张先生', 'title' => ''],
'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'b72425bd-7871-4050-838e-033d80d754b7', 'title' => ''],
'ContactName' => ['description' => 'The contact name.', 'type' => 'string', 'example' => '张三', 'title' => ''],
'Role' => ['description' => 'The role.', 'type' => 'string', 'example' => '*', 'title' => ''],
'ReferenceId' => ['description' => 'The associated business ID.', 'type' => 'string', 'example' => '2fa6bac3-06da-4315-82ab-72d6fd3a6f34', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'CallingNumbers' => [
'description' => 'The list of calling numbers.',
'type' => 'array',
'items' => ['description' => 'The list of calling numbers.', 'type' => 'string', 'example' => '["0571****3106"]', 'title' => ''],
'title' => '',
'example' => '',
],
'TagHits' => [
'description' => 'The tag hit information in small model scenarios.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => '有意向', 'title' => ''],
'TagGroup' => ['description' => 'The tag group name.', 'type' => 'string', 'example' => '意向收集', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'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' => ''],
['errorCode' => 'NotExist.JobGroup', 'errorMessage' => 'The specified JobGroup does not exist.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.', 'description' => ''],
],
],
'title' => 'Query job list',
'changeSet' => [
['createdAt' => '2023-10-20T07:45:12.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'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"}]',
],
'QueryJobsWithResult' => [
'summary' => 'Queries tasks based on task results.',
'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' => 'The page number.'."\n"
."\n"
.'>This parameter is required.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The page size.'."\n"
.'>This parameter is required.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'minimum' => '1', 'example' => '10', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the job group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ad16fc35-d824-4102-a606-2be51c1aa6dd', 'title' => ''],
],
[
'name' => 'QueryText',
'in' => 'query',
'schema' => ['description' => 'The search content. You can search by phone number.', 'type' => 'string', 'required' => false, 'example' => '1882020****', 'title' => ''],
],
[
'name' => 'JobStatusFilter',
'in' => 'query',
'schema' => ['description' => 'The job status filter. Valid values:'."\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' => 'Specifies whether the call was answered.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'HasHangUpByRejectionFilter',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the call was hung up due to rejection.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'HasReachedEndOfFlowFilter',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the call reached the end of the flow.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9d53cd72-4050-4419-8c17-acc0bf158147', 'title' => ''],
],
[
'name' => 'TaskStatusFilter',
'in' => 'query',
'schema' => ['description' => 'The call status, such as ["Executing","Succeeded"]. Separate multiple values with commas (,).'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'(Note: The **Succeeded** status has been subdivided into specific reasons. The **Succeeded**: 1 (answered) status is no longer returned. Instead, specific sub-reason types are returned.)'."\n"
."\n"
.'- **Executing**: 0 (dialing).'."\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 - busy).'."\n"
.'- **Cancelled**: 5 (not dialed - task stopped).'."\n"
.'- **Failed**: 6 (failed).'."\n"
.'- **NotConnected**: 7 (not answered - unreachable).'."\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, no outbound call).'."\n"
.'- **PerDayCallCountLimit**: 12 (not dialed - daily limit exceeded).'."\n"
.'- **ContactBlockList**: 13 (not dialed - blacklisted).'."\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 verification failure).'."\n"
.'- **OutOfServiceNoCall**: 17 (not dialed - callee out of service, no outbound call).'."\n"
.'- **InArrearsNoCall**: 18 (not dialed - callee has overdue payment, no outbound call).'."\n"
.'- **CallingNumberNotExist**: 19 (not dialed - caller number does not exist).'."\n"
.'- **SucceededFinish**: 20 (answered - completed normally).'."\n"
.'- **SucceededChatbotHangUpAfterNoAnswer**: 21 (answered - robot hung up after rejection).'."\n"
.'- **SucceededChatbotHangUpAfterSilence**: 22 (answered - hung up due to 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 by intent).'."\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 error).'."\n"
.'- **SucceededSpecialInterceptVoiceAssistant**: 29 (answered - special interception - voice assistant).'."\n"
.'- **SucceededSpecialInterceptExtensionNumberTransfer**: 30 (answered - special interception - extension number transfer).'."\n"
.'- **SucceededSpecialInterceptCustomSpecialIntercept**: 31 (answered - special interception - custom interception).'."\n"
.'- **HighRiskSipCode**: 32 (not dialed - high risk, no outbound call).', 'type' => 'string', 'required' => false, 'example' => '["Executing"]', 'title' => ''],
],
[
'name' => 'JobFailureReasonsFilter',
'in' => 'query',
'schema' => [
'description' => 'The list of job failure reasons.',
'enumValueTitles' => [
'NoAnswer' => 'No answer.', 'PerDayCallCountLimit' => 'Daily call count limit for the number.', 'InArrears' => 'Overdue payment.', 'OutOfService' => 'Out of service.', 'NoStrategy' => 'Strategy is empty or not found.', 'EmptyNumber' => 'Nonexistent number, no further outbound calls.', 'JobPerDayCallCountLimit' => 'Daily call count limit for the number.', 'NoneRepeatableJobMaxAttemptCountLimit' => 'Maximum attempt count for the task. Takes effect when RepeatBy (@see) is set to None.', 'ContactSuspended' => 'Call suspended.', 'VerificationCancelled' => 'Cancelled due to pre-call verification failure.',
'Unknown' => 'Unknown error.', 'InvalidStrategy' => 'Invalid strategy. The strategy configuration is incorrect.', 'TimeUp' => 'Timeout detected during scheduling.', 'CallFailed' => 'Call failed.', 'ContactBlockList' => 'Outbound call blacklist.',
],
'type' => 'string',
'required' => false,
'example' => '["NoAnswer"]',
'title' => '',
],
],
[
'name' => 'StartActualTimeFilter',
'in' => 'query',
'schema' => ['description' => 'The filter condition for the call start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1579055782000', 'title' => ''],
],
[
'name' => 'EndActualTimeFilter',
'in' => 'query',
'schema' => ['description' => 'The filter condition for the call end time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1579055783000', 'title' => ''],
],
[
'name' => 'LabelsJson',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The filter condition for labels associated with calls.'."\n"
."\n"
.'> This condition only supports filtering by labels that have specific enumerated label values configured, that is, labels with specific label values configured in large language model scenarios.',
'type' => 'array',
'items' => ['description' => 'The labels and corresponding label values to filter by.'."\n"
."\n"
.'> Filters all calls that match specific labels and their corresponding label values.'."\n"
.'For example: {"ValueList":["满意","不满意"],"Name":"是否满意"} filters call information where the label "是否满意" has label values of "满意" or "不满意".', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "ValueList": ['."\n"
.' "满意",'."\n"
.' "不满意"'."\n"
.' ],'."\n"
.' "Name": "是否满意"'."\n"
.' }', 'title' => ''],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'Code', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9bdaa1d1-a036-4451-ab11-ca0373679091', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'VariableNames' => [
'description' => 'The label names to be collected.',
'type' => 'array',
'items' => ['description' => 'The complete set of label keys.', 'type' => 'string', 'example' => '是否已经接通', 'title' => ''],
'title' => '',
'example' => '',
],
'Jobs' => [
'description' => 'The jobs.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RowCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'List' => [
'description' => 'The job list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The job status. Valid values:'."\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' => 'The job status name.', 'type' => 'string', 'example' => '结束-已触达', 'title' => ''],
'JobFailureReason' => ['description' => 'The 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' => 'The job ID.', 'type' => 'string', 'example' => 'cc231a1d-3c05-4739-8926-193ecf4097ba', 'title' => ''],
'LatestTask' => [
'description' => 'The latest call.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The call status.', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''],
'TaskEndReason' => ['description' => 'The call result.', 'type' => 'string', 'example' => 'FINISHED', 'title' => ''],
'HasAnswered' => ['description' => 'Indicates whether the call was answered.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'CallDuration' => ['description' => 'The call duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '40000', 'title' => ''],
'HasReachedEndOfFlow' => ['description' => 'Specifies whether the call reached the end of the flow.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'StatusName' => ['description' => 'The call status name.', 'type' => 'string', 'example' => '未呼出-超出每日上限', 'title' => ''],
'CallTime' => ['description' => 'The call time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1615363297000', 'title' => ''],
'CallDurationDisplay' => ['description' => 'The call duration.', 'type' => 'string', 'example' => '40', 'title' => ''],
'HasHangUpByRejection' => ['description' => 'Specifies whether the call was hung up due to rejection.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Extras' => [
'description' => 'The label names to be collected.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The label key.', 'type' => 'string', 'example' => '是否已经接通', 'title' => ''],
'Value' => ['description' => 'The label value.', 'type' => 'string', 'example' => '是', 'title' => ''],
],
'title' => '',
'description' => 'The pass-through parameter object.',
'example' => '',
],
'title' => '',
'example' => '',
],
'TagHits' => [
'description' => 'The label hit information (returned by the legacy canvas).',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagName' => ['description' => 'The label name.', 'type' => 'string', 'example' => '猫幼年期,猫幼年期', 'title' => ''],
'TagGroup' => ['description' => 'The label group to which the label belongs.', 'type' => 'string', 'example' => '动物', 'title' => ''],
],
'title' => '',
'description' => 'The label hit object (returned by the legacy canvas).',
'example' => '',
],
'title' => '',
'example' => '',
],
'Contact' => [
'description' => 'The contact.',
'type' => 'object',
'properties' => [
'Round' => ['description' => 'The round number.', 'type' => 'integer', 'format' => 'int32', 'example' => '151', 'title' => ''],
'JobUuid' => ['description' => 'The 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 is actually dialed.'."\n"
.'> Custom-defined by the customer. Passed in JSON format when calling the API to execute an outbound call task.', 'type' => 'string', 'example' => '134123****', 'title' => ''],
'PhoneNumber' => ['description' => 'The phone number of the contact.', 'type' => 'string', 'example' => '1882020****', 'title' => ''],
'State' => ['description' => 'The status of the contact, such as Available, WrongNumber, or DoesNotExist.'."\n"
.'> Custom-defined by the customer. Passed in JSON format when calling the API to execute an outbound call task.', 'type' => 'string', 'example' => 'Available', 'title' => ''],
'Honorific' => ['description' => 'The honorific for the contact. If not specified, it defaults to the same value as the name.'."\n"
.'> Custom-defined by the customer. Passed in JSON format when calling the API to execute an outbound call task.', 'type' => 'string', 'example' => '张先生', 'title' => ''],
'Name' => ['description' => 'The name of the contact.', 'type' => 'string', 'example' => '张三', 'title' => ''],
'Role' => ['description' => 'The role of the contact in this outbound call scenario. If not specified, no role distinction is made. For example, in a debt collection scenario, contact roles can include borrower, co-borrower, and guarantor.'."\n"
."\n"
.'> Custom-defined by the customer. Passed in JSON format when calling the API.', 'type' => 'string', 'example' => '借款人', 'title' => ''],
'Id' => ['description' => 'The contact ID. A unique identifier generated by the system when the outbound call list is uploaded.', 'type' => 'string', 'example' => '63860deb-6218-45df-b1e0-76f2b166e790', 'title' => ''],
'ReferenceId' => ['description' => 'The contact ID uploaded by the customer. This must be provided by the business side to avoid duplicate name issues.', 'type' => 'string', 'example' => 'C01', 'title' => ''],
],
'title' => '',
'example' => '',
],
'HasLastPlaybackCompleted' => ['description' => 'Indicates whether the playback was completed when the call was hung up.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'DialExceptionCodes' => [
'description' => 'The call exception codes.',
'type' => 'array',
'items' => [
'description' => 'The call exception codes.',
'type' => 'object',
'properties' => [
'Code' => [
'description' => 'The error code.',
'enumValueTitles' => [],
'type' => 'string',
'example' => '0',
'title' => '',
],
'Hint' => [
'description' => 'The error message.',
'enumValueTitles' => [],
'type' => 'string',
'example' => '无',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'HangUpDirection' => ['title' => '', 'type' => 'string', 'example' => '被叫用户', 'description' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'description' => 'The job object.',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Labels' => [
'description' => 'The label information that can be used as filter conditions.'."\n"
."\n"
.'> Displays all label information with enumerated values in the job group.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The label name.', 'type' => 'string', 'example' => '是否满意', 'title' => ''],
'ValueList' => [
'description' => 'The list of label values.',
'type' => 'array',
'items' => ['description' => 'The label value.', 'type' => 'string', 'example' => '["否","是"]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'description' => 'The label object.',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'description' => 'The response object.',
'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' => [],
],
'gatewayOptions' => [
'gatewayProtocols' => [],
],
'title' => 'Query tasks 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' => '*'],
],
],
],
],
'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 \\"HangUpDirection\\": \\"被叫用户\\"\\n }\\n }\\n ]\\n },\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"是否满意\\",\\n \\"ValueList\\": [\\n \\"[\\\\\\"否\\\\\\",\\\\\\"是\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'QueryScriptWaveforms' => [
'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' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'Scenario ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5ab2d935-306c-478a-88bf-d08e4e25c1b7', 'title' => ''],
],
[
'name' => 'ScriptContent',
'in' => 'query',
'schema' => ['description' => 'Scenario voice name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '抱歉打扰您了,稍后会有客户经理与您联系啊,再见!'."\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' => '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' => ''],
'ScriptWaveforms' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ScriptContent' => ['description' => 'Scenario voice name', 'type' => 'string', 'example' => '测试', 'title' => ''],
'ScriptWaveformId' => ['description' => 'Scenario voice recording ID', 'type' => 'string', 'example' => '444df4-009c-4791-a720-e7ac4f9821a1'."\n", 'title' => ''],
'FileName' => ['description' => 'Recording file name', 'type' => 'string', 'example' => 'SHUKE_ZA_ol_32_邀约.wav', 'title' => ''],
'ScriptId' => ['description' => 'Scenario ID', 'type' => 'string', 'example' => '25b26ce1-009c-4791-a720-e7ac4f9821a1', 'title' => ''],
'FileId' => ['description' => 'File key in OSS', 'type' => 'string', 'example' => 'UPLOADED/RECORDING/a8xxxxx-2b26-4b6d-a54f-696b95xxx1/a6bf591a-cf6d-4xxxxxx.wav', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => 'Recording list of scenario voices'."\n"
."\n"
.'> Recording data is returned only when the voice type is recording. It is not returned when the voice is 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' => 'This legacy canvas interface retrieves the list of recorded speech transcripts.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
[
'name' => 'StatusList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of statuses.',
'type' => 'array',
'items' => ['description' => 'The status of the scenario. Valid values:'."\n"
."\n"
.'- **DRAFTED**: The script is a draft.'."\n"
."\n"
.'- **INITIALIZE\\_IN\\_PROGRESS**: The script is being initialized.'."\n"
."\n"
.'- **PUBLISHED**: The script is published.'."\n"
."\n"
.'- **PUBLISH\\_IN\\_PROGRESS**: The script is being published.'."\n"
."\n"
.'- **ROLLBACK\\_IN\\_PROGRESS**: The script is being rolled back.'."\n"
."\n"
.'- **EXAMINE\\_IN\\_PROGRESS**: The script is pending approval.'."\n"
."\n"
.'- **PUBLISHED\\_AND\\_EXAMINE\\_IN\\_PROGRESS**: The script is published and pending approval.'."\n"
."\n"
.'- **PUBLISH\\_FAILED**: The script failed to be published.'."\n"
."\n"
.'- **ROLLBACK\\_FAILED**: The script failed to be rolled back.'."\n"
."\n"
.'- **IMPORT\\_IN\\_PROGRESS**: The script is being imported.'."\n"
."\n"
.'- **IMPORT\\_FAILED**: The script failed to be imported.', 'type' => 'string', 'required' => false, 'example' => 'PUBLISHED', 'title' => ''],
'required' => true,
'example' => '',
'maxItems' => 10,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The API status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Scripts' => [
'description' => 'The scenarios.',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''],
'List' => [
'description' => 'The list of scenarios.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status of the application version. Valid values:'."\n"
."\n"
.'- **DRAFTED**: The script is a draft.'."\n"
."\n"
.'- **INITIALIZE\\_IN\\_PROGRESS**: The script is being initialized.'."\n"
."\n"
.'- **PUBLISHED**: The script is published.'."\n"
."\n"
.'- **PUBLISH\\_IN\\_PROGRESS**: The script is being published.'."\n"
."\n"
.'- **ROLLBACK\\_IN\\_PROGRESS**: The script is being rolled back.'."\n"
."\n"
.'- **EXAMINE\\_IN\\_PROGRESS**: The script is pending approval.'."\n"
."\n"
.'- **PUBLISHED\\_AND\\_EXAMINE\\_IN\\_PROGRESS**: The script is published and pending approval.'."\n"
."\n"
.'- **PUBLISH\\_FAILED**: The script failed to be published.'."\n"
."\n"
.'- **ROLLBACK\\_FAILED**: The script failed to be rolled back.'."\n"
."\n"
.'- **IMPORT\\_IN\\_PROGRESS**: The script is being imported.'."\n"
."\n"
.'- **IMPORT\\_FAILED**: The script failed to be imported.', 'type' => 'string', 'example' => 'PUBLISHED', 'title' => ''],
'UpdateTime' => ['description' => 'The time when the script was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1579055782000', 'title' => ''],
'ScriptId' => ['description' => 'The scenario ID.', 'type' => 'string', 'example' => 'fa0e21e9-caab-4629-9121-1e341243d599', 'title' => ''],
'AppliedVersion' => ['description' => 'The version ID.', 'type' => 'string', 'example' => '1579055782000', 'title' => ''],
'IsDebugDrafted' => ['description' => 'Indicates whether the debug version is a draft.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'Industry' => ['description' => 'The industry.', 'type' => 'string', 'example' => '通用', 'title' => ''],
'ScriptDescription' => ['description' => 'The script description.', 'type' => 'string', 'example' => '销售话术', 'title' => ''],
'IsDrafted' => ['description' => 'Indicates whether the version is a draft.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'DebugStatus' => ['description' => 'The debug status.', 'type' => 'string', 'example' => 'PUBLISHED', 'title' => ''],
'DebugVersion' => ['description' => 'The debug version.', 'type' => 'string', 'example' => '01bb2df2-a273-42bb-a214-d3c626b13296', 'title' => ''],
'Scene' => ['description' => 'The scenario.', 'type' => 'string', 'example' => '电销', 'title' => ''],
'ScriptName' => ['description' => 'The 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' => 'Queries scenario information by 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' => 'Task 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' => 'Failure reason.'."\n"
."\n"
.'- Nonexistent number (NotExists)'."\n"
."\n"
.'- Busy (Busy)'."\n"
."\n"
.'- No answer (NotAnswered)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NotExists', 'title' => ''],
],
[
'name' => 'ExceptionCodes',
'in' => 'query',
'schema' => ['description' => 'Error code when the outbound call fails.'."\n"
."\n"
.'- Nonexistent number (NotExists)'."\n"
."\n"
.'- Busy (Busy)'."\n"
."\n"
.'- No answer (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 request 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 sends the call failure reason to the outbound calling system. This operation 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: Specifies 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' => 'Job ID list.'."\n"
."\n"
.'> This parameter is required when All is false.',
'type' => 'array',
'items' => ['description' => 'Job ID.', 'type' => 'string', '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 uploaded by the customer when uploading the outbound list.',
'type' => 'array',
'items' => ['description' => 'Third-party ID of the job.', 'type' => 'string', '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' => 'Success.', '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' => 'Resumes paused jobs.',
'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', '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' => '303523b1-0094-4ebe-b9ed-c23d11c91d61', 'title' => ''],
],
[
'name' => 'RollbackVersion',
'in' => 'query',
'schema' => ['description' => 'Version to roll back to'."\n"
."\n"
.'> For valid values, see the ListScriptPublishHistories operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1578965079000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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' => ''],
],
'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' => 'Saves the delayed playback time after a call is answered.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '980116ec-2d3d-4747-8059-dc25e7af8501', 'title' => ''],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => ['description' => 'The policy level (required). Valid values:'."\n"
.'- 2: instance', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'required' => true, 'example' => '2', 'title' => ''],
],
[
'name' => 'AfterAnswerDelayPlayback',
'in' => 'query',
'schema' => ['description' => 'The playback time for delayed playback. If this parameter is not specified, the default value 0 is used.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', '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' => ''],
],
],
'title' => 'Save delayed playback time after answer',
'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' => 'update',
'ramAction' => [
'action' => 'outboundbot:SaveAfterAnswerDelayPlayback',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'SaveAnnotationMissionSessionList' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '130001',
'abilityTreeNodes' => ['FEATUREoutboundbotQHO52V'],
],
'parameters' => [
[
'name' => 'AnnotationMissionSessionListJsonString',
'in' => 'query',
'schema' => ['description' => 'The list of sessions in JSON format.'."\n"
."\n"
.'> This parameter has the same function as the AnnotationMissionSessionList parameter. You can specify either of them. The JSON field is a parameter of AnnotationMissionSessionList.', 'type' => 'string', 'required' => false, 'example' => '[{"jobGroupId":"4093e364-57dc-4a89-83e0-a88454642596","modifiedTime":1744971010000,"instanceId":"00b37342-e759-4fe5-b296-aef775933af0","version":0,"annotationMissionId":"3d4bfd93-0d16-4873-9d77-e4fb1771e5cf","createTime":1744971010000,"annotationMissionSessionId":"42032063-8ef2-48e1-bc99-587b51581742","scriptId":"bc50d543-6d52-4df8-8fb0-50f31ee9c1ff","sessionId":"641a2c43-5e2a-4535-8a4d-c66d4b4258d6","jobId":"fa54c5bb-d8a7-40ae-a32e-9a4a0c734ce5","annotationStatus":2,"debugConversation":false}]', 'title' => ''],
],
[
'name' => 'UserNick',
'in' => 'query',
'schema' => ['description' => 'The user\'s nickname.', 'type' => 'string', 'required' => false, 'example' => '用户', 'title' => ''],
],
[
'name' => 'AnnotationMissionSessionList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of sessions.'."\n"
."\n"
.'> This parameter has the same function as AnnotationMissionSessionListJsonString. Specify either of them.',
'type' => 'array',
'items' => [
'description' => 'A session.',
'type' => 'object',
'properties' => [
'AnnotationMissionSessionId' => ['description' => 'The session ID.', 'type' => 'string', 'required' => false, 'example' => 'c88cc004-de69-4eee-aa5f-2efed533a54e'."\n", 'title' => ''],
'CreateTime' => ['description' => 'The time when the session was created.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2023-04-14T02:01:23Z', 'title' => ''],
'ModifiedTime' => ['description' => 'The time when the session was last modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683858248778', 'title' => ''],
'AnnotationMissionId' => ['description' => 'The ID of the annotation task.', 'type' => 'string', 'required' => false, 'example' => 'c88cc004-de69-4eee-aa5f-2efed533a54e', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => '77343553-cbc2-4487-a35c-869f1e86c573', 'title' => ''],
'ScriptId' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => false, 'example' => 'e4f32632-2e56-4399-9fec-47bdbaeefdf6', 'title' => ''],
'JobGroupId' => ['description' => 'The task group ID.', 'type' => 'string', 'required' => false, 'example' => '29e669bd-a9d1-4529-98cd-c2b0549bcf53', 'title' => ''],
'JobId' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => '593aaf5e-1275-4add-9990-22696385dc6e', 'title' => ''],
'SessionId' => ['description' => 'For an outbound call, this is the task ID. For navigation, this is the conversation ID.', 'type' => 'string', 'required' => false, 'example' => 'e6271044-b4b2-4ad8-ade4-c720be023538', 'title' => ''],
'AnnotationStatus' => ['description' => 'The annotation status.'."\n"
."\n"
.'- 0: UNDO'."\n"
."\n"
.'- 1: DOING'."\n"
."\n"
.'- 2: DONE'."\n"
."\n"
.'- 3: CLOSED', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'AnnotationMissionChatList' => [
'description' => 'The list of chats.',
'type' => 'array',
'items' => [
'description' => 'The list of chats.',
'type' => 'object',
'properties' => [
'AnnotationMissionChatId' => ['description' => 'The chat ID.', 'type' => 'string', 'required' => false, 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n", 'title' => ''],
'CreateTime' => ['description' => 'The time when the chat was created.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1679629770336', 'title' => ''],
'ModifiedTime' => ['description' => 'The time when the chat was last modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1629360780000', 'title' => ''],
'AnnotationMissionId' => ['description' => 'The ID of the annotation task.', 'type' => 'string', 'required' => false, 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9', 'title' => ''],
'AnnotationMissionSessionId' => ['description' => 'The session ID.', 'type' => 'string', 'required' => false, 'example' => 'c88cc004-de69-4eee-aa5f-2efed533a54e'."\n", 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => '5ec263fa-c8de-46f4-b844-6fb8275bb645', 'title' => ''],
'SequenceId' => ['description' => 'The serial number of the current session interaction.', 'type' => 'string', 'required' => false, 'example' => '1475140522', 'title' => ''],
'OccurTime' => ['description' => 'The time when the chat was triggered.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1682493047418', 'title' => ''],
'Answer' => ['description' => 'The content of the robot\'s response.', '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' => 'The annotation status.'."\n"
."\n"
.'- 0: UNDO'."\n"
."\n"
.'- 1: DOING'."\n"
."\n"
.'- 2: DONE'."\n"
."\n"
.'- 3: CLOSED', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'IntentAnnotationStatus' => ['description' => 'The semantic tagging status.'."\n"
."\n"
.'- 0: UNDO'."\n"
."\n"
.'- 1: DOING'."\n"
."\n"
.'- 2: DONE'."\n"
."\n"
.'- 3: CLOSED', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'],
'AsrAnnotationStatus' => ['description' => 'The Automatic Speech Recognition (ASR) annotation status.'."\n"
."\n"
.'- 0: UNDO'."\n"
."\n"
.'- 1: DOING'."\n"
."\n"
.'- 2: DONE'."\n"
."\n"
.'- 3: CLOSED', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'],
'TagAnnotationStatus' => ['description' => 'The tag annotation status.'."\n"
."\n"
.'- 0: UNDO'."\n"
."\n"
.'- 1: DOING'."\n"
."\n"
.'- 2: DONE'."\n"
."\n"
.'- 3: CLOSED', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'],
'SubStatus' => ['description' => 'The annotation action. Valid values: 1: Correct. 20: Matching error (not optimized). 21: Matching error (optimized). 3: Not covered. 4: Invalid.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'],
'TranslationError' => ['description' => 'The transcription error flag.'."\n"
."\n"
.'- 0: No'."\n"
."\n"
.'- 1: Yes', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'AnnotationAsrResult' => ['description' => 'The result of manual ASR annotation. This is used to calculate the character accuracy rate.', 'type' => 'string', 'required' => false, 'example' => '[]', 'title' => ''],
'OriginalAsrResult' => ['description' => 'The ASR result.', 'type' => 'string', 'required' => false, 'example' => '[]', 'title' => ''],
'AnnotationMissionChatIntentUserSayInfoList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AnnotationMissionChatIntentUserSayInfoId' => ['description' => 'The ID.', 'type' => 'string', 'required' => false, 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n", 'title' => ''],
'CreateTime' => ['description' => 'The time when the item was created.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683858248778', 'title' => ''],
'ModifiedTime' => ['description' => 'The time when the item was last modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683858248778', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n", 'title' => ''],
'AnnotationMissionId' => ['description' => 'The ID of the annotation task.', 'type' => 'string', 'required' => false, 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n", 'title' => ''],
'AnnotationMissionSessionId' => ['description' => 'The session ID.', 'type' => 'string', 'required' => false, 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n", 'title' => ''],
'AnnotationMissionChatId' => ['description' => 'The chat ID.', 'type' => 'string', 'required' => false, 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n", 'title' => ''],
'Content' => ['description' => 'The content.', 'type' => 'string', 'required' => false, 'example' => '[]', 'title' => ''],
'IntentId' => ['description' => 'The intent ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '119839', 'title' => ''],
'DialogId' => ['description' => 'The dialog ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2991201'."\n", 'title' => ''],
'BotId' => ['description' => 'The bot ID.', 'type' => 'string', 'required' => false, 'example' => 'ddce607f-f537-4ebd-9914-cf45671defb9'."\n", 'title' => ''],
'Delete' => ['description' => 'Delete this item.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
'Create' => ['description' => 'Create', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 10,
'description' => 'The list.',
'title' => '',
'example' => '',
],
'AnnotationMissionChatVocabularyInfoList' => [
'description' => 'The hotword annotation information for the annotation task chat.',
'type' => 'array',
'items' => [
'description' => 'The hotword annotation information for the annotation task chat.',
'type' => 'object',
'properties' => [
'AnnotationMissionChatVocabularyInfoId' => ['description' => 'The ID.', 'type' => 'string', 'required' => false, 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", 'title' => ''],
'CreateTime' => ['description' => 'The time when the item was created.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1677552860720', 'title' => ''],
'ModifiedTime' => ['description' => 'The time when the item was last modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1679283408230', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => '77343553-cbc2-4487-a35c-869f1e86c573', 'title' => ''],
'AnnotationMissionId' => ['description' => 'The ID of the annotation task.', 'type' => 'string', 'required' => false, 'example' => '977a45dc-b636-4407-9e98-9f572c709ada', 'title' => ''],
'AnnotationMissionSessionId' => ['description' => 'The session ID.', 'type' => 'string', 'required' => false, 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", 'title' => ''],
'AnnotationMissionChatId' => ['description' => 'The chat ID.', 'type' => 'string', 'required' => false, 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", 'title' => ''],
'VocabularyId' => ['description' => 'The hotword ID.', 'type' => 'string', 'required' => false, 'example' => '77343553-cbc2-4487-a35c-869f1e86c573'."\n", 'title' => ''],
'Vocabulary' => ['description' => 'The content of the hotword annotation.', 'type' => 'string', 'required' => false, 'example' => '[]', 'title' => ''],
'VocabularyName' => ['description' => 'The name of the processing scenario.', 'type' => 'string', 'required' => false, 'example' => '咨询', 'title' => ''],
'VocabularyDescription' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => '售后咨询', 'title' => ''],
'VocabularyWeight' => ['description' => 'The weight of the hotword. The value ranges from -6 to 5.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
'Delete' => ['description' => 'Delete', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'Create' => ['description' => 'Create', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 10,
'title' => '',
'example' => '',
],
'AnnotationMissionChatCustomizationDataInfoList' => [
'description' => 'The language model annotation information for the annotation task chat.',
'type' => 'array',
'items' => [
'description' => 'The language model annotation information for the annotation task chat.',
'type' => 'object',
'properties' => [
'AnnotationMissionChatCustomizationDataInfoId' => ['description' => 'The ID.', 'type' => 'string', 'required' => false, 'example' => 'b598a47a-7c03-45fb-af6b-343950dd9512'."\n", 'title' => ''],
'CreateTime' => ['description' => 'The time when the item was created.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1682316909210', 'title' => ''],
'ModifiedTime' => ['description' => 'The time when the item was last modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1673438100000', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'b598a47a-7c03-45fb-af6b-343950dd9512', 'title' => ''],
'AnnotationMissionId' => ['description' => 'The ID of the annotation task.', 'type' => 'string', 'required' => false, 'example' => '03f56192-fa8a-40dc-9558-39b357f0618f', 'title' => ''],
'AnnotationMissionSessionId' => ['description' => 'The session ID.', 'type' => 'string', 'required' => false, 'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n", 'title' => ''],
'AnnotationMissionChatId' => ['description' => 'The chat ID.', 'type' => 'string', 'required' => false, 'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n", 'title' => ''],
'CustomizationDataId' => ['description' => 'The ID.', 'type' => 'string', 'required' => false, 'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n", 'title' => ''],
'Content' => ['description' => 'The content.', 'type' => 'string', 'required' => false, 'example' => '现在呢主动邀请到您,机会非常难得,而且额度放着不用,也是不收费的,可以当作咱们的备用金,最快5分钟就能到账,建议您可以先把额度免费领取下来呢。 ', 'title' => ''],
'CustomizationDataName' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => '默认数据', 'title' => ''],
'CustomizationDataDescription' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => '默认数据描述', 'title' => ''],
'CustomizationDataWeight' => ['description' => 'The weight of the language model data.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
'Delete' => ['description' => 'Delete', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
'Create' => ['description' => 'Create', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 10,
'title' => '',
'example' => '',
],
'AnnotationMissionChatTagInfoList' => [
'description' => 'The list of mappings between annotation information chats and attached tags.',
'type' => 'array',
'items' => [
'description' => 'The list of mappings between annotation information chats and attached tags.',
'type' => 'object',
'properties' => [
'AnnotationMissionChatTagInfoId' => ['description' => 'The ID.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''],
'CreateTime' => ['description' => 'End time of the annotation mission group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1679710866060', 'title' => ''],
'ModifiedTime' => ['description' => 'Modified time', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1679710866060', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => '32be9d94-1346-4c4a-a4d0-ccd379f87013', 'title' => ''],
'AnnotationMissionId' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => '977a45dc-b636-4407-9e98-9f572c709ada', 'title' => ''],
'AnnotationMissionSessionId' => ['description' => 'The session ID.', 'type' => 'string', 'required' => false, 'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n", 'title' => ''],
'AnnotationMissionChatId' => ['description' => 'The chat ID.', 'type' => 'string', 'required' => false, 'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n", 'title' => ''],
'AnnotationMissionTagInfoId' => ['description' => 'The tag ID.', 'type' => 'string', 'required' => false, 'example' => '977a45dc-b636-4407-9e98-9f572c709ada'."\n", 'title' => ''],
'AnnotationMissionTagInfoName' => ['description' => 'The tag name.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''],
'Delete' => ['description' => 'Delete', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
'Create' => ['description' => 'Create', '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' => 'The environment.'."\n"
."\n"
.'- 0: NONE'."\n"
."\n"
.'- 1: Private cloud'."\n"
."\n"
.'- 2: Public cloud', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'AnnotationMissionDataSourceType',
'in' => 'query',
'schema' => ['description' => 'The source of the annotation data. Valid values: 1: Outbound call. 2: Navigation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['description' => 'The agent ID.'."\n"
."\n"
.'> Obtain this by calling the DescribeInstance operation.', 'type' => 'string', 'required' => false, 'example' => '1198938', 'title' => ''],
],
[
'name' => 'AgentKey',
'in' => 'query',
'schema' => ['description' => 'The key of the workspace. If you do not specify this parameter, the default workspace is accessed. Obtain the key on the Business Management page of your Alibaba Cloud account.'."\n"
."\n"
.'> Obtain this by calling the DescribeInstance operation.', 'type' => 'string', 'required' => false, 'example' => '9137ab9c27044921860030adf8590ec4_p_outbound_public', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the call was successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The returned message. If the request is successful, success is returned. If the request fails, an error code is returned.', 'type' => 'string', 'example' => '执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-zz4310rp1lb,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Message' => ['description' => 'The message returned for the operation.', 'type' => 'string', 'example' => '执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-zz4310rp1lb,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821', 'title' => ''],
'SaveAnnotationMissionSessionListRequest' => [
'description' => 'The request result.',
'type' => 'object',
'properties' => [
'AnnotationMissionSessionListJsonString' => ['description' => 'The content of the script for the approval requests', 'type' => 'string', 'example' => '[]', 'title' => ''],
],
'title' => '',
'example' => '',
],
'MessageList' => [
'description' => 'The list of messages.',
'type' => 'array',
'items' => ['description' => 'The list of messages.', 'type' => 'string', 'example' => '[]', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', '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' => 'You can save a list of annotation chat instances.',
'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' => 'The JSON-formatted data of the tags.'."\n"
."\n"
.'> The parameters in the JSON string are the same as those in AnnotationMissionTagInfoList. Specify either this parameter or AnnotationMissionTagInfoList.', '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' => 'The list of tags.'."\n"
."\n"
.'> This parameter has the same function as AnnotationMissionTagInfoListJsonString. Specify either this parameter or AnnotationMissionTagInfoListJsonString.',
'type' => 'array',
'items' => [
'description' => 'The list of tags.',
'type' => 'object',
'properties' => [
'AnnotationMissionTagInfoId' => ['description' => 'The tag ID.', 'type' => 'string', 'required' => false, 'example' => 'bdbff6a5-1f68-4b41-8d37-6ff805ce165a'."\n", 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'bdbff6a5-1f68-4b41-8d37-6ff805ce165a', 'title' => ''],
'TenantId' => ['description' => 'The tenant ID.', 'type' => 'string', 'required' => false, 'example' => 'bdbff6a5-1f68-4b41-8d37-6ff805ce165a'."\n", 'title' => ''],
'AnnotationMissionTagInfoName' => ['description' => 'The tag name.', 'type' => 'string', 'required' => false, 'example' => '标签', 'title' => ''],
'AnnotationMissionTagInfoDescription' => ['description' => 'The 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. Set it 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' => 'Indicates whether to restore the default tag values.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResponse',
'description' => 'BaseResponse',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the call was successful. A value of true indicates that the call was successful. A value of false indicates that the call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code of the API call.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned for the API call.', 'type' => 'string', 'example' => '执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-uax33hol2uu,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ExecCount' => ['description' => 'The number of successful operations.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Message' => ['description' => 'The message returned for the API call.', 'type' => 'string', 'example' => '执行失败:查找元素或操作超时,outTaskId:trademark_regnew_public_cn-uax33hol2uu,flowId:null,nodeUUID:541b6c71-8cce-4ab0-af84-713ca9741821', 'title' => ''],
],
'title' => '',
'example' => '',
],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The 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' => 'Saves instance tags in a 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' => 'Modifies the global outbound call time window 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"
."\n"
.'- 2: Instance', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'required' => true, 'example' => '2', 'title' => ''],
],
[
'name' => 'OnlyWeekdays',
'in' => 'query',
'schema' => ['description' => 'Make outbound calls only on weekdays. Defaults to false.', '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' => ['description' => 'Running time', 'type' => 'string', 'required' => false, 'example' => '[]', 'title' => ''],
'required' => false,
'example' => '[]',
'maxItems' => 99,
'title' => '',
],
],
[
'name' => 'OnlyWorkdays',
'in' => 'query',
'schema' => ['description' => 'Make outbound calls only on non-holiday days. Defaults to false.', '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' => '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' => 'Adds contacts to the instance\'s blocklist.',
'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 string that contains the blocklist. This parameter is required.'."\n"
."\n"
.'- phoneNumber: The mobile phone number.'."\n"
."\n"
.'- remark: The remarks.'."\n"
."\n"
.'- name: The name.'."\n"
."\n"
.'- creator: The creator.', 'type' => 'string', 'required' => false, 'example' => '[{"phoneNumber":"132322","remark":"123321","name":"ccc1","creator":"ccc222"}]', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID. This parameter is required.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'c3c92de8-e4bd-4db4-a962-50f8acce40bc', 'title' => ''],
],
[
'name' => 'ContactBlockListList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of contacts. \\[Deprecated]',
'example' => '[]',
'items' => ['description' => 'The list of contacts. \\[Deprecated]', 'type' => 'string', 'required' => false, 'example' => '[]', 'title' => ''],
'maxItems' => 99,
'required' => false,
'type' => 'array',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'AffectedRows' => ['description' => 'The number of affected rows.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The status code of the API.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned for the API call.', 'type' => 'string', 'example' => 'Success', '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' => 'Saves an 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' => 'The instance ID. This parameter is required.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c415bb6c-2e6f-46aa-afd9-3b65b6dbe2bc', 'title' => ''],
],
[
'name' => 'ContactWhiteListsJson',
'in' => 'query',
'schema' => ['description' => 'The whitelist. This parameter is required.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '[{"phoneNumber":"132322","remark":"123321","name":"ccc1","creator":"ccc222"}]', 'title' => ''],
],
[
'name' => 'ContactWhiteListList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The contact whitelist. This parameter is deprecated.',
'example' => '{}',
'items' => ['description' => 'The outbound call whitelist. This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
'maxItems' => 99,
'required' => false,
'type' => 'array',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'AffectedRows' => ['description' => 'The number of affected rows.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', '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' => 'The effective time.', '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' => 'Saves the validity period of a basic policy. This operation is deprecated.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'SaveMaxAttemptsPerDay' => [
'summary' => 'Sets the maximum number of daily outbound call attempts to a specific 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', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c8bf820a-6a8a-47bc-99bf-97593df8faa8', 'title' => ''],
],
[
'name' => 'StrategyLevel',
'in' => 'query',
'schema' => ['description' => 'Policy level (required)'."\n"
."\n"
.'- 2: Instance', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'required' => true, 'example' => '2', 'title' => ''],
],
[
'name' => 'MaxAttemptsPerDay',
'in' => 'query',
'schema' => ['description' => 'Daily maximum redial attempts. Default is 3 if not specified.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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' => ''],
],
'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 tasks.',
'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', 'type' => 'string', 'required' => true, 'example' => 'd481cebe-0bb6-4d13-9649-42ce5074fb75', 'title' => ''],
],
[
'name' => 'TaskCreateTimeGte',
'in' => 'query',
'schema' => ['description' => 'Start time of the task'."\n"
."\n"
.'> You must specify both TaskCreateTimeGte and TaskCreateTimeLte. If you omit either, the filter does not work.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1646792941', 'title' => ''],
],
[
'name' => 'TaskCreateTimeLte',
'in' => 'query',
'schema' => ['description' => 'End time of the task'."\n"
."\n"
.'> You must specify both TaskCreateTimeGte and TaskCreateTimeLte. If you omit either, the filter does not work.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1646792941', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => ['description' => 'Job group ID', 'type' => 'string', 'required' => false, 'example' => '3a30ae7c-27b2-4305-9444-7185ced9d51f', 'title' => ''],
],
[
'name' => 'JobGroupNameQuery',
'in' => 'query',
'schema' => ['description' => 'Job group name', 'type' => 'string', 'required' => false, 'example' => '国寿财住院保续保_20220301_134130', 'title' => ''],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => 'Job ID', 'type' => 'string', 'required' => false, 'example' => '11994321-e6bc-47bb-8b1c-8eef8f2f768b', 'title' => ''],
],
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => ['description' => 'Called number', 'type' => 'string', 'required' => false, 'example' => '15126426342', 'title' => ''],
],
[
'name' => 'UserIdMatch',
'in' => 'query',
'schema' => ['description' => 'User ID. A unique identifier for a user.'."\n"
."\n"
.'> This field is passed when you upload an outbound call list.'."\n"
.'>'."\n"
.'> - If you upload the list in JSON format, the user ID is the value of referenceId.'."\n"
.'>'."\n"
.'> - If you upload the list as an Excel file, the user ID is the value of contactId.', 'type' => 'string', 'required' => false, 'example' => 'C01', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => false, 'example' => '744b27f3-437f-4a8c-a181-f668e492fd24', 'title' => ''],
],
[
'name' => 'ActualTimeGte',
'in' => 'query',
'schema' => ['description' => 'Call start time', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1646582400000', 'title' => ''],
],
[
'name' => 'ActualTimeLte',
'in' => 'query',
'schema' => ['description' => 'Call end time', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1643126399000', 'title' => ''],
],
[
'name' => 'RecordingDurationGte',
'in' => 'query',
'schema' => ['description' => 'Minimum ring duration, in seconds', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'RecordingDurationLte',
'in' => 'query',
'schema' => ['description' => 'The minimum ringing duration for the search.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''],
],
[
'name' => 'PageIndex',
'in' => 'query',
'schema' => ['description' => 'Page number'."\n"
."\n"
.'> The first page is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'Number of items per page'."\n"
."\n"
.'> If you omit this parameter, the default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'OtherId',
'in' => 'query',
'schema' => ['description' => 'Other ID'."\n"
."\n"
.'**Valid values include the following:**'."\n"
."\n"
.'- sessionID'."\n"
."\n"
.'- taskid'."\n"
."\n"
.'- jobid', 'type' => 'string', 'required' => false, 'example' => 'AVD-2021-39685', 'title' => ''],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => 'Sort field. Default value: actualTime', 'type' => 'string', 'required' => false, 'example' => 'actualTime', 'title' => ''],
],
[
'name' => 'SortOrder',
'in' => 'query',
'schema' => ['description' => 'Sort order. Valid values:'."\n"
."\n"
.'- asc (ascending)'."\n"
."\n"
.'- desc (descending). Default value.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''],
],
[
'name' => 'CallDurationGte',
'in' => 'query',
'schema' => ['description' => 'Minimum call duration, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12341155', 'title' => ''],
],
[
'name' => 'CallDurationLte',
'in' => 'query',
'schema' => ['description' => 'Maximum call duration, in milliseconds', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12341155', 'title' => ''],
],
[
'name' => 'JobStatusStringList',
'in' => 'query',
'schema' => ['description' => 'Job status. Separate multiple statuses with commas. If you specify this parameter, it overrides jobStatusList.'."\n"
."\n"
.'- Scheduling: The job is being scheduled.'."\n"
."\n"
.'- Executing: The job is running.'."\n"
."\n"
.'- Succeeded: The job completed successfully.'."\n"
."\n"
.'- Paused: The job was paused.'."\n"
."\n"
.'- Failed: The job failed.'."\n"
."\n"
.'- Cancelled: The job was cancelled.', 'type' => 'string', 'required' => false, 'example' => 'Succeeded', 'title' => ''],
],
[
'name' => 'TaskStatusStringList',
'in' => 'query',
'schema' => ['description' => 'Call status. Separate multiple statuses with commas.'."\n"
."\n"
.'- **Executing**: 0 (Calling).'."\n"
."\n"
.'- **Succeeded**: 1 (Connected).'."\n"
."\n"
.'- **NoAnswer**: 2 (No answer).'."\n"
."\n"
.'- **NotExist**: 3 (Nonexistent number).'."\n"
."\n"
.'- **Busy**: 4 (Line busy).'."\n"
."\n"
.'- **Cancelled**: 5 (Call canceled due to job stop).'."\n"
."\n"
.'- **Failed**: 6 (Call failed).'."\n"
."\n"
.'- **NotConnected**: 7 (Cannot connect).'."\n"
."\n"
.'- **PoweredOff**: 8 (Phone powered off).'."\n"
."\n"
.'- **OutOfService**: 9 (Called number out of service).'."\n"
."\n"
.'- **InArrears**: 10 (Called number overdue payment).'."\n"
."\n"
.'- **EmptyNumber**: 11 (Empty number, no outbound call).'."\n"
."\n"
.'- **PerDayCallCountLimit**: 12 (Daily call limit exceeded).'."\n"
."\n"
.'- **ContactBlockList**: 13 (Blacklisted).'."\n"
."\n"
.'- **CallerNotRegistered**: 14 (Caller number not registered).'."\n"
."\n"
.'- **Terminated**: 15 (Call terminated).'."\n"
."\n"
.'- **VerificationCancelled**: 16 (Call canceled due to pre-call validation failure).'."\n"
."\n"
.'- **OutOfServiceNoCall**: 17 (Called number out of service, no outbound call).'."\n"
."\n"
.'- **InArrearsNoCall**: 18 (Called number overdue payment, no outbound call).'."\n"
."\n"
.'- **CallingNumberNotExist**: 19 (Caller number does not exist).'."\n"
."\n"
.'- **SucceededFinish**: 20 (Connected and ended normally).'."\n"
."\n"
.'- **SucceededChatbotHangUpAfterNoAnswer**: 21 (Connected and robot hung up after rejection).'."\n"
."\n"
.'- **SucceededChatbotHangUpAfterSilence**: 22 (Connected and robot hung up after silence timeout).'."\n"
."\n"
.'- **SucceededClientHangUpAfterNoAnswer**: 23 (Connected and client hung up after rejection).'."\n"
."\n"
.'- **SucceededClientHangUp**: 24 (Connected and client hung up without reason).'."\n"
."\n"
.'- **SucceededTransferByIntent**: 25 (Connected and transferred to agent based on intent match).'."\n"
."\n"
.'- **SucceededTransferAfterNoAnswer**: 26 (Connected and transferred to agent after rejection).'."\n"
."\n"
.'- **SucceededInoInterAction**: 27 (Connected and no interaction from client side).'."\n"
."\n"
.'- **SucceededError**: 28 (Connected but system error interrupted).'."\n"
."\n"
.'- **SucceededSpecialInterceptVoiceAssistant**: 29 (Connected but intercepted by voice assistant).'."\n"
."\n"
.'- **SucceededSpecialInterceptExtensionNumberTransfer**: 30 (Connected but intercepted by extension transfer).'."\n"
."\n"
.'- **SucceededSpecialInterceptCustomSpecialIntercept**: 31 (Connected but intercepted by custom rule).'."\n"
."\n"
.'- **HighRiskSipCode**: 32 (High-risk SIP code, no outbound call).', 'type' => 'string', 'required' => false, 'example' => 'Executing', 'title' => ''],
],
[
'name' => 'ScriptNameQuery',
'in' => 'query',
'schema' => ['description' => 'Scenario name', 'type' => 'string', 'required' => false, 'example' => '国寿财', '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' => 'Label-based filter condition for calls'."\n"
."\n"
.'> You can only use labels that have specific enumeration values. For example, labels configured with specific values in Large Language Model (LLM) scenarios.',
'type' => 'array',
'items' => ['description' => 'Label name and corresponding label value to filter.'."\n"
."\n"
.'> Filters all calls where the specified label has the specified value.'."\n"
.'> For example: {"ValueList":\\["Satisfied","Dissatisfied"],"Name":"Satisfaction"} filters calls where the "Satisfaction" label equals "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', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'PageIndex' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '0', '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' => 'Request status code', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'PageSize' => ['description' => 'Number of items per page', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Total' => ['description' => 'Total number of items', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'SearchTaskInfoList' => [
'description' => 'List of tasks',
'example' => '[]',
'items' => [
'description' => 'List of tasks',
'properties' => [
'JobGroupName' => ['description' => 'Job group name', 'type' => 'string', 'example' => '85成新(有笔记划线)2021_11_14_18_00_51', 'title' => ''],
'UserId' => ['description' => 'User ID', 'type' => 'string', 'example' => '12334134', 'title' => ''],
'ActualTime' => ['description' => 'Actual execution time', 'type' => 'integer', 'format' => 'int64', 'example' => '1643436089677', 'title' => ''],
'CalledNumber' => ['description' => 'Called number', 'type' => 'string', 'example' => '15205879599', 'title' => ''],
'TaskStatusString' => ['description' => 'Task status'."\n"
."\n"
.'- **Executing**: 0 (Calling).'."\n"
."\n"
.'- **Succeeded**: 1 (Connected).'."\n"
."\n"
.'- **NoAnswer**: 2 (No answer).'."\n"
."\n"
.'- **NotExist**: 3 (Nonexistent number).'."\n"
."\n"
.'- **Busy**: 4 (Line busy).'."\n"
."\n"
.'- **Cancelled**: 5 (Call canceled due to job stop).'."\n"
."\n"
.'- **Failed**: 6 (Call failed).'."\n"
."\n"
.'- **NotConnected**: 7 (Cannot connect).'."\n"
."\n"
.'- **PoweredOff**: 8 (Phone powered off).'."\n"
."\n"
.'- **OutOfService**: 9 (Called number out of service).'."\n"
."\n"
.'- **InArrears**: 10 (Called number overdue payment).'."\n"
."\n"
.'- **EmptyNumber**: 11 (Empty number, no outbound call).'."\n"
."\n"
.'- **PerDayCallCountLimit**: 12 (Daily call limit exceeded).'."\n"
."\n"
.'- **ContactBlockList**: 13 (Blacklisted).'."\n"
."\n"
.'- **CallerNotRegistered**: 14 (Caller number not registered).'."\n"
."\n"
.'- **Terminated**: 15 (Call terminated).'."\n"
."\n"
.'- **VerificationCancelled**: 16 (Call canceled due to pre-call validation failure).'."\n"
."\n"
.'- **OutOfServiceNoCall**: 17 (Called number out of service, no outbound call).'."\n"
."\n"
.'- **InArrearsNoCall**: 18 (Called number overdue payment, no outbound call).'."\n"
."\n"
.'- **CallingNumberNotExist**: 19 (Caller number does not exist).'."\n"
."\n"
.'- **SucceededFinish**: 20 (Connected and ended normally).'."\n"
."\n"
.'- **SucceededChatbotHangUpAfterNoAnswer**: 21 (Connected and robot hung up after rejection).'."\n"
."\n"
.'- **SucceededChatbotHangUpAfterSilence**: 22 (Connected and robot hung up after silence timeout).'."\n"
."\n"
.'- **SucceededClientHangUpAfterNoAnswer**: 23 (Connected and client hung up after rejection).'."\n"
."\n"
.'- **SucceededClientHangUp**: 24 (Connected and client hung up without reason).'."\n"
."\n"
.'- **SucceededTransferByIntent**: 25 (Connected and transferred to agent based on intent match).'."\n"
."\n"
.'- **SucceededTransferAfterNoAnswer**: 26 (Connected and transferred to agent after rejection).'."\n"
."\n"
.'- **SucceededInoInterAction**: 27 (Connected and no interaction from client side).'."\n"
."\n"
.'- **SucceededError**: 28 (Connected but system error interrupted).'."\n"
."\n"
.'- **SucceededSpecialInterceptVoiceAssistant**: 29 (Connected but intercepted by voice assistant).'."\n"
."\n"
.'- **SucceededSpecialInterceptExtensionNumberTransfer**: 30 (Connected but intercepted by extension transfer).'."\n"
."\n"
.'- **SucceededSpecialInterceptCustomSpecialIntercept**: 31 (Connected but intercepted by custom rule).'."\n"
."\n"
.'- **HighRiskSipCode**: 32 (High-risk SIP code, no outbound call).', 'type' => 'string', 'example' => 'Executing', 'title' => ''],
'TaskStatusName' => ['description' => 'Display text for task status'."\n"
."\n"
.'- **Executing**: 0 (Calling).'."\n"
."\n"
.'- **Succeeded**: 1 (Connected).'."\n"
."\n"
.'- **NoAnswer**: 2 (No answer).'."\n"
."\n"
.'- **NotExist**: 3 (Nonexistent number).'."\n"
."\n"
.'- **Busy**: 4 (Line busy).'."\n"
."\n"
.'- **Cancelled**: 5 (Call canceled due to job stop).'."\n"
."\n"
.'- **Failed**: 6 (Call failed).'."\n"
."\n"
.'- **NotConnected**: 7 (Cannot connect).'."\n"
."\n"
.'- **PoweredOff**: 8 (Phone powered off).'."\n"
."\n"
.'- **OutOfService**: 9 (Called number out of service).'."\n"
."\n"
.'- **InArrears**: 10 (Called number overdue payment).'."\n"
."\n"
.'- **EmptyNumber**: 11 (Empty number, no outbound call).'."\n"
."\n"
.'- **PerDayCallCountLimit**: 12 (Daily call limit exceeded).'."\n"
."\n"
.'- **ContactBlockList**: 13 (Blacklisted).'."\n"
."\n"
.'- **CallerNotRegistered**: 14 (Caller number not registered).'."\n"
."\n"
.'- **Terminated**: 15 (Call terminated).'."\n"
."\n"
.'- **VerificationCancelled**: 16 (Call canceled due to pre-call validation failure).'."\n"
."\n"
.'- **OutOfServiceNoCall**: 17 (Called number out of service, no outbound call).'."\n"
."\n"
.'- **InArrearsNoCall**: 18 (Called number overdue payment, no outbound call).'."\n"
."\n"
.'- **CallingNumberNotExist**: 19 (Caller number does not exist).'."\n"
."\n"
.'- **SucceededFinish**: 20 (Connected and ended normally).'."\n"
."\n"
.'- **SucceededChatbotHangUpAfterNoAnswer**: 21 (Connected and robot hung up after rejection).'."\n"
."\n"
.'- **SucceededChatbotHangUpAfterSilence**: 22 (Connected and robot hung up after silence timeout).'."\n"
."\n"
.'- **SucceededClientHangUpAfterNoAnswer**: 23 (Connected and client hung up after rejection).'."\n"
."\n"
.'- **SucceededClientHangUp**: 24 (Connected and client hung up without reason).'."\n"
."\n"
.'- **SucceededTransferByIntent**: 25 (Connected and transferred to agent based on intent match).'."\n"
."\n"
.'- **SucceededTransferAfterNoAnswer**: 26 (Connected and transferred to agent after rejection).'."\n"
."\n"
.'- **SucceededInoInterAction**: 27 (Connected and no interaction from client side).'."\n"
."\n"
.'- **SucceededError**: 28 (Connected but system error interrupted).'."\n"
."\n"
.'- **SucceededSpecialInterceptVoiceAssistant**: 29 (Connected but intercepted by voice assistant).'."\n"
."\n"
.'- **SucceededSpecialInterceptExtensionNumberTransfer**: 30 (Connected but intercepted by extension transfer).', 'type' => 'string', 'example' => '正在拨打', 'title' => ''],
'JobStatus' => ['description' => 'Job status'."\n"
."\n"
.'- 0: Scheduling'."\n"
."\n"
.'- 1: Executing'."\n"
."\n"
.'- 2: Succeeded'."\n"
."\n"
.'- 3: Paused'."\n"
."\n"
.'- 4: Failed'."\n"
."\n"
.'- 5: Cancelled', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'DialException' => ['description' => 'Exception details', 'type' => 'string', 'example' => '[{"code":"OutboundCallError.SipCodeError", "params":[{"key":"SipCode","value":"500"}]}]', 'title' => ''],
'UserName' => ['description' => 'Username', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'CallDurationDisplay' => ['description' => 'Call duration', 'type' => 'string', 'example' => '47″', 'title' => ''],
'HasAnswered' => ['description' => 'Indicates whether the called party answered', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'JobStatusName' => ['description' => 'Display text for job status'."\n"
."\n"
.'- 0: Scheduling'."\n"
."\n"
.'- 1: Executing'."\n"
."\n"
.'- 2: Succeeded'."\n"
."\n"
.'- 3: Paused'."\n"
."\n"
.'- 4: Failed'."\n"
."\n"
.'- 5: Cancelled', 'type' => 'string', 'example' => '调度中', 'title' => ''],
'CallDuration' => ['description' => 'Call duration, in milliseconds', 'type' => 'integer', 'format' => 'int32', 'example' => '46000', 'title' => ''],
'TaskCreateTime' => ['description' => 'Task creation time', 'type' => 'integer', 'format' => 'int64', 'example' => '1646792941', 'title' => ''],
'JobStatusString' => ['description' => 'Job status'."\n"
."\n"
.'- Scheduling (0)'."\n"
."\n"
.'- Executing (1)'."\n"
."\n"
.'- Completed—Reached (2)'."\n"
."\n"
.'- Paused (3)'."\n"
."\n"
.'- Failed—Line busy (4)'."\n"
."\n"
.'- Cancelled (5)', 'type' => 'string', 'example' => 'Scheduling', 'title' => ''],
'HasReachedEndOfFlow' => ['description' => 'Indicates whether the conversation ended', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'example' => '73df6283-26b2-402d-bad0-ffa489923ea1', 'title' => ''],
'HasHangUpByRejection' => ['description' => 'Indicates whether the call ended due to rejection', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'TaskEndReason' => ['description' => 'Reason why the task ended'."\n"
."\n"
.'- FINISHED(1,"Normal completion")'."\n"
."\n"
.'- CHATBOT\\_HANGUP\\_AFTER\\_NOANSWER(2, "Robot hangup after rejection")'."\n"
."\n"
.'- CHATBOT\\_HANGUP\\_AFTER\\_SILENCE(3, "Robot hangup after silence timeout")'."\n"
."\n"
.'- CLIENT\\_HANGUP\\_AFTER\\_NOANSWER(4, "Client hangup after rejection")'."\n"
."\n"
.'- CLIENT\\_HANGUP(5, "Client hangup without reason")'."\n"
."\n"
.'- TRANSFER\\_BY\\_INTENT(6, "Transfer to agent based on intent match")'."\n"
."\n"
.'- TRANSFER\\_AFTER\\_NOANSWER(7, "Transfer to agent after rejection")'."\n"
."\n"
.'- INO\\_INTERACTION(8, "No interaction from client side")'."\n"
."\n"
.'- ERROR(9, "System error interrupted")'."\n"
."\n"
.'- SPECIAL\\_INTERCEPT\\_VOICE\\_ASSISTANT(10, "Intercepted by voice assistant")'."\n"
."\n"
.'- SPECIAL\\_INTERCEPT\\_EXTENSION\\_NUMBER\\_TRANSFER(11, "Intercepted by extension transfer")', 'type' => 'integer', 'format' => 'int32', 'example' => 'OutOfService', 'title' => ''],
'JobGroupId' => ['description' => 'Job group ID', 'type' => 'string', 'example' => '37db3113-ad34-4ba3-b930-468f016bbf95', 'title' => ''],
'TaskStatus' => ['description' => 'Valid values:'."\n"
."\n"
.'- **Executing**: 0 (Calling).'."\n"
."\n"
.'- **Succeeded**: 1 (Connected).'."\n"
."\n"
.'- **NoAnswer**: 2 (No answer).'."\n"
."\n"
.'- **NotExist**: 3 (Nonexistent number).'."\n"
."\n"
.'- **Busy**: 4 (Line busy).'."\n"
."\n"
.'- **Cancelled**: 5 (Call canceled due to job stop).'."\n"
."\n"
.'- **Failed**: 6 (Call failed).'."\n"
."\n"
.'- **NotConnected**: 7 (Cannot connect).'."\n"
."\n"
.'- **PoweredOff**: 8 (Phone powered off).'."\n"
."\n"
.'- **OutOfService**: 9 (Called number out of service).'."\n"
."\n"
.'- **InArrears**: 10 (Called number overdue payment).'."\n"
."\n"
.'- **EmptyNumber**: 11 (Empty number, no outbound call).'."\n"
."\n"
.'- **PerDayCallCountLimit**: 12 (Daily call limit exceeded).'."\n"
."\n"
.'- **ContactBlockList**: 13 (Blacklisted).'."\n"
."\n"
.'- **CallerNotRegistered**: 14 (Caller number not registered).'."\n"
."\n"
.'- **Terminated**: 15 (Call terminated).'."\n"
."\n"
.'- **VerificationCancelled**: 16 (Call canceled due to pre-call validation failure).'."\n"
."\n"
.'- **OutOfServiceNoCall**: 17 (Called number out of service, no outbound call).'."\n"
."\n"
.'- **InArrearsNoCall**: 18 (Called number overdue payment, no outbound call).'."\n"
."\n"
.'- **CallingNumberNotExist**: 19 (Caller number does not exist).'."\n"
."\n"
.'- **SucceededFinish**: 20 (Connected and ended normally).'."\n"
."\n"
.'- **SucceededChatbotHangUpAfterNoAnswer**: 21 (Connected and robot hung up after rejection).'."\n"
."\n"
.'- **SucceededChatbotHangUpAfterSilence**: 22 (Connected and robot hung up after silence timeout).'."\n"
."\n"
.'- **SucceededClientHangUpAfterNoAnswer**: 23 (Connected and client hung up after rejection).'."\n"
."\n"
.'- **SucceededClientHangUp**: 24 (Connected and client hung up without reason).'."\n"
."\n"
.'- **SucceededTransferByIntent**: 25 (Connected and transferred to agent based on intent match).'."\n"
."\n"
.'- **SucceededTransferAfterNoAnswer**: 26 (Connected and transferred to agent after rejection).'."\n"
."\n"
.'- **SucceededInoInterAction**: 27 (Connected and no interaction from client side).'."\n"
."\n"
.'- **SucceededError**: 28 (Connected but system error interrupted).'."\n"
."\n"
.'- **SucceededSpecialInterceptVoiceAssistant**: 29 (Connected but intercepted by voice assistant).'."\n"
."\n"
.'- **SucceededSpecialInterceptExtensionNumberTransfer**: 30 (Connected but intercepted by extension transfer).', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'JobId' => ['description' => 'Job ID', 'type' => 'string', 'example' => '6203248e-e652-4ef8-a1eb-586ed7b54dc2', 'title' => ''],
'RecordingDuration' => ['description' => 'Ringing duration, in seconds', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TaskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '479aea04-3a92-4ac3-935d-c8798c667850', 'title' => ''],
'DialExceptionOld' => ['description' => 'Exception details', 'type' => 'string', 'example' => '["OutboundCallError.SipTrunkError"]', 'title' => ''],
'DialExceptionCodes' => [
'description' => 'Exception codes shown on the remarks page',
'items' => ['description' => 'List of exception codes', 'type' => 'string', 'example' => '[ { "code":"OutboundCallError.SipCodeError", "hint":"线路侧异常码:480, 首先确定主叫和被叫正确,其次再联系号码和线路的供应商处理!" } ]', 'title' => ''],
'type' => 'array',
'title' => '',
'example' => '',
],
'HasLastPlaybackCompleted' => ['description' => 'Indicates whether the last audio playback completed before hangup', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ScriptName' => ['description' => 'Scenario name', 'type' => 'string', 'example' => '慢病线索', 'title' => ''],
'CallingNumber' => ['description' => 'Calling number', 'type' => 'string', 'example' => '02152739269', 'title' => ''],
'Labels' => [
'description' => 'Labels matched for this outbound call',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'K' => ['description' => 'Label name', 'type' => 'string', 'example' => '是否满意', 'title' => ''],
'V' => ['description' => 'Matched label value', 'type' => 'string', 'example' => '是', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'type' => 'object',
'title' => '',
'example' => '',
],
'type' => 'array',
'title' => '',
],
'VariableNames' => [
'description' => 'Complete list of label keys',
'type' => 'array',
'items' => ['description' => 'Complete list of label keys', 'type' => 'string', 'example' => '["是否满意","是否是本人","是否收到"]', 'title' => ''],
'title' => '',
'example' => '',
],
'Labels' => [
'description' => 'Labels available for filtering.'."\n"
."\n"
.'> Displays all labels with enumeration values in this job group.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'Label name', 'type' => 'string', 'example' => '是否满意', 'title' => ''],
'ValueList' => [
'description' => 'List of label values',
'type' => 'array',
'items' => ['description' => 'Label 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' => 'This API initiates a call directly, bypassing the outbound call scheduling system. It is available only to users on the whitelist.',
'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', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => ['description' => 'Task group ID', 'type' => 'string', 'required' => false, 'example' => '4f21446e-324e-46f2-bf62-7f341fb004ea', 'title' => ''],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => ['description' => 'Scenario ID. This field supports backward compatibility with legacy outbound calling features. You can omit it.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'JobJson',
'in' => 'query',
'schema' => ['description' => 'Job data, which includes the following fields:'."\n"
."\n"
.'extras // Optional extra information'."\n"
."\n"
.'- key // Key for a custom variable'."\n"
."\n"
.'- value // Value for a custom variable'."\n"
."\n"
.'contacts // Required contact information for the callee'."\n"
."\n"
.'- phoneNumber // Required phone number of the callee'."\n"
."\n"
.'- referenceId // Required contact ID (user-defined) to avoid duplicate names'."\n"
."\n"
.'- role // Optional role of this contact in the outbound call scenario. If omitted, no role distinction is made'."\n"
."\n"
.'- honorific // Optional honorific for the contact'."\n"
."\n"
.'- name // Optional name of the contact', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{'."\n"
.' "extras": [{'."\n"
.' "value": "测试",'."\n"
.' "key": "测试"'."\n"
.' }, {'."\n"
.' "key": "ServiceId",'."\n"
.' "value": null'."\n"
.' }, {'."\n"
.' "key": "TenantId",'."\n"
.' "value": null'."\n"
.' }],'."\n"
.' "contacts": [{'."\n"
.' "phonenumber": "198********",'."\n"
.' "name": "张三",'."\n"
.' "priority": 5,'."\n"
.' "referenceId": "C01"'."\n"
.' }]'."\n"
.'}', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'Scenario ID (required)', 'type' => 'string', 'required' => false, 'example' => '1eeae263-54ca-4a52-ae14-62da58f3c473', 'title' => ''],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'List of caller numbers',
'example' => '10086',
'items' => ['description' => 'Caller number', 'type' => 'string', 'required' => false, 'example' => '05710*******', 'title' => ''],
'maxItems' => 99,
'required' => false,
'type' => 'array',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'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' => '8a621aa1-d2e7-43f3-b54d-8830af73c468', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call succeeded. true means success. false means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'TaskIds' => [
'description' => 'Mapping between third-party contact IDs and outbound call task IDs',
'items' => [
'properties' => [
'Key' => ['description' => 'Third-party contact ID', 'type' => 'string', 'example' => 'c93cdd1c-f9b5-4758-be43-7a237a7eaa1d', 'title' => ''],
'Value' => ['description' => 'Outbound call task ID', 'type' => 'string', 'example' => '62229628-45d8-41bd-a80f-6e4c0a39f79b', 'title' => ''],
],
'type' => 'object',
'description' => '',
'title' => '',
'example' => '',
],
'type' => 'array',
'title' => '',
'example' => '',
],
'CallIds' => [
'description' => 'List of call IDs',
'items' => [
'properties' => [
'Key' => ['description' => 'Third-party contact ID', 'type' => 'string', 'example' => 'c93cdd1c-f9b5-4758-be43-7a237a7eaa1d', 'title' => ''],
'Value' => ['description' => 'Call ID for the task', 'type' => 'string', 'example' => '62229628-45d8-41bd-a80f-6e4c0a39f79b', '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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => ['description' => 'The job group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6b3ea2a1-32b3-4041-842b-9bde5de9dda0', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Whether the request was successful.', 'type' => 'boolean', 'example' => 'true', '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' => 'Submits a draft job group. 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', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503', 'title' => ''],
],
[
'name' => 'ResourceRecording',
'in' => 'query',
'schema' => ['description' => 'Script recording data', 'type' => 'string', 'required' => false, 'example' => '{"contactId":"3d35c0487cc041abb7ad0ce61752601f","duration":27,"fileName":"ce2659e5-a20b-4f8e-91b5-5cd909c6b96e_3d35c0487cc041abb7ad0ce61752601f.wav","filePath":"oss://ForCompatibility/waveforms/","startTime":1579057583670,"type":"Source"}', 'title' => ''],
],
[
'name' => 'MergedRecording',
'in' => 'query',
'schema' => ['description' => 'Script recording data', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"contactId":"3d35c0487cc041abb7ad0ce61752601f","duration":27,"fileName":"ce2659e5-a20b-4f8e-91b5-5cd909c6b96e_3d35c0487cc041abb7ad0ce61752601f.wav","filePath":"oss://ForCompatibility/waveforms/","startTime":1579057583670,"type":"Merged"}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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' => ''],
],
'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' => 'Submits a recording of an outbound call. This operation 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', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'Description', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '第一版本提交审核', 'title' => ''],
],
[
'name' => 'From',
'in' => 'query',
'schema' => ['description' => 'Source of review submission', 'type' => 'string', 'required' => false, 'example' => 'MAINSITE', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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' => 'Is successful', 'type' => 'boolean', 'example' => 'true', '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 the scenario for release 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' => 'Suspends outbound calls for a list of phone numbers.',
'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' => 'The instance ID. This parameter is required.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a5fc6490-ef1e-4666-870a-07a4e586c414', 'title' => ''],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'The task group ID. This parameter is required.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'f745881b-343d-43e4-9c51-31b7b063031c', 'title' => ''],
],
[
'name' => 'CalledNumbers',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of called numbers.',
'type' => 'array',
'items' => ['description' => 'List of called numbers', 'type' => 'string', 'required' => false, 'example' => '15107137208', 'title' => ''],
'required' => false,
'example' => '[]',
'maxItems' => 99,
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', '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' => 'Suspends outbound calls using data from a file.',
'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' => false, 'docRequired' => true, 'example' => 'a4274627-265f-4e14-b2d6-4ee7d4f8593e', 'title' => ''],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'Task group ID. Required.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0197261b-30e6-467b-83d6-7f72af868b03', 'title' => ''],
],
[
'name' => 'FilePath',
'in' => 'query',
'schema' => ['description' => 'File path. Required.'."\n"
."\n"
.'> Get the value for this parameter by calling the GetJobDataUploadParams operation. Use the Folder value returned in the response as the FilePath value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'xxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'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 call was suspended successfully.', 'type' => 'boolean', 'example' => 'true', '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', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ef4c09ac-2f5c-49e7-9d33-5d85249cee10', 'title' => ''],
],
[
'name' => 'All',
'in' => 'query',
'schema' => ['description' => 'Filter condition: whether to suspend all jobs.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ScenarioId',
'in' => 'query',
'schema' => ['description' => 'Filter condition, scenario ID (historical parameter, deprecated).', 'type' => 'string', 'required' => false, 'example' => '4b6dd926-3cc3-4111-a333-15d9b006fe81', 'title' => ''],
],
[
'name' => 'JobGroupId',
'in' => 'query',
'schema' => ['description' => 'Filter condition, task group ID.', 'type' => 'string', 'required' => false, 'example' => '6b3ea2a1-32b3-4041-842b-9bde5de9dda0', 'title' => ''],
],
[
'name' => 'JobId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'Job ID list.'."\n"
."\n"
.'> When ALL is false, JobId is required.',
'example' => '11994321-e6bc-47bb-8b1c-8eef8f2f768b',
'items' => ['description' => 'Job ID.', 'type' => 'string', '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 is the ReferenceId uploaded by the customer when uploading the outbound list.',
'example' => 'de3ab269-6746-477c-b13d-bd49f13202c2',
'items' => ['description' => 'Third-party ID of the job.', 'type' => 'string', '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.', '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' => '1364f208-982d-4d0c-89aa-d56e22b47589', 'title' => ''],
'Success' => ['description' => 'Whether successful.', 'type' => 'boolean', 'example' => 'true', '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' => 'You can pause the 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' => 'This parameter is deprecated.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => 'The resource type.',
'enumValueTitles' => ['INSTANCE' => 'The resource is an instance.'],
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'INSTANCE',
'title' => '',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'A list of resource IDs. The value of n can be from 1 to 50.',
'type' => 'array',
'items' => ['description' => 'The resource ID. If the resource type is INSTANCE, enter 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' => 'The list of tags. If the key and value of a tag are different from existing tags, a new tag is created.'."\n"
."\n"
.'> Use the ListResourceTags operation to get the list of tags for an instance.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key. The value of n can be from 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'Tag.1.Key=key1', 'title' => ''],
'Value' => ['description' => 'The value of the tag. The value can contain 1 to 20 characters.', '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' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code of the API call.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The message returned for the API call.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', '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' => 'Adds 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' => 'Prepares a task for execution.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '33040b9a-b04b-452f-b554-cd6f3a15f850', 'title' => ''],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c9e42cd7-ba99-4872-9802-e05719ab051c', 'title' => ''],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => ['description' => 'The ID of the account that owns the instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1971226538081821', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Succes', 'title' => ''],
'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503', 'title' => ''],
],
'description' => 'The response data.',
'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' => 'ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '174952ab-9825-4cc9-a5e2-de82d7fa4cdd', 'title' => ''],
],
[
'name' => 'CallId',
'in' => 'query',
'schema' => ['description' => 'ID of the call.'."\n"
."\n"
.'> You can get this ID by calling the DescribeJob operation.', '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 call was stopped successfully.', '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' => 'Terminates a call during an active session.',
'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',
'enumValueTitles' => ['INSTANCE' => 'INSTANCE'],
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'INSTANCE',
'title' => '',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => ['description' => 'Remove 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. Default value: list of instance IDs. Valid values for n: 1 to 50',
'type' => 'array',
'items' => ['description' => 'Resource ID. Default value: 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. Valid values for n: 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' => 'Response 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 call 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' => 'Remove tags from resources.',
'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' => 'File key 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 recording ID', 'type' => 'string', 'example' => '5feaab8a-97fd-4720-8108-79e017f2d3ac', 'title' => ''],
'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Is successful', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'Return code', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'Interface 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 recording files.',
'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' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '38d2e8ed-04e9-4dac-83b5-a8e57642ef13', 'title' => ''],
],
[
'name' => 'ScriptId',
'in' => 'query',
'schema' => ['description' => 'The script ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Success', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Script' => [
'description' => 'The script information.',
'properties' => [
'Status' => ['description' => 'The status of the application version.', 'type' => 'string', 'example' => 'PUBLISHED', 'title' => ''],
'UpdateTime' => ['description' => 'The time when the script was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1578881227000', 'title' => ''],
'Industry' => ['description' => 'The industry.', 'type' => 'string', 'example' => '金融', 'title' => ''],
'ScriptDescription' => ['description' => 'The script description.', 'type' => 'string', 'example' => '销售话术', 'title' => ''],
'IsDrafted' => ['description' => 'Indicates whether the application version is a draft.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'DebugStatus' => ['description' => 'The debug status.', 'type' => 'string', 'example' => 'PUBLISHED', 'title' => ''],
'ScriptId' => ['description' => 'The script ID.', 'type' => 'string', 'example' => 'e4e2a770-b97b-465a-80d8-06dca008c503', 'title' => ''],
'IsDebugDrafted' => ['description' => 'Indicates whether the debug version is a draft.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'ScriptName' => ['description' => 'The script name.', 'type' => 'string', 'example' => '销售话术', 'title' => ''],
'Scene' => ['description' => 'The scenario.', 'type' => 'string', 'example' => '电销', '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' => [],
],
],
'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' => 'RESOURCE',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'CreateInstanceBindNumber',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateInstanceBindNumber',
'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' => 'DescribeScriptVoiceConfig',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeScriptVoiceConfig',
'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' => 'SaveAnnotationMissionTagInfoList',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SaveAnnotationMissionTagInfoList',
'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' => 'DescribeIntentStatistics',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeIntentStatistics',
'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' => 'GetAfterAnswerDelayPlayback',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAfterAnswerDelayPlayback',
'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' => 'QueryJobsWithResult',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:QueryJobsWithResult',
'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' => 'ModifyTTSConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyTTSConfig',
'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' => 'ModifyBeebotIntentUserSay',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyBeebotIntentUserSay',
'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' => 'ModifyGlobalQuestion',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyGlobalQuestion',
'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' => 'ListJobsByGroup',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListJobsByGroup',
'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' => 'CreateBeebotIntentLgf',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateBeebotIntentLgf',
'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' => 'ListDownloadTasks',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListDownloadTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'TagResources',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:TagResources',
'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' => 'SaveBaseStrategyPeriod',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SaveBaseStrategyPeriod',
'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' => 'ListChatbotInstances',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListChatbotInstances',
'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' => 'CreateAgentProfile',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateAgentProfile',
'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' => 'GetAsrServerInfo',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetAsrServerInfo',
'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' => 'GetRealtimeConcurrencyReport',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetRealtimeConcurrencyReport',
'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' => 'DescribeJobGroup',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetJobGroup',
'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' => 'DeleteScriptRecording',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteScriptRecording',
'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' => 'DescribeTTSConfig',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeTTSConfig',
'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' => 'SubmitRecording',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:SubmitRecording',
'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' => 'DeleteScript',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteScript',
'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' => 'QueryScriptsByStatus',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:QueryScriptsByStatus',
'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' => 'QueryScriptWaveforms',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:QueryScriptWaveforms',
'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' => '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' => 'DeleteAllNumberDistrictInfo',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteAllNumberDistrictInfo',
'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' => 'StartJob',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:StartJob',
'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' => 'DeleteIntent',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteIntent',
'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' => 'ListApiPlugins',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListApiPlugins',
'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' => 'ResumeJobs',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:ResumeJobs',
'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' => 'CreateJobGroup',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateJobGroup',
'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' => 'DescribeGlobalQuestion',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeGlobalQuestion',
'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' => 'DeleteBeebotIntentUserSay',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteBeebotIntentUserSay',
'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' => 'ListAnnotationMissionSession',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListAnnotationMissionSession',
'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' => 'CreateGlobalQuestion',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateGlobalQuestion',
'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' => 'CreateInstance',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateInstance',
'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' => 'ModifyJobGroup',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyJobGroup',
'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' => 'AssignJobsAsync',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:AssignJobsAsync',
'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' => 'DeleteBeebotIntent',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteBeebotIntent',
'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' => 'ModifyBeebotIntent',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyBeebotIntent',
'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' => 'DescribeTTSDemo',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeTTSDemo',
'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' => 'CreateBatchRepeatJob',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateBatchRepeatJobs',
'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' => 'ListScriptPublishHistories',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListScriptPublishHistories',
'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' => 'DeleteJobGroup',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteJobGroup',
'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' => 'ListBeebotIntentUserSay',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListBeebotIntentUserSay',
'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' => 'ListIntentions',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListIntentions',
'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' => 'DescribeTagHitsSummary',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeTagHitsSummary',
'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' => 'CreateTaskExportTask',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateTaskExportTask',
'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' => 'InflightTaskTimeout',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:InflightTaskTimeout',
'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' => 'ChangeResourceGroup',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:ChangeResourceGroup',
'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' => 'SaveContactWhiteList',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:SaveContactWhiteList',
'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' => 'DeleteScriptWaveform',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'outboundbot:DeleteScriptWaveform',
'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' => 'DescribeGroupExecutingInfo',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeGroupExecutingInfo',
'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' => 'ListGlobalQuestions',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:ListGlobalQuestions',
'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' => 'TaskPreparing',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'outboundbot:TaskPreparing',
'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' => 'CreateBeebotIntentUserSay',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateBeebotIntentUserSay',
'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' => 'ListTags',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListTags',
'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' => 'SuspendJobs',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:SuspendJobs',
'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' => 'ListScriptRecording',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListScriptRecording',
'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' => 'ModifyTagGroups',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyTagGroups',
'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' => 'CreateDialogueFlow',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateDialogueFlow',
'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' => 'GetJobDataUploadParams',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetJobDataUploadParams',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListIntents',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListIntents',
'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' => 'CreateTag',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateTag',
'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' => 'ModifyScriptVoiceConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyScriptVoiceConfig',
'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' => 'GetMaxAttemptsPerDay',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetMaxAttemptsPerDay',
'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' => 'DescribeJobGroupExportTaskProgress',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeJobGroupExportTaskProgress',
'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' => 'DescribeDialogueNodeStatistics',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:DescribeDialogueNodeStatistics',
'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' => 'ModifyInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'outboundbot:ModifyInstance',
'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' => 'UploadScriptRecording',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:UploadScriptRecording',
'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' => 'GetTaskByUuid',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'outboundbot:GetTaskByUuid',
'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' => 'ListJobGroupsAsync',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListJobGroupsAsync',
'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' => 'ListFlashSmsTemplates',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'outboundbot:ListFlashSmsTemplates',
'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' => 'ImportScript',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:ImportScript',
'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' => 'CreateJobDataParsingTask',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'outboundbot:CreateJobDataParsingTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'OutboundBot', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:outboundbot:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
];