'1.0',
'info' => ['style' => 'RPC', 'product' => 'VoiceNavigator', 'version' => '2018-06-12'],
'directories' => [
[
'children' => ['ModifyGreetingConfig', 'ModifySilenceTimeoutConfig', 'ModifyTTSConfig', 'ModifyUnrecognizingConfig', 'DescribeTTSConfig', 'DescribeExportProgress', 'AssociateChatbotInstance', 'AuditTTSVoice', 'CollectedNumber', 'ExportStatisticalData', 'SilenceTimeout'],
'type' => 'directory',
'title' => 'Configuration management',
],
[
'children' => ['DescribeConversation', 'DescribeConversationContext', 'ListConversationDetails', 'QueryConversations', 'DescribeRecording', 'EndDialogue', 'SaveRecording'],
'type' => 'directory',
'title' => 'Dialog flow',
],
[
'children' => ['ListConversations', 'BeginDialogue', 'ExportConversationDetails'],
'type' => 'directory',
'title' => 'Session',
],
[
'children' => ['DebugBeginDialogue', 'DebugCollectedNumber', 'DebugDialogue'],
'type' => 'directory',
'title' => 'Debug',
],
[
'children' => ['DisableInstance', 'EnableInstance', 'ModifyInstance', 'DescribeNavigationConfig', 'DescribeInstance', 'DescribeStatisticalData'],
'type' => 'directory',
'title' => 'Instance',
],
[
'children' => ['ListChatbotInstances', 'CreateDownloadUrl', 'ListDownloadTasks', 'ModifyAsrConfig', 'GetAsrConfig', 'GetRealTimeConcurrency', 'CreateInstance', 'DeleteInstance', 'Dialogue', 'ListInstances'],
'type' => 'directory',
'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AssociateChatbotInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the navigation instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'ChatbotInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the Chatbot instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'chatbot-720edd02b66a', 'title' => ''],
],
[
'name' => 'ChatbotName',
'in' => 'query',
'schema' => ['description' => 'The name of the Chatbot instance.', 'type' => 'string', 'required' => false, 'example' => '客服机器人', 'title' => ''],
],
[
'name' => 'UnionSource',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'NluServiceParamsJson',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'NluServiceType',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Associate a chatbot instance',
'summary' => 'Associates a Chatbot instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-12-27T03:10:11.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-09-19T12:51:36.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:AssociateChatbotInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
],
'AuditTTSVoice' => [
'summary' => 'Previews a TTS voice.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The navigation instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'Voice',
'in' => 'query',
'schema' => ['description' => 'The voice.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aixia', 'title' => ''],
],
[
'name' => 'Text',
'in' => 'query',
'schema' => ['description' => 'The preview text.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '你好', 'title' => ''],
],
[
'name' => 'SpeechRate',
'in' => 'query',
'schema' => ['description' => 'The speech rate.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '100', 'title' => ''],
],
[
'name' => 'Volume',
'in' => 'query',
'schema' => ['description' => 'The volume.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => 'The TTS engine.', 'type' => 'string', 'required' => false, 'example' => 'ali', 'title' => ''],
],
[
'name' => 'PitchRate',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'SecretKey',
'in' => 'query',
'schema' => ['description' => 'The AccessKey secret.', 'type' => 'string', 'required' => false, 'example' => 'ZDc3********DAzM2E0YjM5NTFkMDQ1', 'title' => ''],
],
[
'name' => 'AccessKey',
'in' => 'query',
'schema' => ['description' => 'The AccessKey ID of the namespace.', 'type' => 'string', 'required' => false, 'example' => 'b4331******a4640ce1f88e27ac8df0', 'title' => ''],
],
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey of the third-party voice configuration.', 'type' => 'string', 'required' => false, 'example' => 'be******', 'title' => ''],
],
[
'name' => 'ExtParams',
'in' => 'query',
'schema' => ['description' => 'The extended parameters.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'AuditionUrl' => ['description' => 'The preview URL.', 'type' => 'string', 'example' => 'http://voicenavigator-cn-shanghai.oss-cn-shanghai.aliyuncs.com/exported_files/2020-02-20/ttsConfig-1582188148528-abd8e407de0a49b381bb591bd91fc073.wav?Expires=1582188208&OSSAccessKeyId=LTAIppQY*******&Signature=FaBassElzqGEB0H2TvTKPJsOJHs%3D', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"AuditionUrl\\": \\"http://voicenavigator-cn-shanghai.oss-cn-shanghai.aliyuncs.com/exported_files/2020-02-20/ttsConfig-1582188148528-abd8e407de0a49b381bb591bd91fc073.wav?Expires=1582188208&OSSAccessKeyId=LTAIppQY*******&Signature=FaBassElzqGEB0H2TvTKPJsOJHs%3D\\"\\n}","type":"json"}]',
'title' => 'Preview a TTS voice',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-02-04T14:18:44.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-06-21T12:20:15.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:AuditionTTSVoice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'BeginDialogue' => [
'summary' => 'Starts a conversation.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => ['description' => 'The called number.', 'type' => 'string', 'required' => false, 'example' => '10086', 'title' => ''],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => ['description' => 'The calling number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1358158****', 'title' => ''],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => ['description' => 'The conversation ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c28fc549-d88f-4f6e-85ad-a0806e5e39c0', 'title' => ''],
],
[
'name' => 'InitialContext',
'in' => 'query',
'schema' => ['description' => 'The conversation context.', 'type' => 'string', 'required' => false, 'example' => '{\\"channelId\\":\\"fe2559d3-5fc9-4fa5-8314-32b9f762791d\\"}', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4d7db6670b8e41b5adb1f21560ea9272', 'title' => ''],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => ['description' => 'The instance owner ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1231639035307976', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Action' => ['description' => 'The action to perform.', 'type' => 'string', 'example' => 'Broadcast', 'title' => ''],
'Interruptible' => ['description' => 'Specifies whether the IVR playback can be interrupted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
'ActionParams' => ['description' => 'The action parameters.', 'type' => 'string', 'example' => '{\\"duration\\":31340,\\"endTime\\":1638243934786,\\"hangUpDirection\\":\\"ivr\\",\\"startTime\\":1638243903446}', 'title' => ''],
'TextResponse' => ['description' => 'The text response.', 'type' => 'string', 'example' => '您好,欢迎致电智能助手', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"Action\\": \\"Broadcast\\",\\n \\"Interruptible\\": true,\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"ActionParams\\": \\"{\\\\\\\\\\\\\\"duration\\\\\\\\\\\\\\":31340,\\\\\\\\\\\\\\"endTime\\\\\\\\\\\\\\":1638243934786,\\\\\\\\\\\\\\"hangUpDirection\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ivr\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":1638243903446}\\",\\n \\"TextResponse\\": \\"您好,欢迎致电智能助手\\"\\n}","type":"json"}]',
'title' => 'Start a session',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:StartConversation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [],
],
],
'CollectedNumber' => [
'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' => '0099b75d-60fd-4c63-8541-7fbba0ae6bb0', 'title' => ''],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the conversation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0099b75d-60fd-4c63-8541-7fbba0ae6bb0', 'title' => ''],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => ['description' => 'The number entered by the user.', 'type' => 'string', 'required' => false, 'example' => '1500060224', 'title' => ''],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance owner.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1426738157626835', 'title' => ''],
],
[
'name' => 'AdditionalContext',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Action' => ['description' => 'Specifies the next action to perform.', 'type' => 'string', 'example' => 'Broadcast', 'title' => ''],
'Interruptible' => ['description' => 'Indicates whether the IVR playback can be interrupted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', 'title' => ''],
'ActionParams' => ['description' => 'The parameters for the action.', 'type' => 'string', 'example' => '{\\"duration\\":31340,\\"endTime\\":1638243934786,\\"hangUpDirection\\":\\"ivr\\",\\"startTime\\":1638243903446}', 'title' => ''],
'TextResponse' => ['description' => 'The text to play back to the user.', 'type' => 'string', 'example' => '收号内容是123', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"Action\\": \\"Broadcast\\",\\n \\"Interruptible\\": false,\\n \\"RequestId\\": \\"da37319b-6c83-4268-9f19-814aed62e401\\",\\n \\"ActionParams\\": \\"{\\\\\\\\\\\\\\"duration\\\\\\\\\\\\\\":31340,\\\\\\\\\\\\\\"endTime\\\\\\\\\\\\\\":1638243934786,\\\\\\\\\\\\\\"hangUpDirection\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ivr\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":1638243903446}\\",\\n \\"TextResponse\\": \\"收号内容是123\\"\\n}","type":"json"}]',
'title' => 'Collect digits',
'summary' => 'Collects a number entered by a user during a call.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:CollectedNumber',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [],
],
],
'CreateDownloadUrl' => [
'summary' => 'Creates a download URL for a file.',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'DownloadTaskId',
'in' => 'query',
'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => '073f092da0a847b9bf76eb88b5931c7a', 'title' => ''],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => ['description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to query the file ID.', 'type' => 'string', 'required' => true, 'example' => '22626c39603744f5a08d4d715315561a', '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://ssml-test.oss-cn-shanghai.aliyuncs.com/key', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7401D698-0AAC-5909-B68E-88C68805FFB8', '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 message.', 'type' => 'string', 'example' => 'get upload tool url success', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create a download file URL',
'changeSet' => [
['createdAt' => '2021-11-24T12:59:40.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateDownloadUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"FileHttpUrl\\": \\"http://ssml-test.oss-cn-shanghai.aliyuncs.com/key\\",\\n \\"RequestId\\": \\"7401D698-0AAC-5909-B68E-88C68805FFB8\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"get upload tool url success\\"\\n}","type":"json"}]',
],
'CreateInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the Voice Navigator instance, which identifies the digital employee scenario.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试场景', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the instance.', 'type' => 'string', 'required' => false, 'example' => '这是一个测试场景', 'title' => ''],
],
[
'name' => 'Concurrency',
'in' => 'query',
'schema' => ['description' => 'The maximum concurrency of the instance.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'UnionSource',
'in' => 'query',
'schema' => ['description' => 'The source service.'."\n"
."\n"
.'- CCC: Cloud Contact Center', 'type' => 'string', 'required' => false, 'example' => 'CCC', 'title' => ''],
],
[
'name' => 'UnionInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the source instance.'."\n"
."\n"
.'> If you set UnionSource to CCC, set this parameter to the ID of the Cloud Contact Center instance.', 'type' => 'string', 'required' => false, 'example' => 'demo-lctms', 'title' => ''],
],
[
'name' => 'NluServiceParamsJson',
'in' => 'query',
'schema' => ['description' => 'Configuration parameters for the large language model service, in JSON format.'."\n"
."\n"
.'- Use this parameter to specify a Function Compute service.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9ab43460-c0b9-40e2-8447-48d82c97fc67', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'c28fc549-d88f-4f6e-85ad-a0806e5e39c0', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidConcurrency.LimitExceeded', 'errorMessage' => 'The specified Concurrency exceeds the upper limit.', 'description' => ''],
['errorCode' => 'InvalidInstanceName.Duplicated', 'errorMessage' => 'The specified InstanceName already exists.', '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 \\"RequestId\\": \\"9ab43460-c0b9-40e2-8447-48d82c97fc67\\",\\n \\"InstanceId\\": \\"c28fc549-d88f-4f6e-85ad-a0806e5e39c0\\"\\n}","type":"json"}]',
'title' => 'Create an Intelligent Navigation instance ',
'summary' => 'Creates a Voice Navigator instance.',
'changeSet' => [
['createdAt' => '2023-09-19T12:51:37.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'extraInfo' => ' ',
],
'DebugBeginDialogue' => [
'summary' => 'Starts a conversation in a debugging environment.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => ['description' => 'The called number.', 'type' => 'string', 'required' => false, 'example' => '10086', 'title' => ''],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => ['description' => 'The calling number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '135815*****', 'title' => ''],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => ['description' => 'The unique ID of the conversation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8a503680-815d-473e-a9b0-e010f47a64d2', 'title' => ''],
],
[
'name' => 'InitialContext',
'in' => 'query',
'schema' => ['description' => 'The initial context of the conversation.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8a503680-815d-473e-a9b0-e010f47a64d2', 'title' => ''],
],
[
'name' => 'ShouldUseSandBox',
'in' => 'query',
'schema' => ['type' => 'boolean', 'title' => '', 'description' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Action' => ['description' => 'The action to perform.', 'type' => 'string', 'example' => 'Broadcast', 'title' => ''],
'Interruptible' => ['description' => 'Specifies whether the Interactive Voice Response (IVR) broadcast can be interrupted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
'ActionParams' => ['description' => 'The action parameters.', 'type' => 'string', 'example' => '{}', 'title' => ''],
'TextResponse' => ['description' => 'The broadcast content.', 'type' => 'string', 'example' => '您好,欢迎致电智能助手', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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' => 'Start a session in the debug environment',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:DebugBeginDialogue',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Action\\": \\"Broadcast\\",\\n \\"Interruptible\\": true,\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"ActionParams\\": \\"{}\\",\\n \\"TextResponse\\": \\"您好,欢迎致电智能助手\\"\\n}","type":"json"}]',
],
'DebugCollectedNumber' => [
'summary' => 'Debugs the number collection process.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the Voice Navigator instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7cefbff0-8d50-4d6f-b93c-73cee23c1555', 'title' => ''],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the conversation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7cefbff0-8d50-4d6f-b93c-73cee23c1555', 'title' => ''],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => ['description' => 'The collected number.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Action' => ['description' => 'The next action that Voice Navigator performs.', 'type' => 'string', 'example' => 'Broadcast', 'title' => ''],
'Interruptible' => ['description' => 'Indicates whether the voice response can be interrupted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'abb4aa26-3a8e-43dd-82f8-0c3898c9c67f', 'title' => ''],
'ActionParams' => ['description' => 'The parameters for the next action.', 'type' => 'string', 'example' => '{}', 'title' => ''],
'TextResponse' => ['description' => 'The text that Voice Navigator plays to the user.', 'type' => 'string', 'example' => '您好,欢迎致电智能助手', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"Action\\": \\"Broadcast\\",\\n \\"Interruptible\\": true,\\n \\"RequestId\\": \\"abb4aa26-3a8e-43dd-82f8-0c3898c9c67f\\",\\n \\"ActionParams\\": \\"{}\\",\\n \\"TextResponse\\": \\"您好,欢迎致电智能助手\\"\\n}","type":"json"}]',
'title' => 'Collect digits in the debug environment.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:CollectedNumber',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [],
],
],
'DebugDialogue' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => ['description' => 'The user utterance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7cefbff0-8d50-4d6f-b93c-73cee23c1555', 'title' => ''],
],
[
'name' => 'AdditionalContext',
'in' => 'query',
'schema' => ['description' => 'The conversation context.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abb4aa26-3a8e-43dd-82f8-0c3898c9c67f', 'title' => ''],
],
[
'name' => 'Utterance',
'in' => 'query',
'schema' => ['description' => 'The user utterance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '是的', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Action' => ['description' => 'The action.', 'type' => 'string', 'example' => 'Broadcast', 'title' => ''],
'Interruptible' => ['description' => 'Indicates whether the IVR broadcast can be interrupted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'd74d6290-7cbe-4436-b5d7-014ebb0f4060', 'title' => ''],
'ActionParams' => ['description' => 'The action parameters.', 'type' => 'string', 'example' => '{}', 'title' => ''],
'TextResponse' => ['description' => 'The broadcast content.', 'type' => 'string', 'example' => '80d11be3-faad-4101-b4b0-59dbea28aaf0', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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' => 'Debug environment conversation',
'summary' => 'Debugs a conversation in the debug environment.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:DebugDialogue',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Action\\": \\"Broadcast\\",\\n \\"Interruptible\\": true,\\n \\"RequestId\\": \\"d74d6290-7cbe-4436-b5d7-014ebb0f4060\\",\\n \\"ActionParams\\": \\"{}\\",\\n \\"TextResponse\\": \\"80d11be3-faad-4101-b4b0-59dbea28aaf0\\"\\n}","type":"json"}]',
],
'DeleteInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd74d6290-7cbe-4436-b5d7-014ebb0f4060', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'd74d6290-7cbe-4436-b5d7-014ebb0f4060', '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\\": \\"d74d6290-7cbe-4436-b5d7-014ebb0f4060\\"\\n}","type":"json"}]',
'title' => 'DeleteInstance',
'summary' => 'Deletes a navigation instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'voicebot:DeleteInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeConversation' => [
'methods' => ['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' => '5daac920-d6c1-429f-a95f-2a798f5255b5', 'title' => ''],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => ['description' => 'The conversation ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '15608cce-36be-43d5-9361-178cbe64127b', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'EffectiveAnswerCount' => ['description' => 'The number of effective Q&A pairs.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
'ConversationId' => ['description' => 'The conversation ID.', 'type' => 'string', 'example' => '2d5aa451-661f-4f08-b0c4-28eec78decc4', 'title' => ''],
'TransferredToAgent' => ['description' => 'Indicates whether the conversation was transferred to a human agent.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'EndTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1582103299434', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
'BeginTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1582103260434', 'title' => ''],
'SkillGroupId' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => 'ABABCBAC', 'title' => ''],
'CallingNumber' => ['description' => 'The calling number.', 'type' => 'string', 'example' => '138106*****', 'title' => ''],
'UserUtteranceCount' => ['description' => 'The number of user utterances.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query conversation information',
'summary' => 'Queries conversation information.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-07-22T12:15:39.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:DescribeConversation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EffectiveAnswerCount\\": 8,\\n \\"ConversationId\\": \\"2d5aa451-661f-4f08-b0c4-28eec78decc4\\",\\n \\"TransferredToAgent\\": true,\\n \\"EndTime\\": 1582103299434,\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"BeginTime\\": 1582103260434,\\n \\"SkillGroupId\\": \\"ABABCBAC\\",\\n \\"CallingNumber\\": \\"138106*****\\",\\n \\"UserUtteranceCount\\": 10\\n}","type":"json"}]',
],
'DescribeConversationContext' => [
'summary' => 'Queries the context of a specified conversation.',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '026ca0f4-483b-4252-ae1d-1f15f056f8b9', 'title' => ''],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the conversation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '361c8a53-0e29-42f3-8aa7-c7752d010399', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'b19af5ce5314ac08108d1b33fe20e15', 'title' => ''],
'ConversationContext' => ['description' => 'The conversation context, returned as a JSON string.', 'type' => 'string', 'example' => ' { "CallingNumber": "135815***", "AdditionalContext": "", "ConversationId": "361c8a53-0e29-42f3-8aa7-c7752d010399" }', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidConversationId.NotFound', 'errorMessage' => 'The specified ConversationId does not exist in our record.', 'description' => ''],
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"RequestId\\": \\"b19af5ce5314ac08108d1b33fe20e15\\",\\n \\"ConversationContext\\": \\" { \\\\\\"CallingNumber\\\\\\": \\\\\\"135815***\\\\\\", \\\\\\"AdditionalContext\\\\\\": \\\\\\"\\\\\\", \\\\\\"ConversationId\\\\\\": \\\\\\"361c8a53-0e29-42f3-8aa7-c7752d010399\\\\\\" }\\"\\n}","type":"json"}]',
'title' => 'Query conversation context',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'DescribeExportProgress' => [
'summary' => 'Queries the status of an export task.',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '868eef14-7515-4856-8a50-5c9a22abdbcc', 'title' => ''],
],
[
'name' => 'ExportTaskId',
'in' => 'query',
'schema' => ['description' => 'The export task ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0de8e5ccc2b645039ae6fbda443da73f', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'FINISHED', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'b19af5ce5314ac08108d1b33fe20e15', 'title' => ''],
'FileHttpUrl' => ['description' => 'The file URL.', 'type' => 'string', 'example' => 'http://ssml-test.oss-cn-shanghai.aliyuncs.com/key', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 export task status',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:DescribeExport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"FINISHED\\",\\n \\"RequestId\\": \\"b19af5ce5314ac08108d1b33fe20e15\\",\\n \\"FileHttpUrl\\": \\"http://ssml-test.oss-cn-shanghai.aliyuncs.com/key\\"\\n}","type":"json"}]',
],
'DescribeInstance' => [
'methods' => ['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' => 'cd6fc91bc13445c2af7f2e3e31418520', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'Published', 'title' => ''],
'ModifyTime' => ['description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683216000000', 'title' => ''],
'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '导航测试实例描述信息', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '790B5EA3-D251-1666-B1E0-4D1F4B33A592', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'cd6fc91bc13445c2af7f2e3e31418520', 'title' => ''],
'Concurrency' => ['description' => 'The instance concurrency.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'ApplicableOperations' => [
'description' => 'The list of applicable operations.',
'type' => 'array',
'items' => ['description' => 'The applicable operation.', 'type' => 'string', 'example' => 'Edit', 'title' => ''],
'title' => '',
'example' => '',
],
'ModifyUserName' => ['description' => 'The user who last updated the instance.', 'type' => 'string', 'example' => '2508711*******', 'title' => ''],
'Name' => ['description' => 'The instance name.', 'type' => 'string', 'example' => '导航测试实例', 'title' => ''],
'AbilityType' => ['description' => 'The instance ability type.
'."\n"
.'DEFAULT: full abilities.
'."\n"
.'VOICE_ONLY: only voice abilities, without dialog intervention.', 'type' => 'string', 'example' => 'VOICE_ONLY', 'title' => ''],
'UnionSource' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'UnionInstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'NluServiceParamsJson' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 instance information',
'summary' => 'Queries instance information.',
'changeSet' => [
['createdAt' => '2023-09-19T12:51:36.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2023-04-25T14:45:58.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:DescribeInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Published\\",\\n \\"ModifyTime\\": 1683216000000,\\n \\"Description\\": \\"导航测试实例描述信息\\",\\n \\"RequestId\\": \\"790B5EA3-D251-1666-B1E0-4D1F4B33A592\\",\\n \\"InstanceId\\": \\"cd6fc91bc13445c2af7f2e3e31418520\\",\\n \\"Concurrency\\": 10,\\n \\"ApplicableOperations\\": [\\n \\"Edit\\"\\n ],\\n \\"ModifyUserName\\": \\"2508711*******\\",\\n \\"Name\\": \\"导航测试实例\\",\\n \\"AbilityType\\": \\"VOICE_ONLY\\",\\n \\"UnionSource\\": \\"\\",\\n \\"UnionInstanceId\\": \\"\\",\\n \\"NluServiceParamsJson\\": \\"\\"\\n}","type":"json"}]',
],
'DescribeNavigationConfig' => [
'methods' => ['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' => '287289b6-1510-4e64-9224-39b53ad89dd2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
'SilenceTimeoutConfig' => [
'description' => 'The silence timeout configuration.',
'type' => 'object',
'properties' => [
'Timeout' => ['description' => 'The duration of the silence timeout.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'IntentTrigger' => ['description' => '""', 'type' => 'string', 'example' => '""', 'title' => ''],
'FinalPrompt' => ['description' => 'The prompt that is played when the silence timeout threshold is reached.', 'type' => 'string', 'example' => '抱歉,听不到您说话,请您稍后致电', 'title' => ''],
'SourceType' => ['description' => 'The source of the configuration.', 'type' => 'string', 'example' => 'chatbotIntent', 'title' => ''],
'FinalAction' => ['description' => 'The action to perform after the final silence prompt is played. Valid values: `TransferToAgent`, `TransferToIVR`, `RedirectToPage`, or `HangUp`.', 'type' => 'string', 'example' => 'HangUp', 'title' => ''],
'Prompt' => ['description' => 'The prompt that is played when a silence timeout occurs.', 'type' => 'string', 'example' => '抱歉,我没听到您说话', 'title' => ''],
'Threshold' => ['description' => 'The maximum number of silence timeouts.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'FinalActionParams' => ['description' => 'Parameters for the final action, such as a redirection target.', 'type' => 'string', 'example' => '{}', 'title' => ''],
],
'title' => '',
'example' => '',
],
'GreetingConfig' => [
'description' => 'The greeting configuration.',
'type' => 'object',
'properties' => [
'IntentTrigger' => ['description' => 'The intent trigger.', 'type' => 'string', 'example' => '你好', 'title' => ''],
'GreetingWords' => ['description' => 'The greeting message.', 'type' => 'string', 'example' => '您好,欢迎致电智能导航', 'title' => ''],
'SourceType' => ['description' => 'The source of the configuration.', 'type' => 'string', 'example' => 'chatbotIntent', 'title' => ''],
],
'title' => '',
'example' => '',
],
'UnrecognizingConfig' => [
'description' => 'The configuration for handling unrecognized input.',
'type' => 'object',
'properties' => [
'FinalPrompt' => ['description' => 'The prompt that is played when the unrecognized input threshold is reached.', 'type' => 'string', 'example' => '抱歉,我暂时无法处理您的问题,即将为您转接人工', 'title' => ''],
'FinalAction' => ['description' => 'The action to take when the number of unrecognized inputs reaches the threshold. Valid values: `TransferToAgent`, `TransferToIVR`, `RedirectToPage`, or `HangUp`.', 'type' => 'string', 'example' => 'TransferToAgent', 'title' => ''],
'FinalActionParams' => ['description' => 'Parameters for the final action, such as a redirection target.', 'type' => 'string', 'example' => '{ \\"skillGroupId\\": \\"fallbackSkillGroup\\" }', 'title' => ''],
'Threshold' => ['description' => 'The maximum number of times the user\'s input is not recognized.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'Prompt' => ['description' => 'The prompt that is played when user input is not recognized.', 'type' => 'string', 'example' => '抱歉,我无法理解您的意思', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"SilenceTimeoutConfig\\": {\\n \\"Timeout\\": 10,\\n \\"IntentTrigger\\": \\"\\\\\\"\\\\\\"\\",\\n \\"FinalPrompt\\": \\"抱歉,听不到您说话,请您稍后致电\\",\\n \\"SourceType\\": \\"chatbotIntent\\",\\n \\"FinalAction\\": \\"HangUp\\",\\n \\"Prompt\\": \\"抱歉,我没听到您说话\\",\\n \\"Threshold\\": 3,\\n \\"FinalActionParams\\": \\"{}\\"\\n },\\n \\"GreetingConfig\\": {\\n \\"IntentTrigger\\": \\"你好\\",\\n \\"GreetingWords\\": \\"您好,欢迎致电智能导航\\",\\n \\"SourceType\\": \\"chatbotIntent\\"\\n },\\n \\"UnrecognizingConfig\\": {\\n \\"FinalPrompt\\": \\"抱歉,我暂时无法处理您的问题,即将为您转接人工\\",\\n \\"FinalAction\\": \\"TransferToAgent\\",\\n \\"FinalActionParams\\": \\"{ \\\\\\\\\\\\\\"skillGroupId\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"fallbackSkillGroup\\\\\\\\\\\\\\" }\\",\\n \\"Threshold\\": 3,\\n \\"Prompt\\": \\"抱歉,我无法理解您的意思\\"\\n }\\n}","type":"json"}]',
'title' => 'View instance IVR configuration ',
'summary' => 'View the instance IVR configuration.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:DescribeNavigationConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeRecording' => [
'methods' => ['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' => '7cefbff0-8d50-4d6f-b93c-73cee23c1555', 'title' => ''],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abb4aa26-3a8e-43dd-82f8-0c3898c9c67f', 'title' => ''],
],
[
'name' => 'NeedVoiceSliceRecording',
'in' => 'query',
'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'FilePath' => ['description' => 'The file download URL.', 'type' => 'string', 'example' => 'url', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => '2019080913202222.wav', 'title' => ''],
'VoiceSliceRecordingListJson' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidConversationId.NotFound', 'errorMessage' => 'The specified ConversationId does not exist in our record.', 'description' => ''],
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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' => 'Retrieve conversation recording',
'summary' => 'Retrieves the recording of a conversation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-08-09T13:03:56.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:DescribeRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FilePath\\": \\"url\\",\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"FileName\\": \\"2019080913202222.wav\\",\\n \\"VoiceSliceRecordingListJson\\": \\"\\"\\n}","type":"json"}]',
],
'DescribeStatisticalData' => [
'methods' => ['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' => 'c28fc549-d88f-4f6e-85ad-a0806e5e39c0', 'title' => ''],
],
[
'name' => 'TimeUnit',
'in' => 'query',
'schema' => ['description' => 'The date unit.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Day/Hour', 'title' => ''],
],
[
'name' => 'BeginTimeLeftRange',
'in' => 'query',
'schema' => ['description' => 'The left boundary of the start time range.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1582283640000', 'title' => ''],
],
[
'name' => 'BeginTimeRightRange',
'in' => 'query',
'schema' => ['description' => 'The right boundary of the start time range.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1582298040000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalDialoguePassRate' => ['description' => 'The total multi-turn session pass rate.', 'type' => 'string', 'example' => '80.00%', 'title' => ''],
'TotalKnowledgeHitRate' => ['description' => 'The total knowledge base hit rate.', 'type' => 'string', 'example' => '80.00%', 'title' => ''],
'TotalResolutionRate' => ['description' => 'The total resolution rate.', 'type' => 'string', 'example' => '80.00%', 'title' => ''],
'TotalValidAnswerRate' => ['description' => 'The total valid answer rate.', 'type' => 'string', 'example' => '80.00%', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
'ResolvedQuestionTotalNum' => ['description' => 'The total number of resolved questions.', 'type' => 'integer', 'format' => 'int64', 'example' => '80', 'title' => ''],
'ConversationTotalNum' => ['description' => 'The total number of sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'StatisticalDataReports' => [
'description' => 'The array of statistics grouped by time dimension.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'KnowledgeHitRate' => ['description' => 'The knowledge base hit rate.', 'type' => 'string', 'example' => '80.00%', 'title' => ''],
'ResolvedQuestionNum' => ['description' => 'The number of resolved questions.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''],
'ResolutionRate' => ['description' => 'The resolution rate.', 'type' => 'string', 'example' => '80.00%', 'title' => ''],
'StatisticalDate' => ['description' => 'The statistical date.', 'type' => 'string', 'example' => '19:00:00', 'title' => ''],
'TotalConversationNum' => ['description' => 'The total number of sessions.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'ValidAnswerRate' => ['description' => 'The valid answer rate.', 'type' => 'string', 'example' => '80.0', 'title' => ''],
'DialoguePassRate' => ['description' => 'The multi-turn session pass rate.', 'type' => 'string', 'example' => '80.00%', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 statistics of the current instance',
'summary' => 'Queries the statistics of the current instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:DescribeStatisticalData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalDialoguePassRate\\": \\"80.00%\\",\\n \\"TotalKnowledgeHitRate\\": \\"80.00%\\",\\n \\"TotalResolutionRate\\": \\"80.00%\\",\\n \\"TotalValidAnswerRate\\": \\"80.00%\\",\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"ResolvedQuestionTotalNum\\": 80,\\n \\"ConversationTotalNum\\": 100,\\n \\"StatisticalDataReports\\": [\\n {\\n \\"KnowledgeHitRate\\": \\"80.00%\\",\\n \\"ResolvedQuestionNum\\": 80,\\n \\"ResolutionRate\\": \\"80.00%\\",\\n \\"StatisticalDate\\": \\"19:00:00\\",\\n \\"TotalConversationNum\\": 100,\\n \\"ValidAnswerRate\\": \\"80.0\\",\\n \\"DialoguePassRate\\": \\"80.00%\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeTTSConfig' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dc437bba-5a25-4bbc-b4c2-f268864bebb5', 'title' => ''],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance owner.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1971226538081821', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F132DDBA-66C4-5BD3-BF7E-9642FE877158', 'title' => ''],
'Volume' => ['description' => 'The volume.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
'Voice' => ['description' => 'The voice.', 'type' => 'string', 'example' => 'aixia', 'title' => ''],
'SpeechRate' => ['description' => 'The speech rate.', 'type' => 'integer', 'format' => 'int32', 'example' => '-150', 'title' => ''],
'NlsServiceType' => [
'description' => 'The TTS service invoke type.',
'enumValueTitles' => ['Authorized' => 'Authorized', 'Managed' => 'Managed'],
'type' => 'string',
'example' => 'Managed',
'title' => '',
],
'AppKey' => ['description' => 'The AppKey of the third-party voice configuration.', 'type' => 'string', 'example' => '5b358afc', 'title' => ''],
'Engine' => [
'description' => 'The TTS engine.',
'enumValueTitles' => ['xunfei' => 'xunfei', 'volc' => 'volc', 'bailian' => 'bailian'],
'type' => 'string',
'example' => 'bailian',
'title' => '',
],
'EngineXunfei' => ['description' => 'The iFLYTEK engine parameters.', 'type' => 'string', 'example' => '{\\"Voice\\":\\"aisjinger\\"}', 'title' => ''],
'PitchRate' => ['description' => 'The pitch rate.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'AliCustomizedVoice' => ['description' => 'The custom voice ID.', 'type' => 'string', 'example' => 'dc458bba-5a25-4cbc-b5c2', 'title' => ''],
'TtsOverrides' => ['description' => 'The TTS error correction dictionary.', 'type' => 'string', 'example' => '[{\\"pronunciation\\":\\"环钱\\",\\"word\\":\\"还钱\\"}]', 'title' => ''],
'ExtParams' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 TTS configuration',
'summary' => 'Queries the TTS configuration.',
'changeSet' => [
['createdAt' => '2024-07-22T12:36:17.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-02-04T14:18:44.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-09-20T13:55:07.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:DescribeTTSConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F132DDBA-66C4-5BD3-BF7E-9642FE877158\\",\\n \\"Volume\\": 50,\\n \\"Voice\\": \\"aixia\\",\\n \\"SpeechRate\\": -150,\\n \\"NlsServiceType\\": \\"Managed\\",\\n \\"AppKey\\": \\"5b358afc\\",\\n \\"Engine\\": \\"bailian\\",\\n \\"EngineXunfei\\": \\"{\\\\\\\\\\\\\\"Voice\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"aisjinger\\\\\\\\\\\\\\"}\\",\\n \\"PitchRate\\": 0,\\n \\"AliCustomizedVoice\\": \\"dc458bba-5a25-4cbc-b5c2\\",\\n \\"TtsOverrides\\": \\"[{\\\\\\\\\\\\\\"pronunciation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"环钱\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"word\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"还钱\\\\\\\\\\\\\\"}]\\",\\n \\"ExtParams\\": \\"\\"\\n}","type":"json"}]',
],
'Dialogue' => [
'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' => '21e0b2a3-168d-4ba7-9009-afc42666eb54', 'title' => ''],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the conversation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', 'title' => ''],
],
[
'name' => 'Utterance',
'in' => 'query',
'schema' => ['description' => 'The user\'s input.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '行吧,那我就不打扰您了,再见。', 'title' => ''],
],
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => ['description' => 'The called number.', 'type' => 'string', 'required' => false, 'example' => '10086', 'title' => ''],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => ['description' => 'The calling number.', 'type' => 'string', 'required' => false, 'example' => '18851708605', 'title' => ''],
],
[
'name' => 'AdditionalContext',
'in' => 'query',
'schema' => ['description' => 'The conversation context.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => ['description' => 'The ID of the Alibaba Cloud account that owns the instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1426738157626835', 'title' => ''],
],
[
'name' => 'Emotion',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Action' => ['description' => 'The action to be performed.', 'type' => 'string', 'example' => 'Broadcast', 'title' => ''],
'Interruptible' => ['description' => 'Indicates whether the IVR greeting can be interrupted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9DB8BA95-4513-54B9-9C67-A28909CFB4AD', 'title' => ''],
'ActionParams' => ['description' => 'The action parameters.', 'type' => 'string', 'example' => '{\\"duration\\":2420,\\"endTime\\":1651717326805,\\"hangUpDirection\\":\\"client\\",\\"hasLastPlaybackCompleted\\":true,\\"startTime\\":1651717324385}', 'title' => ''],
'TextResponse' => ['description' => 'The text to be broadcasted.', 'type' => 'string', 'example' => '您好,欢迎致电智能助手', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"Action\\": \\"Broadcast\\",\\n \\"Interruptible\\": true,\\n \\"RequestId\\": \\"9DB8BA95-4513-54B9-9C67-A28909CFB4AD\\",\\n \\"ActionParams\\": \\"{\\\\\\\\\\\\\\"duration\\\\\\\\\\\\\\":2420,\\\\\\\\\\\\\\"endTime\\\\\\\\\\\\\\":1651717326805,\\\\\\\\\\\\\\"hangUpDirection\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"client\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"hasLastPlaybackCompleted\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":1651717324385}\\",\\n \\"TextResponse\\": \\"您好,欢迎致电智能助手\\"\\n}","type":"json"}]',
'title' => 'Conversation API',
'summary' => 'Use this API to continue a conversation with an intelligent assistant by processing a user\'s utterance.',
'changeSet' => [
['createdAt' => '2022-09-20T13:54:00.000Z', 'description' => 'Request parameters changed'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:Dialogue',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [],
],
],
'DisableInstance' => [
'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' => 'da37319b-6c83-4268-9f19-814aed62e401', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The deletion status.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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' => 'Delete an intelligent navigation instance',
'summary' => 'Deletes an intelligent navigation instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:DisableInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"true\\",\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\"\\n}","type":"json"}]',
],
'EnableInstance' => [
'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' => 'da37319b-6c83-4268-9f19-814aed62e401', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The result status.', 'type' => 'string', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3a530dc0-7cfa-48f6-9539-bf9001e77b16', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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' => 'Start an instance',
'summary' => 'Starts an instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:EnableInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"true\\",\\n \\"RequestId\\": \\"3a530dc0-7cfa-48f6-9539-bf9001e77b16\\"\\n}","type":"json"}]',
],
'EndDialogue' => [
'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' => 'e48e45dd-e47a-4744-a063-f08cbebb1c5a', 'title' => ''],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the conversation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8fb819b5-d032-48a9-ae5e-cff041b83596', 'title' => ''],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance owner.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1399572315967217', 'title' => ''],
],
[
'name' => 'HangUpParams',
'in' => 'query',
'schema' => ['description' => 'The hang-up parameters, in a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{\\"duration\\":40,\\"endTime\\":1645082505345,\\"hangUpDirection\\":\\"ivr\\",\\"hasLastPlaybackCompleted\\":true,\\"startTime\\":1645082505305}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'e48e45dd-e47a-4744-a063-f08cbebb1c5a', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"RequestId\\": \\"e48e45dd-e47a-4744-a063-f08cbebb1c5a\\"\\n}","type":"json"}]',
'title' => 'EndDialogue',
'summary' => 'Ends an ongoing dialogue.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-16T07:23:04.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:EndDialogue',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ExportConversationDetails' => [
'summary' => 'Exports session details.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6c01a99f-1b72-4f75-a8bd-3875766bd19d', 'title' => ''],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => ['description' => 'The calling number.', 'type' => 'string', 'required' => false, 'example' => '13581588**', 'title' => ''],
],
[
'name' => 'BeginTimeLeftRange',
'in' => 'query',
'schema' => ['description' => 'The left boundary of the start date range.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1582266750353', 'title' => ''],
],
[
'name' => 'BeginTimeRightRange',
'in' => 'query',
'schema' => ['description' => 'The right boundary of the start date range.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1640793599000', 'title' => ''],
],
[
'name' => 'Options',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The optional parameters.',
'type' => 'array',
'items' => ['description' => 'The custom parameter.', 'type' => 'string', 'required' => false, 'example' => '{\'Option\': [\'betaTestApproved\']}', 'title' => ''],
'required' => false,
'maxItems' => 99,
'title' => '',
'example' => '',
],
],
[
'name' => 'RoundsLeftRange',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'RoundsRightRange',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'Result',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'DebugConversation',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '75BAAB9B-40B2-5FF5-A59A-7BCF8154C6EE', 'title' => ''],
'ExportTaskId' => ['description' => 'The asynchronous export task ID.', 'type' => 'string', 'example' => '6203fc87271a420c98eab6c2bbc2d856', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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' => 'Export session details',
'changeSet' => [
['createdAt' => '2024-07-22T12:15:38.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-09-20T13:56:33.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:ExportConversation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75BAAB9B-40B2-5FF5-A59A-7BCF8154C6EE\\",\\n \\"ExportTaskId\\": \\"6203fc87271a420c98eab6c2bbc2d856\\"\\n}","type":"json"}]',
],
'ExportStatisticalData' => [
'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' => '29b52d70-d9fe-4fe0-8476-8aaacbcfdc84', 'title' => ''],
],
[
'name' => 'TimeUnit',
'in' => 'query',
'schema' => ['description' => 'The time unit.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Hour', 'title' => ''],
],
[
'name' => 'ExportType',
'in' => 'query',
'schema' => ['description' => 'The export type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'statistical', 'title' => ''],
],
[
'name' => 'BeginTimeLeftRange',
'in' => 'query',
'schema' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1582266750353', 'title' => ''],
],
[
'name' => 'BeginTimeRightRange',
'in' => 'query',
'schema' => ['description' => 'The end time used as a filter condition.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1582266750353', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'c62e6789-28a8-41db-941e-171a01d3b3b9', 'title' => ''],
'ExportTaskId' => ['description' => 'The asynchronous export task ID.', 'type' => 'string', 'example' => '6be5a9f1-406e-424e-a17b-b6fb86ee3cc9', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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' => 'Export statistics',
'summary' => 'Exports statistics.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:ExportStatisticalData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"c62e6789-28a8-41db-941e-171a01d3b3b9\\",\\n \\"ExportTaskId\\": \\"6be5a9f1-406e-424e-a17b-b6fb86ee3cc9\\"\\n}","type":"json"}]',
],
'GetAsrConfig' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'EntryId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The entity ID corresponding to config_level.', 'type' => 'string', 'required' => false, 'example' => '3b1d3031-8b6e-460a-8640-d330f2ca50b8'],
],
[
'name' => 'ConfigLevel',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The policy level. Valid values:'."\n"
."\n"
.'- 0: system'."\n"
.'- 1: tenant'."\n"
.'- 2: instance', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'RpcResponse',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'AsrVocabularyId' => ['description' => 'The hotword ID. You can view the ASR hotword ID on the [ASR Hotword Management page](https://aiccs.console.aliyun.com/sentence/vocab?spm=a2c4g.11186623.0.0.7f9bf965IKBpsi).', 'type' => 'string', 'example' => '3b1d3031-8b6e-460a-8640-d330f2ca50b8', 'title' => ''],
'AsrCustomizationId' => ['description' => 'The ASR dataset ID.', 'type' => 'string', 'example' => '3b1d3031-8b6e-460a-8640-d330f2ca50b8', 'title' => ''],
'AsrAcousticModelId' => ['description' => 'The ASR acoustic model ID.', 'type' => 'string', 'example' => '3b1d3031-8b6e-460a-8640-d330f2ca50b8', 'title' => ''],
'AsrClassVocabularyId' => ['description' => 'The ASR hotword ID.', 'type' => 'string', 'example' => '3b1d3031-8b6e-460a-8640-d330f2ca50b8', 'title' => ''],
'Engine' => ['title' => '', 'description' => 'The speech engine.', 'type' => 'string', 'example' => 'ali'],
'EngineXufei' => ['title' => '', 'description' => 'The iFLYTEK engine parameters.', 'type' => 'string', 'example' => 'EngineXufei'],
'NlsServiceType' => ['title' => '', 'description' => 'NluServiceType', 'type' => 'string', 'example' => 'Authorized'],
'AppKey' => ['title' => '', 'description' => 'The engine.', 'type' => 'string', 'example' => 'your-app-key'],
'AsrOverrides' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Not Found', 'title' => ''],
],
'example' => '',
],
],
],
'title' => 'Query ASR configuration',
'summary' => 'Retrieves the ASR configuration.',
'changeSet' => [
['createdAt' => '2025-12-11T11:27:18.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-04-19T12:23:55.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetAsrConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AsrVocabularyId\\": \\"3b1d3031-8b6e-460a-8640-d330f2ca50b8\\",\\n \\"AsrCustomizationId\\": \\"3b1d3031-8b6e-460a-8640-d330f2ca50b8\\",\\n \\"AsrAcousticModelId\\": \\"3b1d3031-8b6e-460a-8640-d330f2ca50b8\\",\\n \\"AsrClassVocabularyId\\": \\"3b1d3031-8b6e-460a-8640-d330f2ca50b8\\",\\n \\"Engine\\": \\"ali\\",\\n \\"EngineXufei\\": \\"EngineXufei\\",\\n \\"NlsServiceType\\": \\"Authorized\\",\\n \\"AppKey\\": \\"your-app-key\\",\\n \\"AsrOverrides\\": \\"\\"\\n },\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"ErrorMsg\\": \\"Not Found\\"\\n}","type":"json"}]',
],
'GetRealTimeConcurrency' => [
'summary' => 'Retrieves the real-time concurrency of an instance.',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'c112c168ed664c0a851f9ca72d2f7999', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E6E61E1A-D2DC-5ACF-AED4-A115B6691F98', 'title' => ''],
'Timestamp' => ['description' => 'The timestamp of the request.', 'type' => 'integer', 'format' => 'int64', 'example' => '1661584255029', 'title' => ''],
'RealTimeConcurrency' => ['description' => 'The real-time concurrency.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'MaxConcurrency' => ['description' => 'The maximum concurrency.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6E61E1A-D2DC-5ACF-AED4-A115B6691F98\\",\\n \\"Timestamp\\": 1661584255029,\\n \\"RealTimeConcurrency\\": 1,\\n \\"MaxConcurrency\\": 2\\n}","type":"json"}]',
'changeSet' => [
['createdAt' => '2022-08-29T12:28:23.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetRealTimeConcurrency',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'title' => 'GetRealTimeConcurrency',
],
'ListChatbotInstances' => [
'methods' => ['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' => false, 'docRequired' => true, 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', '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' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'UnionSource',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'NluServiceType',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'NluServiceParamsJson',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'Bots' => [
'description' => 'The list of instances.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Introduction' => ['type' => 'string', 'description' => '', 'example' => '‘’', 'title' => ''],
'Avatar' => ['description' => 'The icon of the instance.', 'type' => 'string', 'example' => 'https://dss0.ali.com/70cFuHS.jpg', 'title' => ''],
'TimeZone' => ['description' => 'The time zone.', 'type' => 'string', 'example' => 'UTC+8', 'title' => ''],
'CreateTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '1582266750353', 'title' => ''],
'LanguageCode' => ['description' => 'The language code.', 'type' => 'string', 'example' => 'zh-cn', 'title' => ''],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'Name' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => '测试机器人', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListChatbotInstances',
'summary' => 'Queries a list of instances.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-09-19T12:51:36.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-09-21T15:47:19.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListChatbotInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"Bots\\": [\\n {\\n \\"Introduction\\": \\"‘’\\",\\n \\"Avatar\\": \\"https://dss0.ali.com/70cFuHS.jpg\\",\\n \\"TimeZone\\": \\"UTC+8\\",\\n \\"CreateTime\\": \\"1582266750353\\",\\n \\"LanguageCode\\": \\"zh-cn\\",\\n \\"InstanceId\\": \\"af81a389-91f0-4157-8d82-720edd02b66a\\",\\n \\"Name\\": \\"测试机器人\\"\\n }\\n ],\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"da37319b-6c83-4268-9f19-814aed62e401\\",\\n \\"PageNumber\\": 1\\n}","type":"json"}]',
],
'ListConversationDetails' => [
'methods' => ['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' => '82b2eaae-ce5c-45f8-8231-f15b6b27e55c', 'title' => ''],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => ['description' => 'The conversation ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a2c26e67-5984-4935-984e-bcee52971993', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
'ConversationDetails' => [
'description' => 'The list of conversation details.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Action' => ['description' => 'The action performed during the turn.', 'type' => 'string', 'example' => 'Dialogue', 'title' => ''],
'Speaker' => ['description' => 'The speaker. Valid values: `customer` and `chatbot`.', 'type' => 'string', 'example' => 'Chatbot', 'title' => ''],
'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1582266750353', 'title' => ''],
'ConversationId' => ['description' => 'The conversation ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'ActionParams' => ['description' => 'The action parameters.', 'type' => 'string', 'example' => '{}', 'title' => ''],
'SequenceId' => ['description' => 'The sequence ID of the conversational turn.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'Utterance' => ['description' => 'The speaker\'s utterance.', 'type' => 'string', 'example' => '你好', 'title' => ''],
],
'description' => 'A turn in the conversation.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => 'The response object.',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidConversationId.NotFound', 'errorMessage' => 'The specified ConversationId does not exist in our record.', 'description' => ''],
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"ConversationDetails\\": [\\n {\\n \\"Action\\": \\"Dialogue\\",\\n \\"Speaker\\": \\"Chatbot\\",\\n \\"CreateTime\\": 1582266750353,\\n \\"ConversationId\\": \\"af81a389-91f0-4157-8d82-720edd02b66a\\",\\n \\"ActionParams\\": \\"{}\\",\\n \\"SequenceId\\": \\"af81a389-91f0-4157-8d82-720edd02b66a\\",\\n \\"Utterance\\": \\"你好\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'View conversations under an instance',
'summary' => 'Retrieves the conversation details for a specific conversation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:ListConversationDetails',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListConversations' => [
'summary' => 'Queries a list of sessions.',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', '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, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => ['description' => 'The calling number.', 'type' => 'string', 'required' => false, 'example' => '138106*****', 'title' => ''],
],
[
'name' => 'Result',
'in' => 'query',
'schema' => ['description' => 'The result.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'Query',
'in' => 'query',
'schema' => ['description' => 'The query condition.', 'type' => 'string', 'required' => false, 'example' => '13788914724', 'title' => ''],
],
[
'name' => 'BeginTimeLeftRange',
'in' => 'query',
'schema' => ['description' => 'The left boundary of the start time range.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1638288000000', 'title' => ''],
],
[
'name' => 'BeginTimeRightRange',
'in' => 'query',
'schema' => ['description' => 'The right boundary of the start time range.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1637547875311', 'title' => ''],
],
[
'name' => 'IsSandBox',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'Specifies whether the session is in a sandbox environment.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'RoundsLeftRange',
'in' => 'query',
'schema' => ['description' => 'The left boundary of the rounds query range.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'RoundsRightRange',
'in' => 'query',
'schema' => ['description' => 'The right boundary of the rounds query range.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''],
],
[
'name' => 'DebugConversation',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'a2c26e67-5984-4935-984e-bcee52971993', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Conversations' => [
'description' => 'The list of sessions.',
'type' => 'array',
'items' => [
'description' => 'The list of sessions.',
'type' => 'object',
'properties' => [
'EndTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1582266750353', 'title' => ''],
'HasToAgent' => ['description' => 'Indicates whether the session was transferred to a human agent.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'StartTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1641625694286', 'title' => ''],
'SkillGroup' => ['description' => 'The skill group.', 'type' => 'string', 'example' => 'skg-123', 'title' => ''],
'ConversationId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '82b2eaae-ce5c-45f8-8231-f15b6b27e55c', 'title' => ''],
'CallingNumber' => ['description' => 'The calling number.', 'type' => 'string', 'example' => '135815884***', 'title' => ''],
'EndReason' => ['description' => 'The reason why the session ended. Valid values:'."\n"
.' 1: Normal completion.'."\n"
.' 2: Bot hung up after unrecognized input.'."\n"
.' 3: Hung up due to silence timeout.'."\n"
.' 4: User hung up after unrecognized input.'."\n"
.' 5: User hung up without reason.'."\n"
.' 6: Transferred to a human agent by intent match.'."\n"
.' 7: Transferred to a human agent due to unrecognized input.'."\n"
.' 8: No interaction from the user side.'."\n"
.' 9: System exception interruption.'."\n"
.' 10: Transferred to IVR by intent match.'."\n"
.' 11: Transferred to IVR due to unrecognized input.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Rounds' => ['description' => 'The number of conversation rounds.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'HasLastPlaybackCompleted' => ['description' => 'Indicates whether the last prompt was fully played back when the session ended.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'SandBox' => ['description' => 'Indicates whether the session is in a sandbox environment.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'CalledNumber' => ['description' => 'The called number.', 'type' => 'string', 'example' => '12356', 'title' => ''],
'DsReport' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'DsReportTitles' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', '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' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 session list',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-07-11T07:01:05.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-04-22T07:29:49.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-09-20T13:56:33.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-06-21T12:24:16.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2021-09-16T11:34:31.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2021-09-16T11:34:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:ListConversations',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"a2c26e67-5984-4935-984e-bcee52971993\\",\\n \\"PageNumber\\": 1,\\n \\"Conversations\\": [\\n {\\n \\"EndTime\\": 1582266750353,\\n \\"HasToAgent\\": false,\\n \\"StartTime\\": 1641625694286,\\n \\"SkillGroup\\": \\"skg-123\\",\\n \\"ConversationId\\": \\"82b2eaae-ce5c-45f8-8231-f15b6b27e55c\\",\\n \\"CallingNumber\\": \\"135815884***\\",\\n \\"EndReason\\": 1,\\n \\"Rounds\\": 2,\\n \\"HasLastPlaybackCompleted\\": true,\\n \\"SandBox\\": true,\\n \\"CalledNumber\\": \\"12356\\",\\n \\"DsReport\\": \\"\\",\\n \\"DsReportTitles\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'ListDownloadTasks' => [
'summary' => 'Queries the list of download tasks.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '5', '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' => 'successful', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D24E0148-6D40-550E-9471-B2C5A34C3D12', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'DownloadTasks' => [
'description' => 'The download task 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 entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'List' => [
'description' => 'The list of download tasks.',
'type' => 'array',
'items' => [
'description' => 'The task array.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'Expired', 'title' => ''],
'Title' => ['description' => 'The title.', 'type' => 'string', 'example' => '批量高阶内存整理_2022_02_17_10', 'title' => ''],
'ExpireTime' => ['description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1637119221702', 'title' => ''],
'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'cb9aba69-f578-42b2-aa2f-3e5a41947db8', 'title' => ''],
'DownloadTaskFiles' => [
'description' => 'The list of download task files.',
'type' => 'array',
'items' => [
'description' => 'The list of download task files.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'Published', 'title' => ''],
'Title' => ['description' => 'The title.', 'type' => 'string', 'example' => 'CBU阿里通信反馈-声音延迟', 'title' => ''],
'Progress' => ['description' => 'The completion progress of the download task.', 'type' => 'integer', 'format' => 'int32', 'example' => '70', 'title' => ''],
'FileId' => ['description' => 'The file ID.', 'type' => 'string', 'example' => 'c32bf5675b704dc5b19200a89d2e85f1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'View download task list',
'changeSet' => [
['createdAt' => '2021-11-24T12:59:40.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListDownloadTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"D24E0148-6D40-550E-9471-B2C5A34C3D12\\",\\n \\"Success\\": true,\\n \\"DownloadTasks\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"Expired\\",\\n \\"Title\\": \\"批量高阶内存整理_2022_02_17_10\\",\\n \\"ExpireTime\\": 1637119221702,\\n \\"TaskId\\": \\"cb9aba69-f578-42b2-aa2f-3e5a41947db8\\",\\n \\"DownloadTaskFiles\\": [\\n {\\n \\"Status\\": \\"Published\\",\\n \\"Title\\": \\"CBU阿里通信反馈-声音延迟\\",\\n \\"Progress\\": 70,\\n \\"FileId\\": \\"c32bf5675b704dc5b19200a89d2e85f1\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListInstances' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'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' => 'NluServiceTypeListJsonString',
'in' => 'query',
'schema' => ['description' => 'The NLU type used to filter by dialog capability source. If this parameter is not specified, all types are selected.'."\n"
."\n"
.' * MANAGED: managed (deprecated).'."\n"
."\n"
.' * AUTHORIZED: authorized. In the public cloud, this refers to Chatbot service.'."\n"
."\n"
.' * PROVIDED: private. Configured by specifying the AccessKey ID, AccessKey Secret, and chatEndpoint in the O&M console.'."\n"
.'* CCC_AUTHORIZED: uses a Chatbot authorized by Cloud Call Center.'."\n"
."\n"
.'* CCC_FUNCTION: uses Alibaba Cloud Function Compute.'."\n"
."\n"
.'* SSE_FUNCTION: uses a streaming function service. Function Compute that supports SSE, used to connect to third-party large language model chatbots.'."\n"
."\n\n"
.'* PROMPTS: connects to Qwen foundation models.'."\n"
."\n"
.'* LOCAL: private cloud, local Chatbot.', 'type' => 'string', 'required' => false, 'example' => '["CCC_AUTHORIZED"]', 'title' => ''],
],
[
'name' => 'UnionSource',
'in' => 'query',
'schema' => ['description' => 'The source.'."\n"
.'* CCC: Cloud Call Center.', 'type' => 'string', 'required' => false, 'example' => 'CCC', 'title' => ''],
],
[
'name' => 'UnionInstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.'."\n"
."\n"
.'> When UnionSource is set to CCC, set UnionInstanceId to the instance ID of Cloud Call Center.', 'type' => 'string', 'required' => false, 'example' => 'zhyl', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The scenario name used as a filter condition.', 'type' => 'string', 'required' => false, 'example' => '测试', 'title' => ''],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => 'The scenario status used as a filter condition. If this parameter is not specified, all statuses are selected.'."\n"
.'* DISABLED: offline.'."\n"
.'* PUBLISHED: published.', 'type' => 'string', 'required' => false, 'example' => 'PUBLISHED', 'title' => ''],
],
[
'name' => 'Number',
'in' => 'query',
'schema' => ['description' => 'The inbound number used as a filter condition.', 'type' => 'string', 'required' => false, 'example' => '021xxxxxxx', 'title' => ''],
],
[
'name' => 'InstanceIdListJsonString',
'in' => 'query',
'schema' => ['description' => 'The list of digital employee scenario IDs.', 'type' => 'string', 'required' => false, 'example' => '["e4bebxxxxxxxxxxx"] '."\n", 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Instances' => [
'description' => 'The array of instances.',
'type' => 'array',
'items' => [
'description' => 'The array of instances.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'Published', 'title' => ''],
'ModifyUserName' => ['description' => 'The operator who performed the operation.', 'type' => 'string', 'example' => 'xxx', 'title' => ''],
'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '测试的实例', 'title' => ''],
'ApplicableOperations' => [
'description' => 'The list of applicable operations for the instance.',
'type' => 'array',
'items' => ['description' => 'The list of applicable operations for the instance.', 'type' => 'string', 'example' => 'Edit', 'title' => ''],
'title' => '',
'example' => '',
],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'dc437bba-5a25-4bbc-b4c2-f268864bebb5', 'title' => ''],
'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => '测试实例', 'title' => ''],
'Concurrency' => ['description' => 'The concurrency.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1582266750353', 'title' => ''],
'Numbers' => [
'description' => 'The list of inbound numbers.',
'type' => 'array',
'items' => ['description' => 'The inbound number.', 'type' => 'string', 'example' => '021xxxxxxxx '."\n"
."\n\n", 'title' => ''],
'title' => '',
'example' => '',
],
'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1658202465000', 'title' => ''],
'UnionSource' => ['description' => 'The source.'."\n"
."\n"
.'- CCC: Cloud Call Center.', 'type' => 'string', 'example' => 'CCC', 'title' => ''],
'UnionInstanceId' => ['description' => 'The instance ID.'."\n"
."\n\n"
.'> When UnionSource is set to CCC, UnionInstanceId is set to the instance ID of Cloud Call Center.', 'type' => 'string', 'example' => 'zhyl ', 'title' => ''],
'NluServiceParamsJson' => ['description' => 'The large language model service parameters in JSON format.', 'type' => 'string', 'example' => '{"agentId":"1213503","isCCCAgent":"true","agentKey":"107e04a7519243eb83c9b549ea3b6829_p_ccc_public"} ', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A8AED3C8-F57B-5D71-9A34-4A170287533F', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', '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' => 'List intelligent navigation instances with pagination',
'summary' => 'Retrieves a paginated list of intelligent navigation instances for the current tenant.',
'changeSet' => [
['createdAt' => '2023-09-19T12:51:37.000Z', 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed'],
['createdAt' => '2022-04-19T12:23:55.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"Published\\",\\n \\"ModifyUserName\\": \\"xxx\\",\\n \\"Description\\": \\"测试的实例\\",\\n \\"ApplicableOperations\\": [\\n \\"Edit\\"\\n ],\\n \\"InstanceId\\": \\"dc437bba-5a25-4bbc-b4c2-f268864bebb5\\",\\n \\"Name\\": \\"测试实例\\",\\n \\"Concurrency\\": 10,\\n \\"ModifyTime\\": 1582266750353,\\n \\"Numbers\\": [\\n \\"021xxxxxxxx\\\\t\\\\n\\\\n\\\\n\\"\\n ],\\n \\"CreateTime\\": 1658202465000,\\n \\"UnionSource\\": \\"CCC\\",\\n \\"UnionInstanceId\\": \\"zhyl\\\\t\\",\\n \\"NluServiceParamsJson\\": \\"{\\\\\\"agentId\\\\\\":\\\\\\"1213503\\\\\\",\\\\\\"isCCCAgent\\\\\\":\\\\\\"true\\\\\\",\\\\\\"agentKey\\\\\\":\\\\\\"107e04a7519243eb83c9b549ea3b6829_p_ccc_public\\\\\\"}\\\\t\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"A8AED3C8-F57B-5D71-9A34-4A170287533F\\",\\n \\"PageNumber\\": 2\\n}","type":"json"}]',
],
'ModifyAsrConfig' => [
'summary' => 'Modifies the ASR configuration.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'EntryId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The entity ID corresponding to config_level.', 'type' => 'string', 'required' => false, 'example' => '6cc9f5ca-2cb6-4cc7-a46b-2bbfd3e61b22'],
],
[
'name' => 'ConfigLevel',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The policy level. Valid values:'."\n"
."\n"
.'- 0: system.'."\n"
.'- 1: tenant.'."\n"
.'- 2: instance.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'required' => false, 'example' => '0'],
],
[
'name' => 'AsrVocabularyId',
'in' => 'query',
'schema' => ['description' => 'The hotword ID. You can view the ASR hotword ID on the [ASR Hotword Management page](https://aiccs.console.aliyun.com/sentence/vocab?spm=a2c4g.11186623.0.0.7f9bf965IKBpsi).', 'type' => 'string', 'required' => false, 'example' => '6cc9f5ca-2cb6-4cc7-a46b-2bbfd3e61b22', 'title' => ''],
],
[
'name' => 'AsrCustomizationId',
'in' => 'query',
'schema' => ['description' => 'The dataset ID.', 'type' => 'string', 'required' => false, 'example' => '6cc9f5ca-2cb6-4cc7-a46b-2bbfd3e61b22', 'title' => ''],
],
[
'name' => 'AsrAcousticModelId',
'in' => 'query',
'schema' => ['description' => 'The ASR acoustic model ID.', 'type' => 'string', 'required' => false, 'example' => '6cc9f5ca-2cb6-4cc7-a46b-2bbfd3e61b22', 'title' => ''],
],
[
'name' => 'AsrClassVocabularyId',
'in' => 'query',
'schema' => ['description' => 'The ASR hotword ID.', 'type' => 'string', 'required' => false, 'example' => '6cc9f5ca-2cb6-4cc7-a46b-2bbfd3e61b22', 'title' => ''],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'NlsServiceType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'NluServiceType', 'type' => 'string', 'example' => '语音识别', 'required' => false],
],
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The AppKey of the engine.', 'type' => 'string', 'example' => 'your_app_key', 'required' => false],
],
[
'name' => 'AsrOverrides',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'RpcResponse',
'type' => 'object',
'properties' => [
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'Data' => [
'title' => '',
'description' => 'The modification result.',
'type' => 'object',
'properties' => [
'AffectedRows' => ['description' => 'The number of affected rows.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''],
],
'example' => '',
],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'da37319b-6c83-4268-9f19-814aed62e401', 'title' => ''],
'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''],
'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Not Found', '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' => 'Modify ASR configuration',
'changeSet' => [
['createdAt' => '2025-12-11T11:27:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
['createdAt' => '2022-11-22T13:15:25.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2022-04-19T12:23:55.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:ModifyAsrConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AffectedRows\\": 0\\n },\\n \\"RequestId\\": \\"da37319b-6c83-4268-9f19-814aed62e401\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"ErrorMsg\\": \\"Not Found\\"\\n}","type":"json"}]',
],
'ModifyGreetingConfig' => [
'methods' => ['post'],
'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' => '12f407b22cbe4890ac595f09985848d5', 'title' => ''],
],
[
'name' => 'GreetingWords',
'in' => 'query',
'schema' => ['description' => 'The greeting words.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '你好,欢迎使用智能导航。', 'title' => ''],
],
[
'name' => 'SourceType',
'in' => 'query',
'schema' => ['description' => 'The type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'chatbotIntent', 'title' => ''],
],
[
'name' => 'IntentTrigger',
'in' => 'query',
'schema' => ['description' => 'The intent trigger.', 'type' => 'string', 'required' => false, 'example' => '开始', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\"\\n}","type":"json"}]',
'title' => 'Modify the greeting configuration',
'summary' => 'Modifies the greeting configuration.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:ModifyGreetingConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [],
],
],
'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 instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '12f407b22cbe4890ac595f09985848d5', 'title' => ''],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the instance.', 'type' => 'string', 'required' => false, 'example' => '描述', 'title' => ''],
],
[
'name' => 'Concurrency',
'in' => 'query',
'schema' => ['description' => 'The maximum number of concurrent conversations for the instance.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidConcurrency.LimitExceeded', 'errorMessage' => 'The specified Concurrency exceeds the upper limit.', 'description' => ''],
['errorCode' => 'InvalidInstanceName.Duplicated', 'errorMessage' => 'The specified InstanceName already exists.', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\"\\n}","type":"json"}]',
'title' => 'Modify an instance',
'summary' => 'Modify an instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-09-20T13:57:21.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:ModifyInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ModifySilenceTimeoutConfig' => [
'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' => '12f407b22cbe4890ac595f09985848d5', 'title' => ''],
],
[
'name' => 'Prompt',
'in' => 'query',
'schema' => ['description' => 'The prompt that plays when the system detects no user input during the specified timeout period.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '不好意思,听不见您说什么', 'title' => ''],
],
[
'name' => 'Timeout',
'in' => 'query',
'schema' => ['description' => 'The duration of the silence timeout, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20', 'title' => ''],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['description' => 'The maximum number of times the system plays the silence timeout prompt before it performs the post-prompt action.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '3', 'title' => ''],
],
[
'name' => 'FinalPrompt',
'in' => 'query',
'schema' => ['description' => 'The prompt that plays after the silence timeout threshold is reached.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '再见', 'title' => ''],
],
[
'name' => 'FinalAction',
'in' => 'query',
'schema' => ['description' => 'Action After Prompt', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TransferToAgent', 'title' => ''],
],
[
'name' => 'FinalActionParams',
'in' => 'query',
'schema' => ['description' => 'Parameters for the post-prompt action, specified in a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'SourceType',
'in' => 'query',
'schema' => ['description' => 'The type of source that triggers the action.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'chatbotIntent', 'title' => ''],
],
[
'name' => 'IntentTrigger',
'in' => 'query',
'schema' => ['description' => 'The intent trigger for the silence timeout.', 'type' => 'string', 'required' => false, 'example' => 'Timeout', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
],
'description' => 'The response object.',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\"\\n}","type":"json"}]',
'title' => 'ModifySilenceTimeoutConfig',
'summary' => 'Modifies the silence timeout configuration for a voice bot instance.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:ModifySilenceTimeoutConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ModifyTTSConfig' => [
'summary' => 'Modifies the TTS configuration.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The scenario ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '8a9bdaa895a748528a15b50c281e6474', 'title' => ''],
],
[
'name' => 'Voice',
'in' => 'query',
'schema' => ['description' => 'The voice.', 'type' => 'string', 'required' => false, 'example' => 'aixia', 'title' => ''],
],
[
'name' => 'SpeechRate',
'in' => 'query',
'schema' => ['description' => 'The speech rate.', 'type' => 'string', 'required' => false, 'example' => '50', 'title' => ''],
],
[
'name' => 'Volume',
'in' => 'query',
'schema' => ['description' => 'The volume.', 'type' => 'string', 'required' => false, 'example' => '50', 'title' => ''],
],
[
'name' => 'PitchRate',
'in' => 'query',
'schema' => ['description' => 'The pitch rate.', 'type' => 'string', 'required' => false, 'example' => '50', 'title' => ''],
],
[
'name' => 'NlsServiceType',
'in' => 'query',
'schema' => [
'description' => 'The TTS service invoke type.',
'enumValueTitles' => ['Authorized' => 'Authorized', 'Managed' => 'Managed'],
'type' => 'string',
'required' => false,
'example' => 'Managed',
'title' => '',
],
],
[
'name' => 'AppKey',
'in' => 'query',
'schema' => ['description' => 'The AppKey of the third-party voice configuration.', 'type' => 'string', 'required' => false, 'example' => '5b358afc', 'title' => ''],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => [
'description' => 'The TTS engine.',
'enumValueTitles' => ['xunfei' => 'xunfei', 'bailian' => 'bailian', 'volc' => 'volc'],
'type' => 'string',
'required' => false,
'example' => 'bailian',
'title' => '',
],
],
[
'name' => 'EngineXunfei',
'in' => 'query',
'schema' => ['description' => 'The iFLYTEK engine parameters.', 'type' => 'string', 'required' => false, 'example' => '{\\"Voice\\":\\"aisjinger\\"}', 'title' => ''],
],
[
'name' => 'AliCustomizedVoice',
'in' => 'query',
'schema' => ['description' => 'The personalized custom voice ID.', 'type' => 'string', 'required' => false, 'example' => 'dc458bba-5a25-4cbc-b5c2', 'title' => ''],
],
[
'name' => 'TtsOverrides',
'in' => 'query',
'schema' => ['description' => 'The TTS error correction dictionary.', 'type' => 'string', 'required' => false, 'example' => '[{\\"pronunciation\\":\\"环钱\\",\\"word\\":\\"还钱\\"}]', 'title' => ''],
],
[
'name' => 'ExtParams',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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' => 'Modify TTS configuration',
'changeSet' => [
['createdAt' => '2025-12-18T02:03:50.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-07-22T12:36:17.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-02-04T14:18:44.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2022-09-20T13:55:08.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:ModifyTTSConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\"\\n}","type":"json"}]',
],
'ModifyUnrecognizingConfig' => [
'methods' => ['post'],
'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' => '12f407b22cbe4890ac595f09985848d5', 'title' => ''],
],
[
'name' => 'Prompt',
'in' => 'query',
'schema' => ['description' => 'The rejection prompt played when the service fails to recognize user input.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '我不理解您的意思,请再说一遍', 'title' => ''],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['description' => 'The rejection threshold. The maximum number of consecutive rejections before the service triggers the rejection action.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '3', 'title' => ''],
],
[
'name' => 'FinalPrompt',
'in' => 'query',
'schema' => ['description' => 'The final rejection prompt. The service plays this prompt when the rejection threshold is met.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '再见', 'title' => ''],
],
[
'name' => 'FinalAction',
'in' => 'query',
'schema' => ['description' => 'The rejection action performed after the final rejection prompt is played.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TransferToAgent', 'title' => ''],
],
[
'name' => 'FinalActionParams',
'in' => 'query',
'schema' => ['description' => 'The action parameters for the rejection action, in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
],
'description' => 'The response object.',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\"\\n}","type":"json"}]',
'title' => 'Modify the rejection configuration',
'summary' => 'Modifies the rejection configuration.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:ModifyUnrecognizingConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [],
],
],
'QueryConversations' => [
'methods' => ['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' => '12f407b22cbe4890ac595f09985848d5', 'title' => ''],
],
[
'name' => 'CallingNumber',
'in' => 'query',
'schema' => ['description' => 'The calling number.', 'type' => 'string', 'required' => false, 'example' => '02811111111', 'title' => ''],
],
[
'name' => 'BeginTimeLeftRange',
'in' => 'query',
'schema' => ['description' => 'The start of the time range to query. This value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1582183381000', 'title' => ''],
],
[
'name' => 'BeginTimeRightRange',
'in' => 'query',
'schema' => ['description' => 'The end of the time range to query. This value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1582356181000', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total count of conversation records.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '14C39896-AE6D-4643-9C9A-E0566B2C2DDD', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Conversations' => [
'description' => 'The conversation list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndTime' => ['description' => 'The end time. This value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1582183481000', 'title' => ''],
'EffectiveAnswerCount' => ['description' => 'The effective answer count.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
'TransferredToAgent' => ['description' => 'Whether the conversation was transferred to an agent.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'BeginTime' => ['description' => 'The start time. This value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1582183381000', 'title' => ''],
'SkillGroupId' => ['description' => 'The ID of the skill group.', 'type' => 'string', 'example' => 'AAA', 'title' => ''],
'ConversationId' => ['description' => 'The conversation ID.', 'type' => 'string', 'example' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
'CallingNumber' => ['description' => 'The calling number.', 'type' => 'string', 'example' => '02811111111', 'title' => ''],
'UserUtteranceCount' => ['description' => 'The user utterance count.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'description' => 'The details of a conversation.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => 'The data returned for the request.',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"14C39896-AE6D-4643-9C9A-E0566B2C2DDD\\",\\n \\"PageNumber\\": 1,\\n \\"Conversations\\": [\\n {\\n \\"EndTime\\": 1582183481000,\\n \\"EffectiveAnswerCount\\": 8,\\n \\"TransferredToAgent\\": true,\\n \\"BeginTime\\": 1582183381000,\\n \\"SkillGroupId\\": \\"AAA\\",\\n \\"ConversationId\\": \\"af81a389-91f0-4157-8d82-720edd02b66a\\",\\n \\"CallingNumber\\": \\"02811111111\\",\\n \\"UserUtteranceCount\\": 10\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query conversation records ',
'summary' => 'Retrieves a list of conversation records.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-07-03T09:49:06.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:QueryConversations',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'SaveRecording' => [
'methods' => ['post'],
'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' => 'af81a389-91f0-4157-8d82-720edd02b66a', 'title' => ''],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the conversation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '390515b5-6115-4ccf-83e2-52d5bfaf2ddf', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The Unix timestamp, in milliseconds, when the recording started.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1582267398628', 'title' => ''],
],
[
'name' => 'Duration',
'in' => 'query',
'schema' => ['description' => 'The duration of the recording, in seconds.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => ['description' => 'The name of the recording file.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e6bef0db439d4048bfcf45322491becf.wav', 'title' => ''],
],
[
'name' => 'FilePath',
'in' => 'query',
'schema' => ['description' => 'The storage path of the recording file, such as a path in Object Storage Service (OSS).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'oss://test/record/', 'title' => ''],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => 'The type of the recording file. Example: Source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Source', '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' => ''],
],
[
'name' => 'VoiceSliceRecordingList',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
],
'description' => 'The response object.',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidConversationId.NotFound', 'errorMessage' => 'The specified ConversationId does not exist in our record.', 'description' => ''],
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\"\\n}","type":"json"}]',
'title' => 'SaveRecording',
'summary' => 'Saves a recording.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-08-09T13:03:55.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:SaveRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'SilenceTimeout' => [
'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' => '0099b75d-60fd-4c63-8541-7fbba0ae6bb0', 'title' => ''],
],
[
'name' => 'ConversationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the conversation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0099b75d-60fd-4c63-8541-7fbba0ae6bb0', 'title' => ''],
],
[
'name' => 'InitialContext',
'in' => 'query',
'schema' => ['description' => 'The context of the conversation.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''],
],
[
'name' => 'InstanceOwnerId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance owner.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1231639035307976', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Action' => ['description' => 'The system\'s next action.', 'type' => 'string', 'example' => 'TransferToAgent', 'title' => ''],
'Interruptible' => ['description' => 'Indicates whether the action is interruptible.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '254EB995-DEDF-48A4-9101-9CA5B72FFBCC', 'title' => ''],
'ActionParams' => ['description' => 'Parameters for the action defined in the Action parameter.', 'type' => 'string', 'example' => '{ "skillGroupId": "ABC"}', 'title' => ''],
'TextResponse' => ['description' => 'The text response to play to the user.', 'type' => 'string', 'example' => '正在为你转接人工坐席', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidConversationId.NotFound', 'errorMessage' => 'The specified ConversationId does not exist in our record.', 'description' => ''],
['errorCode' => 'InvalidInstanceId.NotFound', 'errorMessage' => 'The specified InstanceId 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 \\"Action\\": \\"TransferToAgent\\",\\n \\"Interruptible\\": false,\\n \\"RequestId\\": \\"254EB995-DEDF-48A4-9101-9CA5B72FFBCC\\",\\n \\"ActionParams\\": \\"{ \\\\\\"skillGroupId\\\\\\": \\\\\\"ABC\\\\\\"}\\",\\n \\"TextResponse\\": \\"正在为你转接人工坐席\\"\\n}","type":"json"}]',
'title' => 'SilenceTimeout',
'summary' => 'Handles the silence timeout event in a conversation.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:SilenceTimeout',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
],
'endpoints' => [
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'voicenavigator.cn-hangzhou.aliyuncs.com', 'endpoint' => 'voicenavigator.cn-hangzhou.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'voicenavigator.cn-shanghai.aliyuncs.com', 'endpoint' => 'voicenavigator.cn-shanghai.aliyuncs.com', 'vpc' => 'voicenavigator-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' => 'InvalidCategoryId.NotFound', 'message' => 'The specified CategoryId does not exist in our records.', 'http_code' => 404, 'description' => ''],
['code' => 'InvalidCategoryName.Duplicated', 'message' => 'The specified CategoryName already exists.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidConcurrency.LimitExceeded', 'message' => 'The specified Concurrency exceeds the upper limit.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidConversationId.NotFound', 'message' => 'The specified ConversationId does not exist in our record.', 'http_code' => 404, 'description' => ''],
['code' => 'InvalidInstanceId.NotFound', 'message' => 'The specified InstanceId does not exist.', 'http_code' => 404, 'description' => ''],
['code' => 'InvalidInstanceName.Duplicated', 'message' => 'The specified InstanceName already exists.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidNavigationScriptId.NotFound', 'message' => 'The specified NavigationScriptId does not exist in our records.', 'http_code' => 404, 'description' => ''],
['code' => 'InvalidParameter', 'message' => 'The specified parameter %s is invalid.', 'http_code' => 400, 'description' => ''],
['code' => 'MissingParameter', 'message' => 'You must specify parameter %s.', 'http_code' => 400, 'description' => ''],
],
'changeSet' => [
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'ModifyTTSConfig'],
],
'createdAt' => '2025-12-18T02:04:07.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'GetAsrConfig'],
['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyAsrConfig'],
],
'createdAt' => '2025-12-11T11:27:37.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'DescribeTTSConfig'],
['description' => 'Request parameters changed', 'api' => 'ModifyTTSConfig'],
],
'createdAt' => '2024-07-22T12:36:27.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'ListConversations'],
],
'createdAt' => '2024-07-11T07:01:20.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'QueryConversations'],
],
'createdAt' => '2024-07-03T09:49:17.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'ListConversations'],
],
'createdAt' => '2024-04-22T07:30:01.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'AuditTTSVoice'],
['description' => 'Response parameters changed', 'api' => 'DescribeTTSConfig'],
['description' => 'Request parameters changed', 'api' => 'ModifyTTSConfig'],
],
'createdAt' => '2024-02-04T14:18:56.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'AssociateChatbotInstance'],
],
'createdAt' => '2023-12-27T03:10:22.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'AssociateChatbotInstance'],
['description' => 'Request parameters changed', 'api' => 'CreateInstance'],
['description' => 'Response parameters changed', 'api' => 'DescribeInstance'],
['description' => 'Request parameters changed', 'api' => 'ListChatbotInstances'],
['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'ListInstances'],
],
'createdAt' => '2023-09-19T12:51:49.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'DescribeInstance'],
],
'createdAt' => '2023-04-25T14:46:01.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'ModifyAsrConfig'],
],
'createdAt' => '2022-11-22T13:17:05.000Z',
'description' => '修复getVocabularyIdList异常处理代码问题',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'ListChatbotInstances'],
],
'createdAt' => '2022-09-21T15:47:28.000Z',
'description' => '灰度',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'ModifyInstance'],
],
'createdAt' => '2022-09-20T13:57:34.000Z',
'description' => '修改name发布',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'ExportConversationDetails'],
['description' => 'Request parameters changed', 'api' => 'ListConversations'],
],
'createdAt' => '2022-09-20T13:56:55.000Z',
'description' => '导航新增通话轮次筛选',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'DescribeTTSConfig'],
['description' => 'Request parameters changed', 'api' => 'ModifyTTSConfig'],
],
'createdAt' => '2022-09-20T13:55:29.000Z',
'description' => '支持STS调用语音服务',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'Dialogue'],
],
'createdAt' => '2022-09-20T13:54:30.000Z',
'description' => '情绪识别产品化',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetRealTimeConcurrency'],
],
'createdAt' => '2022-08-29T12:28:50.000Z',
'description' => '导航新增实时并发查询接口',
],
[
'apis' => [
['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeRecording'],
['description' => 'Request parameters changed', 'api' => 'SaveRecording'],
],
'createdAt' => '2022-08-09T13:05:20.000Z',
'description' => '支持分段录音试听',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'ListConversations'],
],
'createdAt' => '2022-06-21T12:24:50.000Z',
'description' => '返回值增加被叫号码 CalledNumber',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'AuditTTSVoice'],
],
'createdAt' => '2022-06-21T12:21:02.000Z',
'description' => '语调参数改为非必填',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetAsrConfig'],
['description' => 'Request parameters changed', 'api' => 'ListInstances'],
['description' => 'OpenAPI offline', 'api' => 'ModifyAsrConfig'],
],
'createdAt' => '2022-04-20T06:15:02.000Z',
'description' => '导航标注中心发布',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GenerateUploadUrl'],
],
'createdAt' => '2022-04-11T03:36:18.000Z',
'description' => '标注中心',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'BatchCreateSandBoxWhileList'],
['description' => 'OpenAPI offline', 'api' => 'DeleteSandBoxWhileList'],
['description' => 'OpenAPI offline', 'api' => 'DisableSandBoxWhileList'],
['description' => 'OpenAPI offline', 'api' => 'EnableSandBoxWhileList'],
['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListConversations'],
['description' => 'OpenAPI offline', 'api' => 'ListSandBoxWhileList'],
['description' => 'OpenAPI offline', 'api' => 'ModifySandBoxWhileList'],
],
'createdAt' => '2022-03-01T16:09:18.000Z',
'description' => 'ABTest',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'EndDialogue'],
],
'createdAt' => '2021-12-22T14:10:36.000Z',
'description' => 'ivr调导航挂断时完成播放字段',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'ListConversations'],
],
'createdAt' => '2021-12-22T12:30:51.000Z',
'description' => '届远导航9月迭代会话列表查看--新增挂断时完成播放字段',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetInstanceConfig'],
['description' => 'OpenAPI offline', 'api' => 'GetNewBargeInSwitch'],
['description' => 'OpenAPI offline', 'api' => 'UpdateNewBargeInSwitch'],
],
'createdAt' => '2021-12-22T12:30:13.000Z',
'description' => '智能打断产品化发布',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'CreateDownloadUrl'],
['description' => 'OpenAPI offline', 'api' => 'ListDownloadTasks'],
],
'createdAt' => '2021-11-24T13:02:45.000Z',
'description' => '发布了任务中心相关的API',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'DescribeAsrVadConfig'],
['description' => 'OpenAPI offline', 'api' => 'DescribeVoiceConfig'],
['description' => 'OpenAPI offline', 'api' => 'ModifyAsrVadConfig'],
],
'createdAt' => '2021-11-04T09:11:03.000Z',
'description' => '增加VAD噪音阈值调节配置',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
],
],
'ram' => [
'productCode' => 'VoiceNavigator',
'productName' => 'VoiceNavigator',
'ramCodes' => ['voicebot'],
'ramLevel' => 'OPERATION',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'DescribeInstance',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:DescribeInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListChatbotInstances',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListChatbotInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisableInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:DisableInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SaveRecording',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:SaveRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDownloadTasks',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListDownloadTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeStatisticalData',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:DescribeStatisticalData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'BeginDialogue',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:StartConversation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'Dialogue',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:Dialogue',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListConversationDetails',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:ListConversationDetails',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyTTSConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:ModifyTTSConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeRecording',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:DescribeRecording',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DebugCollectedNumber',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:CollectedNumber',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyGreetingConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:ModifyGreetingConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DebugBeginDialogue',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:DebugBeginDialogue',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDownloadUrl',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateDownloadUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeExportProgress',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:DescribeExport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryConversations',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:QueryConversations',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'AuditTTSVoice',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:AuditionTTSVoice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ExportStatisticalData',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:ExportStatisticalData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteInstance',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'voicebot:DeleteInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'AssociateChatbotInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:AssociateChatbotInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateInstance',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'voicebot:CreateInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ExportConversationDetails',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:ExportConversation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyAsrConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:ModifyAsrConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListInstances',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'voicebot:ListInstances',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAsrConfig',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetAsrConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'EnableInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:EnableInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DebugDialogue',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:DebugDialogue',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListConversations',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:ListConversations',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifySilenceTimeoutConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:ModifySilenceTimeoutConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeTTSConfig',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:DescribeTTSConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyUnrecognizingConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:ModifyUnrecognizingConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetRealTimeConcurrency',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:GetRealTimeConcurrency',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyInstance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:ModifyInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'EndDialogue',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:EndDialogue',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeNavigationConfig',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:DescribeNavigationConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CollectedNumber',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'voicebot:CollectedNumber',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SilenceTimeout',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'voicebot:SilenceTimeout',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeConversation',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'voicebot:DescribeConversation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VoiceNavigator', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];